Creating Documentation Components for PROFINET IO Networks

Applications & Tools

Answers for industry.

Cover

Creating Documentation Components for PROFINET IO Networks

Topology Reporter

Tool Description April 2012

2 Topology Reporter

Version 1.0, Entry ID: 60035096

Cop

yrig

ht

Sie

men

s A

G 2

012

All

right

s re

serv

ed

Siemens Industry Online Support This article is taken from the Siemens Industry Online Support. The following link takes you directly to the download page of this document: http://support.automation.siemens.com/WW/view/en/60035096 Attention: The functions and solutions described in this document are mainly limited to the realization of the automation task. In addition, please note that suitable security measures in compliance with the applicable Industrial Security standards must be taken, if your system is interconnected with other parts of the plant, the company’s network or the Internet. For further information on this issue, please refer to Entry ID 50203404. http://support.automation.siemens.com/WW/view/en/50203404. If you have any questions about this document, please contact us at the following e-mail address: mailto:[email protected] For further information on this topic, you may also actively use our Technical Forum in the Service & Support Portal. Add your questions, suggestions and problems and discuss them in our large forum community: http://www.siemens.com/forum-applications

http://support.automation.siemens.com/WW/view/en/60035096


mailto:[email protected]

http://www.siemens.com/forum-applications

Topology Reporter Version 1.0, Entry ID: 60035096 3

Cop

yrig

ht

Sie

men

s A

G 2

012

All

right

s re

serv

ed

SIMATIC Topology Reporter

Task 1

Solution 2

Functional Mechanism of this Tool

3 Installing the Application Software

4

Operation of the Tool 5

Literature 6

History 7

Table of Contents

4 Topology Reporter


Cop

yrig

ht

Sie

men

s A

G 2

012

All

right

s re

serv

ed

Warranty and Liability Note The application examples are not binding and do not claim to be complete

regarding configuration, equipment and any eventuality. The application examples do not represent customer-specific solutions. They are only intended to provide support for typical applications. You are responsible for ensuring that the described products are used correctly. These application examples do not relieve you of your responsibility to use sound practices in application, installation, operation and maintenance. When using these application examples, you recognize that we cannot be made liable for any damage/claims beyond the liability clause described. We reserve the right to make changes to these application examples at any time and without prior notice. If there are any deviations between the recommendations provided in this application example and other Siemens publications – e.g. catalogs – the contents of the other documents have priority.

We accept no liability for information contained in this document. Any claims against us – based on whatever legal reason – resulting from the use of the examples, information, programs, engineering and performance data etc., described in this Application Example shall be excluded. Such an exclusion shall not apply in the case of mandatory liability, e.g. under the German Product Liability Act (“Produkthaftungsgesetz”), in case of intent, gross negligence, or injury of life, body or health, guarantee for the quality of a product, fraudulent concealment of a deficiency or breach of a condition which goes to the root of the contract (“wesentliche Vertragspflichten”). However, claims arising from a breach of a condition which goes to the root of the contract shall be limited to the foreseeable damage which is intrinsic to the contract, unless caused by intent or gross negligence or based on mandatory liability for injury of life, body or health. The above provisions do not imply a change in the burden of proof to your disadvantage. It is not permissible to transfer or copy these application examples or excerpts thereof without express authorization from Siemens Industry Sector.

Table of Contents


Cop

yrig

ht

Sie

men

s A

G 2

012

All

right

s re

serv

ed

Table of Contents Warranty and Liability..............................................................................................4 Table of Contents.....................................................................................................5 1 Task.................................................................................................................6 2 Solution...........................................................................................................6

2.1 Description of functionality .................................................................6 2.2 Description of functionality .................................................................7 2.3 System requirements.........................................................................9

3 Functional Mechanism of this Tool .............................................................10 4 Installing the Application Software..............................................................11 5 Operation of the Tool ...................................................................................11

5.1 Overview.........................................................................................11 5.2 Export of the topology raw data from STEP 7...................................11 5.3 Creating the HTML report file...........................................................14 5.4 Customizing print view.....................................................................18

6 Literature ......................................................................................................19 7 History ..........................................................................................................19

1 Task 2.1 Description of functionality

6 Topology Reporter


Cop

yrig

ht

Sie

men

s A

G 2

012

All

right

s re

serv

ed

1 Task

Overview of the automation task For the system acceptance test you usually need a document which lists existing status of the PROFINET IO network at a fixed time and prints them in a suitable format. These are: project data module status of all nodes port status of all PROFINET IO devices connections to the respective partner line data with attenuation values statistic data on all ports IP addresses of the respective nodes

This information can be extracted and edited from the STEP 7 configuration files.

2 Solution 2.1 Description of functionality

Overview With the help of the “Topology Reporter” tool you can create a document from the exported data of your STEP 7 project that displays all relevant data regarding the topology of your PROFINET IO network in a clear form.

Fields of application/customer benefits The tool on hand offers you the following advantages: creation of a complete documentation component of your PROFINET IO

network it is based on the consistent configuration file of the plant This makes a new status comparison of the plant possible at any time The tool can also used as Java application on non-Windows operating

systems.

Typical fields of application A typical field of application of this tool is e.g. the final documentation for the system acceptance test.



Cop

yrig

ht

Sie

men

s A

G 2

012

All

right

s re

serv

ed

2.2 Description of functionality

Overview and description of the user interface The following sections show you an overview of the individual HTML pages of the documentation and their contents. Table 2-1

Information Content

General project information

Status of the entire system


8 Topology Reporter


Cop

yrig

ht

Sie

men

s A

G 2

012

All

right

s re

serv

ed

Information Content

Overview of all devices on the PROFINET IO line

Overview of all connection partners to a PN IO device

Statistic regarding the frame traffic on each participating port

2 Solution 2.3 System requirements


Cop

yrig

ht

Sie

men

s A

G 2

012

All

right

s re

serv

ed

2.3 System requirements

The topology reporter tool is a Java program and requires at least the following requirements to be able to run on your computer.

Software requirements Table 2-2

Component Note

Java Runtime Environment Download the free Java runtime environment for your operating system under the following Web site http://www.java.com/en/download/manual.jsp

Internet browser The Internet browser has to be CSS capable (e.g. at least IE V6). Note: From IE V8 the navigation to the individual information units of the report is correctly displayed on the right side of the HTML page.

STEP 7 From STEP 7 V 5.5 SP1

Hardware requirements The graphics resolution of your PC should be at least 1024 * 768 pixels.

Sample files and projects The following list includes all files and projects used in this example. Table 2-3

Component Note

60035096_Topology-Reporter_CODE_v10.zip This zip file contains the tool and for test purposes a sample topology as csv file.

60035096_Topology-Reporter_DOKU_V10_en.pdf This document.

3 Functional Mechanism of this Tool 2.3 System requirements

10 Topology Reporter


Cop

yrig

ht

Sie

men

s A

G 2

012

All

right

s re

serv

ed

3 Functional Mechanism of this Tool General overview

Based on a pictorial schematic, the following graphic shows the data flow from the plant network to the PN IO topology report.

Figure 3-1

STEP 7 – Topology Editor Topology Reporter

PN IO System Network

Export

PN IO Topology Report

HTMLFile

Explanation Table 3-1

Steps Comment

1. Information on the PROFINET IO system network configured in STEP 7, is exported into a CSV file via the topology editor from HW Config.

2. The topology reporter reads the CSV file and formats a structured and clear documentation in HTML format from it.

3. The original HTML file can be displayed and printed by any browser.

4 Installing the Application Software 5.1 Overview


Cop

yrig

ht

Sie

men

s A

G 2

012

All

right

s re

serv

ed

4 Installing the Application Software Software installation

No installation routines are required for the tool topology reporter. Please note the requirements that have been described in chapter 2.3.

Table 4-1

No. Action Comment

1 Extract the zipped “60035096_Topology-Reporter_CODE_v10.zip” archive into a folder of your choice

e.g. D:\Temp

2 Now you can instantly start the topology reporter by double clicking on the trep.jar file (alternatively Start.bat) in the “.\Topology Reporter v1.0.0” directory.

5 Operation of the Tool 5.1 Overview

In order to receive a formatted view of your PROFINET IO system, you have to perform two steps export of the topology raw data from STEP 7 as csv file creation of the HTML report file by importing the csv file topology into the

topology reporter tool and conversion into a HTML file

5.2 Export of the topology raw data from STEP 7

The topology reporter requires a csv file as input format that can be exported from the STEP 7 topology editor. To do this, proceed as follows.

5 Operation of the Tool 5.2 Export of the topology raw data from STEP 7



Cop

yrig

ht

Sie

men

s A

G 2

012

All

right

s re

serv

ed

Table 5-1

No. Action Comment

1 Open your project in the SIMATIC Manager and go to the hardware configuration.

2 Right click onto the PROFINET IO system and start the topology editor via the “Profinet IO Topology …” context menu.

3 Once the topology editor has been

started, go to the “Offline/Online Comparison“ tab. Start the automatic detection of the PROFINET nodes by clicking on the “Start” button. Now the online determination of the PROFINET nodes will take place. Accept the port interconnections for all PROFINET nodes. For this purpose, click onto all ports that have been highlighted in yellow in the online view and select the “Accept Port Interconnection“ function in the context menu. Close the topology editor and accept the changes. The topological interconnection is now saved offline in the SIMATIC manager. Save and compile the hardware configuration and load the configuration into the IO controller.

5 Operation of the Tool 5.2 Export of the topology raw data from STEP 7


Cop

yrig

ht

Sie

men

s A

G 2

012

All

right

s re

serv

ed

No. Action Comment

4 Restart the topology editor. Go to the “Table view” tab and select the online view.

5 Click the “Export…” button to export the

online database into a csv file.

5 Operation of the Tool 5.3 Creating the HTML report file



Cop

yrig

ht

Sie

men

s A

G 2

012

All

right

s re

serv

ed

5.3 Creating the HTML report file

The topology reporter formats a structured HTML file from the csv file. Table 5-2

No. Action Comment

1 Start the topology reporter in the installation directory by double clicking on the “trep.jar” file (alternatively “start.bat” ).

2 To select the source file, click the

“Choose CSV file” button in the “File conversion” tab.



Cop

yrig

ht

Sie

men

s A

G 2

012

All

right

s re

serv

ed

No. Action Comment

3 Select the csv file created with STEP 7 as described in chap. 5.2. Note The csv file is located in the installation directory of the topology reporter. Confirm the selected file with the “Save” button to close the selection window.

4 Specify the output folder of the HTML report via the “HTML Destination directory” button. Once the destination folder has been specified, the “GO Start” button is enabled. Note The output folder must not be

identical to the installation folder of the topology reporter.

The topology reporter saves the information of the directories until the next program start.




Cop

yrig

ht

Sie

men

s A

G 2

012

All

right

s re

serv

ed

No. Action Comment

5 Go to the “Project Information” tab and enter the individual information to your plant. The information last entered is automatically maintained even after exiting the program. The “Drawing number” field is preassigned by the system with the file name of the export file. If desired an individual customer logo can additionally be added. The logo appears in the header of the HTML page. The following formats are supported: .jpeg, .gif, .png and .tiff.

6 Go back to the “Choose file” tab and

click the “GO Start” button to generate the report.

The generated report is created in the destination directory under the file name “*.html”.



Cop

yrig

ht

Sie

men

s A

G 2

012

All

right

s re

serv

ed

No. Action Comment

7 If the report was generated without errors, a quick link to the report will appear in the bottom part of the window once the “HTML conversion successful” dialog was acknowledged.

8 By clicking onto the quick link you can

open the report last created in your standard browser.

5 Operation of the Tool 5.4 Customizing print view



Cop

yrig

ht

Sie

men

s A

G 2

012

All

right

s re

serv

ed

5.4 Customizing print view

The topology reporter offers an optimized print view for documentation purposes. In order to be able to show all contents correctly on an A4 page, you may have to adjust the margins and the orientation of the print settings. The following steps show this on the example of the internet explorer.

Table 5-3

No. Action Comment

1 Open the settings window via the “File Page Setup…” menu

2 Change the margins to 10mm and the format to landscape

3 Check the print settings in the print

preview.

6 Literature


Cop

yrig

ht

Sie

men

s A

G 2

012

All

right

s re

serv

ed

6 Literature Internet Links

Table 6-1

Topic Title

\1\ Reference to this document


\2\ Siemens I IA/DT Customer Support

http://support.automation.siemens.com

\3\ Java downloads for all operating systems

http://www.java.com/en/download/manual.jsp

7 History Table 7-1

Version Date Modification

V1.0 20.12.2011 First issue


http://support.automation.siemens.com/

Creating Documentation Components for PROFINET IO Networks

Documents

Transcript of Creating Documentation Components for PROFINET IO Networks