IDBInformationSystemenUS en US
IDBInformationSystemenUS en US
IndustrialDataBridge 1
Installation Notes
WinCC/
IndustrialDataBridge 2
Release Notes
SIMATIC HMI WinCC/
IndustrialDataBridge 3
Getting Started
WinCC V8.0
WinCC/IndustrialDataBridge WinCC/
IndustrialDataBridge 4
Documentation
System Manual
03/2023
A5E51010757-AA
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.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 3
Table of contents
WinCC/IndustrialDataBridge
4 System Manual, 03/2023, A5E51010757-AA
Table of contents
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 5
Table of contents
WinCC/IndustrialDataBridge
6 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Installation Notes 1
1.1 Overview
Contents
The Installation notes manual contains important information on the scope of delivery,
hardware and software prerequisites as well as the steps for installing or uninstalling
IndustrialDataBridge V8.0. This manual also includes information about the steps for migrating
from IDB V7.3 / V7.4 / V7.4 SP1 / V7.5 / V7.5 SP1/IDB V7.5 SP2 to IDB V8.0.
Components supplied
You will receive the following components:
DVD IDB V8.0
• IDB V8.0 Setup (Includes Configuration System and Runtime application)
• Automation License Manager V6.0 SP9
• IndustrialDataBridge Demo Project
• IndustrialDataBridge Getting Started
• Storage medium with required licenses
• Certificate of license
Note
Hardware and software requirements
For hardware and software prerequisites to install IndustrialDataBridge V8.0, refer WinCC
Information System > Installation Notes > WinCC installation requirements.
All WinCC advanced options follow the same requirements as WinCC.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 7
WinCC/IndustrialDataBridge Installation Notes
1.3 Licenses
Note
Print Installation Notes
The installed notes for the received product are available for printing as a PDF file.
You will find the Installation Notes and Release Notes on the IDB V8.0 DVD in the
"\Documents\Readme" folder.
You will need Adobe Acrobat Reader V5.0 or later. You can download Adobe Acrobat Reader free
of charge at the following URL:
• http://www.adobe.com/products/acrobat
1.3 Licenses
Licenses
The following table shows the licensing model for the WinCC IndustrialDataBridge.
Note
License Message Log
All messages related to the licenses (Trial, Single, Count Relevant and Upgrade) will be logged
in the “IDBRTServiceLog.txt” log file. A "Tag count overflow" message will be logged if the
number of configured tag(s) exceeds the license count.
To enable the trace service log, please refer “How to enable the trace service log?” in the FAQs
(Page 541) Chapter.
License tag corresponds to a connection configured for a link and it is opened in the
IndustrialDataBridge Runtime.
1
WinCC IndustrialDataBridge Basic Package License - This license type depends on the WinCC
IndustrialDataBridge version and it includes necessary components required for the WinCC
IndustrialDataBridge.
WinCC/IndustrialDataBridge
8 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Installation Notes
1.4 Installing IDB
2
WinCC IndustrialDataBridge Count Relevant License - This license is version independent. If
basic package license is available, it combines the count value with basic package (Example,
Basic (100) + 300 Tags = 400 Tags).
3
WinCC IndustrialDataBridge Upgrade License - Number of tags to be supported by the
Upgrade license depends on the number of tags that are supported with the existing license.
4
WinCC IndustrialDataBridge Trial License - Full functionality of the WinCC
IndustrialDataBridge is enabled for 30 Days from the installation date.
Note
Installing IDB
You need administrator rights for installing or uninstalling the IndustrialDataBridge.
Installation Steps
1. Start the IDB product DVD.
The DVD starts automatically if Autorun is enabled in the operating system. If the Autorun
function is not activated, start the program Setup.exe on the DVD.
2. The prerequisites required for IDB will be installed along with other software components.
3. Follow the on-screen instructions.
In IDB Setup screen, the installation wizard will guide you through further steps to proceed
with the installation.
4. The wizard displays a list of languages wherein it allows you to select the language required
to be installed.
5. Upon selection of language, you can view the installation notes and product release notes by
clicking on the "Read installation notes" and "Read product information" buttons in the setup
screen.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 9
WinCC/IndustrialDataBridge Installation Notes
1.5 Installation log
6. The list of components that will be installed will be displayed. The check box provides the
options to mark or unmark the selection for installing the respective component.
7. Select the desired list of components and choose the computer drive and location for
installing IDB. Click "Next" button.
8. The license agreement and open source license agreement is available that displays the text
based on selection of these links in setup screen. Read the text carefully and choose the check
box next to each copyright listed in this screen. Click "Next" button.
9. The wizard further progresses with the installation and prompts a dialog for restarting the
computer.
Overview
The installation log file maintains the progress and status of IDB V8.0 installation. This log file is
helpful in evaluating the errors that occur during installation process or when warnings are
issued. You can do this by yourself or contact product support.
The progress of following installation processes is logged in a file:
• Installing IDB
• Modifying or updating already installed products
• Performing repair of an existing installation
• Uninstalling products
Storage location
The log file is the most recent file with the file extension ".log". The main installation log name
for IDB V8.0 is "SIA_IndustrialDataBridge@yy-mm-dd_hh-mm-secs.log"
WinCC/IndustrialDataBridge
10 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Installation Notes
1.6 Uninstalling IDB
Example: SIA_IndustrialDataBridge@20-09-05_12-40-26.log
This installation log file is created in the following folder location:
C:\ProgramData\Siemens\Automation\Logfiles\Setup
A cab file is generated that can be sent to product support for assistance with installation.
The product support team will use this cab file to determine whether installation was
executed properly. The reports in the form of .cab files will be available in the following
folder path:
C:\ProgramData\Siemens\Automation\Logfiles\Setup\Reports
Introduction
Note
Uninstalling IDB
You need administrator rights for installing or uninstalling the IndustrialDataBridge.
Note
Uninstalling IDB will uninstall the Demo Project and Getting Started project. If the Demo Project
folder and Getting Started project folders are shared, firstly the shares will be automatically
removed and they will be uninstalled.
If WinCC project is activated during IDB uninstallation process, a prompt will be displayed asking
you to close and exit WinCC Explorer. After exiting WinCC Explorer, the uninstallation process
will be continued further.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 11
WinCC/IndustrialDataBridge Installation Notes
1.8 Migrating to V8.0
IDB V8.0
After installing the IndustrialDataBridge V8.0 application, you can start the application from
Start menu.
Use in WinCC
IndustrialDataBridge application can be started using WinCC V8.0. You can start this from the
WinCC Explorer.
Overview
For migrating from V7.2, V7.3, V7.4, V7.4 SP1, V7.5, V7.5 SP1, V7.5 SP2 to V8.0 there is no
specific upgrade installation available. To use IDB V8.0 on your computer, you need to install
IndustrialDataBridge software. Install IDB V8.0 product by running the "Setup.exe" file from the
DVD that is shipped to you. The setup wizard will guide you through the installation process.
WinCC/IndustrialDataBridge
12 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Release Notes 2
2.1 Important information
Safety information
WARNING
Changing Values
If you change the value displayed by the IndustrialDataBridge, you also change the value in the
real process. This happens whether you make the change in the IndustrialDataBridge or in third-
party software.
Modifying process data can lead to unpredictable process reactions that can lead to death,
serious injury to persons and/or damage to equipment.
Proceed with caution, change no data and do not grant unauthorized persons access to data,
which could lead to unexpected functionality of the controlled devices. Always install a physical
emergency stop circuit for your machine or process.
2.2.1 Warnings
Safety notes
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 13
WinCC/IndustrialDataBridge Release Notes
2.2 Service and Support
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.
Note
is an important information about the product, the way to handle the product or the respective
part of the documentation and we wish to especially bring this to your notice.
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
Note the following:
WARNING
Proper use of Siemens products
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.
WinCC/IndustrialDataBridge
14 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Release Notes
2.2 Service and Support
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.
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 constitute one element of such a concept.
Customers are responsible for preventing unauthorized access to their plants, systems,
machines and networks. Such systems, machines and components should only be connected
to an enterprise network or the internet if and to the extent such a connection is necessary
and only when appropriate security measures (e.g. firewalls and/or network segmentation)
are in place.
For additional information on industrial security measures that may be implemented, please
visit
http://www.siemens.com/industrialsecurity (http://www.siemens.com/industrialsecurity)
Siemens’ products and solutions undergo continuous development to make them more
secure. Siemens strongly recommends that product updates are applied as soon as they are
available and that the latest product versions are used. Use of product versions that are no
longer supported, and failure to apply the 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
https://www.siemens.com/cert (https://www.siemens.com/cert)
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. Suggestions for improvement are welcomed.
The statements in the online documentation are more binding than the statements in the
manuals and PDF files.
Please follow the Release Notes and Installation Notes. The information in these Release
Notes and Installation Notes has priority over that in the manuals and online help with regard
to legal validity.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 15
WinCC/IndustrialDataBridge Release Notes
2.2 Service and Support
It is prohibited to transfer, copy, evaluate or communicate this document in full or part unless
the same has been explicitly approved. Violation of this rule can lead to claims for damage
compensation. All rights reserved, especially for granting patents or for GM registration.
Siemens AG
Division Digital Factory
SIMATIC Human Machine Interfaces
P.O. Box 4848
D-90327 Nuremberg, Germany
WinCC/IndustrialDataBridge
16 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Release Notes
2.2 Service and Support
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)
• Message system for traceability and availability (e. g. 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 may 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, please 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.
The above data is secured by adequate technical measures, such as:
• 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.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 17
WinCC/IndustrialDataBridge Release Notes
2.2 Service and Support
Technical support
The Technical Support is available around the clock from Monday to Friday.
Current information on the Technical Support:
• Internet: Technical support (http://support.automation.siemens.com/WW/view/en/
16605032)
Form for support requests:
• Internet: Support Request (https://www.siemens.com/supportrequest)
WinCC FAQs
WinCC Online Support with information on FAQs (Frequently Asked Questions):
• Internet: WinCC FAQs (http://support.automation.siemens.com/WW/view/en/
10805583/133000)
Technical Forum
The Technical Forum supports exchange with other SIMATIC users:
• Internet: Support Technical Forum (https://support.industry.siemens.com/tf/ww/en/)
WinCC/IndustrialDataBridge
18 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Release Notes
2.2 Service and Support
Product Information
SIMATIC WinCC
Additional information about WinCC products:
• Internet: Information about WinCC (http://www.siemens.com/wincc)
SIMATIC Products
Additional information about SIMATIC products:
• Internet: SIMATIC Products (http://www.siemens.com/simatic)
See also
Internet: Support Request (https://www.siemens.com/supportrequest)
Internet: Technical support (http://support.automation.siemens.com/WW/view/en/16605032)
Internet: Siemens Industry Service Card (https://support.industry.siemens.com/cs/ww/en/sc/
4869)
Internet: Service and Support (https://support.industry.siemens.com/)
Internet: WinCC FAQs (http://support.automation.siemens.com/WW/view/en/
10805583/133000)
Internet: Support Technical Forum (https://support.industry.siemens.com/tf/ww/en/)
Internet: Support Online Help (https://support.industry.siemens.com/cs/helpcenter/en/
index.htm)
Internet: Technical documentation for SIMATIC products (http://www.siemens.com/simatic-
tech-doku-portal)
Internet: Contact person database (http://w3.siemens.com/aspa_app/?lang=en)
Internet: Information about WinCC (http://www.siemens.com/wincc)
Internet: SIMATIC Products (http://www.siemens.com/simatic)
Dear customer
In order to provide you with fast and effective support, please complete the "Support
Request" form online on the Internet. Describe the problem in as much detail as possible.
We would appreciate if you would provide us with all project data, so that we can reproduce
the error situation or shorten the turn-around time.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 19
WinCC/IndustrialDataBridge Release Notes
2.2 Service and Support
Before filling out the support request, check whether your configured quantity structure is
within the range of tested quantity structures (see topic "Performance Data").
Procedure
1. Open the "Support Request" form using the link on the Internet. Step 1 "Select product" is
displayed:
2. Enter the project name in the "Product/Order number" box. Upper/lower case is not relevant.
Search for parts of the product name or enter the full product name in the correct order. You
can e. g. search for the following terms:
- "WinCC Runtime"
- "WinCC DataMonitor"
- "WinCC webnavigator"
- "Connectivity"
The found products are offered in the "Product selection" field.
3. Select the desired product and click on "Next" to switch to step 2 "Select use case".
4. Select a use case or describe your specific use case in the "Other application case" field.
5. Press "Next" to switch to step 3 "Our solutions".
Suggested solutions and FAQs for the selected key words are listed.
Once you have found a suggested solution for your problem, you can close the form in the
browser.
If you did not find any applicable suggested solutions, press "Next" to switch to step 4
"Describe problem".
6. Describe your problem as exactly as possible in the "Details" field.
Pay particular attention to the following questions and comments. Please also check the
WinCC installation and configuration with regard to the following references.
If you have any idea what has caused the error, please let us know. No detail should be
omitted, even if you consider it unimportant.
- Was the configuration data created with older WinCC versions?
- How can the error be reproduced?
- Are other programs running simultaneously with WinCC?
- Have you deactivated the screen saver, virus checker and power management function?
- Search the computer for log files (WinCC\Diagnose\*.log, drwatson.log, drwtsn32.log). The
log files are needed for error analysis. Thus, be sure to send the log files as well.
WinCC/IndustrialDataBridge
20 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Release Notes
2.2 Service and Support
7. Use the "Search" button to upload your affected project and the log files (e. g. as a Zip file) to
the Support Request.
Press "Next" to switch to step 5 "Provide contact information".
8. Enter your contact information.
Read the privacy notice and choose whether your personal data should be permanently
saved.
Press "Next" to switch to step 6 "Summary & Send".
9. Press the "Print" button if you would like to print the support request.
You close the support request by clicking the "Send" button.
Your data will be transmitted to Customer Support and processed there.
Thank you for your cooperation. We hope that we can be of assistance in solving your
problems.
Your WinCC Team
See also
Internet: Error report (https://www.siemens.com/supportrequest)
Internet: Overview of Support Request (http://support.automation.siemens.com/WW/
view/en/16605654)
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 21
WinCC/IndustrialDataBridge Release Notes
2.2 Service and Support
WinCC/IndustrialDataBridge
22 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started 3
3.1 Task
Introduction
Welcome to the "IndustrialDataBridge Getting Started". Getting Started uses example projects to
show you the easy operation of IDB. This "Getting Started" takes you through the configuration
process of the IndustrialDataBridge by means of practical examples and enables the data
transfer process during runtime using these examples.
The included WinCC project "idb_getting_started.MCP" and IDB Getting Started project
"IndustrialDataBridge" provides you with an environment that helps to make your first steps
with the IndustrialDataBridge application.
Note
Language
The Getting Started examples are available only in English language. In WinCC Explorer or in IDB,
even if you change the language, you will observe that the Getting Started example in WinCC
Runtime will be displayed in English language.
Example Project
The example project that is provided along with this Getting Started includes 2 examples.
Example 1
The example included demonstrates the data transfer within a plant environment. This
example deals with the data transfer of process value archive to user archive. The archived
alarm data existing in process value archive can be further transferred to a CSV file. The user
archive containing updated data is transferred to OPC Data Access.
Example 2
This example describes a simple production process that uses a recipe. The example deals
with a scenario specific to a plant environment. In the example, the number of pieces
including the recipe data - color attribute and quantity to be manufactured are retrieved
from the database. This information will be stored in the User Archive Thereby, it is taken
into consideration that the production process is started. After completion of production, the
results of the production are entered in the text box fields. The information entered is stored
in a separate User Archive. IDB application ensures data transfer wherein the results entered
are successfully transferred to the database.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 23
WinCC/IndustrialDataBridge Getting Started
3.2 Prerequisites
Task
You will learn the following procedures:
• The creation of project, links, performing link settings and connections in IDB CS.
• To use the configuration in IDB Runtime required for initiating the data transfer.
• Open Getting Started project (idb_getting_started.MCP), activate project and view Getting
Started examples in WinCC Runtime.
Note
The option "IndustrialDataBridge" is indicated with the abbreviation IDB in the subsequent
chapters.
Procedure
Perform the following steps to get through Getting Started. The detailed procedure for
performing these steps are outlined in the subsequent chapters.
1. Create and configure the links in IDB; Export XML file.
2. Install the WinCC project "IDB_Getting_Started".
3. Define the computer properties in the WinCC project.
4. Export reference XML file from WinCC project.
5. Activate the WinCC project.
6. Adapt the reference configuration for the WinCC project.
7. Prepare environment for Getting Started project.
8. Enable data transfer and start download and upload of recipe data.
3.2 Prerequisites
Introduction
This chapter provides information about the hardware requirements and software requirements
required for working with Getting Started.
The IDB Information System can be accessed by navigating to the below mentioned folder
path.
'C:\Program Files (x86)\Siemens\Automation\IndustrialDataBridge\Help\'
WinCC/IndustrialDataBridge
24 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.3 The WinCC Project
Hardware Requirements
The same hardware requirements apply for the Getting Started project as for other IDB projects.
Refer IDB installation notes.
Software requirements
The same software requirements apply for the Getting Started project as for other IDB projects.
Refer IDB installation notes.
3.3.1 Overview
Overview
The WinCC project "idb_getting_started" provides data that is transferred by IDB. The transfers
are triggered by a trigger event, which is created by clicking on a button. When a trigger event
occurs, the data is transferred in accordance with the configuration. This is shown in Getting
Started example1 that uses process values for data transfer and example 2 includes a recipe
example that uses a simple plant production scenario. The Getting Started example uses
"idb_getting_started.xml" as the reference configuration file.
The idb_getting_started.MCP file along with other resources required for WinCC project is
provided within the "idb_getting_started" folder. These examples can be viewed in WinCC
Runtime after the Getting Started project is activated in WinCC.
The project required for working with IndustrialDataBridge CS along with the database, XML
file can be accessed from "IndustrialDataBridge" folder available at the following location:
For Windows 10 / Windows 11 / Windows Server 2019 / Windows Server 2022 Operating
System:
'C:\Users\Public/
PublicDocuments\Siemens\IndustrialDataBridge\idb_getting_started\IndustrialDataBridge\'
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 25
WinCC/IndustrialDataBridge Getting Started
3.3 The WinCC Project
After the installation, you need to adapt the computer properties in the WinCC project,
e.g. computer name and path. This procedure is described in Chapter 4.2 "Preparing the
environment for Getting Started" (Page 26).
Introduction
This chapter provides the steps for adapting the computer properties and lists the information
specific to the steps to be performed for opening the project "idb_getting_started" using WinCC.
Hence, after activating the project in WinCC, the WinCC Runtime displays the Getting Started
examples.
Prerequisites
• The Getting Started project is installed during IDB installation.
• IDB Configuration System and IDB Runtime application is installed on the computer.
• WinCC V8.0 is installed.
The MCP file and other Getting Started resources are available in this folder.
3. The button "Start server locally" will be displayed. Click "Start server locally" to accept local
computer name.
WinCC/IndustrialDataBridge
26 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.3 The WinCC Project
4. However, you need to adjust the computer properties in WinCC Explorer to reflect these
changes.
– In WinCC Explorer, right click on "Computer" icon and select "Properties" option. The
"Computer List Properties" window will be displayed.
– The "Computer List Properties" window displays a list of computers in 'Computer List'
field. Select the computer name and choose "Properties" button to open the "Computer
properties" dialog window.
– The Computer name of the local machine will be displayed in a text box next to the
"Computer Name" field. Click the button "Use Local Computer Name" button and select
OK.
– Next, click OK to save the changes. This will close the "Computer List Properties" window.
5. In WinCC Explorer, close the opened project and restart WinCC for the changes to take effect.
6. After restarting WinCC, open the IDB project in WinCC Explorer by selecting by the
"idb_getting_started.MCP" file.
7. Next, activate the IDB Getting Started project "idb_getting_started" in WinCC. You will
observe that the Getting Started examples will be started automatically in WinCC Runtime.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 27
WinCC/IndustrialDataBridge Getting Started
3.3 The WinCC Project
WinCC/IndustrialDataBridge
28 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.3 The WinCC Project
3. In left hand side navigation of WinCC Explorer, right click on "IndustrialDataBridge" and select
"Project XML Export" option to export XML file.
4. The XML file will be exported to the following path:
For Windows 10 / Windows 11 / Windows Server 2019 / Windows Server 2022 Operating
System:
'C:\Users\Public/
PublicDocuments\Siemens\IndustrialDataBridge\idb_getting_started\IndustrialDataBridge\'
Reports
Result
You have prepared the environment for working with the IndustrialDataBridge Getting Started
examples. To access IDB Runtime using WinCC controls, refer Chapter 4.3 "Accessing IDB
Runtime using WinCC". The steps for working with the provided examples to enable data transfer
are provided in Chapter 6 "Getting Started and Examples" (Page 36).
Overview
WinCC IDB Runtime application can be accessed using WinCC controls. This is possible by adding
WinCC ActiveX control "IDB Runtime Control" as an OCX in Graphics Designer. This will help
WinCC users to start IDB Runtime within their environment.
The look and feel of IDB Runtime as an OCX is almost similar to the IDB Runtime as an
executable. However, there are few additional changes to IDB Runtime as an OCX and these
changes are covered in the subsequent sections.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 29
WinCC/IndustrialDataBridge Getting Started
3.3 The WinCC Project
6. IDB Runtime control should be available as an OCX within the controls list.
7. Drag and drop this OCX control to the container area within the PDL file window.
8. Once this control is added to the container, save the PDL file and click Runtime control in
Standard toolbar to activate Runtime mode.
9. The IDB Runtime control is displayed / opened on the WinCC Runtime screen.
Note
Views
The screenshots provided in chapter "Views" are not valid for IDB Runtime as an OCX control.
While accessing IDB Runtime as an ActiveX control in WinCC, you will observe that the IDB
Runtime menu bar will not be displayed.
WinCC/IndustrialDataBridge
30 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.3 The WinCC Project
Note
"Password check" and "Trace logging" options
The "Password check" and "Trace logging" menu items existing within "Options" menu in IDB
Runtime application is available in "Password" tab and "Trace" tab as separate check boxes.
Options
Select "Options" toolbar button from IDB Runtime application to access Runtime Configuration.
The "Runtime Configuration" provides the following tabs:
• Startup Option
• Trace
• Password
• License
• NT Service
Note
Changes to the Runtime interface can be performed only if the IDB Service has been started.
The options provided within each of these tabs are same as the options in IDB Runtime
application. However, there are some additional features that are provided with IDB Runtime
as WinCC control. These features are highlighted below:
Language Option:
The IDB Runtime application provides language support. It supports 7 languages - English,
Spanish, German, Italian, Chinese, Japanese and French. While accessing IDB Runtime as
OCX control on WinCC Runtime screen, the language changes when the language of WinCC
Runtime has been changed.
The language option of IDB runtime control is not linked to IDB Runtime application or any
other IDB runtime control. This means that language change in IDB runtime control does not
change the language of other controls or IDB Runtime application and vice versa.
Trace Logging:
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 31
WinCC/IndustrialDataBridge Getting Started
3.3 The WinCC Project
The Trace tab is provided next to Startup option tab. This tab is displayed only after you have
loaded the configuration file in IDB Runtime window.
The "Trace Logging" check box is available within the "Trace" tab of Runtime Configuration
window. Upon enabling this check box, it allows to save the trace messages generated both
from provider and consumer side. Within the Trace tab, the "Provider log file" and "Consumer
log file" sections provide options to specify the file name for logging the trace messages. At a
later point of time, the trace log files can be used to view these trace messages.
Password Check:
The "Password Check" check box is provided within "Password" tab of Runtime Configuration
window. Once this check box is enabled, it generates a dialog box asking you to enter
the password each time an operation is performed within each of the tabs in Runtime
Configuration.
WinCC/IndustrialDataBridge
32 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.3 The WinCC Project
In IDB Runtime as OCX, the following points are valid with respect to the actions performed
within Open dialog box.
• Open dialog box is opened only in Read mode. You will be able to open only an XML file.
• Option to delete a file or folder is not provided within this dialog box.
• Options to cut/paste a file or folder and creation of new file/folder are not available.
• Menu pop-up on right mouse-click within the window area cannot be performed.
• Drag and drop of file or folder within the dialog box cannot be done.
• Options to rename file or folder using F2 key cannot be performed.
See also
Views (Page 491)
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 33
WinCC/IndustrialDataBridge Getting Started
3.4 The IDB Project
3.4.1 Overview
Overview
The "IndustrialDataBridge" project provides you with the resources that is required for working
with the Getting Started examples. If you have selected "Getting Started" project during IDB
installation, the Getting Started project will be installed at the following location:
For Windows 10 / Windows 11 / Windows Server 2019 / Windows Server 2022 Operating
System:
'C:\Users\Public/PublicDocuments\Siemens\IndustrialDataBridge\idb_getting_started\'
The "IndustrialDataBridge" folder includes IDBProject, XML file, Access database and other
required resources for running the examples. The "IndustrialDataBridge" project can be
accessed from the following folder location:
For Windows 10 / Windows 11 / Windows Server 2019 / Windows Server 2022 Operating
System:
'C:\Users\Public/
PublicDocuments\Siemens\IndustrialDataBridge\idb_getting_started\IndustrialDataBridge\'
This "IndustrialDataBridge" folder includes the following files:
• IDBProject
• Reports
• getting_started_alarms.csv
• idb_getting_started_configfile.xml
• IDBGettingStarted.accdb
The "IDBProject" folder lists the required files for viewing the project in IDB Configuration
System. The IDBProject can be opened in IDB CS application by importing the XML
WinCC/IndustrialDataBridge
34 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.4 The IDB Project
Note
Folder Structure
The folder structure path mentioned below is respective to Windows 10 / Windows 11 / Windows
Server 2019 / Windows Server 2022 Operating System. Please use the folder locations
mentioned below to navigate to the respective files or folders.
• IDBProject that contains .ip80 and related files:
'C:\Users\Public/
PublicDocuments\Siemens\IndustrialDataBridge\idb_getting_started\IndustrialDataBridge\
IDBProject'
• XML file exported from WinCC:
'C:\Users\Public/
PublicDocuments\Siemens\IndustrialDataBridge\idb_getting_started\IndustrialDataBridge\
Reports'
• IndustrialDataBridge folder containing XML file, database and other resources:
'C:\Users\Public/
PublicDocuments\Siemens\IndustrialDataBridge\idb_getting_started\IndustrialDataBridge\'
'
Note
Reports
After exporting the XML file from WinCC project, by default the XML file will be exported within
the 'Reports' folder. This folder exists within the "IndustrialDataBridge\Reports" folder. The
Reports folder includes the exported XML file.
Structure
In IDB CS, a configuration is created and contained within a project. A project consists of link
which in turn includes the provider, consumer, settings and connections. The definition of each
of these items are provided below:
• Project: A project is used to plan, organize, manage and control IDB CS configuration and
other settings.
• Link: A link represents an entity and contains several connections.
• Connection: A connection represents a unique mapping between provider and consumer
types.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 35
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
3.5.1 Overview
Overview
The Getting Started project uses WinCC project, IDB project and IDB Runtime environment to
demonstrate the data transfer behavior in IndustrialDataBridge with the help of examples. The
projects are provided within the "idb_getting_started" folder. The Getting Started examples and
its functionality can be viewed in WinCC Runtime environment. The example project uses
process value example and recipe example to help you understand with the data transfer process
using IDB.
Note
Use the examples only as a suggestion for realizing the Getting Started project.
The example project helps you in getting to use IndustrialDataBridge Configuration interface,
create configuration file and load configuration during Runtime. It also helps to understand
the data transfer flow with the help of a simple plant scenario.
WinCC/IndustrialDataBridge
36 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
'C:\Users\Public\Public
Documents\Siemens\IndustrialDataBridge\idb_getting_started\IndustrialDataBridge\'
Note
IDB Getting Started project
The IDB Getting Started project provided as part of the installation includes all required files
necessary for viewing the example projects. A fully created working configuration is provided
that can be opened in IDB CS application.
The XML configuration file "idb_getting_started_configfile.xml" is common for both the example
projects.
Note
Viewing example in WinCC
An example that includes the required fields and user interface controls can be viewed in WinCC
Runtime environment. To view the example in WinCC, you need to open the WinCC project
(idb_getting_started.MCP) in WinCC Explorer and activate the respective project.
The Getting Started example screen includes a navigation control button that helps you to
switch between Example 1 and Example 2.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 37
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Note
• In provider transfer options, the Schema name is automatically selected if you use Oracle as
the database type. The list of tables will be provided in the "Table" field.
• While performing connection mapping, follow the steps as described in the respective
chapters.
3.5.2.1 Introduction
Introduction
This Getting Started example helps you to understand the data transfer between process archive
values and WinCC User Archive. The recipe number containing the process values can be
generated using the buttons provided in example screen and can be transferred or updated in
the WinCC User Archive. The archived alarm data within the Process Archive can be filtered based
on "start date" and "end date". The alarm data based on filtered condition can be updated in the
CSV file. A list of ingredients produced are finally transferred to the OPC Data Access from WinCC
User Archive. This is shown in the Getting Started Example 1.
WinCC/IndustrialDataBridge
38 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Note
Example project - IDBProject
The example that includes the complete configuration provided along with Getting Started
project contains a fully defined configuration, provider transfer options that are set along with
connections that have already been created.
The Getting Started example 1 helps you to understand managing the production process
data using a recipe example and perform data transfer. This example provides the options
to select the available recipe, transfer alarm data and send the final ingredient values to the
consumer.
Example 1 uses the following configuration available as a link. In example 1, you will create 3
links - Send_process_values, Send_alarm_data and Receive_recipe.
You can view this configuration in IDB CS application.
• Process Archive (WinCC OLEDB as provider), WinCC User Archive as consumer
• Message Archive (WinCC OLEDB as provider), CSV/TXT as consumer
• WinCC User Archive as provider, OPC Data Access as consumer
However, in order to make you understand better, the following chapters provide information
about the steps in detail for creating or configuring the connections. Each chapter includes a
series of steps listed as Step 1, Step 2, Step 3 and Step 4 that guides you through the detailed
procedure.
• Process Archive - WinCC User Archive
• Message Archive - CSV/TXT
• WinCC User Archive - OPC Data Access
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 39
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Note
Important information
If you do not wish to perform the steps given in above mentioned chapters, and you wish to view
the example in WinCC Runtime directly, it is strongly recommended to perform the steps
mentioned in the chapter "Viewing Example 1 in WinCC Runtime (Page 107)".
Introduction
This chapter provides you with the complete steps for creating a project and link in IDB
Configuration System application. The objective here is to create a project with corresponding
link having WinCC OLEDB (Process Archive) as provider and WinCC User Archive as consumer.
Procedure
1. Open IDB Configuration and create a project by following the steps mentioned below:
– In IDB Configuration menu, select "Project" > "Create" to create a new project.
– In the "Create new project" dialog box, specify a project name, click [...] button and select
the folder location wherever the project needs to be saved.
– After entering the required information, select "Create" button. This creates a new project.
2. The project name will be listed within the "Project tree".
WinCC/IndustrialDataBridge
40 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
3. The next step is to create a link. Follow the steps mentioned below to create a link between
provider and consumer:
– Right click on project name node in the tree structure and select "Add new link" option.
After creating a project, by default a new node "Add new link" is displayed in project tree
below project name node.
Alternatively, you can create a new link by double clicking the "Add new link" node in
project tree.
– In the "Add new link" dialog that is displayed, enter a unique link name.
– Select the provider type as WinCC OLEDB, target type as WinCC User Archive and click OK
button.
– The created link will be displayed below the project name in project tree.
4. The corresponding entries - Provider, Consumer, Settings and Connections are created as
nodes that exist below the new link in the tree structure.
Result
You have created a project that consists of a link having WinCC OLEDB as provider and WinCC
User Archive as consumer.
Introduction
In this chapter, you will configure the respective provider/consumer configuration along with
transfer behaviour settings.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 41
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Procedure
1. In project tree, open the Provider configuration window by double clicking the Provider node.
In Provider configuration window, click on [...] button and select the WinCC project XML file
that you have exported from WinCC.
Note
WinCC Project XML export file
While selecting the WinCC project XML export file, please remember to choose the
appropriate WinCC project XML file. Export the XML file from the computer that has WinCC
installed. In WinCC Explorer, select "IndustrialDataBridge" > "Project XML Export" option to
export the XML file.
For IDB CS to be used on a WinCC station, ensure that you do not mark the "Use Single point
of system access" for selection.
– In "Archive configuration" section, select the WinCC station name of the selected provider.
Note
WinCC Station
• The WinCC station name is listed in the drop down list box of "WinCC station name" field
that displays the station name wherever the WinCC XML file exists. Choose the WinCC
station name by selecting from list.
• The project name is automatically displayed based on the WinCC project XML file that is
selected in "WinCC project XML file" text box.
2. Next, double click the Consumer node in project tree to open the consumer configuration
window.
WinCC/IndustrialDataBridge
42 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Note
Connecting String
In "Consumer configuration window", the "Connection string" field (at top position) displays
the database connection string parameters after the selection of database type.
In Consumer configuration window, perform the following settings:
– Enter the server name and/or complete path of WinCC User Archive database.
– Select the database name from the list that is displayed in the "Database" field. Click on the
drop down list box to view this list.
– If you wish to enable windows authentication automatically, select the check box "Use
automatic windows authentication".
– Within the section area that provides options to logon to the database, enter the user
name and password.
This information is required to logon to the WinCC User Archive database.
– Click Test button to test the connection. It tests the user archive database connection
string and verifies the selected user archive database.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 43
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
2. Within the Transfer Options tab, you can configure the archive settings and transfer behavior
settings for provider.
3. In "Archive settings" section, choose the Archive type. In "Archive" field, select whether data
is to be transferred from 'Process value archive' or from 'Alarm message archive'.
Depending on the archive type selected, the "Process value" button and "Events" button will
be shown in disable or enable state.
4. Click on "Process value" button open the "Variable Filter" window. The "Event filter" window
can be opened by clicking on the "Events" button.
More information about configuring these filter settings is provided in "Configuration of the
transfer behavior (Page 46)".
5. Select the appropriate time zone in the "Time zone for consumer" field.
WinCC/IndustrialDataBridge
44 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
6. In "Time settings" section, enter the cycle time and choose metric (milli seconds / seconds /
minutes / hours) by selecting the drop down list box.
7. Next, select the type of data transfer:
– Cyclic & Continuously
Here, transfer time is set with a timer. This enables an hours transfer to be started for
instance.
The time period is defined using the last two timer times.
– Triggered & Continuously
In the type, the transfer time is defined using a trigger condition with OPC tags. The time
period is defined using the last two trigger times. The IDB marks the last transfer time and
reads the interval between two trigger times.
– Triggered time span
In this type, the transfer time is defined using a trigger condition with OPC tags. The time
period, which is read from the WinCC archive, is defined using two other OPC tags.
Note
Transfer type
Based on transfer type, the buttons "Time span", "Start-up behavior" and "Trigger" will be in
enable or disable state.
• If option "Cyclic & Continuously" or "Triggered & Continuously" is selected, both the "Start-
up behavior" and "Trigger" buttons can be used.
• With option "Triggered time span", only the Timespan and Trigger buttons can be used.
8. Configure the "Trigger" and "Time span" or the "Start-up behavior" in the dialog window that
you open by clicking the respective button.
More information about the transfer setting capabilities and their options are provided in
chapter "Step 3: Configuration of the transfer behavior (Page 46)".
9. The transfer behavior settings for WinCC OLEDB as provider will be saved automatically.
Note
Saving changes
A save operation is not required every time whenever changes are performed within the
editor window in the work area. The changes made to these settings are automatically saved.
However, once the project is created, at any point of time, you can save the project by
selecting the "Project" > "Save" menu option.
Result
You have configured the WinCC OLEDB interface and WinCC User Archive as a consumer. These
elements are displayed in the tree structure of the configuration interface.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 45
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Introduction
This chapter highlights the key information related to WinCC OLEDB transfer setting capabilities
and their options.
Configuration options
The Settings window provides user interface controls in form of drop down list box or buttons
or radio buttons that are used to perform "Archive type settings" and "Transfer type settings". The
configuration settings and their options existing within these dialog windows are explained
below.
WinCC/IndustrialDataBridge
46 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
1. In "Archive" field, select the archive for which you wish to transfer the data by choosing from
the drop down list.
2. The "Archive variable" section displays a list of archive variables. Select one or more tags from
the list that is displayed at left hand side of the window.
3. Transfer these tags to the selection field on right side with ">" or use ">>" to transfer all tags
in the list.
Use "<" or "<<" to delete the selected or all tags from the selection field on right side.
4. Confirm this selection by clicking the "OK" button.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 47
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
1. Enter a message number in the "Single Event" field text box and click "Include" button. This
will be added to the "Chosen events" list.
2. To specify a message number range, enter the start range and end range in "From" and "To"
text box. Then, click "Include" button to add this event range.
3. To exclude any event from the list, select the event within the list and click "Exclude" button.
To clear all the events displayed within the "Chosen events" field, click "Delete list" button.
4. You can select the archive language by choosing the "Archive language" field drop down list
box. This will display the archive messages in the selected language.
5. Once you have performed the changes, confirm this selection by clicking the "OK" button.
WinCC/IndustrialDataBridge
48 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Time span
The "Time span" button is activated only if you have selected the radio button option "Triggered
time span". Click "Time span" button to open the "Time span" dialog window. The transfer time
period for selected tags is defined in this "Time span" window. The selection is controlled through
tags of the OPC Server provided within the OPC tag browser.
In "Time span" window, "Define update cycle" section area, the time period can be defined
using two different ways:
• With a Start time and an End time (using "From" and "To" selection)
• With a Start time and Time period (using "+/-" selection)
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 49
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Procedure
To define the transfer time period, follow these steps:
1. Select the tags that define the Start time by performing selection within the OPC tag browser.
2. Confirm the selection by clicking the "Apply" button in the "From" line. The selected tag is
added within the "From" text box.
3. Define whether you want to define an End time or a period of time by selecting the
appropriate radio button.
4. Select the tags that define End time or the time span in the OPC tag browser. The tag selection
will be added to the text box below "From" field.
5. Confirm the selection by clicking the "Apply" button in the "To" line or "+/-".
6. Click OK button after performing the required changes.
Note
Tag type
The tags that define a time span must be of the type "VT_I4 or be present as string that can be
converted into the type "VT_I4" by the OPC server. With the time span, the preceding sign
determines whether the period of time is before (-) or after (+) the start time (From).
Note
No Time period defined
If no transfer time period is selected within the "From" and "To" or "+/-" fields, all available data
is transferred.
WinCC/IndustrialDataBridge
50 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
• Chinese; LCID="2052"
• Japanese; LCID="1041"
Additional values for LCID are available under http://www.microsoft.com when you enter the
search term "LCID".
Start-up behavior
The "Start-up behavior" button is activated if any one of the transfer types "Cyclic & continuously"
or "Triggered & continuously" is selected. To open the "Start-up behavior" dialog window, select
"Start-up behavior" button. The settings mentioned here will be used during start of the
IndustrialDataBridge Runtime.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 51
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Procedure
To configure the behavior of first transfer, follow these steps:
1. Choose one of the listed options provided within the "Behavior of first transfer" section area.
2. If you have selected "Point in time defined by OPC tag", mark the respective tag in OPC tag
browser and click "Apply" button.
3. The selected tag is added within the "Point in time defined by OPC tag" text box.
4. Select the time zone for data transfer of OPC tags in "Time zone for data of OPC tag" drop
down list field.
5. Click "Ok" button after performing the required changes.
WinCC/IndustrialDataBridge
52 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Note
Tag type
The tags that define a point in time must be of the type "VT_DATE" or be present as a string that
can be converted into the type VT_DATE by the OPC Server.
Note
Transfer behavior
• If the "Transfer current archive values" option is selected, it transfers the current values
(either process values or alarm messages) from the time the data transfer has started.
• With option "Point in time defined by OPC tag" selected, the data transfer will happen from
the date defined by OPC tag (existing in text box) till current date.
Note
New or changed configuration file
The functionality is only supported if no new or a changed configuration file is loaded in the IDB
runtime environment.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 53
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
zone is the local time on the computer, on which the configuration was performed. If the
OPC server is in another time zone, select the respective time zone.
Note
UTC Time format
Since the data will be stored in UTC time format within the database, it is strongly recommended
to follow or set the time zone to UTC time format.
Trigger
Configure the condition that triggers a data transfer for this link in the "Trigger Provider" dialog
window. The description for this dialog window is provided in the chapter "Configuring a Trigger".
See also
Step 4: Configuring a Trigger (Page 54)
Introduction
The "Trigger Provider" dialog window provides the OPC settings, Trigger configuration options
and required fields that help you to configure the condition that triggers a data transfer. This
dialog window is opened after clicking the "Trigger" button in Transfer options window.
Procedure
In "OPC settings" area, select the OPC server by clicking on the [...] button. The selection of the
server is supported by an OPC tag browser. Next, click the button representing "tick mark" to
accept the changes.
WinCC/IndustrialDataBridge
54 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 55
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
1. The browser shows the local OPC server. You can search for OPC servers in the network as
well.
2. If this server is located on another computer, enter the computer name as well. The tree
structure of OPC server is displayed within "Trigger Configuration" area.
3. You can define an OPC item on the trigger provider, in which the success-/failure-status of the
data transfer will be stored in the "Tag for transaction security" field. This value should have
1 byte signed char (e.g. VT_I1). -1 indicates the success state and 0 indicates failure.
4. Select the tag of the OPC server, in which this information is to be saved in the tag browser
and click on the "Apply item" button.
5. In "Trigger Configuration" area, select the desired tags individually and accept them by
clicking on "Add item" each time.
6. Use the "Remove item" button to remove the marked item. If no item is marked for deletion,
the last item from the list is deleted if you click the "Remove item" button. Details about the
columns in the Tag list are located in section "Tag declaration".
Note
OPC Server
After selection of the tags and adding them to tag list, if you switch to another OPC Server in
OPC Settings area, a dialog window is displayed that prompts the message whether you wish
to discard previous settings.
7. In "Trigger condition" area, you can select the type of syntax with selection button "VB Style"
or JScript Style". If a trigger condition is already created, this setting can no longer be
changed. If the language is to be changed, the text in the "Configure Trigger Condition" field
must be deleted.
Details on the programming languages are located in section "Programming Languages".
8. Create the trigger condition in the selected language. Use the Alias designations in the tag
list for these tags. Within the text box displayed, enter the operator symbols using the
keyboard or select them from the "Logical patterns" list box.
WinCC/IndustrialDataBridge
56 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
9. Test the created condition by clicking on "Validate". The trigger condition is calculated with
the values that are entered in the "Test value" column. The result "TRUE" or "FALSE" is shown
in a message box.
10.If the trigger condition provides the correct result and after confirming the changes, close the
dialog by clicking on "OK" button.
Additional Information
Tag declaration
The columns for the tag declaration contain the following:
• Data type: Data type of the tag. If the data type defined here does not match that on the
server, an attempt to convert the data type is made.
• TagID: The TagID of the tag on the OPC server
• Alias: The alias is used for creating the trigger condition. This name must be unique and it
must correspond with the naming conventions of the allocated programming languages. For
more detailed information about the naming conventions, see paragraph "Valid alias names".
• Confirmation value: The confirmation value is the value that the variable takes on after
fulfilling the trigger condition and the values have been delivered to the consumer. The
default value is "<Empty>", i.e., no confirmation value is written.
• Test value: This value is only for testing the trigger condition and has no influence on the later
data exchange. The test values are to be selected and changed so that they test whether the
trigger condition delivers the expected result in all operating conditions.
Note
Confirmation value
The confirmation value does not give any information on whether a transaction has been
completed successfully.
Note
Necessity of Alias names
The OPC ItemID is not used because it may possibly not correspond with the tag validity criteria,
for instance, a "Point" in the tag name is not allowed.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 57
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
• Key words from VB script or J script are not allowed. Note the respective language description
for this.
• Case sensitive (upper and lower case letters).
("tag" is not the same as "Tag").
Programming languages
You can use VBScript or JScript for the trigger condition.
The following table shows the operator type and their symbols in both languages:
It is recommended to use these operators only. Other operators can be found in the language
descriptions for the respective language.
Note
Loss of Trigger Events
The triggering depends on the update speed of the OPC server. In this case, note that data
changes that occur within an update cycle are not considered by the trigger. That means that a
faster change of a tag from 1 - 0 - 1 is not necessarily indicated to the trigger provider by the OPC
server, since the 1 exists at the end again and no value change exists at the check time. This
means that a potentially true condition is not recognized as being true and therefore will not lead
to a data transfer.
Configurations, with which the confirmation value is to set a "true" trigger condition to "false"
again, are not secure because of the statement above. When data changes occur too quickly, the
"true value" may stay the same or values can be left out.
WinCC/IndustrialDataBridge
58 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Introduction
This chapter provides the steps for performing a connection mapping between provider and
consumer.
Connecting Tags
In "Settings" window, the "Connection mapping" tab includes the required fields to connect tags
that have been sent from WinCC OLEDB interface with the selected data consumer. The
Connection mapping tab divides the window into 3 sections.
• WinCC OLEDB provider
• WinCC User Archive consumer
• Connection mapping properties
The "WinCC OLEDB provider" section is displayed at top left portion of "Connection mapping"
tab. This section provides you with required options to choose column name from the list
of columns displayed in "Columns" section area. The "WinCC User Archive consumer" section
exists below the provider section and includes required options to choose schema, table
name and column names that can be mapped with the columns existing within WinCC
OLEDB interface.
A specific connection can be created between the WinCC OLEDB provider column and the
column (belonging to WinCC User Archive consumer) selected in the Where statement tab.
You can create a new connection or else modify an existing connection to apply Where
statement on the selected column.
The separator between the provider and consumer section provides a resize handle that
helps you to resize the height of the section in order to view the fields within the section
clearly.
The "Connection mapping settings" section is displayed at right side of "Connection mapping"
tab. This section helps you to provide a name for connection along with options for choosing
default name for connection. The "Connect", "Modify connection", "Delete connection" and
"Delete all connections" icons are provided at the top portion of this section.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 59
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
1. In "WinCC OLEDB provider" section, select the column name from the list that is displayed
within "Columns" section area.
2. Upon selection, the column name is displayed in "Column for data value" field. The data type
is selected automatically based on selection of column name.
3. The "Filter" field provides you the option to filter the Column names based on single character
or first few characters of column name.
For example, if you wish to view the column names starting with "S", type this character in
"Filter" text box. All column names starting with "S" are displayed.
4. Next, configure the consumer column in the WinCC User Archive consumer" tab by following
these steps:
– The selected table is shown in the "Table" field. Select the Schema for database if
applicable by selecting from the drop down list in "Schema" field.
– The column names are displayed within "Columns" area. If the table has columns with
respective data types, the time stamp can also be written to the table. In this case, select
the respective "Active" check box and select the column within "Column for timestamp"
field.
5. Select the Column name that you wish to connect with "WinCC OLEDB provider". The selected
column is displayed in "Column for data value" field.
WinCC/IndustrialDataBridge
60 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
6. Check the name of the connection in the "Connection mapping settings" area to the right.
Enter a unique name for the connection in the "Connection name" field or use the options
within "Default name options". Click "Connect" button to confirm your entries.
Note
Data type conversion
If the provider column does not match with consumer column, IDB CS converts the data type
to match with data type of provider. A status window is displayed to indicate this change.
7. Repeat steps 1 to 6 for all elements of the "WinCC OLEDB provider" that you wish to transfer.
"Where-statement" tab
The Where statement is required to be configured in order to select the column within the WinCC
User Archive Consumer. The "Where-statement" tab mainly includes the "Where statement"
configuration section and exception handling section.
5. Check the name of the connection in the "Connection mapping settings" area (right). Enter
a unique name for the connection in the "Connection name" field or use the options within
"Default name options". Click "Connect" button to confirm your entries.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 61
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Result
The connections that you have created are shown in the "Connections" tab of IDB CS Settings
window as well as within the project tree node.
Introduction
This chapter provides you with the complete steps for creating a project and link in IDB
Configuration System application. The objective here is to create a project with corresponding
link having WinCC OLEDB (Message Archive) as provider and CSV/TXT as consumer.
WinCC/IndustrialDataBridge
62 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Procedure
1. Open IDB Configuration and create a project by following the steps mentioned below:
– In IDB Configuration menu, select "Project" > "Create" to create a new project.
– In the "Create new project" dialog box, specify a project name, click [...] button and select
the folder location wherever the project needs to be saved.
– After entering the required information, select "Create" button. This creates a new project.
2. The project name will be listed within the "Project tree".
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 63
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
3. The next step is to create a link. Follow the steps mentioned below to create a link between
provider and consumer:
– Right click on project name node in the tree structure and select "Add new link" option.
After creating a project, by default a new node "Add new link" is displayed in project tree
below project name node.
Alternatively, you can create a new link by double clicking the "Add new link" node in
project tree.
– In the "Add new link" dialog that is displayed, enter a unique link name.
– Select the provider type as WinCC OLEDB, target type as CSV/TXT and click OK button.
– The created link will be displayed below the project name in project tree.
4. The corresponding entries - Provider, Consumer, Settings and Connections are created as
nodes that exist below the new link in the tree structure.
Result
You have created a project that consists of a link having WinCC OLEDB as provider and CSV/TXT
as consumer.
Introduction
In this chapter, you will configure the respective provider/consumer configuration along with
transfer behaviour settings for provider.
WinCC/IndustrialDataBridge
64 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Procedure
1. In project tree, open the Provider configuration window by double clicking the Provider node.
In Provider configuration window, click on [...] button and select the WinCC project XML file
that you have exported from WinCC.
Note
WinCC Project XML export file
While selecting the WinCC project XML export file, please remember to choose the
appropriate WinCC project XML file. Export the XML file from the computer that has WinCC
installed. In WinCC Explorer, select "IndustrialDataBridge" > "Project XML Export" option to
export the XML file.
2. For IDB CS to be used on a WinCC station, ensure that you do not mark the "Use Single point
of system access" for selection.
– In "Archive configuration" section, select the WinCC station name of the selected provider.
Note
WinCC Station
• The WinCC station name is listed in the drop down list box of "WinCC station name" field
that displays the station name wherever the WinCC XML file exists. Choose the WinCC
station name by selecting from list.
• The project name is automatically displayed based on the WinCC project XML file that is
selected in "WinCC project XML file" text box.
3. Next, double click the Consumer node in project tree to open the consumer configuration
window.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 65
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
– In "CSV/TXT Configuration" field, click [...] button and select the appropriate folder by
browsing the folder structure.
– Click "Test" button to test the connection. The "Connection string" will be displayed in the
Connection string text box displayed at top portion within this window.
WinCC/IndustrialDataBridge
66 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
1. In project tree, double click the Settings node to open Settings window in the work area. The
Settings window consists of 3 tabs - Transfer options, Connection Mapping & Connections.
2. Within the Transfer Options tab, you can configure the archive settings and transfer behavior
settings for provider.
3. In "Archive settings" section, choose the Archive type. In "Archive" field, select whether data
is to be transferred from 'Process value archive' or from 'Alarm message archive'.
Depending on the archive type selected, the "Process value" button and "Events" button will
be shown in disable or enable state.
4. Click on "Process value" button open the "Variable Filter" window. The "Event filter" window
can be opened by clicking on the "Events" button.
5. Select the appropriate time zone in the "Time zone for consumer" field.
6. In "Time settings" section, enter the cycle time and choose metric (milli seconds / seconds /
minutes / hours) by selecting the drop down list box.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 67
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Note
Transfer type
Based on transfer type, the buttons "Time span", "Start-up behavior" and "Trigger" will be in
enable or disable state.
• If option "Cyclic & Continuously" or "Triggered & Continuously" is selected, both the "Start-
up behavior" and "Trigger" buttons can be used.
• With option "Triggered time span", only the Timespan and Trigger buttons can be used.
8. Configure the "Trigger" and "Time span" or the "Start-up behavior" in the dialog window that
you open by clicking the respective button.
More information about the transfer setting capabilities and their options are provided in
chapter "Step 3: Configuration of transfer behavior (Page 69)".
9. The transfer behavior settings for WinCC OLEDB as provider will be saved automatically.
Note
Saving changes
A save operation is not required every time whenever changes are performed within the
editor window in the work area. The changes made to these settings are automatically saved.
However, once the project is created, at any point of time, you can save the project by
selecting the "Project" > "Save" menu option.
Result
You have configured the WinCC OLEDB interface and CSV/TXT as a consumer. These elements are
displayed in the tree structure of the configuration interface.
See also
Step 3: Configuration of Transfer Behavior (Page 46)
WinCC/IndustrialDataBridge
68 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Introduction
This chapter highlights the key information related to WinCC OLEDB transfer setting capabilities
and their options.
Configuration options
The Settings window provides user interface controls in form of drop down list box or buttons
or radio buttons that are used to perform "Archive type settings" and "Transfer type settings". The
configuration settings and their options existing within these dialog windows are explained
below.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 69
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
1. In "Archive" field, select the archive for which you wish to transfer the data by choosing from
the drop down list.
2. The "Archive variable" section displays a list of archive variables. Select one or more tags from
the list that is displayed at left hand side of the window.
3. Transfer these tags to the selection field on right side with ">" or use ">>" to transfer all tags
in the list.
Use "<" or "<<" to delete the selected or all tags from the selection field on right side.
4. Confirm this selection by clicking the "OK" button.
WinCC/IndustrialDataBridge
70 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
1. Enter a message number in the "Single Event" field text box and click "Include" button. This
will be added to the "Chosen events" list.
2. To specify a message number range, enter the start range and end range in "From" and "To"
text box. Then, click "Include" button to add this event range.
3. To exclude any event from the list, select the event within the list and click "Exclude" button.
To clear all the events displayed within the "Chosen events" field, click "Delete list" button.
4. You can select the archive language by choosing the "Archive language" field drop down list
box. This will display the archive messages in the selected language.
5. Once you have performed the changes, confirm this selection by clicking the "OK" button.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 71
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Time span
The "Time span" button is activated only if you have selected the radio button option "Triggered
time span". Click "Time span" button to open the "Time span" dialog window. The transfer time
period for selected tags is defined in this "Time span" window. The selection is controlled through
tags of the OPC Server provided within the OPC tag browser.
In "Time span" window, "Define update cycle" section area, the time period can be defined
using two different ways:
• With a Start time and an End time (using "From" and "To" selection)
• With a Start time and Time period (using "+/-" selection)
WinCC/IndustrialDataBridge
72 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Procedure
To define the transfer time period, follow these steps:
1. Select the tags that define the Start time by performing selection within the OPC tag browser.
2. Confirm the selection by clicking the "Apply" button in the "From" line. The selected tag is
added within the "From" text box.
3. Define whether you want to define an End time or a period of time by selecting the
appropriate radio button.
4. Select the tags that define End time or the time span in the OPC tag browser. The tag selection
will be added to the text box below "From" field.
5. Confirm the selection by clicking the "Apply" button in the "To" line or "+/-".
6. Click OK button after performing the required changes.
Note
Tag type
The tags that define a time span must be of the type "VT_I4 or be present as string that can be
converted into the type "VT_I4" by the OPC server. With the time span, the preceding sign
determines whether the period of time is before (-) or after (+) the start time (From).
Note
No Time period defined
If no transfer time period is selected within the "From" and "To" or "+/-" fields, all available data
is transferred.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 73
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
• Chinese; LCID="2052"
• Japanese; LCID="1041"
Additional values for LCID are available under http://www.microsoft.com (http://
www.microsoft.com) when you enter the search term "LCID".
Start-up behavior
The "Start-up behavior" button is activated if any one of the transfer types "Cyclic & continuously"
or "Triggered & continuously" is selected. To open the "Start-up behavior" dialog window, select
"Start-up behavior" button. The settings mentioned here will be used during start of the
IndustrialDataBridge Runtime.
WinCC/IndustrialDataBridge
74 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Procedure
To configure the behavior of first transfer, follow these steps:
1. Choose one of the listed options provided within the "Behavior of first transfer" section area.
2. If you have selected "Point in time defined by OPC tag", mark the respective tag in OPC tag
browser and click "Apply" button.
3. The selected tag is added within the "Point in time defined by OPC tag" text box.
4. Select the time zone for data transfer of OPC tags in "Time zone for data of OPC tag" drop
down list field.
5. Click "Ok" button after performing the required changes.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 75
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Note
Tag type
The tags that define a point in time must be of the type "VT_DATE" or be present as a string that
can be converted into the type VT_DATE by the OPC Server.
Note
Transfer behavior
• If the "Transfer current archive values" option is selected, it transfers the current values
(either process values or alarm messages) from the time the data transfer has started.
• With option "Point in time defined by OPC tag" selected, the data transfer will happen from
the date defined by OPC tag (existing in text box) till current date.
Note
New or changed configuration file
The functionality is only supported if no new or a changed configuration file is loaded in the IDB
runtime environment.
WinCC/IndustrialDataBridge
76 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
zone is the local time on the computer, on which the configuration was performed. If the
OPC server is in another time zone, select the respective time zone.
Note
UTC Time format
Since the data will be stored in UTC time format within the database, it is strongly recommended
to follow or set the time zone to UTC time format.
Trigger
Configure the condition that triggers a data transfer for this link in the "Trigger Provider" dialog
window. The description for this dialog window is provided in the chapter "Configuring a Trigger
(Page 77)".
Introduction
The "Trigger Provider" dialog window provides the OPC settings, Trigger configuration options
and required fields that help you to configure the condition that triggers a data transfer. This
dialog window is opened after clicking the "Trigger" button in Transfer options window.
Procedure
In "OPC settings" area, select the OPC server by clicking on the [...] button. The selection of the
server is supported by an OPC tag browser. Next, click the button representing "tick mark" to
accept the changes.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 77
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
WinCC/IndustrialDataBridge
78 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
1. The browser shows the local OPC server. You can search for OPC servers in the network as
well.
2. If this server is located on another computer, enter the computer name as well. The tree
structure of OPC server is displayed within "Trigger Configuration" area.
3. You can define an OPC item on the trigger provider, in which the success-/failure-status of the
data transfer will be stored in the "Tag for transaction security" field. This value should have
1 byte signed char (e.g. VT_I1). -1 indicates the success state and 0 indicates failure.
4. Select the tag of the OPC server, in which this information is to be saved in the tag browser
and click on the "Apply item" button.
5. In "Trigger Configuration" area, select the desired tags individually and accept them by
clicking on "Add item" each time.
6. Use the "Remove item" button to remove the marked item. If no item is marked for deletion,
the last item from the list is deleted if you click the "Remove item" button. Details about the
columns in the Tag list are located in section "Tag declaration".
Note
OPC Server
After selection of the tags and adding them to tag list, if you switch to another OPC Server in
OPC Settings area, a dialog window is displayed that prompts the message whether you wish
to discard previous settings.
7. In "Trigger condition" area, you can select the type of syntax with selection button "VB Style"
or JScript Style". If a trigger condition is already created, this setting can no longer be
changed. If the language is to be changed, the text in the "Configure Trigger Condition" field
must be deleted.
Details on the programming languages are located in section "Programming Languages".
8. Create the trigger condition in the selected language. Use the Alias designations in the tag
list for these tags. Within the text box displayed, enter the operator symbols using the
keyboard or select them from the "Logical patterns" list box.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 79
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
9. Test the created condition by clicking on "Validate". The trigger condition is calculated with
the values that are entered in the "Test value" column. The result "TRUE" or "FALSE" is shown
in a message box.
10.If the trigger condition provides the correct result and after confirming the changes, close the
dialog by clicking on "OK" button.
Additional Information
Tag declaration
The columns for the tag declaration contain the following:
• Data type: Data type of the tag. If the data type defined here does not match that on the
server, an attempt to convert the data type is made.
• TagID: The TagID of the tag on the OPC server
• Alias: The alias is used for creating the trigger condition. This name must be unique and it
must correspond with the naming conventions of the allocated programming languages. For
more detailed information about the naming conventions, see paragraph "Valid alias names".
• Confirmation value: The confirmation value is the value that the variable takes on after
fulfilling the trigger condition and the values have been delivered to the consumer. The
default value is "<Empty>", i.e., no confirmation value is written.
• Test value: This value is only for testing the trigger condition and has no influence on the later
data exchange. The test values are to be selected and changed so that they test whether the
trigger condition delivers the expected result in all operating conditions.
Note
Confirmation value
The confirmation value does not give any information on whether a transaction has been
completed successfully.
Note
Necessity of Alias names
The OPC ItemID is not used because it may possibly not correspond with the tag validity criteria,
for instance, a "Point" in the tag name is not allowed.
WinCC/IndustrialDataBridge
80 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
• Key words from VB script or J script are not allowed. Note the respective language description
for this.
• Case sensitive (upper and lower case letters).
("tag" is not the same as "Tag").
Programming languages
You can use VBScript or JScript for the trigger condition.
The following table shows the operator type and their symbols in both languages:
It is recommended to use these operators only. Other operators can be found in the language
descriptions for the respective language.
Note
Loss of Trigger Events
The triggering depends on the update speed of the OPC server. In this case, note that data
changes that occur within an update cycle are not considered by the trigger. That means that a
faster change of a tag from 1 - 0 - 1 is not necessarily indicated to the trigger provider by the OPC
server, since the 1 exists at the end again and no value change exists at the check time. This
means that a potentially true condition is not recognized as being true and therefore will not lead
to a data transfer.
Configurations, with which the confirmation value is to set a "true" trigger condition to "false"
again, are not secure because of the statement above. When data changes occur too quickly, the
"true value" may stay the same or values can be left out.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 81
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Introduction
This chapter provides the steps for performing a connection mapping between provider and
consumer.
Connecting tags
In "Settings" window, the "Connection mapping" tab includes the required fields to connect tags
that have been sent from WinCC OLEDB interface with the selected data consumer. The
Connection mapping tab divides the window into 3 sections.
• WinCC OLEDB provider
• CSV/TXT consumer
• Connection mapping properties
WinCC/IndustrialDataBridge
82 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
The "Connection mapping settings" section is displayed at right side of "Connection mapping"
tab. This section helps you to provide a name for connection along with options for choosing
default name for connection. The "Connect", "Modify connection", "Delete connection" and
"Delete all connections" icons are provided at the top portion of this section.
CSV/TXT consumer
The CSV/TXT consumer is displayed below the provider section and includes options for
selecting the column within CSV/TXT file. It also provides options to create new CSV/TXT file
with required columns.
In the consumer section, "Maximum entry configuration" tab is displayed next to the
"CSV/TXT consumer" tab. The "Maximum entry configuration" tab provides the required fields
for archive file name generation.
The "CSV/TXT consumer" tab displays the "CSV/TXT" and "Columns" area.
The "CSV/TXT" area includes options to select the CSV/TXT file. The corresponding column
names will be listed in the "Columns" area upon selection of this CSV, TXT file. CSV, TXT
supports only one data type "OLE Automation string (VT_BSTR)". This data type is selected by
default after the selection of respective column name within the "Columns" area.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 83
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Follow the steps provided below to select the CSV/TXT file and choose the required column
name that needs to be mapped:
1. Within "CSV/TXT" area, the "CSV filename" list box is provided that displays a list of CSV or TXT
files. Click the drop down arrow of "CSV filename" field and select the appropriate CSV file.
2. If the CSV/TXT file does not exist in the list, select "New CSV file" button. The "CSV Creator"
dialog box opens thus providing options to create a new CSV file.
In the "CSV creator" dialog window, select "Add" button to create a column entry with default
name. To define a custom name for the column, enter the column name in "Column name"
field provided at top portion of this window. The created columns are displayed within the
"Columns" text area. The "UP" and "DOWN" buttons allows in changing the column sequence.
Note
The keyword "ID" written in capital letters should not be used for creating the first column
name of CSV file. If "ID" is given as column name for the first column, then a warning message
is displayed upon double clicking the CSV file. CSV files do not support this behavior.
3. Enter a file name in the "Filename" text box followed by file extension and select "Create"
button to create the CSV file. The new CSV file will be now available in the file list.
If the file that is selected within the list is of type UTF-8 format, the check box "UTF-8" will be
automatically enabled. If the file is of ANSI format, the check box remains unchecked.
4. In "CSV/TXT consumer" tab, select the CSV file that is displayed in the "CSV filename" field list
box. The "Columns" area displays the "column name" along with its associated "Data type".
WinCC/IndustrialDataBridge
84 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
5. In "Columns" area, select the column name from the list. The selected column name is
displayed in "Column for data value" field and the corresponding data type is selected and
displayed in "Data type" field.
6. To add new columns to the selected CSV file, navigate to bottom portion of the column list
and double click the row that contains the text "<Add new column>".
7. The "Column name" dialog box is displayed that allows you to enter the new column name.
Enter a name for the new column and click "Create" button.
The new column will be listed within the list of column names. You can create any number
of columns by repeating Steps 6 & 7.
8. If the column name has "Date/time" data type, the time stamp can be written to the specific
column. In this case, select the respective "Active" check box and select the column in
"Column for timestamp" field list box.
9. The "Filter" field provides you the option to filter the Column names based on single character
or first few characters of column name.
For example, if you wish to view the column names starting with "S", type this character in
"Filter" text box. All column names starting with "S" are displayed.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 85
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Note
• If this check box "Archive File at Maximum Entry" is unchecked, the Archive File Name
Generation and other file name selection options within this tab will be in disable state.
2. In "Archive File Name Generation" area, options are provided for file name generation with
respect to the archive file. Select any one of the following options by selecting the radio
button.
– Use current date and time
– Use current date and serial number
– Use serial number
3. Next, specify the Archive path in the text box provided. You can either enter the full path
name in the text box or select the path using "..." button. If you provide the path in archive
path text box, archived CSV files are generated at this path. By default, this text box has the
same path where the base CSV file is present.
WinCC/IndustrialDataBridge
86 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
4. The "Use Dedicated File Name" check box allows for options to specify a dedicated file name
in combination with a serial number and date or date and time or serial number. If this
checkbox is unchecked, then the base CSV filename will be used for archiving.
5. The "Select filename type" field provides options to select custom file name.
– To use custom file name, select filename type as "Use custom filename" and enter the
custom file name in "Custom file name" text box.
Note
Serial number
A range of 1 - 999999999 is supported for the serial number. During runtime, if the serial
number exceeds this maximum value, a trace log will be automatically created when this value
is reached. Once this upper limit is reached, IDB will not create any new archive file. The same
file will be updated continuously during data transfer.
Note
Upon selection of "Use Dedicated File Name" check box, the 'Select Filename Type' provides an
option "Use custom filename" within the drop down list. Select this option and enter the
customer filename in "Custom filename" text box.
The option "Use Filename from WinCC Tag" is provided only with providers that supports Tags.
Connection Mapping
To establish connection between the provider and consumer, a data column mapping is
required to be performed. Defining a connection name is the first step towards the setup of
a connection. The Connection window displays "Default connection name" options in order
to specify a name for default connection. Connect, Modify connection, Delete connection
and Delete all connections icons are provided below the "Default connection name" section.
These buttons help in order to work with the connections.
Note
Modify connection
To modify an existing connection, perform the required changes and then select "Modify"
button. The changes can be observed within the Connection window only after selecting the
"Modify" button.
Follow these steps to perform column mapping between provider and consumer:
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 87
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
1. Select a tag name from "WinCC OLEDB provider" and choose the column name from CSV/TXT
consumer" column that needs to be mapped. Click "Connect" button.
2. If there is a data mismatch between the provider and consumer columns, IDB CS will modify
the data type to VT_BSTR data type and displays the message "The provider data type was
changed to fit the consumer type". Next, click OK.
3. Repeat steps 1 & 2 for all elements of the provider that you wish to transfer. A connection is
created for each of the column values in provider and consumer.
4. To use dedicated file name, enable the "Use dedicated filename" check box and select "Use
custom filename" in "Select filename type" field.
Enter custom filename in "Custom filename" text box.
5. Specify a connection name for this connection from the options provided within the "Default
Connection name" area and click "Connect" button.
Note
Data type conversion
If the provider column does not match with consumer column, IDB CS converts the data type
to match with data type of provider. A status window is displayed to indicate this change.
6. The connection name including the provider and consumer data values will be displayed
below the Connect button.
7. The list of connections will be displayed in the Connections tab.
Note
Column for time stamp
The time stamp must be assigned before connecting the first tags. Afterwards, adding or
changing is only possible if all items are deleted, the dialog is closed and reopened again. The
time stamp is generated from the local time, if new data is transferred from the provider.
Result
The connections that you have created are shown in the "Connections" tab of IDB CS "Settings"
window as well as within the project tree node.
WinCC/IndustrialDataBridge
88 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Introduction
This chapter provides you with the complete steps for creating a project and link in IDB
Configuration System application. The objective here is to create a project with corresponding
link having WinCC User Archive as provider and OPC DataAccess as consumer.
Procedure
1. Open IDB Configuration and create a project by following the steps mentioned below:
– In IDB Configuration menu, select "Project" > "Create" to create a new project.
– In the "Create new project" dialog box, specify a project name, click [...] button and select
the folder location wherever the project needs to be saved.
– After entering the required information, select "Create" button. This creates a new project.
2. The project name will be listed within the "Project tree".
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 89
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
3. The next step is to create a link. Follow the steps mentioned below to create a link between
provider and consumer:
– Right click on project name node in the tree structure and select "Add new link" option.
After creating a project, by default a new node "Add new link" is displayed in project tree
below project name node.
Alternatively, you can create a new link by double clicking the "Add new link" node in
project tree.
– In the "Add new link" dialog that is displayed, enter a unique link name.
– Select the provider type as WinCC User Archive, consumer type as OPC DataAccess and
click OK button.
– The created link will be displayed below the project name in project tree.
4. The corresponding entries - Provider, Consumer, Settings and Connections are created as
nodes that exist below the new link in the tree structure.
Result
You have created a project that consists of a link having WinCC User Archive as provider and OPC
DataAccess as consumer.
Introduction
In this chapter, you will configure the respective provider/consumer configuration along with
transfer behaviour settings.
WinCC/IndustrialDataBridge
90 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Procedure
1. In project tree, open the Provider configuration window by double clicking the Provider node.
Note
Connection String
In "WinCC User Archive provider configuration" window, the "Connection string" field (at top
portion) displays the database connection string parameters after the selection of database
type.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 91
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Note
User Archive
Ensure that you enter the complete path of the computer wherever WinCC has been installed.
If the path name is not valid, then the "Database" field will not display any tables. Also, it is
important to verify that the user archive table contains one or more rows of data.
WinCC/IndustrialDataBridge
92 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Note
Node name
For local OPC Server, the node name will display as "local host". In case of remote OPC Server,
the remote computer name will be displayed after selection of OPC Server on the remote
computer. This node name is required for searching the OPC Server from the remote
computer.
The OPC tag browser does not display any content if node name is invalid.
Note
The "OPC Server" and "Node name" fields are provided as editable fields. If the information
about OPC Server name and node name is known, you can directly enter the information in
the "OPC Server" and "Node name" fields. If the node name / OPC Server name is invalid, there
will be no content displayed within the OPC tag browser.
"Configuration for bad quality item" section
– In the "Configure a Variable number of transaction errors" field, click on [...] button and
select a tag in OPC tag browser. Next, click the button representing "tick mark" to accept
the changes. The amount of tags with errors is written with provider tags with
QUALITY=BAD.
– Choose the specific data type by selecting from the drop down list box.
Note
OPC tags
Selection of the tag in OPC tag browser displays the corresponding data type in "Datatype"
field. However, if you know the tag name, enter the tag name in "Configure a Variable for
number of transaction errors" field and select the data type in "Datatype" field by selecting
from the list.
"Asynchronous transfer configuration" section
– Enable the check box option "Write asynchronous" for asynchronous writing.
– Enter the permitted number of maximum outstanding write transactions in the text box.
Note
Asynchronous transfer
If the "Write asynchronous" check box is enabled, a default value of 10 is set and will be
displayed within the "Maximum number of outstanding write transaction" text box. When
this check box is disabled, the value will be reset to 0. You can type a value in this text box
ranging from 1 - 40. If the value entered in this text box is not within the range, then an error
message is displayed.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 93
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Note
Asynchronous writing
The Asynchronous transfer configuration is useful to ensure the correctness of the actual
data transfer that is happening.
Example: If you have configured the "Maximum number of outstanding write transaction" as
15 and if the data transfer is not happening correctly, after the failure of 15th transaction, a
warning message will be displayed in the IDB Runtime Trace view.
2. Within the Transfer options tab, you can configure the transfer behavior settings for provider.
– Select the Table name by selecting from the drop down list.
Note
Schema
• In WinCC User Archive, a default schema is selected automatically in the Transfer
options tab.
3. Click "Event" button to configure the trigger provider settings. The "Trigger provider" will be
opened.
The description of the "Trigger provider" window is provided in chapter "Configuring a Trigger
(Page 95)"
4. The transfer behavior settings for provider will be saved automatically.
WinCC/IndustrialDataBridge
94 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Result
You have configured the WinCC User Archive interface and OPC DataAccess as consumer
including the provider transfer options. These elements are displayed in the tree structure of the
IDB configuration interface.
Introduction
The "Trigger Provider" dialog window provides the OPC settings, Trigger configuration options
and required fields that help you to configure the condition that triggers a data transfer. This
dialog window is opened after clicking the "Trigger" button in Transfer options window.
Note
OPC tag browser
The OPC tags within "Trigger configuration" section will only be displayed if you have already
selected the name of the OPC Server.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 95
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
WinCC/IndustrialDataBridge
96 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Procedure
1. In "OPC settings" area, select the OPC server by clicking on the [...] button. The selection of
the server is supported by an OPC tag browser. Next, click the button representing "tick mark"
to accept the changes.
2. If this server is located on another computer, enter the computer name as well. The tree
structure of OPC server is displayed within "Trigger Configuration" area.
Note
Node name
For local OPC Server, the node name will display as "local host". In case of remote OPC Server,
the remote computer name will be displayed after selection of OPC Server on the remote
computer. This "Node name" is required for searching the OPC Server from the remote
computer.
The OPC tag browser does not display any content if node name is invalid.
Note
The "OPC Server" and "Node name" fields are provided as editable fields.
If the information about OPC Server name and node name is known, you can directly enter
the information in the "OPC Server" and "Node name" fields. If the node name / OPC Server
name is invalid, there will be no content displayed within the OPC tag browser.
3. You can define an OPC tag on the trigger source, in which the success-/failure-status of the
data transfer will be stored in the "Tag for transaction security" field. This value should have
1 byte signed char (e.g. VT_I1). -1 indicates the success state and 0 indicates failure.
Select the tag of the OPC server, in which this information is to be saved in the tag browser
and click on the "Apply item" button.
4. In "Trigger Configuration" area, select the desired tags individually and accept them by
clicking on "Add item" each time.
The selected tags are shown in the Tag list below.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 97
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
5. Use the "Remove item" button to remove the marked item. If no item is marked for deletion,
the last item from the list is deleted if you click the "Remove item" button. Details about the
columns in the Tag list are located in section "Tag declaration".
Note
OPC Server
After selection of the tags and adding them to tag list, if you switch to another OPC Server in
OPC Settings area, a dialog window is displayed that prompts the message whether you wish
to discard previous settings.
6. In "Trigger condition" area, you can select the type of syntax with selection button "VB Style"
or JScript Style". If a trigger condition is already created, this setting can no longer be
changed. If the language is to be changed, the text in the "Configure Trigger Condition" field
must be deleted.
Details on the programming languages are located in section "Programming Languages".
7. Create the trigger condition in the selected language. Use the Alias designations in the tag
list for these tags. Within the text box displayed, enter the operator symbols using the
keyboard or select them from the "Logical patterns" list box.
8. Test the created condition by clicking on "Validate". The trigger condition is calculated with
the values that are entered in the "Test value" column. The result "TRUE" or "FALSE" is shown
in a message box.
9. If the trigger condition provides the correct result and after confirming the changes, close the
dialog by clicking on "OK" button.
Additional Information
Tag declaration
The columns for the tag declaration contain the following:
• Data type: Data type of the tag. If the data type defined here does not match that on the
server, an attempt to convert the data type is made.
• TagID: The TagID of the tag on the OPC server
• Alias: The alias is used for creating the trigger condition. This name must be unique and it
must correspond with the naming conventions of the allocated programming languages. For
more detailed information about the naming conventions, see paragraph "Valid alias names".
• Confirmation value: The confirmation value is the value that the variable takes on after
fulfilling the trigger condition and the values have been delivered to the consumer. The
default value is "<Empty>", i.e., no confirmation value is written.
• Test value: This value is only for testing the trigger condition and has no influence on the later
data exchange. The test values are to be selected and changed so that they test whether the
trigger condition delivers the expected result in all operating conditions.
WinCC/IndustrialDataBridge
98 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Note
Confirmation value
The confirmation value does not give any information on whether a transaction has been
completed successfully.
Note
Necessity of Alias names
The OPC ItemID is not used because it may possibly not correspond with the tag validity criteria,
for instance, a "Point" in the tag name is not allowed.
Programming languages
You can use VBScript or JScript for the trigger condition.
The following table shows the operator type and their symbols in both languages:
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 99
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
It is recommended to use these operators only. Other operators can be found in the language
descriptions for the respective language
Note
Loss of Trigger Events
The triggering depends on the update speed of the OPC server. In this case, note that data
changes that occur within an update cycle are not considered by the trigger. That means that a
faster change of a tag from 1 - 0 - 1 is not necessarily indicated to the trigger provider by the OPC
server, since the 1 exists at the end again and no value change exists at the check time. This
means that a potentially true condition is not recognized as being true and therefore will not lead
to a data transfer.
Configurations, with which the confirmation value is to set a "true" trigger condition to "false"
again, are not secure because of the statement above. When data changes occur too quickly, the
"true value" may stay the same or values can be left out.
Introduction
This chapter provides the steps for performing connection mapping between provider and
consumer.
Connecting Tags
In "Settings" window, the "Connection mapping" tab includes the required fields to connect tags
that have been sent from the WinCC User Archives interface with the selected consumer. The
Connection mapping tab divides the window into 3 sections
• WinCC User Archive Provider
• OPC Data Access consumer
• Connection mapping settings
WinCC/IndustrialDataBridge
100 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
The "WinCC User Archive Provider" section is displayed at top left portion of "Connection
mapping" tab. This section provides you with required options to choose schema, table name
and column name(s) to be mapped. The "OPC Data Access consumer" section is displayed
at bottom left portion of "Connection mapping" tab. This section provides you with required
options to choose the tag name from the list of OPC tags in the OPC tag browser that can be
mapped with WinCC User Archive provider column.
The separator between the provider and consumer section provides a resize handle that
helps you to resize the height of the section in order to view the fields within the section
clearly.
The "Connection mapping settings" section is displayed at right side of "Connection mapping"
tab. This section helps you to provide a name for connection along with options for choosing
default name for connection. The "Connect", "Modify connection", "Delete connection" and
"Delete all connections" icons are provided at the top position of this section.
Note
Connecting mapping tab
To get a clear view of all fields in the sections within the "Connection mapping" tab, it is
suggested to use the "Collapse" option within the Inspector window and Project tree. Once you
click on "Collapse" icon, the window minimizes and provides with "Expand" option. At any point
of time, to bring back the window, click on "Expand" icon.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 101
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Note
Select OPC Server
In order to configure the settings on the "Where Statement" tab, you must have selected an OPC
server in the dialog "Trigger Provider (Page 95)". This dialog window is accessed by clicking on
the "Event" button in "Transfer options" tab.
Note
Data type conversion
If the provider tag data type does not match with consumer column, IDB CS converts the data
type to match with data type of provider tag. A status window is displayed to indicate this
change.
5. Check the name of the connection in the "Connection mapping settings" area to the right.
Enter a unique name for the connection in the "Connection name" field or use the options
within "Default name options". Click "Connect" button to confirm your entries.
6. Repeat steps 1 to 4 for all elements of the "WinCC User Archive Provider" that you wish to
transfer.
WinCC/IndustrialDataBridge
102 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Note
Array
If the WinCC User Archive provider tag has a data type selected other than array data type and
if the OPC Data Access consumer tag has "Array" data type wherein the "Array" check box has
been checked, then after clicking the "Connect" button, an error message is displayed. This will
not allow to perform a connection mapping as "Array" data type might not be supported by the
selected provider.
Where Statement
The SQL String that describes the access location for reading the data is shown on this tab.
The "Where-statement" tab mainly includes the "WHERE" section and text area for displaying
the "Resulting SQL-String".
Note
Columns
The Column names shown in screenshot below might vary depending on the table used within
Where statement.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 103
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
1. Click "Add" button to open the dialog that provides you with options to select the column in
order to compare the content.
2. Select the Fieldname you wish to check for a certain value. The selected field name is
displayed in "Fieldname" field. The data type for this field name is automatically selected in
the "Datatype" field.
3. This "Fieldname" is shown in the "WHERE" text box. Choose the operator symbol from the
drop down list that is used for comparison.
4. In "OPC-variable" section, select the OPC tag, the value of which is compared with the
previously selected column entry. Then, click OK button.
5. The condition is shown in the table within "Where" section and is entered in the "Resulting
SQL String" field.
6. To remove an already existing "Resulting SQL String", click "Remove" button.
7. To define multiple conditions, repeat steps 1 to 5.
WinCC/IndustrialDataBridge
104 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Note
SQL String
• If multiple conditions are configured, they are connected with a logical "AND".
• Only data records (lines) are requested from the IDB and transferred in which all conditions
have been met.
• An optional connection is not possible with a logical "OR".
Advanced
Using button "Advanced", you can define the sort sequence and the behavior when multiple
data records exist.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 105
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
• Order By
Select the selection field. You can then define the column name and the sort direction.
• Behavior with several results:
Select one of the following option fields and click OK button. Based on selected radio button,
you can decide the action to be performed:
– Error message (no data transferred)
– Submit first line
– Submit last line
– Submit all lines
OPC tab
The "OPC" tab includes options to connect OPC tag(s) that have been sent from the WinCC
User Archive interface with OPC Data Access consumer tag(s).
Note
Select OPC Server
In order to configure the settings on the "OPC" tab, you must have selected an OPC server in
dialog "Trigger Provider (Page 95)". This dialog window is accessed by clicking on the "Event"
button in "Transfer options" tab.
1. In the "WinCC User Archive Provider" area, within the OPC tab, the OPC tag browser is
displayed. In tag browser, select the tag for which the values should be transferred. The
selected tag is shown in the "Tag ID" field. The data type is chosen according to the selection.
2. If the selected tag has Array data type, then the "Array" check box is automatically enabled.
This check box is provided below the "Datatype" field.
3. Next, configure the consumer column in the "Database consumer" section by following these
steps:
– The selected table is shown in the "Table" field. Select the Schema if applicable by
selecting from the drop down list in "Schema" text box.
– The column names are displayed within "Columns" area. If the table has columns with
respective data types, the time stamp can also be written to the table. In this case, select
the respective "Active" check box and select the column within "Column for timestamp"
field.
4. Select the Column name that you wish to connect with the OPC tag. The selected column is
displayed in "Column for data value" field.
WinCC/IndustrialDataBridge
106 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
5. Check the name of the connection in the "Connection mapping settings" area to the right.
Enter a unique name for the connection in the "Connection name" field or use the options
within "Default name options". Click "Connect" button to confirm your entries.
Note
Data type conversion
If the provider column does not match with consumer column, IDB CS converts the data type
to match with data type of provider. A status window is displayed to indicate this change.
6. Repeat steps 1 to 5 for all elements of the "WinCC User Archive Provider" that you wish to
transfer.
Note
Array
If the WinCC User Archive provider column has a data type selected other than array data type
and if the OPC Data Access consumer tag has "Array" data type wherein the "Array" check box has
been checked, then after clicking the "Connect" button, an error message is displayed. This will
not allow to perform a connection mapping as "Array" data type might not be supported by the
selected provider.
Result
The connections that you have created are shown in the "Connections" tab of IDB CS "Settings"
window as well as within the project tree node.
Overview
This chapter provides information about the steps to be followed in order to view Getting Started
Example 1 in WinCC Runtime environment. The Getting Started project provided along with the
installation includes all the required resources for running the example project.
Prerequisites
• WinCC is installed
• IDB Getting Started project "idb_getting_started.MCP" is loaded in WinCC and project is
activated
• IDB CS application is open
• Getting Started project "IDBProject" is loaded in IDB CS application
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 107
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
– In WinCC OLEDB provider configuration, for use on a WinCC station, select the WinCC
station name by selecting the drop down list in "WinCC station name" field.
– In WinCC User Archive provider /consumer configuration, enter the complete computer
path wherever WinCC has been installed and choose the appropriate database.
– Configure the Where statement and advanced options for WinCC User Archive provider /
consumer in connection mapping tab and create connections.
6. After performing these steps, save the project and export the configuration XML file to the
IDB Getting Started folder (idb_getting_started).
This XML file will be used in IDB Runtime application.
Note
Opening IDB configuration
The IDB configuration required for Getting Started project can also be opened in IDB CS using
"IDBProject.ip80" file. In IDB CS, click Project > Open project and click on Browse button to browse
the folder structure. Select the ".ip80" file existing within "IDBProject" folder by browsing the
folder contents.
WinCC/IndustrialDataBridge
108 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Follow the steps given below to connect the configuration and start data transfer:
1. In IDB Runtime control, select "Options" button to open the "Runtime configuration" window.
In "NT Service" tab, click "Start service" button to start IDB Runtime service and click OK.
2. Next, load the configuration XML file by clicking on the Open button. Please remember to
choose the appropriate configuration XML file that you exported to IDB Getting Started folder
(idb_getting_started).
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 109
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
3. In the "Open" dialog window, browse the idb_getting_started folder contents and select the
configuration file "idb_getting_started_configfile.xml". Click Open button once you have
selected the XML file.
4. The list of connections will be displayed along with provider and consumer status.
Note
Connections displayed in IDB Runtime
The IDB Runtime window displays the connections (links) that belongs to both Example 1 and
Example 2. While working with each example, it is suggested to select the connections (links)
that are used within the specific example.
Note
Switching between Example 1 and Example 2
To switch from one example to other, click the button provided at bottom right hand portion of
the example screen.
It is important to note that after switching to another example, before proceeding further, you
need to stop the data transfer, disconnect the connection(s). Once you are ready, then you can
start connecting the provider/consumer types and start the data transfer.
Result
You have performed the data transfer successfully and have understood the steps for connecting
the configuration links and starting data transfer using IDB with the help of this example.
WinCC/IndustrialDataBridge
110 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
3.5.3.1 Introduction
Introduction
This Getting Started example helps you to understand the data transfer between process
Dynamic database to WinCC User Archive using a simple recipe example. This is shown in the
Getting Started Example 2.
This example helps you to perform data transfer based on the values you have entered.
Further, the production results are inputted by user using the text box controls in Example 2.
The production results can be updated to the Dynamic database.
Note
Example project - IDBProject
The example that includes the complete configuration provided along with Getting Started
project contains a fully defined configuration, provider transfer options that are set along with
connections that have already been created.
Example 2 uses the following configuration available as links. In example 2, you will create 2
links "Download_RecipeData" and "Upload_ProductionResult" within this example project.
You can view this configuration in IDB CS application.
• Dynamic Database as provider, WinCC User Archive as consumer
• WinCC User Archive as provider, Dynamic Database as consumer
However, in order to make you understand better, the following chapters provide information
about the steps in detail for creating or configuring the connections. Each chapter includes a
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 111
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
series of steps listed as Step 1, Step 2, Step 3 and Step 4 that guides you through the detailed
procedure.
• Dynamic Database - WinCC User Archive
• WinCC User Archive - Dynamic Database
Note
Important information
In case you do not want to perform the steps given in above mentioned chapters, and you wish
to view the example in WinCC Runtime directly, it is strongly recommended to perform the steps
mentioned in the chapter "Viewing Example 2 in WinCC Runtime (Page 150)".
Introduction
This chapter provides you with the complete steps for creating a project and link in IDB
Configuration System application. The objective here is to create a project with corresponding
link having Dynamic Database as provider and WinCC User Archive as consumer.
WinCC/IndustrialDataBridge
112 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Procedure
1. Open IDB Configuration and create a project by following the steps mentioned below:
– In IDB Configuration menu, select "Project" > "Create" to create a new project.
– In the "Create new project" dialog box, specify a project name, click [...] button and select
the folder location wherever the project needs to be saved.
– After entering the required information, select "Create" button. This creates a new project.
2. The project name will be listed within the "Project tree".
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 113
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
3. The next step is to create a link. Follow the steps mentioned below to create a link between
provider and consumer:
– Right click on project name node in the tree structure and select "Add new link" option.
After creating a project, by default a new node "Add new link" is displayed in project tree
below project name node.
Alternatively, you can create a new link by double clicking the "Add new link" node in
project tree.
– In the "Add new link" dialog that is displayed, enter a unique link name.
– Select the provider type as Dynamic Database, consumer type as WinCC User Archive and
click OK button.
– The created link will be displayed below the project name in project tree.
4. The corresponding entries - Provider, Consumer, Settings and Connections are created as
nodes that exist below the new link in the tree structure.
Result
You have created a project that consists of a link having Dynamic Database as provider and
WinCC User Archive as consumer.
Introduction
In this chapter, you will configure the respective provider/consumer configuration along with
transfer behavior settings for provider.
WinCC/IndustrialDataBridge
114 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Procedure
1. In project tree, open the Provider configuration window by double clicking the Provider node.
– If a user name and password has been set for the database, enter the user name and
password in the "User name" and "Password" fields respectively.
If you wish to set a blank password, enable the check box "Allow saving password".
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 115
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
– Click Test button to test the connection. The application tests the database connection
string and verifies the selected database.
3. In Consumer configuration window, perform the following settings:
– Enter the server name and/or complete path of WinCC User Archive database.
– Select the database name from the list that is displayed in the "Database" field. Click on the
drop down list box to view this list.
– If you wish to enable windows authentication automatically, select the check box "Use
automatic Windows authentication".
– Within the section area that provides options to logon to the database, enter the user
name and password.
This information is required to logon to the WinCC User Archive database.
– Click Test button to test the connection.
Note
User Archive
Ensure that you enter the complete path of the computer wherever WinCC has been installed.
If the path name is not valid, then the "Database" field will not display any tables. Also, it is
important to verify that the user archive table contains one or more rows of data.
WinCC/IndustrialDataBridge
116 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
2. Within the Transfer options tab, you can configure the transfer behavior settings for provider.
Note
Selecting Schema
• If you are using a database other than Microsoft Access, selection of Schema is mandatory
before choosing the Table name.
• While using Microsoft Access as database, the "Schema" field is displayed in disable state
and does not allow any selection of Schema.
– Select the Schema firstly (if applicable for the database) and then choose the Table name
by selecting from the drop down list.
– Click "Event" button to configure the trigger provider settings. The "Trigger provider"
window will be opened.
The description of the "Trigger provider" is provided in chapter "Configuring a Trigger
(Page 118)".
3. The transfer behavior settings for provider will be saved automatically.
Note
Saving changes
A save operation is not required every time whenever changes are performed within the editor
window in the work area. The changes made to these settings are automatically saved. However,
once the project is created, at any point of time, you can save the project by selecting the
"Project" > "Save" menu option.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 117
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Result
You have configured the Dynamic Database interface and WinCC User Archive as consumer.
These elements are displayed in the tree structure of the configuration interface.
Introduction
The "Trigger Provider" dialog window provides the OPC settings, Trigger configuration options
and required fields that help you to configure the condition that triggers a data transfer. This
dialog window is opened after clicking the "Trigger" button in Transfer options window.
Note
OPC tag browser
The OPC tags within "Trigger configuration" section will only be displayed if you have already
selected the name of the OPC Server.
WinCC/IndustrialDataBridge
118 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 119
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Procedure
1. In "OPC settings" area, select the OPC server by clicking on the [...] button. The selection of
the server is supported by an OPC tag browser. Next, click the button representing "tick mark"
to accept the changes.
2. If this server is located on another computer, enter the computer name as well. The tree
structure of OPC server is displayed within "Trigger Configuration" area.
Note
Node name
For local OPC Server, the node name will display as "local host". In case of remote OPC Server,
the remote computer name will be displayed after selection of OPC Server on the remote
computer. This "Node name" is required for searching the OPC Server from the remote
computer.
The OPC tag browser does not display any content if node name is invalid.
Note
The "OPC Server" and "Node name" fields are provided as editable fields.
If the information about OPC Server name and node name is known, you can directly enter
the information in the "OPC Server" and "Node name" fields. If the node name / OPC Server
name is invalid, there will be no content displayed within the OPC tag browser.
3. You can define an OPC tag on the trigger source, in which the success-/failure-status of the
data transfer will be stored in the "Tag for transaction security" field. This value should have
1 byte signed char (e.g. VT_I1). -1 indicates the success state and 0 indicates failure.
Select the tag of the OPC server, in which this information is to be saved in the tag browser
and click on the "Apply item" button.
4. In "Trigger Configuration" area, select the desired tags individually and accept them by
clicking on "Add item" each time.
The selected tags are shown in the Tag list below.
WinCC/IndustrialDataBridge
120 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
5. Use the "Remove item" button to remove the marked item. If no item is marked for deletion,
the last item from the list is deleted if you click the "Remove item" button. Details about the
columns in the Tag list are located in section "Tag declaration".
Note
OPC Server
After selection of the tags and adding them to tag list, if you switch to another OPC Server in
OPC Settings area, a dialog window is displayed that prompts the message whether you wish
to discard previous settings.
6. In "Trigger condition" area, you can select the type of syntax with selection button "VB Style"
or JScript Style". If a trigger condition is already created, this setting can no longer be
changed. If the language is to be changed, the text in the "Configure Trigger Condition" field
must be deleted.
Details on the programming languages are located in section "Programming Languages".
7. Create the trigger condition in the selected language. Use the Alias designations in the tag
list for these tags. Within the text box displayed, enter the operator symbols using the
keyboard or select them from the "Logical patterns" list box.
8. Test the created condition by clicking on "Validate". The trigger condition is calculated with
the values that are entered in the "Test value" column. The result "TRUE" or "FALSE" is shown
in a message box.
9. If the trigger condition provides the correct result and after confirming the changes, close the
dialog by clicking on "OK" button.
Additional Information
Tag declaration
The columns for the tag declaration contain the following:
• Data type: Data type of the tag. If the data type defined here does not match that on the
server, an attempt to convert the data type is made.
• TagID: The TagID of the tag on the OPC server
• Alias: The alias is used for creating the trigger condition. This name must be unique and it
must correspond with the naming conventions of the allocated programming languages. For
more detailed information about the naming conventions, see paragraph "Valid alias names".
• Confirmation value: The confirmation value is the value that the variable takes on after
fulfilling the trigger condition and the values have been delivered to the consumer. The
default value is "<Empty>", i.e., no confirmation value is written.
• Test value: This value is only for testing the trigger condition and has no influence on the later
data exchange. The test values are to be selected and changed so that they test whether the
trigger condition delivers the expected result in all operating conditions.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 121
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Note
Confirmation value
The confirmation value does not give any information on whether a transaction has been
completed successfully.
Note
Necessity of Alias names
The OPC ItemID is not used because it may possibly not correspond with the tag validity criteria,
for instance, a "Point" in the tag name is not allowed.
Programming languages
You can use VBScript or JScript for the trigger condition.
The following table shows the operator type and their symbols in both languages:
WinCC/IndustrialDataBridge
122 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
It is recommended to use these operators only. Other operators can be found in the language
descriptions for the respective language
Note
Loss of Trigger Events
The triggering depends on the update speed of the OPC server. In this case, note that data
changes that occur within an update cycle are not considered by the trigger. That means that a
faster change of a tag from 1 - 0 - 1 is not necessarily indicated to the trigger provider by the OPC
server, since the 1 exists at the end again and no value change exists at the check time. This
means that a potentially true condition is not recognized as being true and therefore will not lead
to a data transfer.
Configurations, with which the confirmation value is to set a "true" trigger condition to "false"
again, are not secure because of the statement above. When data changes occur too quickly, the
"true value" may stay the same or values can be left out.
Introduction
This chapter provides the steps for performing connection mapping between provider and
consumer.
Connecting Tags
In "Settings" window, the "Connection mapping" tab includes the required fields to connect tags
that have been sent from the Dynamic database interface with the selected data consumer. The
Connection mapping tab divides the window into 3 sections
• Dynamic database provider
• WinCC User Archive consumer
• Connection mapping settings
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 123
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Note
Select OPC Server
In order to configure the settings in the "Where Statement" tab, you must have selected an OPC
server in the link settings in dialog "Trigger Provider (Page 118)". This dialog window is accessed
by clicking on the "Event" button in "Transfer options" tab.
Dynamic Database
The "Dynamic database provider" section is displayed at top left portion of "Connection
mapping" tab. This section provides you with required options to choose schema, table name
and column names to be mapped. The "WinCC User Archive Consumer" section is displayed
to bottom left portion of "Connection mapping" tab. This section provides you with required
options to choose schema, table name and column names to be mapped with the columns
existing within Dynamic Database (provider).
The separator between the provider and consumer section provides a resize handle that
helps you to resize the height of the section in order to view the fields within the section
clearly.
The "Connection mapping settings" section is displayed at right side of "Connection mapping"
tab. This section helps you to provide a name for connection along with options for choosing
default name for connection. The "Connect", "Modify connection", "Delete connection" and
"Delete all connections" icons are provided at the top portion of this section.
WinCC/IndustrialDataBridge
124 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Note
Selecting Schema
• If you are using a database other than Microsoft Access, selection of Schema is mandatory
before choosing the Table name.
• While using Microsoft Access as database, the "Schema" field is displayed in disable state and
does not allow any selection of Schema.
Where-statement
Note
Select OPC Server
In order to configure the settings in the "Where Statement" tab, you must have selected an OPC
server in the link settings in dialog "Trigger Provider". This dialog window is accessed by clicking
on the "Event" button in "Transfer options" tab.
Note
Columns
The column names displayed as shown in screenshot might vary depending on the table that is
being used in Where statement.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 125
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
The SQL String that describes the access location for reading the data is shown on this tab.
The "Where-statement" tab mainly includes the "WHERE" section and text area for displaying
the "Resulting SQL-String".
Follow the steps provided below to configure the Where statement:
1. Within Where statement tab, click "Add" button to open the dialog that provides you with
options to select the column in order to compare the content.
2. Select the Fieldname you wish to check for a certain value. The selected field name is
displayed in "Fieldname" field. The data type for this field name is automatically selected in
the "Data type" field.
3. This "Fieldname" is shown in the "WHERE" text box. Choose the operator symbol from the
drop down list that is used for comparision.
4. In "OPC-variable" section, select the OPC tag, the value of which is compared with the
previously selected column entry. Then, click OK button.
5. The condition is shown in the table within "Where" section and is entered in the "Resulting
SQL String" field.
WinCC/IndustrialDataBridge
126 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Note
SQL String
• If multiple conditions are configured, they are connected with a logical "AND".
• Only data records (lines) are requested from the IDB and transferred in which all conditions
have been met.
• An optional connection is not possible with a logical "OR".
Advanced:
Using button "Advanced", you can define the sort sequence and the behavior when multiple
data records exist.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 127
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
• Order By
Select the selection field. You can then define the column name and the sort direction.
• Behaviour with several results:
Select one of the following option fields and click OK button. Based on selected radio button,
you can decide the action to be performed:
– Error message (no data transferred)
– Submit first line
– Submit last line
– Submit all lines
OPC tab
Note
Select OPC Server
In order to configure the settings on the "OPC" tab, you must have selected an OPC server in the
link settings in dialog "Trigger Provider (Page 118)". This dialog window is accessed by clicking
on the "Event" button in "Transfer options" tab.
1. In the "Dynamic database provider" area, navigate to OPC tab. The OPC tab mainly includes
the OPC tag browser and "Configure provider OPC tag" area.
2. In OPC tag browser, select the tag for which the values should be transferred. The selected
tag is shown in the "TagID" field. The data type is chosen according to the selection.
3. If the selected tag has Array data type, then the "Array" check box is automatically enabled.
This check box is provided below the "Data type" field.
4. Next, configure the consumer tag in the "Database consumer" section by following these
steps:
– The selected table is shown in the "Table" field. The schema (if selected at provider side)
is displayed in the "Schema" field.
– The column names are displayed within "Columns" area. If the table has columns with
respective data types, the time stamp can also be written to the table. In this case, select
the respective "Active" check box and select the column within "Column for timestamp"
field.
5. Select the Column name that you wish to connect with the OPC tag. The selected column is
displayed in "Column for data value" field of WinCC User Archive consumer.
WinCC/IndustrialDataBridge
128 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
6. Check the name of the connection in the "Connection mapping settings" area to the right.
Enter a unique name for the connection in the "Connection name" field or use the options
within "Default name options". Click "Connect" button to confirm your entries.
7. Repeat steps 1 to 5 for all elements of the "Dynamic database" that you wish to transfer.
Note
Array
If the OPC provider tag has a data type of array data type and if the database consumer column
has data type other than array data type, after clicking on the Connect buton, the "Array" check
box in the "OPC tab" is automatically unchecked.
The WinCC User Archive consumer section provides you with required options to choose
schema, table name and column names to be mapped with the column(s) existing within
Dynamic database provider. A specific connection can be created between the Dynamic
database provider column and the column (belonging to WinCC User Archive consumer)
selected in the Where statement tab. You can create a new connection or else modify an
existing connection to apply Where statement on the selected column.
Where-statement
The Where statement is required to be configured in order to select the column within
the WinCC User Archive Consumer. The "Where-statement" tab mainly includes the "Where
statement" configuration section and exception handling section.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 129
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
4. The behavior is defined in the "Exceptional handling" section if the selection of the consumer
row is not unique:
– Error Message: No consumer rows lines are overwritten and an error message is given as
an output in the trace view of IDB Runtime.
– Change all rows: All selected consumer rows are overwritten.
– Using the "Enable Insert" check box, you define the behavior if a line with the key (primary
key) does not exist. If the option is selected, a new line with the respective key is created.
Note
Simultaneous Utilization as Key and Consumer Column
In order to have more setting ability with the configuration, you can use a column as a key
column and as a target column simultaneously. Take note that this causes the data in the
database to be inconsistent and/or future access to the WinCC User Archive consumer
may result in errors.
5. Check the name of the connection in the "Connection mapping settings" area (right). Enter
a unique name for the connection in the "Connection name" field or use the options within
"Default name options". Click "Connect" button to confirm your entries.
Delete settings
With "WinCC User Archive consumer", you are able to delete data records from the User
Archive. This requires connecting a provider column with a consumer column. If the delete
condition has been met, the data record of the consumer column is deleted from the user
archive. Delete has priority over "Insert" and "Update" actions.
WinCC/IndustrialDataBridge
130 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Connection mapping
1. In Dynamic database provider, the selected archive is shown in the "Table" field. Select the
Schema if applicable by selecting from the drop down list in "Schema" text box.
2. The Column names are displayed within "Columns" area. Select a Column name from the list.
The selected column is displayed in "Column for data value" field. The data type is shown
automatically.
3. The "Filter" field provides you the option to filter the Column names based on single character
or first few characters of column name.
For example, if you wish to view the column names starting with "S", type this character in
"Filter" text box. All column names starting with "S" are displayed.
4. Next, configure the consumer tag in the "WinCC User Archive consumer" section by following
these steps:
– The selected table is shown in the "Table" field. Select the Schema if applicable by
selecting from the drop down list in "Schema" text box.
– The column names are displayed within "Columns" area. If the table has columns with
respective data types, the time stamp can also be written to the table. In this case, select
the respective "Active" check box and select the column within "Column for timestamp"
field.
5. Select the Column name that you wish to connect with "Dynamic database" column.
The selected column is displayed in "Column for data value" field.
6. Check the name of the connection in the "Connection mapping settings" area to the right.
Enter a unique name for the connection in the "Connection name" field or use the options
within "Default name options". Click "Connect" button to confirm your entries.
Note
Data type conversion
If the provider column does not match with consumer column, IDB CS converts the data type
to match with data type of provider. A status window is displayed to indicate this change.
7. Repeat steps 1 to 6 for all elements of the "Dynamic database provider" that you wish to
transfer.
Introduction
This chapter provides you with the complete steps for creating a project and link in IDB
Configuration System application. The objective here is to create a project with corresponding
link having WinCC User Archive as provider and Dynamic Database as consumer.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 131
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Procedure
1. Open IDB Configuration and create a project by following the steps mentioned below:
– In IDB Configuration menu, select "Project" > "Create" to create a new project.
– In the "Create new project" dialog box, specify a project name, click [...] button and select
the folder location wherever the project needs to be saved.
– After entering the required information, select "Create" button. This creates a new project.
2. The project name will be listed within the "Project tree".
WinCC/IndustrialDataBridge
132 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
3. The next step is to create a link. Follow the steps mentioned below to create a link between
provider and consumer:
– Right click on project name node in the tree structure and select "Add new link" option.
After creating a project, by default a new node "Add new link" is displayed in project tree
below project name node.
Alternatively, you can create a new link by double clicking the "Add new link" node in
project tree.
– In the "Add new link" dialog that is displayed, enter a unique link name.
– Select the provider type as WinCC User Archive, consumer type as Dynamic Database and
click OK button.
– The created link will be displayed below the project name in project tree.
4. The corresponding entries - Provider, Consumer, Settings and Connections are created as
nodes that exist below the new link in the tree structure.
Result
You have created a project that consists of a link having WinCC User Archive as provider and
Dynamic Database as consumer.
Introduction
In this chapter, you will configure the respective provider/consumer configuration along with
transfer behavior settings for provider.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 133
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Procedure
1. In project tree, open the Provider configuration window by double clicking the Provider node.
Note
User Archive
Ensure that you enter the complete path of the computer wherever WinCC has been installed.
If the path name is not valid, then the "Database" field will not display any tables. Also, it is
important to verify that the user archive table contains one or more rows of data.
WinCC/IndustrialDataBridge
134 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
– If a user name and password has been set for the database, enter the user name and
password in the "User name" and "Password" fields respectively.
If you wish to set a blank password, enable the check box "Allow saving password".
– Click Test button to test the connection. The application tests the database connection
string and verifies the selected database.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 135
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
2. Within the Transfer options tab, you can configure the transfer behavior settings for provider.
– Select the Table name by selecting from the drop down list.
Note
Schema
• In WinCC User Archive, a default schema is selected automatically in the Transfer
options tab.
3. Click "Event" button to configure the trigger provider settings. The "Trigger provider" dialog
will be opened.
The description of the "Config Trigger dialog" is provided in chapter "Configuring a Trigger
(Page 137)"
4. The transfer behavior settings for provider will be saved automatically.
Note
Saving changes
A save operation is not required every time whenever changes are performed within the editor
window in the work area. The changes made to these settings are automatically saved. However,
once the project is created, at any point of time, you can save the project by selecting the
"Project" > "Save" menu option.
WinCC/IndustrialDataBridge
136 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Result
You have configured the WinCC User Archive interface and Dynamic Database consumer
including the provider transfer options. These elements are displayed in the tree structure of the
IDB configuration interface.
Introduction
The "Trigger Provider" dialog window provides the OPC settings, Trigger configuration options
and required fields that help you to configure the condition that triggers a data transfer. This
dialog window is opened after clicking the "Trigger" button in Transfer options window.
Note
OPC tag browser
The OPC tags within "Trigger configuration" section will only be displayed if you have already
selected the name of the OPC Server.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 137
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
WinCC/IndustrialDataBridge
138 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Procedure
1. In "OPC settings" area, select the OPC server by clicking on the [...] button. The selection of
the server is supported by an OPC tag browser. Next, click the button representing "tick mark"
to accept the changes.
2. If this server is located on another computer, enter the computer name as well. The tree
structure of OPC server is displayed within "Trigger Configuration" area.
Note
Node name
For local OPC Server, the node name will display as "local host". In case of remote OPC Server,
the remote computer name will be displayed after selection of OPC Server on the remote
computer. This "Node name" is required for searching the OPC Server from the remote
computer.
The OPC tag browser does not display any content if node name is invalid.
Note
The "OPC Server" and "Node name" fields are provided as editable fields.
If the information about OPC Server name and node name is known, you can directly enter
the information in the "OPC Server" and "Node name" fields. If the node name / OPC Server
name is invalid, there will be no content displayed within the OPC tag browser.
3. You can define an OPC tag on the trigger source, in which the success-/failure-status of the
data transfer will be stored in the "Tag for transaction security" field. This value should have
1 byte signed char (e.g. VT_I1). -1 indicates the success state and 0 indicates failure.
Select the tag of the OPC server, in which this information is to be saved in the tag browser
and click on the "Apply item" button.
4. In "Trigger Configuration" area, select the desired tags individually and accept them by
clicking on "Add item" each time.
The selected tags are shown in the Tag list below.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 139
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
5. Use the "Remove item" button to remove the marked item. If no item is marked for deletion,
the last item from the list is deleted if you click the "Remove item" button. Details about the
columns in the Tag list are located in section "Tag declaration".
Note
OPC Server
After selection of the tags and adding them to tag list, if you switch to another OPC Server in
OPC Settings area, a dialog window is displayed that prompts the message whether you wish
to discard previous settings.
6. In "Trigger condition" area, you can select the type of syntax with selection button "VB Style"
or JScript Style". If a trigger condition is already created, this setting can no longer be
changed. If the language is to be changed, the text in the "Configure Trigger Condition" field
must be deleted.
Details on the programming languages are located in section "Programming Languages".
7. Create the trigger condition in the selected language. Use the Alias designations in the tag
list for these tags. Within the text box displayed, enter the operator symbols using the
keyboard or select them from the "Logical patterns" list box.
8. Test the created condition by clicking on "Validate". The trigger condition is calculated with
the values that are entered in the "Test value" column. The result "TRUE" or "FALSE" is shown
in a message box.
9. If the trigger condition provides the correct result and after confirming the changes, close the
dialog by clicking on "OK" button.
Additional Information
Tag declaration
The columns for the tag declaration contain the following:
• Data type: Data type of the tag. If the data type defined here does not match that on the
server, an attempt to convert the data type is made.
• TagID: The TagID of the tag on the OPC server
• Alias: The alias is used for creating the trigger condition. This name must be unique and it
must correspond with the naming conventions of the allocated programming languages. For
more detailed information about the naming conventions, see paragraph "Valid alias names".
• Confirmation value: The confirmation value is the value that the variable takes on after
fulfilling the trigger condition and the values have been delivered to the consumer. The
default value is "<Empty>", i.e., no confirmation value is written.
• Test value: This value is only for testing the trigger condition and has no influence on the later
data exchange. The test values are to be selected and changed so that they test whether the
trigger condition delivers the expected result in all operating conditions.
WinCC/IndustrialDataBridge
140 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Note
Confirmation value
The confirmation value does not give any information on whether a transaction has been
completed successfully.
Note
Necessity of Alias names
The OPC ItemID is not used because it may possibly not correspond with the tag validity criteria,
for instance, a "Point" in the tag name is not allowed.
Programming languages
You can use VBScript or JScript for the trigger condition.
The following table shows the operator type and their symbols in both languages:
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 141
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
It is recommended to use these operators only. Other operators can be found in the language
descriptions for the respective language
Note
Loss of Trigger Events
The triggering depends on the update speed of the OPC server. In this case, note that data
changes that occur within an update cycle are not considered by the trigger. That means that a
faster change of a tag from 1 - 0 - 1 is not necessarily indicated to the trigger provider by the OPC
server, since the 1 exists at the end again and no value change exists at the check time. This
means that a potentially true condition is not recognized as being true and therefore will not lead
to a data transfer.
Configurations, with which the confirmation value is to set a "true" trigger condition to "false"
again, are not secure because of the statement above. When data changes occur too quickly, the
"true value" may stay the same or values can be left out.
Introduction
This chapter provides the steps for performing connection mapping between provider and
consumer.
Connecting Tags
In "Settings" window, the "Connection mapping" tab includes the required fields to connect tags
that have been sent from the WinCC User Archives interface with the selected consumer. The
Connection mapping tab divides the window into 3 sections
• WinCC User Archive provider
• Dynamic Database consumer
• Connection mapping settings
WinCC/IndustrialDataBridge
142 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 143
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Where-statement
Note
Select OPC server
In order to configure the settings on the "Where Statement" tab, you must have selected an OPC
server in the dialog "Trigger Provider (Page 137)". This dialog window is accessed by clicking on
the "Event" button in "Transfer options" tab.
Note
Columns
The column names shown in screenshot might vary and is dependent on the table selected.
The SQL String that describes the access location for reading the data is shown on this tab.
The "Where-statement" tab mainly includes the "WHERE" section and text area for displaying
the "Resulting SQL-String".
WinCC/IndustrialDataBridge
144 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
1. Click "Add" button to open the dialog that provides you with options to select the column in
order to compare the content.
2. Select the Fieldname you wish to check for a certain value. The selected field name is
displayed in "Fieldname" field. The data type for this field name is automatically selected in
the "Datatype" field.
3. This "Fieldname" is shown in the "WHERE" text box. Choose the operator symbol from the
drop down list that is used for comparision.
4. In "OPC-variable" section, select the OPC tag, the value of which is compared with the
previously selected column entry. Then, click OK button.
5. The condition is shown in the table within "Where" section and is entered in the "Resulting
SQL String" field.
6. To remove an already existing "Resulting SQL String", click "Remove" button.
7. To define multiple conditions, repeat steps 1 to 5.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 145
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Note
SQL String
• If multiple conditions are configured, they are connected with a logical "AND".
• Only data records (lines) are requested from the IDB and transferred in which all conditions
have been met.
• An optional connection is not possible with a logical "OR".
Advanced:
Using button "Advanced", you can define the sort sequence and the behavior when multiple
data records exist.
WinCC/IndustrialDataBridge
146 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
• Order By
Select the selection field. You can then define the column name and the sort direction.
• Behavior with several results:
Select one of the following option fields and click OK button. Based on selected radio button,
you can decide the action to be performed:
– Error message (no data transferred)
– Submit first line
– Submit last line
– Submit all lines
OPC tab
Note
OPC server
In order to configure the settings on the "OPC" tab, you must have selected an OPC server in
dialog "Trigger Provider". This dialog window is accessed by clicking on the "Event" button in
"Transfer options" tab.
1. In the "WinCC User Archive Provider" area, within the OPC tab, the OPC tag browser is
displayed. In tag browser, select the tag for which the values should be transferred. The
selected tag is shown in the "Tag ID" field. The data type is chosen according to the selection.
2. If the selected tag has Array data type, then the "Array" check box is automatically enabled.
This check box is provided below the "Datatype" field.
3. Next, configure the consumer column in the "Dynamic Database consumer" section by
following these steps:
– The selected table is shown in the "Table" field. Select the Schema if applicable by
selecting from the drop down list in "Schema" text box.
– The column names are displayed within "Columns" area. If the table has columns with
respective data types, the time stamp can also be written to the table. In this case, select
the respective "Active" check box and select the column within "Column for timestamp"
field.
4. Select the Column name that you wish to connect with the OPC tag. The selected column is
displayed in "Column for data value" field.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 147
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
5. Check the name of the connection in the "Connection mapping settings" area to the right.
Enter a unique name for the connection in the "Connection name" field or use the options
within "Default name options". Click "Connect" button to confirm your entries.
6. Repeat steps 1 to 5 for all elements of the "WinCC User Archive Provider" that you wish to
transfer.
Note
Array
If the provider tag has a data type of array data type and if the database consumer column has
data type other than array data type, after clicking on the Connect buton, the "Array" check box
in the "OPC tab" is automatically unchecked.
Note
Selecting Schema
• If you are using a database other than Microsoft Access, selection of Schema is mandatory
before choosing the Table name.
• While using Microsoft Access as database, the "Schema" field is displayed in disable state and
does not allow any selection of Schema.
Where-statement
The Where statement is required to be configured in order to select the consumer column
within the "Dynamic database consumer" area. The "Where-statement" tab mainly includes
the "Where statement" configuration section and exception handling section.
WinCC/IndustrialDataBridge
148 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Note
Simultaneous Utilization as Key and Consumer Column
In order to have more setting ability with the configuration, a column can be used as a key
column and as a consumer column simultaneously. Take note that this causes the data in the
database to be inconsistent and/or future access to the dynamic database consumer may
result in errors.
5. Check the name of the connection in the "Connection mapping settings" area (right). Enter
a unique name for the connection in the "Connection name" field or use the options within
"Default name options". Click "Connect" button to confirm your entries.
Connection mapping
1. In "WinCC User Archive provider", the selected archive is shown in the "Table" field. Select the
Schema for database if applicable by selecting from the drop down list in "Schema" field.
2. The Column names are displayed within "Columns" area. Select a Column name from the list.
The selected column is displayed in "Column for data value" field. The data type is shown
automatically.
3. The "Filter" field provides you the option to filter the Column names based on single character
or first few characters of column name.
For example, if you wish to view the column names starting with "S", type this character in
"Filter" text box. All column names starting with "S" are displayed.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 149
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
4. Next, configure the consumer column in the "Dynamic database consumer" section by
following these steps:
– The selected table is shown in the "Table" field. Select the Schema for database if
applicable by selecting from the drop down list in "Schema" field.
– The column names are displayed within "Columns" area. If the table has columns with
respective data types, the time stamp can also be written to the table. In this case, select
the respective "Active" check box and select the column within "Column for timestamp"
field.
5. Select the Column name in "Database consumer" that you wish to connect with "WinCC User
Archive Provider" column name. The data type of selected column will be automatically
displayed in the "Datatype" field.
The selected column is displayed in "Column for data value" field.
6. Check the name of the connection in the "Connection mapping settings" area to the right.
Enter a unique name for the connection in the "Connection name" field or use the options
within "Default name options". Click "Connect" button to confirm your entries.
Note
Data type conversion
If the provider column does not match with consumer column, IDB CS converts the data type
to match with data type of provider. A status window is displayed to indicate this change.
7. Repeat steps 1 to 5 for all elements of the "WinCC User Archive Provider" that you wish to
transfer.
Result
The connections that you have created are shown in the "Connections" tab of IDB CS "Settings"
window as well as within the project tree node.
Overview
This chapter provides information about the steps to be followed in order to view Getting Started
Example 2 in WinCC Runtime environment. The Getting Started project provided along with the
installation includes all the required resources for running the example project.
Prerequisites
• WinCC is installed
• IDB Getting Started project "idb_getting_started.MCP" is loaded in WinCC and project is
activated
• IDB CS application is open
• Getting Started project "IDBProject" is loaded in IDB CS application
WinCC/IndustrialDataBridge
150 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Note
Opening IDB configuration
The IDB configuration required for Getting Started project can also be opened in IDB CS using
"IDBProject.ip80" file. In IDB CS, click Project > Open project and click on Browse button to browse
the folder structure. Select the ".ip80" file existing within "IDBProject" folder by browsing the
folder contents.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 151
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
Follow the steps given below to connect the configuration and start data transfer:
1. In IDB Runtime control, select "Options" button to open the "Runtime configuration" window.
2. In "NT Service" tab, click "Start service" button to start IDB service and click OK.
3. Next, load the configuration file by clicking on the Open button. In the "Open" dialog window,
browse the folder contents, select the configuration file "idb_getting_started_configfile.xml"
and click "Open" button.
Note
Connections displayed in IDB Runtime
The IDB Runtime window displays the connections (links) that belongs to both Example 1 and
Example 2. While working with each example, it is suggested to select the connections (links)
that are used within the specific example.
WinCC/IndustrialDataBridge
152 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
4. The list of connections will be displayed along with provider and consumer status. The status
is shown next to each provider/consumer as a small circle.
5. Click "Connect" button to connect the provider and consumer types.The status of provider
and consumer will now be changed to green colour.
6. Next, click "Start" button to start the data transfer.
Download recipe data
7. Within "Download recipe data" section displayed on left hand portion of example screen, click
"Fetch data from database" button. The data retrieved from database is displayed in the
WinCC User Archive control. A tick mark icon is shown in the example screen to indicate
successful data transfer.
8. The last updated record existing within the table is shown in "Set point" and "Color" fields.
These fields serve as an input for the production process in the plant.
Upload production results
9. In "Upload production results" section, enter the data in "Used material" and "Operator name"
fields and click "Add row" button. Press the "Enter" key each time when you enter any data in
these fields.
You can observe that the data that is entered is displayed in the WinCC User Archive control.
10.Click "Send user archive data" button to send these production results to the database. A tick
mark icon is shown in the example screen to indicate successful data transfer.
Note
Switching between Example 1 and Example 2
To switch from one example to other, click the button provided at bottom right hand portion of
the example screen.
It is important to note that after switching to another example, before proceeding further, you
need to stop the data transfer, disconnect the connection(s). Once you are ready, then you can
start connecting the provider/consumer types and start the data transfer.
Result
You have performed the data transfer successfully and have understood the steps for connecting
the configuration links and starting data transfer using IDB with the help of this example.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 153
WinCC/IndustrialDataBridge Getting Started
3.5 Getting Started and Examples
WinCC/IndustrialDataBridge
154 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation 4
4.1 Introduction
• IndustrialDataBridge Overview:
This chapter provides an overview of IndustrialDataBridge and its usage. The different
provider or consumer modules supported including the priniciple of operation of
IndustrialDataBridge Configuration System and IndustrialDataBridge Runtime System is
explained here.
• IndustrialDataBridge Configuration
This chapter deals with the information regarding the steps for starting and exiting IDB CS.
• Software User Interface
This chapter includes information specific to the details of the software user interface, its
usage within IDB CS and a detailed explanation of each of the software user controls provided
within the appication.
• User Interface Layout
This chapter includes information about the user interface layout and ways of managing and
storing the window layout.
• Project Basics
The basic concept of project, links and connections is explained here. The related steps for
creating project, saving project and managing project(s) within project tree are provided in
this chapter. This chapter also includes information about links, their usage within project
tree and ways through which links can be managed.
• Import / Generate Runtime Configuration
This chapter includes information about the steps for importing or generating runtime
configuration.
• Modules
This chapter includes the list of supported provider and consumer types. Each of these
module(s) are covered in detail within the individual chapter names. Each module includes
information about creating project, link, configuring provider/consumer configuration,
configuring transfer settings for provider and performing connection mapping between
provider and consumer types.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 155
WinCC/IndustrialDataBridge Documentation
4.1 Introduction
• Runtime
The Runtime chapter deals with working of IndustrialDataBridge Runtime application and
provides information about the various options available within Runtime appliation. This
chapter also includes information for activating connection and enabling or starting data
tranfer.
• Advanced Features
A list of advanced features supported in IDB are provided here. This chapter includes
information about Asian language support, Drag and Drop feature, using IDB Runtime using
WinCC controls and information about Web Navigator support in IDB Runtime.
Introduction
The WinCC/IndustrialDataBridge is a WinCC option. It enables the data exchange between
various systems by using variety of standard interfaces with simple configuration. These are
organized into modules within IndustrialDataBridge that includes various systems or data
interfaces. You can expand the data exchange to other data interfaces at any time with this
modular construction. The software design also allows the simple integration of new interfaces
into the application. The IndustrialDataBridge is used for exchanging data between automation
systems from different vendors (via OPC XML or Send/Receive for example) or with other
applications storing process data in Office formats such as Excel or Access. For archiving larger
data volumes, you can also integrate databases (SQL Server, Oracle).
The IndustrialDataBridge holds the Configuration system "IndustrialDataBridge CS" and the
Runtime system "IndustrialDataBridge RT".
Configuration files are created in XML format using the IndustrialDataBridge CS application.
The IDB CS includes a well equipped user interface that provides options for configuring IDB
links. There are options for commissioning, status monitoring and troubleshooting available
in the runtime environment. The IndustrialDataBridge RT allows access to the process data
and links the data as defined in the loaded configuration file.
Note
Please note that throughout this manual in some of the chapters you may find that,
"IndustrialDataBridge CS" is referred to as "IDB CS" and "IndustrialDataBridge RT" as "IDB RT".
Note
Protecting XML files
To avoid malicious content usage and to prevent unauthorized access, it is suggested to protect
the XML files by ensuring appropriate usage of file and only to authorized personnel within the
plant.
WinCC/IndustrialDataBridge
156 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.1 Introduction
Usage
The IndustrialDataBridge application can be used along with WinCC and can also run as an
independent software. The following 3 scenarios shown below helps to make you understand
the usage of IDB application.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 157
WinCC/IndustrialDataBridge Documentation
4.1 Introduction
Overview
An exchange between different automation systems and IT systems is made possible with the
IndustrialDataBridge. The following image shows an overview of the various applications and
formats that are supported by the IDB Configuration application.
3URYLGHU &RQVXPHU
23& 23&
'DWD$FFHVV 'DWD$FFHVV
23&;0/ 23&;0/
6HQG 6HQG
5HFHLYH 5HFHLYH
'DWDEDVH 'DWDEDVH
64/6HUYHU$FFHVV 64/6HUYHU$FFHVV
'DWDEDVH 'DWDEDVH
2UDFOH0\64/ 2UDFOH0\64/
,QGXVWULDO
'DWD ([FHO
%ULGJH
,'%23&6HUYHU
'\QDPLF'DWDEDVH '\QDPLF'DWDEDVH
:LQ&&
2/('% &697;7
:LQ&&8VHU :LQ&&8VHU
$UFKLYH $UFKLYH
23&8QLILHG
$UFKLWHFWXUH )UHH7H[W(GLWRU
23&8QLILHG
$UFKLWHFWXUH
The various data interfaces are linked via software modules. These modules are divided into
"Provider" and "Consumer".
• Provider
• Consumer
The provider establishes the connection to data provider, from which the data is delivered.
The consumer connects with the data consumer, into which the data is written.
You can connect different providers and consumers with one-another. Note that not all
providers exist as consumers and vice versa. One provider must always be connected with
one consumer.
WinCC/IndustrialDataBridge
158 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.1 Introduction
To get started with the application with the help of easy example projects, you can access
IDB Getting Started application. For more information, please refer IndustrialDataBridge
"Getting Started" manual.
The IndustrialDataBridge Demo Project takes you through an application demo that depicts
the data transfer process between different provider and consumer types.
If you have selected Getting Started project and Demo project as part of IDB installation, this
will be installed in the following location:
For Windows 10 / Windows 11 / Windows Server 2019 / Windows Server 2022 operating
system:
'C:\Users\Public\Public Documents\Siemens\IndustrialDataBridge\'
Principle of Operation
The IndustrialDataBridge is divided into two parts:
• Configuration system
• Runtime system
,QGXVWULDO'DWD%ULGJH
&RQILJXUDWLRQ
,QWHUIDFH 5XQWLPH,QWHUIDFH
6WDWXVPHVVDJHV
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 159
WinCC/IndustrialDataBridge Documentation
4.1 Introduction
You create and manage provider/consumer configuration, settings and connection(s) in the
configuration system. You only require four steps to completely configure a connection:
1. Create project and create the required link(s). Next, select the desired provider and consumer
types.
2. Define provider and consumer configuration properties.
3. Perform link settings - configure the Transfer options for provider.
4. Create connection by performing mapping between provider to consumer tags.
5. Generate Runtime Configuration by exporting the XML file.
Supported Languages
The following interface languages are available in the IndustrialDataBridge application:
• German
• English
• French
• Italian
WinCC/IndustrialDataBridge
160 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
• Spanish
• Simplified Chinese
• Japanese
4.2 Configuration
Introduction
IndustrialDataBridge (IDB) configuration application is used for configuring and managing
connections between provider and consumer. Connection can be established between various
provider and consumer types.
This chapter provides information about starting and exiting IDB application. It also includes
information pertaining to the basic structure of an IDB configuration.
Note
Windows 10 / Windows 11 / Windows Server 2019 / Windows Server 2022 Operating System
In Windows 10 / Windows 11 / Windows Server 2019 / Windows Server 2022 operating system,
to open IDB application using WinCC, select Start > Apps. Click Ctrl+tab key to select the
application.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 161
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
The IDB configuration window includes options for creating a project. Once a project has
been created, it provides option to create links between various provider(s), consumer(s) and
help to manage their connections. Options are also provided to save the new configuration,
export as an XML file or import an existing configuration.
Structure
The basic structure within the IDB Configuration system (CS) is built with the concept of a
Project. A project refers to a single IDB configuration that can be loaded at any point of time. The
project is an entry point for performing a configuration wherein each project consists of link(s)
and connection(s).
• Project: A project helps to create and manage provider/consumer configuration properties,
settings and includes options to perform connection mapping.
• Link: A link is part of a project and allows to configure the provider, consumer and transfer
behavior settings for provider.
• Connection: A connection represents a mapping between provider and consumer types.
Note
No special firewall or network setting are required for data transfer using IDB. Nevertheless,
source and destination machine should be accessible and within intranet.
See also
Software User Interface (Page 163)
WinCC/IndustrialDataBridge
162 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
Introduction
This chapter provides a complete overview of IDB CS Software user interface elements and
explains each of these controls in detail.
User Interface
The structure of IndustrialDataBridge Configuration application includes an easy to use user
interface that provides options for creating & modifying projects/links/nodes, performing
provider/consumer configuration and saving the configuration files. The information about
these user controls have been grouped into the related areas within the user interface.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 163
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
1. Title bar
2. Menu bar
3. Toolbar
4. Project tree
5. Work area
6. Details view
7. Inspector window
8. Editor bar
9. Status bar
Title bar
The Title bar exists at the top position of IDB Configuration application. It displays the project
name once the project has been opened. If no projects are open, then the title bar will not
display the project name in the title bar. The title bar provides 3 window controls that is used
to minimize, maximize or close the IDB CS application window. These controls exist towards
the right hand position of the title bar.
a. Minimize: Minimizes the IDB Configuration application to the windows task bar.
b. Maximize: Maximizes the IDB Configuration application and displays the complete
application view.
c. Close: Closes the IDB Configuration application.
Note
Selecting the "Close" icon exits the IDB Configuration application without saving changes to the
currently opened project. However, a dialog window is displayed that prompts whether you wish
to save the changes to the current project. Select "Yes" to save the changes to the project.
Menu bar
The Menu bar includes all related menu items that are required for working with the
IndustrialDataBridge application. The list of menu items and their description is provided
below:
Item Description
New project Creates a new project
Open project Opens a new project
Close project Closes an opened project without saving
Save Saves the project along with the configuration
Save as Saves the project with a new name
Delete project Provides option to select the project that needs to
be deleted and to perform Delete operation
Import Runtime Configuration Imports the XML file into IDB CS and opens as a new
project
WinCC/IndustrialDataBridge
164 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
Item Description
Generate Runtime Configuration Exports the XML file to desired folder location
Start IndustrialDataBridge Runtime Starts IDB Runtime directly from CS
Stop IndustrialDataBridge Runtime Stops IDB Runtime directly from CS
Download Remote Configuration Download the current configuration into the target
machine
Exit Exits the IDB CS application
Item Description
Add new link 1
Allows for adding a new link
Add link(s) graphically 2 Allows to add link(s) using "Link configuration" win‐
dow
Delete all links 3 Deletes all links created within the project
Connect 4 Connects the provider tag with selected consumer
tag
Delete connection 5 Deletes the selected connection after user confir‐
mation
Note
• 1 2 The menu options "Add new link" and "Add link(s) graphically" are displayed in the
"Configuration" menu only if a project is open. These options are shown even if the project
does not contain any link(s).
• 3 The menu option "Delete all links" is in enable state in the "Configuration" menu only when
a project is open that contains atleast one link.
• 4 5 The menu options "Connect" & "Delete connection" are in enable state in the
"Configuration" menu only while navigating within the connection mapping tab and when
the basic conditions for connection establishment are satisfied.
Item Description
Settings Includes IDB CS General settings and keyboard
shortcuts information
Item Description
Runtime configuration Opens Runtime Configuration
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 165
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
Item Description
Close all editors Closes all open editors including the editor window
in the editor bar
Minimize all editors Minimizes all open editors and displays this win‐
dow in the editor bar
Next editor Navigates to next available editor window
Previous editor Navigates to the previous editor window
Split editors vertically Splits editors vertically within the work area
Split editors horizontally Splits editors horizontally within the work area
Unsplit Reverts back the split windows to normal state
Store current layout Saves the current screen layout
Manage layouts Pops up a window that helps to manage different
window layouts
Restore active layout Restores the active layout
Default window layout Provides a radio button option that helps to toggle
between modes
More layout Provides layout in expanded view
Item Description
Show Help Displays the Online Help window
Installed Software Provides information about the installed software
About Displays product and version information
Toolbar
The Toolbar buttons are provided below the menu bar within the IDB Configuration
application. Some of the options available with menu items in the menu bar are also
provided as toolbar buttons. The toolbar buttons along with their description is provided
below:
Button Description
New Project
Open Project
Save
Generate Runtime Configuration
WinCC/IndustrialDataBridge
166 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
Button Description
Starts IndustrialDataBridge Runtime
Stop IndustrialDataBridge Runtime
Download Remote Configuration
Add New Link
Add link(s) graphically
Runtime Configuration
Show Help
Note
Start/Stop IDB runtime
To start IDB Runtime from CS,
Note
Create Links
WinCC IDB provides two options to create new links.
1. Add new link
2. Add link(s) graphically
The "Add new link" and "Add link(s) graphically" buttons exist within the toolbar that allows you
to create links. In project tree, the same buttons are provided as "Add new link" and "Add link(s)
graphically" nodes below the project node. These nodes are automatically listed once a new
project is created. At any point of time, you can add a new link by double clicking the "Add new
link" or "Add link(s) graphically" nodes. These nodes permanently exist below the project node
in project tree even after a new link is created.
The "Add link(s) graphically" option allows to perform multiple link operations that include
creating links, renaming links, and opening provider and consumer configuration. For more
information, please refer "Graphical Configuration of Links" section in Project Basics (Page 182)
chapter.
Project tree
The project tree provides access to project specific data that includes links, connections and
their settings. The tree structure provides better management for creating and managing
links and their connections.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 167
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
Certain menu options are enabled across specific nodes within the project tree structure. The
options displayed within the menu depends on the selection of particular node within the
project tree. The following tasks can be performed within the project tree:
• Adding New Links
• Deleting Link
• Deleting all Links
• Renaming links
• Add link(s) graphically
• Generate links from XML
• Add links from XML
• Delete Connection
• Delete all Connections
Note
Drag and Drop
In Project tree, the drag and drop feature allows you to drag the existing provider or consumer
node and drop it to a new provider or consumer node within project tree. The configuration
settings will thus be made available for the newly created links. Hence, this is helpful whenever
multiple links need to be configured along with their provider and consumer configuration
settings. For more information about this feature, please refer Chapter 5.5 "Drag and Drop"
(Page 526).
The figure given below shows the different sections of project tree:
WinCC/IndustrialDataBridge
168 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
1. Side stripe
2. Title bar
3. Collapse automatically
4. Collapse
5. Project
6. 'Add new link' node
7. 'Add link(s) graphically' node
8. Link
Side stripe
The Side stripe bar is used to collapse/expand the project tree.
Title bar
The name of the project is displayed in the project tree title bar.
Collapse automatically
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 169
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
You can use the "Collapse automatically" button to auto-hide or collapse the project tree
automatically when you do not need it. This button changes to "Expand permanently". Click
this button if you wish to view the project tree.
Collapse
Once project tree is collapsed manually using the "Collapse" button, the project tree is hidden
to the left-hand margin. The "Collapse" button changes from an arrow pointing left to one
that is pointing right, and can now be used to reopen the project tree using "Expand" button.
Project
A project is used to organize, manage and control IDB configuration and its settings. The
project node displays a downward pointing arrow that is used to view the link(s) nodes
existing within the project.
'Add new link' node
This node is used to add or create a new link. The 'Add new link' node is displayed below the
project node and exists even after the link has been created.
'Add link(s) graphically' node
This node is used to add or create a new link, rename link, and open provider and consumer
configuration window. The 'Add link(s) graphically' node is displayed below the 'Add new link'
node and exists even after the link has been created.
Link
A link is an entity that includes the Provider, Consumer, Settings and Connections nodes.
The link node displays a downward pointing arrow that is used to view these nodes existing
within the link.
Work Area
The work area displays the window objects that you can open for editing purposes. These
objects include editors, views, tables, etc. To open a window, double click the project tree
node, the corresponding window is displayed within the work area.
WinCC/IndustrialDataBridge
170 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
The window includes 4 controls that is used for managing the window view. These controls
help towards the way how you would wish to view the window. It includes the following
controls:
1. Minimize: Minimizes the window to editor bar in IDB CS application.
2. Float: Makes window to be available as a floating window ie., as an individual window
separated from the work area. Upon clicking on "Float", the control changes to "Embed" icon.
Click the "Embed" window control to place the window or embed the window in work area.
3. Maximize: Maximizes the window to the maximum display view.
4. Close: Closes or exits the window. Changes performed within the window interface will be
saved automatically.
You can open several windows within the work area. However, it is possible to see one of
these at a time. To view other windows, minimize the opened window. Once minimized,
the window will be displayed in the editor bar displayed at bottom portion of the IDB
Configuration application window. In the work area, you can view two objects at the same
time in seperate windows. To perform this action, select "Window" > "Split Editors Verfically"
to split editors vertically. If you wish to split editors horizontally, select Window > "Split
Editors Horizontally". The work area will be shown as empty in the work area in case if
no windows are open. To unsplit or to switch back to its normal view, select "Window" >
"Unsplit" or select "Window" > "Restore active layout" to restore the previously available layout.
The figure shown below depicts an example of a vertically split work area.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 171
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
Details View
The "Details view" window is displayed just below the "Project tree" window on left hand side
of IDB CS application area. This view displays certain nodes based on the selection within the
project tree. The nodes displayed in "Details view" window are based on selection within the
project tree at project level, link level, connections level, and individual node level.
At Project level:
• Displays the 'Add new link' node and 'Add link(s) graphically' node (however, no actions can
be performed here).
• It will display all links (if the links have been created in the project tree).
At Link level:
• Displays the nodes Provider, Consumer, Settings and Connections.
At Connections level:
• Displays a list of connections, if the connections are already created, else the "Details view"
window will be shown empty.
The figure given below shows the Details view window.
WinCC/IndustrialDataBridge
172 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
1. Collapse / Expand
2. Title bar
3. 'Add new link' node
4. 'Add link(s) graphically' node
5. Links
Note
Details view
The "Details view" window displays the nodes that are available within the project tree. However,
no actions can be performed from these nodes displayed in "Details view" window except the
listed connections.
Double clicking the connection displayed within the "Details view" window will open the
connection mapping window pertaining to this specific connection.
The "Collapse" option is shown as a downward arrow for minimizing the "Details view"
window. This option is located in the title bar of "Details view" window. After clicking on
this arrow, the details view will be hidden to bottom portion of the application window.
Once it has been minimized, click on the arrow again to re-open or restore the "Details view"
window.
Alternatively, to collapse the "Details view" window, right click on downward arrow and
choose "Collapse" option to minimize the "Details view" window. In minimized state, right
click on the arrow and choose "Expand" option to restore the "Details view" window.
Inspector window
The inspector window displays additional information with respect to the actions performed
in IDB CS application. This includes actions such as creating or deleting project, saving
project, cancelling save operation, closing or opening projects.
The inspector window provides 3 tabs - Properties, Info and Diagnostics along with a window
area for displaying more information specific to each of these tabs.
• Properties tab This tab displays the properties of the object selected.
• Info tab: This tab displays additional information on the object selected.
• Diagnostics tab: This tab provides information on events and connection diagnostics, if any.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 173
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
Note
Inspector Window usage
In IDB Configuration application, inspector window can be used mainly to view the status of
actions performed in the application that are displayed as messages. These messages are
displayed within the "General" tab. The "General" tab exists within the 'Info' tab of Inspector
window.
The inspector window can be hidden within the IDB Configuration application screen
whenever it is not required. This window provides the following 3 controls displayed at right
hand portion on the title bar of this window.
1. Float: The "Float" option makes window to be available as a floating window ie., as an
individual window separated from the work area.
Upon clicking on "Float", the control changes to "Embed" icon. Click on the "Embed"
window control to place the window or embed the window in work area.
2. Collapse: Once the inspector window is collapsed manually using the "Collapse" control,
the project tree is hidden to the bottom margin. The "Collapse" button changes from an
arrow pointing left to one that is pointing right, and can now be used to reopen the inspector
window using "Expand" button.
3. Minimize: Minimizes the inspector window to bottom portion of the work area.
Editor bar
In IDB CS application, the configuration window or settings window or any of the editor
windows when minimized will appear in the editor bar. If you have opened mulitple
windows, these windows are shown as grouped together one after the other. To switch
quickly between different editor windows, you can use the editor bar. This editor bar is placed
at the bottom portion of IDB CS application window screen.
WinCC/IndustrialDataBridge
174 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
Usually, It will be difficult and tedious to switch between editors in the work area by
minimizing or maximizing editor windows. Editor bar will be useful in such instances as
it allows easier switching between different windows.
Note
Editors / Windows
In IDB Configuration application, windows that provide configuration or settings information are
also known as 'editors' or 'editor' windows. The name "editor" is used as it allows to edit text
within the text box or user controls in these windows.
Status bar
The status bar is placed adjacent to the editor bar within the IDB Configuration application.
The status bar displays the status information based on the actions performed at project
level. Some examples include opening project, closing the project, saving the project.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 175
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
WinCC/IndustrialDataBridge
176 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
General Settings
The General Settings section includes the following list of fields that provides the basic user
information as well as includes general options required to work in IDB CS application.
• User name: Lists the user name based on the information provided in Windows login
credentials.
• User interface language: Provides a list box that allows you to select or change the user
interface language required to work with IDB CS appication.
• Mnemonic: Provides the mnemonic information as a list box. 2 options are listed here -
International, German. By default, the option "International" is selected.
• Show list of recently used projects: Displays a control that lists the number of projects that is
allowed to be shown in "Browse" window while opening IDB project.
It accepts a value in the range 1 - 12. By default, a value of 8 is selected.
• Load most recent project during startup: Loads the recently opened project while starting IDB
CS the next time.
• Tooltips: The tooltip setting displays 3 options available as check boxes.
– Show truncated texts completely: Displays truncated text in all tooltips displayed in the
application.
– Show tooltips (context-sensitive help is available): Displays tooltips that have context-
sensitive help defined.
– Open cascade automatically in tooltips: Displays cascaded tooltips.
Reset to default
This section lists the window types that can have all their properties reset to default.
• All application settings: The "Reset to deafult" button is provided that allows to reset the
settings to default options.
• Editor layouts: The "Reset to deafult" button allows to reset all the editor layouts.
• Show all message windows: The "Reset to deafult" button resets this property to default.
Storage settings
This section displays the settings related to storage location for projects.
• Recently used storage location: This button can be selected if you wish to use recently used
storage location to be displayed while browsing projects.
• Specify default setting for storage location: Upon selection of this radio button, the
application allows to select a default storage location to be used while browsing projects.
The following options are enabled upon selection of the option "Specify default setting for
storage location":
• Storage location for projects: A browse button is provided to help you in browsing the default
folder location to be used for storing the projects.
• Storage location for libraries: A browse button is provided to help you in browsing the default
folder location to be used for storing the libraries.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 177
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
Keyboard shortcuts
A list of available shortcut keys in IDB CS are provided in the following table:
Note
Split / Unsplit editors
To unsplit or to switch back to its normal view, select "Window" > "Unsplit" or select "Window" >
"Restore active layout" to restore the previously available layout.
WinCC/IndustrialDataBridge
178 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
Introduction
IDB Configuration provides support for saving the user interface layout. Any changes to the user
interface layout within the application can be saved. When you make any changes to the user
interface layout, these changes are retained even after restarting the IDB application.
Apart from saving the user interface layout, the application provides support for saving
certain window layout and also the layout within Editors.
Window layout
IDB Configuration allows working with multiple windows and editors. A change to the window
layout includes resizing a window or closing and opening an editor window. Each window layout
can be manually saved and can be restored whenever required.
Select "Window" > "Store current layout" to save the current window layout. By default a
window layout is saved and is displayed within the list of 'Existing window layouts' in this
dialog window.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 179
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
If a window layout has been saved by following the steps given above, you can load the
window layout anytime depending on your requirement. The first five window layouts that
are saved can be loaded by selecting the layout name from "Window" menu in the menu
bar. Additionally, the "Manage layouts" option in "Window" menu helps you to load additional
window layouts that are not among the five window layouts.
If you have loaded a window layout and made necessary changes to the layout, you can
restore the originally saved window layout by selecting the "Restore active layout" option
from "Window" menu. At any point of time, if you want to close all editors or minimize all
editors, select the "Close all editors" or "Minimize all editors" options from "Window" menu.
To manage the editor windows effectively, IDB CS also provides support for splitting the
editors. The editors within the work area can be split either horizontally or vertically using
the "Split Editors Vertically" or "Split Editors Horizontally" options from Window menu. If you
have multiple editors and if you want to switch between the editors, the Window menu
includes the options "Next Editor" and "Previous Editor" that allows to switch back and forth
between the open editors. The "Unsplit" option allows to unsplit an already split work area.
WinCC/IndustrialDataBridge
180 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 181
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
Follow the steps given below to reset the user interface settings to the factory settings:
1. In IDB CS menu bar, select "Options" > "Settings".
The "Settings" window is displayed in the work area.
2. Select the "General" label in area navigation.
3. Click the "Reset to default" button across the applicable field.
The default settings for the user interface are restored.
Introduction
IndustrialDataBridge Configuration System (CS) is an application that enables the data transfer
between a provider and consumer. A provider can also be configured as data provider and
consumer as data consumer. The communication happens between the provider and consumer
wherein the parameter definitions for provider and consumer are completely different. Due to
these differences, this chapter provides a general description that includes project basics and
steps for creating / managing projects, links.
The first and foremost task while starting to work with the IDB Configuration application is to
create a new project. The project acts as a container for other node elements that is required
for creating a single IDB configuration. Within the project, these node elements are arranged
as a tree structure in the project tree. A project is used to organize data pertaining to the
provider, consumer, link settings and the corresponding connections. The node elements
that make up a project include the following:
• Link properties
• Provider/Consumer data and configuration information
• Connection Transfer options
• Connection mapping settings
• Connections
Tasks
The IDB CS application provides support for creating configuration that consist of connection
between the provider(s) and consumer(s). The most important tasks that can be performed are
provided below:
• Creating a project
• Creating / Managing links & Connections
• Creating / Managing links graphically
• Configuring Provider / Consumer types
• Configuring Settings & perform connection mapping
WinCC/IndustrialDataBridge
182 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
Note
Information about IDB Configuration application user interface and its components are provided
in "Software User Interface (Page 163)" chapter.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 183
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
Note
Create Links
• After creating a project, you will be able to observe that by default two new nodes "Add new
link" and "Add link(s) graphically" are displayed. These nodes allow you to add a new link to
the existing project. Double click the "Add new link" and "Add link(s) graphically" nodes to
create a new link.
• The "Add new link" and "Add link(s) graphically" nodes will be listed once a project is created
and will be listed even after the creation of a new link.
Note
Project name
Using "\" is not allowed within project name. It is suggested to ensure not to use "\" (backslash)
character in project names.
• Project: A project is used to plan, organize, manage and control IDB CS configuration and
other settings. A single project can include any number of links within a specific project. All
tasks performed within IDB CS are managed within these projects. A project forms a basic
structure for creating and managing configuration. Once a project has been configured and
the connection(s) are created, IDB Configuration application includes options to generate the
Runtime Configuration (XML) as an XML file.
• Link: In IDB CS, a link represents an entity that can contain several connections. A Link is
always a part of the project and is displayed in project tree after creating the link. By default,
the "Add new link" node is listed within the project tree (below project node) once a project
is created. This node permanently exists within the project node, thus allowing you to add or
create new links at any point of time. The created links are always shown below the project
name in the tree structure along with the "Add new link" node. Once a link is created, the
following sub-nodes are created automatically in tree structure below the link name -
Provider, Consumer, Settings & Connections.
• Connection: A connection represents a unique mapping between the provider and consumer
types. The connection node is displayed within the link node. It exists exactly below the
"Settings" node in project tree. The connections created are displayed within the
"Connections" node.
Note
Viewing project properties
To view project properties, right click on the project name in project tree and select "Properties"
option. Alternatively, you can select the project icon in project tree and press the key
combination "Alt+Enter" to open the project properties window.
WinCC/IndustrialDataBridge
184 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
Managing Projects
Once a project has been created, the project will be listed in the Project tree. At any point of time,
you can open an already saved project, close project, save changes to the project or delete an
existing project. The links and connections that are created will be displayed within the project
node. The project tree allows for easier and effective management of links, their properties,
connection mapping settings and connections.
1. Slider control
2. Title bar
3. Collapse automatically
4. Collapse
5. Project
6. 'Add new link' node
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 185
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
The Project tree includes icons or controls that help to manage viewing the project tree
nodes and controlling navigation. The nodes listed below the project name includes several
sub-nodes. Perform a single click on the pointing arrow across project or link node to expand
or view the contents of the specific node in project tree. Double click the sub-node(s) within
the link node to open the respective editor window in work area.
Opening a Project
Follow these steps to open an existing project:
1. In Project menu, select "Project" > "Open project" to open an existing project.
The "Open project" dialog opens that includes the most recently used projects.
2. Select a project from the list and click "Open" button.
3. The project will now be listed in the project tree.
Select the "Browse" button to open a specific project that is not listed in the "Recently used"
list within the Open project window. You can further select the project by browsing the
respective folders.
WinCC/IndustrialDataBridge
186 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
Note
Browse Projects
If you are unable to locate the project from the list, then browse to the respective folder by
clicking the "Browse" button. The default storage location for IDB CS projects is: "\My
Documents\Automation". Navigate to the folder that contains the project and open the project
file. Projects of IDB Configuration application have an extension ".ip80".
Note
Opening projects
If you try to create a new project or open a project while another project is open, IDB CS
application prompts a dialog window if you wish to save the changes to the already opened
project and then creates a new project or opens the project.
Note
Opening configuration file from a previous IDB version
To open an IDB configuration that was created using older versions (IDB V7.0.3 and so on), you
need to import the old configuration file into IDB CS by using the "Import Runtime
Configuration" icon provided in IDB CS toolbar. This configuration file will be converted
automatically to the current file format and saved as a new project with the project file extension
".ip80".
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 187
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
Note
Saving XML file
Saving a project will save the changes made to the current project. However, this will not save
the XML file created within the project. The IndustrialDataBridge Runtime application enables
loading the XML configuration file and allows to perform the data transfer. In order to save the
XML file, you need to generate the file. Select "Generate Runtime Configuration" icon provided
in the IDB toolbar to save the XML file to desired folder location.
Note
Saving Changes to editor window
A save operation is not required every time whenever changes are performed within the editor
window in the work area. The changes made to these settings are automatically saved.
All open projects that are opened in the IDB application can be closed with the help of the
menu option. Follow the steps mentioned below to close a project:
1. To close a project that is opened, select "Project" > "Close" option.
2. A message is displayed if you have made any changes to the project since the last time you
saved it.
3. Confirm by clicking the "Yes" or "No" button whether or not you wish to save the changes.
Deleting projects
WinCC/IndustrialDataBridge
188 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
Note
Open project
In IDB Configuration interface, it is not possible to delete any project that is in open state.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 189
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
The creation of link involves selection of provider and consumer types along with defining
their respective connection properties required for establishing the link. A link is defined
within a project and is part of each project. There can be any number of links created for a
project.
Prerequisites:
• The IDB Configuration application is opened
• A new project is created and is listed within the project tree
Note
New Link
The corresponding node entries - "Provider", "Consumer", "Settings" and "Connections" are
created below the new link in Project tree. The Provider type and Consumer type that you had
selected while creating the link will be shown next to the Provider and Consumer node (within
brackets) in the Project tree.
WinCC/IndustrialDataBridge
190 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
Note
After you have created the link, the "Connections" node will not contain any connections, hence
the "Connections" node will be empty. The list of connections will be displayed in the
"Connections" node only if the respective connections have been created from the Settings
window.
• Provider: The provider node is listed below the link node in project tree. To open the provider
node properties window, double click the provider node in project tree. The provider
properties window will be always displayed in the work area. At any point of time, you can
modify the settings within the provider node properties window.
• Consumer: The consumer node is listed below the provider ncode in project tree. Double click
the consumer node in project tree to open the consumer properties window. The consumer
properties window will be always displayed in the work area.
• Settings: The settings window is used to configure the link settings. This window includes 3
tabs:
– Transfer options: This tab provides the options for configuring the transfer settings for
provider.
– Connection mapping: This tab provides you the required fields to map provider and
consumer and configure the connection.
– Connections: The list of connections created are displayed in this tab.
Note
IDB Configuration
A complete configuration exists after the required links containing connections between
provider(s) and consumer(s) are created. Creating a connection involves configuring the
Provider, Consumer, Transfer options and performing required mapping between provider and
consumer types.
Alternatively, links can also be modified by selecting the link name in project tree and
pressing the F2 key. The link name will be available for you to edit the link name.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 191
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
Deleting links
A link that is created within the project can be deleted at any point of time. Follow the steps
mentioned below to delete a link:
1. Highlight the link that needs to be deleted.
2. Right click on the link name and select "Delete link" option.
3. A confirmation message is displayed if you are sure to delete the link.
4. Confirm by clicking the "Yes" or "No" button whether or not you wish to delete the link.
Note
Delete all links
The IDB application includes options to delete all links. This option is provided in the
"Configuration" menu. To perform this operation, select the project name within project tree and
select "Configuration" > "Delete all links". The list of all links created within the currently open
project will thus be deleted.
Right click on the project node and select "Delete all links" option to delete all the links within the
project.
WinCC/IndustrialDataBridge
192 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
• Creating link
• Renaming link
• Opening provider or consumer configuration
Creating link
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 193
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
2. A new link denoted by a line is displayed between the provider and consumer nodes.
3. Enter a valid link name for the newly created link in the rectangular text box.
WinCC/IndustrialDataBridge
194 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
Note
Selecting link
At any point of time, a specific link can be selected by clicking on link name area within the "Link
configuration" window. Thereby, the respective provider node, consumer node, and connecting
line is highlighted with a different color.
Renaming link
In "Link configuration" window, click on link name area. The link name area will be converted
to an editable area that allows you to modify the link name.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 195
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
Introduction
While working with IndustrialDataBridge CS application, the resulting output from the project is
a complete IDB configuration file. This configuration file is an XML file that is used in the IDB
Runtime environment. The IDB Runtime application loads the configuration file, activates the
connection between provider and consumer components and performs the data transfer by
monitoring the life-span of these components.
The XML file can be generated in IDB CS using the "Generate Runtime Configuration" option.
Similarly, an IDB configuration available as an XML file can be loaded into IDB CS application
using the "Import Runtime Configuration" option. Loading an IDB configuration includes
loading the respective XML file which will load all the respective links and their connections
within the project tree.
This chapter describes the importance of generating / importing runtime configuration and
the steps for performing them.
WinCC/IndustrialDataBridge
196 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
Note
Default Storage Location
The default storage location for IDB CS projects is: "\Documents\Automation". This storage
location is used as the default location while importing project files. Project files in IDB CS have
an extension ".ip80". Any project that has been created can also be opened in IDB CS with the
help of ".ip80" project file.
2. In the "Open" dialog window, browse the folder structure, select the project XML file and click
"Open" button. The "Select Link(s)" dialog window is displayed.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 197
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
3. In the "Select Link(s)" dialog window, select the required links and click "OK" button.
Note
Select all links
Select "Check all" option to select all the links.
4. The selected link(s) is added to the current project and appears in the project tree.
Note
Default Storage Location
After performing the export operation, the XML files are exported to the location: "\My
Documents\Automation".
Note
XML file
If the XML file in Runtime application is not updated, changes made within the project will not
take effect. Hence, it is recommended to generate the runtime configuration once again that
includes the updated changes and use the updated XML file in Runtime.
WinCC/IndustrialDataBridge
198 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
Introduction
The IDB configuration interface and its corresponding windows provide various settings and
options depending on the loaded modules. These settings are described in the "Modules
(Page 202)" chapter.
This chapter includes information about different sections of the configuration interface
depending on corresponding selection within IDB configuration application. The IDB
Configuration mainly consists of the "configuration interface area".
Once a new project is created, the project node with the specified project name is shown in
the project tree.
After a link is created, the link will be displayed within the project. The link consists of the
following nodes listed within each link node in project tree:
• Provider
• Consumer
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 199
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
• Settings
• Connections
Note
Details view
The "Details view" window is displayed on left hand side of IDB CS window and is listed below the
project tree. This window displays only the details of Project and Links. Hence, the content
within this Details view is shown only when you click on Project node or Link node within the
project tree. The relevant nodes belonging to the project or link are displayed in the "Details
view" window.
The view on the right-hand portion of IDB CS application window displays the work area. The
work area displays information based on the selected node in the Project tree:
Project level
Upon selection of Project name within the Project tree, it does not display any information in
the work area. The "Add new link" node will be displayed below the project name node in the
tree structure. If the links are already created within the project, select the project name and
click the arrow icon to expand or view the list of links within the project.
Performing a right click on the project name (if there are already created link(s)), will display
the following options:
1. Add new link: This option is used to create a new link.
2. Delete all links: This option ca be used to delete all links.
3. Properties: This option lists the project properties in a separate window.
4. Add link(s) graphically: This option allows to add links through a separate user interface.
5. Add link(s) from XML: This option allows to add links from a project XML through a separate
user interface.
Link level
The links that have been created are displayed in Project tree within the project node.
Initially, these links will not display the expanded view consisting of the sub-nodes. To view
the sub-nodes available within the link node, expand the arrow icon next to the link name.
The provider or consumer type selected as part of creation of link will be shown next to each
sub-node (within link node). Hence, there can be any number of links that can be created
within a single project in IDB Configuration System application.
WinCC/IndustrialDataBridge
200 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.2 Configuration
After the creation of a link, the "Provider", "Consumer", "Settings" and "Connections" nodes
are created automatically and displayed within the link node.
• At provider or consumer node level, after double clicking the node, the corresponding
provider/consumer configuration window is displayed in work area. Thereby, you can
configure the Provider / Consumer in the respective window.
• The delete link option is enabled for all created links within the project tree. Right clicking on
the link node provides an option to delete a link.
Settings level
The Settings node exists within the Project tree that provides options to configure the link
settings. The Settings window can be accessed by double clicking the Settings node in Project
tree. The Settings window provides 3 tabs - Transfer options, Connection mapping and
Connections. These tabs are displayed within the Settings window in work area. The Settings
node helps you to configure provider transfer options, perform connection mapping and
create/view connections within these tabs.
The "Connection mapping settings" area is displayed as a split window within the Transfer
options tab. This window is active only within the Transfer options tab and is helpful to
choose a connection name even before you perform a connection mapping in Connection
Mapping tab. This display is common across all modules while configuring the provider
transfer options in "Transfer options" tab.
The "Connection mapping" tab displays the provider and consumer area one below the other
on left hand portion of this tab. The "Connection mapping settings" area is displayed to right
hand side of the window. The following icons are provided within the "Connection mapping
settings" area that enables you to create connection, modify connection, delete connection
and delete all connections. The icons and their description are provided in the table shown
below:
Icon Description
Connect
Modify connection
Delete connection
Delete all connections
Connections level
After performing a connection mapping between provider and consumer type, the
connections are created and displayed within the Connections tab of Settings window.
These connections are also displayed within the Connections node in Project tree. The
existing connections can be deleted by using the icons within Connection mapping tab or by
performing a right click on any existing connection within "Connections" node in Project tree.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 201
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Performing a right click on the "Connections" node in project tree provides the option to
"Delete all connections".
The following points are valid and these standards need to be followed in order to ensure the
required options (menu options / toolbar icons) are available for creating a connection:
• Ensure that the appropriate schema is selected in Schema field, if applicable for the selected
table.
• The table you have selected should contain at least one single row with a valid data type. For
a list of data types supported in IDB CS, please refer chapter "Supported data types
(Page 299)".
• The table should not contain any null values. This has to be verified during creation of the
table.
• Ensure that the required column is selected in both provider and consumer.
• The provider or consumer section within the connection mapping tab should not contain
fields that are empty provided if there is a field enabled for user selection.
4.3 Modules
4.3.1 Modules
IDB CS supports a variety of provider and consumer types. Each module contains the steps
for configuring a connection from provider to consumer and vice versa. When creating or
modifying a link, perform the provider/consumer configuration in the work area for which
the displayed fields depend on the selected module, example: "OPC Data Access" module. For
each module, the chapter deals with an Overview section. The individual steps are described
WinCC/IndustrialDataBridge
202 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
in the chapters that includes information about the module when used as a provider and
also as a consumer along with steps for mapping a connection. Some modules act only as a
consumer. In such chapters, the usage of the module as a consumer is explained.
Besides the Overview chapter, more information is available for different modules in
subsequent chapters. The following list of provider and consumer types are dealt in more
detail:
Provider:
• OPC Data Access
• OPC XML
• WinCC OLEDB
• Database
• Dynamic database
• Send/Receive
• WinCC User Archive
• OPC Unified Architecture
Consumer:
• OPC Data Access
• IDB OPC Server
• OPC XML
• Database
• Dynamic database
• CSV/TXT
• Excel
• Send/Receive
• WinCC User Archive
• Free Text Editor
• OPC Unified Architecture
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 203
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Drag and Drop feature
The existing provider and consumer configuration settings can be reused for the newly created
links. IDB provides drag and drop feature that allows you to drag the existing provider or
consumer node and drop it to a new provider or consumer node within project tree. The
configuration settings will thus be made available for the newly created provider and consumer
nodes. Hence, this is helpful whenever multiple links need to be configured along with their
provider and consumer configuration settings.
In Connection mapping tab, connection(s) can be created by selecting the provider column,
consumer column and clicking the Connect button. However, connection(s) can be created
using the Drag and Drop feature. The column values within the provider and consumer section
can be mapped from the provider to consumer type by dragging and dropping the data values.
In this way, connections can be created in a much faster way. This approach saves lot of time and
effort. For more information about this feature, please refer Chapter 5.5 "Drag and Drop"
(Page 526).
Note
4.3.2.1 Overview
Introduction
The OPC standard software interface allows devices and applications from various
manufacturers to be combined into one another in a uniform manner. The Data Access interface
addresses the internal OPC Client of the IndustrialDataBridge or using any OPC Server, which can
then connect to external modules. The connection is either established locally or remotely. This
module supports the OPC DataAccess 3.0 interface or higher with synchronous and
asynchronous access.
An OPC Server provides a manufacturer as a "Service Provider" for accessing data. Different
manufacturers offer different OPC servers with specific properties for different application
WinCC/IndustrialDataBridge
204 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
ranges. An OPC server can offer the data that can be accessed via PROFIBUS for instance,
another can provide access to a programmable controller.
An OPC client as a user of the services is not limited to a single server but can use any
amount of OPC servers within the scope of system performance capacity. Since the type of
data access is the same for all OPC servers, you can exchange one OPC server for a product of
another manufacturer with comparably less effort.
For the OPC server, unique names are defined by the supplier for identifying the object. OPC
clients must use this name to specify the OPC server. These names are designated as ProgIDs
within the scope of the 'COM' standard.
An OPC server can be addressed by multiple OPC clients. This makes various OPC-conforming
applications available for a data provider.
Note
DCOM settings
To work in the configuration and runtime environment of OPC Data Access (as provider and as
a consumer), you must configure the DCOM settings correctly in Windows. Incorrect DCOM
settings can lead to problems in IDB configuration and in the IDB runtime applications.
Information on DCOM settings can be found in "Microsoft Windows Help".
Note
Accessing tags
The OPCServer.WinCC tags are only available when WinCC project is activated and the OPC
Server is selected in the OPC Server browser window.
,'%
3URYLGHU &RQVXPHU
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 205
WinCC/IndustrialDataBridge Documentation
4.3 Modules
,'%
3URYLGHU &RQVXPHU
/RFDWLRQ
GDWD
23&
,'% 23&
'DWD3URYLGHU GDWD 'DWD$FFHVV
3URYLGHU &OLHQW
Objective
To create a project with corresponding link having OPC Data Access as provider and configure the
respective provider/consumer connection properties along with transfer behaviour settings
Creating a link
1. Open IDB Configuration and create a project by following the steps mentioned below:
– In IDB Configuration menu bar, select "Project" > "New project" to create a new project.
– In the "Create new project" dialog box, specify a project name, click [...] button and select
the folder location wherever the project needs to be saved.
– After entering the required information, select "Create" button. This creates a new project.
2. The project name will be listed within the "Project tree". The next step is to create a link.
Follow the steps mentioned below to create a link between provider and consumer:
– Right click on project name node in the tree structure and select "Add new link" option or
else double click the "Add new link" node below the project name node within project tree.
– In the "Add new link" dialog that is displayed, enter a unique link name.
– Select the provider type as OPC Data Access, consumer type as Database and click OK
button.
– The created link will be displayed below the project name in project tree.
– The corresponding entries - Provider, Consumer, Settings and Connections are created as
nodes that exist below the new link in the tree structure.
WinCC/IndustrialDataBridge
206 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. In project tree, double click the Provider node to open the provider configuration window.
In OPC Data Access provider configuration window, perform the following settings:
– Browse for OPC Server by clicking the [...] button and select OPC Server from the list. Next,
click the button representing "tick mark" to accept the changes.
The selection of the server is supported by an OPC tag browser. The browser shows the
local OPC Servers. You can search for OPC Servers in the network as well.
– The node name is simultaneously displayed in "Node name" text box after selection of the
OPC Server.
Note
Node name
For local OPC Server, the node name will display as "local host". In case of remote OPC
Server, the remote computer name will be displayed after selection of OPC Server on the
remote computer. This "Node name" is required for searching the OPC Server from the
remote computer.
The OPC tag browser does not display any content if node name is invalid.
Note
The "OPC Server" and "Node name" fields are provided as editable fields.
If the information about OPC Server name and node name is known, you can directly
enter the information in the "OPC Server" and "Node name" fields. If the node name / OPC
Server name is invalid, there will be no content displayed within the OPC tag browser.
4. Next, double click the Consumer node in project tree. In Consumer configuration window,
perform the following settings:
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 207
WinCC/IndustrialDataBridge Documentation
4.3 Modules
WinCC/IndustrialDataBridge
208 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– In "Database" field, click on [...] button and select the database from the list or from the
folder structure.
Note
Please note the following points:
• The "Server" field text box and "Use automatic Windows authentication" check box is
in disable state if you use "Microsoft Access" as the database.
• The "Use automatic Windows authentication" check box is in disable state if you have
used any database other than "Microsoft SQL Server".
• The option to select the check box "Use automatic Windows authentication" is
provided only for "Microsoft SQL Server" database.
• If you use "Oracle" as the database, it is important to note that the "Database" field list
box will be in disable state.
– If a user name and password has been set for the database, enter the user name and
password in the "User name" and "Password" fields respectively.
If you wish to set a blank password, enable the check box "Blank password". To save the
entered password, enable the check box "Allow saving password".
– Click Test button to test the connection. The application tests the database connection
string and verifies the selected database.
"Consumer type configuration" section
– Select the "Consumer type" by selecting from the list. In this case, we consider the
consumer type as "One data record per call - record set. More information about the
consumer types are provided in detail in Chapter 3.6.7, "Consumer Types" (Page 322).
Note
Transaction type
The Stored procedure or Prepared insert statement transaction type options are in enable
state only when the consumer type "One data record per call - command set" is selected and
if you have selected a database other than Microsoft access. By default, the Prepared insert
statement option is automatically selected.
• Only the "Table" field is enabled if Microsoft access is selected as the database type and
consumer type is selected as "One data record per call - command set". Select the table
name by clicking on the drop down list box.
• If you have selected a database type other than Microsoft access and the consumer type
is selected as "One data record per call - command set", then all the fields within the
Transaction type will be in enable state.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 209
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. Enter a time period in the "Update rate" field after which the system checks for when the data
has to be transferred.
It checks each and every tag for all connections.
Note
Update rate
For better performance, it is recommended to use an update rate of 1000 ms or 1 sec.
WinCC/IndustrialDataBridge
210 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Optional fields
The "Deadband" and "Item for Transaction Security" fields are optional.
Note
Deadband
All OPC Servers do not support deadband. This is dependent on the OPC Server being
used. The "Deadband value (%)" text box is enabled only with the data transfer type -
"Send only changed values". This text box is disabled while you select transfer types -
"Send always all values" and "Send values using trigger".
5. Enter the deadband value (in percent) to contain a value within the range 0 - 100.
6. In "Tag for Transaction Security" field, click [...] button and select a OPC Server tag from the
OPC tag browser. You can define an OPC tag on an OPC server, in which the success-/failure-
status of the data transfer will be stored in the "Tag for transaction security" field.
This value should have 1 byte signed char (e.g. VT_I1). '-1' indicates the success state and '0'
indicates failure.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 211
WinCC/IndustrialDataBridge Documentation
4.3 Modules
7. If you have selected the option "Send values using trigger", you can configure the trigger that
provides options to set the trigger options.
The Trigger section is enabled only with the data transfer type "Send values using trigger".
Perform the following settings in the "Trigger settings" section:
– In "Trigger tag" field, select the tag that should trigger a data transfer. Click on [...] to select
the tag from OPC tag browser.
– Select a valid data type by selecting from the drop down list.
– Enter a threshold at which a data transfer should be triggered, in the "Trigger value" field.
– In "Confirmation value" field, enter a value that the trigger tag should take on after
triggering. The confirmation value does not give any information on whether a
transaction has been completed successfully.
Note
Trigger behavior
The trigger tag selected in "Trigger tag" field triggers the data transfer. IDB CS sets the
confirmation value in the provider tag specified in "Confirmation value" field.
Example: If Trigger value is 100, the data transfer will happen after a known duration that
is mentioned in "Update rate" field. Once the value of tag reaches the value 100, a
confirmation value is written to the provider tag.
8. The transfer behavior settings for OPC Data Access as provider will be saved automatically.
Note
Saving Changes
A save operation is not required every time whenever changes are performed within the editor
window in the work area. The changes made to these settings are automatically saved. However,
once the project is created, at any point of time, you can save the project by selecting the
"Project" > "Save" menu option.
Results
You have created a connection between the OPC Data Access interface and a consumer. These
elements are displayed in the tree structure of the configuration interface. In order to transfer
data, connect the provider and consumer tags, as described in chapter "Connecting Tags from
the OPC Data Access Interface".
WinCC/IndustrialDataBridge
212 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Connecting Tags
In "Settings" window, the "Connection mapping" tab includes the required fields to connect tags
that have been sent from OPC Data Access interface with the selected data consumer. The
Connection mapping tab divides the window into 3 sections:
• OPC Data Access provider
• Database consumer
• Connection mapping settings
The "OPC Data Access provider" section is displayed at top left portion of "Connection
mapping" tab. This section provides you with required options to choose the tag name from
the "OPC tag browser". The "Database consumer" section is displayed at bottom left portion
of "Connection mapping" tab. This section lists the selected Table, Schema and column
names that can be mapped with the tags existing within "OPC DataaAccess provider". The
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 213
WinCC/IndustrialDataBridge Documentation
4.3 Modules
information within "Database consumer" section explained below is specific to having the
consumer type as "One data record per call - recordset".
Note
Consumer types
The fields displayed within "Database consumer" section depends on the "Consumer type" that
you have selected in Consumer configuration window. In this case, the consumer type "One data
record per call - recordset" is used.
The separator between the provider and consumer section provides a resize handle that
helps you to resize the height of the section in order to view the fields within the section
clearly.
The "Connection mapping settings" section is displayed at right side of "Connection mapping"
tab. This section helps you to provide a name for connection along with options for choosing
default name for connection. The "Connect", "Modify connection", "Delete connection" and
"Delete all connections" icons are provided at the top portion of this section.
1. In "OPC Data Access provider" section, select the tag name from the list that is displayed
within the "OPC tag browser". Upon selection of the tag within OPC tag browser, the tag
name is displayed in "Tag ID" field. The data type is selected automatically based on selection
of this tag.
2. If the selected tag has Array data type, then the "Array" check box is automatically enabled.
This check box is provided below the "Data type" field.
3. Next, configure the column in the "Database consumer" section by following these steps:
– Select the Schema, if applicable from "Schema" field. The selected table is shown in the
"Table" field.
– The column names are displayed within "Columns" area. If the table has columns with
Date/time data type, the time stamp can also be written to the column within the table.
In this case, select the respective "Active" check box and select the column within "Column
for timestamp" field.
4. In "Columns" area, select the Column name that you wish to connect with OPC Data Access
tag. The data type of selected column will be automatically displayed in the "Datatype" field.
The selected column is displayed in "Column for data value" field.
Note
Data type conversion
If the provider tag data type does not match with consumer column, IDB CS converts the
provider data type to match with data type of consumer. A status window is displayed to
indicate this change.
5. Check the name of the connection in the "Connection mapping settings" area to the right.
Enter a unique name for the connection in the "Connection name" field or use the options
within "Default name options" area. Click "Connect" button to confirm your entries.
WinCC/IndustrialDataBridge
214 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
6. Repeat steps 1 to 5 for all tags of the "OPC Data Access" interface that you wish to transfer.
7. The connection name including the provider and consumer data values will be displayed
within the "Connection mapping settings" section.The list of connections will be also
displayed within the Connections tab as well as in the project tree within the "Connections"
node belonging to the specific link.
Note
Schema
Microsoft Access does not support schema functionality. Hence, you can observe that the
Schema field in Database consumer is in disable state.
While using any other database as consumer, the Schema field will be in enable state.
Note
Array
If the OPC Data Access provider tag has a data type of type "Array" and if the database consumer
column has data type selected other than array data type, after clicking on the "Connect" button,
the "Array" check box in the "OPC Data Access provider" is automatically unchecked.
Note
In Connection mapping tab, if you are using OPC Data Access as provider that has a tag of data
type other than Array data type and any other consumer that supports "Array" data type, after
clicking on the "Connect" button, the "Array" check box in provider is automatically checked.
Note
Modifying Consumer type
Once the connection(s) have been created in Connection mapping window and if you wish to
modify the Consumer type in Database consumer configuration, the IDB CS application will not
allow to change the Consumer type. To change the Consumer type, you need to delete the
connection(s) that have been already created. Close the consumer configuration window and re-
open the window from the project tree to modify the consumer type.
Results
The connections that you have created are shown in the "Connections" tab of IDB CS Settings
window as well as within the "Connections" node in project tree.
Objective
To create a project with corresponding link having OPC Data Access as consumer and configure
the respective provider/consumer connection properties along with transfer behaviour settings
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 215
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Creating a link
1. Open IDB Configuration and create a project by following the steps mentioned below:
– In IDB Configuration menu, select "Project" > "New project" to create a new project.
– In the "Create new project" dialog box, specify a project name, click [...] button and select
the folder location wherever the project needs to be saved.
– After entering the required information, select "Create" button. This creates a new project.
2. The project name will be listed within the "Project tree". The next step is to create a link.
Follow the steps mentioned below to create a link between provider and consumer:
– Right click on project name node in the tree structure and select "Add new link" option or
else double click the "Add new link" node below the project name node within project tree.
– In the "Add new link" dialog that is displayed, enter a unique link name.
– Select the provider type as Database, consumer type as OPC Data Access and click OK
button.
– The created link will be displayed below the project name in project tree.
– The corresponding entries - Provider, Consumer, Settings and Connections are created as
nodes that exist below the new link in the tree structure.
WinCC/IndustrialDataBridge
216 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. In project tree, double click the Provider node to open the provider configuration window:
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 217
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– If a user name and password has been set for the database, enter the user name and
password in the "User name" and "Password" fields respectively.
If you wish to set a blank password, enable the check box "Blank password". To save the
entered password, enable the check box "Allow saving password".
– Click Test button to test the connection. The application tests the database connection
string and verifies the selected database.
4. Next, double click the Consumer node in project tree. In Consumer configuration window,
perform the following settings:
WinCC/IndustrialDataBridge
218 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Node name
For local OPC Server, the node name will display as "local host". In case of remote OPC Server,
the remote computer name will be displayed after selection of OPC Server on the remote
computer. This node name is required for searching the OPC Server from the remote
computer.
The OPC tag browser does not display any content if node name is invalid.
Note
The "OPC Server" and "Node name" fields are provided as editable fields. If the information
about OPC Server name and node name is known, you can directly enter the information in
the "OPC Server" and "Node name" fields. If the node name / OPC Server name is invalid, there
will be no content displayed within the OPC tag browser.
"Configuration for bad quality item" section
– In the "Configure a Variable for number of transaction errors" field, click on [...] button and
select a tag from the OPC tag browser.
Next, click the button representing "tick mark" to accept the changes. The amount of tags
with errors is written with QUALITY=BAD.
The OPC tag browser will be displayed as shown in the image given below:
– Choose the specific data type by selecting from the drop down list box.
Note
OPC tags
Selection of the tag in OPC tag browser displays the corresponding data type in "Data type"
field. However, if you remember the name of tag, enter the tag name and data type in the
respective fields within "Configuration for bad quality item" section.
"Asynchronous transfer configuration" section
– Enable the check box option "Write asynchronous" for asynchronous writing.
– Enter the permitted number of maximum outstanding write transactions in the text box.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 219
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Asynchronous transfer
If the "Write asynchronous" check box is enabled, a default value of 10 is set and will be
displayed within the "Maximum number of outstanding write transaction" text box. When
this check box is disabled, the value will be reset to 0. You can type a value in this text box
ranging from 1 - 40.
If the value entered in this text box is not within the range, then an error message is displayed.
Note
Asynchronous writing
The Asynchronous transfer configuration is useful to ensure the correctness of the actual
data transfer that is happening.
Example: If you have configured the "Maximum number of outstanding write transaction" as
15 and if the data transfer is not happening correctly, after the failure of 15th transaction, a
warning message will be displayed in the IDB Runtime Trace view.
WinCC/IndustrialDataBridge
220 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 221
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. Select the "Schema" if applicable and the "Table" name by selecting from the drop down list.
Enter a time period in the "Update rate" field after which the system checks for when the data
is to be transferred.
Note
Schema
Microsoft Access does not support schema functionality. Hence, you can observe that the
Schema field will be in disable state if you have chosen Microsoft Access as the database type.
Note
Table name
If you are unable to view Table name in the "Table" field, check if the Schema is selected in
"Schema" field. Without selecting the "Schema", the table name will not be displayed.
However, if you are using Microsoft Access as the database, this condition will not be valid.
If you are still unable to view the Table, please verify with the provider configuration.
Note
Update rate
For better performance, it is recommended to use an update rate of 1000 ms or 1 sec.
WinCC/IndustrialDataBridge
222 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
5. If you have selected the option "Send values using trigger", you can configure the trigger. The
Trigger section is enabled only if the data transfer type "Send values using trigger" is selected.
Perform the following settings in the "Configure trigger" section:
– In the "Schema" field, choose a valid schema by selecting the drop down list.
– Choose a "Table" name by selecting from the drop down list.
– Select the specific column that needs to be used for the trigger condition.
– Choose a valid data type by selecting from the drop down list.
– Enter a threshold at which a data transfer should be triggered, in the "Trigger value" field.
– In "Confirmation value" field, enter a value that the trigger tag should take on after
triggering.
The Confirmation value does not give any information whether a transaction has been
completed successfully.
Note
Trigger behavior
The column name selected will be used for the trigger condition that triggers the data
transfer. IDB CS sets the confirmation value in the provider tag specified in "Confirmation
value" field.
Note
Saving Changes
A save operation is not required every time whenever changes are performed within the editor
window in the work area. The changes made to these settings are automatically saved. However,
once the project is created, at any point of time, you can save the project by selecting the
"Project" > "Save" menu option.
Results
You have created a connection between a provider and the OPC Data Access interface. These
elements are displayed in the tree structure of the configuration interface. In order to transfer
data, connect the provider and consumer tags, as described in chapter "Connecting Tags to the
OPC Data Access Interface".
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 223
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Connecting Tags
In "Settings" window, the "Connection mapping" tab includes the required fields to connect tags
that have been sent from selected provider to OPC Data Access interface. The Connection
mapping tab divides the window into 3 sections:
• Database provider
• OPC Data Access consumer
• Connection mapping settings
The "Database provider" section is displayed at top left portion of "Connection mapping" tab.
This section lists the column values that can be mapped with the tags existing within OPC
Data Access interface. The "OPC Data Access consumer" section is displayed at bottom left
portion of "Connection mapping" tab. This section provides you with required options to
choose the tag name from the list of OPC tags in the OPC tag browser.
The separator between the provider and consumer section provides a resize handle that
helps you to resize the height of the section in order to view the fields within the section
clearly.
The "Connection mapping settings" section is displayed at right side of "Connection mapping"
tab. This section helps you to provide a name for connection along with options for choosing
default name for connection. The "Connect", "Modify connection", "Delete connection" and
"Delete all connections" icons are provided at the top portion of this section.
WinCC/IndustrialDataBridge
224 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
1. In "Database provider" section, the selected archive is shown in the "Table" field. Select the
"Schema" for database if applicable by selecting from drop down list.
2. The Column names and their corresponding data type are displayed within "Columns" area.
Select a Column name from the list, the selected column is displayed in "Column for data
value" field. The data type is shown in the "Data type" field.
3. The "Filter" field provides you the option to filter the Column names based on single character
or first few characters of column name.
For example, if you wish to view the column names starting with "S", type this character in
"Filter" text box. All column names starting with "S" are displayed.
4. Next, configure the tag in the "OPC Data Access consumer" section by following these steps:
– Select the tag name from the list that is displayed within "OPC tag browser". Upon
selection of the tag within OPC tag browser, the tag name is displayed in "Tag ID" field. The
data type is displayed in "Data type" field based on selection of the tag.
Note
Data type conversion
If the provider tag data type does not match with consumer column, IDB CS converts the
provider data type to match with data type of consumer. A status window is displayed to
indicate this change.
5. Check the name of the connection in the "Connection mapping settings" area to the right.
Enter a unique name for the connection in the "Connection name" field or use the options
within "Default name options" area. Click "Connect" button to confirm your entries.
6. Repeat steps 1 to 5 for all elements of the "Database Provider" that you wish to transfer.
7. The connection name including the provider and consumer data values will be displayed
within the "Connection mapping settings" section.The list of connections will be also
displayed within the Connections tab as well as in the project tree within the "Connections"
node belonging to the specific link.
Note
Schema
Microsoft Access does not support schema functionality. Hence, you can observe that the
Schema field in Database consumer is in disable state.
While using any other database as consumer, the Schema field will be in enable state.
Note
Array
If the database provider column has a data type selected other than array data type and if the
OPC Data Access consumer tag has "Array" data type, then after clicking the "Connect" button,
an error message "Error while setting data type of provider" is displayed. This will not allow to
perform a connection mapping as "Array" data type might not be supported by the selected
provider.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 225
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
OPC Data Access as consumer
In Connection mapping tab, if you are using any other provider that supports "Array" data type
and consumer is OPC Data Access that has a tag of data type other than "Array" data type, after
clicking on the "Connect" button, the "Array" check box in provider is automatically checked.
Results
The connections that you have created are shown in the "Connections" tab of IDB "Settings"
window as well as within the "Connections node" in project tree.
4.3.3.1 Introduction
IDB provides two types of OPC Servers:
• OPC DA Server
• OPC UA DA Server
Both these servers function as consumers with any provider that IDB supports. The
functionality of these servers is the same but differ with respect to the supported security
levels and communication protocol.
WinCC/IndustrialDataBridge
226 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Overview
Introduction
The internal OPC Server of the IndustrialDataBridge is addressed through the OPC Data Access
2.x (or higher) interface and functions internally as a consumer, i.e. you can only read tags
(items). In this case, the ProgID of the OPC Server is "OPC.IndustrialDataBridge".
,'%
3URYLGHU &RQVXPHU
23&
,'%
GDWD ,QGXVWLDO 23&'DWD$FFHVV 23&&OLHQW
3URYLGHU
'DWD%ULGJH
Networking
OPC uses DCOM technology for networking. In this way, the data sources (OPC Server) are
available on the local computer including all servers being available on the network as remote
data sources.
Applications
The IDB OPC Server of the IndustrialDataBridge is a consumer module. You can acquire the data
via all available provider modules (Database, Dynamic database, OPC Data Access, OPC XML,
Send/Receive, WinCC OLE DB, WinCC User Archive).
The following data types are supported and are released for the IDB OPC Server module.
• VT_UI1 ( 1 byte unsigned )
• VT_I1 ( 1 byte signed )
• VT_UI2 ( 2 byte unsigned )
• VT_I2 ( 2 byte signed )
• VT_UI4 ( 4 byte unsigned )
• VT_I4 ( 4 byte signed )
• VT_R4 ( 4 byte real )
• VT_R8 ( 8 byte real )
• VT_BSTR ( binary string )
• VT_BOOL ( boolean )
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 227
WinCC/IndustrialDataBridge Documentation
4.3 Modules
• VT_CY ( currency )
• VT_DATE ( date )
Note
Important Notes
WinCC/IndustrialDataBridge
228 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Upon performing the required changes, the created configuration in the project can be saved
and exported to configuration (XML file). The configuration (XML file) is then opened and
started in the IDB Runtime environment.
When tags are added, by means of defining the connections between provider and
consumer, the address space is defined on the OPC Data Access Server. The tags that are read
by the defined provider have access right "Readable". Writing to these tags is not possible.
Note
Starting a New Configuration in the Runtime Environment
If a new or changed configuration (XML file) is opened and started in the runtime environment
while an OPC Client (external) is connected with the OPC Server (IDB), the address space of the
server could possibly change. The items that the connected client uses can be made invalid this
way!
Note
Quality of the Tags
If the runtime program is stopped with a loaded configuration, all tags have the quality "Bad".
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 229
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Overview
Introduction
The IDB OPC UA DA server functions as a consumer module. The OPC UA server is represented
as OPC.IndustrialDataBridge.UA.
,'%
3URYLGHU &RQVXPHU
Supported specifications
OPC Unified Architecture is a specification for the transmission of process values, archive data
and messages. The IDB OPC UA DA server supports OPC UA Specification 1.03.
Application
You can acquire the data via all available provider modules of IDB.
The following data types are supported for IDB OPC UA DA server module:
• VT_UI1 (1 byte unsigned)
• VT_I1 (1 byte signed)
• VT_UI2 (2 byte unsigned)
• VT_I2 (2 byte signed)
• VT_UI4 (4 byte unsigned)
• VT_I4 (4 byte signed)
• VT_R4 (4 byte real)
• VT_R8 (8 byte real)
• VT_BSTR (binary string)
• VT_BOOL (boolean)
• VT_CY (currency)
• VT_DATE (date)
WinCC/IndustrialDataBridge
230 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Important Notes
• If you are using OPC UA DA server in consumer configuration, it is important to note that you
will not be able to perform configuration for bad quality item in the consumer side.
Principle of operation
Installation
There is no seperate configuration to install IDB OPC UA DA server.The IDB OPC UA DA server is
available for usage once the IDB Runtime service starts.
Parameter Description
HostName Placeholder for the computer name.
Port Port number. The default setting value is "4872".
Note
Port number
If any conflict occurs due to the port number, modify the port number in the file
sitbopcuasrv.xml under the tag:
<BaseAddresses>
<ua:String>opc.tcp://[HostName]:4872</ua:String>
</BaseAddresses>
Security
The OPC UA DA server security is based on:
• Authentication and authorization of applications and users involved.
• Ensuring integrity and confidentiality of messages exchanged between the applications.
Both these points are achieved through OPC UA DA server configuration and certificate
exchange between the OPC UA DA client and OPC UA DA server.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 231
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Certificates
The OPC UA DA applications are authenticated through certificates. Each application has its own
instance certificate with which it identifies itself in the public key infrastructure.
The certificates used by IDB OPC UA DA server are configured in the "sitbopcuasrv.xml"
configuration file:
Instance certificate
For secure operation, every IDB OPC UA DA server requires its own instance certificate with a
private key. The certificate is only valid on the corresponding computer and is used only by the
IDB OPC UA DA server installed on that computer.
When the server is configured, a self-signed instance certificate for the server is generated
and stored in the server certificate folder and in the certificate memory of the operating
system. The private key for the certificate is only stored in the certificate folder.
You must restrict access to the folder with the private key to:
• Server
• System administrator
The instance certificate generated upon installation and the corresponding private key can be
replaced by the administrator of the system. In accordance with the security of the system,
the new instance certificate can be either self-signed or issued by a certification authority.
The storage location for the instance certificate of the IDB OPC UA DA server is defined in the
settings for the server configuration file. If necessary, the storage location can be changed by
the system administration.
The parameters in the instance certificate are described below:
WinCC/IndustrialDataBridge
232 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
In this case, the instance certificate of the server is stored in the directory "[Application
path]\OPC_UA\Server\PKI\CA\certs" and the private key in the directory "[Application path]
\OPC_UA\Server\PKI\CA\private".
Note: IDB OPC UA Server and Client supports only self signed certificates.
Parameter Meaning
StoreType Type of certificate storage. The storage location must be "Directory".
StorePath The certificates of trusted clients are stored under this folder.
In this case, the IDB OPC UA DA server trusts all clients whose instance certificates are located
in the "[ApplicationPath]\OPC_UA\Server\PKI\CA\certs" folder.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 233
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Certificates from the certification authorities that are required for verifying a client certificate
chain are stored in the certificate memory of the certification authorities. You can specify
storage settings using the IDB OPC UA DA server configuration file:
Parameter Meaning
StoreType Type of certificate storage. The storage location must be "Directory".
StorePath The certificates of trusted certification authorities are stored under this
folder.
Note
Certificates from the memory of the certification authorities are not automatically trusted
For a certification authority to be trusted, its certificate must be located in the memory for
trusted certificates.
Certificates are trusted if they are located in one of the two locations:
• <Local computer>\Trusted root certification authorities
• <Local computer>\Third-party root certification authorities
Note
Important for storage
The storage location for the server certificate must be "Directory".
The two storage locations for trusted client certificates and for certificates from certification
authorities must have the same StoreType.
To enable secured communication with this client, you will have to move the rejected
certificate to the certificate memory for trusted certificates.
WinCC/IndustrialDataBridge
234 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
ServerConfiguration
The XML element "SecurityPolicies" under "ServerConfiguration" contains the list of all available
"Security Profile" and "Message Security Mode" combinations for the OPC UA DA server.
Note
Ensuring secure communication
Secure communication requires instance certificates for server and client with a correctly
configured certificate memory.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 235
WinCC/IndustrialDataBridge Documentation
4.3 Modules
SecuredApplication
In accordance with the OPC UA specification, security mechanisms are explicitly enabled/
disabled with the "SecurityProfileUris" element under "SecuredApplication".
The image below shows the SecuredApplication element in which insecure communication is
disabled:
WinCC/IndustrialDataBridge
236 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
The IDB OPC UA DA server therefore supports the security strategies Basic256,
Basic256Sha256 and Basic128Rsa15 or no security in runtime with Message Security Modes
"Sign" and "SignAndEncrypt", but not unsecured communication. When communication is
established, the OPC UA clients select the required Policy from this list.
User identity
The IDB OPC UA DA server also supports user authentication for the client applications using
UserTokenPolicy "UserName". The client application must provide a valid combination of user
name and password when communication is established. The IDB OPC UA DA server verifies the
combination in the user management of the operating system.
The UserTokenPolicy is set in the configuration file of the IDB OPC UA server.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 237
WinCC/IndustrialDataBridge Documentation
4.3 Modules
With this configuration, the IDB OPC UA DA server supports both anonymous users and the
Policy "UserName".
WinCC/IndustrialDataBridge
238 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Starting a new configuration in the Runtime environment
If a new or changed configuration (XML file) is opened and started in the runtime environment
while an OPC UA Client (external) is connected with the IDB OPC UA DA Server, the address space
of the server could possibly change. In this way, the items that the connected client uses can be
made invalid.
Note
Quality of the tags
If the runtime program is stopped with a loaded configuration, all tags have the quality "Bad".
Objective
To create a project with corresponding link having IDB OPC Server as consumer and configure the
respective provider/consumer connection properties along with transfer behavior settings.
In this demonstration, Database is used as Provider and IDB OPC DA Server is used as
Consumer. Irrespective of the type of server required, the procedure to use the servers as
consumer is the same.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 239
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Creating a link
1. Open IDB Configuration and create a project by following the steps mentioned below:
– In IDB Configuration menu, select "Project" > "New project" to create a new project.
– In the "Create new project" dialog box, specify a project name, click [...] button and select
the folder location wherever the project needs to be saved.
– After entering the required information, select "Create" button. This creates a new project.
2. The project name will be listed within the "Project tree". The next step is to create a link.
Follow the steps mentioned below to create a link between provider and consumer:
– Right click on project name node in the tree structure and select "Add new link" option or
else double click the "Add new link" node below the project name node within project tree.
– In the "Add new link" dialog that is displayed, enter a unique link name.
– Select the provider type as Database, consumer type as IDB OPC Server and click OK
button.
– The created link will be displayed below the project name in project tree.
– The corresponding entries - Provider, Consumer, Settings and Connections are created as
nodes that exist below the new link in the tree structure.
3. In project tree, open the Provider configuration window by double clicking the Provider node.
WinCC/IndustrialDataBridge
240 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– If a user name and password has been set for the database, enter the user name and
password in the "User name" and "Password" fields respectively.
If you wish to set a blank password, enable the check box "Blank password". To save the
entered password, enable the check box "Allow saving password".
– Click Test button to test the connection. The application tests the database connection
string and verifies the selected database.
Note
Oracle database
While using "Oracle" as the database type, please note that the "Database" field in
'Database provider configuration' window is shown in disable state and does not allow
any user selection for this field. The selection of table belonging to Oracle database can
be performed within the 'Transfer options' tab.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 241
WinCC/IndustrialDataBridge Documentation
4.3 Modules
WinCC/IndustrialDataBridge
242 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Schema
Microsoft Access does not support schema functionality. Hence, you can observe that the
Schema field will be in disable state if you have chosen Microsoft Access as the database type.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 243
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Table name
If you are unable to view Table name in the "Table" field, check if the Schema is selected in
"Schema" field. Without selecting the "Schema", the table name will not be displayed.
However, if you are using Microsoft Access as the database, this condition will not be valid.
If you are still unable to view the Table, please verify with the provider configuration.
Note
Update rate
For better performance, it is recommended to use an update rate of 1000 ms or 1 sec.
WinCC/IndustrialDataBridge
244 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Saving Changes
A save operation is not required every time whenever changes are performed within the editor
window in the work area. The changes made to these settings are automatically saved. However,
once the project is created, at any point of time, you can save the project by selecting the
"Project" > "Save" menu option.
Results
You have created a connection between a provider and the IDB OPC Server interface. These
elements are displayed in the tree structure of the configuration interface. In order to transfer
data, connect the provider and consumer tags, as described in chapter "Connecting Tags to the
IDB OPC Server".
Connecting Tags
In "Settings" window, the "Connection mapping" tab includes the required fields to connect
tags that have been sent from selected provider to IDB OPC Server interface. The Connections
mapping tab divides the window into 3 sections:
• Database provider
• IDB OPC server consumer
• Connection mapping settings
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 245
WinCC/IndustrialDataBridge Documentation
4.3 Modules
The "Database provider" section is displayed at top left portion of "Connection mapping" tab.
This section lists the column values that can be mapped with the tags of "IDB OPC server
consumer". The "IDB OPC server consumer" section is displayed at bottom left portion of
"Connection mapping" tab. This section provides you with required fields to enter the tag
name and select the requested data type.
The separator between the provider and consumer section provides a resize handle that
helps you to resize the height of the section in order to view the fields within the section
clearly.
The "Connection mapping settings" section is displayed at right side of "Connection mapping"
tab. This section helps you to provide a name for connection along with options for choosing
default name for connection. The "Connect", "Modify connection" and "Delete connection"
icons are provided at the top portion of this section.
WinCC/IndustrialDataBridge
246 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
7. Repeat steps 1 to 6 for all elements of the "Database Provider" that you wish to transfer.
8. The connection name including the provider and consumer data values will be displayed
within the "Connection mapping settings" section.The list of connections will be also
displayed within the Connections tab as well as in the project tree within the "Connections"
node belonging to the specific link.
Note
Schema
Microsoft Access does not support schema functionality. Hence, you can observe that the
Schema field in Database consumer is in disable state.
While using any other database as consumer, the Schema field will be in enable state.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 247
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Array
If the Database provider column has a data type selected other than array data type and if the
consumer tag (IDB OPC Server tag) has array data type wherein the "Array" check box has been
marked for selection, then after clicking the "Connect" button, an error message "Error while
setting data type of provider" is displayed. This will not allow to perform a connection mapping
as "Array" data type might not be supported by selected provider.
In Connection mapping tab, if you are using any other provider that does not support "Array"
data type and consumer is IDB OPC Server that has a tag of data type "Array", after clicking on
the "Connect" button, the "Array" check box in provider is automatically checked.
Note
Quality of tags
If data type of consumer does not match with the provider data type, then the tag will have
Quality = BAD.
Results
The connections that you have created are shown in the "Connections" tab of IDB "Settings"
window as well as within the "Connections" node of project tree.
4.3.4.1 Overview
Introduction
OPC XML provides a standard interface for accessing data. It can serve both as a server providing
data and as a client receiving data from other data providers. With XML, the extensible markup
language, it provides another means to describe and exchange information between
collaboration applications. The OPC XML based interface will simplify sharing and data
exchange of OPC data amongst various levels of plant hierarchy and across various platforms.
OPC XML module is based on data exchange via XML with the platform-independent protocol
that is used to enable applications to communicate with each other. This module supports all
the data types supported by OPC Data Access 3.0. IDB supports OPC XML 1.01.
An OPC XML server can be addressed by multiple OPC clients. Similarly, any OPC client
can be used to connect to the OPC XML server or data provider. As OPC XML is
platform independent, it allows applications to easily communicate. This makes various
OPC-confirming applications available for a data provider across multiple platforms.
WinCC/IndustrialDataBridge
248 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
,'%
3URYLGHU &RQVXPHU
23& ,'%
23&
;0/ GDWD &RQVXPHU 'DWD&RQVXPHU
;0/&OLHQW
,'%
3URYLGHU &RQVXPHU
/RFDWLRQ
GDWD
23&
,'% 23&
'DWD3URYLGHU GDWD ;0/
3URYLGHU ;0/&OLHQW
4.3.4.2 Requirements
Introduction
OPC XML enables exchange of data amongst various levels of plant hierarchy and across multiple
platforms. In order to use OPC XML, a number of additional software components must be
installed.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 249
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Installing IIS
IIS needs to be installed firstly before performing the installation of .NET Framework V2.0.
Objective
To create a project with corresponding link having OPC XML as provider and configure the
respective provider/consumer configuration along with transfer behavior settings.
Creating a link
1. Open IDB Configuration and create a project by following the steps mentioned below:
– In IDB Configuration menu bar, select "Project" > "New project" to create a new project.
– In the "Create new project" dialog box, specify a project name, click [...] button and select
the folder location wherever the project needs to be saved.
– After entering the required information, select "Create" button. This creates a new project.
2. The project name will be listed within the "Project tree". The next step is to create a link.
Follow the steps mentioned below to create a link between provider and consumer:
– Right click on project name node in the tree structure and select "Add new link" option or
else double click the "Add new link" node below the project name node within project tree.
– In the "Add new link" dialog that is displayed, enter a unique link name.
– Select the provider type as OPC XML, consumer type as CSV/TXT and click OK button.
– The created link will be displayed below the project name in project tree.
– The corresponding entries - Provider, Consumer, Settings and Connections are created as
nodes that exist below the new link in the tree structure.
WinCC/IndustrialDataBridge
250 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. In project tree, open the Provider configuration window by double clicking the Provider node.
In the "OPC XML provider configuration" section, enter the Server URL of OPC XML Data
Access Server.
The Server URL or the service name need to be known in order to configure the OPC XML
connection properties.
Note
https connection
For enhanced security purposes, it is recommended to use https connection while
configuring OPC XML Data Access provider.
4. Next, double click the Consumer node in project tree. In Consumer configuration window,
perform the following settings:
– In "CSV/TXT Configuration" field, click [...] buttion and select the CSV/TXT file by browsing
the folder structure.
– The file name will be automatically displayed in text box once the CSV/TXT file is selected.
– Click "Test" button to test the connection. The "Connection string" will be displayed in a
dialog window along with the connection status.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 251
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. Enter a time period in the "Update rate" field after which the system checks for whether data
is to be transferred.
Note
Update rate
For better performance, it is recommended to use an update rate of 1000 ms or 1 sec.
WinCC/IndustrialDataBridge
252 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Deadband
All OPC Servers do not support deadband. This is dependent on the OPC Server being
used. The "Deadband value (%)" text box is enabled only with the data transfer type -
"Send only changed values". This text box is disabled while you select transfer types -
"Send always all values" and "Send values using trigger".
5. In "Deadband (%)" field, enter the dead band value (in %) within the text box provided. The
deadband value should be within 0 - 100.
6. In "Tag for transaction security" text box, select […] and select a tag of OPC Server from the
OPC tag browser.
You can define a OPC tag on an OPC server, in which the success-/failure-status of the data
transfer will be stored in the "Tag for transaction security" field.This value should have 1 byte
signed char (e.g. VT_I1). '-1' indicates the success state and '0' indicates failure.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 253
WinCC/IndustrialDataBridge Documentation
4.3 Modules
7. If you have selected the option "Send values using trigger", you can configure the trigger that
provides options to choose trigger tag and set trigger values. Perform the following settings
in the "Trigger settings" section:
– In "Trigger tag" text box, select [...] button to open OPC tag browser and select a tag that
should trigger a data transfer.
– Select a valid data type by selecting from the drop down list.
– Enter a threshold at which a data transfer should be triggered, in the "Trigger value" field.
– You can enter a value that the trigger tag should take on after triggering, in the
"Confirmation value" field. The confirmation value does not give any information on
whether a transaction has been completed successfully.
8. The transfer behavior settings for OPC XML as provider will be saved automatically.
Note
Saving Changes
A save operation is not required every time whenever changes are performed within the editor
window in the work area. The changes made to these settings are automatically saved. However,
once the project is created, at any point of time, you can save the project by selecting the
"Project" > "Save" menu option.
Results
You have created a connection between the OPC XML and a consumer. These elements are
displayed in the tree structure of the configuration interface. In order to transfer data, connect
the provider and consumer tags, as described in chapter "Connecting Tags from the OPC XML
Interface (Page 254)".
Connecting Tags
In "Settings" window, the "Connection mapping" tab includes the required fields to connect tags
that have been sent from the OPC XML Data Access provider to selected consumer. The
Connection mapping tab divides the window into 3 sections. The Connection Settings are
performed by configuring the settings within the Connection mapping tab.
This tab displays the "OPC XML Data Access provider" and "CSV/TXT consumer" on left hand
side whereas the right hand side of window contains Connection mapping properties and
WinCC/IndustrialDataBridge
254 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
connection options. The separator between the provider and consumer section provides a
resize handle that helps you to resize the height of the section in order to view the fields
within the section clearly.
The "Connection mapping settings" section is displayed at right side of "Connection mapping"
tab. This section helps you to provide a name for connection along with options for choosing
default name for connection. The "Connect", "Modify connection", "Delete connection" and
"Delete all connections" icons are provided at the top portion of this section.
CSV/TXT consumer
The CSV/TXT consumer is displayed below the provider section and includes options for
selecting the column within CSV/TXT file. It also provides options to create new CSV/TXT file
with required columns.
In the consumer section, "Maximum entry configuration" tab is displayed next to the
"CSV/TXT consumer" tab. The "Maximum entry configuration" tab provides the required fields
for archive file name generation.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 255
WinCC/IndustrialDataBridge Documentation
4.3 Modules
The "CSV/TXT consumer" tab displays the "CSV/TXT" and "Columns" area.
The "CSV/TXT" area includes options to select the CSV/TXT file. The corresponding column
names will be listed in the "Columns" area upon selection of this CSV, TXT file. CSV, TXT
supports only one data type "OLE/Binary Automation string (VT_BSTR)". This data type is
selected by default after the selection of respective column name within the Columns area.
Follow the steps provided below to select the CSV/TXT file and choose the required column
name that needs to be mapped:
1. Within "CSV/TXT" area, the "CSV filename" list box is provided that displays a list of CSV or TXT
files.
Click the drop down arrow of "CSV filename" field and select the appropriate CSV file.
2. If the CSV/TXT file does not exist in the list, select "New CSV file" button. The "CSV Creator"
dialog box opens thus providing options to create a new CSV file.
In the "CSV creator" dialog window, select "Add" button to create a column entry with default
name. To define a custom name for the column, enter the column name in "Column name"
field provided at top portion of this window. The created columns are displayed within the
"Columns" text area. The "UP" and "DOWN" buttons allows in changing the column sequence.
Note
The keyword "ID" written in capital letters should not be used for creating the first column
name of CSV file. If "ID" is given as column name for the first column, then a warning message
is displayed upon double clicking the CSV file. CSV files do not support this behavior.
WinCC/IndustrialDataBridge
256 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. Enter a file name in the "Filename" text box followed by file extension and select "Create"
button to create the CSV file. The new CSV file will be now available in the file list.
If the file that is selected within the list is of type UTF-8 format, the check box "UTF-8" will be
automatically enabled. If the file is of ANSI format, the check box remains unchecked.
4. In "CSV/TXT consumer" tab, select the CSV file that is displayed in the "CSV filename" field list
box. The "Columns" area displays the "column name" along with its associated "Data type".
5. In "Columns" area, select the column name from the list. The selected column name is
displayed in "Column for data value" field and the corresponding data type is selected and
displayed in "Data type" field.
6. To add new columns to the selected CSV file, navigate to the bottom portion of column list
and double click the row that contains the text "<Add new column>".
7. The "Column name" dialog box is displayed that allows you to enter the new column name.
Enter a name for new column and click "Create" button.
The new column will be listed within the existing list of column names. You can create any
number of columns by repeating steps 6 & 7.
8. The time stamp can be written to the specific column. In this case, select the respective
"Active" check box and select the column in "Column for timestamp" field list box as the
CSV/TXT supports only one data type "OLE/Binary Automation string (VT_BSTR).
9. The "Filter" field provides you the option to filter the Column names based on single character
or first few characters of column name.
For example, if you wish to view the column names starting with "S", type this character in
"Filter" text box. All column names starting with "S" are displayed.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 257
WinCC/IndustrialDataBridge Documentation
4.3 Modules
1. Select the check box "Archive File at Maximum Entry" and specify a value in "Max. entries" text
box.
Note
If this check box "Archive File at Maximum Entry" is unchecked, the Archive File Name
Generation and other file name selection options within this tab will be in disable state.
Note
• By default, the "Max. entries" field displays the value as 0. However, this value can be
modified.
• It is important to ensure that "Max. entries" field should not be left blank.
• If "Max. entries" is set to a value less than zero or negative value entered or if the field is
blank, an error message "Value should be greater than or equal to zero" is displayed.
• The maximum value for Max. entries in CSV/TXT is 2147483647. Any value entered above
this range will not be accepted and displays an error message as "Type conversion failed".
2. In "Archive File Name Generation" area, options are provided for file name generation with
respect to the archive file. Select any one of the following options by selecting the radio
button.
– Use current date and time
– Use current date and serial number
– Use serial number
3. Next, specify the Archive path in the text box provided. You can either enter the complete
folder path in the text box or select the path using "[...]" button. If you provide the path in
"Archive path" text box, archived CSV files are generated at this path. By default, this text box
has the same path where the base CSV file is present.
WinCC/IndustrialDataBridge
258 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
4. The "Use Dedicated file name" check box allows to specify a dedicated file name in
combination with a serial number & date or date & time or serial number. If this checkbox is
unchecked, then the base CSV filename will be used for archiving.
5. The "Select filename type" field provides options to select custom file name.
– To use custom file name, select filename type as "Use custom filename" and enter the
custom file name in "Custom file name" text box.
Note
Serial number
A range of 1 - 999999999 is supported for the serial number. During runtime, if the serial
number exceeds this maximum value, a trace log will be automatically created when this value
is reached. Once this upper limit is reached, IDB will not create any new archive file. The same
file will be updated continuously during data transfer.
Connection Mapping
To establish connection between the provider and consumer, column mapping is required
between the provider and consumer types. The Connection window displays "Default
connection name" options in order to specify a name for default connection. "Connect",
"Modify connection", "Delete connection" and "Delete all connections" icons are provided
below the "Default connection name" section area. These buttons help in order to work with
the connections.
Note
Modify connection
To modify an existing connection, perform the required changes and then select "Modify
connection" button. The changes can be observed within the Connection window only after
selecting the "Modify" button.
Follow these steps to perform column mapping between provider and consumer:
1. In "OPC XML Data Access provider", select a tag name from the list that is displayed within
the "OPC XML Data Access tag browser". Upon selection of the tag within tag browser, the tag
name is displayed in "Tag" field. The data type is selected automatically based on selection of
this tag.
2. If the selected tag has Array data type, then the "Array" check box is automatically enabled.
This check box is provided below the "Data type" field.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 259
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. Next, choose the column name from "CSV/TXT consumer" column that needs to be mapped
and click "Connect" button.
Note
Data type conversion
If the provider tag data type does not match with consumer column, IDB CS converts the
provider data type to match with data type of consumer. A status window is displayed to
indicate this change.
4. Repeat steps 1 - 3 for all elements of the data provider that you wish to transfer. A connection
is created for each of the column values existing between provider and consumer.
5. The connection name including the provider and consumer data values will be displayed
within the "Connection mapping settings" section.
6. The list of connections will be also displayed within the Connections tab as well as in the
project tree within the "Connections" node belonging to the specific link.
Note
Array
If the OPC XML Data Access provider tag has a data type of type "Array" and if the CSV/TXT
consumer column has data type other than array data type, after clicking on the Connect buton,
the "Array" check box in the "OPC XML Data Access provider" is automatically unchecked.
Results
The connections that you have created are shown in the "Connections" tab of IDB "Settings"
window as well as within the project tree node.
Objective
To create a project with corresponding link having OPC XML as consumer and configure the
respective provider/consumer configuration along with transfer behavior settings.
WinCC/IndustrialDataBridge
260 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Creating a link
1. Open IDB Configuration and create a project by following the steps mentioned below:
– In IDB Configuration menu bar, select "Project" > "New project" to create a new project.
– In the "Create new project" dialog box, specify a project name, click [...] button and select
the folder location wherever the project needs to be saved.
– After entering the required information, select "Create" button. This creates a new project.
2. The project name will be listed within the "Project tree". The next step is to create a link.
Follow the steps mentioned below to create a link between provider and consumer:
– Right click on project name node in the tree structure and select "Add new link" option or
else double click the "Add new link" node below the project name node within project tree.
– In the "Add new link" dialog that is displayed, enter a unique link name.
– Select the provider type as OPC Data Access, consumer type as OPC XML and click OK
button.
– The created link will be displayed below the project name in project tree.
– The corresponding entries - Provider, Consumer, Settings and Connections are created as
nodes that exist below the new link in the tree structure.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 261
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. In project tree, open the Provider configuration window by double clicking the Provider node.
In Provider configuration window, perform the following settings:
– Browse for OPC Server by clicking the [...] button and select OPC Server from the list.
The selection of the server is supported by an OPC Server browser. The browser displays
the local OPC Servers as well as OPC Servers in the network.
– The node name is simultaneously displayed in "Node name" text box after selection of the
OPC Server.
Note
Node name
For local OPC Server, the node name will display as "local host". In case of remote OPC
Server, the remote computer name will be displayed after selection of OPC Server on the
remote computer. This node name is required for searching the OPC Server from the
remote computer.
The OPC Server browser does not display any content if you enter an invalid node name
in the "Node name" text box.
Note
The "OPC Server" and "Node name" fields are provided as editable fields. If the information
about OPC Server name and node name is known, you can directly enter the information
in the "OPC Server" and "Node name" fields. If the node name / OPC Server name is invalid,
there will be no content displayed within the OPC tag browser.
4. Next, double click the Consumer node in project tree. In Consumer configuration window,
perform the following settings:
WinCC/IndustrialDataBridge
262 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
https connection
For enhanced security purposes, it is recommended to use https connection while
configuring OPC XML Data Access consumer.
"Configuration for bad quality item" section
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 263
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– In the "Configure a Variable number of transaction errors" field, click on [...] button and
select a tag in OPC tag browser.
The OPC tag browser will be displayed as shown in the image given below:
– Choose the specific data type by selecting from the drop down list box.
Note
OPC tags
Selection of the tag in OPC tag browser displays the corresponding data type in "Data type"
field. However, if you know the tag name, enter the tag name in "Configure a Variable for
number of transaction errors" field and select the data type in "Data type" field by selecting
from the list.
"Asynchronous transfer configuration" section
– Enable the check box option "Write asynchronous" for asynchronous writing.
– Enter the permitted number of maximum outstanding write transactions in the text box.
Note
Asynchronous transfer
If the "Write asynchronous" check box is enabled, a default value of 10 is set and will be
displayed within the "Maximum number of outstanding write transaction" text box. When
this check box is disabled, the value will be reset to 0. You can type a value in this text box
ranging from 1 - 40. If the value entered in this text box is not within the range, then an error
message is displayed.
Note
Asynchronous writing
The Asynchronous transfer configuration is useful to ensure the correctness of the actual
data transfer that is happening.
Example: If you have configured the "Maximum number of outstanding write transaction" as
15 and if the data transfer is not happening correctly, after the failure of 15th transaction, a
warning message will be displayed in the IDB Runtime Trace view.
WinCC/IndustrialDataBridge
264 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. Enter a time period in the "Update rate" field after which the system checks for whether data
is to be transferred.
Note
Update rate
For better performance, it is recommended to use an update rate of 1000 ms or 1 sec.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 265
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Deadband
All OPC Servers do not support deadband. This is dependent on the OPC Server being
used. The "Deadband value (%)" text box is enabled only with the data transfer types -
"Send only changed values" and "Send always all values". This text box is disabled while
you select the transfer type "Send values using trigger".
5. Enter the deadband value (in percent) to contain a value within the range 0 - 100.
6. In "Tag for Transaction Security" field, click [...] button and select a tag of OPC Server from the
OPC tag browser.
You can define an OPC item on an OPC server, in which the success-/failure-status of the data
transfer will be stored in the "Tag for transaction security" field. This value should have 1 byte
signed char (e.g. VT_I1). "-1" indicates the success state and "0" indicates failure.
7. If you have selected the option "Send values using trigger", you can configure the trigger that
provides options to set the trigger options. The Trigger section is enabled only with the data
transfer type "Send values using trigger".
Perform the following settings in the "Configure Trigger" section:
– In "Trigger tag" text box, select the tag that should trigger a data transfer. Click on [...] to
select the tag from OPC tag browser.
– Select a valid data type by selecting from the drop down list.
– Enter a threshold at which a data transfer should be triggered, in the "Trigger value" field.
– In "Confirmation value" field, enter a value that the trigger tag should take on after
triggering.
The confirmation value does not give any information on whether a transaction has been
completed successfully.
8. The transfer behavior settings for OPC Data Access as provider will be saved automatically.
WinCC/IndustrialDataBridge
266 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Saving changes
A save operation is not required every time whenever changes are performed within the editor
window in the work area. The changes made to these settings are automatically saved. However,
once the project is created, at any point of time, you can save the project by selecting the
"Project" > "Save" menu option.
Results
You have created a connection between the provider and OPC XML as a consumer. These
elements are displayed in the tree structure of the IDB configuration interface. In order to
transfer data, connect the provider and consumer tags, as described in chapter "Connecting Tags
to the OPC XML Interface (Page 267)".
Connecting tags
In "Settings" window, the "Connection mapping" tab includes the required fields to connect tags
that have been sent from selected provider to OPC XML Data Access consumer. The Connection
Settings are performed by configuring the settings within the Connection mapping tab. The
Connection mapping tab divides the window into 3 sections.
• OPC Data Access provider
• OPC XML Data Access consumer
• Connection mapping properties
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 267
WinCC/IndustrialDataBridge Documentation
4.3 Modules
The "OPC Data Access provider" section is displayed at top left portion of "Connection
mapping" tab. This section lists the tags that can be mapped with the tags existing within
"OPC XML Data Access consumer". The "OPC XML Data Access consumer" section is displayed
at bottom left portion of "Connection mapping" tab. This section provides you with required
options to choose the tag name from the list of OPC tags to be mapped.
The separator between the provider and consumer section provides a resize handle that
helps you to resize the height of the section in order to view the fields within the section
clearly.
The "Connection mapping settings" section is displayed at right side of "Connection mapping"
tab. This section helps you to provide a name for connection along with options for choosing
default name for connection. The "Connect", "Modify connection" and "Delete connection"
icons are provided at the top portion of this section.
1. In "OPC Data Access provider" section, select the tag name from the list that is displayed
within "OPC tag browser".
Upon selection of the tag within OPC tag browser, the tag name is displayed in "Tag" field. The
data type is selected automatically based on selection of the tag.
2. If the selected tag has Array data type, then the "Array" check box is automatically enabled.
This check box is provided below the "Data type" field.
WinCC/IndustrialDataBridge
268 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. Next, configure the tag in the "OPC XML Data Access consumer" section by following these
steps:
– Select the tag name from the list that is displayed within "OPC tag browser". Upon
selection of the tag within OPC tag browser, the tag name is displayed in "Tag" field. The
data type is selected automatically based on selection of this tag.
– If the selected tag has Array data type, then the "Array" check box is automatically
enabled. This check box is provided below the "Data type" field.
4. Check the name of the connection in the "Connection mapping settings" area to the right.
Enter a unique name for the connection in the "Connection name" field or use the options
within "Default name options". Click "Connect" button to confirm your entries.
The connection name including the provider and consumer data values will be displayed
within the "Connection mapping settings" section.The list of connections will be also
displayed within the Connections tab as well as in the project tree within the "Connections"
node belonging to the specific link.
Note
Data type conversion
If the provider tag data type does not match with consumer column, IDB CS converts the
provider data type to match with data type of consumer. A status window is displayed to
indicate this change.
5. Repeat steps 1 to 4 for all elements of the "OPC Data Access provider" interface that you wish
to transfer.
6. The connection name including the provider and consumer data values will be displayed
within the "Connection mapping settings" section.The list of connections will be also
displayed within the Connections tab as well as in the project tree within the "Connections"
node belonging to the specific link.
Note
Array
If the OPC Data Access provider column has a data type other than array data type and if the OPC
XML Data Access consumer tag has data type of type "Array", after clicking on the Connect
buton, the "Array" check box in the "OPC XML Data Access consumer" is automatically checked.
Results
The connections that you have created are shown in the "Connections" tab of IDB "Settings"
window as well as within the project tree node.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 269
WinCC/IndustrialDataBridge Documentation
4.3 Modules
4.3.5.1 Overview
Introduction
The WinCC OLEDB Provider enables access to the archive data from WinCC. You can select
message archives or process value archives with this archive data.
,'%
:LQ&& 3URYLGHU &RQVXPHU
3URFHVVYDOXH
$ODUPORJ
GDWD :LQ&& ,'% 'DWD
2/('% GDWD &RQVXPHU &RQVXPHU
For the "Cyclic and continuous" transfer, the transfer time is set with a timer. This enables an
hours transfer to be started for instance. The time period is defined using the last two timer
times.
In mode "Triggered and continuous", the transfer time is defined using a trigger condition
with OPC tags. The time period is defined using the last two trigger times. The IDB marks the
last transfer time and reads the interval between two trigger times.
With transfer method "Triggered time period", the transfer time is defined using a trigger
condition with OPC tags. The time period, which is read from the WinCC archive, is defined
using two other OPC tags.
(*) The continuous data transfer can be continued on with a stop of the IndustrialDataBridge.
The IDB saves the time of the last transfer so that even after a restart, a continuous transfer
can be completed without doubled or missing data.
This functionality is only supported if the configuration file is not changed or another file is
loaded.
The start-up behavior for the initial start of a configuration must be defined.
WinCC/IndustrialDataBridge
270 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Adjustment between Summer and Winter Time
• For all data that is to be transferred, a check is performed to determine whether Winter time
or Summer time is concerned and is considered accordingly in the conversion.
• For time definitions that are defined precisely in the hour of the adjustment, doubled data
records can occur in the data consumer.
No data records will be lost.
• In order to maintain the correct behavior of the IDB as of version V7.2, set the time zone to
UTC. GMT is only to be set the same as UTC time in Winter. During summer time, there is a
difference of 1 hour.
4.3.5.2 Requirements
Prerequisites in WinCC
• In order for the WinCC OLEDB Provider of the IndustrialDataBridge to access WinCC, the
ConnectivityPack client (WinCC OLE DB driver) has to be installed. Without this client, the
database interface is not available.
• For configuring WinCC OLEDB provider configuration, the WinCC project XML file exported
from the current WinCC configuration must be available.
If WinCC runs on another computer, you will have to install IDB separately so that the project
XML export will be available. The "Project XML Export" command is located in the pop-up
menu of the IndustrialDataBridge of the WinCC Explorer.
• If the WinCC Runtime is not in RUN status, the browse interface of the OPC server (OPC tag
browser) is not available. Switch the WinCC into RUN status.
• Microsoft Message Queing Service must be installed. To do this, you will need the Windows
installation CD. You can find detailed information on how to install MS Message Queing
service in WinCC V8.0 Installation / Release Notes > WinCC Installation Instructions >
Installing WinCC > How to Install MS Message Queuing.
Note
Time:
If the clock on the IndustrialDataBridge computer is advanced, the interval will not be completely
covered. This circumstance may result in an incomplete transfer of data.
Synchronize the computer clocks.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 271
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Access to WinCC OLE DB from another PC in a Workgroup:
The client and server computers require users with the same access rights, since otherwise a
WinCC OLE DB access is not possible.
Prerequisites for Single Point of System Access to Process Data Archives from a connectivity
station
In order for you to set up "Single Point of System Access" (connectivity station), you require the
Connectivity station name and symbolic computer name (server prefix) of the computer that is
acting as connectivity station. Simatic PCS7 and WinCC needs to be installed to use the computer
as connectivity station.
Note
PCS7
The "OpenPCS7" software option needs to be selected while installing PCS7. For more
information about installing PCS7 or creating projects, please refer "PCS7 manual".
Note
WinCC Project XML file
The WinCC Project XML file has to be exported from the connectivity station. To use Single Point
of System Access (connectivity station), the XML file that supports "Single Point of System
Access" has to be used. The corresponding connectivity station name is automatically displayed
in WinCC OLEDB provider configuration if you are using a valid XML file that supports "Single
Point of System Access". If the XML file used is not a valid one, then the connectivity station name
will not be listed.
If the WinCC project has been changed, you must execute the "Project XML Export" command
on the Engineering Station. In WinCC OLEDB provider configuration, you need to select the
modified XML file again. Transfer the data onto the connectivity station again.
WinCC/IndustrialDataBridge
272 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
WinCC Project XML file
The WinCC Project XML file has to be exported from the WinCC station (the computer that has
WinCC installed). A valid XML file that is exported from the WinCC station needs to be used in
WinCC OLEDB provider configuration. If you are using a valid XML file, then the corresponding
WinCC station name is displayed.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 273
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Changed WinCC Project Configuration
If the WinCC project has been changed, you must execute the "Project XML Export" command
again and check the IDB configuration and modify it if necessary.
Objective
To create a project with corresponding link having WinCC OLE DB as provider and configure the
respective provider/consumer properties along with transfer behaviour settings
WinCC/IndustrialDataBridge
274 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Creating a link
1. Open IDB Configuration and create a project by following the steps mentioned below:
– In IDB Configuration menu bar, select "Project" > "New project" to create a new project.
– In the "Create new project" dialog box, specify a project name, click [...] button and select
the folder location wherever the project needs to be saved.
– After entering the required information, select "Create" button. This creates a new project.
2. The project name will be listed within the "Project tree". The next step is to create a link.
Follow the steps mentioned below to create a link between provider and consumer:
– Right click on project name node in the tree structure and select "Add new link" option or
else double click the "Add new link" node below the project name node within project tree.
– In the "Add new link" dialog that is displayed, enter a unique link name.
– Select the provider type as WinCC OLEDB, consumer type as Database and click OK button.
– The created link will be displayed below the project name in project tree.
– The corresponding entries - Provider, Consumer, Settings and Connections are created as
nodes that exist below the new link in the tree structure.
3. In project tree, open the Provider configuration window by double clicking the Provider node.
In Provider configuration window, click on [...] button and select the WinCC project XML file
that you have exported from WinCC.
Note
WinCC project XML export file
While selecting the WinCC project XML export file, please remember to choose the
appropriate WinCC project XML file. To use "Single point of system access", (SPOSA) choose
the XML file that supports "Single point of system access".
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 275
WinCC/IndustrialDataBridge Documentation
4.3 Modules
4. For IDB CS to be used on a WinCC station, ensure that you do not mark the "Use Single point
of system access" for selection.
– In "Archive configuration" section, select the WinCC station name of the selected provider.
Note
WinCC station
• The WinCC station name is listed in the drop down list box of "WinCC station name" field
that displays the station name wherever the WinCC XML file exists. Choose the WinCC
station name by selecting from list.
• The project name is automatically displayed based on the WinCC project XML file that is
selected in "WinCC project XML file" text box.
5. If IDB CS is required to be used on a Connectivity station, you can set up "Single point of
system access" to these process value archives.
– To use transparent access, enable the "Use Single point of system access" check box.
– Enter the server prefix (symbolic computer name) of connectivity station that has WinCC
installed.
Note
Connectivity Station
Select the check box "Use Single point of system access" only if IDB CS is set as a connectivity
station. The transparent access from a connectivity station can occur to process value
archives. Once this check box is selected, you can observe that the label "WinCC station
name" is changed to "Connectivity station name".
• The connectivity station is listed in the drop down list box of "Connectivity station name"
field that displays the name of connectivity station wherever the WinCC XML file exists.
Choose the connectivity station name by selecting from list.
• The project name is automatically displayed based on the WinCC project XML file that is
selected in "WinCC project XML file" text box.
WinCC/IndustrialDataBridge
276 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
6. Next, double click the Consumer node in project tree to open the consumer configuration
window.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 277
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– In "Database" field, click on [...] button and select the database from the list or from the
folder structure.
Note
Please note the following points:
• The "Server" field text box and "Use automatic Windows authentication" check box is
in disable state if you use "Microsoft Access" as the database.
• The "Use automatic Windows authentication" check box is in disable state if you have
used any database other than "Microsoft SQL Server".
• The option to select the check box "Use automatic Windows authentication" is
provided only for "Microsoft SQL Server" database.
• If you use "Oracle" as the database, it is important to note that the "Database" field list
box will be in disable state.
– If a user name and password has been set for the database, enter the user name and
password in the "User name" and "Password" fields respectively.
If you wish to set a blank password, enable the check box "Blank password". To save the
entered password, enable the check box "Allow saving password".
– Click Test button to test the connection. The application tests the database connection
string and verifies the selected database.
"Consumer type configuration" section
– Select the "Consumer type" by selecting from the list. More information about the
consumer types are provided in chapter "Consumer Types".
– Choose the "Transaction type" - Stored procedure or Prepared insert statement and select
Table name and Schema.
Note
Transaction type
The Stored procedure or Prepared insert statement transaction type options are in enable
state only when the consumer type "One data record per call - command set" is selected
and if you have selected a database type other than Microsoft Access. By default,
the Prepared insert statement option is automatically selected.
• Only the "Table" field is enabled if Microsoft Access is selected as database type and
consumer type is selected as "One data record per call - command set". Select the table
name by clicking the drop down list box.
• If you have selected a database type other than Microsoft Access and consumer type
is selected as "One data record per call - command set", then all the fields within the
Transaction type will be in enable state.
WinCC/IndustrialDataBridge
278 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
1. In project tree, double click the Settings node to open Settings window in the work area. The
Settings window consists of 3 tabs - Transfer options, Connection Mapping & Connections.
2. Within the Transfer Options tab, you can configure the archive settings and transfer behavior
settings for provider.
3. In "Archive settings" section, choose the Archive type. In "Archive" field, select whether data
is to be transferred from 'Process value archive' or from 'Alarm message archive'. Depending
on the archive type selected, the "Process value" button and "Events" button will be shown in
disable or enable state.
4. Click on "Process value" button open the "Variable Filter" window. The "Event filter" window
can be opened by clicking on the "Events" button.
More information about configuring these filter settings is provided in "Configuration of the
transfer behavior".
5. Select the appropriate time zone in the "Time zone for consumer" field.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 279
WinCC/IndustrialDataBridge Documentation
4.3 Modules
6. In "Time settings" section, enter the cycle time and choose metric (milli seconds / seconds /
minutes / hours) by selecting the drop down list box.
7. Next, select the type of data transfer:
– Cyclic & Continuously
Here, transfer time is set with a timer. This enables an hours transfer to be started for
instance.
The time period is defined using the last two timer times.
– Triggered & Continuously
In the type, the transfer time is defined using a trigger condition with OPC tags. The time
period is defined using the last two trigger times. The IDB marks the last transfer time and
reads the interval between two trigger times.
– Triggered time span
In this type, the transfer time is defined using a trigger condition with OPC tags. The time
period, which is read from the WinCC archive, is defined using two other OPC tags.
Note
Transfer type
Based on transfer type, the buttons "Time span", "Start-up behavior" and "Trigger" will be in
enable or disable state.
• If option "Cyclic & Continuously" or "Triggered & Continuously" is selected, both the "Start-
up behavior" and "Trigger" buttons can be used.
• With option "Triggered time span", only the Timespan and Trigger buttons can be used.
Note
OPC tag browser
The OPC tag browser is displayed within the "Time span", "Start-up behavior" and "Trigger"
windows. The OPC tags will only be displayed if you have already selected the name of OPC
Server in "Trigger Provider" window.
8. Configure the "Trigger" and "Time span" or the "Start-up behavior" in the dialog window that
you open by clicking the respective button.
More information about the transfer setting capabilities and their options are provided in
chapter "Configuration of the transfer behavior".
9. The transfer behavior settings for WinCC OLEDB as provider will be saved automatically.
Note
Saving Changes
A save operation is not required every time whenever changes are performed within the editor
window in the work area. The changes made to these settings are automatically saved. However,
once the project is created, at any point of time, you can save the project by selecting the
"Project" > "Save" menu option.
WinCC/IndustrialDataBridge
280 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Results
You have configured the WinCC OLEDB interface and a consumer. These elements are displayed
in the tree structure of the configuration interface. In order to transfer data, connect the provider
and consumer tags, as described in chapter "Connecting Tags from the WinCC OLE DB Interface".
Configuration options
The Settings window provides user interface controls in form of drop down list box or buttons
or radio buttons that are used to perform "Archive type settings" and "Transfer type settings". The
configuration settings and their options existing within these dialog windows are explained
below.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 281
WinCC/IndustrialDataBridge Documentation
4.3 Modules
1. In "Archive" field, select the archive for which you wish to transfer the data by choosing from
the drop down list.
2. The "Archive variable" section displays a list of archive variables. Select one or more tags from
the list that is displayed at left hand side of the window.
3. Transfer these tags to the selection field on right side with ">" or use ">>" to transfer all tags
in the list.
Use "<" or "<<" to delete the selected or all tags from the selection field on right side.
4. Confirm this selection by clicking the "OK" button.
WinCC/IndustrialDataBridge
282 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
1. Enter a message number in the "Single Event" field text box and click "Include" button. This
will be added to the "Chosen events" list.
2. To specify a message number range, enter the start range and end range in "From" and "To"
text box. Then, click "Include" button to add this event range.
3. To exclude any event from the list, select the event within the list and click "Exclude" button.
To clear all the events displayed within the "Chosen events" field, click "Delete list" button.
4. You can select the archive language by choosing the "Archive language" field drop down list
box. This will display the archive messages in the selected language.
5. Once you have performed the changes, confirm this selection by clicking the "OK" button.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 283
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Time span
The "Time span" button is activated only if you have selected the radio button option "Triggered
time span". Click "Time span" button to open the "Time span" dialog window. The transfer time
period for selected tags is defined in this "Time span" window. The selection is controlled through
tags of the OPC Server provided within the OPC tag browser.
Note
OPC tag browser
The OPC tags within the "Time span" window will only be displayed if you have already selected
the name of OPC Server in "Trigger Provider" window.
In "Time span" window, "Define update cycle" section area, the time period can be be defined
using two different ways:
• With a Start time and an End time (using "From" and "To" selection)
• With a Start time and Time period (using "+/-" selection)
WinCC/IndustrialDataBridge
284 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Procedure
To define the transfer time period, follow these steps:
1. Select the tags that define the Start time by performing selection within the OPC tag browser.
2. Confirm the selection by clicking the "Apply" button in the "From" line. The selected tag is
added within the "From" text box.
3. Define whether you want to define an End time or a period of time by selecting the
appropriate radio button.
4. Select the tags that define End time or the time span in the OPC tag browser. The tag selection
will be added to the text box below "From" field.
5. Confirm the selection by clicking the "Apply" button in the "To" line or "+/-".
6. Click OK button after performing the required changes.
Note
Tag type
The tags that define a time span must be of the type "VT_I4 or be present as string that can be
converted into the type "VT_I4" by the OPC server. With the time span, the preceding sign
determines whether the period of time is before (-) or after (+) the start time (From).
Note
No Time Period Defined
If no transfer time period is selected within the "From" and "To" or "+/-" fields, all available data
is transferred.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 285
WinCC/IndustrialDataBridge Documentation
4.3 Modules
• Chinese; LCID="2052"
• Japanese; LCID="1041"
Additional values for LCID are available under http://www.microsoft.com (http://
www.microsoft.com) when you enter the search term "LCID".
Start-up behavior
The "Start-up behavior" button is activated if any one of the transfer types "Cyclic & continuously"
or "Triggered & continuously" is selected. To open the "Start-up behavior" dialog window, select
"Start-up behavior" button. The settings mentioned here will be used during start of the
IndustrialDataBridge Runtime.
Note
OPC tag browser
The OPC tags in "Start-up behavior" window will only be displayed if you have already selected
the name of OPC Server in "Trigger Provider" window.
WinCC/IndustrialDataBridge
286 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Procedure
To configure the behavior of first transfer, follow these steps:
1. Choose one of the listed options provided within the "Behavior of first transfer" section area.
2. If you have selected "Point in time defined by OPC tag", mark the respective tag in OPC tag
browser and click "Apply" button.
3. The selected tag is added within the "Point in time defined by OPC tag" text box.
4. Select the time zone for data transfer of OPC tags in "Time zone for data of OPC tags" drop
down list field.
5. Click "Ok" button after performing the required changes.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 287
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Tag type
The tags that define a point in time must be of the type "VT_DATE" or be present as a string that
can be converted into the type VT_DATE by the OPC Server.
Note
Transfer behavior
• If the "Transfer current archive values" option is selected, it transfers the current values
(either process values or alarm messages) from the time the data transfer has started.
• With option "Point in time defined by OPC tag" selected, the data transfer will happen from
the date defined by OPC tag (existing in text box) till current date.
Note
New or Changed Configuration File
The functionality is only supported if no new or a changed configuration file is loaded in the IDB
runtime environment.
WinCC/IndustrialDataBridge
288 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
UTC time format
Since the data will be stored in UTC time format within the database, it is strongly recommended
to follow or set the time zone to UTC time format.
Trigger
Configure the condition that triggers a data transfer for this link in the "Config. Trigger Provider"
dialog. The description for this dialog is provided in the chapter "Configuring a Trigger".
Introduction
The "Trigger Provider" dialog window provides the OPC settings, Trigger configuration options
and required fields that help you to configure the condition that triggers a data transfer. This
dialog window is opened after clicking the "Trigger" button in Transfer options window.
Note
OPC tag browser
The OPC tags within "Trigger configuration" section will only be displayed if you have already
selected the name of the OPC Server.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 289
WinCC/IndustrialDataBridge Documentation
4.3 Modules
WinCC/IndustrialDataBridge
290 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Procedure
1. In "OPC settings" area, select the OPC server by clicking on the [...] button. The selection of
the server is supported by an OPC tag browser. Next, click the button representing "tick mark"
to accept the changes.
2. The "Node name" is automatically displayed in "Node name" text box after selection of the
OPC Server.
Note
Node name
For local OPC Server, the node name will display as "local host". In case of remote OPC Server,
the remote computer name will be displayed after selection of OPC Server on the remote
computer. This "Node name" is required for searching the OPC Server from the remote
computer.
The OPC tag browser does not display any content if node name is invalid.
Note
The "OPC Server" and "Node name" fields are provided as editable fields.
If the information about OPC Server name and node name is known, you can directly enter
the information in the "OPC Server" and "Node name" fields. If the node name / OPC Server
name is invalid, there will be no content displayed within the OPC tag browser.
3. You can define an OPC tag on the trigger provider, in which the success-/failure-status of the
data transfer will be stored in the "Tag for transaction security" field. This value should have
1 byte signed char (e.g. VT_I1). -1 indicates the success state and 0 indicates failure.
Select the tag of the OPC server, in which this information is to be saved in the tag browser
and click on the "Apply item" button.
4. The tree structure of OPC server is displayed within "Trigger Configuration" area.
5. In "Trigger Configuration" area, select the desired tags individually and accept them by
clicking on "Add item" each time.
The selected tags are shown in the table below the tag browser that displays the tag list.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 291
WinCC/IndustrialDataBridge Documentation
4.3 Modules
6. Use the "Remove item" button to remove the marked item. If no item is marked for deletion,
the last item from the list is deleted if you click the "Remove item" button. Details about the
columns in the Tag list are located in section "Tag declaration".
Note
OPC Server
After selection of the tags and adding them to tag list, if you switch to another OPC Server in
OPC Settings area, a dialog window is displayed that prompts the message whether you wish
to discard previous settings.
7. In "Trigger condition" area, you can select the type of syntax with selection button "VB Style"
or JScript Style". If a trigger condition is already created, this setting can no longer be
changed. If the language is to be changed, the text in the "Configure Trigger Condition" field
must be deleted.
Details on the programming languages are located in section "Programming Languages".
8. Create the trigger condition in the selected language. Use the Alias designations in the tag
list for these tags. Within the text box displayed, enter the operator symbols using the
keyboard or select them from the "Logical patterns" list box.
9. Test the created condition by clicking on "Validate". The trigger condition is calculated with
the values that are entered in the "Test value" column. The result "TRUE" or "FALSE" is shown
in a message box.
10.If the trigger condition provides the correct result and after confirming the changes, close the
dialog by clicking on "OK" button.
Additional Information
Tag declaration
The columns for the tag declaration contain the following:
• Data type: Data type of the tag. If the data type defined here does not match that on the
server, an attempt to convert the data type is made.
• TagID: The TagID of the tag on the OPC server
• Alias: The alias is used for creating the trigger condition. This name must be unique and it
must correspond with the naming conventions of the allocated programming languages. For
more detailed information about the naming conventions, see paragraph "Valid alias names".
• Confirmation value: The confirmation value is the value that the variable takes on after
fulfilling the trigger condition and the values have been delivered to the consumer. The
default value is "<Empty>", i.e., no confirmation value is written.
• Test value: This value is only for testing the trigger condition and has no influence on the later
data exchange. The test values are to be selected and changed so that they test whether the
trigger condition delivers the expected result in all operating conditions.
WinCC/IndustrialDataBridge
292 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Confirmation value
The confirmation value does not give any information on whether a transaction has been
completed successfully.
Note
Necessity of Alias Names
The OPC TagID is not used because it may possibly not correspond with the tag validity criteria,
for instance, a "Point" in the tag name is not allowed.
Programming languages
You can use VBScript or JScript for the trigger condition.
The following table shows the operator type and their symbols in both languages:
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 293
WinCC/IndustrialDataBridge Documentation
4.3 Modules
It is recommended to use these operators only. Other operators can be found in the language
descriptions for the respective language.
Note
Loss of Trigger Events
The triggering depends on the update speed of the OPC server. In this case, note that data
changes that occur within an update cycle are not considered by the trigger. That means that a
faster change of a tag from 1 - 0 - 1 is not necessarily indicated to the trigger provider by the OPC
server, since the 1 exists at the end again and no value change exists at the check time. This
means that a potentially true condition is not recognized as being true and therefore will not lead
to a data transfer.
Configurations, with which the confirmation value is to set a "true" trigger condition to "false"
again, are not secure because of the statement above. When data changes occur too quickly, the
"true value" may stay the same or values can be left out.
Connecting Tags
In "Settings" window, the "Connection mapping" tab includes the required fields to connect tags
that have been sent from WinCC OLEDB interface with the selected data consumer. The
Connection mapping tab divides the window into 3 sections.
• WinCC OLEDB provider
• Database consumer
• Connection mapping settings
WinCC/IndustrialDataBridge
294 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
The "WinCC OLEDB provider" section is displayed at top left portion of "Connection mapping"
tab. This section provides you with required options to choose column name from the list of
columns displayed in "Columns" section area. The "Database consumer" section exists below
the provider section and lists the selected table, schema and column names that can be
mapped with the columns existing within WinCC OLEDB interface.
Note
Consumer types
The fields displayed within "Database consumer" section depends on the "Consumer type" that
you have selected in Consumer configuration window.
In this case, the consumer type "One data record per call - recordset" is used.
The separator between the provider and consumer section provides a resize handle that
helps you to resize the height of the section in order to view the fields within the section
clearly.
The "Connection mapping settings" section is displayed at right side of "Connection mapping"
tab. This section provides you the options to enter the connection name along with options
for choosing default name for connection. The "Connect", "Modify connection", "Delete
connection" and "Delete all connections" icons are provided at the top portion of this section.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 295
WinCC/IndustrialDataBridge Documentation
4.3 Modules
1. In "WinCC OLEDB provider" section, select the column name from the list that is displayed
within "Columns" section area.
2. Upon selection, the column name is displayed in "Column for data value" field. The data type
is selected automatically based on selection of column name.
3. The "Filter" field provides you the option to filter the Column names based on single character
or first few characters of column name.
For example, if you wish to view the column names starting with "S", type this character in
"Filter" text box. All column names starting with "S" are displayed.
4. Next, configure the consumer column in the "Database consumer" section by following these
steps:
– The selected table is shown in the "Table" field. Select the Schema for database if
applicable by selecting from drop down list.
– The column names are displayed within "Columns" area. If the table has columns with
Date/time data type, the time stamp can also be written to the column within the table.
In this case, select the respective "Active" check box and select the column within "Column
for timestamp" field.
5. Select the Column name in consumer that you wish to connect with "WinCC OLEDB" column
name. The data type of selected column will be automatically displayed in the "Datatype"
field.
The selected column is displayed in "Column for data value" field.
6. Check the name of the connection in the "Connection mapping settings" area to the right.
Enter a unique name for the connection in the "Connection name" field or use the options
within "Default name options". Click "Connect" button to confirm your entries.
Note
Data type conversion
If the provider tag data type does not match with consumer column, IDB CS converts the
provider data type to match with data type of consumer. A status window is displayed to
indicate this change.
7. Repeat steps 1 to 5 for all elements of the "WinCC OLEDB" that you wish to transfer.
8. The connection name including the provider and consumer data values will be displayed
within the "Connection mapping settings" section.The list of connections will be also
displayed within the Connections tab as well as in the project tree within the "Connections"
node belonging to the specific link.
Note
Schema
Microsoft Access does not support schema functionality. Hence, you can observe that the
Schema field in Database consumer is in disable state.
While using any other database as consumer, the Schema field will be in enable state.
WinCC/IndustrialDataBridge
296 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Modifying Consumer type
Once the connection(s) have been created in Connection mapping window and if you wish to
modify the Consumer type in Database consumer configuration, the IDB CS application will not
allow to change the Consumer type. To change the Consumer type, you need to delete the
connection(s) that have been already created. Close the consumer configuration window and re-
open the window from the project tree to modify the consumer type.
Note
Time delay in data transfer
Due to the value of the Time difference key in the registry (default value created during the setup
installation), a time delay of 15s occur during data transfer. You can set the value of the registry
key
'\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Siemens\IT4Industry\IndustrialDataBrid
ge\TP\TimeDiff' between 0 to 15s to avoid time delay in data transfer.
Results
The connections that you have created are shown in the "Connections" tab of IDB CS Settings
window as well as within the project tree node.
4.3.6 Database
4.3.6.1 Overview
Overview
The Database module provides read access (database as provider) and write access (database as
consumer) to a database. The following list of databases are supported:
• MS Access 2003 / 2007 / 2010 / 2013 / 2016 via "MS ACE 12.0 OLE DB Provider"
• MS SQL Server 2005 / 2008 / 2008R2 / 2012 / 2014 / 2016 via driver "MS OLE DB Provider for
SQL"
• ORACLE 8i / 10g / 11g / 12c via driver "Oracle provider for OLE DB"
• MySQL 3.5 / 5.1 / 5.5 / 5.6 / 5.7 via driver "MySQL ODBC 3.51 and 5.3 UNICODE"
Using other databases is basically possible but has not been tested and is therefore not
approved. Fault-free functionality is therefore not guaranteed. A respective test is possible
upon request.
For more information on using different databases, please read carefully the instructions
provided in the note at the end of this chapter.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 297
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Database Provider
Read access is provided to the first line of a database with the database provider. Here you can
choose the type of access:
• Send always all values (read every 1000 ms by default)
• Send values using trigger (data read only upon occurrence of the trigger value)
• Send only changed values (data transferred if a field changes in the first line)
,'%
3URYLGHU &RQVXPHU
,'% 'DWD
GDWDEDVH GDWDEDVH GDWD
&RQVXPHU &RQVXPHU
Database Consumer
A write access is provided wherein you can write data in the database consumer.
,'%
3URYLGHU &RQVXPHU
/RFDWLRQ
GDWD
'DWD ,'%
3URYLGHU GDWD GDWDEDVH GDWDEDVH
3URYLGHU
database Networking
MS Access Local and remote
MS SQL Server Local and remote
MySQL Local and remote
Oracle Local and remote
WinCC/IndustrialDataBridge
298 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Important Notes for Configuring the Different Databases
• In 64-bit operating system, IDB application requires 32-bit ODBC connector for MySQL
database.
• The version information specific to MySQL ODBC driver can be edited directly in the
"Connection string" field within provider or consumer configuration window.
• For access to an MS SQL Server and MS Access, the Microsoft Data Access Components 2.8
(MDAC 2.8) must be installed.
• To access MS Access 2013 / 2016 in 64-bit operating system, 32-bit Microsoft Access
Database Engine 2010 Redistributable / 32-bit Microsoft Access Database Engine 2010
Redistributable SP2 respectively must be installed.
• For the MS JET 4.0 OLE DB Provider with MS Access, default setting "Share Deny None" is to
be used under the extended settings for access authorizations. The selection of more than
one access authorization causes an error in the configuration environment of the
IndustrialDataBridge.
• Using data type VT_I8 as a trigger tag (values transferred upon event) in the database
provider is not approved.
• The remote access of the IndustrialDataBridge on a PC with an MS Access Database (via MS
JET 4.0 OLE DB Provider) is not approved because of reconnect problems.
• The character "?" (VT_BSTR) cannot be written in a field with field data type "char" or "varchar"
with the SQL server (in the Runtime interface, a respective error message is output).
• Since a StoredProcedure or a PreparedInsertStatement always requires all values, faults can
occur in the "Only upon change" transfer mode. In this case, this mode should not be used
in combination with StoredProcedure or PreparedInsertStatement.
• The time stamp must be assigned before connecting the first tags. Afterwards, adding or
changing is only possible if all items are deleted, the dialog is closed and reopened again. The
time stamp is generated from the local time, if new data is transferred from the provider.
• A table name is not to contain any spaces, otherwise problems can occur in the transfer.
MS Access
The following data types/field data types are supported with Microsoft Access by the IDB:
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 299
WinCC/IndustrialDataBridge Documentation
4.3 Modules
The following data types/field data types are not supported with Microsoft Access by the IDB:
The following data types/field data types are not supported with SQL Server as data target by
the IDB:
WinCC/IndustrialDataBridge
300 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Oracle
The following data types/field data types are supported with Oracle by the IDB:
MySQL
The following data types/field data types are supported with MySQL by the IDB:
Objective
To create a project with corresponding link having Database as provider and configure the
respective provider/consumer configuration along with transfer behavior settings.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 301
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Creating a link
1. Open IDB Configuration and create a project by following the steps mentioned below:
– In IDB Configuration menu, select "Project" > "New project" to create a new project.
– In the "Create new project" dialog box, specify a project name, click [...] button and select
the folder location wherever the project needs to be saved.
– After entering the required information, select "Create" button. This creates a new project.
2. The project name will be listed within the "Project tree". The next step is to create a link.
Follow the steps mentioned below to create a link between provider and consumer:
– Right click on project name node in the tree structure and select "Add new link" option or
else double click the "Add new link" node below the project name node within project tree.
– In the "Add new link" dialog that is displayed, enter a unique link name.
– Select the provider type as Database, consumer type as Database and click OK button.
– The created link will be displayed below the project name in project tree.
– The corresponding entries - Provider, Consumer, Settings and Connections are created as
nodes that exist below the new link in the tree structure.
WinCC/IndustrialDataBridge
302 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. In project tree, open the Provider configuration window by double clicking the Provider node.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 303
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– If a user name and password has been set for the database, enter the user name and
password in the "User name" and "Password" fields respectively.
If you wish to set a blank password, enable the check box "Blank password". To save the
entered password, enable the check box "Allow saving password".
– Click Test button to test the connection. The application tests the database connection
string and verifies the selected database.
WinCC/IndustrialDataBridge
304 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– If the database exists on a server location, enter the server name in "Server" field.
If you wish to enable windows authentication automatically, select the check box "Use
automatic windows authentication".
– In "Database" field, click on [...] button and select the database from the list or from the
folder structure.
Note
Server name
The "Server" field for entering the Server name, "Use automatic windows authentication"
check box and the fields for entering the logon information are enabled only if you have
selected a database other than Microsoft Access.
– If a user name and password has been set for the database, enter the user name and
password in the "User name" and "Password" fields respectively.
If you wish to set a blank password, enable the check box "Blank password". To save the
entered password, enable the check box "Allow saving password".
– Click Test button to test the connection. The application tests the database connection
string and verifies the selected database.
"Consumer type configuration" section
– Select the "Consumer type" by selecting from the list. More information about the
consumer types are provided in chapter "Consumer Types".
– Choose the "Transaction type" - Stored procedure or Prepared insert statement and select
table name and schema.
Note
Transaction type
The Stored procedure or Prepared insert statement transaction type options are in enable
state only when the consumer type "One data record per call - command set" is selected
and if you have selected a database type other than Microsoft Access. By default,
the Prepared insert statement option is automatically selected.
• Only the "Table" field is enabled if Microsoft Access is selected as database type and
consumer type is selected as "One data record per call - command set". Select the table
name by clicking the drop down list box.
• If you have selected a database type other than Microsoft Access and consumer type
is selected as "One data record per call - command set", then all the fields within the
Transaction type will be in enable state.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 305
WinCC/IndustrialDataBridge Documentation
4.3 Modules
2. Within the Transfer options tab, you can configure the transfer behavior settings for provider.
"Provider settings" section
– Select the Schema, if applicable and choose the Table name by selecting from the drop
down list.
WinCC/IndustrialDataBridge
306 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– Enter a time period in the "Update rate" field after which the system checks for whether
data is to be transferred.
Note
Schema
Microsoft Access does not support schema functionality. Hence, you can observe that the
Schema field will be in disable state if you have chosen Microsoft Access as the database
type.
Note
Table name
If you are unable to view Table name in the "Table" field, check if the Schema is selected
in "Schema" field. Without selecting the "Schema", the table name will not be displayed.
However, if you are using Microsoft Access as the database, this condition will not be
valid. If you are still unable to view the Table, please verify with the provider configuration.
Note
Update rate
For better performance, it is recommended to use an update rate of 1000 ms or 1 sec.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 307
WinCC/IndustrialDataBridge Documentation
4.3 Modules
4. If you have selected the option "Send values using trigger", you can configure the trigger. The
Trigger section is enabled only if the data transfer type "Send values using trigger" is selected.
Perform the following settings in the "Configure trigger" section:
– In the Schema field, choose a valid schema (if applicable) by selecting the drop down list.
– Choose a table name by selecting from the drop down list.
– In Column field, select the specific column that needs to be used for the trigger condition.
– Choose a valid data type by selecting from the drop down list.
– Enter a threshold at which a data transfer should be triggered, in the "Trigger value" field.
– In "Confirmation value" field, enter a value that the trigger tag should take on after
triggering.
The Confirmation value does not give any information whether a transaction has been
completed successfully.
5. The transfer behavior settings for provider will be saved automatically.
Note
Saving changes
A save operation is not required every time whenever changes are performed within the editor
window in the work area. The changes made to these settings are automatically saved. However,
once the project is created, at any point of time, you can save the project by selecting the
"Project" > "Save" menu option.
Results
You have created a connection between the database interface and a consumer. These elements
are displayed in the tree structure of the IDB configuration interface. In order to transfer data,
connect the provider and consumer tags, as described in chapter "Connecting Tags from a
Database Interface".
Overview
The "Database provider configuration" and "Database consumer configuration" windows are
displayed within the work area of IDB Configuration System. The information provided within
the provider and consumer windows are identical except for the section in Database consumer
configuration that allows for selecting the consumer type and transaction type behavior. The
provider and consumer configuration windows can be accessed by double clicking the provider
node and consumer node from project tree. The Settings window consists of "Transfer options",
"Connection mapping" and "Connections" tabs. These individual tabs includes the fields and
options required for configuring provider transfer options, creating connection(s) and
managing or viewing already created connections.
WinCC/IndustrialDataBridge
308 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Example:
German operating system / Floating-point numbers are to be saved in English format ("."
instead ",").
In this case you will have to amend the entry <Link UID="Ref-1" Name="OPC-DB2"> to <Link
UID="Ref-1" Name="OPC-DB2" LCID="1033"> in the XML configuration file.
The attribute LCID (LocalID) indicates in which number format the values will be saved.
During conversion it will be converted into the format of the operating system. For English,
the value of attribute LCID="1033", for German LCID="1031", for French it is LCID="1036",
for Italian it is LCID="1040", for Spanish it is LCID="1034", for Chinese it is LCID="2052"
and for Japanese it is LCID="1041". Additional values for LCID are available under http://
www.microsoft.com (http://www.microsoft.com) when you enter the search term "LCID".
Database connection
In provider/consumer configuration window, depending on the selected database type, the
corresponding information is displayed in the subsequent fields. The fields that do not require
any entry are shown in disable state. You may observe that the selected database type and
connection string parameters are displayed in the "Connection string" field.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 309
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Please note the following points:
• The "Server" field text box and "Use automatic Windows authentication" check box is in
disable state if you use "Microsoft Access" as the database.
• The "Use automatic Windows authentication" check box is in disable state if you have used
any database other than "Microsoft SQL Server".
• The option to select the check box "Use automatic Windows authentication" is provided only
for "Microsoft SQL Server" database.
• If you use "Oracle" as the database, it is important to note that the "Database" field list box will
be in disable state.
Microsoft Access
Note
Microsoft Access 2016
To work with Microsoft Access 2016, it is strongly recommended to install the software driver
"2010 Redistributable SP2 Office System driver: Data Connectivity Components".
If you use TCP/IP (standard) as a network library, a port number to the SQL server is also
accepted in this position, separated by a comma. The standard port is 1433. When using a
WinCC/IndustrialDataBridge
310 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Firewall and also via router connections through NAT, it may be necessary to use another
port. In this case, you must configure the SQL server for the other port.
Note
Automatic windows authentication
The "Use automatic Windows authentication" check box is in disable state if you have used
MySQL as the database type.
Note
MySQL - Stored Procedure
For inserting unicode data in MySQL stored procedure for IndustrialDataBridge, you have to
create stored procedure in MySQL as specified below:
CREATE DEFINER = 'root'@'localhost' PROCEDURE 'IDBStoredProc_MySQL1'(IN p1 smallint(6), IN
p2 smallint(11), IN p3 float, IN p4 varchar(45) charset utf8, IN p6 datetime);
Oracle
In IDB applcation, to work with Oracle 12c, you need to install Oracle client in the local computer
even though the Oracle Server edition is installed. Oracle Client for 12c (32 bit) is required to be
installed for correct working of the database in IDB applcation. This will register
'OraOLEDB.Oracle.1' provider in the local computer which will then connect to the oracle
database.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 311
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Example:
If you use the service name "testdatabase" for the connection configuration, you will find the
following entry in the "tnsnames.ora" file
Here, "testdatabase.domain.testhost.com" refers to the alias name.
#testdatabase
testdatabase.domain.testhost.com =
(DESCRIPTION=
(ADDRESS=
(PROTOCOL=tcp)
(HOST=domain.testhost.com)
(PORT=1531)
)
(CONNECT_DATA=
(SID=testdatabase)
)
)
In the section "Enter information to log on to the database", enter the user name and
password that you have entered in the Oracle Database user profile window.
WinCC/IndustrialDataBridge
312 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
The "Test" button can be used to check for whether access is granted to the database.
Note
Saving changes
A save operation is not required every time whenever changes are performed within the editor
window in the work area. The changes made to these settings are automatically saved. However,
once the project is created, at any point of time, you can save the project by selecting the
"Project" > "Save" menu option.
Connecting Tags
In "Settings" window, the "Connection mapping" tab includes the required fields to connect tags
that have been sent from the Database interface with selected consumer type. The Connection
Settings are performed by configuring the settings within the Connection mapping tab. The
Connection mapping tab divides the window into 3 sections.
• Database Provider
• Database Consumer
• Connection mapping settings
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 313
WinCC/IndustrialDataBridge Documentation
4.3 Modules
The "Database Provider" section is displayed at top left portion of "Connection mapping" tab.
This section lists the column values that can be mapped with the columns existing within
Database Consumer. The "Database Consumer" section is displayed to bottom left portion
of "Connection mapping" tab. This section provides you with required options to choose
schema, table name and column names to be mapped. The separator between the provider
and consumer section provides a resize handle that helps you to resize the height of the
section in order to view the fields within the section clearly.
The "Connection mapping settings" section is displayed at right side of "Connection mapping"
tab. This section helps you to provide a name for connection along with options for choosing
default name for connection. The "Connect", "Modify connection" and "Delete connection"
icons are provided at the top portion of this section.
Note
Consumer types
The fields displayed within "Database consumer" section depends on the "Consumer type" that
you have selected in Consumer configuration window.
In this case, the consumer type "One data record per call - recordset" is used.
1. In "Database Provider", the selected table is shown in "Table" field. Select the Schema for
database if applicable by selecting from the drop down list in "Schema" field.
2. The Column names are displayed within "Columns" area. Select a Column name from the list.
The selected column is displayed in "Column for data value" field. The data type is shown
automatically.
3. The "Filter" field provides you the option to filter the Column names based on single character
or first few characters of column name.
For example, if you wish to view the column names starting with "S", type this character in
"Filter" text box. All column names starting with "S" are displayed.
4. Configure the consumer tag in the "Database Consumer" section by following these steps:
– The selected table is shown in the "Table" field. The schema (if selected at consumer
configuration) is displayed in the "Schema" field. Microsoft Access does not support the
Schema functionality.
– The column names are displayed within "Columns" area. If the table has columns with
respective data types, the time stamp can also be written to the table. In this case, select
the respective "Active" check box and select the column within "Column for timestamp"
field.
5. Select the Column name that you wish to connect with "Database Provider". The selected
column is displayed in "Column for data value" field.
Note
Data type conversion
If the provider tag data type does not match with consumer column, IDB CS converts the data
type to match with data type of provider tag. A status window is displayed to indicate this
change.
WinCC/IndustrialDataBridge
314 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
6. Check the name of the connection in the "Connection mapping settings" area to the right.
Enter a unique name for the connection in the "Connection name" field or use the options
within "Default name options". Click "Connect" button to confirm your entries.
7. Repeat steps 1 to 5 for all elements of the "Database Provider" that you wish to transfer.
8. The connection name including the provider and consumer data values will be displayed
within the "Connection mapping settings" section.The list of connections will be also
displayed within the Connections tab as well as in the project tree within the "Connections"
node belonging to the specific link.
Note
BLOB as new data type
The BLOB data type is applicable when you are using Send/Receive as provider or consumer and
is applicable for database other than Microsoft Access. The BLOB data type will be listed in the
connecting mapping tab within the consumer section area for MySQL or Oracle or SQL Server.
You can select the BLOB data type in provider/consumer section area within the Data type field.
However, the size of data needs to be mentioned in Number field. It can be mapped with
Character array or string field of PLC data. The size of data depends on supported size provided
by Step7 project.
Maximum 1000 bytes of character with unicode support can be transferred for a BLOB field in
Oracle.
Note
Schema
Microsoft Access does not support schema functionality. Hence, you can observe that the
Schema field in Database consumer is in disable state.
While using any other database as consumer, the Schema field will be in enable state.
Note
Modifying Consumer type
Once the connection(s) have been created in Connection mapping window and if you wish to
modify the Consumer type in Database consumer configuration, the IDB CS application will not
allow to change the Consumer type. To change the Consumer type, you need to delete the
connection(s) that have been already created. Close the consumer configuration window and re-
open the window from the project tree to modify the consumer type.
Results
The connections that you have created are shown in the "Connections" tab of IDB CS Settings
window as well as within the project tree node.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 315
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Objective
To create a project with corresponding link having Database as consumer and configure the
respective provider/consumer configuration along with transfer behaviour settings.
Creating a link
1. Open IDB Configuration and create a project by following the steps mentioned below:
– In IDB Configuration menu, select "Project" > "New project" to create a new project.
– In the "Create new project" dialog box, specify a project name, click [...] button and select
the folder location wherever the project needs to be saved.
– After entering the required information, select "Create" button. This creates a new project.
2. The project name will be listed within the "Project tree". The next step is to create a link.
Follow the steps mentioned below to create a link between provider and consumer:
– Right click on project name node in the tree structure and select "Add new link" option or
else double click the "Add new link" node below the project name node within project tree.
– In the "Add new link" dialog that is displayed, enter a unique link name.
– Select the provider type as Database, consumer type as Database and click OK button.
– The created link will be displayed below the project name in project tree.
– The corresponding entries - Provider, Consumer, Settings and Connections are created as
nodes that exist below the new link in the tree structure.
WinCC/IndustrialDataBridge
316 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. In project tree, open the Provider configuration window by double clicking the Provider node.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 317
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– If a user name and password has been set for the database, enter the user name and
password in the "User name" and "Password" fields respectively.
If you wish to set a blank password, enable the check box "Blank password". To save the
entered password, enable the check box "Allow saving password".
– Click Test button to test the connection. The application tests the database connection
string and verifies the selected database.
WinCC/IndustrialDataBridge
318 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– If the database exists on a server location, enter the server name in "Server" field.
If you wish to enable windows authentication automatically, select the check box "Use
automatic windows authentication".
– In "Database" field, click on [...] button and select the database from the list or from the
folder structure.
Note
Server name
The "Server" field for entering the Server name, "Use automatic windows authentication"
check box and the fields for entering the logon information are enabled only if you have
selected a database other than Microsoft Access.
– If a user name and password has been set for the database, enter the user name and
password in the "User name" and "Password" fields respectively.
If you wish to set a blank password, enable the check box "Blank password". To save the
entered password, enable the check box "Allow saving password".
– Click Test button to test the connection. The application tests the database connection
string and verifies the selected database.
"Consumer type configuration" section
– Select the "Consumer type" by selecting from the list. More information about the
consumer types are provided in chapter "Consumer Types".
– Choose the "Transaction type" - Stored procedure or Prepared insert statement and select
table name and schema.
Note
Transaction type
The Stored procedure or Prepared insert statement transaction type options are in enable
state only when the consumer type "One data record per call - command set" is selected
and if you have selected a database type other than Microsoft Access. By default,
the Prepared insert statement option is automatically selected.
• Only the "Table" field is enabled if Microsoft Access is selected as database type and
consumer type is selected as "One data record per call - command set". Select the table
name by clicking the drop down list box.
• If you have selected a database type other than Microsoft Access and consumer type
is selected as "One data record per call - command set", then all the fields within the
Transaction type will be in enable state.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 319
WinCC/IndustrialDataBridge Documentation
4.3 Modules
2. Within the Transfer options tab, you can configure the transfer behavior settings for provider.
"Provider settings" section
– Select the Schema, if applicable and choose the Table name by selecting from the drop
down list.
WinCC/IndustrialDataBridge
320 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– Enter a time period in the "Update rate" field after which the system checks for whether
data is to be transferred.
Note
Schema
Microsoft Access does not support schema functionality. Hence, you can observe that the
Schema field will be in disable state if you have chosen Microsoft Access as the database
type.
Note
Table name
If you are unable to view Table name in the "Table" field, check if the Schema is selected
in "Schema" field. Without selecting the "Schema", the table name will not be displayed.
However, if you are using Microsoft Access as the database, this condition will not be
valid. If you are still unable to view the Table, please verify with the provider configuration.
Note
Update rate
For better performance, it is recommended to use an update rate of 1000 ms or 1 sec.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 321
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Saving changes
A save operation is not required every time whenever changes are performed within the editor
window in the work area. The changes made to these settings are automatically saved. However,
once the project is created, at any point of time, you can save the project by selecting the
"Project" > "Save" menu option.
Results
You have created a connection between the database interface and a provider. These elements
are displayed in the tree structure of the IDB configuration interface. In order to transfer data,
connect the provider and consumer tags, as described in chapter "Connecting Tags to a Database
Interface".
Overview
If you have selected database as a data consumer, define the type of write access in the
"Consumer type" field. The following types are available:
• One data record per tag
• One data record per call - recordset
• One data record per call - command set
WinCC/IndustrialDataBridge
322 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
In this example, there are three index tables created, the name of which exists in the data
tables:
• TablePlant (contains the building designations)
• TableMachine (contains the machine list)
• TableSensor (contains a list of sensors)
If a data record is entered in one of the data tables (TableBYTE, TableFLOAT, TableINT), the
data can be assigned in the index tables by linking the respective entries. If for example, the
following data record is written in table TableINT, the indexing connects every index entry
with a value of the corresponding index table:
IndexPlant: 1
IndexMachine: 3
IndexSensor: 5
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 323
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Value: 34
In this example, the index entries stand for the following values:
IndexPlant: 1 corresponds with Hall A
IndexMachine: 3 corresponds with the steel press
IndexSensor: 5 corresponds with the sensor for outside temperature
Value: 34
This means that the value 34 was measured on sensor "Outside temperature" on the steel
press in Hall A.
More detailed information on index-based database programming is located in the Microsoft
Help for Access
WinCC/IndustrialDataBridge
324 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
The "Index values" section lists 3 rows containing "Index column" and "Index" fields. Initially,
these fields will be in disable state. Enable the "Active" check box and select the desired
column that has a foreign key relationship to a column (primary key) of another table. Select
the desired index value in "Index" field. Please note that the Index column selected should not
be defined as a primary key. To realise this scenario, let us understand with the help of an
example.
Note
Prerequisites
Before performing the selection of "Index column" and "Index" value, it is important to ensure
that the following prerequisites are satisfied:
• The consumer table selected should contain a column that has foreign key relationship with
a column of another table that acts as a primary key.
• The column that requires to have foreign key relation should not have any primary key
assigned to it.
• The table that is selected in "Table" field of consumer area within connection mapping tab
should contain at least one foreign key relationship.
Example: Create 2 tables "Table 1" and "Table 2". "Table 1" contains column "ID" that is defined
as a primary key. The column "ID" is linked to a column "FKey" belonging to "Table 2". The
column "FKey" has a foreign key relation with column "ID" belonging to "Table 1".
The "Data values" section displays the "Column for data value" field and can be selected by
using the drop down list arrow. Upon selection of this field, the corresponding data type is
displayed in the "Data type" field. This column name is used to further map with the column
existing in provider area of "Connection mapping" tab.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 325
WinCC/IndustrialDataBridge Documentation
4.3 Modules
When the database consumer is configured with consumer type "One data record per call -
recordset", the corresponding fields within "Database consumer" area of Connection mapping
tab will be displayed as shown below:
Note
Transaction type
With the selection of consumer type "One data record per call - command set", the fields within
the "Transaction type" section area (in database consumer configuration) are enabled. The
options for selecting "Stored procedure" or "Prepared insert statement" and the "Table" /
"Schema" fields are enabled only if you have choosen a database type other than Microsoft
Access.
Note
Stored Procedure / Prepared insert statement
Depending on the selected database type, you can select "Stored procedure" or "Prepared insert
statement" in the "Transaction type" field within Database consumer configuration. Enter the
name of Stored Procedure or select the Table containing the Prepared insert statement in the
"Table" field. Define a filter that limits the number of displayed tables in the "Schema" field.
Please note that Microsoft Access does not support the Schema functionality.
WinCC/IndustrialDataBridge
326 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
When the database consumer is configured with consumer type "One data record per call
- commandset", the corresponding fields within "Database consumer" area of Connection
mapping tab will be displayed as shown below:
The "Data values" section lists the table name and schema (if applicable). The list of column
names are displayed in "Column selection" section. Selection of any of the column names
from the list within "Column selection" section will display the corresponding column name
and data type in "Data values" section within "Column for data value" and "Data type" fields
respectively.
• The "Character maximum length" displays the length of character variable.
The Character maximum length for String data type should contain a value that is greater
than 0.
• The "Parameter number" field lists a unique number for the specific parameter.
• The "Numeric precision" field displays the maximum number of digits in a number.
• The "Numeric scale" field displays the number of digits to the right of decimal point in a
number.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 327
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Transaction Type
With SQL databases, data is entered in the database with SQL instructions. Quite often, these
instructions are integrated right in the program, often because of lacking awareness concerning
the advantages of Stored Procedures or Prepared Statements.
Stored Procedures
The use of Stored Procedures utilizes the advantage of compiled SQL codes and increases the
performance of the operating programs:
With direct SQL Statement processing, these must be decompressed, compiled and executed
by the SQL server. This routine is repeated each time the statement is called upon.
By using a Stored Procedure, the statement is handed over in compiled format and
is temporarily stored in the so-called Procedure Cache. This prevents the continuous
recompilation and greatly increases the performance of the process.
Note
Permissions
For working with stored procedure, "execute" permission is required.
Note
MySQL - Stored Procedure
For inserting unicode data in MySQL stored procedure for IndustrialDataBridge, you have to
create stored procedure in MySQL as specified below:
CREATE DEFINER = 'root'@'localhost' PROCEDURE 'IDBStoredProc_MySQL1'(IN p1 smallint(6), IN
p2 smallint(11), IN p3 float, IN p4 varchar(45) charset utf8, IN p6 datetime);
With long data transfers use "Stored Procedures". To have frequent connection switching, use
"Prepared Insert Statements".
WinCC/IndustrialDataBridge
328 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Connecting Tags
In "Settings" window, the "Connection mapping" tab includes the required fields to connect tags
that have been sent from the provider type with database interface. The Connection Settings are
performed by configuring the settings within the Connection mapping tab. The Connection
mapping tab divides the window into 3 sections.
• Database Provider
• Database Consumer
• Connection mapping settings
Note
Consumer types
The fields displayed within "Database consumer" section depends on the "Consumer type" that
you have selected in Consumer configuration window.
In this case, the consumer type "One data record per call - recordset" is used.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 329
WinCC/IndustrialDataBridge Documentation
4.3 Modules
1. In "Database Provider", the selected table is shown in "Table" field. Select the Schema for
database if applicable by selecting from the drop down list in "Schema" field.
2. The Column names are displayed within "Columns" area. Select a Column name from the list.
The selected column is displayed in "Column for data value" field. The data type is shown
automatically.
3. The "Filter" field provides you the option to filter the Column names based on single character
or first few characters of column name.
For example, if you wish to view the column names starting with "S", type this character in
"Filter" text box. All column names starting with "S" are displayed.
4. Configure the consumer tag in the "Database Consumer" section by following these steps:
– The selected table is shown in the "Table" field. The schema (if selected at consumer
configuration) is displayed in the "Schema" field. Microsoft Access does not support the
Schema functionality.
– The column names are displayed within "Columns" area. If the table has columns with
respective data types, the time stamp can also be written to the table. In this case, select
the respective "Active" check box and select the column within "Column for timestamp"
field.
5. Select the Column name that you wish to connect with "Database Provider". The selected
column is displayed in "Column for data value" field.
Note
Data type conversion
If the provider tag data type does not match with consumer column, IDB CS converts the data
type to match with data type of provider tag. A status window is displayed to indicate this
change.
6. Check the name of the connection in the "Connection mapping settings" area to the right.
Enter a unique name for the connection in the "Connection name" field or use the options
within "Default name options". Click "Connect" button to confirm your entries.
7. Repeat steps 1 to 5 for all elements of the "Database Provider" that you wish to transfer.
8. The connection name including the provider and consumer data values will be displayed
within the "Connection mapping settings" section.The list of connections will be also
displayed within the Connections tab as well as in the project tree within the "Connections"
node belonging to the specific link.
WinCC/IndustrialDataBridge
330 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
BLOB as new data type
The BLOB data type is applicable when you are using Send/Receive as provider or consumer and
is applicable for database other than Microsoft Access. The BLOB data type will be listed in the
connecting mapping tab within the provider section area for MySQL or Oracle or SQL Server. You
can select the BLOB data type in provider/consumer section area within the Data type field.
However, the size of data needs to be mentioned in Number field. It can be mapped with
Character array or string field of PLC data. The size of data depends on supported size provided
by Step7 project.
Maximum 1000 bytes of character with unicode support can be transferred for a BLOB field in
Oracle.
Note
The transaction type "Prepared insert statement" and "Stored procedure" is not supported for
BLOB data.
Note
Modifying Consumer type
Once the connection(s) have been created in Connection mapping window and if you wish to
modify the Consumer type in Database consumer configuration, the IDB CS application will not
allow to change the Consumer type. To change the Consumer type, you need to delete the
connection(s) that have been already created. Close the consumer configuration window and re-
open the window from the project tree to modify the consumer type.
The display changes depending on the selected consumer type in Transfer options tab:
• One data record per tag
• One data record per call - recordset
• One data record per call - command set
Note
Additional information about consumer types
The description of each of the sections contained within these consumer types (including the
images) are explained in Chapter 3.6.7 "Consumer Types" (Page 322).
The steps to be followed while using specific consumer type is described in more detail below:
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 331
WinCC/IndustrialDataBridge Documentation
4.3 Modules
WinCC/IndustrialDataBridge
332 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
4. Check the name of the connection in the "Connecting mapping settings" section displayed at
right portion of Connection mapping tab. Enter a unique name for the connection in the
"Connection name" field or use the Default name options. Click "Connect" button to confirm
your entries.
5. Repeat steps 1 to 3 for all elements of the provider that you wish to transfer.
With Stored procedure transaction type, you can select the stored procedure table in the
"Table" field.
4.3.7.1 Overview
Overview
The dynamic database module provides the possibility to have read and write access to a
database. You can access MS Access, MS SQL Server, MySQL and Oracle databases. Unlike the
database module, a data record selection can be made at the time of the transfer.
For the special request for different databases, note the information at the end of this chapter.
Introduction
The dynamic database provider has a trigger and control capabilities from OPC unlike the
normal database provider. This way, the selection of the time and the data records can
be made from the OPC. In addition, you also have the ability to transfer a combination
of database and OPC tags. If the trigger condition has been met, data can be sent to the
consumer from the OPC and the database together and can be processed there together.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 333
WinCC/IndustrialDataBridge Documentation
4.3 Modules
,'%
23&
6HUYHU 3URYLGHU &RQVXPHU
23&
,'% 'DWD
GDWD &RQVXPHU
GDWDEDVH &RQVXPHU
GDWDEDVH
The configuration of the dynamic database provider has two other configuration steps. The
trigger and a list of "Where" conditions should be configured.
Example:
The OPC Trigger checks two OPC tags for whether they meet the configured condition. If the
condition has been met, the remaining values are read by the OPC server. In this case, these
are values that are used for the Where condition and the values that are sent directly to the
consumer.
The SQL statement is made up of the values for the "Where" condition. A database query
is made afterwards. The resulting data records are sent to the consumer together with the
OPC values. After the Consumer has sent the data to data target, the configured confirmation
values of the trigger item are written.
Process (see example):
WinCC/IndustrialDataBridge
334 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
23& GDWDEDVH
,'%
,WHPV 'DWD
64/
6HWWULJJHUYDOXH '\QDPLF
7ULJJHU
'DWDEDVH
3URYLGHU
ZLWKWULJJHU
64/VWDWHPHQWYDOXHV 64/VWDWHPHQW
GDWD
&RQVXPHU
'DWD7DUJHW
Introduction
Unlike the normal database consumer, the dynamic database consumer can update a table
record. One of the values that are supplied by the provider is used for selecting a record in
the target database. This value is used for the "Where" condition in SQL statement, created
internally in the IndustrialDataBridge. Only one value (tag) can be compared with a column.
If a record does not exist within the table, you can add a new record. The general behaviour
is defined while configuring.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 335
WinCC/IndustrialDataBridge Documentation
4.3 Modules
,'%
3URYLGHU &RQVXPHU
/RFDWLRQ
GDWD
'DWD ,'% '\QDPLF
3URYLGHU GDWD GDWDEDVH GDWDEDVH
3URYLGHU
Example:
The image shows an exemplary process. The data from the provider is entered in the SQL
statement, which affects the "update record". Since the value of the ID is "1" in "Where"
condition, writing is done to the first record in this example.
,'%
6HOHFWLRQRIWKH 8SGDWHRIWKHVHOHFWHGSDUDPHWHUV
GHVLUHG
3DUDPHWHU
'DWDFXUUHQW
&UHDWLQJWKH
(QJLQH,' :KHUH
VWDWHPHQW
,' :KHUH6WDWHPHQW
,'
3ODQW
,IWKH,'GRHVQRWH[LVW
&UHDWLQJDQHZFROXPQ
WinCC/IndustrialDataBridge
336 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Important Notes for Configuring the Different Databases
• For access to an MS SQL Server and MS Access, the Microsoft Data Access Components 2.8
(MDAC 2.8) must be installed.
• To access MS Access 2013 / 2016 in 64-bit operating system, 32-bit Microsoft Access
Database Engine 2010 Redistributable / Microsoft Access Database Engine 2010
Redistributable SP2 respectively must be installed.
• For the MS JET 4.0 OLE DB Provider with MS Access, default setting "Share Deny None" is to
be used under the extended settings for access authorizations. The selection of more than
one access authorization causes an error in the configuration environment of the
IndustrialDataBridge.
• Using data type VT_I8 as a trigger tag (values transferred upon event) in the database
provider is not approved.
• The remote access of the IndustrialDataBridge on a PC with an MS Access Database (via MS
JET 4.0 OLE DB Provider) is not approved because of reconnect problems.
• The character "?" (VT_BSTR) cannot be written into a field with field type "char" or "varchar"
with the SQL server. A respective error message is output to the Runtime interface.
• Since a StoredProcedure or a PreparedInsertStatement always requires all values, faults can
occur in the "Only upon change" transfer mode. In this case, this mode should not be used
in combination with StoredProcedure or PreparedInsertStatement.
• The time stamp must be assigned before connecting the first tags. Afterwards, adding or
changing is only possible if all items are deleted, the dialog is closed and reopened again. The
time stamp is generated from the local time, if new data is transferred from the provider.
• A table name is not to contain any spaces, otherwise problems can occur in the transfer.
Objective
To create a project with corresponding link having Dynamic Database as provider and configure
the respective provider/consumer configuration along with transfer behavior settings for
provider.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 337
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Creating a link
1. Open IDB Configuration and create a project by following the steps mentioned below:
– In IDB Configuration menu, select "Project" > "New project" to create a new project.
– In the "Create new project" dialog box, specify a project name, click [...] button and select
the folder location wherever the project needs to be saved.
– After entering the required information, select "Create" button. This creates a new project.
2. The project name will be listed within the "Project tree". The next step is to create a link.
Follow the steps mentioned below to create a link between provider and consumer:
– Right click on project name node in the tree structure and select "Add new link" option or
else double click the "Add new link" node below the project name node within project
tree.
– In the "Add new link" dialog that is displayed, enter a unique link name.
– Select the provider type as Dynamic Database, consumer type as Database and click OK
button.
– The created link will be displayed below the project name in project tree.
– The corresponding entries - Provider, Consumer, Settings and Connections are created as
nodes that exist below the new link in the tree structure.
WinCC/IndustrialDataBridge
338 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. In project tree, open the Provider configuration window by double clicking the Provider node.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 339
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– If a user name and password has been set for the database, enter the user name and
password in the "User name" and "Password" fields respectively.
If you wish to set a blank password, enable the check box "Blank password". To save the
entered password, enable the check box "Allow saving password".
– Click Test button to test the connection. The application tests the database connection
string and verifies the selected database.
4. In project tree, open the Consumer configuration window by double clicking the Consumer
node.
In Database consumer configuration window, perform the following settings:
WinCC/IndustrialDataBridge
340 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– If the database exists on a server location, enter the server name in "Server" field.
If you wish to enable windows authentication automatically, select the check box "Use
automatic windows authentication".
– In "Database" field, click on [...] button and select the database from the list or from the
folder structure.
Note
Server name
The "Server" field for entering the Server name, "Use automatic windows authentication"
check box and the fields for entering the logon information are enabled only if you have
selected a database other than Microsoft Access.
– If a user name and password has been set for the database, enter the user name and
password in the "User name" and "Password" fields respectively.
If you wish to set a blank password, enable the check box "Blank password". To save the
entered password, enable the check box "Allow saving password".
– Click Test button to test the connection. The application tests the database connection
string and verifies the selected database.
"Consumer type configuration" section
– Select the "Consumer type" by selecting from the list. More information about the
consumer types are provided in chapter "Consumer Types".
– Choose the "Transaction type" - Stored procedure or Prepared insert statement and select
table name and schema.
Note
Transaction type
The Stored procedure or Prepared insert statement transaction type options are in enable
state only when the consumer type "One data record per call - command set" is selected
and if you have selected a database type other than Microsoft Access. By default,
the Prepared insert statement option is automatically selected.
• Only the "Table" field is enabled if Microsoft Access is selected as database type and
consumer type is selected as "One data record per call - command set". Select the table
name by clicking the drop down list box.
• If you have selected a database type other than Microsoft Access and consumer type
is selected as "One data record per call - command set", then all the fields within the
Transaction type will be in enable state.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 341
WinCC/IndustrialDataBridge Documentation
4.3 Modules
1. In project tree, double click the Settings node to open Settings window in the work area.
2. The Settings window consists of 3 tabs - Transfer options, Connection Mapping &
Connections.
3. Within the Transfer options tab, you can configure the transfer behavior settings for provider.
Note
Selecting Schema
• If you are using a database other than Microsoft Access, selection of Schema
is mandatory before choosing the Table name.
• While using Microsoft Access as database, the "Schema" field is displayed in disable state
and does not allow any selection of Schema.
– Select the Schema firstly by choosing from the drop down list box.
– Next, choose the Table name in "Table" field.
– Click "Event" button to configure the trigger provider settings. The "Trigger provider"
window will be opened.
The description of the "Trigger provider" is provided in chapter "Configuring a Trigger"
4. The transfer behavior settings for provider will be saved automatically.
WinCC/IndustrialDataBridge
342 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Saving changes
A save operation is not required every time whenever changes are performed within the editor
window in the work area. The changes made to these settings are automatically saved. However,
once the project is created, at any point of time, you can save the project by selecting the
"Project" > "Save" menu option.
Results
You have configured the Dynamic Database interface and a consumer. These elements are
displayed in the tree structure of the configuration interface. In order to transfer data, connect
the provider and consumer tags, as described in chapter "Connecting Tags from the Interface of
a Dynamic Database".
Introduction
The "Trigger Provider" dialog window provides the OPC settings, Trigger configuration options
and required fields that help you to configure the condition that triggers a data transfer. This
dialog window is opened after clicking the "Trigger" button in Transfer options window.
Note
OPC tag browser
The OPC tags within "Trigger configuration" section will only be displayed if you have already
selected the name of the OPC Server.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 343
WinCC/IndustrialDataBridge Documentation
4.3 Modules
WinCC/IndustrialDataBridge
344 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Procedure
1. In "OPC settings" area, select the OPC server by clicking on the [...] button. The selection of
the server is supported by an OPC tag browser. Next, click the button representing "tick mark"
to accept the changes.
2. The "Node name" is automatically displayed in "Node name" text box after selection of the
OPC Server.
Note
Node name
For local OPC Server, the node name will display as "local host". In case of remote OPC Server,
the remote computer name will be displayed after selection of OPC Server on the remote
computer. This "Node name" is required for searching the OPC Server from the remote
computer.
The OPC tag browser does not display any content if node name is invalid.
Note
The "OPC Server" and "Node name" fields are provided as editable fields.
If the information about OPC Server name and node name is known, you can directly enter
the information in the "OPC Server" and "Node name" fields. If the node name / OPC Server
name is invalid, there will be no content displayed within the OPC tag browser.
3. You can define an OPC tag on the trigger provider, in which the success-/failure-status of the
data transfer will be stored in the "Tag for transaction security" field. This value should have
1 byte signed char (e.g. VT_I1). -1 indicates the success state and 0 indicates failure.
Select the tag of the OPC server, in which this information is to be saved in the tag browser
and click on the "Apply item" button.
4. The tree structure of OPC server is displayed within "Trigger Configuration" area.
5. In "Trigger Configuration" area, select the desired tags individually and accept them by
clicking on "Add item" each time.
The selected tags are shown in the table below the tag browser that displays the tag list.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 345
WinCC/IndustrialDataBridge Documentation
4.3 Modules
6. Use the "Remove item" button to remove the marked item. If no item is marked for deletion,
the last item from the list is deleted if you click the "Remove item" button. Details about the
columns in the Tag list are located in section "Tag declaration".
Note
OPC Server
After selection of the tags and adding them to tag list, if you switch to another OPC Server in
OPC Settings area, a dialog window is displayed that prompts the message whether you wish
to discard previous settings.
7. In "Trigger condition" area, you can select the type of syntax with selection button "VB Style"
or JScript Style". If a trigger condition is already created, this setting can no longer be
changed. If the language is to be changed, the text in the "Configure Trigger Condition" field
must be deleted.
Details on the programming languages are located in section "Programming Languages".
8. Create the trigger condition in the selected language. Use the Alias designations in the tag
list for these tags. Within the text box displayed, enter the operator symbols using the
keyboard or select them from the "Logical patterns" list box.
9. Test the created condition by clicking on "Validate". The trigger condition is calculated with
the values that are entered in the "Test value" column. The result "TRUE" or "FALSE" is shown
in a message box.
10.If the trigger condition provides the correct result and after confirming the changes, close the
dialog by clicking on "OK" button.
Additional Information
Tag declaration
The columns for the tag declaration contain the following:
• Data type: Data type of the tag. If the data type defined here does not match that on the
server, an attempt to convert the data type is made.
• TagID: The TagID of the tag on the OPC server
• Alias: The alias is used for creating the trigger condition. This name must be unique and it
must correspond with the naming conventions of the allocated programming languages. For
more detailed information about the naming conventions, see paragraph "Valid alias names".
• Confirmation value: The confirmation value is the value that the variable takes on after
fulfilling the trigger condition and the values have been delivered to the consumer. The
default value is "<Empty>", i.e., no confirmation value is written.
• Test value: This value is only for testing the trigger condition and has no influence on the later
data exchange. The test values are to be selected and changed so that they test whether the
trigger condition delivers the expected result in all operating conditions.
WinCC/IndustrialDataBridge
346 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Confirmation value
The confirmation value does not give any information on whether a transaction has been
completed successfully.
Note
Necessity of Alias Names
The OPC TagID is not used because it may possibly not correspond with the tag validity criteria,
for instance, a "Point" in the tag name is not allowed.
Programming languages
You can use VBScript or JScript for the trigger condition.
The following table shows the operator type and their symbols in both languages:
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 347
WinCC/IndustrialDataBridge Documentation
4.3 Modules
It is recommended to use these operators only. Other operators can be found in the language
descriptions for the respective language.
Note
Loss of Trigger Events
The triggering depends on the update speed of the OPC server. In this case, note that data
changes that occur within an update cycle are not considered by the trigger. That means that a
faster change of a tag from 1 - 0 - 1 is not necessarily indicated to the trigger provider by the OPC
server, since the 1 exists at the end again and no value change exists at the check time. This
means that a potentially true condition is not recognized as being true and therefore will not lead
to a data transfer.
Configurations, with which the confirmation value is to set a "true" trigger condition to "false"
again, are not secure because of the statement above. When data changes occur too quickly, the
"true value" may stay the same or values can be left out.
Connecting Tags
In "Settings" window, the "Connection mapping" tab includes the required fields to connect tags
that have been sent from the Dynamic Database interface with the selected data consumer. The
Connection mapping tab divides the window into 3 sections
• Dynamic database provider
• Database consumer
• Connection mapping settings
The "Dynamic database provider" section is displayed at top left portion of "Connection
mapping" tab. This section provides you with required options to choose schema, table
name and column names to be mapped. The "Database consumer" section exists below the
provider section and lists the column values that can be mapped with the columns existing
within Dynamic Database.
WinCC/IndustrialDataBridge
348 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
The separator between the provider and consumer section provides a resize handle that
helps you to resize the height of the section in order to view the fields within the section
clearly.
The "Connection mapping settings" section is displayed at right side of "Connection mapping"
tab. This section helps you to provide a name for connection along with options for choosing
default name for connection. The "Connect", "Modify connection" and "Delete connection"
icons are provided at the top portion of this section.
Note
Select OPC server
In order to configure the settings in the "Where Statement" tab, you must have selected an OPC
server in the link settings in dialog "Trigger Provider". This dialog window is accessed by clicking
on the "Event" button in "Transfer options" tab.
This chapter covers the aspects related to "Dynamic Database provider" and "Where
Statement" tabs. Also, the steps to be performed to have a connection mapping between
provider and consumer are provided within this chapter.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 349
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Dynamic Database
1. In "Dynamic database provider", select the Schema and choose the table name from "Table"
field.
Note
Selecting Schema
• If you are using a database other than Microsoft Access, selection of Schema
is mandatory before choosing the Table name.
• While using Microsoft Access as database, the "Schema" field is displayed in disable state
and does not allow any selection of Schema.
2. The Column names are displayed within "Columns" area. Select a Column name from the list.
The selected column is displayed in "Column for data value" field. The data type is shown
automatically.
3. The "Filter" field provides you the option to filter the Column names based on single character
or first few characters of column name.
For example, if you wish to view the column names starting with "S", type this character in
"Filter" text box. All column names starting with "S" are displayed.
4. Next, configure the consumer tag in the "Database consumer" section by following these
steps:
– The selected table is shown in the "Table" field. Select the Schema if applicable by
selecting from the drop down list in "Schema" text box.
– The column names are displayed within "Columns" area. If the table has columns with
respective data types, the time stamp can also be written to the table. In this case, select
the respective "Active" check box and select the column within "Column for timestamp"
field.
5. Select the Column name that you wish to connect with "Dynamic Database" column.
The selected column is displayed in "Column for data value" field.
6. Check the name of the connection in the "Connection mapping settings" area to the right.
Enter a unique name for the connection in the "Connection name" field or use the options
within "Default name options". Click "Connect" button to confirm your entries.
Note
Data type conversion
If the provider tag data type does not match with consumer column, IDB CS converts the data
type to match with data type of provider tag. A status window is displayed to indicate this
change.
7. Repeat steps 1 to 6 for all elements of the "Dynamic database provider" that you wish to
transfer.
8. The connection name including the provider and consumer data values will be displayed
within the "Connection mapping settings" section.The list of connections will be also
displayed within the Connections tab as well as in the project tree within the "Connections"
node belonging to the specific link.
WinCC/IndustrialDataBridge
350 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Where-statement
The SQL String that describes the access location for reading the data is shown on this
tab. The "Where-statement" tab mainly includes the "WHERE" section and text area for
displaying the "Resulting SQL-String". Follow the steps provided below to configure the Where
statement.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 351
WinCC/IndustrialDataBridge Documentation
4.3 Modules
1. Within Where statement tab, click "Add" button to open the dialog that provides you with
options to select the column in order to compare the content.
2. Select the Fieldname you wish to check for a certain value. The selected field name is
displayed in "Fieldname" field. The data type for this field name is automatically selected in
the "Datatype" field.
3. This "Fieldname" is shown in the "WHERE" text box. Choose the operator symbol from the
drop down list that is used for comparision.
4. In "OPC-variable" section, select the OPC tag, the value of which is compared with the
previously selected column entry. Then, click OK button.
5. The condition is shown in the table within "Where" section and is entered in the "Resulting
SQL String" field.
6. To remove an already existing "Resulting SQL String", click "Remove" button.
7. To define multiple conditions, repeat steps 1 to 5.
WinCC/IndustrialDataBridge
352 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
SQL String
• If multiple conditions are configured, they are connected with a logical "AND".
• Only data records (lines) are requested from the IDB and transferred in which all conditions
have been met.
• An optional connection is not possible with a logical "OR".
Advanced:
Using button "Advanced", you can define the sort sequence and the behavior when multiple
data records exist.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 353
WinCC/IndustrialDataBridge Documentation
4.3 Modules
• Order By
Select the selection field. You can then define the column name and the sort direction.
• Behaviour with several results:
Select one of the following option fields and click OK button. Based on selected radio button,
you can decide the action to be performed:
– Error message (no data transferred): When this option is selected, no data will be
transferred.
– Submit first line: Submits only the first row in the table.
– Submit last line: Submits the last record or last row contained within the table.
– Submit all lines: Considers transfer of all records or rows within the table.
Note
Modifying Consumer type
Once the connection(s) have been created in Connection mapping window and if you wish to
modify the Consumer type in Database consumer configuration, the IDB CS application will not
allow to change the Consumer type. To change the Consumer type, you need to delete the
connection(s) that have been already created. Close the consumer configuration window and re-
open the window from the project tree to modify the consumer type.
Results
The connections that you have created are shown in the "Connections" tab of IDB Settings
window as well as within the project tree node.
WinCC/IndustrialDataBridge
354 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Select OPC server
In order to configure the settings on the "OPC" tab, you must have selected an OPC server in the
link settings in dialog "Config. Trigger Provider". This dialog window is accessed by clicking on the
"Event" button in "Transfer options" tab.
1. In the "Dynamic Database provider" area, navigate to OPC tab. The OPC tab mainly includes
the OPC tag browser and "Configure provider OPC tag" area.
2. In OPC tag browser, select the tag for which the values should be transferred. The selected
tag is shown in the "TagID" field. The data type is chosen according to the selection.
3. If the selected tag has Array data type, then the "Array" check box is automatically enabled.
This check box is provided below the "Datatype" field.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 355
WinCC/IndustrialDataBridge Documentation
4.3 Modules
4. Next, configure the consumer tag in the "Database consumer" section by following these
steps:
– The selected table is shown in the "Table" field. The schema (if selected at provider side)
is displayed in the "Schema" field.
– The column names are displayed within "Columns" area. If the table has columns with
respective data types, the time stamp can also be written to the table. In this case, select
the respective "Active" check box and select the column within "Column for timestamp"
field.
5. Select the Column name that you wish to connect with the OPC tag. The selected column is
displayed in "Column for data value" field of Database consumer.
6. Check the name of the connection in the "Connection mapping settings" area to the right.
Enter a unique name for the connection in the "Connection name" field or use the options
within "Default name options". Click "Connect" button to confirm your entries.
7. Repeat steps 1 to 5 for all elements of the "Dynamic Database" that you wish to transfer.
Note
Array
If the OPC provider tag has a data type of array data type and if the database consumer
column has data type other than array data type, after clicking on the Connect buton, the
"Array" check box in the "OPC tab" is automatically unchecked.
Results
The connections that you have created are shown in the "Connections" tab of IDB CS Settings
window as well as within the project tree node.
Objective
To create a project with corresponding link having Dynamic Database as consumer and
configure the respective provider/consumer connection properties along with transfer
behaviour settings.
WinCC/IndustrialDataBridge
356 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Creating a link
1. Open IDB Configuration and create a project by following the steps mentioned below:
– In IDB Configuration menu, select "Project" > "New project" to create a new project.
– In the "Create new project" dialog box, specify a project name, click [...] button and select
the folder location wherever the project needs to be saved.
– After entering the required information, select "Create" button. This creates a new project.
2. The project name will be listed within the "Project tree". The next step is to create a link.
Follow the steps mentioned below to create a link between provider and consumer:
– Right click on project name node in the tree structure and select "Add new link" option or
else double click the "Add new link" node below the project name node within project tree.
– In the "Add new link" dialog that is displayed, enter a unique link name.
– Select the provider type as Database, consumer type as Dynamic Database and click OK
button.
– The created link will be displayed below the project name in project tree.
– The corresponding entries - Provider, Consumer, Settings and Connections are created as
nodes that exist below the new link in the tree structure.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 357
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. In project tree, open the Provider configuration window by double clicking the Provider node.
WinCC/IndustrialDataBridge
358 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– If a user name and password has been set for the database, enter the user name and
password in the "User name" and "Password" fields respectively.
If you wish to set a blank password, enable the check box "Blank password". To save the
entered password, enable the check box "Allow saving password".
– Click Test button to test the connection. The application tests the database connection
string and verifies the selected database.
4. In project tree, open the Consumer configuration window by double clicking the Consumer
node.
In Danamic database consumer configuration window, perform the following settings:
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 359
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– In "Database" field, click on [...] button and select the database from the list or from the
folder structure.
Note
Server name
The "Server" field for entering the Server name, "Use automatic windows authentication"
check box and the fields for entering the logon information are enabled only if you have
selected a database other than Microsoft Access.
– If a user name and password has been set for the database, enter the user name and
password in the "User name" and "Password" fields respectively.
If you wish to set a blank password, enable the check box "Blank password". To save the
entered password, enable the check box "Allow saving password".
– Click Test button to test the connection. The application tests the database connection
string and verifies the selected database.
WinCC/IndustrialDataBridge
360 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
2. Within the Transfer options tab, you can configure the transfer behavior settings for provider.
"Provider settings" section
– Select the Schema, if applicable and choose the Table name by selecting from the drop
down list.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 361
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– Enter a time period in the "Update rate" field after which the system checks for whether
data is to be transferred.
Note
Selecting Schema
• If you are using a database other than Microsoft Access, selection of Schema
is mandatory before choosing the Table name.
• While using Microsoft Access as database, the "Schema" field is displayed in disable
state and does not allow any selection of Schema.
Note
Update rate
For better performance, it is recommended to use an update rate of 1000 ms or 1 sec.
WinCC/IndustrialDataBridge
362 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Saving changes
A save operation is not required every time whenever changes are performed within the editor
window in the work area. The changes made to these settings are automatically saved. However,
once the project is created, at any point of time, you can save the project by selecting the
"Project" > "Save" menu option.
Results
You have created a connection between the dynamic database interface and a provider. These
elements are displayed in the tree structure of the IDB configuration interface. In order to
transfer data, connect the provider and consumer tags, as described in chapter "Connecting Tags
to a Dynamic Database Interface".
Connecting Tags
In "Settings" window, the "Connection mapping" tab includes the required fields to connect tags
that have been sent from the selected data provider to Dynamic Database interface. The
Connection mapping tab divides the window into 3 sections:
• Database provider
• Dynamic database consumer
• Connection mapping settings
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 363
WinCC/IndustrialDataBridge Documentation
4.3 Modules
The "Database provider" section is displayed at top left portion of "Connection mapping"
tab. This section lists the column values that can be mapped with the columns existing
with Dynamic Database consumer. The "Dynamic database consumer" section is displayed to
bottom left portion of "Connection mapping" tab. This section provides you with required
options to choose schema, table name and column names to be mapped.
Note
Connection mapping
A specific connection can be created between the Database provider column and the column
(belonging to Dynamic database consumer) selected in the Where statement tab. You can create
a new connection or else modify an existing connection to apply Where statement on the
selected column.
The separator between the provider and consumer section provides a resize handle that
helps you to resize the height of the section in order to view the fields within the section
clearly.
The "Connection mapping settings" section is displayed at right side of "Connection mapping"
tab. This section helps you to provide a name for connection along with options for choosing
default name for connection. The "Connect", "Modify connection" and "Delete connection"
icons are provided at the top portion of this section.
WinCC/IndustrialDataBridge
364 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
1. In "Database provider" section, the selected archive is shown in the "Table" field. Select the
Schema if applicable by selecting from the drop down list in "Schema" text box.
2. The Column names are displayed within "Columns" area. Select a Column name from the list.
The selected column is displayed in "Column for data value" field. The data type is shown
automatically.
3. The "Filter" field provides you the option to filter the Column names based on single character
or first few characters of column name.
For example, if you wish to view the column names starting with "S", type this character in
"Filter" text box. All column names starting with "S" are displayed.
Note
Dynamic database consumer
The "Dynamic database consumer" section area consists of 2 tabs - 'Dynamic Database
consumer' and 'Where- Statement'.
This chapter covers the aspects related to "Dynamic database consumer" and "Where-
Statement" tabs.
4. Next, configure the consumer tag in the "Dynamic database consumer" tab by following
these steps:
Note
Selecting Schema
• If you are using a database other than Microsoft Access, selection of Schema
is mandatory before choosing the Table name.
• While using Microsoft Access as database, the "Schema" field is displayed in disable state
and does not allow any selection of Schema.
– In "Dynamic database provider", select the Schema and choose the table name from
"Table" field.
– The column names are displayed within "Columns" area. The column names are displayed
within "Columns" area. If the table has columns with respective data types, the time
stamp can also be written to the table. In this case, select the respective "Active" check box
and select the column within "Column for timestamp" field.
5. Select the Column name that you wish to connect with "Database provider". The selected
column is displayed in "Column for data value" field.
The data type for the selected column is automatically selected in the "Data type" field.
6. The "Filter" field provides you the option to filter the column names based on single character
or first few characters of column name.
For example, if you wish to view the column names starting with "S", type this character in
"Filter" text box. All column names starting with "S" are displayed.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 365
WinCC/IndustrialDataBridge Documentation
4.3 Modules
7. Check the name of the connection in the "Connection mapping settings" area to the right.
Enter a unique name for the connection in the "Connection name" field or use the options
within "Default name options". Click "Connect" button to confirm your entries.
Note
Data type conversion
If the provider tag data type does not match with consumer column, IDB CS converts the data
type to match with data type of provider tag. A status window is displayed to indicate this
change.
8. Repeat steps 1 to 7 for all elements of the "Database Provider" that you wish to transfer.
9. The connection name including the provider and consumer data values will be displayed
within the "Connection mapping settings" section.The list of connections will be also
displayed within the Connections tab as well as in the project tree within the "Connections"
node belonging to the specific link.
WinCC/IndustrialDataBridge
366 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. In the "Where-column" field, select the column that is to be used for the Where Statement. If
a value has to be written to the database, this column is compared with the connected
provider column(s). Only lines in which both values match are updated.
4. The behavior is defined in the "Exception handling" field if the selection of the consumer row
is not unique:
– Error Message: No target lines are overwritten and an error message is given as an output
in the trace view of IDB Runtime.
– Change all rows: All selected consumer rows are overwritten.
– Using the "Enable Insert" check box, you define the behavior if a line with the key (primary
key) does not exist. If the option is selected, a new line with the respective key is created.
Note
Simultaneous Utilization as Key and Target Column
In order to have more setting ability with the configuration, a column can be used as a key
column and as a consumer column simultaneously. Take note that this causes the data in the
database to be inconsistent and/or future access to the dynamic database consumer may
result in errors.
5. Check the name of the connection in the "Connection mapping settings" area (right). Enter
a unique name for the connection in the "Connection name" field or use the options within
"Default name options". Click "Connect" button to confirm your entries.
Results
The connections that you have created are shown in the "Connections" tab of IDB "Settings"
window as well as within the project tree node.
4.3.8.1 Overview
Overview
The IDB application provides support for writing data to an ASCII file, UTF-8 format file using
module CSV, TXT. This module can be used only as a consumer and works with all provider types.
CSV, TXT as a consumer type is to be given priority because of the much higher access speed
in comparison with the "Excel file" data type. You can open and process files of this type with
Microsoft Excel or with another table calculation program.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 367
WinCC/IndustrialDataBridge Documentation
4.3 Modules
To establish connection to CSV/TXT files, let us consider OPC Data Access (OPC DA) as the
provider in this case.
Note
Important Notes for Configuring OPC Data Access
• To work in configuration and runtime environment of the module OPC Data Access, you must
configure the DCOM settings correctly in Windows. Information on DCOM settings can be
found in Microsoft Help.
• The tag browser information or the tags are displayed only if OPC Server is selected in
provider configuration window and is available.
Objective
To create a project with corresponding link having CSV, TXT as consumer and configure the
respective provider/consumer configuration along with transfer behavior settings
Creating a link
1. Open IDB Configuration and create a project by following the steps mentioned below:
– In IDB Configuration menu, select "Project" > "New project" to create a new project.
– In the "Create new project" dialog box, specify a project name, click [...] button and select
the folder location wherever the project needs to be saved.
– After entering the required information, select "Create" button. This creates a new project.
2. The project name will be listed within the "Project tree". The next step is to create a link.
Follow the steps mentioned below to create a link between provider and consumer:
– Right click on project name node in the tree structure and select "Add new link" option or
else double click the "Add new link" node below the project name node within project tree.
– In the "Add new link" dialog that is displayed, enter a unique link name.
– Select the provider type as OPC Data Access, consumer type as CSV/TXT and click OK
button.
– The created link will be displayed below the project name in project tree.
– The corresponding entries - Provider, Consumer, Settings and Connections are created as
nodes that exist below the new link in the tree structure.
WinCC/IndustrialDataBridge
368 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. In project tree, open the Provider configuration window by double clicking the Provider node.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 369
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. Enter a time period in the "Update rate" field after which the system checks for whether data
is to be transferred.
Note
Update rate
For better performance, it is recommended to use an update rate of 1000 ms or 1 sec.
WinCC/IndustrialDataBridge
370 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
5. Enter the deadband value (in percent) to contain a value within the range 0 - 100.
6. In "Tag for transaction security" field, click [...] button and select a tag of OPC Server from the
OPC tag browser.
You can define a OPC tag on an OPC server, in which the success-/failure-status of the data
transfer will be stored in the "Tag for transaction security" field.This value should have 1 byte
signed char (e.g. VT_I1). '-1' indicates the success state and '0' indicates failure.
7. If you have selected the option "Send values using trigger", you can configure the trigger that
provides options to set the trigger options. The Trigger section is enabled only with the data
transfer type "Send values using trigger".
Perform the following settings in the "Trigger settings" section:
– In "Trigger tag" field, select the tag that should trigger a data transfer. Click on [...] to select
the tag from OPC tag browser.
– Select a valid data type by selecting from the drop down list.
– Enter a threshold at which a data transfer should be triggered, in the "Trigger value" field.
– In "Confirmation value" field, enter a value that the trigger tag should take on after
triggering.
The confirmation value does not give any information on whether a transaction has been
completed successfully.
8. The transfer behavior settings for provider will be saved automatically.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 371
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Saving changes
A save operation is not required every time whenever changes are performed within the editor
window in the work area. The changes made within the editor windows are automatically saved.
However, once the project is created, at any point of time, you can save the project by selecting
the "Project" > "Save" menu option.
Results
You have configured the OPC Data Access as provider and the interface to CSV/TXT file including
provider transfer options. These elements are displayed in the tree structure of the
configuration interface. In order to transfer data, connect the provider and consumer tags, as
described in chapter "Connecting Tags to an Interface to CSV- and TXT-Files".
Connecting Tags
In "Settings" window, the "Connection mapping" tab includes the required fields to connect tags
that have been sent from the selected provider to CSV/TXT consumer. The Connection Settings
are performed by configuring the settings within the Connection mapping tab.
This tab displays the "OPC Data Access provider" and "CSV/TXT consumer" on left hand
side whereas the right hand side of window contains Connection mapping properties and
connection options. The separator between the provider and consumer section provides a
resize handle that helps you to resize the height of the section in order to view the fields
within the section clearly.
The "Connection mapping settings" section is displayed at right side of "Connection mapping"
tab. This section helps you to provide a name for connection along with options for choosing
default name for connection. The "Connect", "Modify connection", "Delete connection" and
"Delete all connections" icons are provided at the top portion of this section.
WinCC/IndustrialDataBridge
372 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
CSV/TXT consumer
The CSV/TXT consumer is displayed below the provider section and includes options for
selecting the column within CSV/TXT file. It also provides options to create new CSV/TXT file
with required columns.
In the consumer section, "Maximum entry configuration" tab is displayed next to the
"CSV/TXT consumer" tab. The "Maximum entry configuration" tab provides the required fields
for archive file name generation.
The "CSV/TXT consumer" tab displays the "CSV/TXT" and "Columns" area.
The "CSV/TXT" area includes options to select the CSV/TXT file. The corresponding column
names will be listed in the "Columns" area upon selection of this CSV, TXT file. CSV, TXT
supports only one data type "OLE/Binary Automation string (VT_BSTR)". This data type is
selected by default after the selection of respective column name within the "Columns" area.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 373
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Follow the steps provided below to select the CSV/TXT file and choose the required column
name that needs to be mapped:
1. Within "CSV/TXT" area, the "CSV filename" list box is provided that displays a list of CSV or TXT
files. Click the drop down arrow of "CSV filename" field and select the appropriate CSV file.
2. If the CSV/TXT file does not exist in the list, select "New CSV file" button. The "CSV Creator"
dialog box opens thus providing options to create a new CSV file.
In the "CSV creator" dialog window, select "Add" button to create a column entry with default
name. To define a custom name for the column, enter the column name in "Column name"
field provided at top portion of this window. The created columns are displayed within the
"Columns" text area. The "UP" and "DOWN" buttons allows in changing the column sequence.
Note
The keyword "ID" written in capital letters should not be used for creating the first column
name of CSV file. If "ID" is given as column name for the first column, then a warning message
is displayed upon double clicking the CSV file. CSV files do not support this behavior.
3. Enter a file name in the "Filename" text box followed by file extension and select "Create"
button to create the CSV file. The new CSV file will be now available in the file list.
If the file that is selected within the list is of type UTF-8 format, the check box "UTF-8" will be
automatically enabled. If the file is of ANSI format, the check box remains unchecked.
4. In "CSV/TXT consumer" tab, select the CSV file that is displayed in the "CSV filename" field list
box. The "Columns" area displays the "column name" along with its associated "Data type".
WinCC/IndustrialDataBridge
374 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
5. In "Columns" area, select the column name from the list. The selected column name is
displayed in "Column for data value" field and the corresponding data type is selected and
displayed in "Data type" field.
6. To add new columns to the selected CSV file, navigate to bottom portion of the column list
and double click the row that contains the text "<Add new column>".
7. The "Column name" dialog box is displayed that allows you to enter the new column name.
Enter a name for the new column and click "Create" button.
The new column will be listed within the list of column names. You can create any number
of columns by repeating Steps 6 & 7.
8. If the column name has "Date/time" data type, the time stamp can be written to the specific
column. In this case, select the respective "Active" check box and select the column in
"Column for timestamp" field list box.
9. The "Filter" field provides you the option to filter the Column names based on single character
or first few characters of column name.
For example, if you wish to view the column names starting with "S", type this character in
"Filter" text box. All column names starting with "S" are displayed.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 375
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
• By default, the "Max. entries" field displays the value as 0. However, this value can be
modified.
• It is important to ensure that "Max. entries" field should not be left blank.
• If "Max. entries" is set to a value less than zero or negative value entered or if the field is
blank, an error message "Value should be greater than or equal to zero" is displayed.
• The maximum value for Max. entries in CSV/TXT is 2147483647. Any value entered above
this range will not be accepted and displays an error message as "Type conversion failed".
2. In "Archive File Name Generation" area, options are provided for file name generation with
respect to the archive file. Select any one of the following options by selecting the radio
button.
– Use current date and time
– Use current date and serial number
– Use serial number
3. Next, specify the Archive path in the text box provided. You can either enter the full path
name in the text box or select the path using "..." button. If you provide the path in archive
path text box, archived CSV files are generated at this path. By default, this text box has the
same path where the base CSV file is present.
WinCC/IndustrialDataBridge
376 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
4. The "Use Dedicated File Name" check box allows for options to specify a dedicated file name
in combination with a serial number and date or date and time or serial number. If this
checkbox is unchecked, then the base CSV filename will be used for archiving.
5. The "Select filename type" field provides options to select custom file name or to use file name
from WinCC tag.
– To use custom file name, select filename type as "Use custom filename" and enter the
custom file name in "Custom file name" text box.
– To use file name from WinCC tag, select filename type as "Use filename from WinCC tag".
An OPC tag that uses the FileName Tag will be created. The FileNameTag is displayed only
after performing a connection mapping.
Note
Use Filename from WinCC tag
Please note that this filename type option "Use filename from WinCC tag" is provided (in
"CSV/TXT consumer", "Maximum entry configuration" tab) only while using the following
provider types:
• OPC Data Access
• Dynamic Database
• WinCC User Archive
This feature provides option to configure an OPC Tag as FileName for the CSV file. All Archive
File Name Generation settings are applied along with OPC tag value to construct a file name.
Data from the provider is written into this file until either the maximum entry configured is
reached or the OPC Tag configured for the CSV file name changes.
Note
Serial number
A range of 1 - 999999999 is supported for the serial number. During runtime, if the serial
number exceeds this maximum value, a trace log will be automatically created when this
value is reached. Once this upper limit is reached, IDB will not create any new archive file. The
same file will be updated continuously during data transfer.
Note
Upon selection of "Use Dedicated File Name" check box, the 'Select Filename Type' provides
an option "Use Filename from WinCC Tag" within the drop down combo box. This option is
provided only with providers that supports Tags.
Note
The OPC Tag as FileName feature can be used even if Max. entries is 0. If you have used this
setting, then the new file is created only when the OPC Tag changes. Until then, all records
are written to the CSV file that was created during creation of previous OPC Tag. The
maximum entry condition does not hold as the maximum entry is 0 and all the data is written
into a single file until the OPC Tag value configured for file name changes.
Note
If the OPC Tag value is NULL, then the base file or template file is taken into consideration for
forming the file name.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 377
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Connection Mapping
To establish connection between the provider and consumer, a data column mapping is
required. Defining a connection name is the first step towards the setup of a connection. The
Connection window displays "Default connection name" options in order to specify a name
for default connection. Connect, delete and modify buttons are provided below the "Default
connection name" section. These buttons help in order to work with the connections.
Note
Modify connection
To modify an existing connection, perform the required changes and then select "Modify"
button. The changes can be observed within the Connection window only after selecting the
"Modify" button.
Follow these steps to perform column mapping between provider and consumer:
1. Select a tag name from "OPC Data Access provider" and choose the column name from
CSV/TXT consumer" column that needs to be mapped. Click "Connect" button.
2. If there is a data mismatch between the provider and consumer columns, IDB CS will modify
the data type to VT_BSTR data type and displays the message "The provider data type was
changed to fit the consumer type". Next, click OK.
3. Repeat steps 1 & 2 for all elements of the provider that you wish to transfer. A connection is
created for each of the column values in provider and consumer.
4. To use file name from WinCC tag, select the OPC Tag from tag browser. Specify a connection
name for this connection from the options provided within the "Default Connection name"
area and click "Connect" button.
5. The connection name including the provider and consumer data values will be displayed
below the Connect button.
6. The list of connections will be displayed in the Connections tab.
Note
Array
If the OPC Data Access provider tag has a data type of array data type and if the CSV/TXT
consumer column has data type other than array data type, after clicking on the Connect buton,
the "Array" check box in the "OPC Data Access provider" is automatically unchecked.
WinCC/IndustrialDataBridge
378 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Column for time stamp
The time stamp must be assigned before connecting the first tags. Afterwards, adding or
changing is only possible if all items are deleted, the dialog is closed and reopened again. The
time stamp is generated from the local time, if new data is transferred from the provider.
Results
The connections that you have created are shown in the "Connections" tab of IDB CS "Settings"
window as well as within the project tree node.
4.3.9 Excel
4.3.9.1 Overview
Overview
The Excel module allows you to have write access to Excel spreadsheet. This module is used as
a consumer and is supported with most of the provider types.
,'%
3URYLGHU &RQVXPHU
/RFDWLRQ ([FHO
GDWD
'DWD ,'% ([FHO
3URYLGHU GDWD
3URYLGHU
In IndustrialDataBridge, the Excel consumer type is compatible with Office 2003, 2007, 2010,
2013 and 2016 versions. Using the Excel module with other Office versions is possible,
functionally, but has not been tested and is therefore not approved.
The following data types are supported and are released for the Excel module.
• VT_UI1 ( 1 byte unsigned )
• VT_I1 ( 1 byte signed )
• VT_UI2 ( 2 byte unsigned )
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 379
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Writing Larger Volumes of Data
Frequent use or transferring larger volumes of data can lead to performance loss of close to
100%. The utilization of a CSV file is recommended for this application.
Note
Closing Excel
When opening an Excel table, a new window is opened. If all Excel windows are closed, Excel is
also closed. The instance to which the IndustrialDataBridge is therefore also deleted in this case.
The connection is only re-established after a Reconnect (10 seconds). During this time, all
incoming data is lost.
Note
Setting "Save after a certain duration"
With the configuration "Save after a certain duration" and setting the time at less than 30
seconds, problems can occur when separating the data target Excel in the Runtime program.
4.3.9.2 Requirements
Prerequisites
In order to use a connection to Microsoft Excel as a consumer, you need the Microsoft Excel
program. This program is not provided with the WinCC IndustrialDataBridge. Microsoft Excel is
part of the Microsoft Office package.
If you are not sure whether the software is installed, contact your system administrator.
WinCC/IndustrialDataBridge
380 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
File Extension
Office 2003 includes Excel program and has the file extension ".xls" whereas Excel provided in
Office 2007 / Office 2010 has the file extension as ".xlsx".
Objective
To create a project with corresponding link having Excel as consumer and configure the
respective provider/consumer connection configuration along with their transfer behaviour
settings
Creating a link
1. Open IDB Configuration and create a project by following the steps mentioned below:
– In IDB Configuration menu, select "Project" > "New project" to create a new project.
– In the "Create new project" dialog box, specify a project name, click [...] button and select
the folder location wherever the project needs to be saved.
– After entering the required information, select "Create" button. This creates a new project.
2. The project name will be listed within the "Project tree". The next step is to create a link.
Follow the steps mentioned below to create a link between provider and consumer:
– Right click on project name node in the tree structure and select "Add new link" option or
else double click the "Add new link" node below the project name node within project tree.
– In the "Add new link" dialog that is displayed, enter a unique link name.
– Select the provider type as Database, consumer type as Excel and click OK button.
– The created link will be displayed below the project name in project tree.
– The corresponding entries - Provider, Consumer, Settings and Connections are created as
nodes that exist below the new link in the tree structure.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 381
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. In project tree, open the Provider configuration window by double clicking the Provider node.
WinCC/IndustrialDataBridge
382 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– If a user name and password has been set for the database, enter the user name and
password in the "User name" and "Password" fields respectively.
If you wish to set a blank password, enable the check box "Blank password". To save the
entered password, enable the check box "Allow saving password".
– Click Test button to test the connection. The application tests the database connection
string and verifies the selected database.
4. Next, double click the Consumer node in project tree to open the consumer configuration
window.
5. The Consumer configuration window consists of 2 tabs - Excel save option and Advance
options tabs.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 383
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– Select the radio button "Keep default sheet name" to use default name for the sheet.
– Select the radio button "Set Sheet name as" to set unique names for each sheet and enter
the sheet name in text box provided.
– You can specify the number of sheets required for the workbook by selecting the radio
button with label "1" or "2" or "3".
Based on this selection, the text box for entering the sheet name will be enabled or
disabled.
– In "Auto save option" section, enable the check box "Save after a certain time" and set the
hours, minutes and seconds in the control text box.
– In "Suffix of filename" section, select the radio button "Successive version number" or
"Date / Time" option.
The successive version number defines the method of numbering for files.
WinCC/IndustrialDataBridge
384 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
2. Within the Transfer options tab, you can configure the transfer behavior settings for provider.
"Provider settings" section
– Select the Schema, if applicable and choose the Table name by selecting from the drop
down list.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 385
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– Enter a time period in the "Update rate" field after which the system checks for whether
data is to be transferred.
Note
Selecting Schema
• If you are using a database other than Microsoft Access, selection of Schema
is mandatory before choosing the Table name.
• While using Microsoft Access as database, the "Schema" field is displayed in disable
state and does not allow any selection of Schema.
Note
Update rate
For better performance, it is recommended to use an update rate of 1000 ms or 1 sec.
WinCC/IndustrialDataBridge
386 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Saving Changes
A save operation is not required every time whenever changes are performed within the editor
window in the work area. The changes made to these settings are automatically saved. However,
once the project is created, at any point of time, you can save the project by selecting the
"Project" > "Save" menu option.
Results
You have created a connection between the Excel interface and a provider. These elements are
displayed in the tree structure of the configuration interface. In order to transfer data, connect
the provider and consumer tags, as described in chapter "Connecting Tags to an Excel Interface".
Connecting Tags
In "Settings" window, the "Connection mapping" tab includes the required fields to connect tags
that have been sent from the selected data target with Excel. The Connection mapping tab
divides the window into 3 sections
• Database provider
• Excel consumer
• Connection mapping settings
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 387
WinCC/IndustrialDataBridge Documentation
4.3 Modules
The "Database provider" section is displayed at top left portion of "Connection mapping" tab.
This section displays the selected schema, table name within "Schema" and "Table" fields
along with the column names. These columns can be mapped with the columns existing
within Excel interface. The "Excel consumer" section is displayed to bottom left portion of
"Connection mapping" tab.
The separator between the provider and consumer section provides a resize handle that
helps you to resize the height of the section in order to view the fields within the section
clearly.
The "Connection mapping settings" section is displayed at right side of "Connection mapping"
tab. This section helps you to provide a name for connection along with options for choosing
default name for connection. The "Connect", "Modify connection", "Delete connection" and
"Delete all connections" icons are provided at the top portion of this section.
1. In "Database provider" section, the selected archive is shown in the "Table" field. The Column
names are displayed within "Columns" area.
Select a Column name from the list. The selected column is displayed in "Column for data
value" field. The data type is showan automatically.
2. The "Filter" field provides you the option to filter the Column names based on single character
or first few characters of column name.
For example, if you wish to view the column names starting with "S", type this character in
"Filter" text box. All column names starting with "S" are displayed.
3. In the "Excel consumer" area, enter the column name in "Column name" field. The "Binary
String (VT_BTR)" is selected by default in the "Datatype" field.
To change the data type, click the drop down arrow in "Datatype" list box and select the
appropriate data type.
4. Within "Excel consumer", mark the field in which the column should be saved in first row. The
column name is entered in this field.
Note
Data type conversion
If the provider tag data type does not match with consumer column, IDB CS converts the data
type to match with data type of provider tag. A status window is displayed to indicate this
change.
5. Check the name of the connection in the "Connection mapping settings" area to the right.
Enter a unique name for the connection in the "Connection name" field or use the options
within "Default name options". Click "Connect" button to confirm your entries.
Once the connection is created, you can observe that the mapped column in "Config excel
consumer" area is displayed in yellow color. This represents the connected column in "Config
excel consumer"
6. Repeat steps 1 to 5 for all elements of "Database Provider" that you wish to transfer.
WinCC/IndustrialDataBridge
388 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Number of Excel columns
In Excel consumer, a maximum of 256 columns are supported wherein you can create
connections with 256 columns. After the 256th column, if you try establishing a connection
mapping, a warning message will be displayed. However, you will still be able to create
connections after 256 columns. In Runtime, connections upto a maximum of 256 can be
enabled.
Note
Opening Excel file during data transfer
During data transfer process between the provider and excel as consumer, IDB Runtime writes
the data in the Excel file. If the excel file is opened in parallel during the transfer process, then
runtime application stops working. A trace message "Inserting a value failed" will be displayed
in the "Trace view" once you try opening this excel file.
Please note that the Runtime application stops working and you will not be able to stop or
disconnect the data transfer process. In this scenario, you need to restart the IDB service.
However, you will not be able to save any data during the last data transfer.
Results
The connections that you have created are shown in the "Connections" tab of IDB "Settings"
window as well as within the project tree node.
4.3.10 Send/Receive
4.3.10.1 Overview
Overview
The Send/Receive module in IDB is used for sending and receiving data to or from Siemens PLC.
A secure communication is created over TCP protocol and enables reading or writing data to or
from the PLC memory. This module acts both as a provider and as a consumer.
The concept behind using the Send/Receive module is defined in such a way that it will be
able to read data from the PLC and will be able to write (Send) data to a consumer type
(for example, Database). In the other way, it will be possible to read (Receive) data from a
database and able to write data to a PLC.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 389
WinCC/IndustrialDataBridge Documentation
4.3 Modules
In this case, the following data types are approved for the Send/Receive data source
module:
• VT_UI1 ( 1 byte unsigned )
• VT_I1 ( 1 byte signed )
• VT_UI2 ( 2 byte unsigned )
• VT_I2 ( 2 byte signed )
• VT_UI4 ( 4 byte unsigned )
• VT_I4 ( 4 byte signed )
• VT_R4 ( 4 byte real )
• VT_BSTR ( binary string ) -> Interpretation as S7- or null-terminating string
Note
Data Type VT_BOOL
The utilization of VT_BOOL is not approved, since this data type is interpreted as a byte and
can overwrite values this way.
,'%
6HQG5HFHLYH 3URYLGHU &RQVXPHU
(WKHUQHW ,'%
6HQG5HFHLYH GDWD 'DWD&RQVXPHU
&RPPXQLFDWLRQ &RQVXPHU
WinCC/IndustrialDataBridge
390 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
,'%
,'% (WKHUQHW
'DWD3URYLGHU GDWD 6HQG5HFHLYH
3URYLGHU &RPPXQLFDWLRQ
Note
Send/Receive
Using Send/Receive as provider or consumer type with other supported provider / consumer
types can be configured in IDB CS application. However, after loading the configuration in
Runtime environment and connecting the provider/consumer types, you may observe that the
IDB connection status will still be shown in red colour and the status of connection is in
"Disconnected" state.
The "Connected" state can be achieved only if you are using Send/Receive to send or receive data
to or from a PLC.
4.3.10.2 Requirements
Prerequisites
To be able to send or receive data to or from the PLC, it is required to prepare the environment
accordingly. "STEP7 Professional" software is required to be installed to prepare the environment
and configure STEP7 program. Preparing STEP7 software environment is required to be made
initially before configuring this module in IDB if you wish to perform data transfer between to
and from the PLC.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 391
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Using STEP7 and preparing for the environment
For more information on using STEP7 and creating data blocks, please refer "STEP7 Professional
V12 Information System ".
One of the main prerequisite is to create same memory allocation for different variables in
IDB consumer as it has been done in STEP7 project (for PLC). The data types used in both
provider and consumer need to match in order to ensure a successful data transfer.
If the data type used in Send/Receive configuration has String data type, then the size of this
String data type should be the same or greater than the size of String data type defined in
STEP7 project.
Objective
To create a project with corresponding link having Send/Receive as provider and configure the
respective provider/consumer connection properties along with transfer behaviour settings.
WinCC/IndustrialDataBridge
392 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Creating a link
1. Open IDB Configuration and create a project by following the steps mentioned below:
– In IDB Configuration menu, select "Project" > "New project" to create a new project.
– In the "Create new project" dialog box, specify a project name, click [...] button and select
the folder location wherever the project needs to be saved.
– After entering the required information, select "Create" button. This creates a new project.
2. The project name will be listed within the "Project tree". The next step is to create a link.
Follow the steps mentioned below to create a link between provider and consumer:
– Right click on project name node in the tree structure and select "Add new link" option or
else double click the "Add new link" node below the project name node within project tree.
– In the "Add new link" dialog that is displayed, enter a unique link name.
– Select the provider type as Send/Receive, consumer type as OPC Data Access and click OK
button.
– The created link will be displayed below the project name in project tree.
– The corresponding entries - Provider, Consumer, Settings and Connections are created as
nodes that exist below the new link in the tree structure.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 393
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. In project tree, open the Provider configuration window by double clicking the Provider node.
The Provider configuration window includes several fields that help you to configure the Send/
Receive connection type.
Note
More Information
Information about configuring the Send/Receive connection type and the related options are
provided in chapter "Configuring the Different Types of Connections".
4. Next, double click the Consumer node in project tree to open the consumer configuration
window. In consumer configuration window, perform the following settings:
WinCC/IndustrialDataBridge
394 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Node name
For local OPC Server, the node name will display as "local host". In case of remote OPC Server,
the remote computer name will be displayed after selection of OPC Server on the remote
computer. This node name is required for searching the OPC Server from the remote
computer.
The OPC tag browser does not display any content if node name is invalid.
Note
The "OPC Server" and "Node name" fields are provided as editable fields. If the information
about OPC Server name and node name is known, you can directly enter the information in
the "OPC Server" and "Node name" fields. If the node name / OPC Server name is invalid, there
will be no content displayed within the OPC tag browser
"Configuration for bad quality item" section
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 395
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– In the "Configure a Variable for number of transaction errors" field, click on [...] button and
select a tag from the OPC tag browser.
Next, click the button representing "tick mark" to accept the changes. The amount of tags
with errors is written with QUALITY=BAD.
– Choose the specific data type by selecting from the drop down list box.
Note
OPC tags
Selection of the tag in OPC tag browser displays the corresponding data type in "Data type"
field. However, if you remember the name of tag, enter the tag name and data type in the
respective fields within "Configuration for bad quality item" section.
"Asynchronous transfer configuration" section
– Enable the check box option "Write asynchronous" for asynchronous writing.
– Enter the permitted number of maximum outstanding write transactions in the text box.
Note
Asynchronous transfer
If the "Write asynchronous" check box is enabled, a default value of 10 is set and will be
displayed within the "Maximum number of outstanding write transaction" text box. When
this check box is disabled, the value will be reset to 0. You can type a value in this text box
ranging from 1 - 40.
If the value entered in this text box is not within the range, then an error message is displayed.
Note
Asynchronous writing
The Asynchronous transfer configuration is useful to ensure the correctness of the actual
data transfer that is happening.
Example: If you have configured the "Maximum number of outstanding write transaction" as
15 and if the data transfer is not happening correctly, after the failure of 15th transaction, a
warning message will be displayed in the IDB Runtime Trace view.
WinCC/IndustrialDataBridge
396 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
2. Within the Transfer options tab, you can configure the transfer behavior settings for Send/
Receive as provider.
Enter a time period in the "Update rate" field after which the system checks for whether data
is to be transferred.
Note
Update rate
For better performance, it is recommended to use an update rate of 1000 ms or 1 sec.
The update rate also depends on the response time of the PLC.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 397
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Saving Changes
A save operation is not required every time whenever changes are performed within the editor
window in the work area. The changes made to these settings are automatically saved. However,
once the project is created, at any point of time, you can save the project by selecting the
"Project" > "Save" menu option.
Results
You have created a connection between the Send/Receive interface and OPC Data Access as a
consumer. These elements are displayed in the tree structure of the IDB configuration interface.
In order to transfer data, connect the provider and consumer tags, as described in chapter
"Connecting Tags from a Send/Receive Interface".
WinCC/IndustrialDataBridge
398 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
General
In the "General" section area, select a protocol type, the data length in bytes and the type of
connection establishment.
The following protocol types are available for selection:
• ISO on TCP
• TCP native
• UDP
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 399
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Connection watchdog
In the "Connection watchdog" section, define the following parameters in the fields:
• Watchdog cycle time: This refers to the time after which a ping will be set to check for
whether the connection to the partner station still exists. Depending on the network load,
you should select the monitoring cycle larger (with higher network load) or smaller. This unit
needs to be specified in ms.
• Timeout: Maximum response time for a ping before an error is indicated. This unit need to be
specified in ms.
Addresses
In the "Addresses" section, enter the connection data for the partner station in the
"Addresses" field:
• IndustrialDataBridge IP address: Enter the IP address of the partner station.
The "IndustrialDataBridge IP address" must be configured if the computer has multiple
network cards or IP addresses. Otherwise, select the "IndustrialDataBridge Default IP address"
selection box.
• PLC IP address: Enter the IP address of PLC device.
ISO on TCP
IndustrialDataBridge Port:
1. Type the data length in bytes as same as the User Program of Step 7 PLC.
2. Type the IP address of the CP Card CP1613/CP1623 in the IndustrialDataBridge IP address.
(e.g. 192.168.1.95)
3. Type the IP addess of the CP Card CP443-1/CP343-1 in the PLC IP address. (e.g. 192.168.1.81)
4. Type the TSAP ID in TSAP IndustrialDataBridge in ASCII format with a length from 1 to 16
bytes. (e.g. "TCP-1")
5. Type the TSAP ID in TSAP PLC in ASCII format with a length from 1 to 16 bytes. (e.g. "TCP-1")
6. Enter the consumer details in connection mapping tab of the settings window and map the
connection.
7. Save the Project and export the IDB configured XML.
PLC Port:
Information about configuring PLC port for ISO on TCP Protocoal is provided in the chapter
Configuring the PLC for ISO on TCP Protocoal (Page 402).
TCP native
IndustrialDataBridge Port: Enter the IDB port number. You should set the value for port in the
range 2000 to 65534.
PLC Port: Enter the PLC port number. You should set the value for port in the range 2000 to
65534.
WinCC/IndustrialDataBridge
400 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
UDP
IndustrialDataBridge Port: Enter the IDB port number. You should set the value for the port in
a range between 2000 to 65534.
PLC Port: Enter the PLC port number. You should set the value for port in the range 2000 to
65534.
If you select the selection box "Program-controlled addressing" you can create a free UDP
connection. IP address and port for partner station no longer have to be configured but are
read from the connection data area. This way, you can change dynamically during runtime.
Free UDP connections require a job header in the data area of the connection.
The following graphic shows the structure of the data area and the meaning and positioning
of the parameters in the job header.
'DWDDUHD
,3DGGUHVV
8VHUGDWD
'DWDE\WH 'DWDE\WH
'DWDE\WH
The picture shows a good example based on the following IP address: 192.168.1.100
For port address 2000, for example, the following must be entered: For the high byte: 7Hex
(= 7Dec); for the low byte: D0Hex (= 208Dec)
Note
Occupied Port
With the "TCP native" connection type, the port that should be used might possibly be occupied
on the active side.
In this case, set the IndustrialDataBridge port to "0" with an active connection.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 401
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Objective
For a ISO on TCP protocol in a project, the PLC must be configured to establish the connection
between the IDB and PLC.
3/& ,'%&RQILJXUDWLRQ
&3&DUG
&3&DUG
&3&DUG
&3&DUG
63/& ,QGXVWULDO
RU 6HQG5HFLHYH 'DWD%ULGJH &RQVXPHU
RU
RU
,'%&RQILJXUDWLRQ 3/&
&3&DUG
&3&DUG
&3&DUG
&3&DUG
,QGXVWULDO 63/&
3URYLGHU 'DWD%ULGJH 6HQG5HFLHYH RU
RU
RU
,'% &RQVXPHU 63/&
WinCC/IndustrialDataBridge
402 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
2. Use CP Card CP-443-1 or CP Card CP-1613 to establish data transfer between PLC and IDB for
ISO-on-TCP protocoal.
3. Use SIMATIC NET PC Software for CP card drivers.
4. Use the access point for Set PG/PC application as CP1613.RFC1006.1.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 403
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Connecting Tags
In "Settings" window, click on "Connection mapping" tab to connect tags that have been sent
from Send/Receive interface with the selected data consumer. The Connection mapping tab
divides the window into the following 3 sections:
• Send/Receive provider
• OPC Data Access consumer
• Connection mapping settings
The "Send/Receive provider" section is displayed at top left portion of the "Connection
mapping" tab. This section provides you with required options to choose
The "OPC Data Access consumer" is displayed to the left bottom portion of this tab.
Follow the steps given below to connect tags from a Send/Receive interface to OPC Data
Access.
WinCC/IndustrialDataBridge
404 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
1. In "Send/Receive" provider section, enter the start point of the tag in the "First byte" field. You
have already entered the data length of the tags in "Send/Receive provider configuration"
window.
The information regarding the fields contained within Send/Receive provider configuration is
described in Chapter 3.10.4 "Configuring the Different Types of Connections".
2. Select the respective data type in the "Requested data type" field.
Note
Interpret data
The "Interpret as" field will allow selection only if one of the data types Binary String
(VT_BSTR) or Date (VT_Date) is selected in "Requested data type field.
3. If you have selected one of the data types Binary String (VT_BSTR) or Date (VT_Date), specify
how the incoming data should be interpreted as well:
– Data that is transferred from the data provider as an S7 string or as a byte string is
converted to data type VT_BSTR.
– Data that is transferred from the data provider as an S7_Date_and_Time string is
converted to data type VT_DATE.
4. If you have selected "OLE/Binary Automation string" as data type in "Requested data type"
field, the "Number" field is available for entering a valid number.
Enter a valid number in "Number" field. The permitted range that can be entered within the
"Number" text box is any value between 1 to 8192.
5. Configure the consumer tag in the "OPC Data Access consumer" section (bottom left) by
following these steps:
– Select a consumer tag from the OPC tag browser in the "OPC Data Access consumer"
section.
– The Tag ID and Data type is automatically shown based on selection of OPC tag within the
tag browser.
6. Check the name of the connection in the "Connection mapping settings" area (right). Enter
a unique name for the connection in the "Connection name" field or use the options within
"Default name options". Click "Connect" button to confirm your entries.
7. Repeat steps 2 to 6 for all elements of the data provider that you wish to transfer.
Note
BLOB as new data type
If database of type Oracle or MySQL or SQL Server is used as consumer with Send/Receive as
provider, in connecting mapping tab, you can select the BLOB data type within the consumer
section area. The size of BLOB need to be mentioned in Number field.
As PLC do not support BLOB data type, during Step7 project creation, it is required to select string
or character array as data type. In IDB configuration, this can data can be mapped with BLOB type
field in Database consumer section area.The size of data depends on supported size of data types
provided in Step7 project.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 405
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
The transaction type "Prepared insert statement" and "Stored procedure" is not supported for
BLOB data.
Note
Array
• If the provider tag has a data type of array data type and if the consumer column has data type
other than array data type, after clicking on the Connect buton, the "Array" check box in the
"OPC Data Access consumer" is automatically unchecked.
• If the Send/Receive provider column has a data type other than array data type and if the OPC
Data Access consumer tag has array data type, after clicking on the Connect buton, the
"Array" check box in the "OPC Data Access consumer" is automatically checked.
Results
The connections that you have created are shown in the "Connections" tab of IDB CS "Settings"
window as well as within the project tree node.
Objective
To create a project with corresponding link having Send/Receive as consumer and configure the
respective provider/consumer configuration along with transfer behaviour settings.
WinCC/IndustrialDataBridge
406 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Creating a link
1. Open IDB Configuration and create a project by following the steps mentioned below:
– In IDB Configuration menu bar, select "Project" > "New project" to create a new project.
– In the "Create new project" dialog box, specify a project name, click [...] button and select
the folder location wherever the project needs to be saved.
– After entering the required information, select "Create" button. This creates a new project.
2. The project name will be listed within the "Project tree". The next step is to create a link.
Follow the steps mentioned below to create a link between provider and consumer:
– Right click on project name node in the tree structure and select "Add new link" option or
else double click the "Add new link" node below the project name node within project tree.
– In the "Add new link" dialog that is displayed, enter a unique link name.
– Select the provider type as OPC Data Access, consumer type as Send/Receive and click OK
button.
– The created link will be displayed below the project name in project tree.
– The corresponding entries - Provider, Consumer, Settings and Connections are created as
nodes that exist below the new link in the tree structure.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 407
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. In project tree, open the Provider configuration window by double clicking the Provider node.
WinCC/IndustrialDataBridge
408 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
More Information
Information about configuring the Send/Receive connection type and the related options are
provided in Chapter 3.10.4 "Configuring the Different Types of Connections".
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 409
WinCC/IndustrialDataBridge Documentation
4.3 Modules
2. Within the Transfer options tab, you can configure the transfer behavior settings for provider.
Enter a time period in the "Update rate" field after which the system checks for whether data
is to be transferred.
Note
Update rate
For better performance, it is recommended to use an update rate of 1000 ms or 1 sec.
The update rate also depends on the response time of the PLC.
WinCC/IndustrialDataBridge
410 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Deadband
All OPC Servers do not support deadband. This is dependent on the OPC Server being
used. The "Deadband value (%)" text box is enabled only with the data transfer types -
"Send only changed values" and "Send always all values". This text box is disabled while
you select the transfer type "Send values using trigger".
4. Enter the deadband value (in percent) to contain a value within the range 0 - 100.
5. In "Item for Transaction Security" field, click [...] button and select a tag of OPC Server from
the OPC tag browser.
You can define an OPC tag on an OPC server, in which the success-/failure-status of the data
transfer will be stored in the "Item for transaction security" field.This value should have 1 byte
signed char (e.g. VT_I1). -1 indicates the success state and 0 indicates failure.
6. If you have selected the option "Send values using trigger", you can configure the trigger that
provides options to set the trigger options. The "Trigger settings" section is enabled only with
the data transfer type "Send values using trigger".
Perform the following settings in the "Trigger settings" section:
– In "Trigger tag" field, select the tag that should trigger a data transfer. Click on [...] button
to select the tag from OPC tag browser.
– Select a valid data type by selecting from the drop down list.
– Enter a threshold at which a data transfer should be triggered, in the "Trigger value" field.
– In "Confirmation value" field, enter a value that the trigger tag should take on after
triggering.
The confirmation value does not give any information on whether a transaction has been
completed successfully.
7. The transfer behavior settings for OPC DataAccess as provider will be saved automatically.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 411
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Saving Changes
A save operation is not required every time whenever changes are performed within the editor
window in the work area. The changes made to these settings are automatically saved. However,
once the project is created, at any point of time, you can save the project by selecting the
"Project" > "Save" menu option.
Results
You have created a connection between the OPC Data Access interface and Send/Receive as a
consumer. These elements are displayed in the tree structure of the IDB configuration interface.
In order to transfer data, connect the provider and consumer tags, as described in chapter
"Connecting Tags to a Send/Receive".
Connecting Tags
In "Settings" window, click on "Connection Mapping" tab to connect tags that have been sent
from selected data provider with the Send/Receive interface. The Connection mapping tab
divides the window into the following 3 sections:
• OPC Data Access provider
• Send/Receive consumer
• Connection mapping settings
WinCC/IndustrialDataBridge
412 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
The "OPC Data Access provider" is displayed to the top left portion of this tab. The "Send/
Receive consumer" section is displayed at bottom left portion of the "Connection mapping"
tab.
Follow the steps given below to connect tags from OPC Data Access to Send/Receive
interface.
1. In "OPC Data Access provider" area, navigate to OPC tag browser and select an OPC tag.
2. The Tag ID and data type is automatically shown based on selection of OPC tag.
3. In "Send/Receive consumer" area (bottom left), enter the start point of the tag in the "First
byte" field.
4. Select the respective data type in the "Requested data type" field.
Note
Interpret data
The "Interpret as" field will allow selection only if one of the data types Binary String
(VT_BSTR) or Date (VT_Date) is selected in "Requested data type field.
5. If you have selected one of the data types Binary String (VT_BSTR) or Date (VT_Date), specify
how the incoming data should be interpreted as well:
– Data that is transferred from the data provider as an S7 string or as a byte string is
converted to data type VT_BSTR.
– Data that is transferred from the data provider as an S7_Date_and_Time string is
converted to data type VT_DATE.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 413
WinCC/IndustrialDataBridge Documentation
4.3 Modules
6. If you have selected "OLE/Binary Automation string" as data type in "Requested data type"
field, the "Number" field is available for entering a valid number.
Enter a valid number in "Number" field. The permitted range that can be entered within the
"Number" text box is any value between 1 to 8192.
7. Check the name of the connection in the "Connection mapping settings" area (right). Enter
a unique name for the connection in the "Connection name" field or use the options within
"Default name options". Click "Connect" button to confirm your entries.
8. Repeat steps 1 to 7 for all elements of the data source that you wish to transfer.
Note
BLOB as new data type
If database of type Oracle or MySQL or SQL Server is used as provider with Send/Receive as
consumer, in connecting mapping tab, you can select the BLOB data type within the provider
section area. The size of BLOB need to be mentioned in Number field.
As PLC do not support BLOB data type, during Step7 project creation, it is required to select string
or character array as data type. In IDB configuration, this can data can be mapped with BLOB type
field in Database provider section area.The size of data depends on supported size of data types
provided in Step7 project.
Note
The transaction type "Prepared insert statement" and "Stored procedure" is not supported for
BLOB data.
Note
Array
• If the provider tag has a data type of array data type and if the consumer column has data type
other than array data type, after clicking on the Connect buton, the "Array" check box in the
"OPC Data Access provider" is automatically unchecked.
• If the OPC Data Access provider column has a data type other than array data type and if the
Send/Receive consumer tag has array data type, after clicking on the Connect buton, the
"Array" check box in the "Send/Receive consumer" is automatically checked.
Results
The connections that you have created are shown in the "Connections" tab of IDB CS "Settings"
window as well as within the project tree node.
WinCC/IndustrialDataBridge
414 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
4.3.11.1 Overview
Introduction
The "WinCC User Archive" module enables read and write access to the archive database of the
WinCC project. The functionality is similar to the module for dynamic databases. As a consumer,
there is also the possibility of deleting data in a WinCC User Archive.
Note
Important Notes for Configuring the Different Databases
• For access to an MS SQL Server and MS Access, the Microsoft Data Access Components 2.8
(MDAC 2.8) must be installed (http://www.microsoft.com/data/).
• Using data type VT_I8 as a trigger tag (values transferred upon event) in the database
provider is not approved.
• The character "?" (VT_BSTR) cannot be written in a field with field data type "char" or "varchar"
with the SQL server (in the Runtime interface, a respective error message is output).
• The time stamp must be assigned before connecting the first tags. Afterwards, adding or
changing the time stamp is only possible if all items are deleted, the dialog is closed and
reopened again. The time stamp is generated from the local time, if new data is transferred
from the provider.
• A table name is not to contain any spaces, otherwise problems can occur in the transfer.
Note
WinCC User Archive as a remote provider or consumer
If WinCC and IDB are installed in different systems, IDB does not support WinCC User Archive as
a remote provider or consumer.
Objective
To create a project with corresponding link having WinCC User Archive as provider and
configure the respective provider/consumer connection configuration along with transfer
behavior settings.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 415
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Creating a link
1. Open IDB Configuration and create a project by following the steps mentioned below:
– In IDB Configuration menu, select "Project" > "New project" to create a new project.
– In the "Create new project" dialog box, specify a project name, click [...] button and select
the folder location wherever the project needs to be saved.
– After entering the required information, select "Create" button. This creates a new project.
2. The project name will be listed within the "Project tree". The next step is to create a link.
Follow the steps mentioned below to create a link between provider and consumer:
– Right click on project name node in the tree structure and select "Add new link" option or
else double click the "Add new link" node below the project name node within project tree.
– In the "Add new link" dialog that is displayed, enter a unique link name.
– Select the provider type as WinCC User Archive, consumer type as Database and click OK
button.
– The created link will be displayed below the project name in project tree.
– The corresponding entries - Provider, Consumer, Settings and Connections are created as
nodes that exist below the new link in the tree structure.
WinCC/IndustrialDataBridge
416 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. In project tree, open the Provider configuration window by double clicking the Provider node.
Note
Connection string
In "WinCC User Archive provider configuration" window, the "Connection string" field (at top
portion) displays the database connection string parameters after the selection of database
type.
In WinCC User Archive provider configuration window, perform the following settings:
– Enter the server name and/or complete path of WinCC User Archive database.
– Select the database name from the list that is displayed in the "Database" field. Click on the
drop down list box to view this list.
– If you wish to enable windows authentication automatically, select the check box "Use
automatic Windows authentication".
– Within the section area that provides options to logon to the database, enter the user
name and password.
This information is required to logon to the WinCC User Archive database.
– Click Test button to test the connection.
Note
User Archive
Ensure that you enter the complete path of the computer wherever WinCC has been
installed. If the path name is not valid, then the "Database" field will not display any tables.
Also, it is important to verify that the user archive table contains one or more rows of data.
4. Next, double click the Consumer node in project tree. In Consumer configuration window,
perform the following settings:
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 417
WinCC/IndustrialDataBridge Documentation
4.3 Modules
WinCC/IndustrialDataBridge
418 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– In "Database" field, click on [...] button and select the database from the list or from the
folder structure.
Note
Please note the following points:
• The "Server" field text box and "Use automatic Windows authentication" check box is
in disable state if you use "Microsoft Access" as the database.
• The "Use automatic Windows authentication" check box is in disable state if you have
used any database other than "Microsoft SQL Server".
• The option to select the check box "Use automatic Windows authentication" is
provided only for "Microsoft SQL Server" database.
• If you use "Oracle" as the database, it is important to note that the "Database" field list
box will be in disable state.
– If a user name and password has been set for the database, enter the user name and
password in the "User name" and "Password" fields respectively.
If you wish to set a blank password, enable the check box "Blank password". To save the
entered password, enable the check box "Allow saving password".
– Click Test button to test the connection. The application tests the database connection
string and verifies the selected database.
"Consumer type configuration" section
– Select the "Consumer type" by selecting from the list. More information about the
consumer types are provided in detail in chapter 3.6.7, "Consumer Types".
– Choose the "Transaction type" - Stored procedure or Prepared insert statement and select
table name and schema.
Note
Transaction type
The Stored procedure or Prepared insert statement transaction type options are in enable
state only when the consumer type "One data record per call - command set" is selected and
if you have selected a database other than Microsoft access. By default, the Prepared insert
statement option is automatically selected.
• Only the "Table" field is enabled if Microsoft access is selected as the database type and
consumer type is selected as "One data record per call - command set". Select the table
name by clicking on the drop down list box.
• If you have selected a database type other than Microsoft access and the consumer type
is selected as "One data record per call - command set", then all the fields within the
Transaction type will be in enable state.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 419
WinCC/IndustrialDataBridge Documentation
4.3 Modules
2. Within the Transfer options tab, you can configure the transfer behavior settings for provider.
– Select the Schema, if applicable and choose the Table name by selecting from the drop
down list.
Note
Schema
• A default schema is selected automatically in the Transfer options tab.
3. Click "Event" button to configure the trigger provider settings. The "Trigger provider" will be
opened.
The description of the "Trigger provider" is provided in chapter "Configuring a Trigger"
4. The transfer behavior settings for provider will be saved automatically.
Note
Saving changes
A save operation is not required every time whenever changes are performed within the editor
window in the work area. The changes made to these settings are automatically saved. However,
once the project is created, at any point of time, you can save the project by selecting the
"Project" > "Save" menu option.
WinCC/IndustrialDataBridge
420 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Results
You have configured the WinCC User Archive interface and a consumer including the provider
transfer options. These elements are displayed in the tree structure of the IDB configuration
interface. In order to transfer data, connect the provider and consumer tags, as described in
chapter "Connecting Tags from the WinCC User Archives Interface".
Introduction
The "Trigger Provider" dialog window provides the OPC settings, Trigger configuration options
and required fields that help you to configure the condition that triggers a data transfer. This
dialog window is opened after clicking the "Trigger" button in Transfer options window.
Note
OPC tag browser
The OPC tags within "Trigger configuration" section will only be displayed if you have already
selected the name of the OPC Server.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 421
WinCC/IndustrialDataBridge Documentation
4.3 Modules
WinCC/IndustrialDataBridge
422 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Procedure
1. In "OPC settings" area, select the OPC server by clicking on the [...] button. The selection of
the server is supported by an OPC tag browser. Next, click the button representing "tick mark"
to accept the changes.
2. The "Node name" is automatically displayed in "Node name" text box after selection of the
OPC Server.
Note
Node name
For local OPC Server, the node name will display as "local host". In case of remote OPC Server,
the remote computer name will be displayed after selection of OPC Server on the remote
computer. This "Node name" is required for searching the OPC Server from the remote
computer.
The OPC tag browser does not display any content if node name is invalid.
Note
The "OPC Server" and "Node name" fields are provided as editable fields.
If the information about OPC Server name and node name is known, you can directly enter
the information in the "OPC Server" and "Node name" fields. If the node name / OPC Server
name is invalid, there will be no content displayed within the OPC tag browser.
3. You can define an OPC tag on the trigger provider, in which the success-/failure-status of the
data transfer will be stored in the "Tag for transaction security" field. This value should have
1 byte signed char (e.g. VT_I1). -1 indicates the success state and 0 indicates failure.
Select the tag of the OPC server, in which this information is to be saved in the tag browser
and click on the "Apply item" button.
4. The tree structure of OPC server is displayed within "Trigger Configuration" area.
5. In "Trigger Configuration" area, select the desired tags individually and accept them by
clicking on "Add item" each time.
The selected tags are shown in the table below the tag browser that displays the tag list.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 423
WinCC/IndustrialDataBridge Documentation
4.3 Modules
6. Use the "Remove item" button to remove the marked item. If no item is marked for deletion,
the last item from the list is deleted if you click the "Remove item" button. Details about the
columns in the Tag list are located in section "Tag declaration".
Note
OPC Server
After selection of the tags and adding them to tag list, if you switch to another OPC Server in
OPC Settings area, a dialog window is displayed that prompts the message whether you wish
to discard previous settings.
7. In "Trigger condition" area, you can select the type of syntax with selection button "VB Style"
or JScript Style". If a trigger condition is already created, this setting can no longer be
changed. If the language is to be changed, the text in the "Configure Trigger Condition" field
must be deleted.
Details on the programming languages are located in section "Programming Languages".
8. Create the trigger condition in the selected language. Use the Alias designations in the tag
list for these tags. Within the text box displayed, enter the operator symbols using the
keyboard or select them from the "Logical patterns" list box.
9. Test the created condition by clicking on "Validate". The trigger condition is calculated with
the values that are entered in the "Test value" column. The result "TRUE" or "FALSE" is shown
in a message box.
10.If the trigger condition provides the correct result and after confirming the changes, close the
dialog by clicking on "OK" button.
Additional Information
Tag declaration
The columns for the tag declaration contain the following:
• Data type: Data type of the tag. If the data type defined here does not match that on the
server, an attempt to convert the data type is made.
• TagID: The TagID of the tag on the OPC server
• Alias: The alias is used for creating the trigger condition. This name must be unique and it
must correspond with the naming conventions of the allocated programming languages. For
more detailed information about the naming conventions, see paragraph "Valid alias names".
• Confirmation value: The confirmation value is the value that the variable takes on after
fulfilling the trigger condition and the values have been delivered to the consumer. The
default value is "<Empty>", i.e., no confirmation value is written.
• Test value: This value is only for testing the trigger condition and has no influence on the later
data exchange. The test values are to be selected and changed so that they test whether the
trigger condition delivers the expected result in all operating conditions.
WinCC/IndustrialDataBridge
424 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Confirmation value
The confirmation value does not give any information on whether a transaction has been
completed successfully.
Note
Necessity of Alias Names
The OPC TagID is not used because it may possibly not correspond with the tag validity criteria,
for instance, a "Point" in the tag name is not allowed.
Programming languages
You can use VBScript or JScript for the trigger condition.
The following table shows the operator type and their symbols in both languages:
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 425
WinCC/IndustrialDataBridge Documentation
4.3 Modules
It is recommended to use these operators only. Other operators can be found in the language
descriptions for the respective language.
Note
Loss of Trigger Events
The triggering depends on the update speed of the OPC server. In this case, note that data
changes that occur within an update cycle are not considered by the trigger. That means that a
faster change of a tag from 1 - 0 - 1 is not necessarily indicated to the trigger provider by the OPC
server, since the 1 exists at the end again and no value change exists at the check time. This
means that a potentially true condition is not recognized as being true and therefore will not lead
to a data transfer.
Configurations, with which the confirmation value is to set a "true" trigger condition to "false"
again, are not secure because of the statement above. When data changes occur too quickly, the
"true value" may stay the same or values can be left out.
Connecting Tags
In "Settings" window, the "Connection mapping" tab includes the required fields to connect tags
that have been sent from the WinCC User Archives interface with the selected consumer. The
Connection mapping tab divides the window into 3 sections
• WinCC User Archive Provider
• Database consumer
• Connection mapping settings
WinCC/IndustrialDataBridge
426 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
The "WinCC User Archive provider" section is displayed at top left portion of "Connection
mapping" tab. This section provides you with required options to choose schema, table
name and column names to be mapped. The "Database consumer" section exists below the
provider section and lists the column values that can be mapped with the columns existing
within WinCC User Archive database.
Note
Consumer types
The fields displayed within "Database consumer" section depends on the "Consumer type" that
you have selected in Consumer configuration window. In this case, the consumer type "One data
record per call - recordset" is used.
The separator between the provider and consumer section provides a resize handle that
helps you to resize the height of the section in order to view the fields within the section
clearly.
The "Connection mapping settings" section is displayed at right side of "Connection mapping"
tab. This section helps you to provide a name for connection along with options for choosing
default name for connection. The "Connect", "Modify connection", "Delete connection" and
"Delete all connections" icons are provided at the top portion of this section.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 427
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Connection Mapping tab
To get a clear view of all fields in the sections within the "Connection mapping" tab, it is
suggested to use the "Collapse" option within the Inspector window and Project tree. Once you
click on "Collapse" icon, the window minimizes and provides with "Expand" option. At any point
of time, to bring back the window, click on "Expand" icon.
Note
Select OPC server
In order to configure the settings on the "Where Statement" tab, you must have selected an OPC
server in the dialog "Config Trigger Provider". This dialog window is accessed by clicking on the
"Event" button in "Transfer options" tab.
WinCC/IndustrialDataBridge
428 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
4. Next, configure the consumer column in the "Config database consumer" section by
following these steps:
– The selected table is shown in the "Table" field. Select the Schema for database if
applicable by selecting from the drop down list in "Schema" field.
– The column names are displayed within "Columns" area. If the table has columns with
respective data types, the time stamp can also be written to the table. In this case, select
the respective "Active" check box and select the column within "Column for timestamp"
field.
5. Select the Column name in "Database consumer" that you wish to connect with "WinCC User
Archive Provider" column name. The data type of selected column will be automatically
displayed in the "Datatype" field.
The selected column is displayed in "Column for data value" field.
Note
Data type conversion
If the provider tag data type does not match with consumer column, IDB CS converts the data
type to match with data type of provider tag. A status window is displayed to indicate this
change.
6. Check the name of the connection in the "Connection mapping settings" area to the right.
Enter a unique name for the connection in the "Connection name" field or use the options
within "Default name options". Click "Connect" button to confirm your entries.
7. Repeat steps 1 to 5 for all elements of the "WinCC User Archive Provider" that you wish to
transfer.
8. The connection name including the provider and consumer data values will be displayed
within the "Connection mapping settings" section.The list of connections will be also
displayed within the Connections tab as well as in the project tree within the "Connections"
node belonging to the specific link.
Note
Modifying Consumer type
Once the connection(s) have been created in Connection mapping window and if you wish to
modify the Consumer type in Database consumer configuration, the IDB CS application will not
allow to change the Consumer type. To change the Consumer type, you need to delete the
connection(s) that have been already created. Close the consumer configuration window and re-
open the window from the project tree to modify the consumer type.
Where Statement
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 429
WinCC/IndustrialDataBridge Documentation
4.3 Modules
The SQL String that describes the access location for reading the data is shown on this tab.
The "Where-statement" tab mainly includes the "WHERE" section and text area for displaying
the "Resulting SQL-String".
Follow the steps given below to configure the Where statement:
WinCC/IndustrialDataBridge
430 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
1. Click "Add" button to open the dialog that provides you with options to select the column in
order to compare the content.
2. Select the Fieldname you wish to check for a certain value. The selected field name is
displayed in "Fieldname" field. The data type for this field name is automatically selected in
the "Datatype" field.
3. This "Fieldname" is shown in the "WHERE" text box. Choose the operator symbol from the
drop down list that is used for comparision.
4. In "OPC-variable" section, select the OPC tag, the value of which is compared with the
previously selected column entry. Then, click OK button.
5. The condition is shown in the table within "Where" section and is entered in the "Resulting
SQL String" field.
6. To remove an already existing "Resulting SQL String", click "Remove" button.
7. To define multiple conditions, repeat steps 1 to 5.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 431
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
SQL String
• If multiple conditions are configured, they are connected with a logical "AND".
• Only data records (lines) are requested from the IDB and transferred in which all conditions
have been met.
• An optional connection is not possible with a logical "OR".
Advanced:
Using button "Advanced", you can define the sort sequence and the behavior when multiple
data records exist.
WinCC/IndustrialDataBridge
432 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
• Order By
Select the selection field. You can then define the column name and the sort direction.
• Behavior with several results:
Select one of the following option fields and click OK button. Based on selected radio button,
you can decide the action to be performed:
– Error message (no data transferred)
– Submit first line
– Submit last line
– Submit all lines
Results
The connections that you have created are shown in the "Connections" tab of IDB CS "Settings"
window as well as within the project tree node.
4.3.11.5 Connecting OPC Tags from the WinCC User Archives Interface
Connecting Tags
In "Connection mapping" tab, "WinCC User Archive Provider" section (displayed at top left
portion) includes the following 3 tabs:
• WinCC User Archive provider
• Where Statement
• OPC
This chapter covers the aspects related to OPC tab.
The "OPC" tab includes options to connect OPC tags that have been sent from the WinCC User
Archives interface with the selected data consumer.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 433
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Select OPC server
In order to configure the settings on the "OPC" tab, you must have selected an OPC server in
"Trigger provider" window." This dialog window is accessed by clicking on the "Event" button in
"Transfer options" tab.
1. In the "WinCC User Archive Provider" area, within the OPC tab, the OPC tag browser is
displayed. In tag browser, select the tag for which the values should be transferred. The
selected tag is shown in the "Tag ID" field. The data type is chosen according to the selection.
2. If the selected tag has Array data type, then the "Array" check box is automatically enabled.
This check box is provided below the "Datatype" field.
3. Next, configure the consumer column in the "Database consumer" section by following these
steps:
– The selected table is shown in the "Table" field. Select the Schema if applicable by
selecting from the drop down list in "Schema" text box.
– The column names are displayed within "Columns" area. If the table has columns with
respective data types, the time stamp can also be written to the table. In this case, select
the respective "Active" check box and select the column within "Column for timestamp"
field.
WinCC/IndustrialDataBridge
434 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
4. Select the Column name that you wish to connect with the OPC tag. The selected column is
displayed in "Column for data value" field.
5. Check the name of the connection in the "Connection mapping settings" area to the right.
Enter a unique name for the connection in the "Connection name" field or use the options
within "Default name options". Click "Connect" button to confirm your entries.
6. Repeat steps 1 to 5 for all elements of the "WinCC User Archive Provider" that you wish to
transfer.
7. The connection name including the provider and consumer data values will be displayed
within the "Connection mapping settings" section.The list of connections will be also
displayed within the Connections tab as well as in the project tree within the "Connections"
node belonging to the specific link.
Note
Array
If the provider tag has a data type of array data type and if the database consumer column has
data type other than array data type, after clicking on the Connect buton, the "Array" check box
in the "OPC tab" is automatically unchecked.
Results
The connections that you have created are shown in the "Connections" tab of IDB CS "Settings"
window as well as within the project tree node.
Objective
To create a project with corresponding link having WinCC User Archive as consumer and
configure the respective provider/consumer configuration along with transfer behaviour
settings.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 435
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Creating a link
1. Open IDB Configuration and create a project by following the steps mentioned below:
– In IDB Configuration menu, select "Project" > "New project" to create a new project.
– In the "Create new project" dialog box, specify a project name, click [...] button and select
the folder location wherever the project needs to be saved.
– After entering the required information, select "Create" button. This creates a new project.
2. The project name will be listed within the "Project tree". The next step is to create a link.
Follow the steps mentioned below to create a link between provider and consumer:
– Right click on project name node in the tree structure and select "Add new link" option or
else double click the "Add new link" node below the project name node within project tree.
– In the "Add new link" dialog that is displayed, enter a unique link name.
– Select the provider type as Database, consumer type as WinCC User Archive and click OK
button.
– The created link will be displayed below the project name in project tree.
– The corresponding entries - Provider, Consumer, Settings and Connections are created as
nodes that exist below the new link in the tree structure.
WinCC/IndustrialDataBridge
436 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. In project tree, open the Provider configuration window by double clicking the Provider node.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 437
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– If a user name and password has been set for the database, enter the user name and
password in the "User name" and "Password" fields respectively.
If you wish to set a blank password, enable the check box "Blank password". To save the
entered password, enable the check box "Allow saving password".
– Click Test button to test the connection. The application tests the database connection
string and verifies the selected database.
4. In project tree, open the Consumer configuration window by double clicking the Consumer
node.
In WinCC User Archive consumer configuration window, perform the following settings:
– Enter the server name and/or complete path of WinCC User Archive database.
– Select the database name from the list that is displayed in the "Database" field. Click on the
drop down list box to view this list.
– If you wish to enable windows authentication automatically, select the check box "Use
automatic windows authentication".
– Within the section area that provides options to logon to the database, enter the user
name and password.
This information is required to logon to the WinCC User Archive database.
– Click Test button to test the connection.
WinCC/IndustrialDataBridge
438 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
2. Within the Transfer options tab, you can configure the transfer behavior settings for provider.
"Provider settings" section
– Select the Schema, if applicable and choose the Table name by selecting from the drop
down list.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 439
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– Enter a time period in the "Update rate" field after which the system checks for whether
data is to be transferred.
Note
Selecting Schema
• If you are using a database other than Microsoft Access, selection of Schema
is mandatory before choosing the Table name.
• While using Microsoft Access as database, the "Schema" field is displayed in disable
state and does not allow any selection of Schema.
Note
Update rate
For better performance, it is recommended to use an update rate of 1000 ms or 1 sec.
WinCC/IndustrialDataBridge
440 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Saving changes
A save operation is not required every time whenever changes are performed within the editor
window in the work area. The changes made to these settings are automatically saved. However,
once the project is created, at any point of time, you can save the project by selecting the
"Project" > "Save" menu option.
Results
You have created a connection between the WinCC User Archives interface and a provider. These
elements are displayed in the tree structure of the IDB configuration interface. In order to
transfer data, connect the provider and consumer tags, as described in chapter "Connecting Tags
to a WinCC User Archives Interface".
Connecting Tags
In "Settings" window, the "Connection mapping" tab includes the required fields to connect tags
that have been sent from the selected data provider to WinCC User Archives interface. The
Connection mapping tab divides the window into 3 sections:
• Database provider
• WinCC User Archive Consumer
• Connection mapping settings
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 441
WinCC/IndustrialDataBridge Documentation
4.3 Modules
The "Database provider" section is displayed at top left portion of "Connection mapping" tab.
This section lists the column values that can be mapped with the columns existing within
WinCC User Archive database. The "WinCC User Archive Consumer" section is displayed to
bottom left portion of "Connection mapping" tab. This section provides you with required
options to choose schema, table name and column names to be mapped.
A specific connection can be created between the Database provider column and the column
(belonging to WinCC User Archive consumer) selected in the Where statement tab. You can
create a new connection or else modify an existing connection to apply Where statement on
the selected column.
The separator between the provider and consumer section provides a resize handle that
helps you to resize the height of the section in order to view the fields within the section
clearly.
The "Connection mapping settings" section is displayed at right side of "Connection mapping"
tab. This section helps you to provide a name for connection along with options for choosing
default name for connection. The "Connect", "Modify connection", "Delete connection" and
"Delete all connections" icons are provided at the top position of this section.
Note
Connection Mapping tab
To get a clear view of all fields in the sections within the "Connection mapping" tab, it is
suggested to use the "Collapse" option within the Inspector window and Project tree. Once you
click on "Collapse" icon, the window minimizes and provides with "Expand" option. At any point
of time, to bring back the window, click on "Expand" icon.
WinCC/IndustrialDataBridge
442 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
1. In "Database provider" section, the selected archive is shown in the "Table" field. Select the
Schema for database if applicable by selecting from the drop down list in "Schema" field.
2. The Column names are displayed within "Columns" area. Select a Column name from the list.
The selected column is displayed in "Column for data value" field. The data type is shown
automatically.
3. The "Filter" field provides you the option to filter the Column names based on single character
or first few characters of column name.
For example, if you wish to view the column names starting with "S", type this character in
"Filter" text box. All column names starting with "S" are displayed.
Note
WinCC User Archive consumer
The WinCC User Archive consumer consists of 3 tabs - WinCC User Archive consumer, Where-
Statement and Delete Settings.
This chapter covers the aspects related to "WinCC User Archive consumer" and "Where-
Statement" tabs.
4. Next, configure the column in the "WinCC User Archive consumer" tab by following these
steps:
– The selected table is shown in the "Table" field. Select the Schema for database if
applicable by selecting from the drop down list in "Schema" field.
– The column names are displayed within "Columns" area. If the table has columns with
respective data types, the time stamp can also be written to the table. In this case, select
the respective "Active" check box and select the column within "Column for timestamp"
field.
5. Select the Column name that you wish to connect with "Database provider". The selected
column is displayed in "Column for data value" field.
Note
Data type conversion
If the provider tag data type does not match with consumer column, IDB CS converts the data
type to match with data type of provider tag. A status window is displayed to indicate this
change.
6. Check the name of the connection in the "Connection mapping settings" area to the right.
Enter a unique name for the connection in the "Connection name" field or use the options
within "Default name options". Click "Connect" button to confirm your entries.
7. Repeat steps 1 to 6 for all elements of the "Database provider" that you wish to transfer.
8. The connection name including the provider and consumer data values will be displayed
within the "Connection mapping settings" section.The list of connections will be also
displayed within the Connections tab as well as in the project tree within the "Connections"
node belonging to the specific link.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 443
WinCC/IndustrialDataBridge Documentation
4.3 Modules
WinCC/IndustrialDataBridge
444 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
4. The behavior is defined in the "Exceptional handling" section if the selection of the consumer
row is not unique:
– Error Message: No consumer rows lines are overwritten and an error message is given as
an output in the trace view of IDB Runtime.
– Change all rows: All selected consumer rows are overwritten.
– Using the "Enable Insert" check box, you define the behavior if a line with the key (primary
key) does not exist. If the option is selected, a new line with the respective key is created.
Note
Simultaneous Utilization as Key and Consumer Column
In order to have more setting ability with the configuration, you can use a column as a key
column and as a consumer column simultaneously. Take note that this causes the data in
the database to be inconsistent and/or future access to the WinCC User Archive consumer
may result in errors.
5. Check the name of the connection in the "Connection mapping settings" area (right). Enter
a unique name for the connection in the "Connection name" field or use the options within
"Default name options". Click "Connect" button to confirm your entries.
Results
The connections that you have created are shown in the "Connections" tab of IDB CS "Settings"
window as well as within the project tree node.
4.3.11.8 Configuring the Deleting of Tags from the WinCC User Archive
Connecting Tags
In Connection mapping tab, the "WinCC User Archive consumer" section includes the following
3 tabs:
• WinCC User Archive consumer
• Where-Statement
• Delete settings
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 445
WinCC/IndustrialDataBridge Documentation
4.3 Modules
With "WinCC User Archive consumer", you are able to delete data records from the User
Archive. This requires connecting a provider column with a consumer column. If the delete
condition has been met, the data record of the consumer column is deleted from the user
archive. Delete has priority over "Insert" and "Update" actions.
Results
The connections that you have created are shown in the "Connections" tab of IDB CS "Settings"
window as well as within the project tree node.
WinCC/IndustrialDataBridge
446 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
4.3.12.1 Overview
Overview
The IndustrialDataBridge application provides support for writing data to an HTML file or Text
file or XML file using the Free Text Editor module. This module can be used only as a consumer
and works with all provider types. The Free Text Editor supports an individual layout format and
allows for free editable data transfer. The Free Text Editor module allows transfer of data with
the selected provider type.
The Free Text Editor consumer provides options to create or edit consumer tags within the
Free Text Editor consumer tab. Each consumer tag represents the data field that can be
mapped with provider data. The consumer tag is included within the HTML/XML start tag and
end tag if you have selected HTML/XML as the document type.
The Free Text Editor consumer provides options to insert or edit consumer tags and as well
preview them in a well-defined format and save the changes to the file. In Free Text Editor
consumer tab, you will be able to preview only if you have used HTML as the document type.
For Text document type, the preview option will be in disable state.
Free Text Editor as a consumer type is useful especially while there are requirements to
transfer the data to a mobile device that supports HTML content. To use this on a mobile
device, an additional web server is necessary.
Consider the following points in terms of the aspects of a Base file name and Output file
name:
• A Base file name is mandatory. This base file name cannot be modified.
Example: Let us consider the base file name as one.html. If you would like to have two.html
as the base file, then you need import one.html contents in Connection mapping tab and
then save the changes. Now, IDB CS will accept two.html as the base file with imported
contents.
• An Output file name is created based on the Base file name. However, the output file name
contents can be modified, if required.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 447
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Base filename & Output filename
A Base filename is used as a template containing the variables. The Output filename contains the
data from the executed data transfer.
4.3.12.2 Requirements
Prerequisites
The Free Text Editor as a consumer type includes a free editor that supports an individual layout
format. A default editor is provided that allows to preview or edit consumer tags, text strings as
well as create or edit the HTML/XML tags. If HTML/XML is used as the base file type, a basic
knowledge of HTML/XML is required.
Tag rules
The Tag rules are applicable for HTML, XML, and Text document types. For using the consumer
tag values or working with consumer tags while using Free Text Editor, the following rules need
to be followed:
• A consumer tag value need to be always prefixed and suffixed with an "@" symbol. Example:
@Item@
• A consumer tag value should not contain any extra white spaces between characters or
words used.
Note
Tags
In "HTML" and "Text" document types, consumer tags are used. The same naming convention is
followed in "XML" document type.
Note
Usage of special characters
The following special characters are not supported and should not be used within the consumer
tag names:
<, >, /, \, @
Valid tags: @Tag_name-01@, @xyz@
Invalid tags: @Tag name@, @Tag/Name@, @Tag<Name@, @demo@demo@
WinCC/IndustrialDataBridge
448 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Objective
To create a project with corresponding link having Free Text Editor as consumer and configure
the respective provider/consumer configuration along with "transfer options" settings.
Creating a link
1. Open IDB configuration and create a project by following the steps mentioned below:
– In IDB configuration menu bar, select "Project" > "New project" to create a new project.
– In the "Create a new project" dialog, specify a project name, click [...] button and select the
folder location wherever the project needs to be saved.
– After entering the required information, select "Create" button. This creates a new project.
2. The project name will be listed within the "Project tree". The next step is to create a link.
Follow the steps mentioned below to create a link:
– Right click on project name node in tree structure and select "Add new link" option or else
double click the "Add new link" node below the project name node within project tree.
– In the "Add new link" dialog, enter a unique link name.
– Select the provider type as Database, consumer type as Free Text Editor and click OK
button.
– The new link name will be displayed below the project name in project tree.
– The corresponding entries - Provider, Consumer, Settings and Connections are created as
nodes that exist below the new link in tree structure.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 449
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. In project tree, open the Provider configuration window by double clicking the Provider node.
In Provider configuration window, perform the following steps:
WinCC/IndustrialDataBridge
450 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– If a user name and password has been set for the database, enter the user name and
password in "User name" and "Password" fields respectively.
To set a blank password, enable the check "Blank password". To save the entered
password, enable check "Allow saving password".
– Click "Test" button to test the connection. The application tests the database connection
string and verifies the selected database.
4. Next, double cick the Consumer node in project tree.
– The HTML file name or Text file name or XML file name will be automatically displayed in
the "Base filename" text box.
If base file name is not specified, a roll-out tip with text message "Base file name is
mandatory" will be displayed. In this case, verify whether the file path includes a valid
HTML/Text/XML file.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 451
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– A new output file will be created by IDB runtime by adding a suffix "_Output" to the existing
base file name. This output file name will be automatically displayed in the "Output file
name" text box.
If output file name is not specified in the "Output filename" text box, the file will be created
during runtime.
However, if you wish, you can also enter a customized file name for the output file by
entering the file name within the "Output filename" text box.
Note
File selection
The fields listed within the "File Selection" section is same for "HTML", "XML", and "Text"
document types.
Base file can be of ANSI or UTF-8 format. The Output and Archive file format will be in UTF-8
format.
Note
Base file
Only the contents of the "Output file" will be modified during data transfer.
Options to import template file or export template file are provided in Free Text Eeditor
consumer section of connection mapping tab.
WinCC/IndustrialDataBridge
452 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
2. Within the Transfer options tab, you can configure the transfer settings for provider.
"Provider settings" section
– Select the Schema, if applicable and choose the Table name by selecting from the drop
down list.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 453
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– Enter a time period in the "Update rate" field after which the system checks for whether
data is to be transferred.
Note
Schema
Microsoft Access does not support schema functionality. Hence, you can observe that the
Schema field will be in disable state if you have chosen Microsoft Access as the database
type.
Note
Table name
If you are unable to view Table name in the "Table" field, check if Schema is selected in
"Schema" field. Without selecting the "Schema", the table name will not be displayed.
However, if you are using Microsoft Access as the database, this condition will not be
valid. If you are still unable to view the Table, please verify with the provider configuration.
Note
Update rate
For better performance, it is recommended to use an update rate of 1000 ms or 1 sec.
WinCC/IndustrialDataBridge
454 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
4. If you have selected the option "Send values using trigger", you can configure the trigger. The
"Trigger settings" section is enabled only if the data transfer type "Send values using trigger"
is selected.
Perform the following settings in the "Trigger settings" section:
– In the "Schema" field, choose a valid schema (if applicable) by selecting the drop down list.
– Choose a table name by selecting from the drop down list.
– In the "Column (first row)" field, select the specific column that needs to be used for the
trigger condition.
– Choose a valid data type by selecting from the drop down list.
– Enter a threshold at which a data transfer should be triggered, in the "Trigger value" field.
– In "Confirmation value" field, enter a value that the trigger should take on after triggering.
The confirmation value does not give any information whether a transaction has been
completed successfully.
5. The transfer options settings for provider will be saved automatically.
Note
Saving changes
A save operation is not required every time whenever changes are performed within the editor
window in work area. The changes made to these settings are automatically saved. However,
once the project is created, at any point of time, you can save the project by selecting the
"Project" > "Save" menu option.
Results
You have created a connection between the provider and Free Text Editor interface. These
elements are displayed in the tree structure of IDB configuration interface. In order to transfer
data, connect the provider and consumer tags, as described in chapter "Connecting Tags to a
Free Text Editor interface".
Connecting Tags
In "Settings" window, the "Connecting mapping" tab includes the required fields to connect data
column(s) that have been sent from the selected provider to Free Text Editor consumer. The
connection settings are performed by configuring the settings within the Connection mapping
tab.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 455
WinCC/IndustrialDataBridge Documentation
4.3 Modules
This tab displays the "Database provider" and "Free Text Editor consumer" on left hand
side whereas the right hand side of window contains Connection mapping settings and
connection options. The separator between the provider and consumer section provides a
resize handle that helps you to resize the height of section in order to view the fields within
the section clearly.
Database provider: The "Database provider" section is displayed at top left portion of
"Connection mapping" tab. This section displays the selected schema (if any) and table name
within "Schema" and "Table" fields along with the list of column names and their specific data
type. Any of these columns can be mapped with the HTML / Text / XML tag existing within
Free Text Editor consumer interface.
Free Text Editor consumer: The "Free Text Editor consumer" section is displayed below the
provider section and includes a window area for HTML / Text / XML editor that allows options
for selecting the HTML / Text / XML consumer tags. It consists of the following 2 tabs:
WinCC/IndustrialDataBridge
456 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
To enable performing necessary actions while working with the Free Text Editor consumer,
the following buttons are provided. The buttons along with their description is provided in
the table given below:
Button Description
Import a template file
Export as a template file
Save
Edit/Preview
The edit/preview button works in both the "edit" and "preview" mode. By default for first time,
you will be able to view the HTML / Text / XML consumer tags in edit mode. Clicking on the
edit/preview button changes the icon to be displayed with a rectangular box with blue border
filled with white color (key pressed state) thus indicating preview mode where as the icon
without any border or color around the icon indicates the edit mode.
Note
HTML / Text / XML consumer tags
In Free Text Editor consumer edit mode, the HTML / XML tags will be displayed if you have
selected "HTML" or "XML" as document type in consumer configuration window. If you have
selected "Text" as document type, you will be able to view text tags. Previewing of text tags is not
provided for Text document type. The preview works only for HTML / XML document type.
The following table displays the icon image in both states along with its description.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 457
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Icon Description
Edit mode
Preview mode
Edit: In edit mode, the editor allows you to edit HTML or Text or XML tags and then save the
changes to HTML / Text / XML document.
Preview: In preview mode, this window area displays the output of HTML / XML document.
Consumer settings
The "Consumer settings" tab includes options for file creation and archiving the files. These
settings allows to replace existing file or archive old files. It consists of the following section areas:
WinCC/IndustrialDataBridge
458 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
• Replace existing file: While this option is selected, the file creation is performed by replacing
the existing file each time. The file contents cannot be preserved and hence will be over
written.
• Archive old files: The "Archive old files" option performs an archive operation and hence
archives the file along with its contents by creating a new archive file. The archived files exists
within the archive folder.
Provider data
one.html one_output.html
one_output.html
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 459
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Let us consider the base file to be "one.html" with its output file "one_Output.html"
1. During Runtime data transfer, in first iteration, contents existing within "one.html" are copied
to "one_Output.html"
2. The "Replace existing file" option will replace "one_Output.html" with new contents.
The steps will be repeated consecutively and the contents within one_Output.html will be
replaced each time whenever this operation is performed.
In "Consumer settings' tab, if the option "Archive old files" is selected, then the following
series of actions occur:
Let us consider that the "Use serial number" option is selected for the archive file name
option. The archive file will be of the format: IDBTest2_000000001
WinCC/IndustrialDataBridge
460 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
one.html one_output.html
Archiving of file
Output file: Archive File:
Copy
py content
tent
one_output.html IDBTest2_000000001
1. While archiving files for first time, the contents of output file, for example: one_output.html
are copied to an archive file (IDBTest2_000000001) existing in a specific folder location (as
specified in the "Archive path")
Hence, the contents that were available in output file during first iteration are thus archived.
2. During second time, the similar process occurs. The contents of output file one_output.html
are copied to another archive file (IDBTest2_000000002) in same folder location.
Hence, the contents available in output file during second iteration are thus archived.
3. Similarly, the subsequent archive files
(IDBTest2_000000003.................................IDBTest2_999999999) are created and exists
within the same folder location.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 461
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Archiving files
• Whenever any changes to the content occurs, the contents are updated in the output file.
• Before the next change happens, contents in output file are copied to the archived file.
Important information
• The contents of the old files will be existing in archive file.
• The latest data transferred will be always contained within the output file.
Note
Managing old archives
Storing all the old archived files might consume a majority of the hard drive space. Hence, it is
required to keep track of the hard drive space usage used by these archive files over a period of
time.
It is strongly recommended to delete or remove unwanted or unnecessary old archives that are
not required.
1. The top portion of this section area contains the following three options. The selected option
will be used for file name generation with respect to the archive file. Select any one of the
options:
– Use current date and time
– Use current date and serial number
– Use serial number
2. The Archive path field allows to specify the default folder path for storing the archived files.
Click on [...] button, browse the respective folder and select OK button.
3. The "Use dedicated file name" check box allows for options to specify a dedicated file name
in combination with a serial number and date or date and time or serial number.
WinCC/IndustrialDataBridge
462 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Serial number
A range of 1 - 999999999 is supported for the serial number. During runtime, if the serial
number exceeds this maximum value, a trace log will be automatically created when this value
is reached. Once this upper limit is reached, IDB will not create any new archive file. The same
file will be updated continuously during data transfer.
Note
Archive path
If archive path is not specified in "Archive path" field, IDB will consider the base file path as archive
path.
Note
If the check box "Use dedicated file name " is unchecked, the "Archive file name" field will be in
disable state and the output file name will be used for archiving.
If the check box "Use dedicated file name" is checked and if "Archive file name" field is blank, then
the output file name will be used for archiving.
Connection mapping
To establish connection between the provider and consumer, a data column mapping is
required. Defining a connection name is the first step towards setting up a connection. The
Connection mapping tab includes the fields required for entering the connection name or for
selecting the default connection name. The "Connect", "Modify connection", "Delete
connection" and "Delete all connections" icons are provided at the top portion of Connection
mapping tab.
Follow the steps given below to perform column mapping between provider and consumer:
1. In "Database provider", the selected table is shown in "Table" field. Select the Schema for
database, if applicable by selecting from the drop down list in "Schema" field.
2. The Column names are displayed within "Columns" area. Select a Column name from the list.
The selected column will be displayed in "Column for data value" field. The data type is shown
automatically.
3. The "Filter" field provides you the option to filter Column names based on a single character or
first few characters of column name.
For example, if you wish to view the column names starting with "S", type this character in
"Filter" text box. All column names starting with "S" will be displayed.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 463
WinCC/IndustrialDataBridge Documentation
4.3 Modules
4. Configure the consumer tag in "Free Text Editor consumer" by following these steps:
– In "Free Text Editor consumer" tab, within the editor window area, double click the tag
beginning with @ and ending with @ symbol. Example: @one@
– The selected tag will be displayed in "Consumer tag" text box field. Click [...] button to
expand the dialog window that provides options to find and replace consumer tags.
– If any changes have been performed within the editor, the save button is enabled and thus
allows you to save any changes.
– In "Consumer settings" tab, choose the required file creation options and archive file
options settings.
5. Check the name of the connection in "Connection mapping settings" area that exists at the
right portion of Connection mapping tab. Click "Connect button to confirm your entries.
6. Repeat steps 1 - 5 for all elements of the "Database provider" that you wish to transfer.
Note
Consumer tags
A connection mapping with the Free Text Editor consumer tag cannot be performed if the
consumer tag does not include @ at beginning and ending of the consumer tag. Also, when
consumer tags without @ symbols are used, the selected consumer tag will not be displayed in
the "Consumer tag" field text box.
Results
The connections that you have created are shown in the "Connections" tab of IDB "Settings"
window as well as within the project tree node.
4.3.13.1 Overview
Introduction
The OPC Unified Architecture (UA) is a platform independent protocol which does not rely on
DCOM or OLE technology unlike the classic OPC. OPC UA is used for communicating between
different OPC servers and this is called tunneling.
Among various types of OPC UA protocols, IDB supports OPC UA Data Access (DA).
This provides a secure communication between the provider and consumer through
acknowledgement and authentication. The IDB application allows reading and writing data
to/from the OPC Server. OPC UA DA client can function as both a provider and consumer.
OPC UA uses Service Oriented Architecture (SOA) and web services, thus eliminating
dependency on Windows OS. By using SOAP/XML over HTTP, OPC UA can deploy on a variety
WinCC/IndustrialDataBridge
464 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
,'%
3URYLGHU &RQVXPHU
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 465
WinCC/IndustrialDataBridge Documentation
4.3 Modules
,'%
3URYLGHU &RQVXPHU
OPC UA Data Supported IDB Data Type Applicable for Applicable Supported Data Type for
Type for Data Transfer Provider for Consum‐ Data Adaptation
er
Boolean Boolean; True=-1, Fa lse=0 ✓ ✓ Byte, SByte, Int16, UInt16,
(VT_BOOL) Int32, UInt32, Int64,
UInt64, Float, Double,
String
Byte Unsigned char (VT_UI1) ✓ ✓ SByte, Int16, UInt16,
Int32, UInt32, Int64,
UInt64, Float, Double,
String
Sbyte signed char (VT_I1) ✓ ✓ Byte, Int16, UInt16, Int32,
UInt32, Int64, UInt64,
Float, Double, String
Int16 2-byte signed int (VT_I2) ✓ ✓ UInt16, Int32, UInt32,
Int64, UInt64, Float, Dou‐
ble, String
UInt16 Unsigned short (VT_UI2) ✓ ✓ Int16, Int32, UInt32,
Int64, UInt64, Float, Dou‐
ble, String
Int32 4-byte signed int (VT_I4) ✓ ✓ Int16, UInt16, UInt32,
Int64, UInt64, Float, Dou‐
ble, String
UInt32 Unsigned int (VT_UI4) ✓ ✓ Int16, UInt16, Int32,
Int64, UInt64, Float, Dou‐
ble, String
WinCC/IndustrialDataBridge
466 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
OPC UA Data Supported IDB Data Type Applicable for Applicable Supported Data Type for
Type for Data Transfer Provider for Consum‐ Data Adaptation
er
Int64 8 byte signed int(VT_l8) ✓ ✓ Int16, UInt16, Int32,
UInt32, UInt64, Float,
Double, String
UInt64 unsigned 64-bit ✓ ✓ Int16, UInt16, Int32,
int(VT_UI8) UInt32, Int64, Float, Dou‐
ble, String
Float 4-byte real (VT_R4) ✓ ✓ Int16, UInt16, Int32,
UInt32, Int64, UInt64,
Double, String
Double 8-byte real (VT_R8) ✓ ✓ Int16, UInt16, Int32,
UInt32, Int64, UInt64,
Float, String
DateTime Date (VT_DATE) ✓ ✓ String
String OLE/Binary Automation ✓ ✓ -
string (VT_BSTR)
Guid OLE/Binary Automation ✓ String
string (VT_BSTR)
XmlElement OLE/Binary Automation ✓ String
string (VT_BSTR)
NodeId OLE/Binary Automation ✓ String
string (VT_BSTR)
ExpandedNo‐ OLE/Binary Automation ✓ String
deld string (VT_BSTR)
QualifiedName OLE/Binary Automation ✓ String
string (VT_BSTR)
LocalizedText OLE/Binary Automation ✓ String
string (VT_BSTR)
StatusCode Unsigned int (VT_UI4) ✓ Int32, UInt32, Int64,
UInt64, Float, Double,
String
DataValue OLE/Binary Automation ✓ Int16, UInt16, Int32,
string (VT_BSTR) UInt32, Int64, UInt64,
Float, Double, String
Note: User should know
the proper data type dur‐
ing configuration and con‐
figure accordingly.
Variant signed char (VT_I1) ✓ Int16, UInt16, Int32,
UInt32, Int64, UInt64,
Float, Double, String
Note: User should know
the proper data type dur‐
ing configuration and con‐
figure accordingly.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 467
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Objective
To create a project with corresponding link having OPC UA client as provider and configure the
respective provider/consumer connection properties along with transfer behaviour settings. In
this demonstration, Database is used as consumer.
Creating a link
1. Open IDB Configuration and create a project by following the steps mentioned below:
– In IDB Configuration menu bar, select "Project" > "New project" to create a new project.
– In the "Create new project" dialog box, specify a project name, click [...] button and select
the folder location where the project needs to be saved.
– After entering the required information, select "Create" button. This creates a new project.
2. The project name will be listed within the "Project tree". The next step is to create a link.
Follow the steps mentioned below to create a link between provider and consumer:
– Right click on project name node in the tree structure and select "Add new link" option or
double click the "Add new link" node below the project name node within project tree.
– In the "Add new link" dialog that is displayed, enter a unique link name.
– Select the provider type as OPC UA, consumer type as Database and click "OK" button.
– The created link will be displayed below the project name in project tree.
– The corresponding entries - Provider, Consumer, Settings and Connections are created as
nodes that exist below the new link in the tree structure.
WinCC/IndustrialDataBridge
468 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. In project tree, double click the Provider node to open the provider configuration window.
Note
For more information about the OPC UA Server, refer the chapter OPC UA DA Server
(Page 230).
Security Settings
– Select the type of "Security Policy" for data transfer. The "Security Policy" field will be
populated depending upon the security policies supported by the server.
– Select the type of "Message Security Mode" for data transfer from the provider.
Authentication settings
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 469
WinCC/IndustrialDataBridge Documentation
4.3 Modules
WinCC/IndustrialDataBridge
470 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– If a user name and password has been set for the database, enter the user name and
password in the "User name" and "Password" fields respectively.If you wish to set a blank
password, enable the check box "Blank password". To save the entered password, enable
the check box "Allow saving password".
– Click Test button to test the connection. The application tests the database connection
string and verifies the selected database.
"Consumer type configuration" section
– Select the "Consumer type" by selecting from the list. In this case, we consider the
consumer type as "One data record per call - record set. More information about the
consumer types are provided in detail in Chapter 3.6.7, "Consumer Types".
Note
Transaction type
The Stored procedure or Prepared insert statement transaction type options are in enable
state only when the consumer type "One data record per call - command set" is selected
and if you have selected a database other than Microsoft access. By default, the Prepared
insert statement option is automatically selected.
• Only the "Table" field is enabled if Microsoft access is selected as the database type and
consumer type is selected as "One data record per call - command set". Select the table
name by clicking on the drop down list box.
• If you have selected a database type other than Microsoft access and the consumer
type is selected as "One data record per call - command set", then all the fields within
the Transaction type will be in enable state.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 471
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. Enter a time period in the "Update rate" field and choose transfer time in ms or sec or hr.
Note
For better performance, it is recommended to use an update rate of 1000 ms or 1 sec.
WinCC/IndustrialDataBridge
472 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
5. You need to configure the “Trigger Settings” section if the data transfer option "Send values
using trigger” is selected.
Perform the following settings to set the trigger:
– In "Trigger tag" field, select the tag that should trigger a data transfer. Click on [...] to select
the tag from OPC UA DA tag browser.
– Select a valid data type from the drop down list.
– In "Trigger value" field, enter a threshold value at which data transfer should be triggered.
– In "Confirmation value" field, enter a value that the trigger tag should take on after
triggering. The confirmation value does not give any information whether a transaction
has been completed successfully.
Note
Trigger behavior
The OPC UA trigger configuration will not set any confirmation value after the trigger
operation.
Results
You have created a connection between the OPC UA DA client and a consumer. These elements
are displayed in the tree structure of the configuration interface. In order to transfer data,
connect the provider and consumer tags, as described in chapter "Connecting Tags from the OPC
UA DA client Interface (Page 473)".
Connecting Tags
In "Settings" window, the "Connection mapping" tab includes the required fields to connect tags
that have been sent from OPC UA server interface with the selected data consumer.
The Connection mapping tab divides the window into 3 sections:
• OPC UA provider
• Database consumer
• Connection mapping settings
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 473
WinCC/IndustrialDataBridge Documentation
4.3 Modules
The "OPC UA provider" section is displayed at top left portion of "Connection mapping" tab.
This section provides you with required options to choose the tag name from the "OPC
UA tag browser". The "Database consumer" section is displayed at bottom left portion of
"Connection mapping" tab. This section lists the selected Table, Schema and column names
that can be mapped with the tags existing within "OPC UA provider". The information within
"Database consumer" section explained below is specific to having the consumer type as
"One data record per call - recordset".
The separator between the provider and consumer section provides a resize handle that
helps you to resize the height of the section in order to view the fields within the section
clearly.
The "Connection mapping settings" section is displayed at right side of "Connection mapping"
tab. This section helps you to provide a name for connection along with options for choosing
default name for connection. The "Connect", "Modify connection", "Delete connection" and
"Delete all connections" icons are provided at the top portion of this section.
Prerequisite
The OPC UA server in the provider section will be in disconnected state as there is no
authentication between the OPC UA server and OPC UA client. When the UA client is trying to
connect to the UA server for the first time with security policies, the certificate sent from the
client will be rejected by the server.
WinCC/IndustrialDataBridge
474 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Follow the procedure given below to move the rejected certificate to the required folder at
the UA server side:
1. Go to the rejected certificate folder in the path "[Application Path] \PKI\CA\rejected\certs".
2. Cut-and-paste the certificate from rejected folder to the “certs” folder in the path
"[Application Path]\PKI\CA\certs".
For example, if WinCC UA server is used, the rejected certificate is available in "[Application
Path] \opc\UAServer\PKI\CA\rejected\certs". You have to cut-and-paste the certificate onto
the folder path "[Application Path]\opc\UAServer\PKI\CA\certs”.
This process must be accomplished only once when the client is trying to connect to the
server for the first time.Now, the OPC UA server is connected to the client.
5. Check the name of the connection in the "Connection mapping settings" area to the right.
Enter a unique name for the connection in the "Connection name" field or use the options
within "Default name options" area. Click "Connect" button to confirm your entries.
6. Repeat steps 1 to 5 for all tags of the "OPC UA" interface that you wish to transfer.
7. The connection name including the provider and consumer data values will be displayed
within the "Connection mapping settings" section.The list of connections will be also
displayed within the Connections tab as well as in the project tree within the "Connections"
node belonging to the specific link.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 475
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Note
Schema
Microsoft Access does not support schema functionality. Hence, you can observe that the
Schema field in Database consumer is in disable state.
While using any other database as consumer, the Schema field will be in enable state.
Note
Modifying Consumer type
Once the connection(s) have been created in Connection mapping window and if you wish to
modify the Consumer type in Database consumer configuration, the IDB CS application will not
allow to change the Consumer type. To change the Consumer type, you need to delete the
connection(s) that have been already created. Close the consumer configuration window and re-
open the window from the project tree to modify the consumer type.
The tags used in the above examples are of the scalar data types. The OPC UA tags that are of
matrix and array data type are represented in the OPC UA tag browser as follows:
Array:
Matrix:
WinCC/IndustrialDataBridge
476 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Result
The connections that you have created are shown in the "Connections" tab of IDB CS Settings
window as well as within the "Connections" node in project tree.
Objective
To create a project with corresponding link having OPC UA client as consumer and configure the
respective provider/consumer connection properties along with transfer behaviour settings. In
this demonstration, Database is used as provider.
Creating a link
1. Open IDB Configuration and create a project by following the steps mentioned below:
– In IDB Configuration menu, select "Project" > "New project" to create a new project.
– In the "Create new project" dialog box, specify a project name, click [...] button and select
the folder location wherever the project needs to be saved.
– After entering the required information, select "Create" button. This creates a new project.
2. The project name will be listed within the "Project tree". The next step is to create a link.
Follow the steps mentioned below to create a link between provider and consumer:
– Right click on the project name node in the tree structure and select "Add new link" option
or else double click the "Add new link" node below the project name node within project
tree.
– In the "Add new link" dialog that is displayed, enter a unique link name.
– Select the provider type as Database, consumer type as OPC UA and click OK button.
– The created link will be displayed below the project name in project tree.
– The corresponding entries - Provider, Consumer, Settings and Connections are created as
nodes that exist below the new link in the tree structure.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 477
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. In project tree, double click the Provider node to open the provider configuration window:
WinCC/IndustrialDataBridge
478 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– In "Database" field, click on [...] button and select the database from the list or from the
folder structure.
Note
Please note the following points:
• The "Server" field text box and "Use automatic Windows authentication" check box is
in disable state if you use "Microsoft Access" as the database.
• The "Use automatic Windows authentication" check box is in disable state if you have
used any database other than "Microsoft SQL Server".
• The option to select the check box "Use automatic Windows authentication" is
provided only for "Microsoft SQL Server" database.
• If you use "Oracle" as the database, it is important to note that the "Database" field list
box will be in disable state.
– If user name and password has been set for the database, enter the user name and
password in the "User name" and "Password" fields respectively.
If you wish to set a blank password, enable the check box "Blank password". To save the
entered password, enable the check box "Allow saving password".
– Click Test button to test the connection. The application tests the database connection
string and verifies the selected database.
4. Next, double click the Consumer node in project tree. In Consumer configuration window,
perform the following settings:
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 479
WinCC/IndustrialDataBridge Documentation
4.3 Modules
– Hostname: Enter "localhost", if the OPC UA server is available in the local machine. You
can also enter IP address or hostname, if known.
In remote scenarios, enter the IP address/hostname of the machine in which OPC UA
server is present.
– Server URL: The OPC Local discovery Services (LDS) detects the OPC UA servers available
depending on the hostname provided. Click the [...] button to select from the list of OPC
UA servers identified by OPC LDS. Or, you may enter the server name if known.
Security Settings
– Select the type of "Security Policy" for data transfer. The "Security Policy" field will be
populated depending upon the security policies supported by the server.
– Select the type of "Message Security Mode" for data transfer from the provider.
Authentication settings
– Choose "Login" to authenticate with a username and password or choose "Anonymous"
for authenticating without login identification.
WinCC/IndustrialDataBridge
480 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 481
WinCC/IndustrialDataBridge Documentation
4.3 Modules
3. Select the "Schema" if applicable and the "Table" name by selecting from the drop down list.
Enter a time period in the "Update rate" field after which the system checks for when the data
is to be transferred.
Note
Schema
Microsoft Access does not support schema functionality. Hence, you can observe that the
Schema field will be in disable state if you have chosen Microsoft Access as the database type.
Note
Table name
If you are unable to view Table name in the "Table" field, check if the Schema is selected in
"Schema" field. Without selecting the "Schema", the table name will not be displayed.
However, if you are using Microsoft Access as the database, this condition will not be valid.
If you are still unable to view the Table, please verify with the provider configuration.
Note
Update rate
For better performance, it is recommended to use an update rate of 1000 ms or 1 sec.
WinCC/IndustrialDataBridge
482 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
5. If you have selected the option "Send values using trigger", you can configure the trigger. The
Trigger section is enabled only if the data transfer type "Send values using trigger" is selected.
Perform the following settings in the "Configure trigger" section:
– In the "Schema" field, choose a valid schema by selecting the drop down list.
– Choose a "Table" name by selecting from the drop down list.
– Select the specific column that needs to be used for the trigger condition.
– Choose a valid data type by selecting from the drop down list.
– Enter a threshold at which a data transfer should be triggered, in the "Trigger value" field.
– In "Confirmation value" field, enter a value that the trigger tag should take on after
triggering.
The Confirmation value does not give any information whether a transaction has been
completed successfully.
Note
Trigger behavior
The column name selected will be used for the trigger condition that triggers the data
transfer. IDB CS sets the confirmation value in the provider tag specified in "Confirmation
value" field.
Note
Saving Changes
A save operation is not required every time whenever changes are performed within the editor
window in the work area. The changes made to these settings are automatically saved. However,
once the project is created, at any point of time, you can save the project by selecting the
"Project" > "Save" menu option.
Result
You have created a connection between a provider and the OPC UA client. These elements are
displayed in the tree structure of the configuration interface. In order to transfer data, connect
the provider and consumer tags, as described in chapter "Connecting Tags to the OPC UA client
Interface (Page 484)".
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 483
WinCC/IndustrialDataBridge Documentation
4.3 Modules
Connecting Tags
In "Settings" window, the "Connection mapping" tab includes the required fields to connect tags
that have been sent from selected provider to OPC UA interface. The Connection mapping tab
divides the window into 3 sections:
• Database provider
• OPC UA consumer
• Connection mapping settings
The "Database provider" section is displayed at top left portion of "Connection mapping" tab.
This section lists the column values that can be mapped with the tags existing within OPC UA
interface. The "OPC UA consumer" section is displayed at bottom left portion of "Connection
mapping" tab. This section provides you with required options to choose the tag name from
the list of OPC UA tags in the OPC UA tag browser.
The separator between the provider and consumer section provides a resize handle that
helps you to resize the height of the section in order to view the fields within the section
clearly.
The "Connection mapping settings" section is displayed at right side of "Connection mapping"
tab. This section helps you to provide a name for connection along with options for choosing
WinCC/IndustrialDataBridge
484 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.3 Modules
default name for connection. The "Connect", "Modify connection", "Delete connection" and
"Delete all connections" icons are provided at the top portion of this section.
Prerequisite
The OPC UA server in the provider section will be in disconnected state as there is no
authentication between the OPC UA server and OPC UA client. When the UA client is trying to
connect to the UA server for the first time with security policies, the certificate sent from the
client will be rejected by the server.
Follow the procedure given below to move the rejected certificate to the required folder at
the UA server side:
1. Go to the rejected certificate folder in the path "[Application Path] \PKI\CA\rejected\certs".
2. Cut-and-paste the certificate from rejected folder to the “certs” folder in the path
"[Application Path]\PKI\CA\certs".
For example, if WinCC UA server is used, the rejected certificate is available in "[Application
Path] \opc\UAServer\PKI\CA\rejected\certs". You have to cut-and-paste the certificate onto
the folder path "[Application Path]\opc\UAServer\PKI\CA\certs”.
This process must be accomplished only once when the client is trying to connect to the
server for the first time.Now, the OPC UA server is connected to the client.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 485
WinCC/IndustrialDataBridge Documentation
4.3 Modules
4. Next, configure the tag in the "OPC UA consumer" section by following these steps:
– Select the tag name from the list that is displayed within "OPC UA tag browser". Upon
selection of the tag within OPC UA tag browser, the tag name is displayed in "Tag ID"
field. The data type is displayed in "Data type" field based on selection of the tag.
Note
Data type conversion
If the provider tag data type does not match with consumer column, IDB CS converts the
provider data type to match with data type of consumer. A status window is displayed to
indicate this change.
The list of supported data types of OPC UA Server is provided in the "Supported Data Types
(Page 466)" topic.
The tags used in the above examples are of the scalar data types. The OPC UA tags that are
of matrix and array data type are represented in the OPC UA tag browser as follows:
Array:
Matrix:
5. Check the name of the connection in the "Connection mapping settings" area to the right.
Enter a unique name for the connection in the "Connection name" field or use the options
within "Default name options" area. Click "Connect" button to confirm your entries.
WinCC/IndustrialDataBridge
486 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
6. Repeat steps 1 to 5 for all elements of the "Database Provider" that you wish to transfer.
7. The connection name including the provider and consumer data values will be displayed
within the "Connection mapping settings" section.The list of connections will be also
displayed within the Connections tab as well as in the project tree within the "Connections"
node belonging to the specific link.
Note
Schema
Microsoft Access does not support schema functionality. Hence, you can observe that the
Schema field in Database consumer is in disable state.
While using any other database as consumer, the Schema field will be in enable state.
Result
The connections that you have created are shown in the "Connections" tab of IDB "Settings"
window as well as within the "Connections node" in project tree.
Introduction
The IDB Runtime (RT) system is part of the IndustrialDataBridge software that enables loading
the configuration files and performing data transfer. A created configuration file can be loaded
in the runtime interface. The runtime environment includes the actual provider and consumer
components. Hence, the Runtime system allows access to data within the configuration and
establishes the linkage with data as defined in loaded configuration file, thus enabling efficient
data transfer.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 487
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
1. To start IDB Runtime from windows environment, select "Start" > "All Programs" > "Siemens
Automation" > "IndustrialDataBridge" > "IndustrialDataBridge RT".
To start IDB Runtime while using Windows 10 / Windows 11 / Windows Server 2019 /
Windows Server 2022 operating system, select Start > Apps. Click Ctrl+tab key to select the
application.
2. This will open the IDB Runtime application window.
Note
IDB Service
You can make changes within the Runtime interface only if IDB Service has been started. To
start the service, you need to have sufficient administrator privileges.
3. Before starting to use the IDB Runtime application for data transmission, start IDB service
using any of the methods mentioned below:
– Manually in the "NT Service" tab of Runtime configuration window. The Runtime
configuration window can be opened by clicking on the "Options" button in IDB RT toolbar
or by selecting "Options" menu > "NT Service"
– Manually or automatically as service in the computer administration
Note
Additional Information
The detailed steps for starting IDB Service is mentioned in Chapter 4.4.6 "Starting Service"
(Page 503).
4. Select "File" > "Open" menu option or click "Open" button in IDB toolbar and load the
configuration XML file.
5. A list of connections for specific configuration will be displayed in the status view. Click
"Connect" button and select "Start" button to perform data transfer.
6. Once data provider and data consumer are connected successfully, the link(s) will be
activated.
Thereby, the runtime interface monitors the life-span of the provider and consumer
components and establishes the connection automatically. The runtime interface thus starts
the runtime components and enables data transfer beween the provider and consumer types.
A created configuration file (XML) can be loaded in the runtime interface automatically using
the "Startup option" tab. This tab is provided within the "Runtime configuration" window.
This window can be accessed by selecting "Options" > "Startup option" or by clicking the
"Options" button in application toolbar. For more information, please refer Chapter 4.4.2
"Start Settings" (Page 495).
WinCC/IndustrialDataBridge
488 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
Overview
This chapter provides information about the menu options and toolbar icons provided with IDB
Runtime system. Few options that are provided within the menus are also available as toolbar
buttons. These buttons are shown in enable state only if the IDB Service has been started.
Starting the IDB Service is a prerequisite before making any changes within the Runtime
interface.
Menu commands
The following menu options are provided in the Runtime interface of the IndustrialDataBridge:
The "Options" button opens the "Runtime configuration" window and consists of the
following tabs - "Startup option", "Trace", "Password", "License" and "NT Service". Please note
that the "Trace" tab in "Runtime configuration" window and the menu "Options" > "Trace"
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 489
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
is enabled only after the start of IDB Service and the XML configuration file is loaded in
Runtime.
The "Help" button is provided in the toolbar. This button can be used to access the IDB
information system.
Buttons
The function of some of the toolbar buttons displayed in the IDB Runtime toolbar corresponds
with the functions of the menu commands.
WinCC/IndustrialDataBridge
490 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
4.4.3 Views
Introduction
The IDB Runtime interface includes support for viewing the status messages and status of
connection(s) and their data transfer. This information is managed within the views. The
IndustrialDataBridge Runtime interface includes 2 views:
• Trace view
• Status view
Trace view
In the trace view, you can view the current messages with respect to each of the actions
performed in runtime including the data transfer status of the provider and consumer types.
These messages contain status messages as well as error messages and output parameters of
the individual components. The data is displayed in the form of a continuous list and shown in
ascending order.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 491
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
Status View
In the status view, the connection(s) are shown with their respective data provider and data
consumer status. The last message of a connection and the respective time stamp will also be
displayed in status view. The following states are displayed in the status vew based on the
"Connect" or "Disconnect" status and indicated by colored dots:
• Red color dot: DISCONNECTED (not connected)
• Yellow color dot: TRYCONNECTED (connection is being established)
• Green color dot: CONNECTED (connected)
WinCC/IndustrialDataBridge
492 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
Status Description
IDB service is activated, connection is established
IDB service is not activated, no connection
Note
IDB connection status
The IDB connection status in runtime interface is shown in red color. To change the connection
status to green color, you need to start the IDB service in "Options" > "NT Service" tab.
The IDB tray icon displayed in windows task bar provides options for establishing connection
and for performing the data transfer. The following menu options are displayed after right
clicking on the IDB tray icon:
• Connect: This option is used to connect the provider and consumer types and is enabled only
if IDB service has been started and the configuration XML file is loaded in the runtime
interface.
• Disconnect: This option disconnects or closes connection between provider and consumer
types.
• Start: Starts the data transfer. This option is enabled only during the Connect state.
• Stop: Stops the data transfer.
• Exit: Exits the IDB Runtime application.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 493
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
4.4.4 Options
4.4.4.1 Overview
Overview
The following commands or items are displayed in the "Options" menu:
• Start option
• Trace (available only if the service has been started and a configuration file is open)
• Password
• License
• NT Service
• Language
• Password check
• Trace logging
The first five items can be accessed from the tabs existing within the "Runtime configuration"
window. This window can be accessed by clicking the "Options" button in the toolbar. Within
each of these tabs existing within "Runtime configuration" window, the changes performed
are active only if you close the window by clicking the "OK" button.
The other three items "Language", "Password check" and "Trace logging" are activated or
deactivated directly by the selection in menu interface. The current status is shown with a
check mark. However, the "Language" menu item includes a sub-menu that displays the list
of languages. Upon selecting the particular language, all the menu interface items including
the runtime user interface text will be displayed based on the selected language.
Note
You can only make changes in the Runtime interface if the IDB Service has been started.
Functions
The functions of each of these options are provided below:
Start option
Option to determine the Start settings of the IDB Service.
WinCC/IndustrialDataBridge
494 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
Trace
Trace is a logging function, which enables external logging of error messages, calls and data
transfers in case of an error. Trace is available only if the IDB Service has been started and a
configuration file is open.
Password
Option to determine the password for password protection.
License
This option is for displaying the license parameter.
Language
Selection of the IDB user interface language. English is the default language. The language
can only be changed if the IDB service has been started.
Password check
Activates or deactivates the password check.
Trace recording
Activates or deactivates the logging function for error analysis.
Overview
There are various possibilities for starting the IndustrialDataBridge. These possibilities are listed
below:
• Manually in the WinCC Explorer
• In the start settings of the computer properties in WinCC
• As an application in the Windows Autostart folder
• As a service in the computer administration
Note
More Information
More information about the steps to be followed within each of these options to start IDB is
provided in Chapter 4.5 "Working with Connections" (Page 505).
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 495
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
To define the start behavior of IDB runtime application, select the tab entry "Startup option"
in the "Options" menu or click "Options" button and choose "Startup option" tab.
1. Select "Start" button and type 'dcomcnfg' in the "Search" text box. Press the Enter key.
The Component Services window will be opened.
2. In the left hand navigation folder structure, select "Console Root" > "Component Services" >
"Computers" > "My Computer" > "DCOM Config".
3. The corresponding list of application names and application IDs will be displayed within right
hand portion of the window.
WinCC/IndustrialDataBridge
496 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
4. Hold the Ctrl key on keyboard and select the below mentioned application names from the
list of displayed applications.
– sitbcdb2, sitbcdb1, sitbcdb3, sitbcsql, sitbcxls, sitbcsrv, sitbcopc, sitbcsr, sitbcopcxml,
sitbopcsrv, sitbcopcuada
5. Perform a right click on each of these application icons and select "Properties" > "Identity" tab.
6. The Identity tab displays a list of user accounts that can be selected using the radio button
selection.
By default, the radio button option "The interactive user" will be selected.
7. Modify this option by clicking on the radio button option "The launching user".
8. Select "Apply" button and click "OK" to further save these changes within the properties
window.
Thereby, the startup behavior will work normally by performing the changes to these DCOM
settings.
In addition to the DCOM settings, it is important to configure some more settings for
Windows services.
1. Open the Windows Service Manager.
2. In the Service list, right click on the "IndustrialDataBridge" and click "Properties".
3. In "General" tab, select Startup type as "Automatic (Delayed Start)".
Note
Selecting “Automatic” alone will not allow the service to run.
4. In "Log On" tab, select "This Account" option and provide account name and password.
Note
DCOM settings
This change is not applicable for Excel.
Note
After performing any changes to the Startup settings, you need to restart the computer in order
for the changes to be effective.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 497
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
Introduction
With the "Trace" logging function, you write the trace messages of IndustrialDataBridge Runtime
into a file. This way, you can check the behavior of certain connections offline.
However, this does not influence the display in the Trace view.
Note
Trace tab
The trace tab is displayed in "Runtime configuration" window only if the IDB Service is started and
if you have loaded a valid configuration XML file.
Note
Memory requirement and performance loss
Activation of Trace results in a greater memory requirement and performance loss. We
recommend that this function is only activated for troubleshooting.
Trace settings
Trace settings can only be processed if the IDB Service has been started and a valid
configuration XML file has been loaded in runtime.
To edit the trace settings, select "Trace" within "Options" menu or click "Options" button in
application toolbar and select the "Trace" tab.
WinCC/IndustrialDataBridge
498 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
The trace settings are performed separately for the provider and the consumer of each
connection:
• Select the connection that you wish to monitor.
• Select a memory location and a file name for each log
• Define the scope of the logging in the "Trace level" area:
We recommend coordinating the selection of the trace level with the hotline employee that
works on the solution to the problem.
• In the "Buffer size" field, define how many entries are to collect in the buffer before the data
is written. This setting is used for accelerating the recording.
• With "All Providers" or "All Consumers", the log data of all connections in the selected trace
level are saved in separate provider and consumer files.
• Close the window by clicking "OK" button.
Note
Trace file path
In Windows 10 / Windows 11 / Windows Server 2019 / Windows Server 2022 operating system,
it is strongly recommended to configure trace file path settings in any drive other than 'C:' drive.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 499
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
Note
Saving Changes
In the IDB Runtime, function "Save as ..." is not available.
When saving the changed trace view, the previous configuration will be overwritten. If you want
to save the previous configuration, you will have to save it under a different name.
Note
Editing a configuration file with Trace settings in the configuration program
The configuration program does not support Trace.
If a configuration file with Trace settings is edited and saved in the configuration program, the
Trace settings will be reset.
WinCC/IndustrialDataBridge
500 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
See also
Viewing Alarm Messages (Page 516)
Introduction
The IndustrialDataBridge provides password protection functionality.
If password checking is active, the password is queried when starting, connecting and
disconnecting in Runtime.
Note
The password can only be changed if the "Password check" option is enabled in the "Options"
menu.
In order to change the password, select menu "Options" > "Password" or click "Options"
button and select the "Password" tab.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 501
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
Enter the old and the new password and repeat the new password to exclude the possibility
of input errors. The entries are displayed in masked form for safety reasons.
Click "Apply" button to confirm your input, then close the window by clicking on "OK".
License Information
In order to display the license, select menu "Options" > "License" or click "Options" button and
select the "License" tab.
WinCC/IndustrialDataBridge
502 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
Introduction
Before you can use the IndustrialDataBridge for data transmission, you will have to start the IDB
Service. This can be performed by following any of the methods mentioned below:
• Manually in the "NT Service" tab of Runtime configuration window.
• Manually or automatically as service in the computer administration.
The following paragraph is a description of a manual start in the window "NT Service" and
automatic startup in computer administration as well as stopping the service.
Note
You have two options for entering a new user for a service:
• Changing the local policy via the Local Security Settings console "Secpol.msc".
• Enter the user via the Service console "Services.msc". The policy will be automatically
adjusted for this user.
The default setting is the user "System account".
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 503
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
• Enter the Service Port you wish to use. The default setting is port 11111. Communication
between Runtime interface and the IDB Service with the TCP/IP protocol will take place via
this port.
• If you want to start the IDB Service for the current user, select the "System account" and click
" Start Service".
• If you want to start the service for another user, deactivate the System account check box and
enter the User name and Password in "User name" and "Password" fields respectively. Click
"Apply" button to start the IDB Service.
• Close the window by clicking "OK" button.
WinCC/IndustrialDataBridge
504 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
Note
Automatic mode
• The check box "Automatic mode" needs to be enabled only after the runtime service has been
started.
• If you modify the setting in Services.msc from 'Manual' to 'Automatic', the "Automatic mode"
check box will not be enabled in NT Service tab. To have the "Automatic mode" enabled in NT
Service tab, stop the runtime service and restart service for the changes to take effect.
Introduction
This chapter provides complete information specific to working with connections and the steps
required to activate connection(s) and perform data transfer using IDB RT application. It also
describes several ways for accessing IDB RT application.
Different formats
If the number or date format of the operating system deviates from the corresponding format
of the connected file, you will have to adapt the XML configuration file. Otherwise, you may
experience conversion errors.
Examples
Case 1: German operating system / Floating-point numbers are to be saved in English format
("." instead ",").
Case 2: German operating system / Date as string saved in English format.
In this case you will have to amend the entry <Link UID="Ref-1" Name="OPC-DB2"> to <Link
UID="Ref-1" Name="OPC-DB2" LCID="1033"> in the XML configuration file.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 505
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
The attribute LCID (LocalID) indicates in which format the values will be saved. During
conversion they will be converted into the format of the operating system. The attribute LCID
has the following values for the interface language of the IDB:
WinCC/IndustrialDataBridge
506 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 507
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
project from WinCC Explorer will now enable IDB Runtime environment to be automatically
opened and all IDB links are connected and started.
• Using WinCC controls:
Start WinCC Graphics Designer from WinCC Explorer and add the ActiveX control "IDB
Runtime Control". Save the project and select "Runtime" button in toolbar to activate the
control. WinCC Runtime will be opened in a new window that displays IDB Runtime
application window.
To start IDB connection or links automatically upon starting the project, you need to enable
the Automatic Startup type in Windows Services. Enable automatic data transfer by selecting
start option in IDB Runtime options and select XML configuration file. Upon clicking Runtime
button from Graphics Designer toolbar will now enable IDB Runtime environment to be
automatically opened and all IDB links are connected and started.
To start IDB Runtime application manually, perform the following steps:
• In the Windows start menu, select "Siemens Automation" > "IndustrialDataBridge" >
"IndustrialDataBridge RT".
Note
OPC UA Client certificate exchange at Runtime
If OPC UA DA Client is selected as Provider/Consumer in the configuration, the OPC UA client and
UA server should authenticate via certificate exchange for data transfer during Runtime.
When the client is trying to connect to the server for the first time during Runtime, the server
generates a certificate at IDB side after the XML is loaded.
Follow the steps given below for successful authentication of certificates:
1. At IDB side, go to the folder in the path"[Application Path]\OPC_UA\Client\PKI\Rejected\certs”.
2. Create folders named “Trusted > certs” in the path "[Application Path]\OPC_UA\Client\PKI”
3. Cut-and-paste the certificate under the “Rejected” folder to “Trusted > certs” folder.
4. At UA server side, a certificate named “Siemens OPC UA Client for WinCC IDB Runtime” is
created in "[Application Path]\PKI\CA\rejected\certs” folder.
5. Move the certificate from above mentioned location to "[Application Path]\PKI\CA\certs".
WinCC/IndustrialDataBridge
508 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
Note
IDB OPC UA DA Server certificate exchange at Runtime
If IDB OPC UA DA Server is selected as Consumer in the confuguration, the IDB OPC UA DA server
and client should authenticate via certificate exchange for data transfer during Runtime.
When the server is trying to connect to the client for the first time during Runtime, the
certificate sent from the server will be rejected by the client. This rejected certificate is available
in the path "[Application Path]\OPC_UA\Server\PKI\CA\rejected\certs". Cut-and-paste the
certificate into "[Application Path]\OPC_UA\Server\PKI\CA\certs" folder.
Follow the steps given below to start one or more connections manually:
1. In the Windows start menu, select "Siemens Automation" > "IndustrialDataBridge" >
"IndustrialDataBridge RT". To start IDB runtime from WinCC Explorer, select
"IndustrialDataBridge", right click and choose "Runtime" from the pop-up menu.
2. To load a configuration file, select "Open" in the "File" menu or click "Open" button.
3. Select the Status view. A list of connections applicable for the specific configuration will be
thus displayed. A check mark appears next to the connection name.
This allows for performing actions on individual connection(s).
4. To connect, select the entry "Connect" in the "Operate" menu or click "Connect" button.
5. As soon as the status is displayed with a green colored dot in provider and consumer
columns, the connection is complete.
6. To activate the connections, select the entry "Start" under "Operate" menu or click "Start"
button.
Data can now be transferred via the connection.
7. In Status view, select a connection and right click on the connection. A context menu is
displayed with a list of options. This allows for working with individual connections.
However, the displayed options are dependent on connect / disconnect state.
When IDB is in connected state:
– Right click on an already connected connection will show "Disconnect" option
– Right click on a disconnected connection will show "Connect" option
– If connection fails due to consumer/provider not being initialized, then on performing
right click "Disconnect" option will be displayed
When IDB is in started state:
– Right click on a disconnected connection will show "Start" option
– Right click on a connected connection will show "Disconnect" option
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 509
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
Note
Security settings for Windows 10, Windows 11, Windows Server 2019 and Windows Server
2022 operating systems.
By default, the User Account Control (UAC) is set as "high" and hence denies write access to the
"Program Files" directory.
In Windows 10, Windows 11, Wndows Server 2019 and Windows Server 2022 operating
systems, it is suggested to save the files (that is selected as a consumer) into a folder location
within the drive on your computer other than boot or operating system drive.
WinCC/IndustrialDataBridge
510 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
Note
Opening Excel file during data transfer
During data transfer process between the provider and excel as consumer, IDB Runtime writes
the data in the Excel file. If the excel file is opened in parallel during the transfer process, then
runtime application stops working. A trace message "Inserting a value failed" will be displayed
in the "Trace view" once you try opening this excel file.
Please note that the Runtime application stops working and you will not be able to stop or
disconnect the data transfer process. In this scenario, you need to restart the IDB service.
However, you will not be able to save any data during the last data transfer.
Note
Send/Receive
Using Send/Receive as provider or consumer type with other supported provider / consumer
types can be configured in IDB CS application. However, after loading the configuration in
Runtime environment and connecting the provider/consumer types, you may observe that the
IDB connection status will still be shown in red colour and the status of connection is in
"Disconnected" state.
The "Connected" state can be achieved only if you are using Send/Receive to send or receive data
to or from a PLC.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 511
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
Note
Maximum Number of Links
For all provider/consumer types of the IndustrialDataBridge, the number of links is
recommended to a maximum of 32 links in Runtime operation. The functionality in runtime
operation is not guaranteed with a higher number of links.
Note
Stopping or disconnecting takes a long time
Stopping or disconnecting a WinCC OLE DB connection can take a long time in certain cases. The
reason may be that all job bundles will have to be processed completely.
See also
http://www.microsoft.com (http://www.microsoft.com)
Overview
It is possible to call RT directly from CS for the IDB project that is currently open. For an IDB project
with a completely configured provider, consumer and mapping settings, clicking the "Start
IndustrialDataBridge Runtime" button in the tool bar generates the XML file, open RT, load the
XML file and starts data transfer automatically. It also starts the NT service if not started.
To start IDB RT directly from CS, follow the procedure:
1. Click the "Start IndustrialDataBridge Runtime" button. The "Save as" widow appears.
2. Name the XML file as desired.
3. Click "Save". The XML file is saved.
Result
• The IDB RT application is started.
• The saved XML file is loaded.
• The NT service is started
• Connection between the Provider and Consumer is established.
• Data transfer is started.
WinCC/IndustrialDataBridge
512 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
The "Start IndustrialDataBridge Runtime" button will not start the task if there is an on-going
data transfer in RT regardless of the project open in CS. A message is displayed to inform that
the RT is already running.
Note
Links in RT
By default, the "Start IndustrialDataBridge Runtime" button loads all the links available in the
project into RT. To load the desired link into RT,you need to save the XML file for the link and start
RT manually.
Clicking the "Stop IndustrialDataBridge Runtime" button stops the data transfer, disconnects
the connection between Provider and Consumer, disconnects the services running in the
background and closes the Runtime application. This is also applicable to stop an on-going
data transfer in the Runtime that is started manually.
Prerequisite
• An IDB project with at least one link configured completely in the machine from which RT is
invoked.
• IDB is installed in the remote machine.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 513
WinCC/IndustrialDataBridge Documentation
4.4 Runtime Environment
Procedure
The procedure to start RT in a remote machine is given below:
1. Select the "Download Remote Configuration" option from the toolbar. The "Download to
target system" dialog opens.
3. The "RT Service Port" number is populated wth the default port number in which RT service
runs in the target machine. If there is any change in the IDB RT service port number in the
target machine, the user can enter the port number manually.
Note
The "RT Service Port" field displays the port number which was previously used to start RT
successfully, in the selected remote machine.
WinCC/IndustrialDataBridge
514 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.5 SIMATIC Shell
4. Select the "Start the runtime after download" checkbox to start runtime in the remote
machine after downloading the config xml file.
If you wish to just download the config xml in the target machine and not start RT, then do
not select this option.
5. Click "OK". This downloads the config xml file and starts RT in the target machine.
Consequently, starts the connection and data transfer.
After a successful download, a message is displayed to the user that the download is
successful.
Upon entry of a remote machine destination path, it will be listed on the "Download to target
system" dialog for future selections.
Every machine in this network visualises the same list of machines. Upon selection of a
machine in SIMATIC Shell window, the object "IDB" is displayed, if IDB is installed in that
machine. It also shows the machine’s IP address and domain, shown in the figure above.
It also shows the RT status information, if an IDB config XML file is loaded into IDB RT or in the
connected state.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 515
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
Introduction
In IDB Runtime interface, the status messages and error messages are shown in the trace view.
These error messages can also be logged in a log file if tracing is enabled in the runtime
environment. However, while using IndustrialDataBridge in combination with WinCC, IDB
Runtime does not raise error messages for any system specific errors or initialization failure or
data transfer failure. Hence, these error messages that require attention can be shown as system
messages using Alarm logging control in WinCC. This chapter provides more information about
viewing alarm messages in Alarm logging application.
WinCC/IndustrialDataBridge
516 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 517
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
Alarm Messages
To view alarm messages in WinCC Alarm logging, follow the steps given below:
1. Open Alarm logging application from WinCC Explorer.
2. In the navigation tree, select the "System messages" node. The "Configuration (WinCC)
[ availbale ]" window is displayed. It shows a complete list of available system messages.
3. Select the required system messages from the list in the "Used" column.
Note
To select all the system messages, right-click on the "Used" column and select the option
"Select all".
The "Used" column indicates the system messages that are added into the project. You can
select or deselect the messages.
Introduction
The IDB runtime control on Web Navigator client screen allows an operator from a client
computer to browse configuration files that are located on a server, load configuration file and
start or stop the data transfer. Multiple clients can connect to a single server.
Prerequisites
• Microsoft Internet Information Server (IIS) 6.0
• Web Navigator Server Component
• Web Navigator Client Component
• IDB Server Component
For more information regarding installing IIS, refer Microsoft website.
WinCC/IndustrialDataBridge
518 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
Benefits
• IDB installation
Complete installation of IndustrialDataBridge is not required on client machines.
Necessary components required on the client machine are identified and prompted for
installation while launching the Web client.
• IDB can be operated remotely as a client
• Enables easier browsing of IDB configuration files (during runtime) from remote computer
running as a client
• Supports operation on clients with authorization support
Usage
Using the Internet explorer browser, the IDB runtime environment can be accessed from any
client computer without the need for having a complete IDB installation. However, all the
required prerequisites need to be installed before accessing the runtime application from the
client computer using a browser.
1. In client machine, firstly enter the local host address or IP address of the server machine.
2. If the client does not have necessary components installed, a message is displayed in Startup
screen as "IDB Control plugin not installed".
Install this component using the link given on the same Startup screen. If component is
installed, this message will not be displayed and this step can be skipped.
3. The browser displays the runtime application and lists all the controls available within the IDB
runtime application.
4. Open the configuration file list by clicking the "Open" button. A customized "File Open" dialog
window is displayed. The server files are displayed in this folder structure that can be loaded
by the clients.
5. Click the "Refresh" button to refresh the latest configuration files list.
6. Select a file and click the "Open" button. The selected file is loaded in IDB runtime control and
the data transfer can be started from the client computer.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 519
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
Note
Open dialog box
A customized File Open dialog window is displayed upon clicking the Open button in runtime
application. The list of files that can be opened remotely by clients are displayed in the file list.
All the XML configuration files located in server directory specified by "ConfigurationFilesPath"
key under key "HKEY_LOCAL_MACHINE\SOFTWARE\Siemens\IT4Industry\IndustrialDataBridge"
in the registry on the server will be displayed in the file list within the customized File Open
dialog window while loading files.
It is not possible to browse or select any other files existing on the Web Navigator server
computer. You will not be able to load any configuration file that is not present in the directory
specified by registry entry. Any existing file that is already loaded on the server will be displayed
on client even if the file is not present in the above mentioned directory. This restriction applies
only to the files that can be loaded by the client.
The file loaded on client is displayed in the Group box header. Since the file physically do
not exist on the client computer, the complete file path is not displayed. Only the file name
of specific file is displayed in the header. A file loaded by client on server will reflect on all
the clients connected to the same server. On the server, if you wish to restrict the client to
load configuration file or Start/Stop data transfer, then the server should enable the Password
check option.
Note
You will not be able to load any configuration file that is not present in the directory specified by
registry entry. Any existing file that is already loaded on the server will be displayed on client
even if the file is not present in the above mentioned directory. This restriction applies only to the
configuration or trace files that can be loaded by the client.
WinCC/IndustrialDataBridge
520 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
Overview
WinCC IDB Runtime application can be accessed using WinCC controls. This is possible by adding
WinCC ActiveX control "IDB Runtime Control" as an OCX in Graphics Designer. This will help
WinCC users to start IDB Runtime within their environment.
The look and feel of IDB Runtime as an OCX is almost similar to the IDB Runtime as an
executable. However, there are few additional changes to IDB Runtime as an OCX and these
changes are covered in the subsequent sections.
6. IDB Runtime control should be available as an OCX within the controls list.
7. Drag and drop this OCX control to the container area within the PDL file window.
8. Once this control is added to the container, save the PDL file and click Runtime control in
Standard toolbar to activate Runtime mode.
9. The IDB Runtime control is displayed / opened on the WinCC Runtime screen.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 521
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
Note
Views
The screenshots provided in chapter "Views" are not valid for IDB Runtime as an OCX control.
While accessing IDB Runtime as an ActiveX control in WinCC, you will observe that the IDB
Runtime menu bar will not be displayed.
Note
"Password check" and "Trace logging" options
The "Password check" and "Trace logging" menu items existing within "Options" menu in IDB
Runtime application is available in "Password" tab and "Trace" tab as separate check boxes.
WinCC/IndustrialDataBridge
522 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
Options
Select "Options" toolbar button from IDB Runtime application to access Runtime Configuration.
The "Runtime Configuration" provides the following tabs:
• Startup Option
• Trace
• Password
• License
• NT Service
Note
Changes to the Runtime interface can be performed only if the IDB Service has been started.
The options provided within each of these tabs are same as the options in IDB Runtime
application. However, there are some additional features that are provided with IDB Runtime
as WinCC control. These features are highlighted below:
Language Option:
The IDB Runtime application provides language support. It supports 7 languages - English,
Spanish, German, Italian, Chinese, Japanese and French. While accessing IDB Runtime as
OCX control on WinCC Runtime screen, the language changes when the language of WinCC
Runtime has been changed.
The language option of IDB runtime control is not linked to IDB Runtime application or any
other IDB runtime control. This means that language change in IDB runtime control does not
change the language of other controls or IDB Runtime application and vice versa.
Trace Logging:
The Trace tab is provided next to Startup option tab. This tab is displayed only after you have
loaded the configuration file in IDB Runtime window.
The "Trace Logging" check box is available within the "Trace" tab of Runtime Configuration
window. Upon enabling this check box, it allows to save the trace messages generated both
from provider and consumer side. Within the Trace tab, the "Provider log file" and "Consumer
log file" sections provide options to specify the file name for logging the trace messages. At a
later point of time, the trace log files can be used to view these trace messages.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 523
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
Password Check:
The "Password Check" check box is provided within "Password" tab of Runtime Configuration
window. Once this check box is enabled, it generates a dialog box asking you to enter
the password each time an operation is performed within each of the tabs in Runtime
Configuration.
WinCC/IndustrialDataBridge
524 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
In IDB Runtime as OCX, the following points are valid with respect to the actions performed
within Open dialog box.
• Open dialog box is opened only in Read mode. You will be able to open only an XML file.
• Option to delete a file or folder is not provided within this dialog box.
• Options to cut/paste a file or folder and creation of new file/folder are not available.
• Menu pop-up on right mouse-click within the window area cannot be performed.
• Drag and drop of file or folder within the dialog box cannot be done.
• Options to rename file or folder using F2 key cannot be performed.
Multilingual Configuration
ndustrialDataBridge enables you to configure your projects and perform data transfer in multiple
languages. IDB supports multilingual configuration of all items containing text that is visible in
Configuration and Runtime interface.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 525
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
Supported Languages
In IndustrialDataBridge Configuration interface and Runtime interface, the following interface
languages are supported:
• German
• English
• French
• Italian
• Spanish
• Simplified Chinese
• Japanese
GUI language
The language that is selected during installation of IDB will be set as the language in which the
IDB CS or IDB RT menus, dialog boxes and help are displayed. However, you can switch to any
respective language within IDB application (CS and RT). If you have changed the GUI language
in IDB, the next time when you start IDB, the interface is displayed in the GUI language that you
had set up previously.
The technical terms especially the provider and consumer names will be displayed in English
language irrespective of the selected language in IDB.
4.6.5.1 Overview
Overview
In IDB application, when many connections need to be created, it consumes lot of time and
effort. Also, additional time is consumed especially whenever it is required to perform the link
configuration that includes configuring the provider and consumer configuration settings. To
reduce this time and effort, the IDB Configuration supports Drag and Drop feature. This feature
reduces the effort drastically and hence helps to meet the objectives or goal in a very short span
of time.
The Drag and Drop feature can be used in the following scenarios:
• Project tree: To drag and drop provider or consumer node onto another provider or
consumer node within the project tree
• Connection mapping: Drag and drop connection elements (column values) from provider
to consumer or viceversa in order to create a connection
WinCC/IndustrialDataBridge
526 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
4.6.5.2 Usage
Introduction
Building IDB configuration and creating connections is much easier and hence saves additional
time and effort using the Drag and Drop. The Drag and Drop functionality works within the
project tree as well as within the Connection mapping tab for creating connections. The next
sections describe further information regarding the usage of Drag and Drop in project tree and
for creating connections.
Project tree
The Drag and Drop can be performed within the project tree for dragging any provider or
consumer node and dropping to any provider or consumer node types. There is no restriction on
the provider or consumer types supported in IDB. The graphics shown below depicts a drag and
drop from a provider within Link 1 to another provider existing in Link 2. However, it is also
possible to drag the provider in Link 2 and drop to the provider in Link 1.
Follow the steps given below to perform a drag and drop within the project tree:
1. Click on the specific provider or consumer node within the project tree.
2. Hold the mouse key while the control is on the provider or consumer node and drag the
mouse pointer slowly towards the destination node.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 527
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
3. A valid drop displays a mouse pointer shown with a '+' (Plus) symbol. In any other case, the
drop does not happen successfully.
4. The mapping should be either from provider to provider node or consumer to consumer
node. If you drag provider node and move towards another provider node, the mouse pointer
modifies to a dotted line with another small rectangular box containing a '+' (Plus) symbol.
This is the indication of a perfect drop.
Note
Drag and Drop
• While performing a drag and drop from one provider / consumer node to a provider /
consumer node of another type, a confirmation dialog is displayed that prompts you to
confirm in order to proceed further. Please note that performing this drag and drop action will
modify the existing provider / consumer configuration and its connection mapping settings.
• If there are any connections already existing within the provider or consumer node, the
corresponding connections within the specified link will be deleted. For example, if you drag
consumer node of Link 1 (containing 1 connection) to consumer node of Link 2 (containing
1 connection), a confirmation dialog will be displayed if you wish to continue further. If you
confirm the changes by clicking "Yes", then the Link 2 consumer configuration along with its
connection mapping settings will be modified and the connection(s) will be deleted.
Connections
In Connection mapping tab, the column values within the provider and consumer section can be
mapped from the provider to consumer type by dragging and dropping the data values. In this
way, connections can be created in a much faster way. It is not required every time to firstly select
the provider column, navigate to consumer column and then click on Connect button. Easily,
you will be able to create connections that saves lot of time. A "<Default Column>" will be listed
in the last row within the list of column names that allows you to map provider / consumer
columns.
More detailed information and steps to be followed for creating connections using Drag and
Drop is provided in Chapter "Creating connections using Drag and Drop (Page 529)".
Note
Database as consumer
The Drag and drag feature does not work while using the consumer type "Record per tag" in
Database consumer.
WinCC/IndustrialDataBridge
528 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
Requirements
Following are the list of tasks to be essentially performed before performing a drag and drop to
create connection(s) between provider and consumer data columns:
• A new project is created with "Database" as provider and "CSV/TXT" as consumer
• The respective Database provider configuration settings and CSV/TXT consumer
configuration settings are performed accordingly
• The Database transfer options that includes provider settings, data transfer settings and
trigger settings are configured
• In Connection mapping tab, a table name is selected in Database provider section and the
column names are listed in "Columns" area
• The CSV file name is selected in CSV/TXT consumer section and the column names are listed
in "Columns" area
Note
Connection name
Before performing a drag and drop, it is important to ensure to have a connection name defined
in the "Connection name" field text box that exists within "Connection mapping settings" area.
The connection mapping settings is displayed to the right portion of Connection mapping tab.
Either a connection name needs to be entered in the "Connection name" text box or else any of
the default name options should have been selected.
If you perform a drag and drop from provider column to consumer column or viceversa with
connection name being blank and "Enable default name" check box being unchecked, a warning
message "Connection name cannot be null" will be displayed.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 529
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
WinCC/IndustrialDataBridge
530 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
5. Irrespective of the number of data columns existing within the provider or consumer section,
you can drop by moving the mouse pointer and then releasing the mouse button at
appropriate data column.
Auto scrolling is automatically enabled as you start moving the mouse pointer across the list
of data columns, however long the list exists.
6. A connection will be created and thus displayed within the "Connections" area towards right
hand portion of Connection mapping tab.
7. Repeat steps 1 - 4 to create the connections (column mapping) between provider and
consumer columns.
Note
<Default Column>
The "Default Column" option is listed in the last row within the list of column names ("Columns"
area) of all provider and consumer types
You can perform a drag and drop from a default column of provider to an already existing
consumer column or viceversa.
Note
Data type conversion
While performing drag and drop, if the provider column data type does not match with
consumer column, IDB CS converts the provider data type to match with data type of consumer.
A status window is displayed to indicate this change.
Note
While performing a drag and drop of any provider column to Default column in consumer within
Connection mapping window, it will take the data type as that of the provider column and
viceversa.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 531
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
Requirements
Following are the list of tasks to be essentially performed before performing a drag and drop to
create connection(s) between provider and consumer tags or data columns:
• A new project is created with "OPC Data Access" as provider and "WinCC User Archive" as
consumer
• The respective OPC Data Access provider configuration settings and WinCC User Archive
consumer configuration settings are performed accordingly
• The OPC Data Access transfer settings that includes provider group settings and trigger
settings are configured.
• In Connection mapping tab, OPC Data Access provider section, the OPC tags are listed within
the OPC tag browser.
• The table name is selected in WinCC User Archive consumer section and the column names
are listed in "Columns" area
Note
Connection name
Before performing a drag and drop, it is important to ensure to have a connection name defined
in the "Connection name" field text box that exists within "Connection mapping settings" area.
The connection mapping settings is displayed to the right portion of Connection mapping tab.
Either a connection name needs to be entered in the "Connection name" text box or else any of
the default name options should have been selected.
If you perform a drag and drop from provider tag / column to consumer column or viceversa with
connection name being blank and "Enable default name" check box being unchecked, a warning
message "Connection name cannot be null" will be displayed.
WinCC/IndustrialDataBridge
532 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 533
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
4. Next, perform the drop by releasing the mouse button when the control is on the respective
column name in WinCC User Archive consumer.
5. Irrespective of the number of tags or columns existing within the provider or consumer
section, you can drop by moving the mouse pointer and then releasing the mouse button at
appropriate data column.
Auto scrolling is automatically enabled as you start moving the mouse pointer across the list
of data columns, however long the list exists.
6. A connection will be created and thus displayed within the "Connections" area towards right
hand portion of Connection mapping tab.
7. Repeat steps 1 - 4 to create the connections (column mapping) between provider and
consumer columns.
Note
<Default Column>
The "Default Column" option is listed in the last row within the list of column names ("Columns"
area) of all provider and consumer types
You can perform a drag and drop from any OPC tag in OPC Data Access provider to a Default
Column in WinCC User Archive consumer.
You can perform a drag and drop from any WinCC User Archive consumer column to the Default
Column in OPC Data Access provider.
You will not be able to drag and drop the Default Column in WinCC User Archive consumer with
the columns in OPC Data Access provider.
Note
Data type conversion
While performing drag and drop, if the provider column data type does not match with
consumer column, IDB CS converts the provider data type to match with data type of consumer
column. A status window is displayed to indicate this change.
Note
While performing a drag and drop of any provider column to Default column in consumer within
Connection mapping window, it will take the data type as that of the provider column and
viceversa.
WinCC/IndustrialDataBridge
534 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
Requirements
Following are the list of tasks to be essentially performed before performing a drag and drop to
create connection(s) between provider and consumer data columns:
• A new project is created with "Dynamic database" as provider and "Send/Receive" as
consumer
• The respective Dynamic database provider configuration settings and Send/Receive
consumer configuration settings are performed accordingly
• The Dynamic database transfer settings that includes selecting the table name, schema and
trigger provider settings are configured.
• In Connection mapping tab, Dynamic database provider section, the table name is selected
and the column names are listed in "Columns" area.
• In Send/Receive consumer, ensure the start point of tag in First byte field along with its data
type are already specified and listed.
Note
Connection name
Before performing a drag and drop, it is important to ensure to have a connection name defined
in the "Connection name" field text box that exists within "Connection mapping settings" area.
The connection mapping settings is displayed to the right portion of Connection mapping tab.
Either a connection name needs to be entered in the "Connection name" text box or else any of
the default name options should have been selected.
If you perform a drag and drop from provider column to consumer column or viceversa with
connection name being blank and "Enable default name" check box being unchecked, a warning
message "Connection name cannot be null" will be displayed.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 535
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
WinCC/IndustrialDataBridge
536 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
5. A dialog box with title "SR memory address" will be displayed. Enter a value in "First byte"
field text box.
In case of String data type, enter a number within the range 1 - 255. Next, press the "OK"
button.
6. A connection will be created and thus displayed within the "Connections" area towards right
hand portion of Connection mapping tab.
7. Repeat steps 1 - 5 to create the connections (column mapping) between provider and
consumer columns.
Note
<Default Column>
The "Default Column" option is listed in the last row within the list of column names ("Columns"
area) of all provider and consumer types
While performing drag and drop, you can drag and drop any of the Dynamic database provider
column to the Default Column in Send/Receive consumer and not with any other column.
You will not be able to drag and drop the Default Column in Send/Receive consumer with the
columns in Dynamic database provider.
Note
Data type conversion
While performing drag and drop, if the provider column data type does not match with
consumer column, IDB CS converts the provider data type to match with data type of consumer.
A status window is displayed to indicate this change.
Note
While performing a drag and drop of any provider column to Default column in consumer within
Connection mapping window, it will take the data type as that of the provider column and
viceversa.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 537
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
Requirements
Following are the list of tasks to be essentially performed before performing a drag and drop to
create connection(s) between provider and consumer columns/tags:
• A new project is created with "WinCC OLEDB" as provider and "Free Text Editor" as consumer
• The respective WinCC OLEDB provider configuration settings and Free Text Editor consumer
configuration settings are performed accordingly
• The WinCC OLEDB transfer settings that includes archive settings, time settings and time
span / start-up behavior / trigger settings are configured.
• In Connection mapping tab, WinCC OLEDB provider section, the column names are listed in
"Columns" area.
• In Free Text Editor consumer section, ensure the respective HTML / Text tags are displayed in
the editor window area that begin and end with @ symbol.
Note
Connection name
Before performing a drag and drop, it is important to ensure to have a connection name defined
in the "Connection name" field text box that exists within "Connection mapping settings" area.
The connection mapping settings is displayed to the right portion of Connection mapping tab.
Either a connection name needs to be entered in the "Connection name" text box or else any of
the default name options should have been selected.
If you perform a drag and drop from provider column to consumer column or viceversa with
connection name being blank and "Enable default name" check box being unchecked, a warning
message "Connection name cannot be null" will be displayed.
WinCC/IndustrialDataBridge
538 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 539
WinCC/IndustrialDataBridge Documentation
4.6 Advanced Features
4. Next, perform the drop by releasing the mouse button when the control is within the
respective consumer tag in Free Text Editor consumer.
Note
Consumer tag rules
Ensure that the consumer tags adhere to the tag rules before performing a drag and drop to
create connection between WinCC OLEDB and Free Text Editor consumer.
Refer Chapter 3.12.2 "Requirements (Page 448)" for more information about the tag rules.
Note
In FTE consumer editor window, If a drag and drop is performed on an empty area or in
between HTML tags or XML tags or text, a new consumer tag is created that uses provider
column name as the tag name.
5. A connection will be created and thus displayed within the "Connections" area towards right
hand portion of Connection mapping tab.
6. Repeat steps 1 - 4 to create the connections (column mapping) between provider column and
consumer tags.
Note
<Default Column>
The "Default Column" option is listed in the last row within the list of column names ("Columns"
area) of all provider and consumer types
While using FTE as consumer, you will not be able to perform a drag and drop from a default
column of any provider type to the tag existing in Free Text Editor consumer section.
The Default Column option does not stand valid for Free Text Editor consumer.
Note
Data type conversion
While performing drag and drop, if the provider column data type does not match with
consumer column, IDB CS converts the provider data type to match with data type of consumer
column. A status window is displayed to indicate this change.
Note
While performing a drag and drop of Default column in provider to consumer tag within
Connection mapping window, it will take the data type as that of the consumer column.
WinCC/IndustrialDataBridge
540 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.7 FAQs
4.7 FAQs
• Can I use an XML configuration file created using previous version of IDB?
Yes, XML configuration file created using previous version of IDB can be directly loaded into
Runtime.
However, for using/modifying this XML configuration file in Configuration module, user
needs to Import this configuration file, this would create a project in IDB CS.
• Is a project file compulsory for working with IDB CS V7.2/V7.3/V7.4/V7.4 SP1/V7.5/V7.5
SP1/V7.5 SP2/V8.0?
Yes
• How can I change the Default Project storage location for IDB CS Projects?
An option has been given on the editor under Option->Settings menu for the same in IDB TIA.
On the editor open, go to “Storage settings” group box and modify the “Storage location for
projects”.
• How to load a configuration created in IDB CS in IDB Runtime?
Once a configuration is ready in IDB CS, user can generate the Runtime configuration data
using an option (Generate runtime configuration) given in IDB CS. This option generates the
XML Configuration file required to operate in Runtime.
• How can I reset the settings performed within the IDB CS application?
In IDB CS menu, select "Options" > "Settings" to open the "Settings" window in work area. On
left pane of "Settings" window, click "General" to view the "General" settings in right pane.
The "Reset to default" section area provides the required settings to reset the settings to
default.
• Where can I find the definitions for all the available keyboard shortcuts?
There is an option given in the Settings editor under Option->Settings menu for the same. Go
to “Keyboard Shortcuts” on the options displayed on the left side of the opened editor
window.
• The provider/consumer configuration window or any other editor window do not
provide options to Save.
In IDB CS, the data entered within the configuration window/editors will be automatically
saved.
• Is it required to have a complete installation of IDB on WebNavigator Client machine for
using IDB Runtime control remotely via WebNavigator?
No, complete installation of IDB is not required on the WebNavigator client. Only IDB client
installation is required which is done by the WebNavigator setup.
• Can I make IDB Runtime service Manual/Automatic from a remote Web client?
Yes.
• Is there a limitation on number of clients that can connect to a single IDB Runtime
Service?
No, there is no limitation.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 541
WinCC/IndustrialDataBridge Documentation
4.7 FAQs
• Can the user on WebNavigator client start and stop IDB Runtime Service remotely with
the option provided on the IDB Runtime control?
No, User cannot perform this operation remotely. These operations along with change of
User account and port number is disabled for the user to change/modify.
• I modified the ConfigurationFilespath and TraceFilesPath in the registry under Siemens/
IT4Industry/IndustrialDataBridge. Do, I need to restart the system for changes to take
effect?
No, system restart is not required. However, IDB service need to be restarted.
• Is WinCC required to be in running state in order to configure the User Archive?
Yes, WinCC is required to be started to be able to access the User Archive and configure User
Archive as provider and consumer in IDB CS application.
• Can a user start data transfer to or from OPC XML on a machine WebNavigator is
configured and running?
Some Operating system (For Ex: WinXP) doesn’t allow simultaneously running of more than
one websites. On these Operating system, it is not possible to run OPC XML along with
WebNavigator.
On Operating systems where these are allowed, both OPC XML and WebNavigator can run
simultaneously.
• Is Connectivity Pack License required for browsing OPC XML tag in WinCC?
Yes
• Is it possible to get the count of the bad quality connection in OPC XML Provider/
Consumer?
Yes, it is possible to get the count of the bad quality connection. For this, in OPC XML Data
Access Consumer Configuration, user needs to associate a tag in “Configuration for bad
quality item”. During runtime, the count of the bad quality item will be written into the
configured tag.
• Not able to browse the OPC XML Tags. What are the possible reasons?
Check the following scenarios,
a. Check whether the OPC XML Web service is running or not in Internet Information
Services (IIS). If not run the OPC XML web service in IIS.
b. Ensure whether the IIS is installed before installing .NET Framework.
c. Refer the WinCC documentation for configuring OPC XML Web service in IIS.
• When I open the CSV file, the following error message is displayed: "Excel has detected
that ‘<file>’ is a SYLK file, but cannot load it. Either the file has errors or is not a SYLK file
format. Click OK to try to open this file in a different format."
This error occurs when the first column name is “ID” both I and D capital. To avoid this error,
one can rename this column to small case or any prefix or suffix to ID.
• I have created a CSV file manually (not by IDB CS) with the intention of transferring
Unicode data, but data is not showing correctly. Required language packs are installed
on my machine.
File should be created in UTF-8 character encoding format for this. Open the file as a txt file
and while saving, select the encoding as UTF-8.
• Unable to change the consumer type option on the Database consumer type
configuration, so as the schema and table?
These options will be in disable state, if there is any connection exists. So ensure that there
are no connections exist to change the consumer type option.
WinCC/IndustrialDataBridge
542 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.7 FAQs
• How to transfer data when the table has a foreign key relation?
Use the Per-Tag Database consumer type for the data transfer.
• I have created a table in Oracle database, however I am not able to transfer Unicode
data in the table.
For transferring Unicode data in Oracle, ensure that the database is created with UTF 8
character encoding support.
• Can I edit the connection string on the configuration screen?
Yes, you can edit the connection string in Configuration window. The connection string and
the fields are updated accordingly.
• OPC tag browser is not listing any OPC DA Server. However, there are OPC servers
installed on the machine. What could be the problem?
To browse OPC DA servers, opcenum.exe should be running as a service on the server
machine.
To check whether this service is running , Go to start -> Run. Type services.msc and press
enter. If “opcenum” is not started, make it automatic mode and start it.
If not able to browse OPC servers on remote machine, ensure that the above step is done on
the remote machine.
• Not able to browse the items of an OPC DA Server.
Check if the OPC server is running. If it is not running, start the OPC Server.
• Not able to browse the OPC Items on remote computer.
Check if the DCOM settings are proper.
If DCOM settings are configured properly, then verify the login user account on both the
Server and Client computers.
Note
If you are trying to access the WinCC tags, then in both the computers ensure that the login
user accounts are members of SIMATIC HMI group in "Local Users and Groups" window.
More detailed information is provided in Chapter 3.2 OPC Data Access (Page 204) in the IDB
Documentation manual
• I have only IDB installed, how can I use Send/Receive as Provider or Consumer. Is there
any option in IDB to configure the Step7 Project?
To use Send/Receive as Provider or Consumer, a Step7 Project is also required. There is no
option in IDB to configure this project. A Step7 project is created and the program is
downloaded in PLC. Without this, Send/Receive would not work in IDB runtime.
• In IDB CS, Send/Receive connection mapping screen, is it required to set the number
fields same for both provider and consumer?
No
• Is it possible to have same names for two links or connections?
No it is not possible.
• Can we rename an already created link or connection?
Yes, an existing link or connection name can be renamed. In Project tree, perform a single
click on the link or connection. The link name will be changed to an editable area allowing
you to modify the link name.
• I see some consumer data as “??” or square boxes.
Data transferred is Chinese or Japanese and system doesn’t have language pack installed for
these languages. Installing correct MUI language pack would fix this issue.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 543
WinCC/IndustrialDataBridge Documentation
4.7 FAQs
• A notification to be given to the operator when IDB is not able to transfer data. Is it
possible?
Yes, this can be achieved if the user has installed WinCC. IDB sends Alarm messages when an
error occurs during the data transfer. This is inbuilt in IDB and no additional settings are
required for this.
• I want to see a detailed report if there are any failures during data transfer.
For detailed report on reason for data failure, user needs to configure trace log settings and
enable the trace logging. This setting can also be done remotely on a WebClient.
• I installed IDB then I installed MUI package for Chinese and Japanese. I don’t find an
option to switch to Chinese and Japanese in IDB CS.
IDB Configuration module would need a repair/modify for the new languages to be shown.
However, IDB Runtime would take the effect without IDB setup Repair/modify/reinstallation.
• On uninstallation of IDB, what files/folders are removed and what files/folders are
retained.
– All IDB related binaries are removed except OPC related binaries if used by other products
like WinCC.
– However, Configuration files and folders, Trace files and folders etc are not removed.
– Editors layout settings are also not retained.
– License files are not removed.
• OPC XML DA does not work after performing the installation of .NET Framework V2.0
and IIS
It is important to ensure that you need to firstly install IIS. After installing IIS, install the .NET
Framework. If the order of installation is changed, ASP.NET will not be registered in IIS. To
resolve this issue, execute the following command in command prompt:
C:\Windows\Microsoft.Net\Framework\v2.0.50727\aspnet_regiis.exe –i
If the System path is not set to "C:\Windows", modify the path.
After executing the above mentioned command, reset IIS by entering the command "iisreset"
in command prompt.
• The output file is not known. Is it mandatory to specify a output file name in Free Text
Editor consumer configuration?
No, the output file is not mandatory. If there is no output file name specified, IDB CS
application will take a default file name with "_output" as suffix.
WinCC/IndustrialDataBridge
544 System Manual, 03/2023, A5E51010757-AA
WinCC/IndustrialDataBridge Documentation
4.7 FAQs
• I do not have a base file existing in the computer hard drive, Ist it still possible to create
a connection?
Yes, it is possible to create a connection. You can add the base file content in the edit/preview
window embedded within the Free Text Editor consumer tab in Connection mapping
window. Next, click "Save" button to save the changes. The complete base file can be thus
created.
• In Connection mapping window > Free Text Editor consumer > Consumer settings tab,
I have selected "Replace existing file" option. Which file is getting replaced?
The output file is being replaced. Verify the time of output file creation. This will show the
latest time, which means that the output file is replaced each time during every iteration.
• The base file does not contain any HTML/XML tags. Is it possible to create a connection
mapping between provider and consumer types?
Yes, it is possible. To achieve this, drag and drop the provider columns in Free Text Editor
consumer HTML/XML/Text editor area. The tags will be created automatically.
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 545
WinCC/IndustrialDataBridge Documentation
4.7 FAQs
WinCC/IndustrialDataBridge
546 System Manual, 03/2023, A5E51010757-AA
Index
Creating Connections from the Provider
database, 301
A WinCC OLE DB, 274
WinCC User Archive, 415
Add link(s) graphically, 165
CSV and TXT Files
Creating a Connection to the Consumer, 368
Overview, 367
B Customer support, (See support)
Buttons
Runtime, 490
D
database
C Connecting Tags from a Provider, 313
Configuration interface, 199 Connecting Tags to the Consumer, 329
Configuring a Trigger, 289, 343, 421 Creating a Connection to the Consumer, 316
Configuring Free Text Editor as Consumer Creating Connections from the Provider, 301
Free Text Editor, 449 Overview, 297
Connecting OPC Tags from a Provider Delete variables
WinCC User Archive, 433 WinCC User Archive, 445
Connecting Tags from a Provider Diagnostic Settings, 498
database, 313 Dynamic Database
Dynamic Database, 348 Connecting Tags from a Provider, 348
Dynamic Database - OPC Tags, 354 Connecting Tags to the Consumer, 363
OPC data access, 213 Creating a Connection to the Consumer, 356
Send/Receive, 404 Creating a Connection to the Provider, 337
WinCC OLE DB, 294 Overview, 333
WinCC User Archive, 426 Where Statement, 351
Connecting Tags from the Provider Dynamic Database - OPC Tags
OPC Unified Architecture, 473 Connecting Tags from a Provider, 354
Connecting Tags to a Free Text Editor
Free Text Editor, 455
Connecting Tags to the Consumer E
database, 329
Error report, (See support)
Dynamic Database, 363
Excel
Excel, 387
Connecting Tags to the Consumer, 387
IDB OPC Server, 245
Overview, 379
OPC data access, 224
Requirements, 380
OPC Unified Architecture, 484
Exporting a WinCC Archive Configuration, 273
Send/Receive, 412
WinCC User Archive, 441
Consumer Type, 322
Creating a Connection to the Consumer
F
CSV and TXT Files, 368 FAQ, (See support)
database, 316 Free Text Editor
Dynamic Database, 356 Configuring Free Text Editor as Consumer, 449
Send/Receive, 406 Connecting Tags to a Free Text Editor, 455
WinCC User Archive, 435 Overview, 447
Creating a Connection to the Provider Requirements, 448
Dynamic Database, 337
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 547
Index
S
M Send/Receive
Menu commands Configuring Connection Types, 398
Runtime, 489 Connecting Tags from a Provider, 404
Connecting Tags to the Consumer, 412
Creating a Connection to the Consumer, 406
N Overview, 389
Start settings, 495
NT Service, 495, 503
Status View, 492
Support, 17, 20
Support Request, 20
O
Online support, (See support)
WinCC/IndustrialDataBridge
548 System Manual, 03/2023, A5E51010757-AA
Index
T
Technical support, (See support)
Trace, 498
Trace recording
change, 500
Save, 500
Start, 499
Trace View, 491
Transaction Type, 328
V
VBScript, 58, 81, 99, 122, 141, 293, 347, 425
Views
Status View, 492
Trace View, 491
W
Where Statement
Dynamic Database, 125, 351
WinCC User Archive, 429, 444
WinCC OLE DB
Connecting Tags from a Provider, 294
Creating Connections from the Provider, 274
Overview, 270
Prerequisites in WinCC, 271
WinCC Option, 12
WinCC User Archive
Connecting OPC Tags from a Provider, 433
Connecting Tags from a Provider, 426
Connecting Tags to the Consumer, 441
Creating a Connection to the Consumer, 435
Creating Connections from the Provider, 415
Delete variables, 445
Overview, 415
Where Statement, 429, 444
WinCC/IndustrialDataBridge
System Manual, 03/2023, A5E51010757-AA 549
Index
WinCC/IndustrialDataBridge
550 System Manual, 03/2023, A5E51010757-AA