SIMATIC S7 Connector Configurator enUS en-US
SIMATIC S7 Connector Configurator enUS en-US
Regulation (GDPR) 1
Security information 2
Security Information for
Industrial Edge App 3
Introduction to SIMATIC S7
Connector 4
SIMATIC S7 Connector User Interface for SIMATIC
Configurator V1.4 S7 Connector Configurator 5
Home Page
Additional Information 7
10/2021
A5E50594971-AC
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.
Personal data
There is no personal data* collected but following data is stored to allow machine to machine
communication:
• Industrial Edge Databus credentials
• S7+ legitimization credentials
• OPC-UA server login credentials
• OPC-UA server certificates for encryption and signing
• Tags data and metadata from field devices
• Timestamp
• Smart device information and app usage data
If the customer links the data mentioned above to other data (e.g., shift plans) or if the customer
saves personal information on the same medium (e.g. hard disk) and thus creates a personal
reference, the customer has to ensure that the guidelines regarding data protection are
observed.
Note
* This section refers to any personal data processed by the Application other than the personal
data contained in log-files / tracking data (if any). "Personal data" are any information relating to
an identified or identifiable natural person. Please note that IP-addresses, device identifiers such
as IMEI, UDID, IMSI, MAC-address, MSISDN, location data or machine data (if machine data
tracks events triggered by user interaction with the machine) usually qualify as personal data.
Purposes
The data mentioned above is required for the following purposes:
• Access protection and security measures
• Message system for traceability and availability
• For app diagnosis
Storage of the data is affected for a suitable purpose and is limited to what is strictly necessary,
as the information is indispensable in order to identify the authorized operators.
Securing of data
The above data will not be stored anonymously or pseudonymized, as the purpose
(identification of the operating personnel) cannot be achieved otherwise.
The following data will be used only within the product and within the Edge eco-system and will
not be automatically passed on to third parties or unauthorized persons:
• Industrial Edge Databus credentials
• S7+ legitimization credentials
• OPC-UA server login credentials
• OPC-UA server certificates
The above data is secured by adequate technical measures, such as storing and encryption of
process data in databases.
The tags data and metadata from field devices data will be used only within the product and will
not be automatically passed on to third parties or unauthorized persons.
The customer must ensure the access protection as part of his process configuration.
Deletion policy
This product does not provide an automatic deletion for the databus or PLC credentials already
provided by the user. In case the user provides a different databus or PLC credentials, the
previous credentials will be overwritten. Since there is no explicit delete option, the user could
provide junk databus or PLC credentials to delete the existing valid credentials.
If the user deletes a connection or tag, then the credentials information and other details would
also be deleted.
In short, the collected log data will be automatically deleted once the limit is reached (oldest
entries first).
Data configuration
The customer can configure the data collected via the product as follows:
• Using the App Configurator
Home page
When you launch SIMATIC S7 Connector Configurator, the home page is displayed as follows:
3 5
1 4 10 6
2
7 8 9
UI Elements
The following table lists the different UI elements in the "Configure" section page:
Symbol Description
Add Data Source Button Enables to add a new data source.
Delete Button Enables to delete the data source and data points.
S7 Connector Tab Area to display S7-Protocol (S7-300/400/1200/1500) and Optimized S7-Pro‐
tocol (S7-1200/1500) data source connections.
OPC-UA Connector Tab Area to display OPC UA (OPC Server) data source connections.
Data Source Table Displays the data source connections and data points and their information
as follows:
• "Name": Displays the name of the data point. You can use to align the
data point name. By default, the data point name is left aligned.
• "Comments": Displays the given comments.
• "Address": Displays the address of the data point.
• "Data Type": Displays the data point type.
• "Acquisition Cycle": Displays the acquisition cycle with which the data is
sent to the Databus.
• "Acquisition Mode": Displays the acquisition mode with which the data is
sent to the Databus.
• "Access Mode": Displays the access permission.
• "Actions": Displays the "Edit Data Source", "Add Tags", "Import Tags", and
"Browse" options. For more information, refer Managing Tags/Data Points
(Page 28).
Deploy Button Enables to deploy the project. If you close the SIMATIC S7 Connector Config‐
urator, then all the unsaved configurations are lost. The "Deploy" button saves
the configuration on the Industrial Edge Runtime of the SIMATIC S7 Connec‐
tor.
Start/Stop Project Button Enables to start and stop the project.
Import/Export Icons Enable to import and export the configuration. For more information,
refer Import/Export Configuration (Page 47).
Settings Icon Enables to perform the following tasks:
1. You can edit IE Databus service name.
2. You can specify SIMATIC S7 Connector user credentials which you define
in Industrial Edge Databus Configurator.
3. You can specify configuration version of the SIMATIC S7 Connector Con‐
figurator.
4. You can specify browse timeout.
For more information, refer Configure Settings (Page 42).
The following indicators indicate the connection status of Bus Adaptor connection with TagData/
Metadata and AlarmData MQtt clients:
Color Status
Color Status
Note
When you perform
• add, edit, or delete of a data source,
• add, edit, import, or delete of a tag,
you must click "Deploy" button to save the changes on the Industrial Edge Runtime of the
SIMATIC S7 Connector.
Example Scenario
A Plant Administrator or Industrial Edge Box Operator would like to configure the data
acquisition from the S7-Protocol (S7-300/400/1200/1500) controller, and subsequently would
like to create value from the acquired data.
Prerequisite
The SIMATIC S7 Connector Configurator must be running.
Procedure
To configure S7-Protocol (S7-300/400/1200/1500) controller data source, follow these steps:
1. Launch the SIMATIC S7 Connector Configurator.
The Configurator home page is displayed.
2. Click "Add Data Source" in the upper-left corner under the "S7 Connector" tab.
The "Add" dialog box is displayed as follows:
3. Select the S7-Protocol (S7-300/400/1200/1500) data source type from the "Data Source
Type" drop-down.
The fields are displayed as follows:
Example Scenario
A Plant Administrator or Industrial Edge Box Operator would like to configure the data
acquisition from the Optimized S7-Protocol (S7-1200/1500) controller, and subsequently would
like to create value from the acquired data.
Prerequisite
The SIMATIC S7 Connector Configurator must be running.
Procedure
To configure Optimized S7-Protocol (S7-1200/1500) controller data source, follow these steps:
1. Launch the SIMATIC S7 Connector Configurator.
The Configurator home page is displayed.
2. Click "Add Data Source" in the upper-left corner under the "S7 Connector" tab.
The "Add" dialog box is displayed as follows:
3. Select the Optimized S7-Protocol (S7-1200/1500) data source type from the "Data Source
Type" drop-down.
The fields are displayed as follows:
Example Scenario
A Plant Administrator or Industrial Edge Box Operator would like to configure the data
acquisition from the PLC's OPC-UA Server, and subsequently would like to create value from the
acquired data.
Prerequisite
The SIMATIC S7 Connector Configurator must be running.
Procedure
To configure OPC-UA server data source, follow these steps:
1. Launch the SIMATIC S7 Connector Configurator.
The Configurator home page is displayed.
2. Click "Add Data Source" in the upper-left corner under the "OPC-UA Connector" tab.
The "Add" dialog box is displayed as follows:
3. Select the OPC UA (OPC Server) data source type from the "Data Source Type" drop-down.
The fields are displayed as follows:
Note
• It is not mandatory to sync time between IED and PLC with UTC. By default, the IED time is
published in case of OPC-UA Tags.
• To ensure there is no data loss PLC cycle should be lower than or equal to the Acquisition cycle
in the Configurator.
• If you configure secure OPC-UA connection using certificates, you must ensure that the
certificates generated in the PLC must not be of future time. (PLC/OPC-UA server time should
not be future time.)
• User has to ensure the sampling and publishing interval should be less than or equal to the
Acquisition cycle configured in OPCUA for no data loss.
Note
OPC-UA Support for Non-Siemens PLC
SIMATIC S7 Connector Configurator supports reading of the tag values from non-Siemens PLC for
OPC-UA connection. It supports PLC Type: OMRON NX102-1200 with Firmware version: V1.31.
When you configure non-Siemens PLCs for example OMRON, you must provide the address of
the tag in following format:
ns=urn:OMRON:NxOpcUaServer:FactoryAutomation;s="<Tag_name>"
OPC-UA connection with authentication and messaging mode is not supported for OMRON PLC.
Prerequisite
• The SIMATIC S7 Connector Configurator must be running.
• A data source must be available.
Procedure
To edit a data source, follow these steps:
1. Launch the SIMATIC S7 Connector Configurator.
The Configurator home page is displayed.
2. Click under the "Actions" column of the data source that you want to edit.
The "Edit Data Source" dialog box is displayed.
3. Modify the relevant details.
Note
You cannot edit the "Connection Name" and "IP Address" for a data source once it is at
Industrial Edge Runtime (project deployed and started).
4. Click "Save".
The data source is modified and displayed in the "Data Source" table.
Prerequisite
• The SIMATIC S7 Connector Configurator must be running.
• A data source must be available.
Procedure
To delete a data source, follow these steps:
1. Launch the SIMATIC S7 Connector Configurator.
The Configurator home page is displayed.
2. Select the data source records that you want to delete.
3. Click "Delete" in the upper-left corner.
A confirmation message is displayed.
4. Click "OK".
The data sources are deleted and removed from the "Data Source" table.
The deleted data is hidden and only after click on "Deploy" it is deleted from the Industrial
Edge Runtime.
Prerequisite
• The SIMATIC S7 Connector Configurator must be running.
• A data source must be available.
Procedure
To add data points from a data source, follow these steps:
1. Launch the SIMATIC S7 Connector Configurator.
The Configurator home page is displayed.
2. Click under the "Actions" column of the data source to which you want to add a tag.
The "Add Tags" dialog box is displayed based on the data source as follows:
For S7-Protocol (S7-300/400/1200/1500):
Note
• Only the 'Char' data type supports the array feature for S7-Protocol
(S7-300/400/1200/1500) data source in the configurator, but the data is published as
simple scalar values for each array elements.
• If you have configured string datatype in TIA Portal, then you need to provide the length
of the string when configuring the tag in S7 Connector or by default the string length is
set to 210 for S7-Protocol (S7-300/400/1200/1500). For more information, refer
section Fixed Length String (Page 81).
With "Configurator Version" as 1.2, all the array elements are published as scalar Char value.
Any value change notification of one child element results in publishing of only that child tag
value.
Note
• Optimized S7-Protocol (S7-1200/1500) data source does not support the array feature.
• If you have configured string datatype in TIA Portal, then you need to provide the length
of the string when configuring the tag in S7 Connector or by default the string length is
set to 254 for Optimized S7-Protocol (S7-1200/1500). For more information, refer section
Fixed Length String.
For OPC UA (OPC Server):
Note
• The array data for OPC UA (OPC Server) data source is published as simple scalar value as
String and Pipe separated.
• OPC UA (OPC Server) data source does not support the "String Length" field.
Prerequisite
• The SIMATIC S7 Connector Configurator must be running.
• A data source and a data point must be available.
Procedure
To edit a data point, follow these steps:
1. Launch the SIMATIC S7 Connector Configurator.
The Configurator home page is displayed.
2. Click under the "Actions" column of the data point that you want to edit.
The "Edit Tag" dialog box is displayed.
Note
You cannot edit the "Tag Name", "Acquisition Mode", "Data Type", and "Access Mode" for a tag
once it is at Industrial Edge Runtime.
Prerequisite
• The SIMATIC S7 Connector Configurator must be running.
• The required data points file must be available.
Procedure
To import the data points, follow these steps:
1. Launch the SIMATIC S7 Connector Configurator.
The Configurator home page is displayed.
2. Click under the "Actions" column of the data source to which you want to import the data
points.
The "Open" dialog box is displayed as follows:
It displays the valid tags in ‘success’ section, duplicate tags and existing tags already loaded
in the configurator in ‘warning’ section, and tags having invalid data types in ‘failure’ section.
You can click "Details" hyperlink to view the invalid datatype tags details.
4. Click "OK".
The "Import Tags" dialog box is displayed as follows:
Note
• You can use in "Name" column to align the tag name. By default, the tag name is left
aligned.
• The duplicate tags are displayed in the red box. You can edit the tag name using .
5. Specify the acquisition cycle, acquisition mode, and access mode using "Acquisition Cycle",
"Acquisition Mode", and "Access Mode" drop-down respectively.
6. Mark true against the tags that you want to import and click "Add Tags".
The tags are added below the data source.
Prerequisite
• The SIMATIC S7 Connector Configurator must be running.
• A data source must be available.
Procedure
To browse the data points, follow these steps:
1. Launch the SIMATIC S7 Connector Configurator.
The Configurator home page is displayed.
2. Click under the "Actions" column of the data source of which you want to browse the data
points.
The "Browse" dialog box is displayed as follows:
It displays the valid tags in ‘success’ section and duplicate tags and existing tags already
loaded in the configurator in ‘warning’ section.
3. Click "OK".
The "Browsed Tags" dialog box is displayed as follows:
You can use Datablock and tag filters to filter the required tags. A datablock is an array of tags.
The "Datablock Filter" drop-down field lists all the datablocks available in the PLC. You can use
the "Datablock Filter" drop-down to select the required datablocks. Once you select the
datablocks and click , the tags that are present in the selected datablocks are displayed. In
addition, you can use "Tag Filter" field to further filter the tags.
Note
• Only Optimized S7-Protocol (S7-1200/1500) supports "Datablock Filter" and "Tag Filter"
fields.
• Browsing data is cached for already browsed Optimized S7-Protocol (S7-1200/1500)
connection. But only the last browsed data depending on filters is cached.
• You can use in "Name" column to align the tag name. By default, the tag name is left
aligned.
• The duplicate tags are displayed in the red box. You can edit the tag name using .
4. Specify the acquisition cycle, acquisition mode, and access mode using "Acquisition Cycle",
"Acquisition Mode", and "Access Mode" drop-down respectively.
5. Mark true against the tags that you want to add and click "Add Tags".
The tags are added below the data source.
You cannot update the "Bulk Publish" checkbox as single publish is not supported.
Note
Test conditions
Mqtt Clients: The benchmarking result was obtained using one MQTT publisher client
(S7 Connector) and one lightweight MQTT subscriber client (open source MQTT Node.js client)
in a test run of five hours. For a higher number of publishers or subscribers, the supported tags
will be lower.
Connections: The benchmarking result was obtained with below mentioned number of
connections:
• S7-Protocol (S7-300/400/1200/1500): 4
• Optimized S7-Protocol (S7-1200/1500): 8
• OPC UA (OPC Server): 6
Above quantity structure can be achieved by keeping number of connections less in the Bulk
Publish mode. For higher number of connections, the supported tags will be lower.
Optimized S7-Protocol (S7-1200/1500) NFR was performed with all unique PLCs to get the
optimal result.
Prerequisite
• The SIMATIC S7 Connector Configurator must be running.
• A data source and data point must be available.
Procedure
To delete a data point, follow these steps:
1. Launch the SIMATIC S7 Connector Configurator.
The Configurator home page is displayed.
2. Select the tag/data point records that you want to delete.
create topics for alarms and tags data to the user in the Industrial Edge Databus. The topic name
must be as follows:
• "ie/m/j/simatic/v1/s7c1/dp" for tags metadata
where ie: industrial edge, m: metadata, j: json, s7c1: SIMATIC S7 Connector instance 1, dp:
datapoint.
• "ie/d/j/simatic/v1/s7c1/dp/r/#" for tags data
where ie: industrial edge, d: data, j: json, s7c1: SIMATIC S7 Connector instance 1, dp:
datapoint
• "ie/m/j/simatic/v1/s7c1/ev" for alarms metadata
where ie: industrial edge, m: metadata, j: json, s7c1: SIMATIC S7 Connector instance 1, ev:
event.
• ie/d/j/simatic/v1/s7c1/ev/# for alarms data
where ie: industrial edge, d: data, j: json, s7c1: SIMATIC S7 Connector instance 1, dp:
datapoint
• ie/s/j/simatic/v1/s7c1/status for Connector and Connector diagnostic
status
where ie: industrial edge, s: status, j: json, s7c1: SIMATIC S7 Connector instance 1
When you create a user in Industrial Edge Databus, you define a username and password for the
user. You must specify this username and password combination in the "UserName" and
"Password" fields. Using this credential, the SIMATIC S7 Connector Configurator establishes
connection to Industrial Edge Databus.
Bulk Publish
By default, the bulk publish is always enabled. You cannot update the "Bulk Publish" checkbox as
single publish is not supported. For more information, refer Bulk Publish Functionality (Page 40).
The SIMATIC S7 Connector Configurator allows you to edit or delete the data points or import the
new data points without stopping the Industrial Edge Runtime. When you deploy and start the
project using "Deploy" and "Start Project" buttons respectively, you can again use the "Deploy"
button to deploy the changes while the Industrial Edge Runtime is still running.
When you deploy the changes, Connector birth message and Connector status data is published
along with the metadata. For more information on metadata publish, refer JSON structure for
Alarms and Tags Metadata? (Page 57)
While the Industrial Edge Runtime is running, you cannot perform the following tasks:
• Configuring OPC UA (OPC Server) data source with Authentication and Messaging Mode
connection
• Configuring Full Text Alarms
Prerequisite
• The SIMATIC S7 Connector Configurator must be running.
• A data source and a data point must be available.
Procedure
To deploy a data point, follow these steps:
1. Launch the SIMATIC S7 Connector Configurator.
The Configurator home page is displayed.
2. Mark true against the data points that you want to deploy.
4. Select the required Industrial Edge Devices on which you want to deploy the changes.
5. Click "Deploy".
The Configurator takes a while to deploy the project, and a success message is displayed
subsequently. The data points are deployed and downloaded, and a green check mark is
displayed next to the selected data points.
Note
1. You can deploy the changes only when the Industrial Edge Devices are in "Online" state.
2. Mass deployment feature (deploying to multiple Industrial Edge Devices) is available only
when Industrial Edge Runtime for the selected Industrial Edge Devices is not running.
3. You must manually start, configure project when Industrial Edge Runtime is started, and stop
the project by launching the UI of that Industrial Edge Device.
4. Before performing mass deployment, you must ensure that same user credentials and topic
are already added in the IE Databus Configurator for all the selected Industrial Edge Devices
where you want to perform the mass deployment.
5. After deploy operation is successful, state of metadata client will be visible under Bus Adaptor
icon.
Prerequisite
• The SIMATIC S7 Connector Configurator must be running.
• A data source and a data point must be available.
• A data point must be deployed to the Industrial Edge Runtime as described in Deploy Project
(Page 43).
Procedure
To start a project, follow these steps:
1. Launch the SIMATIC S7 Connector Configurator.
The Configurator home page is displayed.
2. Click "Start Project" in the upper-right corner.
The Configurator takes a while to start the project and a success message is displayed
subsequently.
After completion of start operation , state of Tagdata and Alarmdata client will be visible
under Bus Adaptor icon.
Connection state of PLC’s that are deployed under runtime will be visible under Connection
state icon.
Prerequisite
• The SIMATIC S7 Connector Configurator must be running.
• A data source and a data point must be available.
• The Industrial Edge Runtime must be running as described in Start Project (Page 46).
Procedure
To stop a project, follow these steps:
1. Launch the SIMATIC S7 Connector Configurator.
The Configurator home page is displayed.
2. Click "Stop Project" in the upper-right corner.
The Configurator takes a while to stop the project, and a success message is displayed
subsequently. The Industrial Edge Runtime stops the data transfer to the Industrial Edge
Databus.
After Stop operation is completed, state of clients under Bus Adapter icon and connection
state of PLC will be set to default state.
Note
• You must not modify the SystemData and checksum key.
• You cannot add Optimized S7 Connection (1200/1500) with legitimization enabled.
• You cannot add OPC UA Connection with authentication or messaging mode enabled.
• You cannot add Optimized S7 Tags with symbolic address.
• You cannot change "isBrowse" key value in Optimized S7 and OPC UA connection.
To import and export the configuration, you can use and icons respectively present in the
upper-right corner.
Note
You can import configuration files of V1.1 and V1.2. When you import V1.1 configuration file in
V1.2, the payload is applied as per V1.1 settings. Single mode is changed to Bulk and tag Id is
published in tag data payload.
val: value of the Tag. Based on the data type of the data point, the value can be simple scalar
value.
Note
You can use the metadata to get the tag id published from the SIMATIC S7 connector for 'Tag
Write' functionality. You can use this tag Id in the Publisher (MQTT) to write value for that tag.
If you have configured fixed length string datatype in TIA Portal, then you need to provide the
length of the string when configuring the tag in S7 Connector or by default the string length is
set to 210 for S7-Protocol (S7-300/400/1200/1500). For more information, refer section Fixed
String Length (Page 81).
If you have configured fixed length string datatype in TIA Portal, then you need to provide the
length of the string when configuring the tag in S7 Connector or by default the string length is
set to 254 for Optimized S7-Protocol (S7-1200/1500). For more information, refer section Fixed
String Length.
For more information on Bulk Publish, refer Bulk Publish Tags. (Page 40)
For more information on topic format structure, refer Topic Structure for Data and Metadata
(Page 50).
Tags Data
With the "Bulk Publish" feature, all tags data is published under single group with topic name as:
ie/d/j/simatic/v1/s7c1/dp/r/<connection-name>/default
The JSON structure is as follows:
Alarms Data
On the other hand, the 'Bulk Publish Functionality' does not apply for alarms data. The topic
format for alarms data is as follows:
ie/d/j/simatic/v1/s7c1/ev/<connection-name>/FullText
The JSON structure is as follows:
Value Description
0 Normal
1 Alarm is raised.
2 Raised and cleared.
Note
You must discover the tag information from the metadata payload.
Tags Metadata
The topic format for tags metadata is as follows:
ie/m/j/simatic/v1/s7c1/dp
where ie: industrial edge, m: metadata, j: json, s7c1: SIMATIC S7 Connector instance 1, dp:
datapoint.
With the "Bulk Publish" feature, the JSON structure for tags metadata is as follows:
Alarms Metadata
The topic format for alarms metadata is as follows:
ie/m/j/simatic/v1/s7c1/ev
where ie: industrial edge, m: metadata, j: json, s7c1: SIMATIC S7 Connector instance 1, ev:
event.
The JSON structure for alarms metadata is as follows:
Note
Alarms metadata is published only when you deploy S7 Connection with 'Full Text Alarm'
checkbox enabled before starting the project.
Once you start the Industrial Edge Runtime, you cannot configure 'Full Text Alarms' checkbox.
Therefore, the alarms metadata is not published in this case.
When you successfully start a project, the Connector and Connection status are published with
tag and alarm data packet as follows:
When you successfully stop a project, the Connector Will message is published by the broker as
follows:
Note
• In Connector status data – status: “available” indicates connector is up and started. status:
“unavailable” indicates connector is down.
• In Connector status data – status: “bad” indicates at least one of the connector clients is not
connected to the IE Databus. More information will be provided in the reason field of
Connector data.
• In Connector status data – status: “good” indicates all the connector clients are connected to
the IE Databus.
• In Connection status data – status: “bad” indicates connection to target device could not be
established.
• In Connection status data – status: “good” indicates connection with target device is
established.
5. Click "OK".
The XML file is exported.
From TIA Portal, only XML file format is supported in the SIMATIC S7 Connector Configurator.
Tags in Data Blocks cannot be exported from the TIA Portal. This can be done in SIMATIC
Manager. You can configure a 'Project' for S7 Classic PLC in STEP 7 SIMATIC Manager and can use
this 'Project' to create an excel sheet or XML file which can be imported in S7-Protocol
3. Click on "Create a new converter template" to create the template file. Select the Path to save
template file and choose s7p (*.s7p) project created from SIMATIC Manager.
4. Click "Create".
5. Select the Tags from data Block and Symbols that you want to be added in the excel sheet or
XML file.
6. Provide Connection Name and choose the output format as .xlsx or .xml as required.
7. Click "Convert".
The file is exported.
3. Click "OPC UA" > "Server" > "Export" section in "Properties" window as follows:
Off set of Tag 11 (String tag) is 22 as depicted in the above image. The address format for Tag11
(String tag) is 'DB1.DBB22'.
You can configure the string tag data type in S7-Protocol (S7-300/400/1200/1500) as follows:
You can monitor string value in TIA Portal to cross check Data Block offsets.
Step 1: Protect the Project by selecting the "Project protection" option in TIA Portal.
1. Click on "Security settings" > "Settings".
A new window is displayed for project as follow:
Note
You must ensure the sampling and publishing interval should be less than or equal to the
Acquisition cycle configured in OPCUA with no data loss.
Step 2: Enable Global Security Setting and prepare server and client certificates.
1. Select the device properties, click "Protection & Security" > "Certificate manager", and mark
true against "Use global security for certificate manager" checkbox.
2. In the "Device certificates", configure new security, and click "Add new" to add new certificate.
Note
• For client certificate, the hostname of the container is required where OPC-UA application
is running. Provide hostname as 's7connector' for client certificate.
• While creating the certificates, you must ensure that PLC/OPC-UA server time is not in
future time. As the certificates with future time will not be activated in SIMATIC S7
Connector Configurator when configured.
Step 3: Add the Server Certificate and Ciient Certificate in OPC-UA Security options.
1. In OPC UA Device properties section, enable the "Activate OPC UA server" option by marking
true against the checkbox.
3. Select the following security policies for server functionality which corresponds 128-bit
encryption algorithms.
Note
You can follow the above steps to create certificates with 'sha256RSA' signature value as well.
3. Click "Protection & Security" > "Access Level" section in "Properties" window as follows:
4. Select "No access" level and provide password for any of the above "Access level".
Other functionalities for configuration version 1.1 remain same as configuration version 1.2 as
described in this manual.
BOOL (bit)
An operand of data type BOOL represents a bit value and contains one of the following values:
• TRUE
• FALSE
Note
Applies to CPUs of the S7-1500 series
For a block with the block property "Optimized block access", the bit has a length of 1 byte.
BYTE
An operand of data type BYTE is a bit string of 8 bits.
The following table shows the properties of data type BYTE:
Note
The BYTE data type cannot be compared for more than or less than. It can only be supplied with
the same decimal data that can be processed by the SINT and USINT data types.
CHAR
A tag of the CHAR (Character) data type has a length of 8 bits and occupies one BYTE of memory.
The CHAR data type stores a single character in ASCII coding. You can find information on the
encoding of special characters under "STRING".
The following table shows the value range of the CHAR data type:
DATE
The DATE data type saves the date as an unsigned integer. The representation contains the year,
the month, and the day.
The contents of an operand of DATE data type correspond in hexadecimal format to the number
of days since 01-01-1990 (16#0000).
The following table shows the properties of data type DATE:
Example
The following figure shows the integer +125790 as a binary number:
DWORD
An operand of data type DWORD is a bit string of 32 bits.
Note
The DWORD data type cannot be compared for more than or less than. It can only be supplied
with the same decimal data that can be processed by the DINT and UDINT data types.
LREAL
Operands of the data type LREAL have a length of 64 bits and are used to represent floating-
point numbers. An operand of the LREAL data type consists of the following three components:
• Sign: The sign is determined by the signal state of bit 63. The bit 63 assumes the value "0"
(positive) or "1" (negative).
• 11-bit exponents to base 2: The exponent is increased by a constant (base, +1023), so that
it has a value range of 0 to 2047.
• 52-bit mantissa: Only the fraction part of the mantissa is shown. The integer part of the
mantissa is always 1 with normalized floating-point numbers and is not stored.
The LREAL data type is processed with a precision of 15 digits.
Note
With floating-point numbers, only the precision defined by the IEEE754 standard is stored.
Additionally specified decimals are rounded off according to IEEE754.
The number of decimal places may decrease for frequently nested arithmetic calculations.
If more decimal places are specified than can be stored by the data type, the number is rounded
to the corresponding value of the precision allowed by this value range.
It is not necessary to specify all time units. LT#5h10s is therefore a valid entry, for example. If
only one unit is specified, the absolute value of days, hours, and minutes must not exceed the
high or low limits. When more than one time unit is specified, the value must not exceed 106751
days, 23 hours, 59 minutes, 59 seconds, 999 milliseconds, 999 microseconds, or 999
nanoseconds.
Note
In SIMATIC S7 Connector Configurator, LTIME value is published in nanoseconds which
represents a duration in 100 nanosecond intervals.
LTOD (LTIME_OF_DAY)
Data type LTOD (LTIME_OF_DAY) occupies two double words and stores the number of
nanoseconds since the beginning of the day (0:00 h) as unsigned integer.
You always need to specify the hours, minutes, and seconds. The specification of nanoseconds
is optional.
Note
In SIMATIC S7 Connector Configurator, LTOD value is published in nanoseconds which
represents a duration in 100 nanosecond intervals.
LWORD
An operand of data type LWORD is a bit string of 64 bits.
Note
The LWORD data type cannot be compared for more than or less than. It can only be supplied
with the same decimal data that can be processed by the LINT and ULINT data types.
REAL
Operands of the data type REAL have a length of 32 bits and are used to represent floating-
point numbers. An operand of the REAL data type consists of the following three components:
• Sign: The sign is determined by the signal state of bit 31. The bit 31 assume the value "0"
(positive) or "1" (negative).
• 8-bit exponents to basis 2: The exponent is increased by a constant (base, +127), so that it
has a value range of 0 to 255.
• 23-bit mantissa: Only the fraction part of the mantissa is shown. The integer part of the
mantissa is always 1 with normalized floating-point numbers and is not stored.
The REAL data type is processed with a precision of 6 digits.
Note
With floating-point numbers, only the precision defined by the IEEE754 standard is stored.
Additionally specified decimals are rounded off according to IEEE754.
The number of decimal places may decrease for frequently nested arithmetic calculations.
If more decimal places are specified than can be stored by the data type, the number is rounded
to the value corresponding to the precision allowed by this value range.
STRING
An operand of the STRING data type saves several characters in a character string that can consist
of up to 254 characters. In a character string, all characters of the codepage created on the
system are permitted. The characters are specified in single quotation marks.
A character string can also contain special characters. The escape character $ is used to identify
control characters, dollar signs, and single quotation marks.
Note
Different code pages
Please note that the special characters are coded using the code page currently set in Windows.
This means that a string that contains special characters can be displayed differently on a
different operating system with a different code page.
The dependency of the codepage on the created system makes an international use of the user
program more difficult. Only the characters from the 7-bit ASCII coding are internationally valid.
Note
Different code pages
Please note that the special characters are coded using the code page currently set in Windows.
This means that a string that contains special characters can be displayed differently on a
different operating system with a different code page.
The dependency of the codepage on the created system makes an international use of the user
program more difficult. Only the characters from the 7-bit ASCII coding are internationally valid.
It is not necessary to specify all time units. T#5h10s is a valid entry, for example. If only one unit is
specified, the absolute value of days, hours, and minutes must not exceed the high or low limits.
When more than one time unit is specified, the value must not exceed 24 days, 23 hours, 59
minutes, 59 seconds, or 999 milliseconds.
Note
In SIMATIC S7 Connector Configurator, TIME value is published in nanoseconds which represents
a duration in 100 nanosecond intervals.
TIME_OF_DAY (TOD)
Data type TOD (TIME_OF_DAY) occupies a double word and stores the number of milliseconds
since the beginning of the day (0:00 h) as unsigned integer.
The following table shows the properties of data type TOD:
You always need to specify the hours, minutes, and seconds. The specification of milliseconds
is optional.
Note
In SIMATIC S7 Connector Configurator, TOD value is published in nanoseconds which represents
a duration in 100 nanosecond intervals.
WORD
An operand of data type WORD is a bit string of 16 bits.
The following table shows the properties of data type WORD:
Note
The WORD data type cannot be compared for more than or less than. It can only be supplied with
the same decimal data that can be processed by the INT and UINT data types.
Configuration update
Whenever you change the configuration in the SIMATIC S7 Connector Configurator, the system
app on the respective Industrial Edge Device (IED) gets updated only when you click on the
"Deploy" button.
You can check the status of the configuration update using the tasks icon in the IED UI.
Supported language
When you provide the needed information in input fields, the Industrial Edge Management
(IEM), the system configurators, and other components only support characters from the
English language. For example, when you add a data source and tag name with special
characters like "ö", "ä", or "ü", these characters are not supported and result in error messages.
Cycle time: For testing 10 milliseconds acquisition cycle, cycle time must be greater than 5
milliseconds and less than 9 milliseconds.
Issue Troubleshooting
The delta download of S7+ connections for legitimization -
from "NoAccess" to "FullAccess" does not work.
You will get no response from the UI after you click on "De‐ Close and reopen the SIMATIC S7 Connector Configurator. Per‐
ploy", "Start", and "Stop". In that case, the operation remains in form again the required operation.
progress state and buttons are disabled.
S7-1200 PLCs are not supported for OPC-UA connection in the -
S7 Connector Configurator.
The following data types are not supported for the "TagWrite" -
operation:
• S7 data sources: DATE, TIME, and CHAR ARRAY
• S7+ data sources: DATE
• OPC-UA data sources: ARRAY, SInt, and USInt
Editing of "CHAR ARRAY" data types for S7 connections is not -
supported.
The browse feature is provided as preview for ease of config‐ Configure manually the tags or import the exported files from
uration; hence the following issues are known with regard to the TIA Portal.
this feature: The browse feature is provided as beta functionality in V1.2.0,
• When the browsing data source (OPC-UA server or PLC) has the complete feature will be available in V1.3.0.
a large number of tags, it takes approximately 2 minutes to
display the tag list.
• When the browsing data source (OPC-UA server or PLC) has
not responded within 2 minutes, a time out error occurs.
• When you browse S7+ data sources, editing these data
sources and browsed tags are not supported.
Sporadically, the browsing feature may fail due to any reason Configure the tags manually or import the exported files from
after several attempts. the TIA Portal.
Browsing S7+ data sources is not supported for ET200 Open -
Control PLCs.
Manual adding of symbolic addresses for S7+ tags is not sup‐ Symbolic addresses are only supported in browsing S7+ data
ported. sources.
Delta download of full text alarms for S7-300 and S7-400 PLCs Full text alarms are only supported in S7-300 and S7-400 PLCs
is not supported. in the full download configuration. To get full text alarms, stop
the project and download the project with S7-300 or S7-400
PLCs.
When you browse an OPC-UA server from a project in the Configure manually the OPC-UA tags or use the exported
TIA Portal with 1 function block (FB) and several data block "*.xml" file of the DB instances from the TIA Portal.
(DB) instances, only data of 1 DB instance is returned and thus
results in false read data.
Issue Troubleshooting
Deleting a configuration of the SIMATIC S7 Connector by click‐ -
ing the "Delete Configuration" button under the "My Installed
Apps" menu entry starts a task on the according Edge Device
but fails immediately.
A maximum array size of 999 is supported for the "CHAR AR‐ -
RAY" data type in S7 connections.
If you import a configuration file, which was exported from the Use imported files which are exported from a version ≥ 1.0.6.
IEM through a SIMATIC S7 Connector Configurator version less Browse all S7+ connections and then click "Deploy".
than 1.0.6, into the SIMATIC S7 Connector Configurator, full
downloads fail if there are S7+ tags with symbolic address.
If you import a configuration file, which was exported from the Use imported files which are exported from a version ≥ 1.0.9.
IEM through a SIMATIC S7 Connector Configurator version less Alternatively, you can check data sources again after import‐
than 1.0.9, into the SIMATIC S7 Connector Configurator, full ing and eliminate the duplicate tag names.
and delta downloads fail if you use duplicate tag names in the
same connection or if you use tag names with unsupported
characters.
If column widths were resized previously, the column widths Resize the column widths again.
will be reset to default size due to the following scenarios:
• Browser window is resized
• Browser window is refreshed
• Configurator is relaunched
If the number of tags is more than 4000 or if you import re‐ -
spectively browse tags, the response of resizing columns be‐
comes slow, and you may observe flickering of the UI.
If before completion of the mass deployment operation, you You must wait for the completion of mass deployment opera‐
launch the UI in one of the selected Industrial Edge Devices, tion before launching UI in other Industrial Edge Device which
then new configuration is not reflected in the Industrial Edge was selected as part of the mass deployment.
Device.
Mass deployment feature is available only when Industrial You must manually start, configure project when Industrial
Edge Runtime for the selected Industrial Edge Device is not Edge Runtime is started, and stop the project by launching the
running. UI of that Industrial Edge Device and perform these operations.
If you select Industrial Edge Device where Industrial Edge Run‐ You must explicitly start the Industrial Edge Runtime in those
time is running, then after the mass deployment the project Industrial Edge Device once again.
will be stopped in those Industrial Edge Devices.
SIMATIC S7 Connector Configurator publishes tag data to brok‐ -
er using unreliable Qos policy -Qos0. This may result in some
packet loss.
In SIMATIC S7 Connector Configurator, you can browse maxi‐ This is the NFR limit of OPC-UA browser. If you want to browse,
mum of 2000 tags in OPC-UA connection. If PLC contains more then you must use a PLC Project with less than 2000 tags.
than 2000 Tags, then "Browse Timeout" error is displayed.
S7+ browsing is not supported for following PLC type and FW -
version:
• CPU 1513F-1 PN V2.8
• CPU 1518-4 PN/DP V2.8
• CPU 1518F-4 PN/DP V2.6.1
• CPU 1512SP-1 PN V2.8
S7+ driver supports maximum of eight connections. In the S7 -
Connector project, you can configure maximum eight Opti‐
mized S7-Protocol (S7-1200/1500).
Issue Troubleshooting
S7 Connector publishes multiple instances of same tag with You must ensure S7 Connector gets enough CPU to process all
different timestamp to broker when IED CPU is overloaded. the packets and send to broker.
This is done to ensure that no data loss happens even if there
is data delay because of low CPU resources.
In Optimized S7-Protocol (S7-1200/1500), filter is supported -
only for Datablocks. Tag filter based on M, Q, and I area is not
yet supported.
In OPC-UA data source, You can edit the exported OPC-UA XML file and Import it in
• Browsing functionality does not support "Browse Filter" SIMATIC S7 Connector Configurator. You can add/modify the
tag name, address namespace, and datatype. For more infor‐
with tag name and datablock.
mation, refer Export Tags for OPC-UA Connection (Page 67).
• Browsing is possible only of tags with namespace greater
than 0.
The download fails for a project with 6000 tags if the tag name It is recommended to use smaller tag names and connection
and connection name are long (200-254 bytes). names, if you want to download large number of tags.
If legitimization is enabled in PLC and the full access is selected -
in the configurator, then you can browse PLC tags but not dat‐
ablocks. There is no protection available for PLC tags regard‐
less of the legitimization level. The PLC tags can always be
browsed.
SIMATIC S7 Connector Configurator V1.3 is incompatible with You must update both SIMATIC S7 Connector Configurator and
previous versions of the run-time application. the run-time application to V1.3.
Total memory limit of SIMATIC S7 Connector Runtime is 920 -
MB.
Connection state of PLC and clients will be displayed after -
10seconds from the actual state.