s

Preface, Contents SIMATIC IT Services

SIMATIC IT Production Suite V5.1 and SIMATIC IT Historian V6.0 SP2 SIMATIC IT Services V4.4 SP2
User Manual

Text Editor Hot Backup Tag Management Real Time Data Server The SIMATIC IT OPC Browser

1 2 3 4 5 6

Edition 01/2005

Guidelines
This manual contains notices intended to protect the products and connected equipment against damage. These notices are graded according to severity by the following texts:

Caution
indicates that property damage can result if proper precautions are not taken.

Notice
draws your attention to particularly important information on the product, handling the product, or to a particular part of the documentation.

Trademarks
SIMATIC is a registered trademark of SIEMENS AG. Third parties using for their own purposes any other names in this document which refer to trademarks might infringe upon the rights of the trademark owners.

Copyright Siemens AG 2005 All rights reserved

The reproduction, transmission or use of this document or its contents is not permitted without express written authority. Offenders will be liable for damages. All rights, including rights created by patent grant or registration of a utility model or design, are reserved.

Disclaimer of Liability
We have checked the contents of this manual for agreement with the hardware and software described. Since deviations cannot be precluded entirely, we cannot guarantee full agreement. However, the data in this manual are reviewed regularly and any necessary corrections included in subsequent editions. Suggestions for improvement are welcomed.

Siemens AG
Bereich Automation and Drives Geschaeftsgebiet Industrial Automation Systems Postfach 4848, D- 90327 Nuernberg Siemens AG 2005 Technical data subject to change.

Siemens Aktiengesellschaft

Preface
Purpose of the Manual
This manual gives you a complete overview of iusign SIMATIC IT Services. This manual is intended for those responsible for configuring, commissioning, and administering automation systems. After installing SIMATIC IT Services, we recommend you get acquainted with the SIMATIC IT Production Suite environment by reading the Getting Started manual. It offers you an easy start in implementing a sample MES application.

Required Basic Knowledge

In order to understand the technical language used in this manual and comprehend the information contained herein, readers must have the following basic requirements: General knowledge in the field of automation engineering. The manual contains references to this areas commonplace terms, concepts and related IT environments.

In addition, you should know how to use computers or devices with similar functions (e.g programming devices) under Windows 2000 or XP operating systems.

Where is this Manual valid?

This manual is valid for the software packages SIMATIC IT Production Suite V5.0 SP3 and SIMATIC IT Historian 6.0 SP1.

Readme
Installation includes a Readme file, which contains information on upgrade procedures and compatibility with previous releases. This file is supplied both in standard text (Readme.txt) and in Acrobat PDF (Readme.pdf) format. This file is available in folder \ReleaseNotes of the Setup CD-ROM and is installed in folder \setup_path\DATA\ReleaseNotes

Online Help
The manual is complemented by an online help which is integrated in the software.

SIMATIC IT Services V4.4 SP2 User Manual

iii

Preface

This online help is intended to provide you with detailed support when using the software. The help system is integrated in the software via a number of interfaces: The Contents and Index command from the Help menu opens the online help window, from which you can choose the topic of interest. You can search for the desired information, using the Table of Contents or the Index The context-sensitive help offers information on the current context, for example, an open dialog box or an active window. You can open the contextsensitive help by clicking the Help button or by pressing F1. The status bar offers another form of context-sensitive help. It displays a short explanation for each menu command when the mouse pointer is positioned on the menu command. A brief explanation (tooltip) is also displayed for each icon in the toolbar when the mouse pointer is positioned on the icon for a short time.

Related Documentation
The following documents contain information related to the contents of this manual. All these documents are available online from the Start > Programs > SIMATIC IT Online Documentation shortcut. SIMATIC IT Production Suite Getting Started, addressed to novice users, guides you step by step in the creation of a complete sample MES application. SIMATIC IT Services Online Help, addressed to novice users, describes SIMATIC IT Services basics and working environment. SIMATIC IT Services Installation Manual, provides a complete overview of installing and configuring SIMATIC IT Services.

Finding Your Way

This manual is sub-divided into the following topics: Chapter SIMATIC IT Services This chapter provides an introduction to the Services environment and a description of the initial steps in using the Services functionality. Chapter Text Editor, This chapter describes the functions available for using text editor to create text files of different types, such as .txt files, iter source files (.src, .inc) and server configuration files (.csv) Chapters Hot Backup In this chapter, there is a description of the various methods for providing backup modules in the event of a Plant or Primary Master Workstation becoming unavailable. Chapters Tag Management This chapter provides you with a description of the Points database, also called the data dictionary, for managing com logical units.

SIMATIC IT Services V4.4 SP2 User Manual

iv

Preface

Chapter Real Time Data Server This chapter provides a description of how to manage and manipulate RTDS in order to build up a bridge between SIMATIC IT components and field devices. Chapter The SIMATIC IT OPC Browser In this chapter, you are provided with a description of how to use the SIMATIC IT OPC Browser from the Management Console.

SIMATIC IT Services V4.4 SP2 User Manual

Preface

Conventions
Throughout this manual, specific typographic conventions have been used and are described below: symbol/convention E.g. Text in boldtype indicates Points where examples are given. The names of menus, commands, dialog boxes and toolbar buttons and, in general, all strings (e.g. File menu; Save command). Accelerator or shortcut keys, which permit rapid access to commands (e.g. CTRL+C). The names of keyboard keys (e.g. RETURN key and toolbar buttons; PLANT button). The names of parameters that must be replaced with a specific name or value. For example, filename indicates that the name of the file must be specified; input indicates that the corresponding value must be specified. A succession of commands in which the command preceding the symbol must be selected before the command following it.

KEY1+KEY2 UPPERCASE Italics

>

SIMATIC IT Training Center

Siemens A&D AS MES offers a number of training courses to familiarize you with the SIMATIC IT product suite. To successfully achieve this goal, training consists of lessons in both theory and practice. Courses are held year-round, according to a program that is published well in advance of the first scheduled session. The material on the basis of which our courses are conducted reflects the result of years of experience in process, LIMS and quality control and production management. All courses are held by expert personnel that is aware of the developments and innovations in the Siemens A&D AS MES product suite. Courses are held in English at the Siemens A&D AS MES Training Centers in Genoa, Italy and Ninove, Belgium. Upon request, training courses can also be organized on the customers premises. For more information on the training course calendar, please visit our Technical Web site (http://www.simaticit.com/ Support > Training).

SIMATIC IT Services V4.4 SP2 User Manual

vi

Preface

SIMATIC IT Service & Support

A Software Maintenance program is provided with SIMATIC IT products. Software Maintenance includes the following services: Software Update Service (SUS): automatic distribution of upgrades and service packs Technical Support Service (TSS): support on technical problems with SIMATIC IT software (Standard Support plus other services and optional services) Access to Online Support: a technical web site that includes information such as Frequently Asked Questions and technical documentation on SIMATIC IT products

Software Update Service (SUS)

This service automatically distributes new versions and service packs when they are released. Typically, when a version becomes available, the installation CD is distributed within a month. For each server that is covered by Software Maintenance, one copy of the installation CD is shipped. Hot fixes (officially tested and released) are not shipped and can only be downloaded from the Online Support. Software Update Service is related to the licenses for the SIMATIC IT product purchased by the customer. Software Update Service is available at no cost for one year after having purchased the software licenses. Upon expiration of this initial one-year period, SUS is included in the end-customer Maintenance Agreement, together with product support.

Technical Support Service (TSS)

SIEMENS has a dedicated technical support team for SIMATIC IT products. Siemens A&D AS MES offers various support services, plus optional services. Those entitled to Standard support are: SIMATIC IT Partners; Customers who have purchased a SIMATIC IT license for a server product within the last 12 months (in this case, Standard support is related solely to that particular software license and its options); Customers who have signed a Maintenance Agreement with Siemens A&D AS MES for their plant; this Maintenance Agreement covers both product support and SUS for the SIMATIC IT licenses used in the project at the plant site.

Other services or optional services will be available only as part of a Maintenance Agreement. To be able to access TSS, you need to register as a user at the Technical Support Web site: https://tss.simaticit.com

SIMATIC IT Services V4.4 SP2 User Manual

vii

Preface

Complete the registration form with: Your personal data Company and plant information The registration number that is provided together with the licenses by the Siemens Licenses office.

The Technical Support Web site provides the following information: Service conditions Phone numbers Working hours Reaction times

Online Support
Any customer who is a registered TSS user can access the Technical Support Web site (https://tss.simaticit.com). The Technical Support Web contains technical information such as: SIMATIC IT knowledge base: a technical support database that includes practical service solutions from Technical Support or the SIMATIC IT community SIMATIC IT software (e.g. hot fixes, software examples) and release notes that can be downloaded SIMATIC IT Cross-Industry libraries that can be downloaded (limited access to SIMATIC IT Certified Partners) SIMATIC IT Product Documentation that can be downloaded Frequently Asked Questions and useful tips.

SIMATIC IT Services V4.4 SP2 User Manual

viii

Table of Contents
1 SIMATIC IT Services 1.1 1.1.1 1.1.2 1.1.3 1.2 1.2.1 1.2.2 1.2.3 1.2.4 1.2.5 1.3 1.3.1 1.3.2 1.3.3 1.3.4 1.3.5 1.3.6 1.3.7 1.3.8 1.3.9 1.3.10 1.4 1.4.1 1.4.2 1.4.3 1.4.4 1.4.5 1.5 1.5.1 1.5.2 1.5.3 1.5.4 1.6 1.6.1 1.6.2 1.6.3 1.7 1.7.1 1.7.2 1.7.3 1.7.4 1.7.5 1.7.6 1.8 1.8.1 1.8.2 1.8.3 1.8.4 1.8.5 1.8.6 1.8.7 1.8.8 1.8.9 1.8.10 1.8.11 1.8.12 13 Overview ............................................................................................................ 13 SIMATIC IT Services ......................................................................................... 13 Starting SIMATIC IT Services ............................................................................ 13 Quitting SIMATIC IT Services ............................................................................ 14 Getting Started ................................................................................................... 14 When SIMATIC IT Services is started for the first time ..................................... 14 Stand Alone Configuration ................................................................................. 15 Client-Server Configuration................................................................................ 16 Client-Server Backup Configuration .................................................................. 16 Parameters for system configuration ................................................................. 17 Environment ....................................................................................................... 17 SIMATIC IT Services environment..................................................................... 17 Plant Management............................................................................................. 18 What can I do from Plant Management ? .......................................................... 18 Management Console........................................................................................ 18 ZME Zone Monitoring Environment ................................................................... 19 What is a Zone? ................................................................................................. 20 Defining a Zone.................................................................................................. 20 Configuring the default Zone.............................................................................. 20 Removing a Zone............................................................................................... 21 Starting the Zone Monitoring Environment ........................................................ 21 Working area...................................................................................................... 21 The Zone Monitoring Environment working area............................................... 21 Displaying AMD, HDD and GUI windows .......................................................... 22 Configuring the file display options .................................................................... 22 Arranging windows in the working area ............................................................. 22 Saving the working area settings ....................................................................... 22 Alarm Manager Display...................................................................................... 23 Starting SIMATIC IT Alarm Manager Display from Zone Monitoring Environment23 Creating an AMD file.......................................................................................... 23 Opening an ADD file .......................................................................................... 23 Configuring the connection to the Alarm Manager server ................................. 24 Historian Data Display ....................................................................................... 24 Starting SIMATIC IT Historian Data Display from Zone Monitoring Environment24 Creating a Historian Data Display file ................................................................ 24 Opening a Historian Data Display file ................................................................ 25 Working with Projects ........................................................................................ 25 The Project......................................................................................................... 25 Creating a new Project....................................................................................... 26 Viewing the Projects .......................................................................................... 26 Removing a Project............................................................................................ 26 Renaming a Project ........................................................................................... 26 Copying a Project............................................................................................... 27 Programming environments............................................................................... 27 SIMATIC IT Programming Environments .......................................................... 27 Control Programming Environment ................................................................... 27 Configuring the programming mode of a Unit.................................................... 28 Running PDE from a CONTROL Unit................................................................ 28 Running PDE from an RTDS/IMC User Unit ..................................................... 29 Running PDE from a Project.............................................................................. 29 Data manipulation and aggregation................................................................... 30 Starting the SIMATIC IT Real Time Data Engine Manager ............................... 30 API Environment ................................................................................................ 31 Configuring IMC ................................................................................................. 31 Starting IMC ....................................................................................................... 31 Debugging a program ........................................................................................ 32

1.8.13 1.8.14 1.9 1.9.1 1.9.2 1.9.3 1.9.4 1.9.5 1.9.6 1.9.7 1.9.8 1.9.9 1.9.10 1.9.11 1.9.12 1.9.13 1.9.14 1.9.15 1.10 1.10.1 1.10.2 1.10.3 1.10.4 1.11 1.11.1 1.11.2 1.11.3 1.11.4 1.11.5 1.11.6 1.11.7 1.11.8 1.12 1.12.1 1.12.2 1.13 1.13.1 1.13.2 1.13.3 1.13.4 1.13.5 1.13.6 1.13.7 1.13.8 1.13.9 1.14 1.14.1 1.14.2 1.14.3 1.14.4 1.14.5 1.14.6 1.14.7 1.14.8 1.14.9 1.15 1.15.1 1.15.2 1.15.3 1.15.4 1.15.5 1.15.6

Dumping/restoring a control panel ..................................................................... 32 Transmitting a program to the controller............................................................ 33 Graphic User Interface....................................................................................... 33 Starting SIMATIC IT Graphic User Interface from Zone Monitoring Environment33 Creating a graphic panel.................................................................................... 33 Opening a graphic panel.................................................................................... 34 Compiling a graphic panel ................................................................................. 34 Compiling multiple graphic panels ..................................................................... 34 Configuring SIMATIC IT Graphic User Interface Development ......................... 35 Showing/hiding the grid and defining the step ................................................... 35 Enabling/disabling the snap and defining the step ............................................ 36 Defining the SIMATIC IT Graphic User Interface page configuration................ 36 Defining the maximum number of objects and points........................................ 36 Defining the maximum number of graphic panels that can be displayed at the same time 37 Locking objects in the panel............................................................................... 37 Logging all operator actions by default .............................................................. 37 Configuring Dynamic Link Libraries (DLLs) ....................................................... 38 Configuring the source files backup................................................................... 38 Miscellaneous elements of SIMATIC IT Services.............................................. 38 System Toolbox ................................................................................................. 38 Enabling the System Toolbox at startup ............................................................ 39 Management Console Tasklist........................................................................... 39 System Information ............................................................................................ 40 User Management ............................................................................................. 41 Logging on to SIMATIC IT ................................................................................. 41 Configuring automatic logoff .............................................................................. 42 Predefined logon users ...................................................................................... 42 Defining the automatic logon user ..................................................................... 42 Logging on to SIMATIC IT with a user other than "Default" .............................. 43 Modifying the user password ............................................................................. 43 Allowing user password modification................................................................. 43 Configuring the password expiry date ............................................................... 44 User Manager tool ............................................................................................. 44 Overview of User Manager ................................................................................ 44 Filtering the contents.......................................................................................... 45 Working with groups .......................................................................................... 46 Groups ............................................................................................................... 46 Resources of the Administrators group ............................................................. 46 Resources of the Developer group .................................................................... 46 Resources of the High Level Operator group .................................................... 47 Resources of the Low Level Operator group ..................................................... 47 Resources of the Maintenance Operator group................................................. 47 Creating a group ................................................................................................ 47 Removing a group.............................................................................................. 48 Displaying the groups of a user ......................................................................... 48 Working with users............................................................................................. 49 Defining a user ................................................................................................... 49 Modifying the properties of a user...................................................................... 50 Removing a user................................................................................................ 50 Associating a user to a group ............................................................................ 50 Associating a user to a different group .............................................................. 51 Locking a user.................................................................................................... 51 Rules for defining user-account options ............................................................ 51 Disabling a user account.................................................................................... 52 Displaying the users associated with a group.................................................... 53 Working with access levels ................................................................................ 53 Access levels ..................................................................................................... 53 Hierarchical access level ................................................................................... 53 Exclusive access level ....................................................................................... 54 How to use access levels................................................................................... 54 Configuring the access level for a resource....................................................... 55 Load Graphic Panels - Access level .................................................................. 55

1.15.7 Run SIMATIC IT Applications from GUI - Access level ..................................... 55 1.15.8 Set Variables from SIMATIC IT Graphic User Interface - Access level............. 56 1.15.9 Set Variables from Ladder, Block Editor, ODS - Access level........................... 56 1.16 Working with resources...................................................................................... 56 1.16.1 SIMATIC IT resources ....................................................................................... 56 1.16.2 Assigning system resources to a group............................................................. 59 1.16.3 Assigning local resources to a group................................................................. 59 1.16.4 Displaying the resources of a group .................................................................. 60 1.16.5 Modifying the resources assigned to a group .................................................... 60 1.16.6 General Purpose resources ............................................................................... 60 1.16.6.1 Access to Administrative Tools .......................................................................... 60 1.16.6.2 Access to Help ................................................................................................... 60 1.16.6.3 Access to License Configuration........................................................................ 61 1.16.6.4 Access to Operating System Shell .................................................................... 61 1.16.6.5 System Configuration......................................................................................... 61 1.16.6.6 Close Session .................................................................................................... 61 1.16.6.7 Modify and Save Configurations ........................................................................ 61 1.16.6.8 Modify Configurations (without Saving) ............................................................. 61 1.16.7 Historian resources ............................................................................................ 62 1.16.7.1 Alarm Acknowledgement ................................................................................... 62 1.16.7.2 Alarm Configuration ........................................................................................... 62 1.16.7.3 Enable GUI Menu Bar........................................................................................ 62 1.16.7.4 Historical Trends Configuration.......................................................................... 62 1.16.7.5 Load Graphic Panels ......................................................................................... 62 1.16.7.6 Print from Graphics, Alarm, Historical Environments......................................... 62 1.16.7.7 Run Alarms ........................................................................................................ 62 1.16.7.8 Run SIMATIC IT Applications from GUI ............................................................ 62 1.16.7.9 Run Historical Trends ........................................................................................ 63 1.16.7.10 Run Messages from GUI ................................................................................... 63 1.16.7.11 Run Applications from GUI ................................................................................ 63 1.16.7.12 Set Variables from GUI...................................................................................... 63 1.16.8 Production Modeler resources ........................................................................... 63 1.16.8.1 IfPMObserver ..................................................................................................... 63 1.16.8.2 IfPMSuperUser................................................................................................... 63 1.16.8.3 IfPMUser ............................................................................................................ 63 1.16.8.4 IfPMEnd-User..................................................................................................... 63 1.16.9 PM COM Interface resources ............................................................................ 64 1.16.9.1 PM COM Interface Show ................................................................................... 64 1.16.9.2 PM COM Interface Exit ...................................................................................... 64 1.16.9.3 PM COM Interface Delete.................................................................................. 64 1.16.9.4 PM COM Interface Configure............................................................................. 64 1.16.10 Business Process Modeler resources ............................................................... 64 1.16.10.1 BPM Configuration Administrator ...................................................................... 64 1.16.10.2 BPM Remove Plants and Libraries.................................................................... 64 1.16.10.3 BPM Close Session........................................................................................... 64 1.16.11 Material Manager resources .............................................................................. 64 1.16.11.1 MM Model Configuration ................................................................................... 64 1.16.11.2 MM Configuration Administrator ........................................................................ 65 1.16.11.3 MM Sublot Management ................................................................................... 65 1.16.11.4 MM Hut Configuration........................................................................................ 65 1.16.11.5 MM Close Session............................................................................................. 65 1.16.12 Messaging Manager resources.......................................................................... 65 1.16.12.1 Access to Messaging Manager Form................................................................ 65 1.16.13 Production Order Manager resources ............................................................... 65 1.16.13.1 POM Order Dispatch ......................................................................................... 65 1.16.13.2 POM Order Management .................................................................................. 66 1.16.13.3 POM In Progress Order Management............................................................... 66 1.16.13.4 POM Configuration Administrator...................................................................... 66 1.16.13.5 POM Template Instantiation .............................................................................. 66 1.16.13.6 POM Template Management ............................................................................ 66 1.16.13.7 POM State Machine Management .................................................................... 66 1.16.13.8 POM Close Session .......................................................................................... 66

1.16.14 Production Operation Recorder resources ........................................................ 67 1.16.14.1 POPR Backup Restore...................................................................................... 67 1.16.14.2 POPR Configuration Administrator.................................................................... 67 1.16.14.3 POPR Close Session ........................................................................................ 67 1.16.15 Personnel Manager resources........................................................................... 67 1.16.15.1 PRM Common Data Configuration .................................................................... 67 1.16.15.2 PRM Low Level Operator .................................................................................. 67 1.16.15.3 PRM Manager.................................................................................................... 67 1.16.15.4 PRM Person/Group Definition ........................................................................... 67 1.16.15.5 PRM Work Schedule Definition ......................................................................... 67 1.16.16 Miscellaneous resources ................................................................................... 68 1.16.16.1 Browse Source Files.......................................................................................... 68 1.16.16.2 CommuWinII - Specialist User........................................................................... 68 1.16.16.3 Edit DB, User Libraries, Projects ....................................................................... 68 1.16.16.4 Hardware Configuration..................................................................................... 68 1.16.16.5 Modify, Save, Compile Source Files ................................................................. 68 1.16.16.6 PMC Operations ................................................................................................ 68 1.16.16.7 Program Transmission ...................................................................................... 68 1.16.16.8 Run ODS ........................................................................................................... 69 1.16.16.9 Set Variables from Ladder, Block Diagram, ODS ............................................. 69 1.16.16.10 Application Builder Runtime Widget ............................................................ 69 1.16.16.11 Batch Operator ............................................................................................ 69 1.16.16.12 Close Application Builder Runtime .............................................................. 69 1.16.16.13 Set Variables from OPC Server .................................................................. 69 1.17 Licensing ............................................................................................................ 69 1.17.1 Inserting SIMATIC IT license codes .................................................................. 69 1.17.2 When you insert licenses for the first time ......................................................... 70 1.17.3 Inserting license codes from file......................................................................... 70 1.17.4 Entering license codes manually ....................................................................... 70 1.18 Basic Configuration............................................................................................ 71 1.18.1 System configuration ......................................................................................... 71 1.18.2 Entering the System Configuration window ....................................................... 71 1.18.3 Workstation ........................................................................................................ 72 1.18.3.1 Configuring a SIMATIC IT workstation .............................................................. 72 1.18.3.2 Enabling serial communications ........................................................................ 72 1.18.3.3 Defining the system language............................................................................ 72 1.18.4 Foundation servers ............................................................................................ 73 1.18.4.1 Configuring the Foundation servers................................................................... 73 1.18.4.2 What happens if no Foundation servers are configured?.................................. 73 1.18.4.3 Removing a Foundation server.......................................................................... 74 1.18.5 Start-up configuration......................................................................................... 74 1.18.5.1 Enabling SIMATIC IT stand-alone start-up ........................................................ 74 1.18.5.2 Starting SIMATIC IT Management Console ...................................................... 74 1.18.5.3 Starting SIMATIC IT applications from SIMATIC IT Management Console ...... 75 1.18.5.4 Minimizing SIMATIC IT Management Console.................................................. 75 1.18.5.5 Start order for SIMATIC IT Management Console components........................ 75 1.18.5.6 Starting SIMATIC IT components automatically ................................................ 76 1.18.5.7 Start Delay time ................................................................................................. 77 1.18.5.8 Configuring start-up parameters for SIMATIC IT components .......................... 78 1.18.5.9 Alarm Manager Display: startup parameters ..................................................... 78 1.18.5.10 Real Time Data Engine: start-up parameters.................................................... 78 1.18.5.11 Graphic User Interface Run-Time: start-up parameters .................................... 79 1.18.5.12 Operations Data Display: start-up parameters .................................................. 79 1.18.5.13 Historian Data Display: start-up parameters ..................................................... 79 1.18.5.14 Real Time Data Server: start-up parameters .................................................... 79 1.18.5.15 Controlled shutdown.......................................................................................... 79 1.18.6 Working with Plants ........................................................................................... 80 1.18.6.1 What is a Plant? ................................................................................................. 80 1.18.6.2 Creating a Plant ................................................................................................. 80 1.18.6.3 Opening a Plant ................................................................................................. 81 1.18.6.4 Copying a Plant.................................................................................................. 81 1.18.6.5 Renaming a Plant .............................................................................................. 81

1.18.6.6 Removing a Plant............................................................................................... 81 1.18.6.7 Closing a Plant ................................................................................................... 82 1.18.6.8 Plant directory structure ..................................................................................... 82 1.18.6.9 APPLIC directory structure ................................................................................ 83 1.18.6.10 MMI directory structure...................................................................................... 83 1.18.6.11 ACTION.LOG directory structure....................................................................... 83 1.18.6.12 ALARM.LOG directory structure........................................................................ 84 1.18.6.13 DATA.LOG directory structure........................................................................... 84 1.18.6.14 EVENT.LOG directory structure ........................................................................ 84 1.18.6.15 Archiving ............................................................................................................ 84
1.18.6.16 1.18.6.17 1.18.6.18 1.18.6.19 1.18.6.20 1.18.6.21 1.18.6.22 1.18.6.23 1.18.6.24 1.18.6.25 1.18.6.26 1.18.6.27 1.18.6.28 1.18.6.29 1.18.6.30 1.18.6.32 1.18.6.33 1.18.6.34 1.18.6.35 1.18.6.36 Archiving a Plant............................................................................................................ 84 Archiving a Plant you are not logged on to .................................................................... 84 Creating a backup copy of a Plant................................................................................. 85 Selecting the files to be archived ................................................................................... 85 Selecting the Units to be archived ................................................................................. 86 Selecting the Zones to be archived ............................................................................... 86 Selecting the third-party applications to be archived ..................................................... 86 Checking the correctness of the backup copy ............................................................... 86 Creating a backup copy of a Plant automatically ........................................................... 87 Compiling the backup configuration file ......................................................................... 88 Displaying the contents of a backup file ........................................................................ 89 Sorting the files by user parameters .............................................................................. 89 Selecting the fields to be displayed ............................................................................... 89 Changing the width of table columns............................................................................. 90 Changing the type of character used in the table .......................................................... 90 Restoring a Plant ........................................................................................................... 90 Selecting the files to be restored ................................................................................... 91 Selecting the Units to be restored.................................................................................. 91 Selecting the Zones to be restored................................................................................ 91 Selecting the third-party applications to be restored...................................................... 91

1.18.6.31 Restoring ........................................................................................................... 90

1.18.7 1.18.7.1 1.18.7.2 1.18.7.3 1.18.7.4 1.18.7.5 1.18.7.6 1.18.7.7

Working with Units ............................................................................................. 92 What is a Unit?................................................................................................... 92 Configuring a Unit .............................................................................................. 93 Modifying the Unit attributes .............................................................................. 93 Duplicating a Unit............................................................................................... 94 Renaming a Unit ................................................................................................ 94 Removing a Unit ................................................................................................ 94 RTDS/IMC User Unit.......................................................................................... 94

1.18.7.8 Why use an RTDS/IMC User Unit? ................................................................................. 94 1.18.7.9 Configuring the RTDS/IMC User Unit .............................................................................. 95 1.18.7.10 Configuring the RTDS/IMC User Unit in programming mode ........................................ 95 1.18.7.11 Configuring the RTDS/IMC User Unit in supervisory mode ........................................... 95 1.18.7.12 Configuring the RTDS/IMC User Unit and the network device ...................................... 95 1.18.7.13 Parameters (Arcnet) ...................................................................................................... 96 1.18.7.14 Parameters (Session Manager)..................................................................................... 96

1.18.7.15 Session Manager............................................................................................... 97

1.18.7.16 1.18.7.17 1.18.7.19 1.18.7.20 1.18.7.21 1.18.7.22 1.18.7.23 1.18.7.25 1.18.7.26 1.18.7.27 1.18.7.28 1.18.7.30 1.18.7.31 1.18.7.32 1.18.7.33 1.18.7.34 Why use a Session Manager Unit ? .............................................................................. 97 Configuring a Session Manager Unit ............................................................................. 97 Why use a ControlCORE Unit ? .................................................................................... 97 Configuring the ControlCORE Unit ................................................................................ 97 Configuring the ControlCORE Unit in programming mode ............................................ 97 Configuring the ControlCORE Unit in supervisory mode ............................................... 98 Configuring the ControlCORE Unit and the network device .......................................... 98 Why use a Remote Control Unit ? ................................................................................. 99 Configuring a Remote CONTROL Unit .......................................................................... 99 Configuring a Remote Control Unit in programming mode ...........................................100 Configuring a Remote Control Unit in supervisory mode ..............................................100 Why use a CONTROL UNIT ?......................................................................................100 Configuring the CONTROL Unit ...................................................................................101 Configuring a Control Unit in programming mode.........................................................101 Configuring a Control Unit in supervisory mode ...........................................................101 Configuring a CONTROL Unit and the network device.................................................102

1.18.7.18 ControlCORE Unit ............................................................................................. 97

1.18.7.24 Remote CONTROL Unit .................................................................................... 99

1.18.7.29 CONTROL Unit................................................................................................100

1.18.7.35 1.18.7.37 1.18.7.38 1.18.7.39 1.18.7.41

P.M.C. date & time synchronization..............................................................................102 Why use a Real Time Data Engine User Unit?.............................................................102 Configuring the Real Time Data Engine User Unit .......................................................103 Configuring the Real Time Data Engine User Unit and the network device..................103 Configuring an RTDS/IMC-EXTERN DEVICE User Unit ..............................................104

1.18.7.36 Real Time Data Engine User Unit ...................................................................102

1.18.7.40 RTDS/IMC - EXTERN DEVICE User Unit.......................................................104 1.19 1.19.1 1.19.1.1 1.19.1.2 1.19.1.3 1.19.1.4 1.19.1.5 Advanced Configuration................................................................................... 105 Networks and Communication .........................................................................105 Monitoring network nodes................................................................................105 Rebuilding the network configuration...............................................................105 Time alignment on client workstations.............................................................106 Advanced configurations..................................................................................107 RIS ...................................................................................................................107

1.19.1.6 RIS Inter-Process Communication Service.....................................................................107 1.19.1.7 Configuring networking using RIS IPC ...........................................................................107 1.19.1.8 Example..........................................................................................................................108 1.19.1.9 Example..........................................................................................................................109 1.19.1.10 Example - Two servers in hot-backup configuration with preferential network set for backup communications. ..............................................................................................................................109 1.19.1.11 Example - Two servers in hot-backup configuration with no preferential network ........110 1.19.1.12 Example - A single server without backup with two clients ...........................................111 1.19.1.13 Configuring a redundant network with two Historian servers in hot-backup..................111 1.19.1.14 Example of a configuration of a redundant network with two Historian servers in hot-backup configuration and one client .............................................................................................................111 1.19.1.15 Configuring the RIS parameters ...................................................................................112 1.19.1.16 Configuring the RIS parameters (Default).....................................................................113 1.19.1.17 Configuring the RIS parameters (Custom)....................................................................113 1.19.1.18 IPADDR.INI ..................................................................................................................114 1.19.1.19 Adding a new FAT Server.............................................................................................114

1.19.1.20 TCP/IP .............................................................................................................114

1.19.1.21 1.19.1.22 1.19.1.23 1.19.1.25 1.19.1.26 1.19.1.27 1.19.1.28 Configuring the TCP protocol .......................................................................................114 Configurable TCP/IP parameters..................................................................................115 Optimizing TCP/IP timeouts..........................................................................................116 Overview of CAB Protocol Configurator........................................................................116 Defining the default settings .........................................................................................117 Defining specific subnet settings ..................................................................................118 Troubleshooting for CAB Protocol Configurator............................................................119

1.19.1.24 CAB Protocol Configurator ..............................................................................116

1.19.2 1.19.2.1 1.19.2.2 1.19.2.3 1.19.2.4 1.19.2.5 1.19.2.6 1.19.2.7 1.19.3 1.19.3.1 1.19.3.2 1.19.3.3 1.19.3.4 1.19.3.5 1.19.4 1.19.4.1 1.19.4.2 1.19.4.3 1.19.4.4 1.20 1.20.1 1.20.2
1.20.2.1 1.20.2.2 1.20.2.3 1.20.2.4

Client/Server Architecture ................................................................................119 Client/Server Architecture ................................................................................119 Sharing a Plant ................................................................................................120 Connecting to a remote Plant ..........................................................................121 Emergency configuration for SIMATIC IT client workstations .........................121 Configuring a client workstation .......................................................................122 Disabling file alignment ....................................................................................122 Filtering files to be replicated ...........................................................................123 Security Management ......................................................................................123 Security Management ......................................................................................123 Disabling hotkey combinations ........................................................................124 Disabling Ctrl Alt Del ........................................................................................124 Automatic Windows Logon ..............................................................................124 Impersonate User ............................................................................................125 External components .......................................................................................125 Adding third-party components to the Client menu..........................................125 Structure of .ADN files .....................................................................................125 Starting the third-party modules.......................................................................127 Adding custom components to the Client menu ..............................................128 Troubleshooting Tools ..................................................................................... 128 Alerter service ..................................................................................................128 Log File Viewer ................................................................................................129
Overview of Log File Viewer ...........................................................................................129 Structure of log file messages ........................................................................................129 Starting the Log File Viewer............................................................................................130 Updating log file messages.............................................................................................130

1.20.2.5

Displaying details of a message .....................................................................................130

1.20.2.6 Environment: Customize the Log File Viewer window.....................................131 1.20.2.7 Environment: Arranging windows ....................................................................131 1.20.2.8 Environment: Arranging the selected windows................................................132 1.20.2.9 Environment: Hiding messages .......................................................................132 1.20.2.10 Environment: Showing hidden messages .......................................................132 1.20.2.11 Environment: Configuring the message display time ......................................133 1.20.2.12 Environment: Setting the local time .................................................................133 1.20.2.13 Applying filters .................................................................................................133 1.20.2.14 Filtering by the description...............................................................................133 1.20.2.15 Filtering by date ...............................................................................................134 1.20.2.16 Filtering by priority level...................................................................................134 1.20.2.17 Filtering by advanced criteria...........................................................................135 1.20.2.18 Filtering by application.....................................................................................135 1.20.2.19 Finding a message in the log file .....................................................................135 1.20.2.20 Priority Level search option .............................................................................136 1.20.2.21 Application search option ................................................................................136 1.20.2.22 Advanced Criteria search option .....................................................................136 1.20.2.23 Message search option ...................................................................................137 1.20.2.24 Working with log files.......................................................................................137
1.20.2.25 1.20.2.26 1.20.2.27 1.20.2.28 1.20.2.29 1.20.2.30 Opening a log file..........................................................................................................137 Viewing archived log files .............................................................................................137 Viewing application log files..........................................................................................137 Viewing remote log files................................................................................................138 Saving a log file ............................................................................................................138 Printing a log file ...........................................................................................................138

1.20.2.31 Overwriting the system log ..............................................................................139 1.20.2.32 Configuring the log size ...................................................................................139 1.20.2.33 Configuring the overwriting mode....................................................................139 1.20.2.34 Displaying information on the log file...............................................................140 1.20.2.35 Removing log messages .................................................................................140 1.20.2.36 Configuring Categories....................................................................................141
1.20.2.37 1.20.2.38 1.20.2.39 Defining the category value ..........................................................................................141 Disabling message archiving for an application............................................................141 Loading a category configuration file ............................................................................142

Text Editor 2.1 2.1.1 2.1.2 2.2 2.2.1 2.2.2 2.2.3 2.2.4 2.2.5 2.3 2.3.1 2.3.2 2.3.3 2.3.4 2.3.5 2.3.6 2.3.7 2.4 2.4.1 2.4.2 2.4.3 2.4.4 2.4.5 2.4.6 2.5 2.5.1

143

Overview .......................................................................................................... 143 Overview of Text Editor....................................................................................143 Starting the Text Editor from SIMATIC IT Management Console....................143 Working with text files ...................................................................................... 144 Creating a new file ...........................................................................................144 Opening a file ...................................................................................................144 Saving a file......................................................................................................144 Printing a file ....................................................................................................144 Closing a file.....................................................................................................145 Editing text files ................................................................................................ 145 Standard Editing operations.............................................................................145 Tabs and spaces..............................................................................................145 Advanced Editing operations ...........................................................................146 Selecting a horizontal block of text ..................................................................146 Selecting a vertical block of text.......................................................................146 Filling a selection .............................................................................................147 Keys available in Text Editor............................................................................147 Finding and replacing text................................................................................ 148 Finding and replacing.......................................................................................148 Finding text in the current file...........................................................................148 Finding and replacing text in the current file ....................................................149 Finding text in more than one file.....................................................................149 Finding and replacing text in more than one file ..............................................150 Locating text in the file .....................................................................................150 Customizing the working environment............................................................. 151 Showing/hiding toolbars...................................................................................151

2.5.2 2.5.3 2.5.4 2.5.5 2.5.6 2.5.7 2.5.8 2.5.9 3

Showing/hiding the Output Window.................................................................151 Choosing the default file type...........................................................................152 Choosing the default save format ....................................................................152 Configuring the Save options...........................................................................152 Setting Colours ................................................................................................153 Defining user keywords....................................................................................153 Setting the default font .....................................................................................154 Configuring the search options ........................................................................154 155

Hot Backup 3.1 3.1.1 3.1.2 3.1.3 3.1.4 3.2 3.2.1 3.2.2 3.2.3 3.2.4 3.2.5 3.2.6 3.2.7 3.2.8 3.3 3.3.1 3.3.2 3.3.3 3.3.4 3.3.5 3.3.6 3.3.7 3.3.8 3.3.9 3.3.10 3.4 3.4.1 3.4.2 3.4.3

Overview .......................................................................................................... 155 Hot Backup.......................................................................................................155 Useful tips on hot backup.................................................................................155 Monitoring the backup status ...........................................................................156 Backup status...................................................................................................156 Configuring servers in hot backup ................................................................... 157 Configuring hot backup for SIMATIC IT plants and applications .....................157 Configuring hot-backup servers as Primary and Auxiliary Master...................158 Removing hot-backup servers .........................................................................158 Modifying hot-backup servers ..........................................................................158 Configuring SIMATIC IT applications hot-backup............................................159 Configuring the Plant hot backup.....................................................................159 Replication of files between primary and auxiliary masters.............................160 Copying Plant directories .................................................................................160 Master-slave switching..................................................................................... 161 Overview of master-slave switching.................................................................161 Plant Master-Slave Switching ..........................................................................161 When the master disk is unavailable ...............................................................162 Example: when the master disk is not available ..............................................162 When a network error occurs (Plants) .............................................................162 Application Master-Slave Switching.................................................................162 When the master application is unavailable ....................................................163 Example: when the master application is not available ...................................163 When a network error occurs (Applications)....................................................164 Enhancing master-slave alignment..................................................................164 Manual switching ............................................................................................. 164 Manual switching of Plants and modules.........................................................164 Manual master-slave switching of Plants.........................................................164 Manual master-slave switching of SIMATIC IT components ...........................165 166

Tag Management 4.1 4.1.1 4.1.2 4.1.3 4.2 4.2.1 4.2.1.1 4.2.2 4.2.3 4.2.3.1 4.3 4.3.1 4.3.2 4.3.3 4.3.3.1 4.3.3.2 4.3.4 4.3.4.1 4.3.4.2 4.3.4.3 4.3.4.4

Overview .......................................................................................................... 166 Overview of the Points Database.....................................................................166 Structure of the Points Database .....................................................................166 Maximum size of the Points Database ............................................................166 Points Database tables .................................................................................... 167 Main table.........................................................................................................167 AM table...........................................................................................................168 GUI table ..........................................................................................................168 PDA table .........................................................................................................169 RTDS table ......................................................................................................170 Database Editor ............................................................................................... 170 Starting the Database Editor............................................................................170 Typographical conventions used in the database grid ....................................171 Opening a database.........................................................................................172 Opening a database (Database Editor)...........................................................172 Opening a database linked to a particular Unit ...............................................172 Working with views ..........................................................................................172 Database table views ......................................................................................172 User Views.......................................................................................................172 Creating a User view .......................................................................................173 Assigning a User view .....................................................................................173

4.3.4.5 4.3.5 4.3.5.1 4.3.5.2 4.3.5.3 4.3.5.4 4.3.5.5 4.3.5.6 4.3.5.7 4.3.5.8 4.3.5.9 4.3.5.10 4.3.5.11 4.3.5.12 4.3.5.13 4.3.5.14 4.3.5.15 4.3.5.16 4.3.5.17 4.3.5.18 4.3.5.19 4.3.5.20 4.3.5.21 4.3.5.22 4.3.5.23 4.3.5.24 4.3.5.25 4.3.5.26 4.3.5.27 4.3.5.28 4.3.5.29 4.3.6 4.3.6.1 4.3.6.2 4.3.6.3 4.3.6.4 4.3.6.5 4.3.6.6 4.3.6.7 4.3.6.8 4.3.6.9 4.3.7 4.3.7.1 4.3.8 4.3.8.1 4.3.8.2 4.3.8.3 4.3.8.4 4.3.8.5 4.3.9 4.3.9.1 4.3.10 4.3.10.1 4.3.11 4.3.11.1 4.3.11.2 4.3.11.3 4.3.11.4 4.3.11.5 4.3.11.6 4.3.11.7 4.3.12

Deleting a User view........................................................................................173 Working with points..........................................................................................174 Managing Points ..............................................................................................174 Inserting a new point (guided mode) ...............................................................174 Inserting a new point (manual mode) ..............................................................175 Automatic allocation ........................................................................................176 Example of automatic allocation......................................................................176 Automatic Filling ..............................................................................................177 Example of Automatic Filling ...........................................................................177 Modifying a point (guided mode) .....................................................................178 Modifying a point (manual mode) ....................................................................179 Modifying a group of variables .........................................................................179 Deleting a point ................................................................................................179 Duplicating a point ...........................................................................................180 Duplicating several points ................................................................................180 Correcting errors ..............................................................................................180 Displaying errors ..............................................................................................180 Converting a scalar variable into an array .......................................................180 Find and Replace.............................................................................................181 Conventions used for finding strings................................................................181 Single-field queries ..........................................................................................181 Multiple-field queries ........................................................................................182 Finding and replacing text................................................................................183 Converting text to uppercase/lowercase..........................................................184 Locating a point in the database ......................................................................184 Sorting points ...................................................................................................184 Inserting/removing Bookmarks ........................................................................184 Exporting points ...............................................................................................185 Importing points from a .DEF file .....................................................................186 Locking a point .................................................................................................186 Unlocking a point .............................................................................................187 Working with arrays .........................................................................................187 Managing Arrays..............................................................................................187 Adding an array ...............................................................................................187 Modifying the field values of an array element (guided mode)........................188 Buttons.............................................................................................................188 Modifying the field values of an array element (manual mode).......................189 Duplicating an array.........................................................................................189 Deleting Arrays ................................................................................................189 Locking an array ..............................................................................................190 Unlocking an array...........................................................................................190 Updating server configuration ..........................................................................191 Updating the SIMATIC IT servers configuration..............................................191 Configuring alarms...........................................................................................191 Configuring alarms ..........................................................................................191 Creating a group of alarms ..............................................................................192 Updating alarm groups ....................................................................................192 Associating an alarm group to a point .............................................................193 Configuring the read/write mode .....................................................................193 Configuring RTDS parameters.........................................................................194 Entering RTDS parameters to handle communication with a PLC network....194 Configuring historical data ...............................................................................194 Configuring a point to be archived ...................................................................194 Configuring graphic panels ..............................................................................195 Graphic object attributes ..................................................................................195 Configuring graphic object parameters............................................................196 Parameters used by graphic objects ...............................................................196 Parameters of a logic variable .........................................................................197 Parameters for a slider.....................................................................................197 Parameters of an integer or real variable ........................................................198 Parameters for a Trend or a Chart...................................................................198 Repairing the database....................................................................................198

4.3.12.1 Recreating the database indexes ....................................................................198 4.3.12.2 Rebuilding the database ..................................................................................199 4.3.12.3 Resetting the server status ..............................................................................199 4.3.13 Printing .............................................................................................................199 4.3.13.1 Printing the database .......................................................................................199 4.3.13.2 Print preview ....................................................................................................199 4.3.13.3 Selecting a printer ............................................................................................199 4.3.13.4 Printing records ................................................................................................200 4.3.13.5 Printing to file ...................................................................................................200 4.3.13.6 Print settings ....................................................................................................200 4.3.13.7 Defining the header..........................................................................................201 4.3.13.8 Defining the footer............................................................................................201 4.3.13.9 Defining the page layout ..................................................................................201 4.3.13.10 Defining the filter..............................................................................................201 4.3.14 Customizing the environment ..........................................................................202 4.3.14.1 Showing/hiding bars.........................................................................................202 4.3.14.2 Customizing the scroll bars..............................................................................202 4.3.14.3 Arranging windows in the client area ...............................................................203 4.3.14.4 Changing the font.............................................................................................203 4.3.14.5 Changing colors ...............................................................................................203 4.3.14.6 Customizing a view ..........................................................................................204 4.3.15 Creating a Database ........................................................................................204 4.3.15.1 Automatic vs. manual database creation.........................................................204 4.3.15.2 Creating a database associated with an RTDS/IMC Unit................................205 4.3.15.3 Creating a database associated with a Real Time Data Engine Unit ..............205 4.3.15.4 Creating a database associated with a CONTROL Unit..................................205 4.3.15.5 Creating a database from Database Editor .....................................................205 4.3.16 Creating a new database .................................................................................206 4.4 Locreg management ........................................................................................ 206 4.4.1 Defining and displaying the Locreg..................................................................206 4.4.2 Database Locreg - Details ...............................................................................207 4.4.3 Troubleshooting for different locregs ...............................................................207 4.4.4 Assigning a new locreg run-time......................................................................207 4.4.5 Viewing the locreg map....................................................................................207 4.5 Database Management Tool............................................................................ 208 4.5.1 Overview about Points Database Maintenance...............................................208 4.5.2 The Database Management environment .......................................................209 4.5.3 Database attributes..........................................................................................209 4.5.4 Field: Type .......................................................................................................210 4.5.5 Viewing the Database details...........................................................................210 4.5.6 Opening a database (Database Management)................................................210 4.5.7 Database-file types ..........................................................................................210 4.5.8 Renaming a database......................................................................................211 4.5.9 Browsing the database ....................................................................................211 4.5.10 Copying a database .........................................................................................211 4.5.11 Removing a database ......................................................................................212 4.5.12 Reallocating registers ......................................................................................212 4.5.13 Importing/exporting a database .......................................................................212 4.5.14 Conversion .......................................................................................................213 4.5.14.1 Creating a CSV file ..........................................................................................213 4.5.14.2 Keyword: Symbolic ..........................................................................................214 4.5.14.3 Keyword:Type ..................................................................................................214 4.5.14.4 Keyword: Register............................................................................................214 4.5.14.5 Keyword: Comment1 .......................................................................................214 4.5.14.6 Keyword: Comment2 .......................................................................................214 4.5.14.7 Keyword: Description .......................................................................................214 4.5.14.8 Example of CSV File........................................................................................215 4.5.14.9 Converting a database.....................................................................................215 4.5.14.10 Converting a SIMATIC IT database (.CDB) into a .CSV file ...........................215 4.5.14.11 Converting the format of a SIMATIC IT database (.CDB) ...............................216 4.5.14.12 Converting a .CSV file into a SIMATIC IT database (.CDB) ...........................217 4.5.14.13 Conversion with Main tab ................................................................................217

4.5.14.14 Conversion without Main tab ...........................................................................218 4.5.15 Merging ............................................................................................................219 4.5.15.1 Merging databases ..........................................................................................219 4.5.15.2 Register Reallocation.......................................................................................219 4.5.15.3 Example ...........................................................................................................220 4.5.15.4 Reallocation rules ............................................................................................221 4.5.15.5 Example of register reallocation.......................................................................221 4.5.15.6 Congruence of the database Locregs..............................................................222 4.6 Database Browser ........................................................................................... 222 4.6.1 Overview of the Database Browser .................................................................222 4.6.2 Selecting a different Unit..................................................................................223 4.6.3 Finding records ................................................................................................223 4.6.3.1 Finding Records ..............................................................................................223 4.6.3.2 Searching by Point Type .................................................................................224 4.6.3.3 Searching by Symbolic Name .........................................................................224 4.6.3.4 Searching by Comment ...................................................................................224 4.6.3.5 Searching by Record Type ..............................................................................224 4.6.3.6 Searching by RTDS fields ...............................................................................225 4.6.3.7 Searching by Configuration .............................................................................225 4.6.3.8 Choosing the Sorting Order.............................................................................225 4.6.3.9 Choosing the Display Format ..........................................................................226 4.6.3.10 Display Format: Normal ...................................................................................226 4.6.3.11 Display Format: Extended................................................................................226 4.6.3.12 Display Format: Compressed ..........................................................................226 5 Real Time Data Server 5.1 5.1.1 5.1.2 5.1.3 5.1.4 5.1.5 5.1.6 5.1.7 5.1.8 5.1.9 5.1.10 5.2 5.2.1 5.2.2 5.2.3 5.2.4 5.2.5 5.2.6 5.2.7 5.2.8 5.2.9 5.2.10 5.2.11 5.2.12 5.2.13 5.3 5.3.1 5.3.2 5.3.3 5.3.4 5.3.5 5.3.6 5.3.7 5.3.8 5.3.9 228

Overview .......................................................................................................... 228 What is SIMATIC IT Real Time Data Server? .................................................228 Starting SIMATIC IT Real Time Data Server ...................................................229 RTDS polling classes.......................................................................................230 Dynamic class change .....................................................................................231 Dynamic class change scenarios.....................................................................231 Reading and writing arrays with RTDS............................................................232 Installing and Configuring the SIMATIC IT Real Time Data Server Drivers ....232 Data exchange between SIMATIC IT Real Time Data Server and the RTDS interfaces .........................................................................................................................233 Updating the SIMATIC IT Real Time Data Server ...........................................233 Troubleshooting the RTDS update ..................................................................234 Data Memory Area........................................................................................... 235 Data Memory Area...........................................................................................235 RTDS Data Types............................................................................................235 System Locregs for SIMATIC IT Real Time Data Server ................................235 Locreg RTDB_0 ...............................................................................................236 Locreg RTDB_1 ...............................................................................................236 Locreg RTDB_2 ...............................................................................................236 Locreg RTDB_3 ...............................................................................................237 Locreg RTDB_4 ...............................................................................................237 Locreg RTDB_5 ...............................................................................................237 User Registers .................................................................................................237 Registers for RTDS Locregs ............................................................................237 Registers for PMC Locregs..............................................................................238 System Registers.............................................................................................239 Configuring the Locreg..................................................................................... 239 Configuring the Locreg.....................................................................................239 Creating a new user locreg ..............................................................................240 If you have selected an RTDS Locreg .............................................................240 Type .................................................................................................................241 Field Memory ...................................................................................................241 User Memory....................................................................................................241 Backup Memory ...............................................................................................241 If you have selected a PMC Locreg.................................................................242 Permanent Memory .........................................................................................242

5.3.10 5.3.11 5.3.12 5.4 5.4.1 5.4.2 5.4.3 5.4.4 5.4.5 5.4.6 5.4.7 5.4.8 5.4.9 5.4.10 5.4.11 5.4.12 5.4.13 5.4.14 5.4.15 5.5 5.5.1 5.5.2 5.5.3 5.5.4 5.6 5.6.1 5.6.2 5.6.3 5.6.4 5.6.5 5.6.6 5.6.7 5.6.8 5.6.9 6

Not permanent Memory ...................................................................................242 Modifying a user locreg....................................................................................243 Viewing the registers of a locreg......................................................................243 Configuring SIMATIC IT Real Time Data Server ............................................. 244 Configuring SIMATIC IT Real Time Data Server .............................................244 Configuring the interfaces to the RTDS drivers ...............................................245 Defining the size of RTDS queues...................................................................246 Monitoring the RTDS queue status..................................................................247 Defining the management of 0 class points.....................................................247 Optimizing the setting of values on device drivers for 0 class points ..............248 Enabling oneshot reading ................................................................................248 Enabling quality flags management.................................................................248 Enabling Time Stamp.......................................................................................249 Displaying quality information ..........................................................................249 The GOOD quality attribute .............................................................................250 The BAD quality attribute .................................................................................250 The UNCERTAIN quality attribute ...................................................................250 The quality status.............................................................................................251 The limit field ....................................................................................................251 Hot backup (redundancy)................................................................................. 251 Details on RTDS hot backup (redundancy) .....................................................251 Register management with RTDS in hot backup.............................................251 The DB-Align function ......................................................................................252 Launching the DB-Align application (dbalign.exe) ...........................................252 Advanced RTDS configuration......................................................................... 253 Advanced RTDS configurations.......................................................................253 COMMVIEWER.INI..........................................................................................253 GPSSOCK.INI..................................................................................................253 ITFLIB.INI.........................................................................................................254 MENU.INI .........................................................................................................255 NCSERV.INI.....................................................................................................255 QBRIDGE.INI ...................................................................................................255 RTDB.INI..........................................................................................................256 USERBK.INI.....................................................................................................257 259

The SIMATIC IT OPC Browser 6.1

How to use SIMATIC IT OPC Browser ............................................................ 259

SIMATIC IT Services

1.1
1.1.1

Overview
SIMATIC IT Services
SIMATIC IT Services is a software package that acts as an enabling layer offering common services to all SIMATIC IT components. Such services include: User Management License Management Audit Trail Service Electronic Signature Service Troubleshooting Tools Configuration Tools Messaging Management

1.1.2

Starting SIMATIC IT Services

After installing SIMATIC IT Services, you must configure some parameters related to the clientserver architecture and the network services. Note that configuration can only be done after the program has been started.

To start SIMATIC IT Services from Windows: 1. Select the Start button from Microsoft Windows taskbar. 2. Select option Programs. 3. Click the Management Console icon Console. in the program group SIMATIC IT Management

The SIMATIC IT Management Console welcome window appears showing the different software modules being loaded (this operation takes a few seconds). This window also contains useful information about the environment, the version date and number, the protection key serial number.

Depending on the configuration, you might either access the Plant Management environment (this occurs, for instance, when you start SIMATIC IT Services for the very first time) or log on directly to a specific Plant and thus access the Management Console environment. In both cases, you will have to perform some configurations required for the system to work correctly.

SIMATIC IT Services V4.4 SP2 User Manual

13

1.1.3

Quitting SIMATIC IT Services

To terminate your working session and log off from SIMATIC IT Services: 1. Select command File > Exit from Plant Management or Management Console. 2. The Exit window appears. Select one of the following options:

Select Exit Exit to Operating System Shutdown Shutdown and Power Off

To End the current working session, quit the Management Console / Plant Management environment. End the current working session, quit the Management Console / Plant Management environment and return to Windows End the Windows working session and prepare your computer to be turned off. End the current SIMATIC IT working session and switch off the computer (hardware dependent). Note If you want the option Shutdown and Power Off to appear in the WinLogOn menu you have to set it in the PC registry. This is only possible if the OEM has supplied the computer with a HAL (Hardware Abstruction Layer) which supports the power down request. The x86 Microsoft supplied HALs do not support this request.

If you choose to Shutdown the system, you can then select one of the following options:
Select Restart when shutdown is complete Restart with Operating System Shell active Automatic Windows Logon To Restart automatically after the system shutdown is complete Restart the system and activate the Windows NT operating system shell Restart and logon automatically to Windows (without pressing CTRL+ALT+DEL).

Important In order for the Restart with Operating System Shell active and Automatic Windows Logon options to work correctly, the Windows user must have the right to access the Registry.

1.2
1.2.1

Getting Started
When SIMATIC IT Services is started for the first time
The first time the system is started, it is possible to configure the system quickly: Stand Alone Configuration Client-Server Configuration Client-Server Backup Configuration.

Important
SIMATIC IT Services V4.4 SP2 User Manual 14

SIMATIC IT Services should be started on the workstation on which the Plant will reside. It is recommended that this workstation be also configured as one of the Foundation servers.

Important The Management Console Quick Configuration tool allows you to define only the SIMATIC IT workstations. To configure network and control devices, you must use the Network Configuration tool or define them when configuring a Unit.

After that, some other configuration must be carried out: Configuring the users and the access levels Configuring the plant and units

Important In order to configure a Unit it is necessary to insert the SIMATIC IT Services license. For more information, see Inserting SIMATIC IT license codes.

The SIMATIC IT licenses must be configured on each workstation of the network, in relation to the components for which the license has been purchased.

1.2.2

Stand Alone Configuration

To configure a Stand-Alone application: 1. Select command Tools > Management Console Quick Configuration in Plant Management. 2. In the Management Console Quick Configuration dialog box, select the Stand Alone option button. Click Next. 3. Within the Foundation Server tab, enter the computer name of the workstation that will be configured as the Foundation server and click the Apply button. For more information about defining Foundation servers, see Configuring the Foundation servers. 4. Select a network and click Add. Click the Next button. Note: It is possible to change the name, used to identify the network, by clicking and overwriting it. 5. Insert the required parameters for system configuration according to the selected network and click Next. 6. Information about the configuration (Foundation server, network type, node number, ) is displayed. Click Finish to save the configuration.

Checking the configuration

After completing this configuration, you can check it by clicking Tools > Network Configuration in Plant Management.

SIMATIC IT Services V4.4 SP2 User Manual

15

1.2.3

Client-Server Configuration
To configure a Client-Server application: 1. Select command Tools > Management Console Quick Configuration in Plant Management. 2. In the Management Console Quick Configuration dialog box, select the Client-Server option button. Click Next. 3. Within the Foundation Server tab, enter the computer name of the workstation that will be configured as the Foundation server and click Add. Then click the Apply button. For more information about defining Foundation servers, see Configuring the Foundation servers. 4. Within the Client tab, enter the computer name of the workstation that will be configured as the client and click Add. Note: It is possible to change the name, used to identify the network, by clicking and overwriting it. 5. Select a network and click Add. Click the Next button. 6. Insert the required parameters for system configuration according to the selected network and click Next. 7. Information about the configuration (Foundation server, network type, node number, ) is displayed. Click Finish to save the configuration

Checking the configuration

After completing this configuration, you can check it by clicking Tools > Network Configuration in Plant Management.

1.2.4

Client-Server Backup Configuration

To configure a Client-Server Backup application: 1. Select command Tools > Management Console Quick Configuration in Plant Management. 2. In the Management Console Quick Configuration dialog box, select the Client-Server Backup option button. Click Next. 3. Within the Foundation Server tab, enter the computer name of the workstations that will be configured as the Primary Master and Auxiliary Master and click the Apply button. . For more information about defining Foundation servers, see Configuring the Foundation servers. 4. Within the Client tab, enter the computer name of the workstation(s) that will be configured as the client(s) and click Add. 5. Select a network and click Add. Click the Next button. Note: It is possible to change the name, used to identify the network, by clicking and overwriting it 6. Insert the required parameters for system configuration according to the selected network and click Next. 7. Information about the configuration (Foundation server, network type, node number, ) is displayed. Click Finish to save the configuration.

SIMATIC IT Services V4.4 SP2 User Manual

16

Checking the configuration

After completing this configuration, you can check it by clicking Tools > Network Configuration in Plant Management.

1.2.5

Parameters for system configuration

The following table illustrates the parameters that are involved in performing: Stand Alone configuration Client Server configuration Client Server Backup configuration

Parameter Cpu type

Iternet Select the type of CPU associated with the workstation: None: Used exclusively for supervision tasks RTDS/IMC-n: Used to read or write data to non-proprietary PLC networks or other devices. Each type of RTDB_IMC CPU identifies the default locreg that will be assigned to all logical Units associated with this workstation (e.g. CPU type RTDS/IMC1 corresponds to locreg RTDS1). For more information on SIMATIC IT system locregs, see System Locregs for SIMATIC IT Real Time Data Server. SPV-n: This CPU type is obsolete and is used only for old locregs based on VMS systems

Session Manager As per Iternet.

Node A IP Address

Enter the node number assigned to the workstation. Not applicable.

Not applicable. Enter the TCP/IP address of Channel A (and, if necessary, of Channel B) from the workstation you are configuring. For more information on IP Addresses, see Session Manager network parameters .

1.3
1.3.1

Environment
SIMATIC IT Services environment
SIMATIC IT Services are the ground layer that supports the systems entire architecture and must be installed on each workstation. The Services main role is to centralize those functions affecting all of the systems components: i.e. management and configuration of users and user groups, licenses, logging of operations, hot back-up, real-time database, system events, etc.

SIMATIC IT Services V4.4 SP2 User Manual

17

The main working environments that make up the Services are: Plant Management Management Console Zone Monitoring Environment

1.3.2

Plant Management
The Plant Management environment is specifically designed for Plant definition. In the SIMATIC IT environment, the term "Plant" indicates an element that comprehends all the configurations, programs and, in general, the files that form an application for the supervision and control of an automation system.

From the Plant Management environment you can perform some basic functions for SIMATIC IT Services environment configuration, such as management of users, definition of master machines, management of the physical network and the enabling codes of the SIMATIC IT components. Once the Plant has been defined, and configuration, which is essential for system operation, has been carried out, you can access the SIMATIC IT Management Console system menu for a single Plant.

1.3.3

What can I do from Plant Management ?

From the Plant Management environment, you can: Configure the Foundation servers Configure the SIMATIC IT network Insert license codes Configure groups Configure your workstation

1.3.4

Management Console
SIMATIC IT Management Console is the management and configuration environment for all SIMATIC IT components. From Management Console, you can access all the configuration tools (licenses, users, workstation, network, start-up, third party applications, etc) and, in general, all those components making up the SIMATIC IT product family. The SIMATIC IT Management Console environment is made up of various tabs, from which you can access the different functions. The same functions are also available from the menu commands.

SIMATIC IT Services V4.4 SP2 User Manual

18

Important Access to individual SIMATIC IT components depends on the resources available to each user.

1.3.5

ZME Zone Monitoring Environment

From SIMATIC IT Management Console you can define supervisory Zones, that is the supervisory logical areas that make up a Plant. The Zone is the logical element that includes all files and configurations dedicated to the supervision and management of a specific Plant area. Each workstation can access more than one supervisory Zone, either local or remote. Supervisory Zones are managed in the SIMATIC IT Management Console environment, in the tab. Each zone is graphically represented by an icon which can be double-clicked by the user in order to launch the Zone Monitoring Environment. Zone Monitoring Environment (ZME) is the supervisory environment which integrates all the software tools required to supervise the Plant, that is: SIMATIC IT Graphic User Interface (SIMATIC IT Graphic User Interface); SIMATIC IT Alarm Manager Display (Alarm Manager Display); SIMATIC IT Historian Data Display (Historian Data Display).

These modules must be configured with reference to a specific Zone, i.e., for a specific logical area of the Plant.
SIMATIC IT Services V4.4 SP2 User Manual 19

You will have access to the Zone Monitoring Environment only if you have configured a Default Zone in SIMATIC IT Management Console, since all the operations (database management, cross-reference, function keyboard configuration, etc.) which you can execute in ZME refer to a specific zone. For more information, see Configuring the Default Zone.

1.3.6

What is a Zone?
The SIMATIC IT environment is subdivided into zones, that is, logical supervision areas. A zone includes all the files and configurations related to the supervision and operation of a specific area of your Plant. To each zone you can associate graphic panels, alarms, archived points.

The SIMATIC IT applications which provide supervisory functions (SIMATIC IT Graphic User Interface, SIMATIC IT Alarm Manager Display, SIMATIC IT Historian Data Display) can be started also from the SIMATIC IT Management Console system menu, but only when executed from within the Zone Monitoring Environment can you obtain a complete view of the whole zone on which you are operating.

Each workstation can have access to more than one supervisory zone, either locally or on a remote server.

1.3.7

Defining a Zone
To define a Zone: 1. Select the tab in SIMATIC IT Management Console.

2. Select command File > New. 3. In the New Zone dialog box enter the name to be assigned to the zone (maximum 8 characters) in the Zone Name box. 4. Click OK. The icon of the zone appears in the window.

The supervisory modules (SIMATIC IT Graphic User Interface, SIMATIC IT Alarm Manager Display, SIMATIC IT Historian Data Display) integrated in Zone Monitoring Environment always refer to the Default Zone when they are activated. For more information, see Configuring the Default Zone.

1.3.8

Configuring the default Zone

The supervisory modules integrated in ZME (SIMATIC IT Graphic User Interface, SIMATIC IT Alarm Manager Display, SIMATIC IT Historian Data Display) always refer to a default zone when they are activated.

To configure the Default Zone:

SIMATIC IT Services V4.4 SP2 User Manual

20

1. Select command Configuration > System in SIMATIC IT Management Console. 2. Click the Plant Configuration tab in the System Configuration window. 3. Select the name of the default zone to be configured from the Current Zone list box. 4. Click OK.

Important If you execute this operation when a supervisory application (SIMATIC IT Graphic User Interface, SIMATIC IT Alarm Manager Display, SIMATIC IT Historian Data Display) is currently running, you will be asked whether to interrupt the application or not.

1.3.9

Removing a Zone
To remove a Zone: 1. Select the tab in SIMATIC IT Management Console. .

2. Select command Edit > Delete

3. The message Do you really want to delete it ? appears. 4. Click Yes. The icon of the zone is removed from the window.

1.3.10

Starting the Zone Monitoring Environment

Select command Tools > Zone Monitoring Environment Console to enter the ZME supervisory environment. Or Select the Environment. Or Select the tab, expand the Zones folder and double-click a zone icon. tab, expand the Tools folder and double-click Zone Monitoring in SIMATIC IT Management

1.4
1.4.1

Working area
The Zone Monitoring Environment working area
Graph, Alarm and Data windows can be arranged in the Zone Monitoring Environment working area. Each window shows the files defined in the corresponding directories.

SIMATIC IT Services V4.4 SP2 User Manual

21

1.4.2

Displaying AMD, HDD and GUI windows

Three windows can be opened in the Zone Monitoring Environment working area: Alarm Files, Data Files, Graph Files. They correspond to the three object classes managed within a Zone, that is, alarms, historical points and graphic panels. When you enter the Zone Monitoring Environment all three windows are displayed by default.

To show or hide the AMD, HDD and GUI file windows: 1. Select command Options > Windows Setting in the Zone Monitoring Environment. 2. In the Window Setting dialog box check or uncheck the boxes of the file windows to be displayed in the working area: Graph Files Window Alarm File Window Data Files Window

3. Click OK.

1.4.3

Configuring the file display options

In the three Zone Monitoring Environment windows (Alarm Files, Data Files, Graph Files) you can display: all the file details (name, size, creation date and time) with command View > All File Details only the file name, with command View > Name only the files with a particular extension, with command View > By File Type

The list of files displayed in one or all of the windows can be refreshed run-time by selecting commands Refresh and Refresh All from the Window menu.

1.4.4

Arranging windows in the working area

The Alarm, Data and Graph windows can be minimized and arranged in the working area, starting from the left lower corner with command Window > Arrange Icons.

If the windows are maximized you can: tile them horizontally (command Window > Tile Horizontal). tile them vertically (command Window > Tile Vertical). arrange them one on top of the other (command Window > Cascade).

1.4.5

Saving the working area settings

The settings of the ZME working environment can be saved:

SIMATIC IT Services V4.4 SP2 User Manual

22

 as soon as configured (command Options > Save Settings Now) each time you quit the Zone Monitoring Environment (command Options > Save Settings on Exit)

1.5
1.5.1

Alarm Manager Display

Starting SIMATIC IT Alarm Manager Display from Zone Monitoring Environment
Click the icon on the Zone Monitoring Environment toolbar to gain access to the SIMATIC IT Alarm Manager Display environment. icon on the Zone Monitoring Environment toolbar to gain access to the Alarm Click the Acknowledge Services environment.

1.5.2

Creating an AMD file

To create an AMD file: 1. Select command File > New in the Zone Monitoring Environment.

2. In the New dialog box click the Alarm Viewer button. 3. Click OK. You access the SIMATIC IT Alarm Manager Display environment.

Tip For more information, see manual SIMATIC IT Alarm Manager and Alarm Manager Display: Users Guide.

1.5.3

Opening an ADD file

To open an ADD file: 1. Select command File > Open in the Zone Monitoring Environment.

2. In the Open dialog box select the directory where the files you want to open are stored. The following directories are available for SIMATIC IT Alarm Manager Display: \ALARM\USER contains active alarm, alarms to be acknowledged and workspace files. \ALARM\TEXT contains alarm configuration files.

3. Select the file from the File Name box. 4. Click OK.

Or

SIMATIC IT Services V4.4 SP2 User Manual

23

1. In the Alarm User Files window double click the name of the file you want to open. 2. According to the file type you selected you access the SIMATIC IT Alarm Manager Display, Alarm Acknowledge Services or Text Editor environments.

1.5.4

Configuring the connection to the Alarm Manager server

Each Alarm Manager Display or Alarm Acknowledge Service client can connect to one or more Alarm Manager servers and thus display the alarms generated by all the servers configured in the network. The server/s to which the clients must connect can be configured also in the Zone Monitoring Environment.

Important Before configuring the servers make sure that the SIMATIC IT Alarm Manager Display client and the SIMATIC IT Graphic User Interface module are not running within the default zone.

To configure the connection to the AM server: 1. Select command Configuration > Alarm Manager Connections Configuration in the Zone Monitoring Environment or Configuration > Alarm Manager > AMD Connections in SIMATIC IT Management Console; the Connections Configuration dialog box appears; 2. Select the pair of servers to which the clients must connect from the Computer Name 1 and Computer Name 2 list boxes: if the server selected from the Computer Name 1 list box is configured in hot backup, select the name of the corresponding slave server from the Computer Name 2 list box. if the server selected from the Computer Name 1 list box is NOT configured in hot backup, select (None) from the Computer Name 2 list box.

3. Click the Add>> button to add the selected server name to the Computer Name 1Computer Name 2 box. 4. Repeat steps from 2 to 3 to select other pairs of servers, if required. 5. Click OK.

1.6
1.6.1

Historian Data Display

Starting SIMATIC IT Historian Data Display from Zone Monitoring Environment
Click the button on the Zone Monitoring Environment toolbar to gain access to the SIMATIC IT Historian Data Display environment.

1.6.2

Creating a Historian Data Display file

To create a HDD file:
24

SIMATIC IT Services V4.4 SP2 User Manual

1. Select command File > New

in the Zone Monitoring Environment.

2. In the New dialog box click the Historical Trend button. 3. Click OK. You access the SIMATIC IT Historian Data Display environment. Tip For more information, see manual SIMATIC IT Plant Data Archive and Historical Data Display: Users Guide

1.6.3

Opening a Historian Data Display file

To open a HDD file: 1. Select command File > Open in the Zone Monitoring Environment.

2. In the Open dialog box select the directory where the files you want to open are stored. The following directories are available for SIMATIC IT Historian Data Display: \DATA\USER which contains the trend and workspace files. \DATA\TEXT which contains the process data configuration files.

3. Select the file from the File Name box. 4. Click OK

Or

1. In the Data User Files window double click the file name you want to open. 2. According to the file type you selected you access the SIMATIC IT Historian Data Display or Text Editor environments.

1.7
1.7.1

Working with Projects

The Project
PDE allows a programmer to organize his application programs into Projects. A Project is made up of all the source modules, compiled modules, libraries and databases that contribute to creating an application program: Therefore, if you want to use the programming environment, you must create a Project. A Project can be automatically created in the SIMATIC IT Management Console environment when you define a Unit and has the same name assigned to the Unit. The same Project can be associated to more than one Unit.

SIMATIC IT Management Console provides a your projects.

window from which you can manage

SIMATIC IT Services V4.4 SP2 User Manual

25

1.7.2

Creating a new Project

To create a new Project: 1. In SIMATIC IT Management Console, click the tab.

2. Right click the Projects folder and choose command New from the shortcut menu. 3. The New Project wizard is displayed. 4. Enter the name to be assigned to the project (maximum 8 characters) in the Project Name box. 5. Click OK. The icon of the Project is added to the project tree.

Tip For more information on the Project Development Environment, see manual Control Environment Programming Users Guide

1.7.3

Viewing the Projects

To view the Projects defined for the current Plant: 1. In SIMATIC IT Management Console, click the tab

2. Double click the Projects folders to expand the project tree. 3. The icons of all the projects defined for the current Plant are displayed.

You can click a project icon to launch the Project Development Environment and edit the project.

1.7.4

Removing a Project
To remove a Project from the project tree: 1. In SIMATIC IT Management Console, click the 2. Double click the Projects folder to expand the tree. 3. Right click a project and choose command Delete from the shortcut menu. 4. Click Yes to confirm the message Do you really want to delete it? 5. The icon of the Project is removed from the project tree. tab.

1.7.5

Renaming a Project
To assign a new name to an existing Project: 1. In SIMATIC IT Management Console, click the 2. Double click the Projects folder to expand the tree. tab.

SIMATIC IT Services V4.4 SP2 User Manual

26

3. Right click a project and choose command Rename from the shortcut menu or click the project name. 4. Type the new name, and then press ENTER.

1.7.6

Copying a Project
To copy a Project to the project tree: 1. In SIMATIC IT Management Console, click the 2. Double click the Projects folder to expand the tree. 3. Right click a project and choose command Copy from the shortcut menu. 4. The Copy Project wizard is displayed. 5. Enter the name to be assigned to the project (maximum 8 characters) in the Project Name box. 6. Click OK. The icon of the Project is added to the project tree. tab.

1.8
1.8.1

Programming environments
SIMATIC IT Programming Environments
SIMATIC IT provides three programming environments to help you satisfy all of the control and supervision requirements of a modern automation system: Control Programming Environment Supervisory Programming Environment API Environment

1.8.2

Control Programming Environment

PDE Project Development Environment is the programming environment specifically designed to develop control applications. It offers three proprietary programming languages (Iter, Ladder and Block Diagram) and the tools required to edit, compile and transfer programs to the P.M.C. controllers, where they will be executed. This environment can be also used with RTDS/IMC User Units in order to: simulate a virtual P.M.C. process data read from non-proprietary external devices

PDE manages projects. SIMATIC IT automatically associates a new or existing Project to each Unit configured in programming mode. Therefore any project defined in the PDE environment can be dynamically associated to various logical Units.
SIMATIC IT Services V4.4 SP2 User Manual 27

For more information on how to run the PDE environment from a CONTROL Unit, see Running PDE from a CONTROL Unit. For more information on how to run the PDE environment from an RTDS/IMC Unit, see Running PDE from an RTDS/IMC User Unit.

1.8.3

Configuring the programming mode of a Unit

From the Plant configuration environment (SIMATIC IT Management Console) you can define attributes of PDE, which will be applied each time you run PDE from a CONTROL or RTDS/IMC Unit. To configure the programming mode of a Unit: 1. Select command Configuration > System in SIMATIC IT Management Console. 2. Click the Plant Configuration tab in the System Configuration window. 3. Select one of the buttons related to the Variable Insertion Mode attribute:
Guided The program always reads the Points Database to check if the variables are defined and consistent. Warning messages are issued if incompatibilities are detected. The program does not check the variables for consistency. You can access the Points Database in read-only mode.

Not Guided

4. Click OK.

1.8.4

Running PDE from a CONTROL Unit

Important The Unit must be configured in programming mode. For more information, see Configuring a CONTROL Unit .

To run PDE from a CONTROL Unit: 1. Click the tab in the SIMATIC IT Management Console window. icon and choose command Unit > Programming Environment

2. Select the Control Unit

or Double click the Control Unit 3. Double click the Program or expand the Management Environment icon. icon to expand the unit tree. or Project icon

item and then double click the Project Development

SIMATIC IT Services V4.4 SP2 User Manual

28

The Project Development Environment is launched and the project previously associated to the Unit is opened.

Tip For more information on the Project Development Environment, see manual Control Environment Programming Users Guide

1.8.5

Running PDE from an RTDS/IMC User Unit

Important The Unit must be configured in programming mode. For more information, see Configuring an RTDS/IMC User Unit.

To run PDE from a RTDS/IMC User Unit: 1. Click the tab in the SIMATIC IT Management Console window. icon and choose command Unit > Programming Environment

2. Select the RTDS Unit

or Double click the RTDS Unit 3. Double click the Program or expand the Management icon to expand the unit tree. or Project icon icon.

item and then the Project Development Environment

The Project Development Environment is launched and the project previously associated to the Unit is opened.

Tip For more information on the Project Development Environment, see manual Control Environment Programming Users Guide.

Note When you activate PDE to manage a project associated with an RTDS/IMC Unit, the SIMATIC IT Real Time Data Server and-IMC modules must also be running. These modules handle the SIMATIC IT Real Time Data Server memory area and process data stored in this area, respectively.

1.8.6

Running PDE from a Project

PDE handles Projects. SIMATIC IT Management Console and Historian automatically assigns a project to each Unit configured in programming mode. The project can be new or already exist. To run PDE from a Project: 1. In SIMATIC IT Management Console, click the tab

SIMATIC IT Services V4.4 SP2 User Manual

29

2. Double click the Projects folders to expand the project tree. 3. Double click a project 4. If the project is not currently associated with any Unit, you will be prompted to choose a Unit to which the project will be assigned. 5. The Project Development Environment is launched and the project is opened.

Tip For more information on the Project Development Environment, see manual Control Environment Programming Users Guide

1.8.7

Data manipulation and aggregation

SIMATIC IT Real Time Data Engine Manager is a powerful data-processing engine designed to satisfy calculation needs related to monitoring and supervision. This module allows you to execute sophisticated processing on data read from any external device, and then makes them available to the supervision tools. Real Time Data Engine Manager simplifies the management of calculated variables, triggers, alarm processing and various other kinds of data.

You can run the Real Time Data Engine Manager environment from a Real Time Data Engine User Unit.

1.8.8

Starting the SIMATIC IT Real Time Data Engine Manager

To start SIMATIC IT Real Time Data Engine Manager: 1. In SIMATIC IT Management Console, click the 2. Select a RTDEM Unit. tab.

3. Select command Unit > Real Time Data Engine > Start Real Time Data Engine. or Expand the Unit tree, then expand the Management item and double click the SIMATIC icon. IT Real Time Data Engine Manager

Important To execute the tasks created in the SIMATIC IT Real Time Data Engine Manager environment, you must start the run-time engine with command Unit > Real Time Data Engine > Start Real Time Data Engine in SIMATIC IT Management Console.

Tip For more information on the SIMATIC IT Real Time Data Engine Manager environment, see the manual Supervisory Environment Programming User's Guide.

SIMATIC IT Services V4.4 SP2 User Manual

30

1.8.9

API Environment
The Application Programming Interface (API) provides the software libraries, the tools and documentation required to develop programs to be integrated into the SIMATIC IT environment, which perform custom functions, supply new communications interfaces with PCs and field devices or even replace standard SIMATIC IT components with custom modules in order to meet specific requirements. Programs can be created using high-level languages such as C and C++, which support the Cstandard conventions for calling routines.

APIs are supplied for the following environments: System Enabler (data management) Alarms Management Historical Trends Management

Tip For more information, see the manual Application Programming Interface Users Guide.

1.8.10

Configuring IMC
IMC is a virtual controller which acquires data, reading it from the SIMATIC IT Real Time Data Server memory area managed by SIMATIC IT Real Time Data Server, processes it and generates output values which will be written to the same memory area.

To configure IMC: 1. In SIMATIC IT Management Console, click the 2. Select an RTDS Unit. tab.

3. Select command Unit > Integral Multifunction Controller > IMC Configuration or Expand the Unit tree, then expand the Management item and double click the IMC Configuration icon. 4. In the IMC Configuration dialog box enter the controller cycle time (in milliseconds) in the Tick box. This value cannot be less than 500 ms. 5. In the Start Mode area select the IMC start-up attribute:
Run Stop IMC executes the last program transmitted IMC does not execute any program

6. Click OK.

1.8.11

Starting IMC
To start IMC:

SIMATIC IT Services V4.4 SP2 User Manual

31

1. In SIMATIC IT Management Console, click the 2. Select the icon of the RTDS/IMC Unit

tab.

you want to use.

3. Select command Unit > Integral Multifunction Controller > Start IMC. 4. The IMC module is started.

Important This command is enabled only if you have selected an RTDS/IMC Unit and if the computer name assigned to the logical Unit is the same as the current workstation name.

IMC has no user interface. To check if IMC is running (two IMC instances cannot be started concurrently on the same workstation) view the Management Console Tasklist in the System Toolbox. For more information, see Management Console Tasklist.

1.8.12

Debugging a program
To start the ODS Operation Debugging Support module for the application program associated with the selected Unit: Select command Unit > Operation Debugging Support Console or In the window, double click a Unit, then expand the Management icon. double click the Debug item and in SIMATIC IT Management

ODS is the tool offered by SIMATIC IT to debug and correct the application programs created in the PDE or SIMATIC IT Real Time Data Engine programming environments. With ODS you can view the values of all the variables used by a program while the program is running, apply a different display format to each variable and change its value in run-time.

Tip For more information, see manuals Control Environment Programming Users Guide and Supervisory Environment Programming Users Guide.

1.8.13

Dumping/restoring a control panel

The Dump/Restore Control Panel utility allows you to save the contents of some P.M.C. datastorage registers on a file and, if necessary, to restore the saved data. To launch this utility, do as follows: 1. Click the tab in SIMATIC IT Management Console. or RTDS Unit, expand the tree and double click the Management

2. Select a CONTROL item.

SIMATIC IT Services V4.4 SP2 User Manual

32

3. Double click the Dump

icon.

Tip For more information, see manual Control Environment Programming User's Guide.

1.8.14

Transmitting a program to the controller

To transmit a program to the P.M.C. or virtual controller CPU: Select command Unit > Transmission Control Panel Console. or In the Management window, double click an RTDS or P.M.C. item and double click the Transmit icon. Unit, then expand the in SIMATIC IT Management

Tip For more information, see manual Control Environment Programming Users Guide.

1.9
1.9.1

Graphic User Interface

Starting SIMATIC IT Graphic User Interface from Zone Monitoring Environment
Click the icon on the Zone Monitoring Environment toolbar to have access to the SIMATIC IT Graphic User Interface Development environment, where you can: Create a graphic panel Open a graphic panel Compile a graphic panel Compile multiple graphic panels Also, you can configure some default attributes of SIMATIC IT GUI Development from the Zone Monitoring Environment.

1.9.2

Creating a graphic panel

To create a graphic panel: 1. Select command File > New in Zone Monitoring Environment.
33

SIMATIC IT Services V4.4 SP2 User Manual

2. In the New dialog box select the Graphic Panel button. 3. Click OK to access the SIMATIC IT Graphic User Interface Development environment.

Tip For more information on creating graphic panels, see manual SIMATIC IT Graphic User Interface: Users Guide.

1.9.3

Opening a graphic panel

To open a graphic panel: 1. Select command File > Open in Zone Monitoring Environment.

2. In the Open dialog box select the directory where the files you want to open are stored. The following directories are available for SIMATIC IT Graphic User Interface: \GRAPH\SOURCES which contains graphic source files (.grs) \GRAPH\TEXT which contains text files used by SIMATIC IT Graphic User Interface \GRAPH\LIB which contains graphic object libraries.

3. Select the file from the File Name box. 4. Click OK.

Or In the Graph Source Files window, double click the name of the file you want to open.

In either case you have access to the SIMATIC IT Graphic User Interface Development environment.

1.9.4

Compiling a graphic panel

Select command File > Compile in Zone Monitoring Environment to start the graphic panel compiler for the selected file.

The compiler optimizes the instructions inserted in the file, verifies the attributes assigned to the objects and checks if the points assigned to the objects are defined in the Unit database.

When you start the compiler, the SIMATIC IT Graphic User Interface environment displays a dialog box with the compilation percentage and then the Compiling Report box with the compilation results, the error and warning messages.

1.9.5

Compiling multiple graphic panels

To compile more than one graphic panel at a time you must create a file with .grm extension which contains the names of the source files to be compiled.

SIMATIC IT Services V4.4 SP2 User Manual

34

To create a .grm file: 1. Select the Build command from the Tools menu in Zone Monitoring Environment. The Build dialog box appears. 2. Select the source files to be added to the .grm file from the Graphic Panels list box. 3. Click the Add button. The selected files are automatically added to the Build Modules list box. Click Remove to remove one or more files from the list. 4. Enter the name of the .grm file in the Build File box.

To compile multiple graphic panels: 1. Select the .grm file from the Graph Source Files window in Zone Monitoring Environment. 2. Select the Compile command from the File menu.

Tip For more information, see manual SIMATIC IT Graphic User Interface: Users Guide.

1.9.6

Configuring SIMATIC IT Graphic User Interface Development

Some default attributes of the SIMATIC IT Graphic User Interface Development Environment can be configured in the Zone Monitoring Environment. These attributes include: Defining the SIMATIC IT Graphic User Interface page configuration Configuring Dynamic Link Libraries (DLLs) Showing/hiding the grid Enabling/disabling the snap Configuring the source files backup

1.9.7

Showing/hiding the grid and defining the step

To show/hide the grid and define the step: 1. Select command Configuration > GUI Development Configuration in the Zone Monitoring Environment. The Development Configuration dialog box appears. 2. In the Grid area, check or uncheck the On box to show or hide the grid respectively. 3. Enter the distance between the grid points in the Step X and Step Y boxes.

Important The distance between the intersection points of the horizontal and vertical axes of the grid must be between 10 and 50 pixels.

Tip For more information, see manual SIMATIC IT Graphic User Interface: Users Guide.
35

SIMATIC IT Services V4.4 SP2 User Manual

1.9.8

Enabling/disabling the snap and defining the step

To enable/disable the snap and define the step: 1. Select command Configuration > GUI Development Configuration in Zone Monitoring Environment. The Development Configuration dialog box appears. 2. In the Snap area, check or uncheck the On box to enable or disable the snap respectively. 3. Enter the cursor step in the Step X and Step Y boxes. You can choose different values for the horizontal and vertical axis.

Important The step value on either axis of the grid must be between 2 and 50 pixels.

Tip For more information, see manual SIMATIC IT Graphic User Interface: Users Guide.

1.9.9

Defining the SIMATIC IT Graphic User Interface page configuration

When defining the GUI page configuration, you can perform the following settings: Define the maximum number of objects and points Establish the maximum number of displayable panels Lock objects in the panel Log all operator actions by default

1.9.10

Defining the maximum number of objects and points

You can modify the number of objects and points that can be inserted into a graphic panel. The maximum limit has been set at 10,000 objects and 5,000 points. Only users with the MANAGER access level can modify these limits.

To define the maximum number of objects and points: 1. Select the command Configuration > GUI Development Configuration in Zone Monitoring Environment. The Development Configuration dialog box appears. 2. In the Limits area enter the maximum number of Objects and Points that can be configured in a graphic panel.

Important The default values (1024 objects and 512 points) represent the recommended maximum limits for each graphic panel.

Tip For more information, see manual SIMATIC IT Graphic User Interface: Users Guide.

SIMATIC IT Services V4.4 SP2 User Manual

36

1.9.11

Defining the maximum number of graphic panels that can be displayed at the same time
To define the maximum number of graphic panels that can be displayed simultaneously: 1. Select command Configuration > GUI Development Configuration in Zone Monitoring Environment. The Development Configuration dialog box appears. 2. In the Max no. simult. displayed panels box , enter the maximum number of graphic panels that you intend to display at the same time (max. 8). 3. Click OK.

Tip For more information, see manual SIMATIC IT Graphic User Interface: Users Guide.

1.9.12

Locking objects in the panel

To lock objects in the panel: 1. Select command Configuration > GUI Development Configuration in Zone Monitoring Environment. The Development Configuration dialog box appears. 2. Select the Out of video objects check box to prevent objects from being dragged outside the workspace. 3. Click OK.

Tip For more information, see manual SIMATIC IT Graphic User Interface: Users Guide.

1.9.13

Logging all operator actions by default

To log all operator actions by default: 1. Select command Configuration > GUI Development Configuration in Zone Monitoring Environment. The Development Configuration dialog box appears. 2. Select the Log by default check box to log all operator actions by default. 3. Click OK. You can also choose whether to log the operator actions for each individual button. For more information, see the SIMATIC IT Graphic User Interface documentation.

SIMATIC IT Services V4.4 SP2 User Manual

37

1.9.14

Configuring Dynamic Link Libraries (DLLs)

Dynamic Link Libraries (DLLs) contain custom procedures created by the user to meet specific requirements. These files must be copied into the system directory (by default \ICUBESYS\BIN) and then configured, before being called with an appropriate button ("DLL Interface") from a graphic panel.

To configure DLLs: 1. Select command Configuration > GUI Development Configuration in Zone Monitoring Environment. The Development Configuration dialog box appears. 2. In the DLL area enter the name of the DLL file in the DLL Name box. 3. Click the Add >> button to add the file name to the list box. Click << Remove to remove DLLs you no longer need from the list.

Tip For more information, see manual SIMATIC IT Graphic User Interface: Users Guide.

1.9.15

Configuring the source files backup

To create a backup copy (.bak extension) of the graphic panel each time you save it: 1. Select command Configuration > GUI Development Configuration in Zone Monitoring Environment. The Development Configuration dialog box appears. 2. In the Panel area, check the File .Bak box.

1.10
1.10.1

Miscellaneous elements of SIMATIC IT Services

System Toolbox
By default, SIMATIC IT Management Console displays the System Toolbox toolbar upon SIMATIC IT Management Console startup. However, you can disable this option setting the startup parameters.

The System Toolbox is always displayed on top of all other applications.

You can disable this toolbar whenever you want by choosing command Services > System Toolbox in SIMATIC IT Management Console or by clicking the tab in SIMATIC IT Management Console, expanding the System folder and double-clicking System Toolbox.

The System Toolbox consists of a title bar, on which the System Toolbox label and the system time appear, and a toolbar with several buttons: each button is associated with one of the SIMATIC IT components and appears only if the related application is running. All buttons operate in toggle mode: if the application is currently minimized, you switch to the application
SIMATIC IT Services V4.4 SP2 User Manual 38

and the application window will be maximized; if the application is currently maximized, it will be minimized. By default, the System Toolbox shows the following three buttons. Those which refer to the other applications are inserted in run time.

: Click this button to switch to SIMATIC IT Management Console. : Click this button to view the Management Console Tasklist that displays all SIMATIC IT applications currently running on your workstation. : Click this button to view the SIMATIC IT Management Console Online Help.

1.10.2

Enabling the System Toolbox at startup

To enable the System Toolbox at start-up: 1. Enter the System Configuration window. 2. Select the Start Up tab. 3. Select the System Toolbox check box. 4. Click OK.

With this option, when you start SIMATIC IT Management Console and log on to a Plant, the System Toolbox toolbar is loaded.

1.10.3

Management Console Tasklist

To display the Management Console Tasklist dialog box, click the button on the System Toolbox bar or on the main toolbar in SIMATIC IT Management Console.

The Management Console Task List tab lists all the SIMATIC IT applications currently running on your workstation. Within the Management Console Task List tab, you can perform the following operations:
To select an active application and switch to it terminate an application add a new task to the applications list (reserved for future use) display SIMATIC IT applications running on another workstation, configured on SIMATIC IT Network Configuration Action Choose the application name from the list and click the Switch To button. Choose the application name from the list and click the End Task button. Enter any valid command in the New Task box and click the Run button. (reserved for future use) Choose a name from the Computer Name list box.

refresh the list of SIMATIC IT applications currently Click the Refresh button. running on your workstation or (reserved for future use) the workstation you are connected to

Important
39

SIMATIC IT Services V4.4 SP2 User Manual

The End Task button is enabled only for SIMATIC IT applications with no user interface (e.g. IMCRTDS, PDA, AM, ...) or for OLE server modules, such as AMD and HDD. All other applications must be terminated using the appropriate command on their menu bar.

(Reserved for future use) The Remote Control tab shows the computer name of the workstation to which the current workstation is connected in the Currently connected to area. Within the Remote Control tab, you can perform the following operations:
Click Logoff <-Logon Shutdown Refresh To Log off from the Plant to which the current workstation is connected. Log on to a Plant. Close all programming systems. Refresh the list of SIMATIC IT applications currently running on the workstation you are connected to.

1.10.4

System Information
If you select command Help > System Information in SIMATIC IT Management Console the System Information dialog box containing information related to your SIMATIC IT workstation appears. By clicking the Miscellaneous tab, the following information is displayed:

In the Management Console Information area: Key Serial Number

Description Serial number and type of the hardware key installed on the workstation. For more information on how to install the hardware key see Installing the Protection Key Node number of the Arcnet network adapter. This data is available only if your workstation is connected to an Arcnet network. For more information, see Monitoring network nodes. Computer name of the workstation, defined during Windows installation. YES indicates that SIMATIC IT Management Console stand-alone startup has been configured. For more information, see Enabling SIMATIC IT stand-alone start-up . Computer name of the workstation where the Plant is located and to which the current workstation is connected. Computer name of the workstation to which the current workstation is connected.

Arcnet Node Number

Computer Name Stand Alone

Plant resides on Currently Connected to

In the Memory Status area: Description Physical Memory Installed The physical memory installed on your computer. Physical Memory Available The physical memory not yet used. Total Virtual Memory The space on your hard disk that Windows uses as if it were actually memory. The benefit of using virtual memory is that you can run more applications at one time than your systems physical memory would otherwise allow.

You can click the Check Management Console files button to display the list of files which are not matching the installation. This table shows files contained in the Bin directory, before and
SIMATIC IT Services V4.4 SP2 User Manual 40

after installation of a new program version. The size (in bytes) and installation date/time for each file are displayed. For the files not present in the updated version the string missing is displayed.

By clicking the Hardware tab, the following information is displayed:

In the System Hardware Information area: Processor Number of processors Processor architecture Processor Speed Active processor mask Processor level Processor revision Description Specifies the processor name. Specifies the number of processors present on your computer. Specifies the type of processor. Specifies the processor speed (in megahertz). Specifies a mask representing the set of processors configured into the system. Bit 0 is processor 0; bit 31 is processor 31. Specifies the systems architecture-dependent processor level. Specifies the processor revision.

Minimum application address Pointer to the lowest memory address accessible to applications and dynamic-link libraries (DLLs). Maximum application address OEM id Page size CPU Manufacturer Pointer to the highest memory address accessible to applications and dynamic-link libraries (DLLs). Specifies the Original Equipment Manufacturer Id. Specifies the page size and the granularity of page protection and commitment. Specifies the CPU manufacturer name.

1.11
1.11.1

User Management
Logging on to SIMATIC IT
From SIMATIC IT Management Console you can log on to all components making up the SIMATIC IT suite. When you start SIMATIC IT Management Console for the very first time, the system logs you on as DEFAULT user, with very limited rights.

To appropriately start and configure your system, you must: Switch to full-authorization mode by pressing the SHITF+ESC keys and entering the predefined username MANAGER (no password). Define the appropriate user profiles and the related rights Log on with a user other than default

SIMATIC IT Services V4.4 SP2 User Manual

41

1.11.2

Configuring automatic logoff

Procedure
1. Select the File > New > User command in the User Manager environment; or select a

command (or user in the User Manager - User View and then select the Edit > Modify right-click and select the Modify command from the shortcut menu ), the New User or Modify user dialog boxes are displayed, respectively. 2. Click the Advanced button: the Advanced dialog box is displayed. 3. Click the Timeout check box in the Automatic Logoff area. 4. Enter the number of minutes (1-1440) after which the system will automatically logoff the user in the Minutes edit box or select a value clicking the spin button. 5. To notify the user before logging off, click the Confirm before logoff check box. 6. Click the Apply button to exit the Advanced dialog box. Note When this option is selected, the system automatically logs off any user that has been connected to SIMATIC IT Management Console longer than the configured time interval.

1.11.3

Predefined logon users

SIMATIC IT Services come with two pre-defined users:
Username Default Password none Authorizations Only start the SIMATIC IT Plant Management and Management Console environments and view graphic panels. All administrative rights.

Manager

none

From the User Management tool you can then define additional user groups and profiles and assign them the appropriate rights.

1.11.4

Defining the automatic logon user

When you start SIMATIC IT, the system logs on automatically using the system user Default (password RETURN), if no other information is available. However, you can configure the name and password of the user that must be used for automatic logon, as follows:

1. Enter the System Configuration window. 2. Select the Workstation tab. 3. Select the Automatic User Logon checkbox. 4. Enter the username in the User edit box. This name must already have been defined as a SIMATIC IT user or must be one of the pre-defined users (Manager or Operator). 5. Enter, if required, the password that uniquely identifies the user in the Password edit box. Characters are replaced with stars as you type.
42

SIMATIC IT Services V4.4 SP2 User Manual

The user you have just defined will be available the next time you log on to SIMATIC IT Management Console.

Important If you do not select the Automatic Logon option, the system will always log on to SIMATIC IT Management Console with the Default user.

1.11.5

Logging on to SIMATIC IT with a user other than "Default"

If you have not configured a user to be used for automatic logon, the system logs on to SIMATIC IT Management Console with the Default username (password RETURN), which has access rights to limited resources.

To log on with a user other than the default, do as follows: 1. Press the SHIFT+ESC keys; the User Logon dialog box appears. 2. Insert the user name and password in the User and Password edit boxes respectively; 3. Click the OK button to log on.

1.11.6

Modifying the user password

Important You must configure an appropriate option, in order for a user to be allowed to change his/her password. However, the MANAGER user can always change his password, regardless of his configuration

Procedure
1. Press the SHIFT+ESC keys; the User Logon dialog box opens. 2. Enter the user name in the User edit box. 3. Click the Change button; the Change Password dialog box opens. 4. Enter the new password in the Password edit box and then type it again in the Confirm Password edit box to check that the previously entered string is correct. Characters are replaced with stars as you type. 5. Click the OK button.

1.11.7

Allowing user password modification

By default, only the Manager user can always change his password, regardless of his configuration.

SIMATIC IT Services V4.4 SP2 User Manual

43

Other users must be appropriately configured in order for them to be allowed to modify their password:

Procedure
1. Enter the User Management environment (command Tools > User Manager). 2. Create a new user (command Edit > New > User Edit >Modify ) or modify an existing user (command

or right click the user name and select Modify on the shortcut menu).

3. In the Account Settings area, select the User can change password check box.

If a user is not allowed to change his/her password, the Change button in the User Logon dialog box (SHIFT+ESC) is disabled.

1.11.8

Configuring the password expiry date

Procedure
1. Select the File > New > User command in the User Manager environment; or select a

command (or double click the user in the User View and then select the Edit > Modify user name or right-click and select the Modify command on the shortcut menu ), the New User or Modify user dialog boxes are displayed, respectively. 2. Click the Advanced button: the Advanced dialog box opens. 3. In the Temporal Expiration area, select the Password expires in check box. 4. Enter the number of days (0-34463) after which the password is no longer valid in the Days edit box or select a number by clicking the spin button. 5. If you want to be advised before the password expires, click the Waiting before check box and then enter the number of days in the Days edit box or select a number by clicking the spin button. 6. Click the Apply button to exit the Advanced dialog box.

1.12
1.12.1

User Manager tool

Overview of User Manager
The User Manager is a tool provided by SIMATIC IT Services to manage users and groups within the SIMATIC IT environment. The user can access the User Manager environment simply by selecting the Tools > User Manager command in the Plant Management or in SIMATIC IT Management Console.

The User Manager environment contains three different views:

SIMATIC IT Services V4.4 SP2 User Manual

44

 User View, displaying existing users (View >Show > Users

command). command). command).

Group View, displaying existing groups (View > Show > Groups Scenario View, displaying existing groups (View > Show > Scenario

Important It is necessary to save changes by selecting the File > Save before quitting the User Manager environment. command

All changes made and operations performed within the User Manager environment (e.g. defining, modifying, deleting users groups and scenarios, as well as policy account settings) are traced as Audit Trail records. These records can be viewed by selecting the View > Show > Audit Trail Viewer menu command or by clicking the toolbar. Audit Trail Viewer button on the

1.12.2

Filtering the contents

In the User Manager environment (command Tools > User Manager from Plant Management or from SIMATIC IT Management Console) it is possible to set the filter criteria when searching for an item contained within the columns. This way, you can see only the items that match the search criteria. In the Groups View, this dialog box is composed of two columns: Group Name and Description. In the Users View, this dialog box is composed of three columns: User Name, Full Name and Groups. In the Scenario View, this dialog box is composed of three columns: Scenario Name, Description and Members.

Procedure
1. Select the cell under the column that you wish to set the filter on. 2. Type the search criteria. The word can be typed completely or in part (either the first few letters or by using an asterisk) 3. To see the search result, press Enter, select the button on the right side of the cell simply wait a few seconds. 4. The search results will be shown in the cells below. , or

SIMATIC IT Services V4.4 SP2 User Manual

45

1.13
1.13.1

Working with groups

Groups
SIMATIC IT Services control access to the diverse functions offered by the system through groups, to which specific resources are assigned. A group has specific access rights to the SIMATIC IT system. SIMATIC IT Services provide the User Manager tool for the management of groups.

The following default groups are available: Administrators Developer High Level Operator Low Level Operator Maintenance Operator

1.13.2

Resources of the Administrators group

By default the Administrators group has been assigned all the resources available and it is not possible to modify or remove the resources. However, if you select the Only administration rights for Administrator Group option in the Policy Account dialog box (Menu Edit> Policy Account), the only resource associated with the Administrators group will be access to administrative tools, bearing the Selected area of the General tab in the Modify group dialog box. symbol in the

Note It is not possible to remove this resource, but you can add or remove other resources according to your preferences.

1.13.3

Resources of the Developer group

By default the Developer group has been assigned the resources listed below. However you can update this group if you belong to the Administrators group (e.g. if you are the Manager user).

Access to Operating System Shell Alarm Configuration Load Graphic Panels Edit DB, User Libraries, Projects Historical Trends Configuration Modify Configurations (without Saving) PMC Operations Program Transmission Run Historical Trends Run Applications from GUI Browse Source Files

System Configuration Enable GUI Menu Bar Hardware Configuration Modify and Save Configurations Modify, Save, Compile Source Files Print from Graphics, Alarm, Historical Environments Run Alarms Run ODS Set Variables from GUI Set Variables from Ladder, Block Diagram, ODS

SIMATIC IT Services V4.4 SP2 User Manual

46

1.13.4

Resources of the High Level Operator group

By default the High Level Operator group has been assigned the resources listed below. However you can update this group if you belong to the Administrators group (e.g. if you are the Manager user).

Load Graphic Panels Run Alarms Run ODS Set Variables from Ladder, Block Diagram, ODS

Modify Configurations (without Saving) Run Historical Trends Set Variables from GUI

1.13.5

Resources of the Low Level Operator group

By default the Low Level Operator group has been assigned the resources listed below. However you can update this group if you belong to the Administrators group (e.g. if you are the Manager user). Load Graphic Panels Run Historical Trends Run Alarms

1.13.6

Resources of the Maintenance Operator group

By default the Maintenance Operator group has been assigned the resources listed below. However you can update this group if you belong to the Administrators group (e.g. if you are the Manager user).

Enable GUI Menu Bar Modify Configurations (without Saving) Print from Graphics, Alarm, Historical Environments Run Alarms Run Historical Trends Set Variables from GUI Browse Source Files

Hardware Configuration PMC Operations Program Transmission Load Graphic Panels Run ODS Set Variables from Ladder, Block Diagram, ODS

1.13.7

Creating a group
You can create a new group only if your user name has been associated to the Administrators group (or to an equivalent group owning the Access to Administrative Tools resource).

SIMATIC IT Services V4.4 SP2 User Manual

47

Procedure
1. Start the User Manager tool by selecting the Tools > User Manager Management or in SIMATIC IT Management Console. command in Plant

2. Select the File > New > Group command or click the New Group button on the toolbar. The New Group dialog box opens. 3. Enter the name of the new group (an alphanumerical string up to 15 characters) in the Group Name edit box. 4. Select the system resources of the new group from the System Resources list box, and then click the Add> button. 5. Click the Local Resources tab to assign local resources to the new group. 6. Click the OK button to confirm this operation.

In addition to defining a new group from scratch you can create a new group using the definition of an existing group, by selecting a group and then the Edit > Copy command. (or by rightclicking and selecting the Copy command from the displayed shortcut menu ). The Copy Group dialog box opens: you are prompted to enter a new group name and then you can modify all group configuration parameters.

1.13.8

Removing a group

Procedure
1. In the User Manager - Group View environment (command Tools > User Manager Plant Management or SIMATIC IT Management Console) select the group of interest. 2. Select command Edit > Delete , or right-click and select the Delete command on the shortcut menu , or press the DEL key. 3. Click the Yes button to confirm this operation. in

1.13.9

Displaying the groups of a user

Procedure
1. In the User Manager - User View environment (command Tools > User Manager Plant Management or SIMATIC IT Management Console) select the user of interest. in

or double-click the user name or right-click and select 2. Select command Edit > Modify the Modify command on the shortcut menu . 3. The Modify user dialog box opens. Select the Group membership tab: the groups associated with the current user are displayed in the Selected Groups list box.

SIMATIC IT Services V4.4 SP2 User Manual

48

1.14
1.14.1

Working with users

Defining a user
You can define a new user only if your user name has been associated to the Administrators group (or to an equivalent group owning the Access to Administrative Tools resource).

Procedure
1. Select the Tools > User Manager command in Plant Management or SIMATIC IT Management Console to start the User Manager environment. 2. Select command File > New > User ; the New User dialog box is displayed.

3. Enter the user name In the User Name edit box. By default, the name proposed by User Manager is composed of 3 alphabetical characters, the pound sign and a progressive number (e.g. USR#21). However, the user can modify the name. 4. (Optional) Enter a comment in the Full Name edit box (User Manager-User View dialog box) or the Description edit box (User Manager-Group View dialog box). 5. Operating in the Account Settings area, if required, enter the password in the Password edit box. Characters are replaced with stars as you type. 6. Enter the password again in the Confirm Password edit box to check if the previously entered string is correct.

Important Remember that it is possible to block the user by setting the dedicated parameters. For more information on how to lock a user, see Locking a user.

You can then select one or more optional parameters related to: Changing the password at the following logon (expiry date, updating,. . . ) The user account The possibility for the user to change his/her password The possibility of unlocking a locked user Associating a user to a group

In addition to defining a new user from scratch you can create a new user using the definition of command (or by an existing user, by selecting an existing user and then the Edit > Copy right-clicking and selecting the Copy command on the shortcut menu ). The Copy User dialog box is displayed: you are prompted to enter a new user name and then you can modify all configuration parameters.

SIMATIC IT Services V4.4 SP2 User Manual

49

1.14.2

Modifying the properties of a user

Procedure
1. In the User Manager - User View environment (command Tools > User Manager Plant Management or SIMATIC IT Management Console) select the user of interest. in

, or double-click the user name, or right-click and select 2. Select command Edit > Modify the Modify command on the shortcut menu ; the Modify User dialog box opens and displays the properties of the current user. 3. Update the parameters of interest. 4. Click the OK button.

1.14.3

Removing a user

Procedure
1. In the User Manager-User View environment (command Tools > User Manager in Plant Management or SIMATIC IT Management Console), select the user of interest. 2. Select command Edit > Delete , or right-click and select the Delete command on the shortcut menu or press the DEL key. 3. Click the Yes button to confirm this operation.

1.14.4

Associating a user to a group

Each new user must be associated to a group in order to perform any operation in the SIMATIC IT environment.

Procedure
1. Select command File > New > User in the User Manager environment or select a user

command (or rightin the User Manager - User View and then select the Edit > Modify click and select the Modify command from the shortcut menu ); the New User or Modify user dialog boxes are displayed, respectively. 2. Select the Group membership tab. 3. Select a group from the Available Groups list box and then click the Add> button. The group name is moved to the Selected Groups list box. 4. Click the Resources button to display the resources assigned to the selected group. The Resources dialog box opens and displays all resources and related access levels available to the user.

Important Each user can be associated to more than one group

SIMATIC IT Services V4.4 SP2 User Manual

50

1.14.5

Associating a user to a different group

Procedure
1. In the User Manager - User View environment (command Tools > User Manager Plant Management or SIMATIC IT Management Console), select the user of interest. in

, or double-click the user name, or right-click and select 2. Select command Edit > Modify the Modify command on the shortcut menu . 3. The Modify user dialog box opens. Select the Group membership tab: the groups associated with the current user are displayed. 4. If necessary, select the old group from the Selected Groups list box and click the <Remove button. 5. Select the new group to which the user is to be associated from the Available Groups list box. 6. Click the Add> button to move the group to the Selected Groups list box. 7. Click the OK button to confirm this operation.

1.14.6

Locking a user
This option allows you to block a user. This way, if a user inserts the wrong password several times, User Manager will block the entrance into the environment. To block a user, select the Lock User Account check box in the Policy Account dialog box. Once a user is blocked, the associated icon in the User Manager-User View environment will be displayed with a red line through it , indicating that this user has been disabled.

To unlock the user, select the disabled user icon in the User Manager-User View dialog box and then select the User > Modify command. In the Modify User dialog box , clear the User Locked check box. The user will be re-enabled and will therefore be able to access SIMATIC IT.

1.14.7

Rules for defining user-account options

Select command Edit > Policy Account in the User Manager-User View environment, the Policy Account dialog box opens

If Check user name uniqueness

Is Selected

Then User Manager suggests a default name for each new user, composed of three alphabetical characters, the pound sign and a progressive number (e.g. USR #21). But it is also possible to insert a different name, if never used before. It is possible to rename the old user names by following the same criteria of the user name automatically created by User Manager. It is also possible to copy the new user names in the Full Name cells by overwriting the old ones.

Cleared

User Manager will suggest this name but the user can choose whether to k it h it l t l dif it i t
51

SIMATIC IT Services V4.4 SP2 User Manual

keep it, change it completely or modify it in part.

Only Administration rights for Administrator Group

Selected

The only resource associated to the Administrator Group will be access to administrative tools and it is not possible to add or remove it. Instead it is possible to add or remove the local resources on the Local Resources tab. The Administrator Group behaves like the other groups.

Cleared

Password Generation area

Selected

The old password (if a password has been modified by a user) will be locked for this user only (i.e. it will not be able to be used) for a pre-defined time period.

Lock User Account area Selected

This option sets how many times the user can insert the wrong password before being disabled. Click the Invalid Logon Attempts spin button to set how many times you can insert the wrong password (up to 10). There is no limit to wrong entries; the user will always remain enabled.

Cleared

Password Constraints area

Selected

The area below is enabled and it is possible to define the password setting rules. These rules will be enabled from that moment on. As such, old passwords will continue to be valid, but if the user creates a new password or modifies an old password, he/she will have to respect the password setting rules. The area below is disabled

Cleared

Once the password and the user generation parameters are set, select the OK button to accept them and exit the dialog box.

1.14.8

Disabling a user account

Procedure
1. Select command File > New > User user and then select the Edit > Modify command on the shortcut menu ). from the User Manager environment or choose a command (or right-click and select the Modify

2. In the New User / Modify User dialog box that opens, select the Account not enabled check box. 3. Click the OK button to exit the dialog box.

This option can be used to temporarily disable a users access to the system. To re-enable the users access, select command Edit > Modify in the User Manager environment and clear the option by clicking the Account not enabled check box in the Modify User dialog box.

SIMATIC IT Services V4.4 SP2 User Manual

52

1.14.9

Displaying the users associated with a group

Procedure
1. In the User Manager - Group View environment (command Tools > User Manager Plant Management or SIMATIC IT Management Console) select the group of interest. 2. Either select command Edit > Modify command on the shortcut menu . in

or right-click on the group and select the Modify

3. The Modify group dialog box opens. Click the Users button. 4. The Users dialog box opens, displaying a list of the users associated to the group.

1.15
1.15.1

Working with access levels

Access levels
Access levels allow you to perform a further control on the access to SIMATIC IT functions. Actually, you can assign the same resource, configured with different access levels, to more groups and thus limit the access to specific functions managed by the same resource.

SIMATIC IT Management Console provides 30 access levels (from 1 to 30) that can be configured as: Hierarchical (default) Exclusive

and can be assigned to each resource associated with a group.

At present you can define an Exclusive access level only for the resources listed below: Load Graphic Panels Run SIMATIC IT Applications from GUI Set Variables from GUI Set Variables from Ladder, Block Diagram, ODS

1.15.2

Hierarchical access level

Any user of a resource configured with hierarchical access level can perform all operations related to this resource IF the access level defined in the application (e.g. SIMATIC IT Graphic User Interface, ODS, ) is LESS THAN or EQUAL TO the level configured for the resource. For example, if you configure the Load Graphic Panels resource with hierarchical access level 12 and then you assign level 10 to the SIMATIC IT Graphic User Interface graphic panel ProdLine1, the operator can load this page.

SIMATIC IT Services V4.4 SP2 User Manual

53

1.15.3

Exclusive access level

Any user of a resource configured with exclusive access level can perform all operations related to this resource ONLY IF the access level defined in the application (e.g. SIMATIC IT Graphic User Interface, ODS, ) is EQUAL TO the level configured for the resource. For example, if you configure the Load Graphic Panels resource with exclusive access level 12 and then you assign level 12 to the SIMATIC IT Graphic User Interface graphic panel ProdLine1, the operator can load this page.

1.15.4

How to use access levels

Scenario You have configured two groups, Production Line Operator and Production Line Manager and have assigned the "Run SIMATIC IT Applications from GUI" resource to each of them. This resource has been configured, respectively, with access level 15 and 20 (both hierarchical). Then you have defined two users: Smith as Production Line Manager and Brown as Production Line Operator. This scenario is illustrated in the following table:

User Smith Brown

Group Production Line Manager Production Line Operator

Resource Run SIMATIC IT Applications from GUI with access level 20 (hierarchical). Run SIMATIC IT Applications from GUI with access level 15 (hierarchical).

Then you create a graphic panel, define two buttons of type "SIMATIC IT Application" and configure their access levels as follows:
SIMATIC IT Application button to load a SIMATIC IT ODD (Operations Data Display) workspace to configure an alarm Access level 18 14

According to this configuration, Smith can both load a SIMATIC IT ODD workspace and configure an alarm, as the access level required to perform these operations is less than 20, that is, the level assigned to the "Run SIMATIC IT application from SIMATIC IT Graphic User Interface" resource for the "Production Line Manager" group. On the other hand Brown can configure an alarm, as the access level required for this operation is less than 15, the level assigned to the resource for the "Production Line Operator" group, but cannot load a SIMATIC IT ODD workspace as the button access level is greater than the resource level.

You might also have configured the groups as follows in order to handle the same situation:
User Smith Brown Group Production Line Manager Production Line Operator Resource Run SIMATIC IT Applications from GUI with access level 20 (hierarchical). Run SIMATIC IT Applications from GUI with access level 20 (exclusive).

SIMATIC IT Services V4.4 SP2 User Manual

54

Then you create a graphic panel, define two buttons of type "SIMATIC IT Application" and configure their access levels as follows:
SIMATIC IT Application button to load an SIMATIC IT ODD (Operations Data Display) workspace to configure an alarm Access level 18 14

According to this configuration, Smith can both load a SIMATIC IT ODD workspace and configure an alarm, as the access level required to perform these operations is less than 20, that is, the level assigned to the "Run SIMATIC IT application from SIMATIC IT Graphic User Interface" resource for the "Production Line Manager" group. On the other hand, Brown can neither load a SIMATIC IT ODD workspace nor configure an alarm: although the button access level is less than the level assigned to the resource for the "Production Line Operator" group, the resource level has been configured as exclusive, and therefore the two buttons would be enabled only if their access level were equal to 20.

1.15.5

Configuring the access level for a resource

Procedure
1. In the User Manager - Group View environment (command Tools > User Manager Plant Management or SIMATIC IT Management Console) double-click a group (Group command, or right-click Name column), or select a group and then the Edit > Modify and select the Modify command from the displayed shortcut menu . The Modify group dialog box opens. 2. Select the resource of interest from the Selected list box within the Resources area and then click the Set Level button. The Edit Resource Level dialog box opens. 3. Enter the access level value in the Level (1-30) edit box or select the value clicking the spin button. 4. To assign the highest level to the resource click the Max Level check box. 5. To configure the access level as exclusive, click the Mutex check box. SIMATIC IT Management Console displays an "x" next to the level value in the Modify group dialog box. You can configure an access level as exclusive only for some resources. 6. Click the Apply button to return to the Modify group dialog box. in

1.15.6

Load Graphic Panels - Access level

You configure this access level from SIMATIC IT Graphic User Interface. This resource is used to control access to graphic panels. You can configure a different access level for each graphic panel selecting command File > Properties from SIMATIC IT Graphic User Interface Development.

1.15.7

Run SIMATIC IT Applications from GUI - Access level

You configure this access level from SIMATIC IT Graphic User Interface.

SIMATIC IT Services V4.4 SP2 User Manual

55

This resource is used to control access by "SIMATIC IT Application" type buttons, and thus to allow/prevent the execution of SIMATIC IT applications from the SIMATIC IT Graphic User Interface environment. The access level can be configured for each "SIMATIC IT Application" button defined in a graphic panel.

1.15.8

Set Variables from SIMATIC IT Graphic User Interface - Access level

You configure this access level from the Database Editor. This resource is used to control write access to variables within a graphic panel. You can configure a different access level for each variable defined in the Points Database using the SL field.

1.15.9

Set Variables from Ladder, Block Editor, ODS - Access level

You configure this access level from the Database Editor, the Ladder and Block Diagram Editors. This resource is used to control write access to variables in a Ladder or Block Diagram program, or from an ODS monitor.

1.16
1.16.1

Working with resources

SIMATIC IT resources
SIMATIC IT supplies the following resources to manage the access to the different functions of the environment:

General Purpose resources

Access to Administrative Tools Access to Help Access to License Configuration Access to Operating System Shell Close Session System Configuration Modify and Save Configurations Modify Configurations (without Saving)

SIMATIC IT Historian resources

Alarm Acknowledgement Alarm Configuration Enable GUI Menu Bar Historical Trends Configuration Load Graphic Panels

SIMATIC IT Services V4.4 SP2 User Manual

56

Print from Graphics, Alarm, Historical Environments Run Alarms Run SIMATIC IT Applications from GUI Run Historical Trends Run Messages from GUI Run Applications from GUI Set Variables from GUI

SIMATIC IT Business Process Modeler resources

BPM Configuration Administrator BPM Remove Plants and Libraries BPM Close Session

SIMATIC IT Production Modeler resources

IfPMObserver IfPMSuperUser IfPMUser IfPMEnd-User

SIMATIC IT PMCOM Interface resources

PM COM Interface Exit PM COM Interface Delete PM COM Interface Configure PM COM Interface Show

SIMATIC IT Material Manager resources

MM Model Configuration MM Sublot Management MM Hut Configuration MM Configuration Administrator MM Close Session

SIMATIC IT Messaging Manager resources

Access to Messaging Manager Form

SIMATIC IT Production Order Manager resources

POM In Progress Order Management POM Configuration Administrator

SIMATIC IT Services V4.4 SP2 User Manual

57

POM Template Management POM Template Instantiation POM Order Dispatch POM Order Management POM State Machine Management POM Close Session

SIMATIC IT Production Operation Recorder resources

POPR Backup Restore POPR Configuration Administrator POPR Close Session

SIMATIC IT Personnel Manager resources

PRM Common Data Configuration PRM Low Level Operator PRM Manager PRM Person/Group Definition PRM Work Schedule Definition

Miscellaneous resources
Browse Source Files CommuWinII - Specialist User Edit DB, User Libraries, Projects Hardware Configuration Modify, Save, Compile Source Files P.M.C. Operations Program Transmission Run ODS Set Variables from Ladder, Block Diagram, ODS Application Builder Runtime Widget Batch Operator Close Application Builder Runtime Set Variables from OPC Server

When you start SIMATIC IT Management Console, the system is configured with the following resources assigned to the Default user: Run Alarms, Load Graphic Panels, Run Historical Trends. Resources Access to License Configuration and Access to Administrative Tools are assigned, by default, only to the Administrators group.

SIMATIC IT Services V4.4 SP2 User Manual

58

1.16.2

Assigning system resources to a group

Procedure
1. In the User Manager - Group View environment (command Tools > User Manager in Plant Management or SIMATIC IT Management Console) double-click a group (Group Name column), or select a group and then click Edit > Modify. The Modify group dialog box opens. 2. Select the resource/s of interest from the Available list box (in the System Resources area). 3. Click the Add >> button. 4. The selected resources are moved to the Selected list box. 5. Click the OK button to exit the dialog box.

1.16.3

Assigning local resources to a group

Procedure
1. In the User Manager - Group View environment (command Tools > User Manager Plant Management or SIMATIC IT Management Console) double-click a group (Group Name column) select a group and then the Edit > Modify dialog box opens. 2. Click the Local Resources tab. 3. Select the workstation you want to assign one or more local resources to. Note Only workstations configured in the SIMATIC IT network are displayed. 4. Click the plus sign beside the workstation icon to expand the resource tree list. 5. Select the check box next to the resource/s of interest . 6. Select another workstation and repeat the above steps on any other workstation you want to assign one or more local resources to. 7. Click the OK button to exit the dialog box. in

command. The Modify group

Important Unlike system resources, local resources can also be assigned to remote workstations; however, these are available only at a workstation level. Therefore, if you want to assign a local resource to multiple workstations on the SIMATIC IT network, you must select that resource on each individual machine you want to assign it to.

SIMATIC IT Services V4.4 SP2 User Manual

59

1.16.4

Displaying the resources of a group

Procedure
1. In the User Manager-Group View environment (command Tools > User Manager in Plant Management or SIMATIC IT Management Console), select the group of interest. 2. Either select command Edit > Modify command from the shortcut menu . , or right-click on the group and select the Modify

3. The Modify group dialog box opens and displays the system resources currently assigned to the group. 4. Click the Local Resources tab: the local resources currently assigned to the group are displayed.

1.16.5

Modifying the resources assigned to a group

Procedure
1. In the User Manager - Group View environment (command Tools > User Manager Plant Management or SIMATIC IT Management Console) select the group of interest. in

or double-click the group name, or right-click and select 2. Select command Edit > Modify the Modify command on the shortcut menu . The Modify group dialog box opens and you can assign a new name to the group. 3. The system resources currently assigned to the group are displayed in the Selected list box within the System Resources area. 4. To assign a new resource, select the resource of interest in the upper table of the System Resources area, and click the Add> button; to remove a resource, select the resource in the lower table and then click the <Remove button. 5. Click the Local Resources tab: the local resources currently assigned to the group are displayed. 6. To assign a new resource, select the check box near the resource of interest to remove a resource, clear the corresponding check box. 7. Click OK to confirm this operation.

1.16.6 1.16.6.1

General Purpose resources Access to Administrative Tools

If this resource has been assigned to your group you can run the User Manager and Log File Viewer tools in Plant Management or SIMATIC IT Management Console

1.16.6.2

Access to Help
If this resource has been assigned to your group you can access to Online Help.

SIMATIC IT Services V4.4 SP2 User Manual

60

1.16.6.3

Access to License Configuration

If this resource has been assigned to your group you can insert/update the license codes for each module (using the License Configuration tool in Plant Management or SIMATIC IT Management Console).

1.16.6.4

Access to Operating System Shell

If this resource has been assigned to your group you can access and run all applications available on your workstation from SIMATIC IT Management Console.

1.16.6.5

System Configuration
If this resource has been assigned to your group you can create, delete, modify Units, backup and restore Plant directories, run the Backup Switch Tool and all applications which handle configurations from SIMATIC IT Management Console. You cannot run the License Configuration or third-party configuration tools.

1.16.6.6

Close Session
If this resource has been assigned to your group you can quit SIMATIC IT Management Console.

1.16.6.7

Modify and Save Configurations

If this resource has been assigned to your group you can: Resize, move, close client windows; open files; save files; close applications (from SIMATIC IT Historian Data Display and SIMATIC IT Alarm Manager Display). Create new files; open existing files/workspaces; save files/workspaces; load programs different to the current one (other than the current one); resize, move, close windows; edit/save monitors; define the module options; show the toolbar, the status bar and the module system bar (from ODS).

1.16.6.8

Modify Configurations (without Saving)

If this resource has been assigned to your group you can: Resize, move, close client windows; open files; close applications (from SIMATIC IT Historian Data Display and SIMATIC IT Alarm Manager Display). Create new files; open existing files/workspaces; load programs different to the current one (other than the current one); resize, move, close windows; edit monitors; define the module options; show the toolbar, the status bar and the module system bar (from ODS).

SIMATIC IT Services V4.4 SP2 User Manual

61

1.16.7 1.16.7.1

Historian resources Alarm Acknowledgement

If this resource has been assigned to your group you can acknowledge alarms.

1.16.7.2

Alarm Configuration
If this resource has been assigned to your group you can run the Alarm Manager Configuration tool from SIMATIC IT Management Console.

1.16.7.3

Enable GUI Menu Bar

If this resource has been assigned to your group you can display or hide the menu bar from SIMATIC IT Management Console.

1.16.7.4

Historical Trends Configuration

If this resource has been assigned to your group you can run the Plant Data Archive Configuration tool from SIMATIC IT Management Console.

1.16.7.5

Load Graphic Panels

If this resource has been assigned to your group you can create and load Graphic Panels from SIMATIC IT Graphic User Interface. This operation is subject to the access level associated with each graphic panel.

1.16.7.6

Print from Graphics, Alarm, Historical Environments

If this resource has been assigned to your group you can print graphic panels from SIMATIC IT Graphic User Interface, historical trends from SIMATIC IT Historian Data Display and alarms from SIMATIC IT Alarm Manager Display.

1.16.7.7

Run Alarms
(Obsolete resource, which must be replaced with the Run SIMATIC IT Application from GUI resource.)

1.16.7.8

Run SIMATIC IT Applications from GUI

If this resource has been assigned to your group, you can configure Application buttons from SIMATIC IT Graphic User Interface to run SIMATIC IT applications. This operation is subject to the access level associated with each button.

SIMATIC IT Services V4.4 SP2 User Manual

62

1.16.7.9

Run Historical Trends

(Obsolete resource, which must be replaced with the Run SIMATIC IT Application from GUI resource.)

1.16.7.10 Run Messages from GUI

If this resource has been assigned to your group, you can configure DDE and EVENT buttons from SIMATIC IT Graphic User Interface to send SIMATIC IT messages.

1.16.7.11 Run Applications from GUI

If this resource has been assigned to your group you can configure the RUN button from SIMATIC IT Graphic User Interface to run other applications.

1.16.7.12 Set Variables from GUI

If this resource has been assigned to your group you can set variables from SIMATIC IT Graphic User Interface. This operation is subject to the access level associated with each variable.

1.16.8 1.16.8.1

Production Modeler resources IfPMObserver

This resource refers to Production Modeler and gives the user very restricted access to system functions. The user can only display objects.

1.16.8.2

IfPMSuperUser
This resource refers to Production Modeler and allows the user to access all system functions. In particular, access to the user environment is permitted only to Super-Users.

1.16.8.3

IfPMUser
This resource refers to Production Modeler and allows the user to access a sub-set of system functions, that is, activating rules and modifying object parameters (but not connections).

1.16.8.4

IfPMEnd-User
This resource refers to Production Modeler and is reserved for future use.

SIMATIC IT Services V4.4 SP2 User Manual

63

1.16.9 1.16.9.1

PM COM Interface resources PM COM Interface Show

This resource allows the user to view PM COM Interface.

1.16.9.2

PM COM Interface Exit

This resource allows the user to exit from PM COM Interface.

1.16.9.3

PM COM Interface Delete

This resource allows the user to delete the objects listed in the PM COM Interface grid.

1.16.9.4

PM COM Interface Configure

This resource allows the user to configure PM COM Interface.

1.16.10

Business Process Modeler resources

1.16.10.1 BPM Configuration Administrator

This resource allows the user to change the database login password from the BPM server form. In order to perform this operation, the user must necessarily possess the appropriate privileges.

1.16.10.2 BPM Remove Plants and Libraries

Operating from BPM Display, this resource allows the user to definitely delete a selected plant or library from the BPM database. If the user wants to restore what has been deleted, he/she must necessarily perform a Download Objects operation from Production Modeler.

1.16.10.3 BPM Close Session

This resource refers to Business Process Modeler and allows the user to close the BPM application server.

1.16.11

Material Manager resources

1.16.11.1 MM Model Configuration

This resource refers to Material Manager and allows you to configure Materials: Add/Modify/Delete Classes and Definitions Manage Properties for Classes & Definitions
SIMATIC IT Services V4.4 SP2 User Manual 64

 Manage Units of Measurements Manage Inventory types Manage Bill of Materials

1.16.11.2 MM Configuration Administrator

This resource allows the user to change the database login password from the MM server form. In order to perform this operation, the user must necessarily possess the appropriate privileges.

1.16.11.3 MM Sublot Management

This resource refers to Material Manager and allows the user to handle lots/sublots: Add/Modify/Delete Lot Modify Lot available fields = Commit, Status Modify Material Lot properties Sublot Management

1.16.11.4 MM Hut Configuration

This resource refers to Material Manager and allows the user to manage the Handling Units.

1.16.11.5 MM Close Session

This resource refers to Material Manager and allows the user to close the MM application server.

1.16.12

Messaging Manager resources

1.16.12.1 Access to Messaging Manager Form

This resource allows the user to configure the access to the entire form and to the access levels. An access level (from 1 to 30) is assigned to the form during its development. At run time, when the form is displayed, the access level of the current user to this resource is compared with the level assigned to the form. If the user access level is lower, the insertion fields will be disabled.

1.16.13

Production Order Manager resources

1.16.13.1 POM Order Dispatch

This resource refers to Production Order Manager and allows the user to dispatch an order.

SIMATIC IT Services V4.4 SP2 User Manual

65

1.16.13.2 POM Order Management

This resource refers to Production Order Manager and allows the user to create and modify Production Order, Entry or Campaign data, and to change the status of an order. Exception: the status of an "in progress" order cannot be modified unless the user owns the "POM In Progress Order Management" resource.

Note This resource has been maintained for compatibility with previous versions on POMD and is valid solely on those states managed by the system state machines.

1.16.13.3 POM In Progress Order Management

This resource has been maintained for compatibility with previous versions, as transient states are now managed by the State Machines. See POM State Machine Management.

1.16.13.4 POM Configuration Administrator

This resource allows the user to change the database login password from the POM server form. In order to perform this operation, the user must necessarily possess the appropriate privileges.

1.16.13.5 POM Template Instantiation

This resource refers to Production Order Manager and allows the user to generate actual Production Orders, Campaigns or Entries in POM from a Template used for all three objects. On the basis of the selections made, the user can create the desired object in POM (passage from "template" to "actual object").

1.16.13.6 POM Template Management

This resource refers to Production Order Manager and allows the user to create and modify Templates relative to Production Orders, Campaigns or Entries.

1.16.13.7 POM State Machine Management

This resource refers to Production Order Manager and allows the user to create and modify Custom State Machines and Custom Statuses. The State Machines are those provided by default in POM, whereas the Custom Statuses are defined "ad hoc" by the user. This resource permits the detailed definition of the various moments that concur to the creation, modification, approval, etc. of a Production Order, Campaign or Entry.

1.16.13.8 POM Close Session

This resource refers to Production Order Manager and allows the user to close the POM application server.

SIMATIC IT Services V4.4 SP2 User Manual

66

1.16.14

Production Operation Recorder resources

1.16.14.1 POPR Backup Restore

This resource refers to Production Operation Recorder and allows the user to enable the backup/restore functionalities of the POPR database.

1.16.14.2 POPR Configuration Administrator

This resource allows the user to change the database login password from the POPR server form. In order to perform this operation, the user must necessarily possess the appropriate privileges.

1.16.14.3 POPR Close Session

This resource refers to Production Operation Recorder and allows the user to close the POPR application server.

1.16.15

Personnel Manager resources

1.16.15.1 PRM Common Data Configuration

This resource refers to Personnel Manager and allows you to configure properties, operations, measuring units, day and group types.

1.16.15.2 PRM Low Level Operator

This resource refers to Personnel Manager and only allows you to display information from the various Personnel Manager environments.

1.16.15.3 PRM Manager

This resource refers to Personnel Manager and allows you to access all system functions.

1.16.15.4 PRM Person/Group Definition

This resource refers to Personnel Manager and allows you to configure persons/groups/qualification test specifications and user management, but not work schedule management.

1.16.15.5 PRM Work Schedule Definition

This resource refers to Personnel Manager and allows you to configure work schedule management.

SIMATIC IT Services V4.4 SP2 User Manual

67

1.16.16

Miscellaneous resources

1.16.16.1 Browse Source Files

If this resource has been assigned to your group you are granted read access to the source files from the PDE and Zone Monitoring Environments.

1.16.16.2 CommuWinII - Specialist User

If this resource has been assigned to your group you can run the CommuWinII program for configuring Endress + Hauser devices as a "specialist" user (full access to all CommuWinII functions). Otherwise, you can run the CommuWinII program as a "maintenance" user (limited access to CommuWinII functions).

1.16.16.3 Edit DB, User Libraries, Projects

If this resource has been assigned to your group you can run the Locreg Configuration tool from SIMATIC IT Management Console or PDE; from PDE you can run the Library Manager and Data Base Management tools, as well as define and update the module options and save configurations; from ZME you can run the Data Base Management tool.

1.16.16.4 Hardware Configuration

If this resource has been assigned to your group you can run the Hardware Configuration Tool from SIMATIC IT Management Console.

1.16.16.5 Modify, Save, Compile Source Files

If this resource has been assigned to your group you can: save and compile files from SIMATIC IT Graphic User Interface. update, save and compile source files from PDE. update, save and compile source files (graphic panels) from ZME.

1.16.16.6 PMC Operations

If this resource has been assigned to your group you can run the Transmission Control Panel and Dump/Restore Control Panel tools from SIMATIC IT Management Console or PDE. In the ODS environment you can change the P.M.C. status (Run/Stop), and the sequence status (Suspend/Resume).

1.16.16.7 Program Transmission

(Obsolete resource, which must be replaced with the P.M.C. Operations resource.)

SIMATIC IT Services V4.4 SP2 User Manual

68

1.16.16.8 Run ODS

(Obsolete resource, which must be replaced with the Run SIMATIC IT Application from GUI resource.)

1.16.16.9 Set Variables from Ladder, Block Diagram, ODS

If this resource has been assigned to your group you can set variables from ODS, Ladder and Block Diagram files.

1.16.16.10

Application Builder Runtime Widget

This resource is obsolete. It is applicable to the buttons, the screens and the menu items of a SIMATIC IT Application Builder application. If this resource is available, you can enable the button or menu item.

1.16.16.11

Batch Operator
This resource is obsolete.

1.16.16.12

Close Application Builder Runtime

This resource is obsolete. If this resource has been assigned to your group, you can exit from SIMATIC IT Application Builder Runtime.

1.16.16.13

Set Variables from OPC Server

This resource allows you to modify the values of RTDS variables from OPC Server.

1.17
1.17.1

Licensing
Inserting SIMATIC IT license codes
SIMATIC IT is made up of a number of components which are independent of each other: each component has a license code which is linked to the protection key supplied with the product. You must insert the license codes for all the components that you wish to start on your workstation in order to be able to use the components. In particular, a specific procedure must be followed when inserting license codes for the first time.

Important Only users belonging to a group to which the Access to License Configuration resource has been assigned can use command Licenses Configuration. For more information, see SIMATIC IT resources.

You can perform one of the following operations:

SIMATIC IT Services V4.4 SP2 User Manual 69

 Inserting license codes from file Entering license codes manually

1.17.2

When you insert licenses for the first time

The first time you insert licenses on your workstation, you must do as follows: 1. Check if the SIMATIC IT protection key has been plugged into the selected parallel port. 2. Check if the protection key driver has been correctly installed; 3. Start SIMATIC IT Management Console; 4. Log on as Manager, since only this user has the access permission to update licenses. To log on, press the SHIFT+ESC keys, enter manager in the User Logon dialog box and press RETURN without entering any Password. 5. Enter the System Configuration window. 6. Select the Licenses tab. 7. Type in the license codes or insert them from diskette.

1.17.3

Inserting license codes from file

You can insert license codes from file when you need to add or update all license codes at the same time.

To insert license codes from file: 1. Enter the System Configuration window. 2. Select the Licenses tab. 3. Click the Update from Files button. 4. Select the appropriate drive and directory in the Update from File dialog box 5. The files contained in the directory are listed in alphabetical order (all files have .LIC extension and their name is the same as the serial number of the protection key for which they have been generated). 6. Select the file name corresponding to the number labelled on the protection key of your workstation from the License file list box. You can also check for the serial number of your key by running command Help > System Information in Plant Management or SIMATIC IT Management Console. 7. Click the Exit button.

1.17.4

Entering license codes manually

You can type in license codes when you need to add or update only a few license codes (for example, when you must configure the licenses of a new add-on module or a new driver).

To enter license codes manually: 1. Enter the System Configuration window. 2. Select the Licenses tab.
70

SIMATIC IT Services V4.4 SP2 User Manual

3. In the Category area, select one or more radio buttons related to the kind of components you want to display in the list box:
Select All Modules SIMATIC IT Main modules SIMATIC IT Add-on Modules To display all components all SIMATIC IT main components all add-on components, that is, those components which are not part of SIMATIC IT base architecture but can be used for specific purposes. all drivers, that is, the interface modules developed by Siemens A&D AS MES which connect the Real Time Data Server with a wide range of supervisory and control systems. all third-party components, implemented by third-party companies in co-operation with Siemens A&D AS MES. all CORe components (i.e. SIMATIC IT BPM, POPR, POM, MM) and SIMATIC IT Plant Performance Analyzer

Drivers

Third Party Add-on Modules Components

4. The list box shows the component name, the license code and, where applicable, the expiration date of the product license. Select the component for which the license must be inserted or updated. 5. Type the license code in the License Code edit box; press the TAB or RETURN keys to move between the fields. 6. Where applicable, type the expiry code of the license in the License Expiration Code edit box. 7. Click the Update License button to save the inserted codes. 8. Click the Exit button to quit this operation.

1.18
1.18.1

Basic Configuration
System configuration
SIMATIC IT Management Console provides a user-friendly tab-based interface for the configuration of the system. System configuration includes the following functions: Configuring the Foundation servers Configuring a SIMATIC IT workstation Configuring SIMATIC IT components for automatic start-up

1.18.2

Entering the System Configuration window

You can enter the System Configuration window from two distinct environments: Plant Management SIMATIC IT Management Console.

If you are in...

Select...

SIMATIC IT Services V4.4 SP2 User Manual

71

Plant Management SIMATIC IT Management Console

Tools > System Configuration command Configuration > System command Or tab > Configuration > System Configuration command

1.18.3 1.18.3.1

Workstation Configuring a SIMATIC IT workstation

Configuration parameters define the start-up and utilization mode of a SIMATIC IT workstation (e.g., Foundation Server, default user name, system language, messages format, etc.) The above settings are local to the workstation on which they are configured.

1.18.3.2

Enabling serial communications

If the SIMATIC IT workstation you are configuring acts as gateway to a P.M.C. serial network (that is, if you configured it as Master during the creation of the serial network), you need to:

1. Enter the System Configuration window. 2. Select the Workstation tab. 3. Select the Enable P.M.C. serial communications checkbox to start the SIMATIC IT Management Console services which handle serial communications.

If this option is not properly configured, the system will not be able to send data to/receive data from P.M.C.s connected to the serial network.

1.18.3.3

Defining the system language

SIMATIC IT Management Console menus and dialog boxes can be displayed either in English (United Kingdom or United States), French, German, Italian and Spanish.

Important The difference between English (United Kingdom) and English (United States) is limited to date-display in the SIMATIC IT Historian Data Display and SIMATIC IT Alarm Manager Display client modules (English (United Kingdom): day/month/year, English (United States): month/day/year).

To define the language used on your workstation:

1. Enter the System Configuration window. 2. Select the Workstation tab. 3. Select one of the following options in the System Language area:
72

SIMATIC IT Services V4.4 SP2 User Manual

Select Run-time Language Development Language Operator keyboard language

To define the language used by online applications the language used by off-line applications the functional keyboard language (Italian, English, French, German or Spanish)

The configured language will be applied the next time you log on to SIMATIC IT Management Console.

1.18.4 1.18.4.1

Foundation servers Configuring the Foundation servers

The Foundation servers should be defined during installation of SIMATIC IT Services, as prompted by the setup program. However, if the servers have not been defined during installation, you can configure them later from the Plant Management or SIMATIC IT Management Console environment. To configure a Foundation server: 1. Enter the System Configuration window:. 2. Select the Foundation Servers tab. 3. Enter the computer name of the workstation that will be configured as the Foundation server in the Computer Name box. 4. Click the Add button to insert the computer name into the Foundation Server List list box. 5. Click the OK button to confirm.

Important If the following message appears when you select the Foundation servers command: "Write access on masters configuration file temporarily denied" please wait for about 3 minutes until you are granted write access to the server configuration file. Until access is granted all buttons and boxes in the Foundation Servers tab are disabled

The computer names are listed in alphabetical order in the Foundation Server List list box, independent of the order in which they have been inserted. You can enter three computer names at most, and then the Add command is disabled. You can insert another computer name only after deleting one of the displayed computer names.

1.18.4.2

What happens if no Foundation servers are configured?

If no Foundation server configuration is available, that is, the BCKCONF.CNF file located in directory ICUBE.CNF cannot be read (either because no configuration was defined during installation of SIMATIC IT Services or because no workstations defined as Foundation servers are available), all SIMATIC IT components on the workstation start normally but cannot perform the following functions: Updating the physical network configuration. Communicating with remote server modules.

SIMATIC IT Services V4.4 SP2 User Manual

73

 Updating the user database and transferring the updated information to all other SIMATIC IT workstations.

1.18.4.3

Removing a Foundation server

To remove a Foundation server: 1. Enter the System Configuration window. 2. Select the Foundation Servers tab. 3. Select the computer name of the workstation that must no longer be configured as Foundation server in the Computer Name combo box. 4. Click the Delete button to remove the computer name from the Foundation Server List list box. 5. Click the OK button to confirm.

Important Even if you remove all Foundation servers, the current network server still maintains network functions

1.18.5 1.18.5.1

Start-up configuration Enabling SIMATIC IT stand-alone start-up

When you start SIMATIC IT Management Console on your workstation, the system reads information related to network configuration and groups from the machine which has been configured as network server. If you configure SIMATIC IT to start up in stand-alone mode, the SIMATIC IT components on your workstation are isolated from all other SIMATIC IT components running on remote workstations, and therefore the system obtains the network configuration from the local machine, ignoring the centralized configuration. Also, if you select this option, all functions are handled by your machine, therefore you must have installed both client and server modules. The stand-alone configuration is recommended when you do not need to interact with other workstations over the network and if you do not need to perform many functions on the same workstation.

To enable SIMATIC IT stand-alone start-up: 1. Enter the System Configuration window . 2. Select the Workstation tab. 3. Select the Stand-Alone checkbox.

1.18.5.2

Starting SIMATIC IT Management Console

1. Enter the System Configuration window. 2. Select the Start Up tab. 3. Select the Automatic Log-On to Current Plant check box.

SIMATIC IT Services V4.4 SP2 User Manual

74

4. Click OK.

With this option, when you start SIMATIC IT Management Console you log on directly to the SIMATIC IT Management Console environment of the current Plant and do not need to select the Plant icon in the Plant Management window

1.18.5.3

Starting SIMATIC IT applications from SIMATIC IT Management Console

SIMATIC IT Management Console is the system menu that provides access to all SIMATIC IT configuration and programming tools.

From Server menu or Configuration menu or Client menu or Component menu or Tools menu or Services menu or tab tab tab tab tab tab

Start the applications Compliance Service Server, Event Manager, Alarm Manager, etc. Compliance Service Configuration, Event Manager, Alarm Manager, etc. Compliance Service Viewer, Historian Data Display, etc. Plant Performance Analyzer, Material Manager, Production Order Manager, etc. Backup Manager, Log File Viewer, User Manager, etc. Alerter, System Toolbox, etc.

The Management Console Tasklist displays all the applications currently running on your workstation. For more information, see Management Console Tasklist.

1.18.5.4

Minimizing SIMATIC IT Management Console

To minimize SIMATIC IT Management Console: 1. Enter the System Configuration window. 2. Select the Start Up tab. 3. Select the Start System Menu as an Icon check box. 4. Click OK.

With this option, when you start SIMATIC IT Management Console and log on to a Plant, the SIMATIC IT Management Console application window is minimized.

1.18.5.5

Start order for SIMATIC IT Management Console components

This is the default order that SIMATIC IT uses to automatically launch its modules. Note that this order cannot be modified by the user: SIMATIC IT Messaging Manager Server SIMATIC IT Real Time Data Server SIMATIC IT Data Engine SIMATIC IT Compliance Service Server SIMATIC IT Plant Data Archive SIMATIC IT Alarm Manager

SIMATIC IT Services V4.4 SP2 User Manual

75

 SIMATIC IT DDE Interface SIMATIC IT Report Manager SIMATIC IT Event Manager SIMATIC IT Expert System User Interface SIMATIC IT Expert System/RTDS Interface SIMATIC IT Statistical Process Control SIMATIC IT Statistical Process Control Run-Time SIMATIC IT Expert System/PDA Interface SIMATIC IT Operations Data Display SIMATIC IT Business Process Modeler SIMATIC IT Material Manager SIMATIC IT Production Operation Recorder SIMATIC IT Production Order Manager SIMATIC IT Personnel Manager Server SIMATIC IT Plant Performance Analyzer SIMATIC IT Batch COM Interface Custom and Third-party applications SIMATIC IT PM COM Interface SIMATIC IT Production Modeler SIMATIC IT Batch SIMATIC IT Batch COM Server Alarm Acknowledge Services SIMATIC IT Alarm Manager Display SIMATIC IT Graphics User Interface Run-Time SIMATIC IT Historian Data Display

The third-party applications must be launched between the launch of SIMATIC IT BATCH COM Interface and SIMATIC IT PM COM INTERFACE (if installed).

1.18.5.6

Starting SIMATIC IT components automatically

To start a SIMATIC IT component automatically: 1. Enter the System Configuration window. 2. Select the Start Up tab. 3. Select the component/s to be started automatically upon Plant logon from the Management Console Applications list box where they are sorted in alphabetical order. Note It is not possible to change the order in which the components are started up automatically. When you select them, the Up and Down buttons become disabled. 4. Click the Add-> button. Component names are moved to the Start-Up list box and deleted from the Management Console Applications list box.

SIMATIC IT Services V4.4 SP2 User Manual

76

5. If you need to start third-party or custom applications automatically, select the application/s from the Third Party Applications list box and click the Add-> button. Application names are moved to the Start-Up list box and deleted from the Third Party Applications list box. Note If you add more than one Third Party Application, you can change only their order in the Start-Up list box using the Up and Down buttons; however, they must be inserted between the SIMATIC IT Batch COM Interface and SIMATIC IT PM COM Interface components. Also note that third-party applications are listed in this box ONLY IF they have been added to the SIMATIC IT Management Console Client menu. For more information, see Adding thirdparty components to the Client menu. 6. To set a default delay of 5 seconds between the launch of any two components: Select the Delay property in the Management Console Applications list box, click the Add -> button which moves the delay property to the end of the Start-Up list box. Select the Delay property in the Start-Up list box and move it using the Up and Down buttons to a location between the components whose start time you want to delay. To change the default of the delay from 5 seconds to another interval, see Start Delay time.

Note the Delay property is always present in the Management Console Applications list box because it can be used repeatedly to set a launch delay between various components 7. Click OK to exit and save the current settings.

Important The following components are always launched last and you cannot insert a delay time or third-party/custom application(s) between them: SIMATIC IT Alarm Acknowledge Services SIMATIC IT Alarm Data Display SIMATIC IT Graphic User Interface Run-Time SIMATIC IT Historian Data Display For more information, see the Users Guide of the SIMATIC IT component of interest.

1.18.5.7

Start Delay time

SIMATIC IT Management Console has a 5 second default delay between launching components. You can modify the delay: 1. Enter the System Configuration window. 2. Select the Start Up tab. 3. In the Management Console Applications list box, select the Delay property and click the Add -> button, the property is moved to the Start-Up list box. 4. In the Start-Up list box, select the Delay property and move it using the Up and Down buttons to a location between the components whose start time you want to modify. 5. Select the Properties button, the Delay dialog box appears. 6. In the Delay dialog box, type the milliseconds you want to set as delay time before the automatic start of the next component. 7. Click OK to save or Cancel to exit without saving.

SIMATIC IT Services V4.4 SP2 User Manual

77

1.18.5.8
Purpose

Configuring start-up parameters for SIMATIC IT components

The following SIMATIC IT components require start-up parameters in order to permit their automatic launching upon SIMATIC IT start-up: SIMATIC IT Alarm Manager Display SIMATIC IT Real Time Data Engine SIMATIC IT Graphic User Interface Run-Time SIMATIC IT Operations Data Display SIMATIC IT Historian Data Display SIMATIC IT Real Time Data Server

Procedure
1. Enter the System Configuration window. 2. Select the Start Up tab. 3. Select the component name from the Start-Up list box. 4. Click the Properties button and enter the required parameters in the Properties dialog box. Please note that this button is disabled if the component does not need any start-up parameters to be configured. 5. Click OK.

Important Components which are run within a Zone (such as Alarms, SIMATIC IT Graphic User Interface, Historical Trends, ) are executed in the default zone defined. For more information on how to change this parameter, see Configuring the Default Zone. .

1.18.5.9

Alarm Manager Display: startup parameters

Command Line: name of the workspace file stored in the \plantname\\MMI\zonename\ALARM\USER directory OLE Server: check this box if you need to use the Alarm Manager Display module only as an OLE server, that is, to load AMD objects into SIMATIC IT Graphic User Interface or other Windows OLE-compliant applications. Run Minimized: check this box if you want to run the Alarm Manager Display module in a minimized mode.

1.18.5.10 Real Time Data Engine: start-up parameters

Unit Name: name of the Real Time Data Engine Unit to be used.

SIMATIC IT Services V4.4 SP2 User Manual

78

1.18.5.11 Graphic User Interface Run-Time: start-up parameters

Command Line: name of the graphic panel stored in the \plantname\MMI\zonename \GRAPH\COMP directory. Run Minimized: check this box if you want to run the SIMATIC IT Graphic User Interface RunTime module in a minimized mode.

1.18.5.12 Operations Data Display: start-up parameters

Command Line: name of the SIMATIC IT ODD workspace stored in the \plantname \ACTION.LOG\GEN directory. Run Minimized: check this box if you want to run the Operations Data Display module in a minimized mode.

1.18.5.13 Historian Data Display: start-up parameters

Command Line: name of the workspace file stored in the \plantname\\MMI\zonename\DATA\USER directory OLE Server: check this box if you need to use the Historian Data Display module only as an OLE server, that is, to load Historian Data Display objects into SIMATIC IT Graphic User Interface or other Windows OLE-compliant applications. Run Minimized: check this box if you want to run the Historian Data Display module in a minimized mode.

1.18.5.14 Real Time Data Server: start-up parameters

Unit Name: name of the RTDS Unit to be used.

1.18.5.15 Controlled shutdown

The following components must be closed in the following order which is the opposite of their launch order: Business Process Modeler Material Manager Production Operation Recorder Production Order Manager Personnel Manager Server Plant Performance Analyzer Batch COM Interface All custom/third-party applications PM COM Interface Production Modeler

SIMATIC IT Services V4.4 SP2 User Manual

79

The Production Modeler waiting timeout is five minutes maximum; therefore, all modules must be closed within this time. To modify this timeout, add in the %ICUBECNF%\menu.ini file the following section and key:

[DELAY]
retry=<integer that specifies the number of attempts >

1.18.6 1.18.6.1

Working with Plants What is a Plant?

A Plant represents the factory, or a part of it, and is made up of supervisory workstations and controllers. These items are logically represented as Units in the SIMATIC IT environment. SIMATIC IT can handle several Units. If the Unit is a Siemens Orsi Automation P.M.C. data is exchanged directly between SIMATIC IT applications and the P.M.C. memory areas. Siemens Orsi Automation P.M.C.s are logically represented as Control Units in the SIMATIC IT environment. On the other hand, if the control unit is a third-party device connected to a market control network (Siemens, Allen Bradley, ), SIMATIC IT applications read and write data to a temporary memory area located on the PC, called the SIMATIC IT Real Time Data Server, and data is exchanged with the external devices via appropriate drivers. In this case controllers are logically represented as RTDS or Real Time Data Engine Units. From a physical point of view a Plant is a directory on the PC hard disk, called Plant.PLT. This directory contains several subdirectories where configurations, programs and all files required to build the supervisory and control applications of your automation system are stored. Each Plant defined in the system is represented with a Management application window. PLANT icon in the Plant

From any workstation you can log on to more than one Plant, although not concurrently, and each Plant can be shared by several workstations.

1.18.6.2

Creating a Plant
To create a Plant: 1. Select command File > New in Plant Management.

2. Enter the Plant name (maximum 8 characters) in the Plant name edit box. Click the Next button. 3. Select the drive where you want to create the Plant. Click the Next button. 4. Click the Finish button.

The Plant icon is added to the Plant Management window and the plantname.PLT directory structure is created on the selected PC hard disk.

SIMATIC IT Services V4.4 SP2 User Manual

80

1.18.6.3

Opening a Plant
After creating a new Plant you need to define all Units that are part of it. To do this you must first open the Plant and then run the appropriate commands from the SIMATIC IT Management Console environment. To open a Plant: 1. Double-click the icon or Select the Plant icon and then choose command File > Logon to SIMATIC IT Management Console. 2. If it is the first time you open a Plant, the SIMATIC IT Management Console dialog box is displayed and you can configure the default Unit, choosing one of the computer names previously defined in the network configuration. 3. Finally you enter the SIMATIC IT Management Console environment which supplies all the tools required to manage a Plant. of the Plant of interest in the Plant Management window

1.18.6.4

Copying a Plant
To copy the Plant directory to another directory with a different name: 1. Select command Edit > Copy in Plant Management.

2. In the Copy Plant dialog box, enter the name of Plant in Plant Name box. Select the Next button. 3. Select the drive where you want to create the Plant. Select the Next button. 4. Click the Copy button.

1.18.6.5

Renaming a Plant
To rename the Plant directory: 1. Select command Edit > Rename 2. Enter the new name of the Plant. 3. Click out of the edit box or press the ENTER key. in Plant Management.

1.18.6.6

Removing a Plant
To remove a Plant: 1. Select the plant you want to remove. 2. Select command Edit > Delete in Plant Management.

3. The program asks you a confirmation Click the Yes button. 4. The program asks you another confirmation. Select the Yes button.

Important Since you can cancel deletion at any moment, some directories might not be removed completely. In this case the Plant icon is still displayed in the Plant Management window, but it is broken.

SIMATIC IT Services V4.4 SP2 User Manual

81

1.18.6.7

Closing a Plant
To close a Plant and go back to the Plant Management environment: 1. Select command File > End session or press keys ALT+ F4. 2. The End session dialog box appears. 3. Select the Log Off option to end the current working session, quit the SIMATIC IT Management Console environment and go back to the Plant Management environment .

If you choose any other option, you will either end the current Plant working session and return to the Windows operating system, or end the Windows working session.

1.18.6.8

Plant directory structure

A Plant is a structure of directories and subdirectories which can be deleted, copied and renamed. Furthermore you can create a backup copy of the whole Plant and save it to diskette.

The main directory of the Plant, called Plant.PLT is further subdivided into subdirectories: APPLIC which stores all files related to Projects MMI which stores all files related to supervisory Zones

There is also a number of subdirectories with .LOG extension which store configuration and data files: ACTION.LOG ALARM.LOG DATA.LOG EVENT.LOG

Also the following SYSTEM subdirectories contain, respectively: Plant configuration files (CONFIG); Data Dictionaries (DATABASE); PMC configuration files (PMC_CONF); SIMATIC IT Real Time Data Server and error log configuration files (RTDS). temporary files, which are removed each time you log on to SIMATIC IT Management Console (TEMP); text files created with the SIMATIC IT Management Console native Text Editor (TEXT); link group files, used to set variables via Historian DDE Interface (DDE).

When you create a new Plant, the program also adds some directories related to third-party applications: directory SPC.LOG stores log files generated by the Cube-SPC application.
SIMATIC IT Services V4.4 SP2 User Manual 82

Note Cube-SPC is no longer supported from version 4.2 of SIMATIC IT Management Console and Historian.

1.18.6.9

APPLIC directory structure

The APPLIC directory is further subdivided into a number of subdirectories which have the same name as the Projects created for the current Plant.

Directory APPLIC

Subdirectory Project name

Subdirectory COMP GEN LIB SOURCES TEXT

Contents Compiled files System files, not managed by the user User library files ITER, LADDER and BLOCK DIAGRAM source files Cross-Reference output files and compilation error files Compiled files System files, not managed by the user User library files Files sent to the Recycle Bin ITER, LADDER and BLOCK DIAGRAM source files Cross-Reference output files and compilation error files Global library files for Real Time Data Engine Global library files for Siemens Orsi P.M.C. Reserved for future use Global monitor files created by ODS

Project name.DEC

COMP GEN LIB RECYCLED SOURCES TEXT

GLOBAL.LIB

DE PMC SOFTCNT

GEN.GLB

1.18.6.10 MMI directory structure

The MMI directory is further subdivided into a number of subdirectories which have the same name as the Zones defined in the current Plant.
Directory MMI Subdirectory Zone name Subdirectory ALARM DATA EVENT GRAPH REPORT Third-party module Contents Files generated by the Alarms module System files, not managed by the user Files generated by the Events module Files generated by the SIMATIC IT Graphic User Interface module Files generated by the Reports module Files generated by third-party modules

1.18.6.11 ACTION.LOG directory structure

Directory ACTION.LOG Subdirectory ARCH GEN TEXT Contents SIMATIC IT ODD archive files (current and backup) SIMATIC IT ODD configuration and workspace files SIMATIC IT ODD text files

SIMATIC IT Services V4.4 SP2 User Manual

83

1.18.6.12 ALARM.LOG directory structure

Directory ALARM.LOG Subdirectory ARCH GEN TEXT Contents SIMATIC IT Alarm Manager alarm definition files and archive files SIMATIC IT Alarm Manager server configuration files SIMATIC IT Alarm Manager text files

1.18.6.13 DATA.LOG directory structure

Directory DATA.LOG Subdirectory ARCH GEN TEXT Contents SIMATIC IT Plant Data Archive point definition files and archive files SIMATIC IT Plant Data Archive server configuration files SIMATIC IT Plant Data Archive text files

1.18.6.14 EVENT.LOG directory structure

Directory EVENT.LOG Subdirectory ARCH GEN TEXT Contents SIMATIC IT Event Manager archive files (e.g. events database) SIMATIC IT Event Manager server configuration files SIMATIC IT Event Manager text files

1.18.6.15 Archiving
1.18.6.16 Archiving a Plant
SIMATIC IT Management Console provides a Plant maintenance tool for: Creating a backup copy of a Plant Creating a backup copy of a Plant automatically Displaying the contents of a backup file Restoring a previously-archived Plant

In a user-friendly environment, this tool is called Backup Manager and can be activated with command Tools > Backup Manager from Plant Management or SIMATIC IT Management Console.

1.18.6.17 Archiving a Plant you are not logged on to

If you run command Tools > Backup Manager from Plant Management rather than from SIMATIC IT Management Console, you can create a backup copy of a Plant other than the one currently selected (this information is available in the status bar).

To archive a Plant to which you are not currently logged on: 1. Select command Options > Configuration in the Backup Manager environment. 2. The Configuration dialog box displays all the Plants located on the current drive. 3. Select the drive and Plant of interest from the Drive and Plant list boxes, respectively.

SIMATIC IT Services V4.4 SP2 User Manual

84

4. Click the OK button.

Then proceed as described in Creating a backup copy of a Plant.

1.18.6.18 Creating a backup copy of a Plant

You can create a backup copy of: the Plant you are currently logged on to (from SIMATIC IT Management Console) the Plant selected in the Plant Management window. For more information, see Archiving a Plant you are not logged on to.

The backup file has .ARQ extension and can be saved into any directory of the current drive, on a remote drive, on Iomega Zip or on diskette. By default the backup file has the same name as the Plant but you can enter any string compliant with Microsoft Windows standards.

Important If you backup the Plant to diskette, it is recommended to use empty diskettes.

To create a backup copy: 1. Select the command Tools > Backup Manager from Plant Management or SIMATIC IT Management Console. 2. Select the command File > Backup in the Backup Manager environment. Important Before activating the backup command make sure that no SIMATIC IT application is running.

3. Select the pathname of the backup file and click the Open button. 4. The Backup dialog box displays all the files, which can be archived in the File list box. By default all Plant files are selected apart from some configuration files. In detail, you can: Select the files to be archived Select the Units to be archived Select the Zones to be archived Select the third-party applications to be archived.

1.18.6.19 Selecting the files to be archived

To select the Plant files that you want to archive: 1. In the Backup dialog box, select the file to be archived from the File list box. To cancel selection click an already selected file. 2. Hold down the CTRL or SHIFT keys to select more than one file at the same time. 3. Click the Select All button to choose to archive all the Plant files (data and configuration). 4. Click the None button to cancel all selections. 5. By default, SIMATIC IT Management Console archives all backup files (*.bak, *.bbk, *.old) stored in your Plants directories. To archive only the backup files found in the ALARM.LOG and DATA.LOG directories, please check the Exclude backup source files box.
SIMATIC IT Services V4.4 SP2 User Manual 85

By default the program archives all Units (project, database, hardware configuration files) and all Zones (alarm and trend workspace, graphic panels, reports, etc.).

1.18.6.20 Selecting the Units to be archived

To select the Units that you want to archive: 1. In the Backup dialog box, click the Unit button. 2. The Unit dialog box displays all the Units configured in the selected Plant in the Unit Backup list box. 3. To not archive a Unit, select the Unit name from the Backup Unit list box and click the <Remove button. The Unit name is moved to the Unit list box. 4. To not archive any Unit, click the <-Remove All button 5. For each Unit displayed in the Unit Backup list box, you can select the Project, DataBase and Hardware Configuration check boxes to archive the project, database and hardware configuration files, respectively. 6. Click the OK button. to return to the Backup dialog box.

1.18.6.21 Selecting the Zones to be archived

To select the Zones that you want to archive: 1. In the Backup dialog box, click the Zone button. 2. The Zones dialog box displays all the Zones configured in the selected Plant. 3. In order not to archive a Zone, click the Zone name in the list box. 4. If you do not wish to archive any Zone, click the None button. 5. To archive all Zones (default), click the Select All button. 6. Click the OK button. to return to the Backup dialog box.

1.18.6.22 Selecting the third-party applications to be archived

By default SIMATIC IT Management Console archives all third-party applications but you can change this configuration.

To select the third-party applications that you want to archive: 1. In the Backup dialog box, click the Third Party button. 2. The Third Party Applications dialog box displays all the third-party applications configured in the selected Plant. 3. In order not to archive an application click the application name in the list box. 4. If you do not wish to archive any application click the None button. 5. To archive all applications (default) click the Select All button. 6. Click the OK button. to return to the Backup dialog box.

1.18.6.23 Checking the correctness of the backup copy

To check if the backup copy of a plant has been created correctly: 1. Select the File > Test command in the Backup Manager environment. 2. Select the backup file and click the Open button.

SIMATIC IT Services V4.4 SP2 User Manual

86

3. The Test Archive Integrity dialog box displays whether errors are detected or not for the backup copy. 4. Click the OK button.

1.18.6.24 Creating a backup copy of a Plant automatically

Important You can associate this function to an event periodically triggered by the Event Manager.

To automatically create a backup copy of a Plant: 1. Compile the configuration file in the directory corresponding to the ICUBECNF environment variable (e.g. ICUBE.CNF). Either use the ARQINFO.INI default file or define a new one. For more information, see Compiling the backup configuration file. 2. Open a Command Prompt session. 3. Type the Cubearq command line and pass the following arguments:
Argument Example

/Ddisk, where disk is the name of the disk on which the Plant /DC: (C: is the name of the disk on which is located. the Plant is located). /Pplant, where plant is the name of the Plant to be archived. /A, sets the automatic backup mode and loads the configuration in the ARQINFO.INI default file. /Pplant3 (plant3 is the name of the plant to be archived). /A

/Afile, where file is the name of the user-defined INI file. Sets /AmyIni.INI (myIni.INI is the name of the the automatic backup mode and loads the configuration in the user-defined file). specified INI file.

Important Arguments must be separated by a blank space.

Example 1 Cubearq /DC: /Pplant3 /A Example 2 Cubearq /DC: /Pplant3 /AmyIni.INI

4. The Backup Manager is launched as a minized window. At the end of the backup execution (or in the event of errors), it closes automatically. If serious errors occur, they are notified via the SIMATIC IT Management Console Alerter. 5. The backup file is created in the directory specified in the backup configuration file. It is called by default PlantName_BackupDate_BackupTime.ARQ, according to the following formats: BackupDate: DDMMYY BackupTime: HHMMSS

Example MYPLANT_030802_122707.ARQ

Important The automatic backup of the Plant should be executed while Historian is running.
SIMATIC IT Services V4.4 SP2 User Manual 87

1.18.6.25 Compiling the backup configuration file

The structure of the backup configuration file is the following:
Keywords [OUT_PATH] BackupDir= [PlantName] Access Levels Configuration Files= Action Log Files= Alarm Archive Files= Batch Configuration Files= DDE Configuration Files= Event Archive Files= Global Libraries= Global Monitor Files= yes/no yes/no yes/no yes/no yes/no yes/no yes/no yes/no BackupDirectoryPath Type Description Section that identifies the destination directory for backup files Path of the Backup Directory (e.g. C:\BACKUP) Section that identifies the Plant yes to archive files; no not to archive them yes to archive files; no not to archive them yes to archive files; no not to archive them yes to archive files; no not to archive them yes to archive files; no not to archive them yes to archive files; no not to archive them yes to archive files; no not to archive them yes to archive files; no not to archive them yes to archive files; no not to archive them yes to archive files; no not to archive them yes to archive files; no not to archive them yes to archive files; no not to archive them yes to archive files; no not to archive them yes to archive files; no not to archive them yes to archive files; no not to archive them yes to archive files; no not to archive them yes to archive files; no not to archive them yes to archive files; no not to archive them yes to archive files; no not to archive them yes to archive files; no not to archive them yes to archive files; no not to archive them yes to archive files; no not to archive them yes to archive files; no not to archive them yes to archive files; no not to archive them

Plant Data Archive configuration yes/no files= I/O Device Profiles and Catalogs= Licenses Configuration Files= Network Configuration Files= Plant Configuration Files= Plant Data Archive Files= Recipe Configuration Files= RTDB/IMC Configuration Files= Statistical Archive Files= Text Files= Third Party Applications= Unit Data Files= Workstation Configuration Files= Zones= yes/no yes/no yes/no yes/no yes/no yes/no yes/no yes/no yes/no yes/no yes/no yes/no yes/no

Messaging Manager Templates= yes/no

User alarms configuration files= yes/no

Important The keyword Plantname should be modified. It is necessary to insert the name of the Plant that you want to backup automatically, without the extension .PLT. For ex: [PLANT_CATE]

Important With reference to the keywords:

They are written in English and are case sensitive. They must not be altered.

SIMATIC IT Services V4.4 SP2 User Manual

88

Their order is irrelevant.

1.18.6.26 Displaying the contents of a backup file

When you select command File > View or each time you create a backup copy of a Plant the Backup Manager window displays the files archived in the backup file.

By default files are sorted in descending order by date and for each file the following information is available:
Field Name Date/Time Size Packed Ratio Path Description Name of the archived file Date/time when the file was archived Original file size Packed file size Percentage of compression File pathname in the Plant directory

You can customize the information displayed; in particular, you can: Sort the files by user parameters Select the fields to be displayed Change the width of table columns Change the type of character used in the table

1.18.6.27 Sorting the files by user parameters

By default, files are sorted in descending order by date in the Backup Manager window, but you can change the sort order and criteria.

To sort files by user parameters: 1. Select command View > Sort in the Backup Manager environment. The Sort dialog box appears. 2. Select the field used to sort the file list from the Sort items by drop-down list box. 3. Click the Ascending or Descending radio buttons to choose the sorting direction. 4. Click the OK button. 5. The files in the Backup Manager dialog box are automatically sorted according to the new criteria.

1.18.6.28 Selecting the fields to be displayed

By default, Backup Manager displays all the fields and in a system defined order, in the table. Both these settings can be modified by the user.

To choose the fields to be displayed: 1. Select command View > Columns in the Backup Manager environment. The Columns dialog box appears.

SIMATIC IT Services V4.4 SP2 User Manual

89

2. To eliminate a field from the display, select the field name from the Show the following list box and click the <-Remove button (the Name field is mandatory and cannot be removed). 3. To display a field, select the field name from the Available Columns list box and click the Add-> button. 4. To change the order of the fields displayed in the table select the field name in the Show the following list box and click the Move Up or Move Down buttons to move the field towards the top or to the bottom of the list, respectively. 5. To restore all default configurations click the Reset button. 6. Click the OK button. 7. The files in the Backup Manager dialog box are automatically displayed according to the new criteria.

1.18.6.29 Changing the width of table columns

In the Backup Manager window move to the left or right boundary of the column heading. The cursor becomes a line: drag the boundary until the column is the width you want.

You can also do as follows: 1. Select command View > Columns in Backup Manager. The Columns window appears. 2. Select the name of the field of interest in the Show the following listbox and enter a new value (pixel) in the Column Width edit box. 3. Repeat step 2 for all the columns to be modified. 4. Click the OK button.. The selected width is applied to the columns in the Backup Manager window.

1.18.6.30 Changing the type of character used in the table

To change the type of character used in the table: 1. Select command Options > Font in Backup Manager. 2. The standard Font Windows dialog box appears and you can select the font and size. 3. Click the OK button to confirm the options selected. 4. The selected font and size is applied to all the file names displayed in the Backup Manager window.

1.18.6.31 Restoring
1.18.6.32 Restoring a Plant
To restore a Plant: 1. Select command File > Restore in Backup Manager. 2. Select the .ARQ file from which files are to be restored (the file can be located on the local drive, on a remote drive, on diskette, on Iomega Zip or on CD-ROM). Click the Open button. 3. The File list box in the Restore dialog box displays all files which can be restored. By default, all Plant files are selected. In detail, you can: Select the files to be restored Select the Units to be restored Select the Zones to be restored

SIMATIC IT Services V4.4 SP2 User Manual

90

Select the third-party applications to be restored.

4. Select the name of the Plant where files are to be restored from the Plant Name drop-down list box. 5. Click the OK button to start restoring the files.

1.18.6.33 Selecting the files to be restored

To choose the files that you want to restore: 1. In the Restore dialog box, click the file to be restored in the File list box. To cancel a selected file, click the file name in the list box. 2. To select/unselect several files at the same time, hold down the CTRL or SHIFT keys while you click the left mouse button. 3. Click the Select All button to restore all the files. 4. Click the None button to choose to not restore any files.

1.18.6.34 Selecting the Units to be restored

To choose the Units that you want to restore: 1. In the Restore dialog box, click the Unit button. 2. The Unit dialog box displays all the previously archived Units in the Restore Unit list box. 3. In order not to restore a Unit, select the Unit name from the Restore Unit list box and click the <-Remove button. The Unit name is moved to the Unit list box. 4. If you do not want to restore any Unit, click the <-Remove All button 5. For each Unit displayed in the Unit Restore list box, you can select the Project, DataBase and Hardware Configuration check boxes to restore the project, database and hardware configuration files, respectively. 6. Click the OK button. to return to the Restore dialog box.

1.18.6.35 Selecting the Zones to be restored

To choose the Zones that you want to restore: 1. In the Restore dialog box, click the Zones button. 2. The Zones dialog box displays all the previously archived Zones. 3. In order not to restore a Zone, click the Zone name in the list box. 4. If you do not want to restore any Zone, click the None button. 5. To restore all Zones (default), click the Select All button. 6. Click the OK button to return to the Restore dialog box.

1.18.6.36 Selecting the third-party applications to be restored

To choose the third-party applications that you want to restore: 1. In the Restore dialog box, click the Third Party button. 2. The Third Party Applications dialog box displays all the previously archived third-party applications. 3. In order not to restore an application, click the application name in the list box. 4. If you do not want to restore any application, click the None button. 5. To restore all applications (default), click the Select All button. 6. Click the OK button to return to the Restore dialog box.
SIMATIC IT Services V4.4 SP2 User Manual 91

1.18.7 1.18.7.1

Working with Units What is a Unit?

A logical Unit is the bridge between the physical architecture of the system, configured upon definition of the network devices, and the software components that make up SIMATIC IT.

Before executing a number of operations from SIMATIC IT Management Console, such as Database management or Project handling, you need to define the current working Unit: from that moment all operations will apply to that Unit. The table below summarizes the types of Units available:
Type RTDS/IMC User Unit Description Used when you want to configure your workstation to exchange data with one or more third-party device networks and to simulate a virtual P.M.C. Reserved for particular uses. For more information, contact the Technical Support Service Used when you want to read/write from/to an OpenPMC or an Open PMC Lite (in general, all controllers based on TCP-IP). Used to exchange data with a PMC (connected to an Arcnet network) via a SIMATIC IT multihomed workstation connected to an Ethernet network acting as a bridge (thus, supporting both an Arcnet and an Ethernet adapter). Obsolete; maintained only for compatibility with previous versions. Used when you want to read/write from/to one of the available Siemens Orsi Automation P.M.C. control systems. Real Time Data Engine User Unit Used when you want to configure your workstation to exchange data with one or more third-party device network.. Also allows you to define and execute your tasks in SIMATIC IT Real Time Data Engine Manager. Used when you want to read from a RTDS active on a computer that is not present in the SIMATIC IT network configuration (Configuration > Network Configuration), but can be contacted on the physical network. Obsolete; maintained only for compatibility with previous versions. Obsolete; maintained only for compatibility with previous versions.

Session Manager Unit

ControlCORE Unit

Remote Control Unit

Control Unit

RTDS/IMC External Device User Unit

USER UNIT Operator Workstation USER UNIT Host Computer

To each workstation and controller defined in the network configuration one or more than one logical Units can be associated. For instance, each workstation can "host" one or more RTDS/IMC logical Unit, and thus operate as gateway to third-party field devices; you can also associate more than one Real Time Data
SIMATIC IT Services V4.4 SP2 User Manual 92

Engine Unit to the same workstation and thus use the same computer as a process engine for different projects.

Since logical Units are independent of the physical devices defined during network configuration, you can associate a logical Unit to any physical device of the same type (e.g. you can associate a Control Unit to any P.M.C. defined in your network configuration).

1.18.7.2

Configuring a Unit
Unit configuration and management is performed in the SIMATIC IT Management Console environment. You access this environment immediately after logging on to the selected Plant. The SIMATIC IT Management Console provides all the tools required to design, and configure your control and supervisory system.

To define a new Unit select command File > New in SIMATIC IT Management Console. and then simply follow the Wizards prompts. Tips and Help are provided with each stage of the Wizard.

You can configure the following types of Units: RTDS/IMC User Unit Session Manager Unit ControlCORE Unit Remote CONTROL Unit CONTROL Unit Real Time Data Engine User Unit RTDS/IMC External Device User Unit

Note Units USER UNIT Operator Workstation and USER UNIT Host Computer are not described since they are by now obsolete and maintained only for compatibility with previous versions.

1.18.7.3

Modifying the Unit attributes

To change the attributes of a Control or User Unit: 1. Select the icon of the Unit of interest in the SIMATIC IT Management Console window. 2. Select command Edit > Modify. The Attributes dialog box appears and you can change the following attributes of a Control or User Unit: Locreg Database Project device name

SIMATIC IT Services V4.4 SP2 User Manual

93

1.18.7.4

Duplicating a Unit
To make a copy of a Unit: 1. Select the Unit of interest in the SIMATIC IT Management Console window; 2. Select command Edit > Copy. The selected Unit is copied into the Clipboard. 3. The Attributes dialog box appears and you can enter a different device name or change other parameters (locreg, database, project, etc.)

1.18.7.5

Renaming a Unit
To assign a new name to a Unit: 1. Select the icon of the Unit of interest in the SIMATIC IT Management Console window. 2. Select command Edit > Rename .

1.18.7.6

Removing a Unit
To remove a Unit: 1. Select the Unit of interest in the SIMATIC IT Management Console window. 2. Select command Edit > Delete .

Deleting a Unit causes the associated database and project to be removed as well.

1.18.7.7
1.18.7.8

RTDS/IMC User Unit

Why use an RTDS/IMC User Unit?
With an RTDS/IMC User Unit you can configure your workstation to:

Exchange data with one or several third-party device networks. SIMATIC IT applications (SIMATIC IT Graphic User Interface, SIMATIC IT Alarm Manager, SIMATIC IT Plant Data Archive, etc.) can read data from and write data to, the external devices via a temporary memory area called SIMATIC IT Real Time Data Server. Simulate a virtual P.M.C.. From the PDE environment you can create and execute userdefined control applications.

Tip Communications between SIMATIC IT components and third-party devices are to be configured by the user. For more information, see manual Managing Communications with External Devices Users Guide.

If you configure an RTDS/IMC User Unit in programming mode, the Unit can be handled exclusively by the PDE (Programmable Development Environment) module.

Tip For more information, see manual Control Environment Programming Users Guide.

SIMATIC IT Services V4.4 SP2 User Manual

94

1.18.7.9

Configuring the RTDS/IMC User Unit

To configure a RTDS/IMC User Unit: 1. Select command File > New in SIMATIC IT Management Console.

2. Select the Unit type USER UNIT RTDS/IMC and click Next>. 3. In the Attributes dialog box, select the device name of the workstation to be associated to the Unit from the Device Name list box. With this operation data concerning the workstation are assigned to the logical Unit (e.g. node number of the device, IP Address, which is displayed by clicking the Additional Info button or moving the cursor over the device name). 4. Enter the identifier of the logical Unit (alphanumeric string up to 15 characters) in the Logical Unit Name edit box. By default this identifier is the same as the computer name of the workstation. 5. (Optional) Enter a brief description in the Comment edit box. 6. Click the Next > button to configure the Unit in either programming or supervisory mode. 7. Click Finish to save this configuration.

1.18.7.10 Configuring the RTDS/IMC User Unit in programming mode

Configure the Unit in programming mode if you need to use the PDE (Programming Development Environment) environment to create and test user control programs.

To configure a RTDS/IMC User Unit in programming mode: 1. In the Additional Attributes dialog box choose a project name to be assigned to the Unit from the Projects box or edit a new project name. 2. Select the locreg to be assigned to the User Unit from the Locreg listbox. The list shows all the system locregs and locregs created by the user.

1.18.7.11 Configuring the RTDS/IMC User Unit in supervisory mode

Configure the Unit in supervisory mode if the SIMATIC IT Real Time Data Server memory area is to be read/written only by SIMATIC IT applications.

To configure a RTDS/IMC User Unit in supervisory mode: 1. Select the Monitoring only check box in the Additional Attributes dialog box. 2. Choose a database name from the DataBase box or edit a new name. 3. Select the locreg to be assigned to the User Unit from the Locreg listbox. The list shows all the system locregs and locregs created by the user.

1.18.7.12 Configuring the RTDS/IMC User Unit and the network device
To configure a RTDS/IMC User Unit and its network device: 1. Select command File > New in SIMATIC IT Management Console.

2. Select the Unit type USER UNIT RTDS/IMC and click Next>.

SIMATIC IT Services V4.4 SP2 User Manual

95

3. Enter the identifier of the logical Unit (alphanumeric string up to 15 characters) in the Logical Unit Name edit box. By default this identifier is the same as the computer name of the workstation. 4. In the Attributes dialog box, check the Device Configuration box. Select the New Device or Modify Device option button. In the latter case, choose the name of the device you want to modify from the Device Name list box. 5. (Optional) Enter a brief description in the Comment edit box. 6. Click the Next button. 7. The Control Unit device dialog box appears. Enter following data:
Parameter Device Name Action Enter a symbolic name of device to be added to the network (max.15 characters). It is not allowed to use following characters @ # [ ] + - ! $ % & / ( ) = ? ^. Select the type of CPU associated with the device: None: Used exclusively for supervision tasks RTDS/IMC-n: Used to read or write data to non-proprietary PLC networks or other devices. Each type of RTDB_IMC CPU identifies the default locreg which will be assigned to all logical Units associated with this workstation (e.g. CPU type RTDS/IMC1 corresponds to locreg RTDS1). For more information on system locregs, see System Locregs for SIMATIC IT Real Time Data Server. SPV-n: This CPU type is obsolete and is used only for old locregs based on VMS systems

CPU type

8. According to the network you select, you must insert different parameters: Arcnet Session manager

9. Click the Next > button to configure the Unit in either programming or supervisory mode. 10. Click Finish to save this configuration.

1.18.7.13 Parameters (Arcnet)

Parameter Node A Action Enter the node number assigned to the device.

1.18.7.14 Parameters (Session Manager)

Parameter IP Address Action Enter the TCP/IP address of Channel A (and, if necessary, of Channel B) from the Unit you are configuring. For more information on IP Addresses, see Session Manager network parameters Enter the Timeout value(s). This value defines waiting time for receiving acknowledgements of messages and is registered in milliseconds (ms). Note If no value is entered, a default of 200 ms is automatically selected.

Timeout

SIMATIC IT Services V4.4 SP2 User Manual

96

1.18.7.15 Session Manager

1.18.7.16 Why use a Session Manager Unit ?
Reserved for future use.

1.18.7.17 Configuring a Session Manager Unit

Reserved for future use.

1.18.7.18 ControlCORE Unit

1.18.7.19 Why use a ControlCORE Unit ?
A particular new kind of control unit is the ControlCORE unit that can be an OpenPMC or an Open PMC Lite. Its difference from a control unit is that it must belong to the Session Manager network inside the network configuration.

A ControlCORE unit can be defined in hot backup. If so, it is represented by the following icon . A ControlCORE backup unit can only be of the Open PMC type.

1.18.7.20 Configuring the ControlCORE Unit

To configure a ControlCORE Unit: 1. Select the command File > New in SIMATIC IT Management Console.

2. Select the Unit type ControlCORE or ControlCORE-BACKUP and click Next>. 3. Select the device name of the workstation to be associated to the Unit from the Device Name list box. With this operation data concerning the workstation are assigned to the logical Unit (e.g. device name, node number of the device, which is displayed by clicking the Additional Info button or moving the cursor over the device name). 4. Enter the identifier of the logical Unit (alphanumeric string up to 15 characters) in the Logical Unit Name edit box. By default this identifier is the same as the computer name of the workstation. 5. (Optional) Enter a brief description in the Comment edit box. 6. Click the Next > button to configure the Unit in either programming or supervisory mode. 7. Click Finish to save this configuration.

1.18.7.21 Configuring the ControlCORE Unit in programming mode

To configure a ControlCORE Unit in programming mode: 1. In the Additional Attributes dialog box choose a project name to be assigned to the Unit from the Projects box or edit a new project name. 2. Select the locreg to be assigned to the Control Unit from the Locreg listbox. By default SIMATIC IT Management Console assigns a locreg which best suits the CPU of the P.M.C. being configured but you can choose any locreg created by the user.

SIMATIC IT Services V4.4 SP2 User Manual

97

1.18.7.22 Configuring the ControlCORE Unit in supervisory mode

To configure a ControlCORE Unit in supervisory mode: 1. Select the Monitoring only check box in the Additional Attributes dialog box. 2. Choose a database name from the DataBase box or edit a new name. 3. Select the locreg to be assigned to the Control Unit from the Locreg list box. By default, SIMATIC IT Management Console assigns a locreg which best suits the CPU of the device. being configured but you can choose any locreg created by the user.

1.18.7.23 Configuring the ControlCORE Unit and the network device

To configure a ControlCORE Unit and its network device: 1. Select the command File > New in SIMATIC IT Management Console.

2. Select the Unit type ControlCORE or ControlCORE-BACKUP and click Next>. 3. In the Attributes dialog box, check the Device Configuration box. Select the New Device or Modify Device option button. 4. In the Control Unit device dialog box, enter following data:
Parameter Device name Action Enter a symbolic name of device to be added to the network (max.15 characters). It is not allowed to use following characters @ # [ ] + - ! $ % & / ( ) = ? ^. To find out if the inserted device name already exists in the network, button. If so, the device configuration parameters in the click the Control Unit device dialog box will be replaced automatically. IP Address Enter the TCP/IP address of Channel A (and, if necessary, of Channel B) from the Unit you are configuring. For more information on the IP Addresses, see Session Manager network parameters. Enter the Timeout value(s). This value defines waiting time for receiving acknowledgements of messages and is registered in milliseconds (ms). Note If no value is entered, a default of 200 ms is automatically selected. CPU type Select the type of CPU associated with the device: ALL IN ONE OPEN PMC OPEN PMC LITE

Timeout

5. Click the Next > button to configure the Unit in either programming or supervisory mode. 6. Click Finish to save this configuration.

Tip For more information about the ControlCore Configuration Tool, see manual Project Development Environment (PDE) Users Guide

SIMATIC IT Services V4.4 SP2 User Manual

98

1.18.7.24 Remote CONTROL Unit

1.18.7.25 Why use a Remote Control Unit ?
The current version supports the Arcnet/Ethernet bridge. This means that you can use a SIMATIC IT workstation, connected to an Ethernet (TCP/IP) network (provided that it is properly configured), in order to exchange data with a PMC connected to an Arcnet network. The SIMATIC IT workstation must support both an Arcnet and an Ethernet adapter, in order to act as a bridge.

1.18.7.26 Configuring a Remote CONTROL Unit

A Remote Control Unit is used to exchange data with a PMC (connected to an Arcnet network) via a SIMATIC IT multihomed workstation connected to an Ethernet network acting as a bridge (thus, supporting both an Arcnet and an Ethernet adapter). This logical unit must be connected to a PMC Bridge or External PMC Bridge network device.

To configure a Remote Control Unit: 1. Select the command File > New in SIMATIC IT Management Console.

2. Select the Unit type Remote CONTROL UNIT or Remote CONTROL UNIT - BACKUP and click Next>. Note Since the same icons are used to identify Control Units, Remote Control Unit icons are displayed in yellow, in order to avoid misunderstandings. 3. In the Attributes dialog box, enter the following data:
Parameter Logical Unit Name Bridge Description Enter the name which will be used to identify the logical unit. Select a PMC Bridge or a PMC External Bridge device (previously defined in Network Configuration). If the device you select is configured in backup, the check box Bridge B has the highest priority will be enabled. Choose this option in order to use the bridge with lower priority as first choice. Name of the remote PMC with which data is exchanged. Select the type of CPU of the remote PMC device. Optional. Enter a brief description.

Remote PMC CPU type Comment

4. Click the Next> button to configure the Unit in either programming or supervisory mode. 5. Click Finish to save this configuration.

Important To offer greater flexibility SIMATIC IT supports associating the same P.M.C. to more than one logical Control Unit. However upon commissioning each P.M.C. must be associated to ONE logical Control Unit only.

SIMATIC IT Services V4.4 SP2 User Manual

99

1.18.7.27 Configuring a Remote Control Unit in programming mode

You usually configure a Remote Control Unit in programming mode in order to use the PDE Programming Development Environment to create and test control programs.

To configure a Remote Control Unit in programming mode: 1. In the Additional Attributes dialog box choose a project name to be assigned to the Unit from the Projects box or edit a new project name. 2. Select the locreg to be assigned to the Control Unit from the Locreg listbox. By default SIMATIC IT Management Console assigns a locreg which best suits the CPU of the P.M.C. being configured but you can choose any locreg created by the user.

1.18.7.28 Configuring a Remote Control Unit in supervisory mode

To configure a Remote Control Unit in supervisory mode: 1. Select the Monitoring only check box in the Additional Attributes dialog box. 2. Choose a database name from the DataBase box or edit a new name. 3. Select the locreg to be assigned to the Control Unit from the Locreg list box. By default SIMATIC IT Management Console assigns a locreg which best suits the CPU of the P.M.C. being configured but you can choose any locreg created by the user.

1.18.7.29 CONTROL Unit

1.18.7.30 Why use a CONTROL UNIT ?
A control unit represents one of the available Siemens Orsi Automation P.M.C. control systems. Depending on the type of selected controllers, it is displayed and treated in a different way by the system, giving the user the perception of working in an unique environment.

A control unit is represented by the following icon and can be one of the following type of controllers: Tloop,PMC Series 5, PMC Series 8, PMC Series 10, PMC Series 15, PMC Series 20, PMC CP16. You can configure this type of unit only if your network configuration includes one of the above mentioned PMC types.

A control unit can be in hot backup configuration: if so, it is represented by the following icon . A backup control unit can be:PMC Series 10, PMC Series 15, PMC Series 20. As for Control Units, you can configure this type of Unit only if your network configuration includes one of the mentioned PMC types.

Tip For more information on the different PMC types, see the relative manuals.

In addition, if you configure a Control Unit in programming mode, you can make use of the advanced features provided by the PDE Programming Development Environment, to design and execute control programs.

SIMATIC IT Services V4.4 SP2 User Manual

100

Tip For more information, see the Control Environment Programming Users Guide.

1.18.7.31 Configuring the CONTROL Unit

To configure a CONTROL Unit: 1. Select the command File > New in SIMATIC IT Management Console.

2. Select the Unit type CONTROL UNIT or CONTROL UNIT - BACKUP and click Next>. 3. In the Attributes dialog box, select the device name of the P.M.C. to be associated to the Unit from the Device Name list box (this box shows all the P.M.C.s defined during network configuration). With this operation data concerning the P.M.C. are assigned to the logical Unit (e.g., node number of the device, which is displayed by clicking the Additional Info button or moving the cursor over the device name). 4. Enter the identifier of the logical Unit (alphanumeric string up to 15 characters) in the Logical Unit edit box. By default this identifier is the same as the computer name of the P.M.C. 5. (Optional) Enter a brief description in the Comment edit box. 6. Click the Next> button to configure the Unit in either programming or supervisory mode. 7. Click Finish to save this configuration.

Important To offer greater flexibility SIMATIC IT supports associating the same P.M.C. to more than one logical Control Unit. However upon commissioning each P.M.C. must be associated to ONE logical Control Unit only

1.18.7.32 Configuring a Control Unit in programming mode

You usually configure a Control Unit in programming mode in order to use the PDE Programming Development Environment to create and test control programs.

To configure a Control Unit in programming mode: 1. In the Additional Attributes dialog box, choose a project name to be assigned to the Unit from the Projects box or edit a new project name. 2. Select the locreg to be assigned to the Control Unit from the Locreg listbox. By default SIMATIC IT Management Console assigns a locreg which best suits the CPU of the P.M.C. being configured but you can choose any locreg created by the user.

1.18.7.33 Configuring a Control Unit in supervisory mode

To configure a Control Unit in supervisory mode: 1. Select the Monitoring only check box in the Additional Attributes dialog box. 2. Choose a database name from the DataBase box or edit a new name. 3. Select the locreg to be assigned to the Control Unit from the Locreg list box. By default SIMATIC IT Management Console assigns a locreg which best suits the CPU of the P.M.C. being configured but you can choose any locreg created by the user.

SIMATIC IT Services V4.4 SP2 User Manual

101

1.18.7.34 Configuring a CONTROL Unit and the network device

To configure a CONTROL Unit and its network device: 1. Select the command File > New in SIMATIC IT Management Console.

2. Select the Unit type CONTROL UNIT or CONTROL UNIT - BACKUP and click Next>. 3. In the Attributes dialog box, select the Device Configuration check box. Select the New Device or Modify Device option button. In the latter case, choose the name of the device you want to modify from the Device Name list box. 4. Enter the identifier of the logical Unit (alphanumeric string up to 15 characters) in the Logical Unit edit box. 5. (Optional) Enter a brief description in the Comment edit box. 6. Click the Next> button. 7. In the Control Unit device dialog box, enter following data:
Parameter Device Action Enter a symbolic name of device to be added to the network (max.15 characters). It is not allowed to use following characters @ # [ ] + - ! $ % & / ( ) = ? ^. Enter the node number assigned to the device. To be used only for P.M.C. controllers in backup. Enter the node number of the backup node. Select the type of CPU associated with the device.

Node A Node B CPU type

8. Click the Next > button to configure the Unit in either programming or supervisory mode. 9. Click Finish to save this configuration.

1.18.7.35 P.M.C. date & time synchronization

From each workstation, it is possible to synchronize the date and time values of all PMCs connected to the SIMATIC IT network via a "master clock". By default, date&time are synchronized with the date&time configured on the network server .

To perform P.M.C. data & time synchronization: 1. Enter the System Configuration window. 2. Select the Foundation Servers tab. 3. Check the Time Alignment box. 4. Check the Enable PMC Time Alignment box. 5. Date&time will be aligned to the date&time configured on the current network server

1.18.7.36 Real Time Data Engine User Unit

1.18.7.37 Why use a Real Time Data Engine User Unit?
With a Real Time Data Engine User Unit you can configure your workstation to perform data processing tasks on data acquired by diverse devices (Siemens Orsi Automation P.M.C. or third-party PLCs). You can define and execute your tasks within a highly advanced environment
SIMATIC IT Services V4.4 SP2 User Manual 102

called SIMATIC IT Real Time Data Engine Manager. Data is exchanged between SIMATIC IT applications via a temporary memory area called the SIMATIC IT Real Time Data Server.

Tip For more information, see manual Supervisory Environment Programming Users Guide.

You should use this Unit if you need to implement high-level data processing: the environment offered is extremely user-friendly and thus you no longer need to associate a project and a locreg to the Unit since these operations are executed automatically by the system upon creation of the Unit. SIMATIC IT automatically associates a project to a Real Time Data Engine Unit that can be handled only by the SIMATIC IT Real Time Data Engine Manager. Since each Real Time Data Engine Unit handles a single Project you cannot associate the same Project to more than one Real Time Data Engine Unit. The Real Time Data Engine Unit handles a 64Kb memory area called the SIMATIC IT Real Time Data Server. This default size can be increased up to 512 Kb. To change the memory map you need to use the appropriate tool in the SIMATIC IT Real Time Data Engine Manager environment.

1.18.7.38 Configuring the Real Time Data Engine User Unit

To configure a Real Time Data Engine User Unit: 1. Select command File > New in SIMATIC IT Management Console.

2. Select the Unit type USER UNIT Real Time Data Engine and click Next>. 3. In the Attributes dialog box, select the device name of the workstation to be associated to the Unit from the Device Name list box. With this operation data concerning the workstation are assigned to the logical Unit (e.g. node number of the device, IP Address, which is displayed by clicking the Additional Info button or moving the cursor over the device name). 4. Enter the identifier of the logical Unit (alphanumeric string up to 15 characters) in the Logical Unit Name edit box. By default this identifier is the same as the computer name of the workstation. 5. (Optional) Enter a brief description in the Comment edit box. 6. Click Finish to save this configuration.

1.18.7.39 Configuring the Real Time Data Engine User Unit and the network device
To configure a Real Time Data Engine User Unit and its network device: 1. Select command File > New in SIMATIC IT Management Console.

2. Select the Unit type USER UNIT Real Time Data Engine and click Next>. 3. In the Attributes dialog box, enter the identifier of the logical Unit (alphanumeric string up to 15 characters) in the Logical Unit Name edit box. 4. Check the Device Configuration box. Select the New Device or Modify Device option button. In the latter case, choose the name of the device you want to modify from the Device Name list box. 5. (Optional) Enter a brief description in the Comment edit box. 6. Click the Next button.
SIMATIC IT Services V4.4 SP2 User Manual 103

7. The Control Unit device dialog box appears. Enter following data:
Parameter Device Name Action Enter a symbolic name of device to be added to the network (max.15 characters). It is not allowed to use following characters @ # [ ] + - ! $ % & / ( ) = ? ^. Select the type of CPU associated with the device: None: Used exclusively for supervision tasks RTDS/IMC-n: Used to read or write data to non-proprietary PLC networks or other devices. Each type of RTDB_IMC CPU identifies the default locreg which will be assigned to all logical Units associated with this workstation (e.g. CPU type RTDS/IMC1 corresponds to locreg RTDS1). For more information on system locregs, see System Locregs for SIMATIC IT Real Time Data Server. SPV-n: This CPU type is obsolete and is used only for old locregs based on VMS systems.

CPU type

8. According to the network you select, you must insert different parameters: Arcnet Session Manager

9. Click Finish to save this configuration.

1.18.7.40 RTDS/IMC - EXTERN DEVICE User Unit

1.18.7.41 Configuring an RTDS/IMC-EXTERN DEVICE User Unit
To configure a RTDS/IMC EXTERN DEVICE User Unit: 1. Select command File > New in SIMATIC IT Management Console.

2. Select the Unit type USER UNIT RTDS/IMC EXTERN DEVICE and click Next>. 3. In the Attributes dialog box, insert a device name of the workstation to be associated to the Unit in the Device Name box. 4. Enter the identifier of the logical Unit (alphanumeric string up to 15 characters) in the Logical Unit Name edit box. 5. (Optional) Enter a brief description in the Comment edit box. 6. Click the Next > button. 7. In the Additional Attributes dialog box, choose a database name from the DataBase box or edit a new name. 8. Select the locreg to be assigned to the User Unit from the Locreg listbox. The list shows all the system locregs and locregs created by the user. 9. Click Finish to save this configuration.

SIMATIC IT Services V4.4 SP2 User Manual

104

1.19
1.19.1 1.19.1.1

Advanced Configuration
Networks and Communication Monitoring network nodes
If you have configured an Arcnet network, either for supervision or control, you can display the status of the network nodes in real-time and thus obtain an up-to-date scenario of which workstations and P.M.C. controllers are currently connected to the network. To monitor the network nodes in real time: 1. Select command Tools > Network Node Monitor from SIMATIC IT Management Console. This command is enabled only if an Arcnet network has been defined during network configuration. 2. The Network Node Monitor application window shows the following information:

Parameter Computer Info Node A Computer Info Node B Selected Node Info

Description node number assigned to the workstation or P.M.C. controller node number assigned to the backup P.M.C. controller when you select a node number from the grid, this box contains a brief description of the device type connected (e.g. P.M.C. Series 8, P.M.C. Series 10, DEC Station, DOS Supervisor, etc.)

Furthermore, if you select the Displ. Ch. check box, the node numbers of the grid are replaced with the name of the channels used by each node (A, B or both). All single nodes are marked an asterisk. If a backup configuration is available, an asterisk is displayed next to the master node.

1.19.1.2

Rebuilding the network configuration

Important The following procedure will delete the current network configuration, therefore it is strongly suggested to make a copy of it before proceeding

To rebuild the network configuration: 1. Delete the NETDEV.* files in the %\ICUBE.CNF directory. 2. Start SIMATIC IT Services on the primary Foundation Server (master server) without logging on to a plant. 3. Enter the Network Configuration environment by selecting the Configuration > Network Configuration command. 4. Create a new network with all PCs and configure the IP Addresses of both Ethernet adapters. 5. Add all Open PMCs with their regular IP Addresses to the network configuration.

SIMATIC IT Services V4.4 SP2 User Manual

105

6. Log on to your plant, start the server modules and verify that all modules required by your application on the server work properly. 7. Start SIMATIC IT Services on the auxiliary Foundation Server (slave server) without logging on to a plant. 8. Wait several minutes and verify that the Slave has inherited the network configuration from the Master. 9. Shutdown and restart the Slave server, logging on to the plant. 10.On the slave server, start one of the modules that you have launched on the server (ex. SIMATIC IT Real Time Data Server) and wait for it to be synchronous with that of the server. This will function as a backup module. 11. Proceed with the other backup modules, waiting for their complete synchronization before launching the next module. 12.On all client workstations, start SIMATIC IT Services without logging on to a plant. 13.Wait several minutes and verify that the Slave has inherited the network configuration from the Master. 14.Shutdown and restart the Client, logging on to the plant. 15.In SIMATIC IT Management Console environment select the Configuration > System command: the System Configuration dialog box appears. Select the Start-Up tab and add the applications previously removed from the Start-Up area. If necessary, select the Automatic Log-On to Current Plant check box and click OK to exit the dialog box.

1.19.1.3

Time alignment on client workstations

By default, time on the client workstations connected to the SIMATIC IT network is automatically aligned to the time configured on the network server . However, in particular circumstances, the user can configure a different device as a reference computer for time alignment. To perform time alignment on client workstations: 1. Enter the System Configuration window. 2. Select the Foundation Servers tab. 3. Check the Time Alignment box. 4. Select the Foundation Servers option if you want to use the current network server as a reference computer for time alignment. 5. Select the User Configuration option if you want to configure other devices (up to two) as reference computers for time alignment. 6. In the Device 1 combo box, select the first device from those defined in the current Network Configuration. Note If you select an OpenPMC device type, time alignment will be performed using this device as the reference. 7. Select the second workstation (optional) from the Server 2 combo box. 8. Time will be aligned to the time configured on the Device 1. Should this become unavailable, the Server 2 computer, if defined, will become the new reference computer.

Important If, in either case, both Server 1 and Server 2 should be unreachable, the current network server will be used as a reference computer.
SIMATIC IT Services V4.4 SP2 User Manual 106

1.19.1.4

Advanced configurations
From the Plant Management environment, you can start some tools allowing you to carry out advanced configurations, relative to the TCP/IP protocol and the RIS Inter-Process Communication.

Important Use of these tools is reserved to expert users only. It is recommended that you contact Siemens A&D AS MES Technical Support Service for any additional information.

1.19.1.5
1.19.1.6

RIS
RIS Inter-Process Communication Service
SIMATIC IT Services offers an Inter-Process Communication layer (RIS=Redundant IPC Service). This IPC service is used for client/server communication and requires the TCP/IP protocol. The main features provided by this service are: Very fast detection of network failures. Support of redundant supervision networks (please contact Siemens A&D AS MES Technical Support Service for more information)

To be able to use this service, you need to perform the following operations, on ALL SIMATIC IT workstations:

1. Install and configure the TCP/IP protocol 2. Configure networking

1.19.1.7

Configuring networking using RIS IPC

This topic explains how to configure networking using RIS IPC in case of a non-redundant network. In case of a redundant network, see Configuring RIS parameters. For more information, see Configuring a redundant network with two Historian servers in hot backup. SIMATIC IT IPC services use standard Windows naming services. Note All workstations belonging to the SIMATIC IT network can have more than one IP address bound to each adapter, and can have more than one adapter installed. By properly configuring HOSTS files, you can establish on which logical subnet or physical network the communication will flow.

Important If you have more than one IP address bound to a single adapter, it is always advisable to modify the IP address order in the control panel, by setting the IP address on which you want workstations to communicate as first in the list of IP attributes for a card.

SIMATIC IT Services V4.4 SP2 User Manual

107

Important If you have one or more OPMCs, you MUST type IP addresses in the SIMATIC IT network configuration but, anyhow, configurations showed above are always mandatory.

Important If you are using workstations that are DHCP clients (for the supervisory subnet), you MUST NOT fill in the HOSTS file since IP addresses are dynamically assigned.

If you have Wins, DNS or other naming services configured for the supervisory network, it is not always necessary to fill the HOSTS files (each single case should be evaluated).

You must always run TCPTUNE utility to set IP parameters independently from the IPC type used.

The following examples describe a networking configuration at a Windows level, to best support all supervision communications of SIMATIC IT: Two servers in hot-backup configuration with preferential network set for backup communications. Two servers in hot-backup configuration with no preferential network. A single server without backup with two clients.

1.19.1.8

Example
Assume that a server (SRV1) has an adapter installed with the following bound IP addresses: 172.31.2.1 10.10.4.1

Assume that a client (CLI1) has an adapter with the following bound IP addresses: 172.31.2.2 10.10.4.2 200.200.100.2

By setting the server HOSTS file as follows: 172.31.2.2 CLI1 subnet mask: 255.255.0.0 and the client HOSTS file as follows: 172.31.2.1 SRV1 subnet mask: 255.255.0.0 all communications between SIMATIC IT Historian components will flow on subnet: 172.31.0.0

SIMATIC IT Services V4.4 SP2 User Manual

108

1.19.1.9

Example
Assume that a server (SRV1) has two adapters installed with the following bound IP addresses: 172.31.5.1 200.200.100.1

Assume that a client (CLI1) has two adapters with the following bound IP addresses: 172.31.5.2 200.200.100.2

By setting the server HOSTS file as follows: 172.31.5.2 CLI1 and the client HOSTS file as follows: 172.31.5.1 SRV1 the communication between workstations will flow on the Subnet set in the file.

By setting the operations mentioned above, SIMATIC IT Services does NOT use the IP addresses set in the Network Configuration. For this reason, setting just the names of all of the workstations belonging to the same network is enough to allow the system to work.

1.19.1.10 Example - Two servers in hot-backup configuration with preferential network set for backup communications.
1. Assume that the computer names for the two backup servers are SRV1 and SRV2 and CLIx (CLI1, CLI2,etc.) for each client workstation. 2. Assume that the two servers each have a network adapter (A adapter) connecting each other as a preferential network for backup communications, and another adapter (B adapter) to link to clients. 3. Then assume that the IP addresses are: SRV1 (A adapter): 172.31.1.2 SRV2 (A adapter): 172.31.1.3 SRV1 (B adapter):200.200.200.2 SRV2 (B adapter):200.200.200.3 CLI1: 200.200.200.4 CLI2: 200.200.200.5

4. Edit, on all workstations, the file: HOSTS (%\winnt\system32\etc) as follows: The SRV1 HOSTS file will be: 172.31.1.3 SRV2 200.200.200.4: CLI1 200.200.200.5: CLI2

The SRV2 HOSTS file will be: 172.31.1.2:SRV1 200.200.200.4:CLI1

109

SIMATIC IT Services V4.4 SP2 User Manual

200.200.200.5:CLI2

The client HOSTS files will be: CLI1: 200.200.200.2: SRV1 200.200.200.3: SRV2 200.200.200.5: CLI2 CLI2: 200.200.200.2: SRV1 200.200.200.3: SRV2 200.200.200.4: CLI1

As a matter of fact, HOST files declare: the IP address of the preferential network (so communications among them will always flow on that network) on 2 servers, the secondary network on clients

1.19.1.11 Example - Two servers in hot-backup configuration with no preferential network

1. Assume that the computer names for the two backup servers are SRV1 and SRV2 and CLIx (CLI1, CLI2, etc.) for each client workstations. 2. Then assume that the IP addresses are the following: SRV1 :200.200.200.2 SRV2 :200.200.200.3 CLI1: 200.200.200.4 CLI2: 200.200.200.5

3. Edit, on all workstations, the file: HOSTS (%\winnt\system32\etc) as follows: The SRV1 HOSTS file will be: 200.200.200.3: SRV2 200.200.200.4: CLI1 200.200.200.5: CLI2

SRV2 HOSTS file will be: 200.200.200.2: SRV1 200.200.200.4: CLI1 200.200.200.5: CLI2

Client HOSTS files will be: CLI1: 200.200.200.2: SRV1 200.200.200.3: SRV2 200.200.200.5: CLI2 CLI2: 200.200.200.2: SRV1 200.200.200.3: SRV2
110

SIMATIC IT Services V4.4 SP2 User Manual

200.200.200.4: CLI1

1.19.1.12 Example - A single server without backup with two clients

1. Assume that the computer name for the server is SRV1 and for each client workstation is CLIx (CLI1, CLI2, etc.). 2. Assume that the IP addresses are: SRV1 :200.200.200.2 CLI1: 200.200.200.4 CLI2: 200.200.200.5

3. Edit, on all workstations, the file: HOSTS (%\winnt\system32\etc) as follows: The SRV1 HOSTS file will be: 200.200.200.4: CLI1 200.200.200.5: CLI2

The client HOSTS files will be: CLI1: 200.200.200.2: SRV1 200.200.200.5: CLI2 CLI2: 200.200.200.2: SRV1 200.200.200.4: CLI1

1.19.1.13 Configuring a redundant network with two Historian servers in hot-backup

Generally, at least two network adapters are required for each SIMATIC IT workstation. If the priority communication channel (Ch. A) fails and a secondary (backup) communication channel (Ch. B) has been defined, all communications switch to the applications on the backup channel. The secondary-priority switching occurs automatically when the priority channel is restored. Note If, during the correct functioning of communications on Ch. A, a problem on the backup backbone occurs causing a brief disconnection of communications on this channel, and if consecutively a problem on the priority channel occurs, the switching to Ch. B occurs in any case. However it is preceded by a brief network interruption that will be notified to the user applications before the establishment of all communications on Ch. B. This event is highlighted to the user by the appearance of "hashes" on the graphic panels.

1.19.1.14 Example of a configuration of a redundant network with two Historian servers in hot-backup configuration and one client

Important The following procedure cannot be used in an upgrade from a non-redundant to redundant network on a SIMATIC IT running application.

Suppose you have the following configuration:

SIMATIC IT Services V4.4 SP2 User Manual

111

 Master, Slave and Client PCs having two single-channel Ethernet adapters installed (Adapt1 and Adapt2). 2 active Hubs (one for network 1 and the other for network 2). All Adapt1 adapters connected to Hub 1 and all Adapt2 adapters connected to Hub 2. Adapt 1 and 2 will be used for supervision communication. To stand on different networks, both adapters must be configured on each PC as follows: Adapt1: IP Address: 179.29.254.x (x is a different number for each Adapt1 of all PCs) Subnet mask: 255.255.255.0

Adapt2: IP Address: 200.200.1.y (y is a different number for each Adapt2 of all PCs) Subnet mask 255.255.255.0

Note In multi-homed systems it would be possible to have more IP Addresses assigned to each adapter. In this case you must select the address you want to use for supervision communication as primary.

Perform the following actions on all SIMATIC IT workstations on the network: 1. In SIMATIC IT Management Console environment, select the Configuration > System command: the System Configuration dialog box appears. Select the Start-Up tab and remove all applications from the Start-Up area. Deselect the Automatic Log-On to Current Plant check box and click OK to exit the dialog box. Close SIMATIC IT Management Console. 2. Set a redundant configuration via RIS Configuration Wizard 3. Optimize TCP/IP timeouts 4. Rebuild the network configuration

1.19.1.15 Configuring the RIS parameters

To configure RIS parameters, the system comes provided with the RIS Configuration Wizard. Two types of configuration can be performed: automatic and custom. A custom configuration can be either non-redundant or redundant.

Important Since these configurations must be carried out very carefully in order to avoid possible malfunctions, it is recommended that you contact Siemens A&D AS MES Technical Support Service

To configure the RIS parameters: 1. From the Plant Management environment, select command Tools > Advanced > R.I.S. Configuration. 2. From the RIS Configuration dialog box, click the RIS Configuration button: this calls up the RIS Configuration Wizard. 3. Choose the type of configuration you want to perform: Default configuration User-defined (Custom) configuration
112

SIMATIC IT Services V4.4 SP2 User Manual

1.19.1.16 Configuring the RIS parameters (Default)

To configure the default RIS parameters from the RIS Configuration wizard: 1. Select the Automatic option. 2. Click Next. 3. The Default Parameter Settings dialog box is displayed. 4. Click Finish to complete RIS configuration.

1.19.1.17 Configuring the RIS parameters (Custom)

To configure the custom RIS parameters from the RIS Configuration wizard: 1. Select the Custom option. 2. Click Next. 3. Choose the type of custom configuration you want to perform:
To execute: a non-redundant configuration a redundant configuration Select the Non Redundant button and click Next. Move on to step 4. select the Redundant button, enter the number of seconds you want to set as the timeout in TimeoutSec (recommended: >=3; this value must be evaluated on the basis of the networks reliability) and click Next. Move on to step 4.

4. The Insert the Port Number dialog box is displayed. Enter the port number of your choice and click Next to confirm your entry. 5. If you want to change the default IP address, click the Default IP Address Configurator button: a dedicated dialog box is displayed. Enter the Computer name and the addresses of your choice for Channel 1 and Channel 2. Click the Add button. To render your entries effective, click the Apply button and then OK. For Redundant configuration, move on to step 6. For Non Redundant configuration, skip directly to step 7. 6. (Only for Redundant configuration): The IP Address File dialog box is displayed, allowing you to choose how to define the name IP address.
If you select: No Yes Then The network configuration is used. The IPADDR.INI file (static configuration) is used..

Click Next to confirm your selection. Move on to step 7.

7. (For both Redundant and Non Redundant configuration): The Summary Table dialog box is displayed, summarizing all the choices you have made for the RIS parameters. Click Finish to complete RIS configuration.
SIMATIC IT Services V4.4 SP2 User Manual 113

1.19.1.18 IPADDR.INI
This file is generated by the system automatically and must not be edited in any manner whatsoever. It is used in certain circumstances to map computer names to IP addresses.

1.19.1.19 Adding a new FAT Server

Procedure
1. Click the Add new button: this calls up the Add a new FAT server dialog box. 2. In field FAT Server:, enter the name of the FAT Server to be added and click OK. 3. This returns you to the Default settings tab: the FAT Server has been added at the end of the list in the FAT Server: area.

Note
To remove a FAT Server from the list in the FAT Server: area, click the FAT Server to be removed to select it and click the Remove button.

1.19.1.20 TCP/IP
1.19.1.21 Configuring the TCP protocol
When using SIMATIC IT Services and the TCP/IP protocol, Windows has to be properly configured in order to be able to take advantage of the new Inter-Process Communication layer (RIS=Redundant IPC Service). To this end, the system provides an ad-hoc tool, called TcpTune.

To perform TCP protocol configuration: 1. From the Plant Management environment, select command Tools > Advanced > Network Tune. 2. From the TcpTune dialog box, click:
Button Description Recommended for all users. To launch automatic configuration. The parameters are automatically configured in order to provide for best performances when working with the system.

Reserved for expert users only.

To start manual configuration. You can configure all parameters and save their value by clicking button Update. Click button Default to restore the default configuration value for the current parameter.

3. Click Exit to quit. All changes applied will become effective only after restarting the computer.

SIMATIC IT Services V4.4 SP2 User Manual

114

Note You can generate a dump file of the current configuration by clicking button Info and then button Save, in the Network Configuration dialog box. You will be prompted to enter the name of the file where configuration values will be saved.

1.19.1.22 Configurable TCP/IP parameters

Protocol SIMATIC IT Services Parameter HeartBeatFailTimeout Description Delay applied when notifying a connection failure to backup applications. This notification occurs whenever the "alive message" transmission between the two backup servers fails. For internal use only Determines the transmission interval (in milliseconds) of the keep-alive package. This allows the system to detect the so-called "orphan sessions", i.e., sessions considered active by a server application, even if the corresponding client is disconnected. By reducing the transmission interval, the time required to detect a connection failure is also reduced. TCP/IP Protocol TcpMaxConnectRetransmissions Determines how many times TCP retransmits an unanswered request for a new connection. TCP retransmits new connection requests until they are answered, or until this value expires. Changes to this value allow you to reduce the interval required to detect a connection failure, thus, the client switch-over occurs in a shorter time. TcpMaxDataRetransmissions Determines how many times TCP retransmits an unacknowledged data segment on an existing connection. TCP retransmits data segments until they are acknowledged, or until this value expires. This parameter should be configured together with TcpMaxConnectRetransmissions in order to reduce the interval required by the client to perform a switch-over. KeepAlive Time Determines how often TCP sends keep-alive transmissions. TCP sends keep-alive transmissions to verify that an idle connection (i.e. with no data transmission) is still active. Determines how often TCP repeats keep-alive transmissions when no response is received. TCP sends keep-alive transmissions to verify that idle connections are still active. This prevents TCP from inadvertently disconnecting active lines. Sets DisableDHCPMediaSense to 1 Windows contains the "Media
SIMATIC IT Services V4.4 SP2 User Manual 115

AdiMaxTimeoutRetrasmit NetBT Sessions SessionKeepAlive

KeepAlive Interval

DHCP Media Sense Disabled:

Sensing" feature. This feature can be used on a Windows-based computer with TCP/IP to detect whether or not the network media is in a "link state". A "link state" is defined as the physical media connecting or inserting itself on the network. For example, assuming a 10bt or 100bt physical media, Ethernet network adapters and hubs typically have a "link" light to indicate the current connection status. This is the same condition in which Windows can detect a link. Whenever Windows detects a "down" state on the media, it removes the bound protocols from that adapter until it is detected as "up" again. There may be situations where you may not want your network adapter to detect this state, and you can configure this by editing the registry. See Microsoft Windows article Q239924 for more details.

1.19.1.23 Optimizing TCP/IP timeouts

To optimize TCP/IP timeouts: 1. In the %\ICUBESYS\BIN directory, double click the TCPTUNE.exe file. 2. The TcpTune dialog box appears: click the Automatic Tuning button. 3. Click OK to exit the dialog box. 4. Shutdown and restart the workstation.

1.19.1.24 CAB Protocol Configurator

1.19.1.25 Overview of CAB Protocol Configurator

Introduction
CAB Protocol Configurator is a tool used to configure the IPC communication channel for CAB. CAB Clients will use the configuration set via CAB Protocol Configurator on CAB Runtime Server Engine to select the communication channel to be used for the connection between clients and servers present on the Plant. The default protocol is Standard IPC: it must be changed only if the features offered by the HTTP or HTTPS protocol are required.

Configuration types
Two types of configuration can be set using CAB Protocol Configurator: default configuration (mandatory) specific subnet configuration (optional).

SIMATIC IT Services V4.4 SP2 User Manual

116

Running the tool

To run CAB Protocol Configurator, operating in Plant Management, select Configuration > Cab Configuration.

1.19.1.26 Defining the default settings

Introduction
A minimum default configuration must be defined: when CAB Protocol Configurator is launched for the first time; if the configuration database has been removed. The default configuration defines the communication protocol that is used in the absence of a specific subnet configuration for any request not contemplated in the subnet configuration and, if necessary; the Web Server. The supported communication protocols are IPC, HTTP and HTTPS. The default configuration also defines a list of reference FAT Servers used for the connection.

Requirements for minimum default configuration

Minimum default configuration requires: Selecting the default communication protocol (IPC,HTTP,HTTPS); Defining at least one Fat Server. (Only if HTTP or HTTPS has been selected as the default communication protocol) Specifying the IP address of the Web Server where the SITISAPI Extension that provides support to the HTTP or HTTPS protocol is installed.

Procedure
1. In Plant Management, select Configuration > Cab Configuration. This calls up the CAB Protocol Configuration dialog box, with the focus on the Default settings tab. 2. In field Protocol, select the type of protocol you require (default: IPC). Should you choose either HTTP or HTTPS, enter the address of the Web Server in field Web Server IP. 3. In the FAT Server: area, check to see whether the FAT Server(s) you require are listed, and whether they are displayed in the desired order (FAT Servers are processed sequentially in the same order as that in which they are listed).

Important The minimum default configuration requires that at least one FAT Server be entered. In the case of an empty FAT Server list, the system will return to its initial condition without any configuration whatsoever.

4. If necessary, temporarily remove all FAT Servers from the displayed FAT Server list by clicking the undesired items and clicking the Remove button. to permit the insertion of the FAT Servers in the desired order. Likewise, if you need to remove one or more FAT Servers from the FAT Server list, click the FAT Server(s) to be removed to select it and click the Remove button. 5. If necessary, add a new FAT Server.

SIMATIC IT Services V4.4 SP2 User Manual

117

6. Click the OK or Apply button in the CAB Protocol Configuration dialog box so that the changes made become effective.

1.19.1.27 Defining specific subnet settings

Purpose
Permits defining a list of subnets, identified by means of an IP address and a subnet mask. If a communication request coming from a CAB Client concerns a subnet specified in this configuration, the communication system will use the specified protocol and the reference Web Server (if present) for that particular subnet.

Example of behaviour
Configuration: Cli1 Ip 172.31.5.0 Mask 255.255.0.0

Cli2 Ip 200.200.100.100 Mask 255.255.0.0

The Subnets area of the Subnet settings tab lists only one subnet entry, i.e.: Ip Address 200.200.0.0 Subnet Mask 255.255.0.0 Web Server 100.100.100.2 Protocol HTTP

Therefore: When computer Cli2 connects, it will use the HTTP protocol, adopting the machine with IP 100.100.100.2 as ISAPI Provider server. When computer Cli1 connects, it will use standard IPC as the communication protocol.

Requirement for defining subnet settings

To define specific subnet settings, the default settings must already have been defined.

Procedure
1. Upon completing the default configuration, click the Apply button to confirm the changes made in the Default settings tab. 2. Click the Subnet settings tab of the CAB Protocol Configurator dialog box.The Subnets: area lists, in the same order in which they are processed during querying, those subnets for which a particular configuration has been defined, each with the Web Server and the Protocol that will be used (the first time, the list will be empty). 3. To add a new subnet configuration, click the Add new button. This calls up the Add a new subnet dialog box. 4. Enter the data required for the new subnet in fields IP Address and Subnet Mask. Enter the communication protocol to be used in field Protocol and the reference Web Server in field Web Server IP and click OK: this returns you to the Subnet settings tab.

SIMATIC IT Services V4.4 SP2 User Manual

118

5. The new subnet will be added at the bottom of the list in the Subnets: area. 6. The changes made will become effective only after clicking the OK or Apply button in the CAB Protocol Configurator dialog box.

Notes
Dedicated message boxes will be displayed should any errors occur while saving the changes made. In particular, in the case of a wrong configuration, some data may be discarded or not saved: for example, if you attempt to enter two subnets that are identical, the second coinciding subnet will be automatically deleted.

1.19.1.28 Troubleshooting for CAB Protocol Configurator

No default setting has been found on the local system. A default setting is required to permit proper operation; please type a default setting.
This message is displayed the first time that the configurator is started or if the database containing the configuration data has been lost. If you are using CAB Protocol Configurator for the first time, enter a default setting and save the changes made by clicking the Apply button. Then, if necessary, enter the specific settings for the subnets.

Due to an unexpected error, some changes regarding the default settings will not be saved properly.
The changes made to the default settings have not been saved. Relaunch the configuration tool, correct the default settings and reattempt to save the changes made.

The subnet settings have not been saved properly.

The subnet settings have been saved only in part: this may mean that there is a duplicate network that has been discarded automatically and the settings of which have not been saved. Close the application and relaunch it to view the status of the changes made that were written successfully and, if necessary, add new subnets, removing any duplicate ones.

The subnet settings have not been changed.

CAB Protocol Configurator has been started, but only the default settings have been viewed by the user. In this case, the subnet settings remain unchanged: therefore, they will not be modified and then re-saved.

1.19.2 1.19.2.1

Client/Server Architecture Client/Server Architecture

SIMATIC IT has been built on the Windows operating system and makes full use of the network services offered by this operating system. Therefore you can implement a powerful client-server architecture and access the Plant resident on the server workstation from a number of client workstations, defined in your network configuration.

SIMATIC IT Services V4.4 SP2 User Manual

119

Furthermore a distributed client-server architecture makes it possible to subdivide the processing workload among different computers since SIMATIC IT components can run on any workstation, even those on which the Plant is not located.

Important When SIMATIC IT is used in a Client /Server architecture, it uses the Windows user currently logged on. Thus, it is subject to Windows security management. This implies that, if Windows users are part of a Workgroup, it is extremely important to keep user definition congruent on each computer of the SIMATIC IT network.

The following operations must be performed on the server workstation in order to configure a client-server architecture, after having defined the network and created the Plant: on the workstation where the Plant is located: you must share the Plant;

on the client workstations: you must connect to the remote Plant.

These operations are to be executed in the Plant Management environment.

1.19.2.2

Sharing a Plant
In order for client workstations to log on to a remote Plant, the Plant on the server workstation must be shared:

To share a Plant: 1. Select the Plant icon in the Plant Management window. 2. Select command File > Share .

A shared Plant is represented with the standard Windows icon in the Plant Management window. When you share a Plant, the whole Plant directory is actually shared using the Plant name as share name.

Important You are strongly recommended not to share/unshare the drive and/or Plant directory from an external file manager tool (e.g. Windows Explorer).

To cancel Plant sharing, choose command File > Stop Sharing window.

in the Plant Management

SIMATIC IT Services V4.4 SP2 User Manual

120

1.19.2.3

Connecting to a remote Plant

To log on to a remote Plant from a client workstation, you must first connect to the workstation where the Plant is located.

To connect to a remote Plant: 1. In Plant Management, expand the plant tree to find the Plant of interest. 2. Select the plant icon .

You can then open the Plant of interest on the remote workstation.

1.19.2.4

Emergency configuration for SIMATIC IT client workstations

In addition to hot-backup configuration, SIMATIC IT Management Console provides other tools to overcome a possible failure of the server workstation (i.e. the workstation where the Plant is located), so that, in the event that the server workstation crashes or is disconnected from the network, client workstations still have access to Plant data and are able to provide supervisory functions. To make use of this feature you need to configure the client workstations in advanced mode; that is, create an "image" of the Plant on the client drive. This configuration will be deployed by SIMATIC IT Management Console, in the event that the PLANT on the server workstation becomes unavailable after the client workstation has already logged on.

Each client workstation configured in Advanced mode can supply some or all of the following functions: displaying graphic panels displaying historical trends (only if the SIMATIC IT Plant Data Archive server module is running on a workstation other than the Plant server workstation) displaying and acknowledging alarms (only if the SIMATIC IT Alarm Manager server module is running on a workstation other than the Plant server workstation)

SIMATIC IT Management Console copies to the client workstation drive the following files: compiled graphic panels Historian Data Display workspaces AMD workspaces functional keyboard configuration

The above files are maintained in alignment with the corresponding files on the server workstation. SIMATIC IT Management Console replicates such files to all client workstations either when they connect to the Plant , each time the Unit databases or the Zone files are updated ,and every 12 hours.

Note Even during normal operation of the SIMATIC IT Management Console server workstation, client workstations have an advantage from the advanced configuration, because workspaces and configuration files are loaded from the local drive and not from the network, which makes access to information much faster.

SIMATIC IT Services V4.4 SP2 User Manual

121

1.19.2.5

Configuring a client workstation

It is possible to select the files to be aligned on the client workstation and to define their update mode.

To select files to be aligned: 1. On the client workstation, select command Configuration > System in SIMATIC IT Management Console. 2. Click the Plant Configuration tab in the System Configuration window. 3. Check the Advanced box. Please note that this box is disabled on a server workstation! The Advanced area is enabled. 4. Click the Files tab. In the Drives box select the drive where the plant of interest is located. 5. Select the zones to be replicated on the local machine from the Remote zones list box and click the Add-> button. 6. The selected zones are moved to the Local zones list box. 7. By default, SIMATIC IT Management Console replicates all the files (compiled graphic panels, AMD and Historian Data Display workspaces, functional keyboard configuration) related to the selected Zones.

To remove some zone files from the replicate list:

1. Select the Zone of interest from the Local zones list box. 2. Select the file type from the Local files list box. 3. Click the < Remove button. The selected file types are moved to the Remote files list box.

To define the file alignment mode:

Files can be aligned both at pre-defined intervals and on event (i.e. each time data changes). By default files are aligned on event, but you can also configure alignment intervals. 1. On the client workstation, select command Configuration > System in SIMATIC IT Management Console. 2. Click the Plant Configuration tab in the System Configuration window. 3. Check the Advanced box. Please note that this box is disabled on a server workstation! The Advanced area is enabled. 4. Click the Configuration tab. 5. Select:
Option Upon interval alignment box At pre-defined time alignment Description Align files automatically every 12 hours. Align files at pre-defined time intervals.You must enter the exact time when file alignment must start.

1.19.2.6

Disabling file alignment

You can disable the alignment of Plant files on the client workstation according to the following criteria:

SIMATIC IT Services V4.4 SP2 User Manual

122

 If you want to disable the alignment of files each time data changes: 1. On the client workstation, select command Configuration > System in SIMATIC IT Management Console. 2. Click the Plant Configuration tab in the System Configuration window. 3. Check the Advanced box. Please note that this box is disabled on a server workstation! The Advanced area is enabled. 4. Click the Configuration tab. 5. Check the Disable upon change alignment box. In this way, files will be automatically aligned only at the intervals configured by the user. If you want to disable all periodic alignments, edit the BCKUPMNG.CNF file (stored in the drive:\ICUBE.CNF directory of the workstation where the master Plant is located) and set the DISABLE_PERIOD_ALIGNMENT parameter to 1.

1.19.2.7

Filtering files to be replicated

You can define a subset of files to be replicated on the client workstation, by setting appropriate filters.

To do this, you must edit the BCKFILT.INI file located in the drive:\ICUBE.CNF directory of the workstation where the master Plant is located.

For each local plant, a dedicated section is available. The [PLANTn] keyword must be replaced with the name of the Plant whose files will be replicated. Each pathcode refers to a file type. Delete the pathcodes you do not need.

[PLANT1] 225 = *.gr? 516 = *.grw 1025 = *.wk? 1793 = *.wkg

Pathcode 225 = *.gr? 516 = *.grw 1025 = *.wk? 1793 = *.wkg Definition graphic panels graphic workspaces alarm workspaces data workspaces

1.19.3 1.19.3.1

Security Management Security Management

In addition to account and access level management, SIMATIC IT Services provides some additional security features. For further information, see Groups.

SIMATIC IT Services V4.4 SP2 User Manual

123

1. Enter the System Configuration window. 2. Select the Foundation Servers tab. 3. Then proceed according to your needs.

1.19.3.2

Disabling hotkey combinations

SIMATIC IT Services provides some security options, which help you to manage user rights. You can enable/disable for each user account: Hotkey combinations:

Hotkey combination ALT + TAB ALT + SHIFT + TAB CTRL + ESC ALT + ESC Winkey CTRL + ALT + DEL

Description Commonly used to switch forward between programs. Commonly used to switch backward between programs. Commonly used to display the Start menu and to move the focus to taskbar. Commonly used to display the next window. Commonly used to shortcut access the Start button or other Windows NT functions . Commonly used to begin the process of logging on or off. For more information, see Disabling Ctrl+Alt+Del.

Task Manager utility (used to control the programs running on your computer and to monitor your computers performance)

1.19.3.3

Disabling Ctrl Alt Del

Windows security allows you to disable the sequence of the CTRL ALT DEL keys only after replacing the DLL called MSGINA.DLL (Graphical Identification and Authentication).

The DLL provided by SIMATIC IT Services is called orsigina.dll. There are other commercial products, which can replace this DLL. Therefore, SIMATIC IT Management Console will verify the presence of this DLL and will ask the user if he can replace it with its own one, if necessary.

To disable this sequence of keys: 1. Check the Subst default msgina.dll (Need NT restart) box. The Disable CTRL+ALT+DEL check box will be activated. 2. Check the Disable CTRL+ALT+DEL box.

1.19.3.4

Automatic Windows Logon

When you quit SIMATIC IT Management Console with option Automatic Windows Logon, you can configure the user name and password which will be used for the automatic logon, next time you restart the system.

SIMATIC IT Services V4.4 SP2 User Manual

124

To configure the automatic Windows logon: 1. Enter the System Configuration window. 2. Select the Security tab. 3. Enter the following data in the Automatic Windows Logon area:
Field Default User Default Domain Default Password Confirm Password Description Unique name identifying the user account to Windows. Domain in which the account participates. Password required for the user to log on to Windows. Can be up to 14 characters, and is case-sensitive. Type again the password to check if you entered it correctly.

1.19.3.5

Impersonate User
Impersonation occurs when one user takes on the security attributes of another. This option has not been implemented yet.

1.19.4 1.19.4.1

External components Adding third-party components to the Client menu

To add third-party components to the Client menu: 1. Enter the System Configuration window. 2. Select the Third Party Applications tab. 3. Click the Add button. 4. In the Add Application dialog box, select the Third Party Add-On Application option and click OK. 5. In the Add on dialog box, select the directory where the third-party component file (.ADN extension) is stored. This file is supplied with the third-party component. Select Open button. 6. Click OK to add the component name to the Client menu in SIMATIC IT Management Console.

Important If you want to remove a previously installed third-party component click the Remove button. To delete the directories created in the Plant and used by the component, click the Directories button.

1.19.4.2

Structure of .ADN files

SIMATIC IT Services comes provided with an example file (GENERIC.ADN, found in the BIN directory) to aid the user in structuring an .ADN file to permit the addition of third-party applications (and their relative resources).

Important
SIMATIC IT Services V4.4 SP2 User Manual 125

Structuring and editing .ADN files must be performed solely by expert users. Removing an .ADN file results in the elimination of the associated third-party application and its resources.

The contents of example file GENERIC.ADN are given below, with a description of its main keys.

Sections and keys:

[Application Info] ID=33 Name=GNR

Path=C:\ICUBESYS\BIN\GENERIC.EXE StartUp=Yes PlantDir=GENERIC

Numerical identifier of the Third-Party application Name of the Third Party applications license
Complete path of the executable Indicates if the user wants the application to be configured for Automatic Startup. The name of a directory (if present) inside the Plant that is dedicated to the Third-Party application. Working directory of the application. Any input parameters required by the application Indicates if the application must be supported by a particular Unit. Indicates if the application must be supported by a particular Zone. Not used Indicates whether the application requires a license Indicates whether the application must be integrated with GUI Maximum number of instances of the application that can be launched at the same time Number of resources associated to the application. For each resource, a [Resource Info] section must be added at the end of the .AND file.

WorkingDir=C:\STE\PROVE InputPar= UnitInfo=NO ZoneInfo=NO ToolButton= Licensed=Yes GMS=Yes MaxInst=2

RESNO=n

Important The following sections contain keys ENG and ITA. To view the keys in the other available languages, add the same keys with ESP = <string in Spanish>, FRA = <string in French>, DEU = <string in German>, when compiling the .ADN files.

[Short Description] ENG=Generic App ITA=Appl. Generica

SIMATIC IT Services V4.4 SP2 User Manual

126

[Extended Description] ENG=Generic Application ITA=Applicazione Generica

[Menu Item]
ENG=Generic Third Party Application ITA=Applicazione di Terze Parti Generica Menu item that will appear under Client menu in English Menu item that will appear under Client menu in Italian

[Menu Help]
ENG=Starts a generic third party application String that described the menu item in English ITA=Lancia una applicazione di terze parti generica String that described the menu item in Italian

[PlantDir Description] ENG=Generic Application Files ITA=File per Applicazione Generica

[Resource Info 1]
ID= ENG= ITA= Numerical identifier of the applications resource Name of the resource in English Name of the resource in Italian

[Resource Info n] ID= ENG= ITA=

Important There will be as many [Resource Info] sections as there are specified in key RESNO of section [Application Info]. For example, if RESNO = n, there will be n [Resource Info] sections.

1.19.4.3

Starting the third-party modules

The third-party modules have been developed by Siemens A&D AS MES in co-operation with other companies in order to meet particular requirements of an automation system and thus are tightly integrated into the SIMATIC IT system.

Important
SIMATIC IT Services V4.4 SP2 User Manual 127

To start third-party modules from SIMATIC IT Management Console you must add the module name to the Client menu. For more information, see Adding third-party modules to the Client menu.

1.19.4.4

Adding custom components to the Client menu

Custom components are general-purpose programs that can be added to Client menu in Management Console.

To add custom components to the Client menu: 1. Enter the System Configuration window. 2. Select the Third Party Applications tab. 3. Click the Add button. 4. In the Add Application dialog box, select the Custom/Standard Application option and click OK. 5. In the Add Custom Application dialog box, enter the following data:
Parameter Menu Item Help String Command Line Working Directory Add custom application to startup applications Description Name to be assigned to the user component. This name will be displayed in the Client menu. Brief description which will be displayed in the status bar. Optional. Name of the executable program, without path. Directory where the component files are stored. Check this box if you want to insert the component name in the list of the components that can be activated upon system startup. Then, if you want to start the component automatically, you must add this component to the Startup Configuration. For more information, see Starting SIMATIC IT components automatically.

6. Click OK and then click Close to add the component name to the menu. 7. To change the configuration parameters of the component, click the Modify button. To delete the custom component, click Remove.

1.20
1.20.1

Troubleshooting Tools
Alerter service
The SIMATIC IT system automatically generates diagnostic messages concerning the activity of your workstation: each time an alert is generated, a message box appears and prompts you to either view or ignore the message. You can later view these messages with command Services > Alerter in SIMATIC IT Management Console or by selecting the Services tab in SIMATIC IT Management Console, expanding the System folder and double-clicking Alert Service. The Messages dialog box lists the most recent messages generated during the current working session.

SIMATIC IT Services V4.4 SP2 User Manual

128

Check the Show only errors box to display only messages concerning the failure of some operations. If you clear this box, the system also lists warning and general diagnostic messages. Click OK to close the dialog box.

1.20.2
1.20.2.1

Log File Viewer

Overview of Log File Viewer
The SIMATIC IT Log File contains all error and warning messages related to operations performed on your workstation. When you start the Log File Viewer, the contents of the system log file are displayed in the Log File Viewer window.

You can view: Application log files Log files created on other workstations

You can view log files only if your user name has been associated to the Administrators group (or to an equivalent group owning the Access to Administrative Tools resource).

1.20.2.2

Structure of log file messages

Each message displayed in the Log File Viewer window contains the following items: event type (icon and description). date and time when the message was generated name of the application which generated the message message with the event description name of the connected user computer name of the workstation on which the message was generated PID (Process identifier) TID (Thread identifier) Process

The first column also displays an icon, indicating the messages level of priority or urgency. The following icons are possible:
Icon Label ERROR WARNING INFO SUCCESS AUDIT Message description Local error (i.e. one that is easy to recover from, as it will only affect the current routine or function) A problem that is not actually an error (e.g. unexpected parameters or conditions) An informational message that reports neither problems nor errors Access to the system completed successfully

SIMATIC IT Services V4.4 SP2 User Manual

129

FAILURE AUDIT USER DEBUG MANDATORY FATAL ERROR

Access to the system failed (Intended for internal use) An event that can easily be filtered out without affecting anything else (Intended for internal use) An event that can easily be filtered out without affecting infos, warnings, or errors Text that must appear in the trace file, regardless of the current trace filter (e.g. headlines) An error that will affect the whole system and likely prevent proper recovery

1.20.2.3

Starting the Log File Viewer

To start the Log File Viewer, depending on the environment in which you are currently working, proceed as follows:

Environment Plant Management SIMATIC IT Management Console

Select Tools > Log File Viewer tab Tools > Log File Viewer Or > Tools > Log File Viewer

1.20.2.4

Updating log file messages

To update the list of messages with the most recent messages generated by the system: 1. Select command File > Refresh, press key F5 or click the Refresh button File Viewer toolbar. in the in Log

2. The list of messages is updated with the most recent messages generated by the system.

1.20.2.5

Displaying details of a message

To display the details of a log message: 1. Select the message of interest in the Log File Viewer window. 2. Double click the message. 3. The Event Properties dialog box appears. 4. To view the details of the event which precedes or follows the current event in the list, click the or buttons to view the previous or the following events respectively. button.

5. To copy the details of the event into a .txt file, click the 6. To go back to the Log File Viewer window click the OK button.

For each message, the following details are displayed:

Parameter File Date Time User Description Name of the log file Date when the message was generated. Time when the message was generated. Name of the connected user
130

SIMATIC IT Services V4.4 SP2 User Manual

Event Type Application Process Name Computer PID TID Description

Event identifier. This code is assigned by each SIMATIC IT application and cannot be modified by the user. Name of the application which generated the message Name of the process/server Computer name of the workstation on which the message was generated Process identifier Thread identifier Message written by the application

1.20.2.6

Environment: Customize the Log File Viewer window

To customize the Log File Viewer window: 1. Select the View > Customize command in Log File Viewer or click the Customize button in the toolbar, the Customize dialog box appears. 2. In the Log File Viewer window, select the desired caption field and drag and drop it into the Customize dialog box. Note Only the Application field is impossible to drag and drop. 3. The field disappears from the main window and it is shown in the Customize dialog box. 4. Repeat for every field you want to hide. 5. The system keeps these settings also after the file is closed. 6. To undo the operation, select the fields into the Customize dialog box and drag and drop them to the Log File Viewer window.

1.20.2.7

Environment: Arranging windows

When you open several windows at the same time, it may be useful to arrange them in the working area.

These windows can be arranged in the Log File Viewer window by selecting/clicking the following commands/buttons.
Command/Button Window > Cascade Description Resizes and arranges the active trend windows on the screen one on top of the other, in such a way that the title bar of each window is visible. Assigns the same size to the trend windows displayed on the screen and arranges them horizontally. Assigns the same size to the trend windows displayed on the screen and arranges them vertically. Arranges the minimized windows in the bottom of the Log File Viewer window. Opens the Windows dialog box and allows to select the windows to organize. Moves the selection of every active window to event with more similar time than the selected window.

Window > Tile Horizontally Window > Tile Vertically Window > Arrange Icons

Window > Windows View > Synchornize windows

SIMATIC IT Services V4.4 SP2 User Manual

131

1.20.2.8

Environment: Arranging the selected windows

The Windows dialog box allows you to arrange only the desired windows selecting them from the Windows List. Perform the following operations: 1. Select the Window > Windows command in Log File Viewer or click the Windows button in the toolbar, the Windows dialog box appears. 2. The Select window list box shows a list of all the activate windows currently present in Log File Viewer. 3. Select the desired window in the Select window list box and choose:

Select Button Activate OK Close window Tile Horizontally

To Enable and display the selected window in the foreground with respect to the other windows found in Log File Viewer. Accept the changes and exit. Close the selected window. Assign the selected windows on the screen with the same dimensions, arranges them horizontally and minimizes the non selected windows. Assign the selected windows on the screen with the same dimensions, arranges them horizontally and minimizes the non selected windows.

Tile Vertically

1.20.2.9

Environment: Hiding messages

You can perform this operation only in the files saved by the user (not in the system file or in the third-party application files). This command allows you to hide the selected item (one or more) but

To hide a message: 1. Select the messages you want to hide. 2. Do one of the following operations: Select the View > Hide command in Log File Viewer. Or Select Hide button in the toolbar. Press the DEL key.

The selected message is hidden but, if you refresh or filter the file, it is displayed again.

1.20.2.10 Environment: Showing hidden messages

The Hide functionality allows you to hide the selected item, never cancel or remove it. To show the hidden messages: Select the File > Refresh command in Log File Viewer, press the F5 key or select the Refresh button in the toolbar. Select the View > Filter command in Log File Viewer or the Filter button in the toolbar and apply a filter to the file. In both cases, the hidden messages will be shown again.
SIMATIC IT Services V4.4 SP2 User Manual 132

1.20.2.11 Environment: Configuring the message display time

You can configure the date/time used by Log File Viewer to display the log file messages. Messages can be displayed either according to the default date/time of your workstation or according to the date/time configured by the user.

1.20.2.12 Environment: Setting the local time

To set the local time: 1. Select command View > International in Log File Viewer or click the International button in the toolbar. The International dialog box appears. 2. Click one of the following radio buttons
Select File Time Zone Other Time Zone: Local Time Zone World Time Zone Display log file messages according to the local time zone Display log file messages according to the time shifting configured by the user in the combo box. To Display log file messages according to the time zone of the country where such messages were generated

3. Click the OK button to exit.

1.20.2.13 Applying filters

By default, SIMATIC IT Management Console displays all the columns regarding the event. Now it is possible to order each column separately by clicking the caption field of the column. In this way, you can sort it in descending or ascending order. . With command View > Filter or clicking the Filter button different filtering parameters in the Filter dialog box: Filtering by date Filtering by priority level Filtering by application Filtering by advanced criteria Filtering by description in the toolbar, you can set

To restore default configurations, click the Default filter button. To remove the filter currently applied to the list and display all messages contained in the current log file, click the Default filter button in the Log File Viewer toolbar.

1.20.2.14 Filtering by the description

To filter the events by description:
SIMATIC IT Services V4.4 SP2 User Manual 133

1. Select command View > Filter or click the Filter button the Filter dialog box appears.

in the Log File Viewer toolbar;

2. Check the Message check box to expand the field and show the filter criteria. 3. Select:
Check box Message Text Case Sense March whole word only If You want to write the exact text You want to match only the case you entered You want to match only the whole word and not part of it

4. Click the Filter button to apply the filter. Note To reset all the filter fields, click the Default filter toolbar. Remember that the filters can be combined together. button in the Log File Viewer

1.20.2.15 Filtering by date

To filter the events by date: 1. Select command View > Filter or click the Filter button the Filter dialog box appears. in the Log File Viewer toolbar;

2. Check the Date check box to expand the field and show the filter criteria. 3. In the From button choose First Event to display all messages starting from the first contained in the log file or Events On to set the date and/or time starting from which messages are to be displayed. 4. In the To button choose Last Event to display all messages up to the end of the log file or Events On to set the date and/or time starting from which messages are to be displayed. Note In both cases, to modify the date, type it directly or select the day, month and year in the calendar below. To modify the time, click the appropriate arrow of the spin button to increase or decrease this value. 5. Click the Filter button to apply the filter. To reset all the filter fields, click the Default filter Remember that the filters can be combined together. button in the Log File Viewer toolbar.

1.20.2.16 Filtering by priority level

To filter the events by priority level: 1. Select command View > Filter or click the Filter button the Filter dialog box appears. in the Log File Viewer toolbar;

2. Check the Priority Level check box to expand the field and show the filter criteria. Click the check boxes relative to the types of interest (Fatal Error, Error, Warning, Information, Audit Succes, Audit Failed, Debug, User, Mandatory). For more information, see Structure of log file messages. 3. Click the Filter button to apply the filter. Note To reset all the filter fields, click the Default filter toolbar.
SIMATIC IT Services V4.4 SP2 User Manual

button in the Log File Viewer

134

Remember that the filters can be combined together.

1.20.2.17 Filtering by advanced criteria

To filter the events by advanced criteria: 1. Select command View > Filter or click the Filter button the Filter dialog box appears. in the Log File Viewer toolbar;

2. Check the Advanced Criteria check box to expand the field and show the filter criteria.
Parameter Process User Computer Description Name of the process/server User name Computer name of the workstation on which messages were generated

3. Click the Filter button to apply the filter. Note To reset all the filter fields, click the Default filter toolbar. Remember that the filters can be combined together. button in the Log File Viewer

1.20.2.18 Filtering by application

To filter the events by application: 1. Select command View > Filter or click the Filter button the Filter dialog box appears. in the Log File Viewer toolbar;

2. Check the Application check box to expand the field and show the filter criteria. The list box on the left side shows all the available applications, click the or buttons to add the selected application or all the applications respectively. To delete them from the list box on the right side, click the or all the applications respectively. or buttons to remove the selected application

3. Click the Filter button to apply the filter. button in the Log File Viewer Note To reset all the filter fields, click the Default filter toolbar. Remember that the filters can be combined together.

1.20.2.19 Finding a message in the log file

To quickly find messages in the log file, use command View > Find press CTRL+F or click the Find button Priority Level Application Advanced Criteria Message
SIMATIC IT Services V4.4 SP2 User Manual 135

in the Log File Viewer toolbar.

In the Find dialog box, check the find criteria you want to apply:

When the search options are set, click the Find Next button to start the search or Close to close the window without searching.

To continue the search, select the View > Find Next command, press the F3 key or click the Find Next button in the Log File Viewer toolbar. The system will display the next occurrence that matches with the search criteria.

To search the previous item, select the View > Find Previous command, press the SHIFT + F3 in the Log File Viewer toolbar. The system will keys or click the Find Previous button display the previous occurrence that matches with the search criteria.

1.20.2.20 Priority Level search option

To find an occurrence by priority level: 1. In the Find dialog box, enabled the Priority Level check box to expand the field and show the search criteria. Click the check boxes relative to the types of interest (Fatal Error, Error, Warning, Information, Audit Succes, Audit Failed, Debug, User, Mandatory). For more information, see Structure of log file messages. 2. Click the Find Next button to start the search. 3. The system highlights the row that matches with the search criteria.

1.20.2.21 Application search option

To find an occurrence by application: 1. In the Find dialog box, enabled the Application check box to expand the field and show the search criteria. The list box on the left side shows all the available applications, click the or buttons to add the selected application or all the applications respectively. buttons to

To delete them from the list box on the right side, click the or remove the selected application or all the applications respectively. 2. Click the Find Next button to start the search. 3. The system highlights the row that matches with the search criteria.

1.20.2.22 Advanced Criteria search option

To find an occurrence by advanced criteria: 1. In the Find dialog box, enabled the Advanced Criteria check box to expand the field and show the search criteria.
Parameter Process User Computer Description Name of the process/server User name Computer name of the workstation on which messages were generated

2. Click the Find Next button to start the search.

SIMATIC IT Services V4.4 SP2 User Manual

136

3. The system highlights the row that matches with the search criteria.

1.20.2.23 Message search option

To find an occurrence by message: 1. In the Find dialog box, enabled the Message check box to expand the field and show the filter criteria. 2. Select:
Check box Message Text Case Sense March whole word only If You want to write the exact text You want to match only the case you entered You want to match only the whole word and not part of it

3. Click the Find Next button to start the search: the system highlights the row that matches with the search criteria.

1.20.2.24 Working with log files

1.20.2.25 Opening a log file
When you access the Log File Viewer the system displays, by default, all messages stored in the log file generated by the system (the System Log File option in the File menu is checked). To open an application log file, see Viewing application log files. To open a generic log file, see Viewing archived log files. The File menu also displays the last four opened files.

1.20.2.26 Viewing archived log files

To view archived log files: 1. Select command File > Generic Log File in Log File Viewer. 2. Choose the name of the archived file of interest in the Open dialog box. 3. Click the OK button.

The system displays the names of all log files located in the SIMATIC IT configuration directory (by default ICUBE.CNF). But you can view log files located in any directory of the local workstation and on any workstation configured in the SIMATIC IT network.

1.20.2.27 Viewing application log files

To view application log files: 1. Select command File > Application log file. The Select Private log file dialog box appears. 2. Select the name of the application which generated the messages from the Application drop-down listbox. 3. The Log File Viewer shows the selected file and the System Log File option in the File menu is unchecked.

SIMATIC IT Services V4.4 SP2 User Manual

137

4. Click the OK button.

All messages stored in the selected log file are displayed in the Log File Viewer window. Private log files are generated by SIMATIC IT applications such as Alarms, Historical Trends, Graphic User Interface, Real Time Data Server, etc.

1.20.2.28 Viewing remote log files

To view remote log files: 1. Select command File > Select computer in Log File Viewer; the Select Computer dialog box appears. 2. Do either of the following: Or Select the computer name defined in the network configuration from the Select computer list box (Note This list is composed by the computer names set in Plant Management.) 3. Click OK to continue. All messages contained in the remote log file are displayed in the Log File Viewer window. Type the computer name of the workstation in the Computer list box.

1.20.2.29 Saving a log file

You can save the log messages currently displayed in a file with .LOG extension using command File > Save as or clicking the Save As button in the Log File Viewer toolbar. By default the file is saved in the ICUBE.CNF directory on the local or on a remote workstation, but you can choose another directory.

You can also export, e.g. save, the list using the File > Export List command in Log File Viewer or clicking the Export List button in the toolbar. The Save As dialog box appears and it is possible to save the list as a file with .csv or .txt extension. By default the file is saved in the ICUBE.CNF directory on the local or on a remote workstation, but you can choose another directory.

1.20.2.30 Printing a log file

To print a log file: 1. Select the command File > Print or the Print button in the Log File Viewer toolbar, the Print dialog box appears. 2. In the Print range area: Choose All to print all the displayed events. Choose Selection to print the selected events

3. Click the Custumize button, the Page Setup dialog box allows you to select the columns you want to print: Choose Visible Columns to print the current Log File Viewer visible columns. (The area below is totally disabled)

SIMATIC IT Services V4.4 SP2 User Manual

138

Choose Select Columns to print only the visible columns on the right side list box. To select them, use the following buttons: to add all the events to the lsit box, list box, to add the selected event to the list box, to remove the selected event from the

to remove all the events selected from the list box.

Click the Default button to print the default events. Click OK to accept the print settings and come back to the Print dialog box.

4. Click OK to print and exit.

1.20.2.31 Overwriting the system log

Important This tab is enabled only when the System.log file is activated.

The file containing the system log can become quite large and this might slow down the system. In order to prevent the file from becoming too large, you can define the properties of the log file with command File > Properties. In the Properties dialog box, select the Log Setting tab, where you can Configure the log size Configure the overwriting mode

You can restore the default configuration by clicking the Default button, that is: file size 256 kb; file is overwritten only if necessary (Overwrite if necessary)

1.20.2.32 Configuring the log size

Important This tab is enabled only when the System.log file is activated.

To configure the maximum log size: 1. Select command File > Properties in Log File Viewer, in the Properties dialog box, select the Log Setting tab. 2. Enter the maximum size (Kb) of the log file in the Maximum log size combo box, or click the arrows of the spin button. The default size is 256 Kb and can be incremented by 64 Kb blocks up to 5120 Kb.

1.20.2.33 Configuring the overwriting mode

Important This tab is enabled only when the System.log file is activated.

To configure the overwriting mode of the system log file:

SIMATIC IT Services V4.4 SP2 User Manual 139

1. Select command File > Properties in Log File Viewer, in the Property dialog box, select the Log Setting tab. 2. In the Log Size area, click one of the following radio buttons to configure the overwriting mode:
Select Overwrite events as needed Overwrite events older thandays Do not overwrite events To Start overwriting messages when the log file has reached the maximum configured size. Start overwriting messages after the configured number of days has expired. However, when the file reaches the maximum size, messages will no longer be registered. Prevent the file from being overwritten. When the file reaches the maximum size, messages will no longer be registered.

3. Click the OK button to confirm this operation or the Restore Defaults button to maintain the old configuration.

1.20.2.34 Displaying information on the log file

Important This tab is enabled only when the System.log file is activated.

The File > Properties command displays the Properties dialog box, in the General tab you can see the following information about the current log file:
Field Log Name Size Created Modified Last Abnormal Termination Server Version File Version Maximum Number of Events Description Name of the current log file Dimension of the current log file Date/time when the file was created Date/time when the file was updated Date/time when SIMATIC IT Management Console terminated abnormally Reserved system information Reserved system information Maximum number of messages which can be stored in the file

1.20.2.35 Removing log messages

To remove messages contained in the system log file: 1. Select the File > Properties command or click the Properties button in the Log File Viewer toolbar. 2. In the Properties dialog box, select the Log Setting tab. 3. Click the Clear Log button to clear the log file. The system shows a dialog box to confirm this option. 4. Select Yes to clear or No to return to the previous dialog box. 5. Click OK to accept and exit. You can create a backup copy of the file before removing the messages.

SIMATIC IT Services V4.4 SP2 User Manual

140

Important Messages contained in log files saved by the user can be neither edited nor deleted.

1.20.2.36 Configuring Categories

A category is a parameter which defines the importance of each message and is used by the system to determine whether the message should be archived or not. The higher the number, the higher the messages priority. SIMATIC IT applications assign an appropriate category number to each message according to its severity. You can configure a threshold value for each SIMATIC IT application, above which the message is archived. The default threshold value is 500.

If you choose a category value greater than or smaller than the default value, the number of messages archived into the system log decreases or increases, respectively. You can modify the category only for messages archived in the system log file but not in the log files created by SIMATIC IT applications. Therefore, private log files contain all error messages generated by the application independent of their category.

To restore the previous category configuration, click the Restore button.

1.20.2.37 Defining the category value

Important This tab is enabled only when the System.log file is activated.

To define the category value: 1. Select command File > Properties in Log File Viewer or the Property button in the toolbar. The Properties dialog box appears. 2. Select the Categories tab. 3. Select the application of interest from the Application drop-down list box. 4. Double click the application name and enter the category value in the Category drop-down list box. 5. Click OK to accept the changes and exit or Restore to undo the changes and restore the old configuration.

1.20.2.38 Disabling message archiving for an application

To disable the archiving of messages for a specific application: 1. Select command File > Properties in Log File Viewer or click the Properties button in the toolbar. The Properties dialog box appears. 2. Select the Categories tab and then the application of interest from the Application dropdown list box. 3. Click the Save As button to save the new configuration in a file with .CNF extension (the default file is SYSTEM.CNF) and then select the Save button to go back to the Properties dialog box. 4. Click OK to exit.

SIMATIC IT Services V4.4 SP2 User Manual

141

1.20.2.39 Loading a category configuration file

To load a category configuration file: 1. Select command File > Properties in Log File Viewer or the Properties button in the toolbar. The Properties dialog box appears. 2. In the Properties dialog box, select the Categories tab 3. Click the Load button to load a previously saved .CNF file. 4. All files with .CNF extension, stored in the ICUBE.CNF directory (or any other directory previously configured to hold SIMATIC IT configuration files) are listed. 5. Select the file of interest in the File name window and click the Open button. 6. The selected file is loaded. 7. Click the OK button in the Properties dialog box to exit.

SIMATIC IT Services V4.4 SP2 User Manual

142

Text Editor

Text Editor

2.1
2.1.1

Overview
Overview of Text Editor
With the Text Editor you can create and edit text files of the following types: text file (.txt) Iter source files (.src, .inc) server configuration files (.txt, .csv)

Important If you start the Text Editor from SIMATIC IT Management Console and then edit an Iter source file, the functions used to access the Points Database (such as browsing, inserting variables, ...) are not available. These functions are provided only if you use the Text Editor within one of the SIMATIC IT programming environments (PDE or SIMATIC IT Real Time Data Engine). The Match Brace command however is available in all environments.

In the latter case the Text Editor provides additional features typical of a source program editor (access to the Points Database, ...)

The Text Editor window has two areas: the upper area is reserved for the user for text editing operations whereas the bottom area, also called Output Window , is used by Text Editor to display search results or error messages.

2.1.2

Starting the Text Editor from SIMATIC IT Management Console

To access the Text Editor from SIMATIC IT Management Console, select command Tools >Text Editor .

In the Text Editor application window, the name of the Plant to which you are currently connected appears in the Project bar.

SIMATIC IT Services V4.4 SP2 User Manual

143

Text Editor

2.2
2.2.1

Working with text files

Creating a new file
When you start the Text Editor, the program opens by default an empty text file called Text1.txt. You can later save the file with a different extension. To create a new file: 1. Select command File > New in Text Editor.

2. In the File type dialog box, select one of the following options: Text Iter Source Server Configuration

3. Click OK. An empty page appears. The Textn.eee label is displayed in the title bar, where n is a progressive number and eee corresponds to the extension of the selected file.

2.2.2

Opening a file
To open a file in Text Editor: 1. Select command File > Open ; the Open dialog box appears.

2. By default, all the files with .txt extension stored in the \Plant Name\TEXT directory are listed; however, this configuration can be modified by the user. For more information, see Choosing the default file type. 3. Select the file you want to edit from the default directory or from any other directory, either on your workstation or on a remote workstation. 4. Click OK to open the selected file.

2.2.3

Saving a file
To save the current file, choose commands Save or Save as from the File menu.

You can save the file in any supported format; by default the file is saved in text format, but you can change this configuration. For more information, see Choosing the default file type.

Files are saved in standard Ansi format. For more information on how to save the files in Unicode format, see Choosing the default file type and Configuring the Save options.

2.2.4

Printing a file
To print the file you are editing, choose command File > Print Windows dialog box for setting printing attributes is displayed. in Text Editor. The standard

To preview the text before printing, select command File > Print Preview

SIMATIC IT Services V4.4 SP2 User Manual

144

Text Editor To choose the default printer, select command File > Print Setup. The standard Windows dialog box for choosing the default printer is displayed.

2.2.5

Closing a file
To close the file you are editing, select command File > Close or click the Close button in the upper-right corner of the document window.

2.3
2.3.1

Editing text files

Standard Editing operations
The following standard commands can be selected from the Edit menu:

Command Cut Copy Paste Delete Select All

Description Deletes the selected text and copies it into the Clipboard. Copies the selected text into the Clipboard Copies the text from the Clipboard to the file, starting from the cursor position. Removes the selected text Selects all the file

And also:
Cancels the most recent command or action executed Repeats the most recent command or action executed

Edit > Undo Edit > Redo

2.3.2

Tabs and spaces

To insert/remove spaces and tabs, the following commands are available:

Command Edit > Insert Space Edit > Erase Space TAB

Description Inserts a space at the beginning of the selected line/s Removes a space at the beginning of the selected line/s Inserts a TAB at the beginning of the selected line/s or at the cursor position

Important Each TAB corresponds to the number of spaces configured by the user (by default this number is 4).

SIMATIC IT Services V4.4 SP2 User Manual

145

Text Editor To set tabs: 1. Select command Tools > Editor Options and click the Editor tab. 2. In the Tab Settings area, enter the number of spaces that defines a TAB in the Tab Stops box. 3. Click OK.

Click the Insert Spaces or Keep Tabs buttons to define SPACE or TAB, respectively, as the default character used to fill the space between column zero and the beginning of the text in each row. This option is required since the Text Editor allows you to start writing text on a row from a column other than zero.

2.3.3

Advanced Editing operations

The following advanced editing options are available on the Edit menu:

Command Advanced > Make Selection Upper Case Advanced > Make Selection Lower Case Fill Delete Row

Description Replaces the selected text with uppercase letters Replaces the selected text with lowercase letters Fills the selected block with user-defined text Removes all the text from the cursor position up to the end of the line

And also:
Cancels the most recent command or action executed Repeats the most recent command or action executed

Edit > Undo Edit > Redo

2.3.4

Selecting a horizontal block of text

To select a horizontal block of text: 1. Move the pointer to the beginning of the row you want to select. 2. Drag down up to the number of rows you want.

2.3.5

Selecting a vertical block of text

To select a vertical block of text: 1. Move the pointer to the beginning of the text you want to select. 2. Hold down the ALT key and drag up to the block size you want. 3. Release the ALT key and the mouse button.

SIMATIC IT Services V4.4 SP2 User Manual

146

Text Editor

2.3.6

Filling a selection
To fill a selection: 1. Select a vertical block of text: Move the pointer to the beginning of the text you want to select. Hold down the ALT key and drag up to the block size you want. Release the ALT key and the mouse button.

2. Select command Edit > Fill. 3. In the Fill dialog box, enter:
Parameter Text Description Alphanumeric string to be used to fill the field. The string is truncated if it is longer than the selected field or block size. The string is always aligned to the left. If the block you select already contains characters, these are replaced with the text entered by the user. To insert a number in any position within a string, type the # symbol where the number (any number of digits) is to be inserted. Type the \ character before the number sign # (i.e. \#) to display the # character instead of a digit. Automatic increment Click this check box only if a right-aligned number is to be inserted at the end of the string. The number will be automatically incremented in each record. First number to be incremented. Step to be applied to increment the number. If you click this check box, the program will insert as many leading zeros as required to reach the digit indicated in the subsequent Number of digits field. See description below. Total number of digits to be inserted, including leading zeros.

Start from Step Leading zero

Number of digits

4. Click OK.

2.3.7

Keys available in Text Editor

Main Cursor Movement Keys

Press PAGE DOWN PAGE UP END HOME CTRL + CTRL + CTRL + CTRL + CTRL + PAGE DOWN CTRL + PAGE UP To Scroll the file one window down Scroll the file one window up Move the pointer to the end of the line, including spaces and TABs Move the pointer to the beginning of the line or to the first character other than space or TAB Scroll the file up but not move the pointer Scroll the file down but not move the pointer Move the pointer right to the first valid character Move the pointer left to the first valid character Move the pointer to the bottom of the window Move the pointer to the top of the window
147

SIMATIC IT Services V4.4 SP2 User Manual

Text Editor
CTRL + HOME CTRL + END Move the pointer to the beginning of the file Move the pointer to the end of the file

Main Editing Keys

Press DEL BACKSPACE CTRL + BACKSPACE CTRL + Y SHIFT + arrow keys To Delete character after the pointer Delete character before the pointer Delete the current line See CTRL + BACKSPACE Select a horizontal block of text

2.4
2.4.1

Finding and replacing text

Finding and replacing
SIMATIC IT Text Editor provides all the standard Find and Replace commands of a common Windows editor.

2.4.2

Finding text in the current file

To find text in the current file: 1. Select command Edit > Find in Text Editor. The Find dialog box appears.

2. Enter the text to be found in the Find What box. 3. Select the following options, if required:
Option Match Whole Word Only Match Case Direction Up Direction Down Description If you check this box, the Text Editor will find only complete words If you check this box, the Text Editor will find only text with the specified capitalization (case-sensitive). If you click this button, the Text Editor will search text only from the current line to the beginning of the document. If you click this button, the Text Editor will search text only from the current line to the end of the document.

4. After setting the options of interest:

Click Find Next Set Bookmarks on All To Start searching for the first occurrence of the text Insert a bookmark next to each line that matches the specified search criteria.

To find the next text occurrence that matches the search criteria, click the toolbar.
SIMATIC IT Services V4.4 SP2 User Manual

button in the

148

Text Editor

2.4.3

Finding and replacing text in the current file

To find and replace text in the current file: 1. Select command Edit > Replace in Text Editor; the Replace dialog box appears. 2. Enter the text to be found in the Find What box. 3. Enter the text to be replaced in the Replace With box. 4. Select the following options:

Option Match Whole Word Only Match Case Replace in Selection Replace in Whole File

Description If you check this box, the Text Editor will find only complete words If you check this box, the Text Editor will find only text with the specified capitalization (case-sensitive). The text is replaced only in the selected file The text is replaced in the whole file

5. Click the Find Next button to find the first occurrence of the text and then click Replace. Or click the Replace All button to replace all the occurrences of the text at a time.

2.4.4

Finding text in more than one file

To find the same text in more than one file: 1. Select command File > Find in Files appears; in Text Editor; the Find in Files dialog box

2. Enter the text to be found in the Find What box. 3. In the Files/file types combo box, insert the file names or the file types where text has to be searched. 4. In the In folder box, select the folder where the files have to be searched. Click the button to use the browser. 5. Select the following options:
Option Match Case Look in subfolder Description If you check this box, the Text Editor will find only text with the specified capitalization (case-sensitive). If you check this box, the Text Editor will also search in the subfolder.

Match Whole Word Only If you check this box, the Text Editor will find only complete words

6. Select the Advanced>> button if you need to search in specific files. 7. Select the file/s where text has to be searched from the File Name list box. You can choose files from various directories. Click the Add button to insert each file in the Selected Files box. Click the Add All button if you want to insert all the files stored in the current directory in the Selected Files box. 8. Click Find.

Search results are displayed in the Output Window. For each text occurrence, the corresponding file name and line number are reported.

SIMATIC IT Services V4.4 SP2 User Manual

149

Text Editor To view the text in the file where it has been found: 1. Double click the line in the Output Window, or right-click the Output Window and choose command Go to Tag from the shortcut menu. 2. The file containing the selected text is opened at the corresponding line.

Important The Output Window must be enabled for the search results to be displayed. For more information, see Displaying/hiding the Output Window.

2.4.5

Finding and replacing text in more than one file

To find and replace text in more than one file: 1. Select command File > Replace in Files ; the Replace in Files dialog box appears.

2. Enter the text to be found in the Find What box. 3. Enter the text to be replaced in the Replace With box. 4. Select the following options:
Option Match Whole Word Only Match Case Description If you check this box, the Text Editor will find only complete words If you check this box, the Text Editor will find only text with the specified capitalization (case-sensitive).

5. Select the file/s where text has to be searched from the File Name list box. You can choose files from various directories. Click the Add button to insert each file in the Selected Files box. Click the Add All button if you want to insert all the files stored in the current directory in the Selected Files box. 6. Click Find to search a single text occurrence at a time. The following buttons are available:
Click Skip Replace Replace All Skip File To Not replace the current text and go to the next occurrence. Replace the current text. Replace all the text occurrences in the current file. Not replace any text occurrence in the current file and open the next file.

2.4.6

Locating text in the file

To quickly locate text in the current file, you can choose: command Edit > Go To to locate the line number you have entered. commands Previous Bookmark or Next Bookmark from the Search menu to locate a line previously marked with a bookmark.

To add/remove a bookmark:
SIMATIC IT Services V4.4 SP2 User Manual 150

Text Editor 1. Go to the line to be marked. 2. Select command Edit > Bookmarks > Toggle in Text Editor

To add more bookmarks: 1. Select command Edit > Find 2. Enter the search attributes. 3. Click the Add Bookmark button. 4. All the lines that match the search criteria are marked. in Text Editor.

To remove all bookmarks, select command Edit > Bookmarks > Clear All.

2.5
2.5.1

Customizing the working environment

Showing/hiding toolbars
To show/hide the toolbars, perform the following operations:

Select command View > Toolbars > System Information

To Show/hide the System Information bar. This bar displays the name of the Plant to which you have logged on. Show/hide the Standard toolbar. Show/hide the status bar.

View > Toolbars > Standard View > Status Bar

2.5.2

Showing/hiding the Output Window

By default the Text Editor shows the Output Window when you create a new file or edit an existing file.

To hide the Output Window: 1. Right click the Output Window. A shortcut menu appears. 2. Select the Hide command.

To display the Output Window: Select command View > Output Window or press keys ALT+7

To clear the contents of the Output Window: 1. Right click the Output Window. A shortcut menu appears. 2. Select command Clear.

SIMATIC IT Services V4.4 SP2 User Manual

151

Text Editor

2.5.3

Choosing the default file type

When you start the Text Editor, all operations (creating, opening, deleting, saving, ...) are executed by default on .txt file types. You can however configure a different file type supported by the Text Editor. To change the default file extension, so that all operations are automatically executed on the file type you choose, do as follows: 1. Select command Tools > Editor Options in Text Editor. 2. In the Options dialog box click the Files tab. 3. In the File Type area choose one of the available options: Text (.txt) Source Iter(.src, .inc) Server Configuration (.csv, .txt) All Files

4. Click OK.

2.5.4

Choosing the default save format

By default all files are saved in standard Ansi format, but the Text Editor also supports the Unicode format. To choose the default saving format, do as follows: 1. Select command Tools > Editor Options in Text Editor. 2. In the Options dialog box click the Files tab. 3. In the Save area choose one of the following options: Ansi Unicode

4. Click OK.

2.5.5

Configuring the Save options

Backup copy When you save a file the Text Editor creates by default a backup copy with .old extension. To enable/disable this option do as follows: 1. Select command Tools > Editor Options in Text Editor. 2. In the Options dialog box, click the Editor tab. 3. In the Save Settings area, check/uncheck the Enable Backup box. 4. Click OK.

Automatic saving Each time you execute a find and replace operation on a file, all files currently open are automatically saved so that the program can search the last version of the files. To enable/disable this option do as follows:

SIMATIC IT Services V4.4 SP2 User Manual

152

Text Editor 1. Select command Tools > Editor Options in Text Editor. 2. In the Options dialog box, click the Editor tab. 3. In the Save Settings area, check/uncheck the Save Before Running Tools box. 4. Check the Prompt Before Saving Files box to display a message before automatically saving each file. 5. Click OK.

2.5.6

Setting Colours
You can choose a different colour for each of the following items:

Item Bookmark Comment Current Tag Output Window Source Text Source Keyword String Text Selection User-defined Keywords

Description Bookmark Comment inserted by the user in an Iter file. Line found during file searching (command File > Find in Files) Window where the results of a Find in Files or Replace in Files command are displayed. Text in a document. Reserved keyword in a .src file Text surrounded by inverted commas Selected text User-defined keyword in a .src file

1. Select command Tools > Editor Options and click the Colors tab. 2. Select the item you want to configure from the Set Colors for list box. 3. Select the colour to be assigned to the item from the colour palette. You can choose a different colour for the Text and the Background of each item. 4. Click OK.

2.5.7

Defining user keywords

You can define significant text in your document as a keyword and thus display it in a different colour.

To define user keywords: 1. Select command Tools > Editor Options and click the User Keywords tab. 2. Enter the text in the Keyword box. 3. Choose the keyword type: CSV (Server configuration file) Iter PMC (Iter source file) used for PMC Iter RTDS (Iter source file) used for RTDS

4. Click the Add button to insert the keyword in the Keyword List.
SIMATIC IT Services V4.4 SP2 User Manual 153

Text Editor 5. Repeat steps from 3 to 5 to insert other keywords. 6. Click OK.

2.5.8

Setting the default font

By default the text you type in a Text Editor document appears in Courier New with size 10. However you can select any Windows supported font as default font.

To set a new default font: 1. Select command Tools > Editor Options and click the Fonts tab. 2. The standard Windows dialog box for configuring font type and size is displayed. 3. Select the attributes of the default font for your documents and click OK.

2.5.9

Configuring the search options

You can configure some options as default for all your searches. In the Find dialog box, you can change these choices.

To configure the search options: 1. Select command Tools > Editor Options and click the Search tab. 2. Select the following options:
Option Match Whole Word Only Match Case Direction Up Direction Down Prompt before resuming search from end or beginning of file Description If you check this box, the Text Editor will find only complete words If you check this box, the Text Editor will find only text with the specified capitalization (case sensitive). If you click this button, the Text Editor will search text only from the current line to the beginning of the document. If you click this button, the Text Editor will search text only from the current line to the end of the document. When the program reaches the end of the document it asks you if you want to continue searching at the beginning of it. Select Yes to continue No to end the search. If you dont want to have this confirmation prompted, uncheck the box.

SIMATIC IT Services V4.4 SP2 User Manual

154

Hot Backup

Hot Backup

3.1
3.1.1

Overview
Hot Backup
SIMATIC IT Historian provides a number of tools that help you overcome emergency conditions; such as the failure of the server workstation where the Plant and the SIMATIC IT server modules (Alarm Manager, Plant Data Archive, Event Manager, etc.) are running. One of these tools is known as "hot backup" and allows you to replicate Plant and/or server module files on to an additional server workstation (called "Auxiliary Master") in a completely transparent mode. In the event that the Plant, or a server module on the Primary Master workstation becomes unavailable, the client workstations connect automatically to the Auxiliary Master workstation, where the Plant and/or server modules, which were in "slave" status, start running in "master" mode.

For a detailed description of the procedures required to configure a pair of SIMATIC IT servers in hot backup, see Configuring hot backup for SIMATIC IT plants and applications.

3.1.2

Useful tips on hot backup

The slave server is automatically aligned by the master server. The Backup Switch Tool indicates when the slave server is synchronous, that is, the moment in when the files and the memory areas have been aligned. Immediately afterwards the slave server is ready to accept manual switching.

Important It is strongly recommended to start and configure the master server first, and then start the slave server, in order to have correct alignment of the latter.

During alignment you cannot: recreate, edit and delete the server configuration. insert, modify and delete points. restart alignment.

If the master stops working during slave alignment, the slave cannot switch to master since the configuration files have not been thoroughly aligned. In this case, when the master is restarted, slave alignment will be correctly completed.

SIMATIC IT Services V4.4 SP2 User Manual

155

Hot Backup

3.1.3

Monitoring the backup status

With the Backup Switch Tool you can monitor the status of the Plants and of the server modules running on the pair of workstations configured in hot backup (primary and auxiliary master).

Choose command Tools > Backup Switch Tool in SIMATIC IT Management Console. The Backup Switch dialog box shows two icons, which represent the pair of workstations, and their computer names.

Icons are displayed next to each workstation and to each module, with the following meaning:
Icon Meaning Module/Plant in Master status is running Master module is in asynchronous status (i.e. it is being initialized). Module/Plant in Slave status is running and ready to switch to Master Module/Plant in Slave status is not synchronous (i.e. not yet ready to switch to Master) Transition status (from Slave to Master when a manual switch is performed, from Master to Slave upon reconnection of two Masters) Module/Plant not running

Additional information is available if you display the Module/Plant status.

3.1.4

Backup status
Right-click the computer name or the server-module name in the Backup Switch window to display the status of the Plant/module. The following table lists the various status types and their meaning in relation to the Plant/module in backup mode:

Status Master Slave No active Slave asycr Backup switching Error Master initializing Unknown

Description The Plant/module in Master status is running. The Plant/module in Slave status is running. The Plant/module has not been started yet. The Slave module is being aligned by the Master module. The application is in Master/Slave switching status. The application is not running. The Master is starting up and is not yet ready to align the Slave. Due to network errors, it is impossible to determine the server status.

In the case of a server module, the following additional information is available:

SIMATIC IT Services V4.4 SP2 User Manual

156

Hot Backup Application name switching mode (automatic / manual); computer name of the pair of workstations configured in hot backup; status of the Plant located on each workstation.

3.2
3.2.1

Configuring servers in hot backup

Configuring hot backup for SIMATIC IT plants and applications

Important To configure server workstations in hot backup, the following configurations are MANDATORY:
SIMATIC IT components must be running on the same workstation on which the Plant is located; SIMATIC IT and all its accessories (e.e. RTDS communication drivers) must be installed on the same disk partition and in the same path, both on the Primary Master and the Auxiliary Master.

For a hot-backup configuration to operate correctly you need to follow these procedures carefully step by step: 1. Create the Plant on the SIMATIC IT server that will be configured as Primary Master. 2. Define the hot backup servers as Foundation Servers, by entering their computer names in the Foundation Servers list. 3. Configure the hot backup servers as Primary and Auxiliary Master, by entering their computer names in the Primary and Auxiliary Master list. 4. Configure the SIMATIC IT server modules which will support hot backup. 5. Complete the SIMATIC IT system configuration on the Primary Master computer. 6. Start the SIMATIC IT server modules on the Primary Master computer. 7. Complete the Plant backup configuration by: Creating a backup copy of the Plant on the Primary Master Restoring it on the Auxiliary Master.

Please remember that you will have to update the computer names of all SIMATIC IT Real Time Data Server/IMC Units on the Auxiliary Master. 8. Share the Plant on both Primary and Auxiliary Master workstations with command File > Share in Plant Management.

9. In this manner, files will be automatically copied between Primary and Auxiliary Master computers. 10.Configure, if required, additional files to be automatically replicated (e.g. zones, projects).

SIMATIC IT Services V4.4 SP2 User Manual

157

Hot Backup

3.2.2

Configuring hot-backup servers as Primary and Auxiliary Master

To configure hot backup you need to define two computers in the network acting as: Primary Master Auxiliary Master

It is recommended that the above workstations are chosen from among the previouslyconfigured Foundation servers .

1. Enter the System Configuration window. 2. Select the Modules Backup tab. 3. Please note that if this command is disabled, your SIMATIC IT workstation has probably been configured in stand-alone mode. For more information, see Enabling SIMATIC IT stand-alone start-up. 4. Select the computer name of the workstation to be configured as Primary Master from the Primary Master drop-down list box. 5. Select the computer name of the workstation to be configured as Auxiliary Master from the Auxiliary Master drop-down list box. 6. Click the Add button to insert the selected computer names in the Primary MasterAuxiliary Master list box. 7. Click OK.

Important You can configure several pairs of hot-backup servers, provided that the same computer name is not used more than once in different pairs.

3.2.3

Removing hot-backup servers

1. Enter the System Configuration window. 2. Select the Modules Backup tab. 3. Select the pair of computer names to be removed from the Primary Master - Auxiliary Master list box. 4. Click the Delete button. 5. Click OK.

3.2.4

Modifying hot-backup servers

1. Enter the System Configuration window. 2. Select the Modules Backup tab. 3. Select the computer name of the workstation to be configured as Primary Master from the Primary Master drop-down list box. 4. Select the computer name of the workstation to be configured as Auxiliary Masterfrom the Auxiliary Master list box.

SIMATIC IT Services V4.4 SP2 User Manual

158

Hot Backup 5. Click the Change button to insert the selected computer names in the Primary Master Auxiliary Master list box. 6. Click OK.

3.2.5

Configuring SIMATIC IT applications hot-backup

SIMATIC IT provides hot-backup facilities for the following server modules: SIMATIC IT Alarm Manager (Alarm Management) SIMATIC IT Plant Data Archive (Historical Archiving Management) SIMATIC IT Event Manager (Event Management) SIMATIC IT Real Time Data Server SIMATIC IT Report Manager (Report Manager)

1. Enter the System Configuration window. 2. Select the Modules Backup tab. 3. Select the applications to be configured in backup in the Application List list box. 4. Click the Add-> button to move the selected applications in the Selected Applications list box. 5. Click OK. Then start the server modules on both Primary and Auxiliary Master. The modules assume master and slave status on the configured Primary and Auxiliary Master workstations, respectively.

3.2.6

Configuring the Plant hot backup

In order for your hot-backup configuration to operate correctly you need to create the same Plant on both Primary and Auxiliary Master workstations.

1. On the Primary Master workstation start SIMATIC IT Management Console and run the Backup Manager tool (command Tools > Backup Manager SIMATIC IT Management Console). 2. Archive the Plant. For more information, see Archiving a Plant. 3. Restore the Plant on the Auxiliary Master workstation. For more information, see Restoring a Plant. in Plant Management or

Then you must share the Plant on both Primary and Auxiliary Master workstations with command File > Share in Plant Management.

Upon completion of the above operations SIMATIC IT Management Console begins replicating the following files to the Auxiliary Master. For more information on how file replication is performed, see Replication of files between primary and auxiliary masters.

SIMATIC IT Services V4.4 SP2 User Manual

159

Hot Backup

3.2.7

Replication of files between primary and auxiliary masters

The primary master replicates automatically databases and Zone files to the auxiliary master, which guarantee the provision of supervisory functions in backup mode: Zone directories, and, for each Zone: Compiled Graphic Panels AMD Workspaces Historian Data Display Workspaces Unit Databases

Replication is performed: every 12 hours, if no changes are applied upon event, that is, each time the Unit databases or the Zone files are updated

Moreover, the user can configure the replication of additional Zone and Project files at customized intervals, as follows: 1. Select command Configuration > System from SIMATIC IT Management Console and then choose the Plant Configuration tab. 2. In the Files replication area, check the Zone and Project boxes you want to replicate. The tree structure allows you to easily navigate between files in the current Plant. 3. Click the arrow buttons in order to increase / decrease the Replication period, i.e., the time interval at which files will be copied from the primary to the auxiliary master. The replication period can range from a minimum of 30 minutes to a maximum of 24 hours, and can be incremented by 30 minute intervals. 4. Click Apply to save changes and OK to quit the dialog box.

Important All those files for which it is not possible to configure automatic replication must be copied manually between Plants. For more information, see Copying Plant directories.

3.2.8

Copying Plant directories

If programming functions, in addition to supervisory functions, are to be replicated on the Auxiliary Master, you must copy the relative files/directories to the Auxiliary Master workstation and keep them aligned with any changes made (on the Primary Master). SIMATIC IT Management Console does not perform this operation automatically.

To copy Plant files to the Auxiliary Master, use the Backup Manager tool in Plant Management or SIMATIC IT Management Console.

Important You must copy and restore files manually each time the files of interest change, in order for the Primary and Auxiliary Master to be maintained in constant alignment.

SIMATIC IT Services V4.4 SP2 User Manual

160

Hot Backup

3.3
3.3.1

Master-slave switching
Overview of master-slave switching
Hot backup guarantees complete supervisory functions of the SIMATIC IT server modules in the event that one of the applications becomes unavailable. The SIMATIC IT Management Console hot backup feature also handles more complex situations such as the subdivision of the network into two separate subnets, each comprising a Plant and one or more server modules.

During normal operation, only the server module in master status performs all functions, that is, reads, handles and archives data, and maintains the slave server in alignment. The slave server module is notified of all the changes that occur on the master and waits for a possible failure of the master module. As the slave configuration and data files mirror the corresponding files on the master, and master and slave modules are kept constantly aligned, in the event of master failure, the slave can immediately replace the master and all its functions. The time required to align the slave is variable since it depends on the size of the configuration and data files.

In the event of master-slave switching, SIMATIC IT clients previously connected to a master Plant which is no longer available, automatically log on to the new master Plant, as soon as switching has completed successfully. Please note that a SIMATIC IT client can log on ONLY to a Plant currently in master status. Client modules (SIMATIC IT Alarm Manager Display, SIMATIC IT Historian Data Display, etc.) also connect automatically to the corresponding server modules in master status, as soon as master-slave switching has completed successfully

SIMATIC IT components and Plants in hot backup configuration can assume one of the following states: master: standard operation mode. Only one server module is running. master with synchronous slave: both master and slave server modules are running. The slave is completely aligned and ready to switch to master status. master with asynchronous slave: the master module starts running again after a network interruption and the slave is not aligned, or, master-slave alignment is in progress.

An asynchronous slave cannot switch to master until it has been completely aligned, whether the request is issued by the Backup Switch Tool (user request) or by SIMATIC IT (failure of the master module).

3.3.2

Plant Master-Slave Switching

Master-Slave switching occurs automatically when: the master Plant or the workstation where the Plant is located becomes unaviable a network error occurs

SIMATIC IT Services V4.4 SP2 User Manual

161

Hot Backup

Important Upon Plant startup, the Plant which is first activated assumes Master status, be it located on the Primary Master or on the Auxiliary Master workstation.

3.3.3

When the master disk is unavailable

When the Plant currently in master status becomes unavailable or the workstation where the Plant is located crashes, the slave Plant takes on its role and becomes the master. This switching is notified to all client workstations with a message (Switch primary master disk successfully terminated), ONLY if this option has been configured on each client workstation (select command Configuration > System > Workstation tab, and check the box Enable Switch Primary Master Disk Notification). Otherwise master-slave switching occurs but the operator is not notified.

When the former master starts working again, the former slave Plant which has become master, maintains this status.

3.3.4

Example: when the master disk is not available

Scenario You have configured a pair of workstations (e.g. OMEGA and LAMBDA) as Primary Master and Auxiliary Master. Then you start the DEMO Plant on the OMEGA workstation (which becomes the MASTER) and the other DEMO Plant on the LAMBDA workstation (this Plant becomes the SLAVE).

Should the DEMO Plant in MASTER status suddenly become unavailable (because the OMEGA workstation crashes or shutdown is performed, etc.) the DEMO Plant on the LAMBDA workstation assumes MASTER status. When the DEMO Plant on the OMEGA workstation again becomes available, it assumes SLAVE status, and the DEMO Plant on the LAMBDA workstation maintains the MASTER status.

3.3.5

When a network error occurs (Plants)

If a network error occurs between two SIMATIC IT server workstations, and communications between Plants configured in hot backup are no longer possible, then there will be two Plants in master status, running on the Primary Master workstation and on the Auxiliary Master workstation, respectively. When communications between SIMATIC IT servers are reestablished, the Plant located on the Primary Master workstation maintains the MASTER status, independent of previous configurations.

3.3.6

Application Master-Slave Switching

Master-Slave switching occurs automatically when: the master Plant or the workstation on which the Plant is located becomes unavailable a network error occurs

SIMATIC IT Services V4.4 SP2 User Manual

162

Hot Backup

Important Upon application start-up, the SIMATIC IT server application which is first activated assumes master status (and maintains this status), be it located on the Primary Master or on the Auxiliary Master workstation.

Note To configure the server module running on the Primary Master to assume Master status, you need to perform this operation manually from the Backup Switch Tool environment.

3.3.7

When the master application is unavailable

In the event that the SIMATIC IT server application currently in master status becomes unavailable, or the workstation where the module is running crashes, the slave server application automatically assumes the role of master.

When the previous master is reactivated, it automatically assumes the role of slave, while the current master maintains this role. To restore the initial roles you must perform this operation manually using the Backup Switch Tool.

3.3.8

Example: when the master application is not available

Scenario You have configured a pair of workstations as primary and auxiliary master (in this example, OMEGA and LAMBDA, respectively). Then you start SIMATIC IT Alarm Manager (AM) and SIMATIC IT Plant Data Archive (PDA) modules on OMEGA and they assume MASTER status, whereas the SIMATIC IT Alarm Manager and SIMATIC IT Plant Data Archive modules on LAMBDA assume SLAVE status.

Should the SIMATIC IT Alarm Manager module currently in MASTER status become suddenly unavailable, the SIMATIC IT Alarm Manager module in SLAVE status running on LAMBDA assumes the role of MASTER. When the SIMATIC IT Alarm Manager on the OMEGA workstation is again available, it assumes the role of SLAVE, whereas the SIMATIC IT Alarm Manager running on LAMBDA maintains MASTER status.
SIMATIC IT Services V4.4 SP2 User Manual 163

Hot Backup

3.3.9

When a network error occurs (Applications)

If a network error occurs between two SIMATIC IT servers, and communications between applications configured in hot backup are no longer possible, then applications in synchronous slave status will switch to master status. When communications between SIMATIC IT servers are re-established, applications configured on the primary master will maintain their MASTER status, whereas applications configured on the auxiliary master will assume SLAVE status. You can change this by selecting option Master on Auxiliary Master (Configuration > System > Modules Backup tab, button Advanced) for each server application you want to configure in this way. If you choose this configuration, the module running on the auxiliary master workstation will maintain the MASTER role, whereas the server application running on the primary master workstation will switch to SLAVE.

3.3.10

Enhancing master-slave alignment

SIMATIC IT backup servers regularly exchange large amounts of data to keep Plants and archives constantly aligned. It is possible to speed up data alignment between Primary and Auxiliary Master computers, thus releasing supervisory and control networks from alignment traffic, by implementing and configuring a dedicated point-to-point Ethernet network. This configuration should be carried out by advanced users only, familiar with network protocols and their configuration. Hence, it is recommended that for any question or for more information about different client / server network configurations you contact Siemens A&D AS MES TSS tss.simatic-it@siemens.com

3.4
3.4.1

Manual switching
Manual switching of Plants and modules
Under normal operation, master-slave switching occurs automatically in the event that the master status workstation where the Plant and modules are located becomes unavailable or the modules are stopped.

However, you can also switch the Plant and module status manually by using the Backup Switch Tool.

3.4.2

Manual master-slave switching of Plants

To carry out manual master-slave switching of Plants: 1. Select the command Tools > Backup Switch Tool in SIMATIC IT Management Console. 2. Double-click the computer name displayed on top of the workstation icon in the Backup Switch dialog box. 3. The Global Switch Request dialog box lists the Plant names and the status that they will assume when switching occurs. (Global Switch Mode options are not yet enabled). 4. Click OK to confirm switching.

SIMATIC IT Services V4.4 SP2 User Manual

164

Hot Backup

Important Switching is executed only if the workstations configured in backup are operating normally.

3.4.3

Manual master-slave switching of SIMATIC IT components

To carry out manual master-slave switching of SIMATIC IT components: 1. Select command Tools > Backup Switch Tool in SIMATIC IT Management Console. 2. Double-click the SIMATIC IT component name in the Backup Switch dialog box. 3. The Single Switch Request dialog box lists the module names, the status that they will assume when switching occurs, and the computer name of the workstation on which they are running. (Global Switch Mode options are not yet enabled). 4. Click OK to confirm switching.

Important Switching is executed only if the workstations configured in backup are operating normally.

SIMATIC IT Services V4.4 SP2 User Manual

165

Tag Management

Tag Management

4.1
4.1.1

Overview
Overview of the Points Database
A points (i.e. tags) database (also called data dictionary) is automatically associated to each logical Unit of any type.

Note Throughout this document, the terms variable and point have the same meaning, and are used without distinction.

This database contains the definition of all the variables that will be handled by SIMATIC IT applications: all read/write operations on these variables will be performed via the Unit to which the database is associated. When the variables are inserted into the database, their symbolic name is associated with a physical register of the memory area managed by the Unit.

This memory area can be located either on the computer (in this case, it is called "SIMATIC IT Real Time Data Server"), if you use third-party external devices, or on the P.M.C., if you use a Siemens Orsi Automation proprietary control network. SIMATIC IT components (Alarms, Historical Trends, Graphic Panels, etc) have access to the variables located in any memory area, either centralized or distributed.

4.1.2

Structure of the Points Database

The Points Database is made up of various tables, as follows: Main table AM table GUI table PDA table RTDS table

4.1.3

Maximum size of the Points Database

The maximum size of the Points Database (Data Dictionary) is defined as follows:

Variables/array elements Arrays

1.000.000 20.000
166

SIMATIC IT Services V4.4 SP2 User Manual

Tag Management
Elements in each array 32.767

Note: These are "theoretical" limits. In fact, the actual size of each Data Dictionary is determined by the corresponding Locreg size.

4.2
4.2.1

Points Database tables

Main table
The Main table contains fields required to configure the basic parameters of all the points.

Field Name REAL NAME

Description Register name associated with a physical address of the memory area managed by the Unit. Registers can be of different types (e.g. P permanent, F field, ). For more information, see User registers. Symbolic identifier assigned to the database variable. Cannot be longer than 32 characters. the point is configured, but no server is using it. the point is configured and at least one server is using it. the configuration of the point is no longer present, but at least one server is still using it. Code assigned to the variable. The following codes are available: A E the variable is the array header the variable is the element of an array

SYMBOLIC NAME Alarm Manager SIMATIC IT Graphic User Interface Data Archive Plant RTDS

C (Code)

I the variable is an array loaded from a .DEF file or the variable was scalar and had been converted into an array. In both cases the array size is 1 and the variable is converted into a normal array after entering the Array Management environment. If no code is displayed in this field, the variable is scalar. DIM. (Dimension or Index) SL (Setting Level) Array size or index number of an array element. This field is used only for Points with code A (array header) and E (array element). Access level assigned to the variable. The access level defined in the Database Editor is used with the resource Set variables from SIMATIC IT Graphic User Interface . Any user of this resource will be able to change the variable value from a SIMATIC IT Graphic User Interface graphic panel, provided that the access level of the resource is equal to or greater than the level assigned to the variable. This value must be included between 1 and 30 and will be used by the SIMATIC IT Graphic User Interface module to control write access to variables. For more information on variable setting from SIMATIC IT Graphic User Interface, see manual SIMATIC IT Graphic User Interface: Users Guide. DEF. VAL. (Default Value) Initialization value, i.e. a value that is assigned to a variable when defining the application program within PDE and SIMATIC IT Real Time Data Engine. For more information, see manual Project Development Environment (PDE) Users Guide. Comment assigned to the variable, usually in the language most familiar to the database user.

COMMENT Pr. (Comment Primary language)

SIMATIC IT Services V4.4 SP2 User Manual

167

Tag Management
COMMENT Sec. (Comment Secondary language) Comment assigned to the database variable, in a language other than that used in the primary comment. This field is optional and is added to the database only if the appropriate option is chosen upon database creation. .

4.2.1.1

AM table
The AM table contains fields required to configure the alarms. If you right click the column header, the corresponding ToolTip is displayed.

Field Name GROUP

Description Name of the group(s) the point is associated with. For more information on how to associate a point to a group of alarms, see Associating an alarm group to a point. Name of the server that manages the alarm Priority level of the alarm (from 1 to 5) No = not archivable; Yes = archivable Sub = replace the existing graphic panel; Add = add a new graphic panel; No = Alerter not enabled; Yes = Alerter enabled No = not printable; Yes = printable No = no comment added to alarm message defined in MESSAGE 1 or MESSAGE 2; Yes = comment added to alarm message defined in MESSAGE 1 or MESSAGE 2. Check the box if you want to invert the alarm activation mode. Reserved for future use. Alarm message displayed on the operators console. This message is displayed if you have selected option Comment Display First Comment with command Configuration > System from SIMATIC IT Management Console. Otherwise MESSAGE 2 is displayed. Second message added. This message is displayed if you have selected option Comment Display Second Comment with command Configuration > System from SIMATIC IT Management Console. Otherwise MESSAGE 1 is displayed. Name of the graphic panel (with .GRC extension) and/or of the sound file (with .WAV extension) associated with the alarm.

SERVERS PY (Priority) ARCH (Archivable flag) LOAD. MODE (Load mode) AL. (Alert) PRN (Printable) A.M.(Add message)

Neg. Logic COMM (Comment) MESSAGE 1

MESSAGE 2

PANEL / WAVE (Graphic Panel Name - Alarm WAV File)

For more information on the configuration of alarms, see Configuring alarms.

4.2.2

GUI table
The GUI table contains fields required to configure the graphic object attributes. If you right click the column header, the corresponding ToolTip is displayed.

Field Name D. 1 (Digital Color 1) TRUE

Description Colour shown when the point is in the status ON String displayed when the point has the status TRUE in place of the ON default string

SIMATIC IT Services V4.4 SP2 User Manual

168

Tag Management
D. 2 (Digital Color 2) FALSE MAX. VAL. (Maximum Value) A. 1 (Analogic Color 1) TH. HH (Threshold HH) A. 2 (Analogic Color 2) TH. H (Threshold H) A. 3 (Analogic Color 3) TH. L (Threshold L) A. 4 (Analogic Color 4) TH. LL (Threshold LL) A. 5 (Analogic Color 5) MIN. VAL. (Minimum Value) DELTA T. C (Trace Color) Colour shown when the point is in the status OFF String displayed when the point has the status FALSE in place of the OFF default string Maximum value the point may assume. Colour shown when the point exceeds the HH threshold Value of HH threshold Colour shown when the point exceeds the H threshold Value of H threshold Colour shown when the point exceeds the L threshold Value of L threshold Colour shown when the point exceeds the LL threshold Value of LL threshold Colour shown when the point is lower than the LL threshold Minimum value the point may assume. (reserved for future use) Percentage by which the points increase or decrease may vary (with respect to the range) Colour used for the line that draws the points trend or that represents the element in the chart

For more information on graphic-object attributes, see Graphic object attributes.

4.2.3

PDA table
The PDA table contains fields required to configure the point to archive. If you right click the column header, the corresponding ToolTip is displayed.

Field Name SERVERS TYPE CL (PDA Class) MAX. VAL. (Maximum Value) MIN. VAL. (Minimum Value) DELTA EXT. (Delta External) MIN. EXT. (Minimum External) MAX. EXT. (Maximum External) DELTA INT. (Delta Internal) MIN. INT. (Minimum Internal) MAX. INT. (Maximum Internal) ENG. UNIT (Engineering Unit)

Description Servers that manage the alarm Point type. Sampling class type (from 1 to 4) Maximum value the point may assume. Minimum value the point may assume. Delta for external compression. Minimum interval (in seconds) between two samples passed to the external compression algorithm. Maximum time (in seconds) between two samples passed to the external compression algorithm. Delta for internal compression. Minimum interval (in seconds) between two samples passed to the internal compression algorithm. Maximum time (in seconds) between two samples passed to the internal compression algorithm. Measurement unit of the archived point.

SIMATIC IT Services V4.4 SP2 User Manual

169

Tag Management For more information on the configuration of historical points, see Configuring a point to be archived.

4.2.3.1

RTDS table
The RTDS table contains fields required to configure communications between SIMATIC IT Real Time Data Server and a third-party PLC network, in order to read/write field variables

Field Name INTERFAC (Interface Name)

Description Name of the interface used to handle communications between SIMATIC IT Real Time Data Server and a third-party PLC network, in order to read/write field variables. This name is usually defined upon driver installation and must be also specified during RTDS configuration. For more information, see Configuring SIMATIC IT Real Time Data Server.

CL (RTDS Class)

Time class value. The time class is the frequency applied by the interfaces to read values from the network. Six predefined classes are available and each class corresponds to a different sampling time: 0 = variables are not read at predefined intervals by the interface but only upon a specific request of a SIMATIC IT component. 1 = 1 second 2 = 2 seconds 3 = 6 seconds 4 = 10 seconds 5 = 30 seconds 6 = 60 seconds

SAFE VAL.

Safety value, that is, value assigned by default to the variable if the value cannot be read from field (e.g. due to network communications failure, SIMATIC IT Real Time Data Server and interfaces communications failure). This field contains information required to access variables via thirdparty interfaces (e.g. PLC variable name) This field contains information required to access variables via thirdparty interfaces (e.g. PLC node number) This field contains information required to access variables via thirdparty interfaces

USER 1 USER 2 USER 3

4.3
4.3.1

Database Editor
Starting the Database Editor
SIMATIC IT Management Console provides the Database Editor tool to create, update and manage the Data Dictionaries associated to the various Units defined in your Plant. From the Database Editor you can edit only one database at a time.

From SIMATIC IT Management Console: 1. Select a Unit in the tab.

2. Choose command Unit > Database Editor or

SIMATIC IT Services V4.4 SP2 User Manual 170

Tag Management expand the Unit and click icon .

The Database Editor can also be called from various SIMATIC IT environments, such as PDE (Project Development Environment), SIMATIC IT Real Time Data Engine (SIMATIC IT Real Time Data Engine Manager) and the Alarm Manager / Plant Data Archive server configuration utility.

4.3.2

Typographical conventions used in the database grid

Points in the Database Editor grid are sorted by default in descending order by field REAL NAME. To re-sort Points when new variables are added, save the database with command File > Save

Points are displayed in the grid with different colours according to their status, as follows:
Color Black Grey Blue Black blue Green Description Normal point Read-only point Locked point (i.e., the database program cannot shift the allocation of the variable to another register/bit of the same type). Read-only locked point Bookmark

These colors are assigned by the Database Editor but can be changed by the user, if required. For more information, see Changing colors.

The column placed on the left side of the grid is used to display icons with the following meaning:
Icon Description New point, i.e. not yet saved in the database Point already defined in the database, modified in the current session and not yet saved. Invalid point, i.e. not saved since it contains errors. Point marked for deletion. The point will be removed when the database is saved. Array element Open array Closed array Scalar variable converted into an array

If the left column is empty, the point has already been saved in the database and has not been modified by the user in the current working session.

The column with the

header is used to display icons with the following meaning:

171

SIMATIC IT Services V4.4 SP2 User Manual

Tag Management

Icon

Description Point already defined in the database, modified in the current session and not saved until all servers have read and updated database info. Point marked for deletion. The point will be removed when all servers have read and updated the database info.

4.3.3 4.3.3.1

Opening a database Opening a database (Database Editor)

Select the command File > Open in the Database Editor window. The standard browser dialog box appears.

4.3.3.2

Opening a database linked to a particular Unit

To open a database that is linked to a specific Unit: 1. Select the command File > Open Unit DB in the Database Editor. The Open Database Linked to Unit dialog box appears. 2. In the Units list box select the Unit of which you want to open the database. The dialog displays the Unit Type, the name of the Database and the Project relating to the selected Unit. 3. Select the OK button to open the database linked to the selected Unit.

4.3.4 4.3.4.1

Working with views Database table views

The Database Editor provides some predefined table views, which can be used to configure the order in which fields are displayed in the database grid. By default the Database Editor shows the views which best suit the database structure. The predefined views available, correspond to the tables that make up the database structure. You can modify the position, label and width of the fields in each view. For more information, see Customizing a view.

In addition, the user can create customized views, which will be displayed in the database grid when clicking tabs View 1, View 2 and View 3, respectively.

4.3.4.2

User Views
Views 1 to 3 in the database grid allow you to insert the fields you want, in the order that you want.

You can: Create a User View Assign a User View

SIMATIC IT Services V4.4 SP2 User Manual 172

Tag Management Delete a User View Customize a User View

4.3.4.3

Creating a User view

To create a User view: 1. Select command Tools > Views Management in the Database Editor. 2. Click the Create User Views tab in the Views Management dialog box. 3. In the File Name box insert the name of the new View. 4. In the Database Fields list box select the fields you want to add to the View and click the button. 5. In the View Fields box are displayed the fields you have chosen. To remove a field from the View Fields box reselect it and click . To remove all the fields click the Clear button.

6. Click Save to confirm your settings. The Close button allows you to exit the dialog box.

4.3.4.4

Assigning a User view

To assign a User view: 1. Select command Tools > Views Management in the Database Editor. 2. Click the Assign User View tab in the Views Management dialog box. 3. Select the View1 tab. 4. From the Available User Views list, select the user view you want assign to the View1 tab. 5. Click the Apply button. The Close button allows you to exit the dialog box. 6. The assignment you have just made is displayed in the View1 field in the Current Assignment area. 7. Repeat steps from 3 to 6 for View 2 and View 3, if necessary.

You can also assign a User view as follows: 1. Right-click the View1 tab in the Database Editor. The Select View (VIEW1) dialog box appears. 2. Select the view you want from the list and click OK.

4.3.4.5

Deleting a User view

To delete a User view: 1. Select command Tools > Views Management in the Database Editor. 2. Click the Delete User Views tab in the Views Management dialog box. 3. In the Views list box select the view you want to delete. 4. Click the Delete button. The Close button allows you to exit the dialog box.

SIMATIC IT Services V4.4 SP2 User Manual

173

Tag Management

4.3.5 4.3.5.1

Working with points Managing Points

To manage points (i.e. scalar variables) you need to enter a dedicated environment, with command File > Points Management in Database Editor.

To handle scalar variables in guided mode, select commands Edit > Point > Add Point > Modify .

or Edit >

The following operations can be performed in the Points Management environment: Inserting a new point (in guided mode) Inserting a new point (in manual mode) Modifying a point (in guided mode) Modifying a point (in manual mode) Modifying a group of points Deleting a point Duplicating a point Duplicating serveral points Correcting errors Converting a scalar variable into an array Setting in read-only mode

To save any changes applied to variables in Points Management you need to choose command . In any case the Database Editor program prompts you to save changes when File > Save you quit the Points Management environment.

Important All the changes applied to the database should be updated on the SIMATIC IT servers (Alarm Manager, Plant Data Archive, RTDS). For more information, see Updating the SIMATIC IT servers configuration.

4.3.5.2

Inserting a new point (guided mode)

To insert a new point in guided mode: 1. In the database grid, move to the row under which the new point is to be inserted. 2. Select command Edit > Point > Add . The Add Points dialog box is displayed.

Parameter Real name

Description Register identifier. Registers and types may vary according to the locreg type associated with the database. to display all registers and related types (Integer, Click button Real, Character, Logic):

SIMATIC IT Services V4.4 SP2 User Manual

174

Tag Management
Symbolic name Setting level Alarm (A) Field (F) Not Permanent (R) Permanent (P) Backup (B) Input (I) Output (O)

Symbolic identifier of the variable. Alphanumeric string up to 32 characters. Access level required to set the variable value in SIMATIC IT Graphic User Interface. The access level defined in the Database Editor is used with the resource Set variables from SIMATIC IT Graphic User Interface . Any user of this resource will be able to change the variable value from a SIMATIC IT Graphic User Interface graphic panel, provided that the access level of the resource is equal to or greater than the level assigned to the variable. For more information on variable setting from SIMATIC IT Graphic User Interface, see manual SIMATIC IT Graphic User Interface: Users Guide.

Locked

If you select this check box the point is locked, that is, the database merge program cannot shift the variable allocation to another register/bit of the same type. Comment assigned to the variable, usually in the language most familiar to the database user. Comment assigned to the database variable, in a language other than that used in the primary comment. This field is optional and is added to the database only if the appropriate option is chosen upon database creation. Number of points to be inserted

Comment (Primary language) Comment (Secondary language)

Points Number

3. Click the OK button.

The points are inserted in the database when you select command File > Save

You can then insert the other parameters to configure the point according to your needs, i.e.: To handle communication with the PLC network To configure an alarm To configure a poiint to be archived To configure graphic object parameters

4.3.5.3

Inserting a new point (manual mode)

To insert a new point in manual mode: 1. In the database grid move to the row under which the new point is to be inserted. 2. Press the RETURN key to insert an empty point. 3. Move to the REAL NAME field of the first point you have inserted and enter the register type and progressive number (e.g. F10, P5, A30). You can also enter only the register type and then perform an automatic allocation. For more information, see Automatic allocation.

SIMATIC IT Services V4.4 SP2 User Manual

175

Tag Management 4. Enter the symbolic identifier of the variable in the SYMBOLIC NAME field (maximum 32 characters). To enter several names which begin with the same characters you can use automatic fill. For more information, see Automatic Filling. 5. Enter the required values in all the remaining fields of the point. Click the various tabs (AM, PDA, GUI) to complete the point configuration. For more information on the values to be inserted, see Structure of the Points Database. The points are inserted in the database when you select command File > Save .

4.3.5.4

Automatic allocation
Thanks to the automatic allocation tool you do not need to view the locreg map to discover which registers of a certain type are still free.

If you add a variable or an array in guided mode (for more information, see Inserting a new point (guided mode) for the point or see Modifying the field values of an array element (guided mode) for the array), the first free register of the selected type is automatically assigned to the point when the variable or the array is saved in the database.

If, on the other hand, you insert a point in manual mode, you must proceed as follows: 1. In the Points Management window insert one or more empty points: move to the row under which the new point is to be inserted and press the RETURN key as many times as the number of points to be inserted. 2. Enter the register type (e.g. RI,PF) in the first REAL NAME field of the point(s) to be allocated. If you want to allocate a bit, the register type identifier must be followed by a dot (e.g. RI. PI.). You can also indicate the register number and/or bit number from which allocation must start (e.g. RI10 PI.[5]). 3. Drag the cursor to select all the REAL NAME fields of the points to be allocated. 4. Select command Edit > Auto Allocation .

5. All the selected REAL NAME fields are filled with free register numbers of the selected type. If the REAL NAME field of the first selected point is empty or does not contain a valid identifier, automatic allocation is not performed. Allocation starts from the first point of the selected block and continues with all subsequent points of the block, for which the REAL NAME field is empty. If somewhere in the block there is a point with a valid register identifier different from the first, allocation continues using the latter register type. Bit allocation starts from the first free bit of either the first free or partially used register, if you do not indicate any register number.

4.3.5.5

Example of automatic allocation

If bits 0 to 3 of register RI10 are already used, and you just specify RI. in the first POINT field of your block, bits allocation will start from RI10.[4]. However, if you indicate RI11. as the first POINT field value of your block, allocation starts from bit RI11.[0], even if not all the bits of register R10 were used.

SIMATIC IT Services V4.4 SP2 User Manual

176

Tag Management

4.3.5.6

Automatic Filling
The Automatic Fill tool inserts a string followed, if required, by a progressive number, in a block of selected points. In this way it becomes extremely easy, for example, to assign different names to each element of an array.

To perform Automatic Filling in a block of selected points: 1. Drag the cursor to select the field to be filled (e.g. SYMBOLIC NAME) for all the points of interest. 2. Select command Edit > Fill Selection
Parameter Text Description Alphanumeric string to be used to fill the field. The string is truncated if it is longer than the selected field or block size. The string is always aligned left. If the block you select already contains characters, these are replaced with the text entered by the user. To insert a number in any position within a string, type the # symbol where the number (any number of digits) is to be inserted. Type the \ character before the number sign # (i.e. \#) to display the # character instead of a digit. Enable Automatic increment Start from Step Leading Zero Check this box only if a right aligned number is to be inserted at the end of the string. The number will be automatically incremented in each point. First number to be incremented Step to be applied to increment the number If you check this box, the program will insert as many leading zeros as required to reach the digit indicated in the subsequent Number of digits field. See description below. Total number of digits to be inserted, including leading zeros.

. The Fill Selection dialog box appears;

Digits

Important If the selected block contains read-only fields, these are not processed by the filling program.

4.3.5.7
Example1

Example of Automatic Filling

You have selected a block made up of 10 characters and 8 rows in the SYMBOLIC NAME field. Then you set the following parameters in the Fill Selection dialog box. Text: valve Enable Automatic increment: Start from: 2 Step: 1 Leading zero: Number of digits: 3

The eight rows of the SYMBOLIC NAME field will be filled with the following strings:
SIMATIC IT Services V4.4 SP2 User Manual 177

Tag Management valve002 valve003 valve004 valve005 valve006 valve007 valve008 valve009

Example2
You have selected six rows of the SYMBOLIC NAME field. Then you set the following parameters in the Fill Selection dialog box: Text: VALVE#KK_A Enable Automatic increment: Start from: 4 Step: 2 Leading zero: Number of digits: 4

The six rows of the SYMBOLIC NAME field will be filled with the following strings: valve0004KK_A valve0006KK_A valve0008KK_A valve0010KK_A valve0012KK_A valve0014KK_A

4.3.5.8

Modifying a point (guided mode)

To modify a point in guided mode: 1. Select command Edit > Point > Modify box appears. in Database Editor. The Point Viewer dialog

2. Modify the values of the fields of interest. You can use any of the following buttons:
Click To Move to the previous point Move to the next point Update the database fields with the new values inserted into the fields. Reset the previously displayed settings. View the original record values, not yet acquired by the servers.

SIMATIC IT Services V4.4 SP2 User Manual

178

Tag Management
(for arrays only) Expand the array (for arrays only) Collapse the array

3. If you want to remove some tables from the point definition, click the relative tab and uncheck the Present box. 4. Click Update to update the point definition. To apply the changes you have entered use the File > Save command.

4.3.5.9

Modifying a point (manual mode)

To modify a point in manual mode: 1. Move to the point of interest in the database grid. 2. Type the new values in the fields. To move between fields press the TAB key.

To apply the changes you have entered use the File > Save

command.

4.3.5.10

Modifying a group of variables

To modify a group of variables: 1. Select the block of points you want to modify. 2. Select command Edit > Point >Modify 3. Select the tables of interest. 4. Modify the fields you want. 5. Click OK. To apply the changes you have entered use the File > Save command. . The Point Viewer dialog box appears.

4.3.5.11

Deleting a point
To remove a point from the database, select a point in the database grid and choose command Edit > Point > Delete .

If the point is old, that is, it had already been saved in the database, the delete icon ( ) is displayed in the first column next to the REAL NAME field. In this way the point is only logically deleted and will be removed from the database when the Save command is chosen. Until then it is possible to restore the point by selecting it and choosing command Edit > Point > Delete.

If the point is new, that is, it has been inserted in the database but not yet saved (icon first column), the point is actually removed and it will not be possible to restore it.

in the

SIMATIC IT Services V4.4 SP2 User Manual

179

Tag Management

4.3.5.12

Duplicating a point
To duplicate a point: 1. Select a point in the grid. 2. Select command Edit > Point >Duplicate The Add Points dialog box appears.

3. A new point is inserted after the selected one. This point has the same fields and values as the sample point, but the REAL NAME field is empty. 4. Enter an appropriate value in the REAL NAME field. You can use the dynamic allocation option.

4.3.5.13

Duplicating several points

To duplicate several points: 1. Select a point in the grid. 2. Select command Edit > Point > Duplicate .

3. The new points are inserted after the last points present in database. These points have the same fields and values as the sample point, but the REAL NAME field is empty. 4. Enter an appropriate value in the REAL NAME field. You can use the dynamic allocation option.

4.3.5.14

Correcting errors
By selecting the Save command you save the new and the modified points in the database. If one or more points are not correct i.e. if some fields present incorrect values, they are listed at the bottom of the window with related error messages.

To correct any fields that contain incorrect values: 1. Modify the incorrect values displayed at the bottom of the window. 2. Save the database again. 3. The fields that previously contained incorrect values now display the changes made.

4.3.5.15

Displaying errors
To display the errors found after saving the database, select command View > Errors View.

4.3.5.16

Converting a scalar variable into an array

You can convert a scalar variable into an array with dimension 1. The size of the array can be subsequently modified in the Arrays Management environment.

To convert a scalar variable into an array: 1. Select the point to be changed in the database grid. 2. Select command Edit > Change Scalar to Array or press key F8. 3. The I character is inserted into the CODE (C) field.
SIMATIC IT Services V4.4 SP2 User Manual 180

Tag Management

4. Enter the Array Management environment with command File > Arrays Management The converted array is displayed as a blue folder. 5. Modify the array as required (e.g. increase the dimension). The folder colour changes to yellow and the I code is replaced with the A and E codes in the database grid.

You can restore the initial status (that is, re-convert the array into a scalar variable) with command Edit > Change Array to Scalar (keys Shift+F8), if the database was not saved. Otherwise this operation is not possible.

4.3.5.17

Find and Replace

You can execute filters on the values of any field (both in read and in write mode) in the grid of the Database Editor. Adopting specific conventions when applying a filter can aid you considerably in searching for a string in the database. In addition, you can perform two types of queries: Single-field queries Multiple-field queries You can find and replace text throughout the entire database or in a selected block of points.

In addition to the usual Find and Replace commands, the Database Editor provides a number of tools to help you to quickly locate a point in the database. Points can also be sorted for display in the Points Management window of Database Editor.

4.3.5.18

Conventions used for finding strings

The following conventions can be applied to search any string in the database.

To search for Partial strings

Do as follows Enter the first characters of the string followed by wildcards * (any number of characters) or ? (one character). For instance, type TIC405* to find all strings in the database which begin with TIC405 and are followed by any number of characters. Type TIC405? to find all strings in the database which begin with TIC405 and are followed by one character.

Substrings

Enter the substring to be found within a longer string . You can use wildcards * (any number of characters) or ? (one character). For instance type *TIME* to find all strings which contain the TIME substring.

4.3.5.19

Single-field queries
To execute a single-field query: 1. Move the cursor to any point of the field to be used for the query in the Database Editor grid (for instance, click any point of the SYMBOLIC NAME field). 2. Select command Edit > Find . Enter the following parameters in the Find dialog box.

Parameter Find what

Description Text to be found in the database, in the field displayed in the title bar
181

SIMATIC IT Services V4.4 SP2 User Manual

Tag Management
(it is the field where the cursor is positioned). Match whole word only Match Case Negative Logic Direction Up Direction Down If you check this box, the Database Editor will consider the text inserted in Find what as a word and not a part of word. If you check this box, the Database Editor will find only text with the specified capitalization (case sensitive). If you check this box, the Database Editor will find text which does NOT match the text you entered in the Find what edit box. If you click this radio button, the Database Editor will find text only in the points which precede the point where the cursor is positioned. If you click this radio button, the Database Editor will find text only in the points which follow the point where the cursor is positioned.

3. After setting the parameters of interest:

Click Find Next Mark All To Start searching the first occurrence of the text Insert a bookmark next to each point that matches the specified search criteria.

4. After finding the first point that matches the search criteria, the Find dialog box disappears automatically. To find more points that match the same criteria, click one of the following buttons (available in the Points Management toolbar): to find the next point to find the previous point.

4.3.5.20

Multiple-field queries
To execute a multiple-field query: 1. Select command Search > Advanced Find . The Advanced Find dialog box appears.

2. You can perform complex searches by using the database fields of the various tables. These tables are: the Main table the RTDS table the AM table the GUI table the PDA table

3. You can also select some additional options:

Select Direction - Up Direction - Down check box check box To Search text from the current record up to the beginning of the file. Search text from the current record up to the end of the file. Find text which does NOT match the text you entered in the field box. Find only text with the specified capitalization (case sensitive).

SIMATIC IT Services V4.4 SP2 User Manual

182

Tag Management
Choose a relational operator which will be used to search numeric fields. The most common and some advanced operators are available.

icon

4. Click the Mark All button to insert a bookmark next to each record which matches the specified search criteria. 5. Click Find Next to run the search. After finding the first record which matches the search criteria, the Advanced Find dialog box disappears automatically. To find more records which match the same criteria, click one of the following buttons (available in the Points Management toolbar):

to find the next record to find the previous record.

4.3.5.21

Finding and replacing text

You can find and replace text in the whole database or in a selected block of points. The Find and Replace command, as the Find command, can only search a single field at a time.

To find and replace text: 1. Select a block of points for the field of interest (e.g. SYMBOLIC NAME) or move to any point of the field of interest to search the whole database. 2. Select command Edit > Replace box:
Parameter Find what Replace with Match whole word only Match Case Replace in Description Text to be found in the database, in the field displayed in the title bar (it is the field where the cursor is positioned). You can search for partial strings. Text which will replace the text found. If you check this box, the Database Editor will consider the text inserted in Find what as a word and not a part of word. If you check this box, the Database Editor will find only text with the specified case. Text is replaced only in the selected block (button Selection) or in the whole database (button Whole Database).

. Enter the following parameters in the Replace dialog

3. After setting the parameters of interest:

Click Find Next Replace Replace All To Search text in the current selection or in the whole database. Replace the current text with the text specified in the Replace with box. Replace the current text with the text specified in the Replace with box, either in the current selection or in the whole database.

SIMATIC IT Services V4.4 SP2 User Manual

183

Tag Management

4.3.5.22

Converting text to uppercase/lowercase

To convert a selected text block to all uppercase or all lowercase letters you can use commands Upper Case or Lower Case in the Edit menu. A block is a set of contiguous fields of the same type.

4.3.5.23

Locating a point in the database

The Database Editor provides a number of tools to help you to quickly locate a point in the database, in addition to the usual Find and Replace commands.

Using bookmarks
If you have added bookmarks to your database file, you can locate the marked points by selecting commands Bookmarks > Previous or Bookmarks > Next on the Edit menu. For more information, see Inserting and removing bookmarks.

Using line numbers

Each point in the database file is associated with a line number, which is displayed in the Pointer bar of the Database Editor window. Select command Edit > Go To to display the Go To dialog box and enter the line number to be located in the Line Number box.

4.3.5.24

Sorting points
Points displayed in the Points Management window of Database Editor can be sorted by: real name symbolic name

To sort points by Real name Symbolic name

Select command Search > Sort > by Real Name Search > Sort > by Symbolic Name

4.3.5.25

Inserting/removing Bookmarks
Bookmarks are used to mark one or more points in your database which you need to locate quickly. You can add bookmarks either while running a Find command, or manually.

Adding a bookmark manually

1. Move to the point to be marked in the database grid. 2. Select command Edit > Bookmarks > Toggle. 3. The Title column next to the point is marked with a different colour (usually green, but you can customize this option).

Removing a bookmark
1. Move to a point previously marked in the database grid

SIMATIC IT Services V4.4 SP2 User Manual

184

Tag Management 2. Select command Edit > Bookmarks > Toggle. 3. The bookmark is removed.

Removing all bookmarks

1. Select command Edit > Bookmarks > Remove. 2. All bookmarks previously inserted, either manually or automatically, will be removed.

4.3.5.26

Exporting points
You can copy a block of points from the current database to a database that has the same format. Export databases are equal to a standard database but have .XDB extension and must be assigned a name different from that of the source database. When the Database Editor creates an EXPORT file it also generates the relative indexes. Since new points can be appended to an existing EXPORT database, it is possible to export points several times to the same file.

Before running the Export command you must save all changes in Points Management window. Then proceed as follows: 1. Select command Tools > Export points. The Export dialog box appears. 2. In the Extract Points area choose the set of points to be exported: Selected: the points selected in the grid. Marked: the points to which a bookmark has been associated. Whole database: all points in the database.

3. Check the configurations (AM, PDA, GUI, RTDS) you want to export within the Filter Points by Configuration area. These check boxes determine the subset of records which will be exported, as follows: Selected: the program will only export those records which contain these configurations Unselected: the program will only export those records which DO NOT contain these configurations Undetermined (selected but shadowed): the program will export all records, whether or not they contain these configurations.

4. Enter the name of the export file in the File Name edit box (maximum 8 characters). 5. Click the Skip Arrays check box to choose not to copy array headers and array elements into the new database. If you do not check this box, all the elements of a selected array are copied to the new database, even if the block of points selected does not contain all the array elements. 6. In the Writing mode area check the box Overwrite or Append if you want to either overwrite the destination database or add points to it. 7. Click OK 8. You can open the file with .XDB extension from the Points Management or Database Management by choosing command File > Open.

SIMATIC IT Services V4.4 SP2 User Manual

185

Tag Management

4.3.5.27

Importing points from a .DEF file

Definitions files (.DEF extension) are created by compilers in the PDE or-Real Time Data Engine Manager environments when incomplete variable definitions are detected. Therefore each .DEF file contains a list of all the program variables and registers which do not have a corresponding definition in the database associated with the Unit.

To import a definition file, perform the following steps: 1. In Points Management, select command Tools > Read Definitions Files. 2. The Read Definitions Files dialog box lists all the .DEF files generated when compiling the Project associated with the current Unit. To display .DEF files generated in other Projects, you must associate a different Project to the Unit (use command Edit > Modify in SIMATIC IT Management Console). 3. Select the file from the Definitions Files list box. 4. Click OK to import the files.

For each definition stored in the .DEF file the Database Editor creates a new point, which is added after the point where the cursor is positioned.

The Import program behaves as follows:

If you import A variable which does not exist in the database The program adds A point which contains the variable name in the SYMBOLIC NAME field and the variable type (integer, float, character, etc) in the REAL NAME field (if this information was available in the program). The type is preceded by a question mark which must be replaced by the user with the register type of interest (e.g. P to allocate a permanent register, F to allocate a field register, etc.) A point which contains the register name in the REAL NAME field. The user must insert the variable name in the SYMBOLIC NAME field.

A register

If you import a scalar variable, the CODE (C) field is empty, whereas it contains the I letter if you import an array. The imported array always has size 1.

To explode the elements of the array (i.e. display the A and E letters in the CODE field), you must enter the Array Management environment with command File > Arrays Management . The imported array folder is displayed in blue but becomes yellow (standard colour) when you modify the array (e.g. increase its size).

4.3.5.28

Locking a point
You can lock a point or a block of selected points: this implies that if you merge this database with another, the program cannot shift the allocation of the selected point to another register/bit of the same type. For more information on merging databases, see Merging databases.

SIMATIC IT Services V4.4 SP2 User Manual

186

Tag Management To lock a point (or a block of selected points): 1. Select a point or block of points in the Points Management window. 2. Select command Edit > Point > Lock .

3. Locked points are displayed in a different colour, usually blue. However you can modify this default colour. For more information, see Changing colors.

4.3.5.29

Unlocking a point
To unlock a point (or a block of selected points): 1. Select a locked point or block of points in the Points Management window. Locked points are displayed by default in blue. 2. Select command Edit > Point > Unlock .

Unlocked points are displayed in the standard text colour (usually black), but you can change it. For more information, see Changing colors.

4.3.6 4.3.6.1

Working with arrays Managing Arrays

To manage arrays you need to enter the Arrays Management environment, with command File > Arrays Management in Database Editor.

To handle an array in guided mode, you can: Select commands Edit >Add Array Select command View > Point Viewer or Modify Array or Element , or

In all cases the Add Array or Point Viewer dialog boxes are displayed.

Any changes applied to arrays become permanent as soon as they are performed, and no confirmation is required. However, if you select the Enable Restore option (Tools menu > Settings command > Workspace tab > Arrays Management area >Enable Restore check box) in Arrays Management, the following message will be displayed: Database modified, confirm changes? Click Yes to save all changes applied during the current working session. Click No to reject changes, and to restore the database status prior to any changes applied during the current session.

4.3.6.2

Adding an array
To add an array: Select command Edit > Add Array appears. Enter the following data: in Arrays Management. The Add Array dialog box

Parameter First Register

Description Identifier of the first register of the array (e.g. FF25).

187

SIMATIC IT Services V4.4 SP2 User Manual

Tag Management
The register types available depend on the locreg to previously assigned to the database: click button display all registers and related types (Integer, Real, Character, Logic). Symbolic Name Setting Level Symbolic identifier of the variable. Alphanumeric string up to 32 characters. Access level required to set the variable value in SIMATIC IT Graphic User Interface. This value is assigned to each element of the array. Dimension of the array (i.e. number of elements it can hold). If you select this check box each element of the array is locked, that is, the database merge program cannot shift the variable allocation to another register/bit of the same type. Alphanumeric string used to define the array contents. It is displayed only beside the array header. Alphanumeric string used to define the array contents. It is displayed only beside the array header.

Dimension Locked

Comment (Primary language) Comment (Secondary language)

You can then insert the other parameters to configure the point according to your needs: to handle communication with PLC network to configure an Alarm to configure a point to be archived to configure graphic-object parameters

4.3.6.3

Modifying the field values of an array element (guided mode)

To modify the field values of an array element in guided mode: 1. In the Arrays Management window, select the array to be modified. 2. Double click the array name: all the elements of the array are listed. Select the element to be modified. 3. Select command Edit > Modify Array or Element appears. ; the Point Viewer dialog box

4. Modify the values of the fields of interest. For a brief description of the buttons displayed next to the dialog box, see Array buttons. 5. If you want to remove some tables from the point definition, click the relative tab and uncheck the Present box. 6. Click Update to confirm changes.

Important You are not allowed to change the register type, the element index or the Locked check box.

4.3.6.4

Buttons
These dialog boxes show the following buttons, which allow you to perform several operations:

SIMATIC IT Services V4.4 SP2 User Manual

188

Tag Management

Click

To Move to the previous point Move to the next point Expand the collapsed array Collapse the expanded array Reset previous settings Update the database fields with the values inserted in the fields Insert the new values in the database fields Close the window without saving

4.3.6.5

Modifying the field values of an array element (manual mode)

To modify the field values of an array element in manual mode: 1. In the Points Management window select the array element to be modified in the database grid. 2. The REAL NAME field of each element of the array is displayed in a different colour (usually grey) to indicate that the field is read-only and thus cannot be modified. 3. Enter a new identifier in the SYMBOLIC NAME field to associate a name other than the array header to the element of the array. 4. Enter new values in the other fields, if required. 5. To save changes choose command File > Save .

4.3.6.6

Duplicating an array
To duplicate an array: 1. Select the array to be modified in the Arrays Management window. 2. Select command Edit > Duplicate Array 3. Enter all the values of interest. 4. Click the OK button to confirm changes. ; the Add Array dialog box appears.

4.3.6.7

Deleting Arrays
You can remove one or more arrays only from the Arrays Management environment.

To delete a single array:

1. Select the array to be deleted in the Arrays Management window. 2. Select command Edit > Delete Array .

3. Confirm deletion with Yes. The array and all its elements are removed from the database.

SIMATIC IT Services V4.4 SP2 User Manual

189

Tag Management

To delete multiple arrays:

1. Select command Edit > Delete Multiple Arrays. 2. Select the arrays to be deleted in the window. To make multiple selections you can press the SHIFT key. 3. Confirm deletion with Yes. The arrays and all their elements are removed from the database.

Important You cannot remove only one element of the array

4.3.6.8

Locking an array
You can lock an array: this implies that if you merge this database with another, the program cannot shift the allocation of the selected array to another register/bit of the same type. For more information on merging databases, see Merging databases.

To lock an array: 1. Select an array in the Arrays Management window. 2. Select command Edit > Lock Array . or ) is displayed in

3. The array and all its elements are locked. The array icon (either blue.

Important Arrays can be locked (as a whole) only in the Arrays Management environment. Thus you cannot lock/unlock the elements of an array in the Points Management window

4.3.6.9

Unlocking an array
To unlock an array: 1. Select a locked array in the Arrays Management window. 2. Select command Edit > Unlock Array . or ) is displayed in

3. The array and all its elements are unlocked. The array icon (either white).

Important Arrays can be unlocked (as a whole) only in the Arrays Management environment. Thus you cannot lock/unlock the elements of an array in the Points Management window.

SIMATIC IT Services V4.4 SP2 User Manual

190

Tag Management

4.3.7 4.3.7.1

Updating server configuration Updating the SIMATIC IT servers configuration

Any changes you apply to a database from the Database Editor must be updated in the SIMATIC IT servers configuration (Alarm Manager, Plant Data Archive, RTDS). This operation can be performed run-time by the servers, that is, without shutting them down. To this end, the program provides a dedicated configuration environment. Updating the RTDS server configuration For details on how to update the point configuration of the RTDS server, see Updating SIMATIC IT Real Time Data Server. Updating the Plant Data Archive server configuration For details on how to update the point configuration of the Plant Data Archive server, see the related documentation of the SIMATIC IT Plant Data Archive module. Updating the Alarm Manager server configuration For details on how to update the point configuration of the Alarm Manager server, see the related documentation of the SIMATIC IT Alarm Manager module.

4.3.8 4.3.8.1

Configuring alarms Configuring alarms

You can organize alarms in groups (sets) according to their function or their zone and can filter their display in the SIMATIC IT Alarm Manager Display module. Alarms can be printed and archived.

To configure User alarms: 1. Click the AM tab in the Point Viewer dialog box. A dialog box appears and displays the Alarm Manager fields. 2. Check the Present box and configure the following Alarm Manager attributes.

Important This check box is enabled only if you are adding a Boolean point.

Field Name Servers Groups Archivable Printable Comment Add Message

Action Choose the servers that have to manage the alarm Enter the name of the group to which the alarm belongs Check the box if you want to archive the alarm Check the box if you want to print the alarm Reserved for future use Check this box if text entered in the Comment fields of the Main tab must be concatenated to text in the Message 1 or Message 2 fields. Comment (Primary language) will be added before Message 1 whereas Comment (Secondary language) will be added before Message 2. Check the box if you want to invert the alarm activation mode. Check the box if you want to enable the Alerter service

Neg. Logic Enable Alerter

SIMATIC IT Services V4.4 SP2 User Manual

191

Tag Management
Priority Select the priority level you want to associate to the alarm. For more information on alarm priority see the SIMATIC IT Alarm Manager and Alarm Manager Display documentation. Enter the name of the graphic panel (with .GRC extension) and/or sound file (with .WAV extension) you want to associate to the alarm. You can enter both values, using the ";" character or a blank as separator. File names must be entered with extension but without pathname and can be in any order. For further information, see also: Associating a sound file to an alarm Associating a graphic panel to an alarm Loading mode Select the button which defines how to load the graphic panel: Sub = replace the existing graphic panel. Add = add a new graphic panel. Message 1 Alarm message displayed on the operators console. This message is displayed if you have selected option Comment Display First Comment with command Configuration > System from SIMATIC IT Management Console. Alarm message displayed on the operators console, usually in a language different from Message 1. This message is displayed if you have selected option Comment Display Second Comment with command Configuration > System from SIMATIC IT Management Console.

Panel/Wave

Message 2

3. Click the OK button. Points are inserted in the database when you select command File > Save .

4.3.8.2

Creating a group of alarms

To create a group of alarms: 1. Select command Tools > Define Alarm Groups in DB Editor 2. In the Define Alarm Groups dialog box click the button

3. Insert the name of the new alarm group. You can add up to 255 groups. 4. Click OK to save changes and quit.

If you want to define several alarm groups at a time, you can import their names from an existing TXT file. Click the Import button and select the file from the dialog box. To use existing group names for a different Plant, you can also export these names to a TXT file (click the Export button) and then re-import them.

4.3.8.3

Updating alarm groups

To change the name of an alarm group:

1. Select command Tools > Define Alarm Groups in DB Editor. 2. Select the name of a group in the Group Names list. 3. In the Define Alarm Groups dialog box click the
SIMATIC IT Services V4.4 SP2 User Manual

button or click the group name.

192

Tag Management 4. Enter the new name. 5. Click OK to save changes and quit.

To delete an alarm group:

1. Select command Tools > Define Alarm Groups in DB Editor. 2. In the Define Alarm Groups dialog box select the name of the group to be deleted from the Group Names list. 3. Click the button.

4. Click OK to save changes and quit.

To change the sorting order:

By default, group names are sorted in descending alphabetical order (by Name option). You can assign a user-defined order: 1. Select command Tools > Define Alarm Groups in DB Editor. 2. In the Define Alarm Groups dialog box click the by User button in the Sort area. 3. Select the name of a group from the Group Names list. 4. Click the and buttons to move the group name down or up in the list, respectively.

5. Click OK to save changes and quit.

To restore the initial group names and/or sorting order, click the Reload button. This operation is possible only before quitting the dialog box with the OK command.

4.3.8.4

Associating an alarm group to a point

To associate an alam group to a specific point: 1. In the database grid, click the AM tab to display the Alarm Manager configuration fields. 2. In the GROUPS column, double click the cell corresponding to the point you want to associate to an alarm group. 3. The Modify Configuration dialog box is displayed. 4. Click the name of the group you want to associate to the point in the Group Names list. 5. The group name is moved to the Selection Summary list. 6. Each point can be associated to a maximum of 16 alarm groups. 7. To remove the association between a group and the point, click the highlighted group name in the Group Names list. The name is removed from the Selection Summary list.

4.3.8.5

Configuring the read/write mode

Points are always displayed in write mode when you open a database. Thus you can change any field value in the grid. To prevent accidental changes to the data displayed, you can choose command Tools > ReadOnly mode which is applied to the Points grid.

SIMATIC IT Services V4.4 SP2 User Manual

193

Tag Management Since arrays and array elements can be modified only in the Arrays Management window, you need to re-enter the command also in that environment, if you want to obtain the same level of security.

4.3.9 4.3.9.1

Configuring RTDS parameters Entering RTDS parameters to handle communication with a PLC network
1. Click the RTDS tab in the Add Points dialog box. A dialog box displaying the RTDS fields appears. 2. Check the Present box and then enter the following parameters:

Field Name Interface Name

Description Name of the interface used to handle communications between SIMATIC IT Real Time Data Server and a third-party PLC network, in order to read/write field variables. This name is defined during RTDS configuration. Value assigned by default to the variable if the value cannot be read from the field (e.g. due to network communications failure, SIMATIC IT Real Time Data Server and interfaces communications failure). Time class value. The time class is the frequency applied by the interfaces to read values from the network. Six predefined classes are available and each class corresponds to a different sampling time: 0 = variables are not read at predefined intervals by the interface but only upon a specific request from a SIMATIC IT component. 1 = 1 second 2 = 2 seconds 3 = 6 seconds 4 = 10 seconds 5 = 30 seconds 6 = 60 seconds

Safe Value

Class

User Field 1 User Field 2 User Field 3

This field contains information required to access variables via third-party interfaces (e.g. PLC variable name) This field contains information required to access variables via third-party interfaces (e.g. PLC node number) This field contains information required to access variables via third-party interfaces

3. Click the OK button. Points are inserted in the database when you select command File > Save .

4.3.10 4.3.10.1

Configuring historical data Configuring a point to be archived

Tip Detailed information about how compression is performed can be found in the SIMATIC IT Plant Data Archive and SIMATIC IT Historian Data Display documentation

SIMATIC IT Services V4.4 SP2 User Manual

194

Tag Management

In order to enter Plant Data Archive parameters: 1. Click the PDA tab in the Add Points dialog box. A dialog box displaying the Plant Data Archive fields appears. 2. Check the Present box and configure the following Plant Data Archive attributes:
Parameter Minimum Value Maximum Value Class Type Eng. Unit External Compression Internal Compression Description Minimum value the point may assume. Maximum value the point may assume. Select the interval for the point data sampling. See paragraph "Sampling classes". Select one of the available types. See paragraph "Point types to be selected". Measurement unit of the archived point. Parameters requested for external compression calculation. See paragraph "External Compression parameters". Parameters requested for internal compression calculation. See paragraph "Internal Compression parameters".

3. Click the OK button to add the new parameters to the database.

To display the database fields relating to the attributes of the points configured, select the PDA tab. The points are inserted in the database when you select command File > Save .

4.3.11 4.3.11.1

Configuring graphic panels Graphic object attributes

Each graphic object has a set of attributes such as border color, fill color, position, visibility and so on. The attributes can be dynamic or static, depending on whether or not one or more points are associated with them. The static attributes are only for graphic purposes, whereas the dynamic attributes allow you to view the real-time dynamic trend of the individual Plant items. By defining these attributes, it is possible to move an object in all directions, show or hide it, change the fill, border and text color, assign a blinking color, zoom in or out, or turn an enclosed area into a bargraph. For example, you can use a circle to represent a container and view the level of the contained liquid. You can also group more elementary items and handle them as a single object.

Tip For more information on dynamic attributes, see the SIMATIC IT Graphic User Interface documentation

Some parameters, such as threshold colors, min. and max. values, which are standard and often the same for all objects, can be configured directly from the Database Editor .
SIMATIC IT Services V4.4 SP2 User Manual 195

Tag Management

4.3.11.2

Configuring graphic object parameters

To enter GUI parameters: 1. Operating in the Database Editor, select Edit > Point > Add. The Add Points dialog box is displayed. 2. At this point, you must assign a real name and a symbolic name to the point you are inserting: clicking the box. button next to Real Name calls up the Register Definition dialog

3. Make your selections for what concerns Register and Type according to your needs, and click OK: this returns you to the Add Points dialog box. Depending on the selections you made, a real name (consisting in specific initials and a consecutive number) is assigned to the point in question. 4. Operating in the Add Points dialog box, assign the point with a symbolic name (Symbolic Name), and click OK. 5. Now click the GUI tab in the Add Points dialog box, and check the Present box: If you are entering the parameters of a logic variable, the Digital area is enabled; If you are entering the parameters of an integer or real variable, the Analog area is enabled.

The fields to be completed for these areas are described in the table below:
Area Name Digital Fields Analogic True: enter the full or partial string to be displayed when the point has status TRUE False: enter the full or partial string to be displayed when the point has status FALSE Threshold values for HH, H, L, LL Minimum Value and Maximum Value Delta: Percentage by which the points increase or decrease may vary (with respect to the range) Trace Color: color to be used to display the point when in a Trend or Chart graphic object.

To continue entering parameters for: a logic variable, see Parameters of a logic variable. an integer or real variable, see Parameters of an integer or real variable. a slider, see Parameters for a slider. a Trend or a Chart, see Parameters for a Trend or a Chart.

To see how the parameters that you have just configured will be used by the graphic objects, see Parameters used by graphic objects.

4.3.11.3

Parameters used by graphic objects

Parameter

Graphic object

SIMATIC IT Services V4.4 SP2 User Manual

196

Tag Management
Bargraph Zoom Position Alphanumeric Alphanumeric (digital) Trend Minimum Value Maximum Value Minimum Value Maximum Value Minimum Value Maximum Value Minimum Value Maximum Value True (string) False (string) Minimum Value Maximum Value Trace color Chart Minimum Value Maximum Value Trace color Slider Minimum Value Maximum Value Delta Line color (digital) Fill color (digital) Text color (digital) True (color) False (color) True (color) False (color) True (color) False (color)

4.3.11.4

Parameters of a logic variable

Operating in the GUI tab of the Add Points dialog box, to enter additional parameters for a logic variable: 1. Click the True color box to assign a color to the point ON status; the Color dialog box appears. In run-time, the selected color will show when the point is in the ON status. Enter the string to be displayed when the point is in the ON status in place of the On default string. 2. Click the False color box to assign a color to the point OFF status; the Color dialog box appears. In run-time, the selected color will show when the point is in the OFF status. Enter the string to be displayed when the point is in the OFF status in place of the Off default string. 3. Click the OK button. 4. To see the database fields relating to the attributes of the points you have just configured, select the GUI tab at the bottom of the Database Editor window to view the GUI table. The points are actually inserted in the database when you select command File > Save .

4.3.11.5

Parameters for a slider

Operating in the GUI tab of the Add Points dialog box, to enter additional parameters for a slider: 1. In the Delta box, define the percentage by which the point increase or decrease may vary with respect to the range (Minimum Value and Maximum Value).

SIMATIC IT Services V4.4 SP2 User Manual

197

Tag Management 2. Click the OK button.

To see the database fields relating to the attributes of the points you have just configured, select the GUI tab at the bottom of the Database Editor window to view the GUI table. The points are actually inserted in the database when you select command File > Save .

4.3.11.6

Parameters of an integer or real variable

Operating in the GUI tab of the Add Points dialog box, to enter additional parameters for an integer or real variable: 1. In the HH, H, L, LL boxes, enter a numeric constant to define the reference thresholds. 2. For each threshold, click the box next to it to define the color that you want to assign.

Important You must assign five colors in total, as the first box starting from the bottom contains the color associated with the point values that are below the first threshold.

3. Click the OK button.

To see the database fields relating to the attributes of the points you have just configured, select the GUI tab at the bottom of the Database Editor window to view the GUI table. The points are inserted in the database when you select command File > Save .

4.3.11.7

Parameters for a Trend or a Chart

Operating in the GUI tab of the Add Points dialog box, to enter additional parameters for a Trend or a Chart: 1. Double click the Trace color box and choose the color that has to be used for the line that illustrates the points trend or that represents the element in the chart. 2. Click the OK button.

To see the database fields relating to the attributes of the points you have just configured, select the GUI tab at the bottom of the Database Editor window to view the GUI table. The points are actually inserted in the database when you select command File > Save .

4.3.12 4.3.12.1

Repairing the database Recreating the database indexes

You should recreate the index files periodically, in order to compress the database or to solve problems such as the wrong sort order of the points in the database grid. This operation is strongly recommended if the elements of an array are displayed in the wrong order, e.g. element 0 of the array (code E) appears in the list before the header array (code V).

SIMATIC IT Services V4.4 SP2 User Manual

198

Tag Management This operation can be executed only after you have saved all the changes applied to the database. To recreate indexes choose command Tools > Rebuild > Index Files.

4.3.12.2

Rebuilding the database

To rebuild the database, index files and the files relating to the acquisition status of servers, select command Tools > Rebuild > Database.

Important It is strongly recommend that you are careful before selecting this command, because all information about the current acquisition status of servers will be lost.

4.3.12.3

Resetting the server status

To reset the acquisition file of the Alarm Manager/Plant Data Archive/RTDS servers, select command Tools > Reset Servers Status.

4.3.13 4.3.13.1

Printing Printing the database

Printing facilities are provided both in the Points Management and in the Arrays Management environments.

In the Points Management environment, you can send to printer or file: all database points a block of selected points all marked points

In the Arrays Management environment, you can only print: the descriptors of all the arrays displayed in the window the descriptors and the elements of all the arrays displayed in the window

4.3.13.2

Print preview
You can preview a report in order to see it as it will look when printed. Select command File > Print Preview to display a report page. Using the standard Windows buttons you can display two report pages, view the previous or the next page or print the report. To quit the Preview window, click the Close button.

4.3.13.3

Selecting a printer
A database can be printed to any printer configured in the network. Select command File > Print Setup in Database Editor. In the Layout tab you can choose one of the configured printers from the Printer list box. If you choose the Default Printer option, the output will be sent to the printer configured by default from Windows Print Manager.

SIMATIC IT Services V4.4 SP2 User Manual

199

Tag Management

4.3.13.4

Printing records
In the Points Management or Arrays Management windows select command File > Print. The report is automatically sent to the printer you have selected with command File > Print Setup. You can also write the output to a file with command File > Print to File.

4.3.13.5

Printing to file
To print the contents of the current database to file: 1. In the Points Management or Arrays Management windows select command File > Print to File. 2. Enter the name of the file in the File Name box. The file is stored by default in the \plant name\DATABASE directory, but you can choose a different path by clicking the Browse button. 3. Choose the write option: Overwrite: to overwrite the contents of the file Append: to add the output at the end of the file

4. Click the Settings button to configure the print settings. For more information, see Print settings. 5. Click OK to send the output to the selected file.

4.3.13.6

Print settings
Settings of the page to be printed (header, footer, orientation,) can be defined with command File > Print Setup in Points Management or Arrays Management. Headers and footers are printed on each page of the report: you can either select predefined fields or enter any text.

The following predefined fields are available (<EMPTY> means that no text is inserted): DATE TIME DATE + TIME DATABASE NAME LOCREG NAME PAGE NUMBER FREE TEXT (the Free Text edit box is enabled and you can insert any text)

The following print attributes can be defined: header footer page layout filter

SIMATIC IT Services V4.4 SP2 User Manual

200

Tag Management

4.3.13.7

Defining the header

Select command File > Print Setup click the Header tab. in Database Editor. In the Print Settings dialog box

Select Left Center

To define The text which will be printed on the left side of the header. Default is the DATABASE NAME but you can choose any predefined field from the Left Item list box. The text which will be printed at the center of the header. Default is the string "Database Editor" (FREE TEXT), but you can choose any predefined field from the Central Item list box. The text which will be printed on the right side of the header. Default is the LOCREG NAME, but you can choose any predefined field from the Right Item list box.

Right

4.3.13.8

Defining the footer

Select command File > Print Setup click the Footer tab. in Database Editor. In the Print Settings dialog box

Select Left Center Right

To define The text which will be printed on the left side of the footer. Default is <EMPTY> but you can choose any predefined field from the Left Item list box. The text which will be printed at the center of the footer. Default is the PAGE NUMBER, but you can choose any predefined field from the Central Item list box. The text which will be printed on the right side of the footer. Default is <EMPTY>, but you can choose any predefined field from the Right Item list box.

4.3.13.9

Defining the page layout

Select command File > Print Setup click the Layout tab. Enter the following data: in Database Editor. In the Print Settings dialog box

Parameter Printer Extended Format View Format Orientation

Description Select a printer from those configured. Check the boxes corresponding to the tables you want to print. Prints fields so that they can be viewed as a table. Click the Portrait or Landscape button to choose the page orientation.

To check if the view format you have selected fits the page to be printed, click the Test Width button. The Database Editor shows a message about the results obtained. If the view is too large and overrides the page borders, you can change the page layout.

4.3.13.10 Defining the filter

To define the filter for printout: 1. Select command File > Print Setup click the Filter tab.
SIMATIC IT Services V4.4 SP2 User Manual

in Database Editor. In the Print Settings dialog box

201

Tag Management 2. Choose the following options:

Parameter Extract Points Description You can choose whether to print all the points in the database, only the points you have selected or the points to which a bookmark has been assigned. Check the configurations (AM, PDA, GUI, RTDS) you want to export within the Filter Points by Configuration area. These check boxes determine the subset of records which will be exported, as follows: Selected: the program will only export those records which contain these configurations. Unselected: the program will only export those records which DO NOT contain these configurations. Undetermined (selected but shadowed): the program will export all records, whether or not they contain these configurations. By default all records are printed. Show Arrays Elements Check this box if you want to print all the elements of each array.

Filter Points by Configuration

3. Click OK to quit.

4.3.14 4.3.14.1

Customizing the environment Showing/hiding bars

By default the Editor Database shows all the bars in the main window.

To show/hide Toolbar Edit bar Search bar Database Information on the Database

Select command View > Toolbars > Standard View > Toolbars > Edit View > Toolbars > Search View > Point Viewer in Arrays Management View > Database Info

4.3.14.2

Customizing the scroll bars

The Points Management window contains a horizontal and a vertical scroll bar.

With the default settings, when you drag the scroll box on the vertical bar, the status bar displays: the current line number the real name of the point, if the database is sorted by real name the symbolic name of the point, if the database is sorted by symbolic name

By default no information is shown when you scroll the horizontal bar.

With command Tools > Settings > Workspace tab you can change the information which is displayed while scrolling the vertical and the horizontal bar, by checking the following boxes in the Scrollbar Informations area: Show Line Number on vertical scroll
SIMATIC IT Services V4.4 SP2 User Manual 202

Tag Management Show Field Identifier on vertical scroll Show Line Name on horizontal scroll

4.3.14.3

Arranging windows in the client area

All windows in the client area (either in the Points Management, Arrays Management or Locreg Map environments) can be maximized, minimized and arranged according to Microsoft Windows standards. To do this use the commands from the Window menu.

However the following limitations apply: you cannot display the Points Management and the Arrays Management windows concurrently (but you can display the Locreg Map and the Points Management windows at the same time). you cannot open two Points Management or Arrays Management windows at the same time (i.e. you cannot edit two databases at a time).

To restore the default position and size of the windows displayed in the client area when you access the Database Editor, use command Tools > Settings > Workspace tab > Keep Size and Position check box. To always maximize the windows displayed in the client area use command Tools > Settings > Workspace tab > Maximize Windows on Open check box.

4.3.14.4

Changing the font

The type and size of the font used to display data in the Points Management and Arrays Management windows can be changed with command Tools > Settings > Font tab.

The standard Microsoft Windows dialog box appears and you can choose the font type and size. The selected font is applied to all the Database Editor windows (Points Management, Arrays Management and Locreg Map).

4.3.14.5

Changing colors
The Database Editor uses various colours to show the status of points in the database grid. To change the default colours assigned by the system, use command Tools > Settings > Color tab. For more information on default colours, see Typographical conventions used in the database grid. In the Color tab choose one of the following items from the Category list box: TEXT READ-ONLY TEXT LOCKED TEXT LOCKED AND READ-ONLY TEXT BOOKMARK INFO MESSAGE TEXT INFO MESSAGE BACKGROUND ERROR MESSAGE TEXT ERROR MESSAGE BACKGROUND

SIMATIC IT Services V4.4 SP2 User Manual

203

Tag Management Then click a colour icon in the palette to assign a different colour to the selected items.

4.3.14.6

Customizing a view
To customize a view: 1. Select command Tools > Views Management in the Database Editor. 2. Click the Customize Views tab in the Views Management dialog box. 3. In the Views list box select the view you want to customize, either a DB Table view or a User view. 4. In the Fields list box select the field you want to move. 5. Click the Up/Down in the list. buttons to move the field respectively up or down

6. You can also change the following settings by entering new values in the relative fields:
Field Name Field Length Description Label which will be displayed in the column header of the database table. Width (in number of characters) of the column where the field is displayed.

7. Click the Apply button. The Close button allows you to exit the dialog box.

4.3.15 4.3.15.1

Creating a Database Automatic vs. manual database creation

To create a database you can carry out either an automatic, or a manual procedure.

Automatic creation
Upon definition of a new Unit, you are prompted to associate a database and/or project name to the Unit. The database/project can be new, or can be selected from a list of existing names. If the database/project does not exist, you will be prompted to enter a number of parameters required to create the database, when you access the Database Editor or start the programming environment. These parameters differ according to the Unit type: Creating a database associated with a RTDS/IMC Unit Creating a database associated with a Real Time Data Engine Unit Creating a database associated with a CONTROL Unit

Manual creation
You can also create a new database independently of the definition of a Unit; in detail, you can: Create a database from Database Editor Create a database from Database Management

SIMATIC IT Services V4.4 SP2 User Manual

204

Tag Management

4.3.15.2

Creating a database associated with an RTDS/IMC Unit

Upon definition of a new RTDS/IMC Unit, you are prompted to enter a variables database/project name and a locreg name to be assigned to this Unit. If the database/project does not exist, when you access the DB Editor or the programming environment SIMATIC IT Management Console will display the New database dialog box with the following request: The database does not exist, do you want to create it?

Select Bilingual Comment

To Add the Comment (Secondary Language) field to the database. This field is used to insert an additional comment in a language other than that used in the Primary Comment. Option not implemented

Unicode

By confirming this request, a new database is created, and is assigned with both the name entered and the locreg selected during Unit definition. In the Editor Database, you can choose a new locreg to be assigned to the database, provided that the selected locreg is compatible with the current locreg. If this is not the case, some Points might be removed from the database.

4.3.15.3

Creating a database associated with a Real Time Data Engine Unit

Upon definition of a new Real Time Data Engine Unit, the program automatically creates an empty database with the same name as the Unit and associates a default user locreg. This locreg can be configured only from the SIMATIC IT Real Time Data Engine Manager environment.

4.3.15.4

Creating a database associated with a CONTROL Unit

Upon definition of a new CONTROL Unit (which logically represents an Siemens Orsi P.M.C.), you are prompted to enter a variables database/project name and a locreg name to be assigned to this Unit. If the database/project does not exist, when you access the DB Editor or the programming environment, SIMATIC IT Management Console will display the New database dialog box with the following request: The database does not exist, do you want to create it?

Select Bilingual Comment

To Add the Comment (Secondary Language) field to the database. This field is used to insert an additional comment in a language other than that used in the Primary Comment. Option not implemented

Unicode

By confirming this request, the program creates a new database, and assigns to it both the name entered and the locreg selected during Unit definition. In the Editor Database you can choose a new locreg to be assigned to the database.

4.3.15.5

Creating a database from Database Editor

1. Start the Database Editor (For more information, see Starting the Database Editor.), and then select command File > New to create a new database.

SIMATIC IT Services V4.4 SP2 User Manual

205

Tag Management 2. The New database dialog box appears. Enter the following information:
Parameter Name Locreg Bilingual Comment Unicode Description Identifier to be assigned to the database. Alphanumeric string maximum 8 characters. Select the name of a system locreg or user locreg. If you select this check box, field "Comment (Secondary Language)" is added to the database. Option not implemented

Note You can also create a new database by importing a file in .CSV format. For more information, see Importing/exporting a database.

Data Memory Area

4.3.16

Creating a new database

To create a new database in the Database Management environment select command File > New . In the Create dialog box enter the following data:
Description Identifier to be assigned to the database. Alphanumeric string up to 8 characters. Select the name of a system locreg or user locreg If you check this box, field "Comment (Secondary Language)" is added to the database.

Parameter Name Locreg Bilingual Comment

When the database has been created you can select command File >Open Database Editor and insert variables.

to access the

4.4
4.4.1

Locreg management
Defining and displaying the Locreg
When you create a new database, a specific locreg is assigned to each database. See also Database locreg details. However, if you open an existing database, SIMATIC IT Management Console uses the locreg associated with the current Unit. Therefore, if the database locreg and the Unit locreg are not the same, the program issues an error message and displays the locreg structures and the maximum number of registers used in the database, for each type. For more information, see Troubleshooting for different locregs.

SIMATIC IT Services V4.4 SP2 User Manual

206

Tag Management

4.4.2

Database Locreg - Details

Information concerning the locreg is stored in reserved points of the database, which cannot be viewed by the user. This information describes the point structure and, for each register type, the higher number used in the database. Reading this data the program can check the compatibility between the locreg associated with the database and the Unit locreg.

4.4.3

Troubleshooting for different locregs

Locregs not compatible

If the database contains registers not defined in the locreg associated with the Unit, the locregs are not compatible and therefore an error message is issued. You can choose to automatically remove the exceeding registers (please note that if an array exceeds the limits only partly, it will be truncated but the array will not be removed). If you answer No, the points will not be deleted, but the program will check for locreg compatibility each time you open the database, and thus re-issue the error message

Locregs different but compatible

If all the database points fit in the new locreg, a warning message is issued and then the locreg is automatically replaced, since the locregs are compatible.

4.4.4

Assigning a new locreg run-time

You can change the locreg associated with the current database during an editing session. To perform this operation you must first save the database. Please note that the database must have been opened with command File > Open, that is, it must not be currently associated to any Unit. The locreg you choose will be checked for compatibility against the current database locreg and some messages are returned. For more information, see Troubleshooting for different locregs.

To change the locreg: 1. Choose command Tools > Change Locreg in Points Management; the Locreg Selection dialog box lists all the system locregs and user locregs . 2. To assign a new locreg to the database click the User or System buttons: all the User or System locregs, respectively, are listed in the Available Locregs box. 3. Select a locreg in the list box: the current locreg map and the selected locreg map appear in the dialog box. 4. Click OK.

4.4.5

Viewing the locreg map

The locreg map shows in a graphical format the memory area handled by the Unit, subdivided by register type, and the currently allocated registers.

SIMATIC IT Services V4.4 SP2 User Manual

207

Tag Management

Choose command File > Locreg Map window.

in Points Management to view the locreg map

The Map Bar displays the register type, and, for that type, the total number of registers, the number of registers allocated (shown in red) and the number of free registers (shown in teal) To view the register map for a different register type, select the type from the Register Type list box.

The Locreg Summary window (which you can display by dragging up the button line of the window and can hide with command View > Locreg Summary) shows the number of all the registers configured for the current locreg, and the number of allocated and free registers for each type.

You can refresh the locreg map manually by pressing the F5 button. You can also configure the automatic refreshing of the locreg with command Tools > Automatic Refresh. In the Automatic Refresh dialog box check the Enable Automatic Refresh box and then enter the number of seconds in the range between 5 and 3600 in the Time Rate box.

Select commands Points Management or Arrays Management to return to the Points or Arrays Management windows, respectively.

from the menu File

4.5
4.5.1

Database Management Tool

Overview about Points Database Maintenance
The Database Management environment provides a set of tools that help you maintain the databases of all the Units configured in the current Plant. In this environment, you can perform the following operations: Create a new database Open a database Rename a database Browse the database Copy a database Delete a database Convert a database Merge databases Reallocate registers Import/export a database

To start the Database Management environment select the Tools > Database Management command in SIMATIC IT Management Console: the main window lists all the databases defined in the current Plant.

SIMATIC IT Services V4.4 SP2 User Manual

208

Tag Management

4.5.2

The Database Management environment

The Database Management window has two areas: the upper area lists all the databases configured in the current Plant. the bottom area, also called Output Window, is used to display performance results or error messages. Select the folders on the bottom of the Output window to see information relating to the different operations.

For each database, the Database Management window displays the following attributes: Name Type Size LastSaved Locreg Bilingual Auxiliary Files

To re-create the list of the Unit databases select command Window > Refresh

4.5.3

Database attributes
The following table summarizes the various database attributes and their meaning:

Attribute Name Type Size LastSaved Locreg Bilingual

Description Database name For details, see Field: Type. Database dimension expressed in byte. Date and time when the database was last saved. Name of the locreg assigned to the database. For details, see Data Memory Area. Yes means that both primary and secondary language comments have been inserted when creating the database. No means that only primary language comments are available. For details, see Structure of the Points Database .

Auxiliary Files

Auxiliary files include: Two INDEX files with IDR and IDS extension. A FRR file used to handle free registers/bits. An ACQ file used to list the points acquired by the SIMATIC IT servers upon run-time update.

These files are automatically generated when you access the database from the Database Editor environment.

SIMATIC IT Services V4.4 SP2 User Manual

209

Tag Management

4.5.4

Field: Type
The database can be of different type. Depending on the database type the following labels are displayed:

Label [#] or empty field

Description Points database with .CDB extension. The Type field contains the number (in brackets) of the Units to which the database is associated. You can select command File > Details to list all the Unit names. If the field is empty, the database has not been associated to any Unit. File generated with a Merge command in Database Management, if the target file name already exists and the option Automatic Backup has been selected. You can restore the database selecting the command Database > Restore. File created with an Export command in the Database Editor. This file contains a block of records of the database from which it has been exported. Standard text file, generated by external Windows applications such as Excel, Access, etc. This file can be converted and imported to be opened as a standard database. Points database associated with a Real Time Data Engine Unit. Backup copy of a points database associated with a Real Time Data Engine Unit. Obsolete files version 2.03.xx (they are displayed with command Options >Show Obsolete) Obsolete Real Time Data Engine files version 2.03.xx (they are displayed with command Options > Show Obsolete)

Backup

Export .CSV

DE DE bck Old Old - DE

4.5.5

Viewing the Database details

Select command File > Details in the Database Management window to display the Details dialog box which contains the following information: the computer name of the workstation on which the database is being edited and the application used to edit it (e.g. Database Editor). the name of the Units with which the database is associated.

4.5.6

Opening a database (Database Management)

To open one of the databases listed in the Database Management window, select the database and then select the command File > Open .

If you select a .CDB, .XDB or DE database, the Database Editor is started, whereas if you select a .CSV database, the Text Editor is started. You cannot open a database from Database Management if the file is already open in Database Editor or if it is a backup file.

4.5.7

Database-file types
The following table summarizes the various types of database files managed by Database Manager:

SIMATIC IT Services V4.4 SP2 User Manual

210

Tag Management
Type or extension .CDB .CSV Description Standard SIMATIC IT database. Standard text file, generated by external Windows applications (such as Excel, Access, ...) or through conversion. This file can be converted and imported to be opened as a standard SIMATIC IT database. File generated with an Export command in the Database Editor, which contains a block of records of the source database. Standard SIMATIC IT database associated with a Real Time Data Engine Unit. File generated with a Merge command, if the destination file already exists and you have checked option Automatic Backup.

Export

DE Backup

4.5.8

Renaming a database
DE databases cannot be renamed because they are automatically assigned the name of the Real Time Data Engine Unit.

To rename a database: 1. Select the database name from the list. 2. Select command File > Rename. 3. Enter the new database name in the To DB box. 4. Click OK.

The program also renames the auxiliary files (.FRR, .IDR, .IDS, .ACQ), if they exist.

4.5.9

Browsing the database

To view all the points defined in a database select command Database > Browse in Database Management. The Database Browser tool provides a number of filters to view the points according to your needs. The Database > Browse cannot be selected for Backup, Export and CSV files or for databases which do not have auxiliary files.

4.5.10

Copying a database
You can copy a database to a new or to an existing database, thus overwriting the latter.

To copy a database: 1. Select the database name from the list. 2. Select command File > Copy .

3. Enter the new database name in the To DB box

SIMATIC IT Services V4.4 SP2 User Manual 211

Tag Management or select the To DE Unit button to overwrite the database associated to the DE Unit selected. 4. Click OK.

The program also performs the following operations: copies the auxiliary files (.FRR, .IDR, .IDS, .ACQ), if they exist. creates the auxiliary files, if you overwrite a database which does not have these files. removes the auxiliary files, if you overwrite a database which does have these files, whereas the source database does not. copies the user locreg, if a DE database is copied to another DE database or to a .CDB database. copies the user locreg, if a .CDB database is copied to a DE database

4.5.11

Removing a database
Select command File > Delete in Database Management to remove the selected database. You can remove the whole database or only the auxiliary files (Auxiliary Files Only check box). In this case you can choose to remove: Index files (FRR, IDR, IDS extensions) Acquisition file (ACQ extension)

4.5.12

Reallocating registers
Select command Database > Packed reallocation in Database Management to sort the selected database, and perform the following additional operations: Pack the records Remove unused spaces by renaming registers in order to optimize their use (e.g. records RI0 REC1 and RI5 REC2 would be transformed into RI0 REC1 and RI1 REC2)

4.5.13

Importing/exporting a database
To import a database select command File > Import in Database Management. In the Database to be Imported dialog box select the database to be imported, from any local or remote Plant, or from a floppy disk: SIMATIC IT Database (with extension CDB or RDB). The locreg associated with the database is automatically imported. SIMATIC IT Export Database (with extension XDB), Comma delimited file (with extension CSV) Locreg file (with extension LCG)

By selecting command File > Export, you can choose that the database is copied to drive a: or b:. The database can be exported with its auxiliary files and with the user locreg associated with the database, provided that the corresponding boxes (Auxiliary Files and User Locreg). have been checked.

SIMATIC IT Services V4.4 SP2 User Manual

212

Tag Management

4.5.14 4.5.14.1

Conversion Creating a CSV file

A .CSV file is a standard text file containing a list of variables, generated by external applications such as Excel, Access, etc. This file must be edited with an appropriate syntax and, in order to obtain a database that can be used by SIMATIC IT, it must be converted. For more information, see Converting a .CSV file into a SIMATIC IT database (.CDB).

CSV file layout:

First line It has the following format: <table identifier>;<keyword>;<locname> where <table identifier> = Cube_MAIN, Cube_RTDB, Cube_ADB, Cube_PDB or Cube_GMS <keyword> = keyword used to quickly select the csv files relating to the same database (optional) <locname> = the locreg name (optional) (only for the Main table). Second line The heading order can be different from the default one, provided that: for the Main table, field Type always precedes field DefaultValue; for the other tables, Symbolic and Description are always the first two fields (this to maintain the link with the Main table). The conversion program only checks whether the Min and Max fields of the PDA and GUI tables have the same values. If not, the user will be prompted to choose the value to be assigned to both tables. Fields (not all must necessarily be present) are not case sensitive. Main Table Record Header: Symbolic;Description;Type;Register;Comment1;Comment2;SettingLevel;Def aultValue RTDS Table Record Header: Symbolic;Description;Interface;Class;Safevalue;User1;User2;User3 AM Table Record Header: Symbolic;Description;Interface;Servers;Priority;Archivable;Printable;Loadmo de;Activeconf;Alert;Comment; Logic;Addmsg;Message1;Message2;Graphpage PDA Table Record Header: Symbolic;Description;Min;Max;Servers;Deltaext;Tminext;Tmaxext;Deltaint;T minint;Tmaxint;Engunit;Class; Activeconf;Type GUI Table Record Header: Symbolic;Description;Min;Max;Dig1_On;Dig2_On;Dig1_Off;Dig2_Off; Ana1_On;Ana2_On;Ana3_Onna4_On;Ana5_On;Ana1_Off;Ana2_Off;Ana3_Off ;Ana4_Off;Ana5_Off; Thrhh;Thrh;Thrl;Thrll;Color;Delta;String_On;String_Off Third line and all subsequent lines Values of record fields, separated by the ; (or other) symbol.

Keywords: Symbolic Type Register

SIMATIC IT Services V4.4 SP2 User Manual 213

Tag Management Comment1 Comment2 Description

For a detailed description of the keywords available for the other database tables, see Structure of the Points Database.

4.5.14.2

Keyword: Symbolic
Symbolic identifier of the database variable. Alphanumeric string up to 15 characters. This field is mandatory.

4.5.14.3

Keyword:Type
Variable type. Allowed values (can be entered both with uppercase and lowercase letters): I = integer B = boolean (logical) F = float (real) C = character This field is mandatory. It can be omitted only for array elements. The register type can be indicated next to the variable type. If this data is omitted, type P (Permanent) is assumed by default. P or blank = permanent R = not permanent A = alarm B = backup I = input O = output

4.5.14.4

Keyword: Register
Register to which the variable is to be associated. This field is optional. If no register is specified, the program will automatically allocate a new register. But if you indicate a register number, the record will be locked in the SIMATIC IT database.

4.5.14.5

Keyword: Comment1
First comment of the variable. String up to 40 characters. Optional.

4.5.14.6

Keyword: Comment2
Second comment of the variable. String up to 40 characters. Optional. If the database is monolingual this field must not be used.

4.5.14.7

Keyword: Description
Letter which indicates the type of variable:

Identifier

Description

SIMATIC IT Services V4.4 SP2 User Manual

214

Tag Management
empty Vn Ei Bx BxEi I IEi scalar array with dimension n element position within the array position of the bit within the integer variable position of the bit within the i-th integer element of an array integer which overlaps the logic array integer which overlaps the logic array starting from the i-th word

Records describing an 'element' need to be specified only when one or more fields (e.g. symbolic name, comment, etc.) differ from the default array values. Lines containing the description of array elements must be inserted immediately after the line describing the array header. Lines containing the description of bits must be inserted immediately after the line describing the integer element. Field Type can be omitted for array elements.

4.5.14.8

Example of CSV File

Important The first line must contain the field headings.

Example with Main table Symbolic;Register;Type;Description;Comment1;SettingLevel

BOOLEAN;FI0.[0];B;;COMMENT;1 ARRAY;FI1;I;V10;ARRAY COMMENT;1 BOOL_IN_ARRAY;FI5.[7];B;;;1 ALARM;;IA;;;1 INTEGER;;IP;;INTEGER COMMENT;1 BOOL_IN_SCAL;;;B5;;1 ARRAY_2;;IP;V10;;1 BIT_IN_ARRAY_2;;;B6E4;;1 Logic variable (not dynamically allocated) Array of integers with 10 elements which must begin from FI1 (not dynamically allocated) Logic variable: eighth bit of integer variable FI5 (fifth element of ARRAY) (not dynamically allocated): Integer scalar alarm (dynamically allocated) Integer variable (dynamically allocated) Logic variable allocated in bit 5 of INTEGER Integer array of 10 elements (dynamically allocated) Logic variable allocated in bit 6 of element 4 of ARRAY_2)

4.5.14.9

Converting a database
When converting a database, you can perfom the following types of conversion: conversion of a SIMATIC IT database (.CDB) into a .CSV file; conversion of a .CSV file into a SIMATIC IT database (.CDB); conversion of the format of a SIMATIC IT database (.CDB).

4.5.14.10 Converting a SIMATIC IT database (.CDB) into a .CSV file

1. Select command Database > Save as CSV in Database Management to convert a standard SIMATIC IT database (RDB extension) into a text file which can be edited with DOS or Windows applications (Excel, Access, ). 2. In the CSV Format dialog box enter the following values:

SIMATIC IT Services V4.4 SP2 User Manual

215

Tag Management
Parameter Lock Registers Comment Highlight Description Check this box if registers have NOT to be re-allocated during conversion Check this box if comment fields (primary and/or secondary language) have to be placed at the beginning of each record (this option is useful, for instance, for translating comments quickly)

3. Type a string, which will be used to quickly search for the .CSV files generated by this conversion, in the Keyword box. The default string is the database name. 4. Enter in the Comma Separator box a character (NOT alphanumeric) that will be used as a separator between the different record fields. 5. Select the Tables button to choose the tables to be read from the database and converted in the destination database. 6. Click the OK button. 7. At the end of the conversion the CSV Destination File Names dialog box appears. Please note that only boxes relative to tabs available in the database are enabled. Insert the name of relative tabs. 8. Click the OK button.

If errors are found, at the end of the conversion, the program asks for a name for a file where records skipped due to errors, are automatically inserted

4.5.14.11 Converting the format of a SIMATIC IT database (.CDB)

You can convert a SIMATIC IT database (CDB type) into another SIMATIC IT database (.CDB extension) but with a different format, that is: with/without bilingual comment with a different locreg (Locreg box)

1. Select Database > Convert in Database Management and enter the following parameter:
Parameter Pack Bilingual Comment Description Check this box if registers have to be re-allocated during conversion Check this box if you want the format with bilingual comment

2. In the Locreg drop down list box select the locreg to associate to the new database. 3. Select the Tables button to choose the tables to be read from the database and converted in the destination database. 4. Click the OK button.

Important If you want abort the operation select the Abort button in the Working progress dialog or select the command Database > Stop Conversion.

5. At the end of the conversion the Destination dialog box appears.

SIMATIC IT Services V4.4 SP2 User Manual

216

Tag Management
Select Name To DE Unit To Enter the Identifier of the target database To overwrite the database associated to the Real Time Data Engine Unit selected. If you click this button, you can only choose the Bilingual Comment option, if required. All other options are set by the program.

6. Click the OK button.

If errors are found, at the end of the conversion, the program asks for a name for a file where records skipped due to errors (which are not notified) are automatically inserted

4.5.14.12 Converting a .CSV file into a SIMATIC IT database (.CDB)

You can convert a CSV file, previously imported, into a CDB or DE type database. For information on the various file types, see Database-file types. This particular type of conversion can either include the Main tab, thus generating a new database that contains all the records extracted from it, or exclude the Main tab (in this case, the tabs to be converted are inserted into an existing reference database).

4.5.14.13 Conversion with Main tab

If you convert with the Main tab, a new database, which will contain all the records extracted from the Main tab, is generated.

To perform conversion with Main tab: 1. Select a CSV file from the Database Management window. 2. Select command Database > Convert 3. The Convert CSV File dialog box appears. Enter the .CSV files to be converted in one of the following ways: Type their names in the Main, RTDS, AM, PDA, GUI edit boxes, respectively. Select them from the list and click the arrow button to move them to the Main, RTDS, AM, PDA, GUI edit boxes, respectively.. Perform a guided search by using a keyword (button Automatic Selection Based On) .

4. In the Locreg drop down list box, select the locreg to be associated to the new database. 5. Check Pack box if registers have to be re-allocated during conversion 6. Check Bilingual Comment box if the new database must include/contain the "Comment (Secondary Language)" field 7. Click the OK button.

Important If you want abort the operation select the Abort button in the Working progress dialog or select the command Database > Stop Conversion.

8. At the end of the conversion the Destination dialog box appears:

SIMATIC IT Services V4.4 SP2 User Manual

217

Tag Management

Select Name To DE Unit

To Enter the Name of the target database To overwrite the database associated to the Real Time Data Engine Unit selected. If you click this button, you can only choose the Bilingual Comment option, if required. All other options are set by the program.

9. Click OK.

Important You can save records skipped due to errors in .CSV files that correspond to the source tab.

4.5.14.14 Conversion without Main tab

If you convert without the Main tab, the tabs to be converted are inserted into an existing reference database.

To perform conversion without Main tab: 1. Select a CSV file from the Database Management window. 2. Select command Database > Convert .

3. The Convert CSV File dialog box appears. 4. Enter the .CSV files to be converted in one of the following ways: Type their names in the RTDS, AM, PDA, GUI edit boxes, respectively. Select them from the list and click the arrow button to move them to the RTDS, AM, PDA, GUI edit boxes, respectively. Perform a guided search by using a keyword (button Automatic Selection Based On)

5. Select the database into which you want to insert the tabs to be converted from the Database Name list box. 6. Check the Overwrite Tables box to overwrite the tabs that already exist in the reference database. 7. Click OK.

Important If you want abort the operation select the Abort button in the Working progress dialog or select the command Database > Stop Conversion.

8. At the end of the conversion the Destination dialog box appears.

Select Name To DE Unit To Enter the Name of the target database To overwrite the database associated to the Real Time Data Engine Unit selected. If you click this button, you can only choose the Bilingual Comment option, if required. All other options are set by the program.

9. Click the OK button.

SIMATIC IT Services V4.4 SP2 User Manual 218

Tag Management

Important You can save records skipped due to errors in .CSV files that correspond to the source tab.

4.5.15 4.5.15.1

Merging Merging databases

You can insert the contents of the selected database into another database (.CDB or DE type) called "reference" database. This program also performs congruence checks and re-allocations, if required.

To perform a database merge: 1. Select the database you want to merge in Database Management. 2. Select command Database > Merge . The draft cursor appears.

3. Select with the draft cursor the destination database. 4. Double click on it or select the command Database > Start Merge.

Important If you want abort the operation select the Abort button in the Working progress dialog or select the command Database > Stop Merge.

5. At the end of the conversion the Destination dialog box appears.

Select Name To DE Unit To Enter the Name of the target database To overwrite the database associated to the Real Time Data Engine Unit selected. If you click this button, you can only choose the Bilingual Comment option, if required. All other options are set by the program.

6. Click the OK button.

If errors are found, at the end of the conversion, the program asks for a name for a file where records skipped due to errors (which are not notified) are automatically inserted

4.5.15.2

Register Reallocation
During the merge process, the program performs consistency checks and re-allocates some variables of the database, if required.

Consistency checks concern the following database fields: symbolic name;

SIMATIC IT Services V4.4 SP2 User Manual

219

Tag Management real name; attribute (scalar, array, array element, array size).

The following general rules will be applied in the event that conflicts between two records should occur: Same symbolic name and attribute, different registers but with same type Different symbolic name or attribute, but same real name Same symbolic name Variable available only in the database to be imported

Same symbolic name and attribute, different registers but with same type
In this case the Reference Database takes priority. If the record to be imported is locked or the real name refers to an I/O register (II, OI), an error message is generated.

Example
Database Field Symbolic name Real name Attribute Reference DB Delta RF100 Scalar DB to be Imported Delta RF108 Scalar

In the Destination Database the DELTA variable will be associated with register RF100.

Different symbolic name or attribute, but same real name

In this case the variable to be imported will be reallocated in a new register. If the record to be imported is locked or the real name refers to an I/O register (II, OI), an error message is generated.

Same symbolic name

Arrays with the same symbolic name must match perfectly, that is, must have exactly the same size and name: if either condition is not verified, an error message will be generated.

Variable available only in the Database to be Imported

If a variable of the Database to be Imported is not stored in the Reference Database and the corresponding register is not locked, the variable will be added to the Destination Database and the associated register will be reallocated. However, if the variable in the Database to be Imported is locked, reallocation cannot be carried out, and therefore the variable will be inserted into the Destination Database only if the corresponding register is not already used in the Reference Database. Please note that I/O (II, OI) registers are never reallocated.

4.5.15.3

Example
Variables in the Database to be Imported

SIMATIC IT Services V4.4 SP2 User Manual

220

Tag Management
Symbolic Name VL_RAA VL_RCC VL_RDD Register RI0 RI1 PF1 Locked NO YES YES

Variables in the Reference Database

Symbolic Name VL_RFF VL_RKK Register RI0 RI1 Locked / /

Variables in the Destination Database

Symbolic Name VL_RAA VL_RDD VL_RFF VL_RKK Register RI2 PF1 RI0 RI1 Locked NO YES / /

Variable VL_RCC cannot be added to the Destination Database since the corresponding register (RI1) is locked and is already used by another variable (VL_RKK) in the Reference Database. Variable VL_RDD is locked but can be added to the Destination Database since register PF1 is not used by any variable in the Reference Database.

4.5.15.4

Reallocation rules
The following rules will be applied for register reallocation: 1. If not otherwise specified, any variable will be reallocated in a register of the same type as the variable register, beginning from an offset which corresponds to the highest register number occupied in the Reference database plus one. The record will not be locked. 2. If you specify the register type (e.g. PI), the new record will be automatically allocated and will be locked. 3. If you specify the register name (e.g. PI41), the new record will be automatically created and locked. 4. For logical variable allocation the usual rules are applied, except in the case that the logical variable is associated to the bit of a register defined also as integer variable. In this case the logical variable will be reallocated in the integer register used to reallocate the integer variable and the corresponding bit.

4.5.15.5

Example of register reallocation

The following variables are defined in the Database to be Imported:

VMASK V_ON

RI40 RI40.[5]

SIMATIC IT Services V4.4 SP2 User Manual

221

Tag Management If all RI registers up to 999 are occupied in the Reference Database, reallocation will proceed as follows:
VMASK V_ON RI1000 RI1000.[5]

In the event that the integer variable is defined also in the Reference Database, conflicts might arise. In this case the integer variable register and the corresponding bits of the Reference Database are maintained.
Reference Database VMASK V_ON V_OFF RI500 RI500.[2] RI500.[3] Database to be Imported VMASK V_ON HI_LEV RI460 RI460.[2] RI460.[3]

The HI_LEV variable is not inserted into the Database.

4.5.15.6

Congruence of the database Locregs

Before starting to merge the databases the program will verify the congruence of the Locregs associated with the two Databases. The following situations might occur:

Locregs are different but compatible

The Locreg of the Database to be Imported is different from the Locreg of the Reference Database but the two Locregs are compatible (i.e. the Reference Database does not contains registers outside of the range of the locreg of the Database to be Imported).

Locregs are different and incompatible

The Database to be Imported contains variables associated to registers which exceed the limits of the range of the Reference Database Locreg.

In either case the program will issue a warning message and will associate the Reference Database Locreg to the Destination Database.

4.6
4.6.1

Database Browser
Overview of the Database Browser
The Database Browser is a general-purpose tool, which can be started from any SIMATIC IT application to quickly search for variables defined in the database of a specified Unit.

When you start the Database Browser from any SIMATIC IT environment the DATABASE NAME: database name dialog box appears. This dialog box lists the names of all the variables (i.e. points) defined in the current database. For each point, the following attributes are displayed:
SIMATIC IT Services V4.4 SP2 User Manual 222

Tag Management Symbolic Name Register Type Description

To display all the tables and fields of a point, click the Viewer button. For a detailed description of each table, see Structure of the Points Database.

To expand the array on which you are positioned and list all its elements, click the button Expand. To restore the default view, click the button Collapse.

By default the database records are listed in ascending order by the SYMBOLIC NAME field (Sorting order: Symbolic). All the scalar variables, the array headers and the array elements with Symbolic Name other than the corresponding array name are listed (Display format: Normal).

4.6.2

Selecting a different Unit

By default, the Database Browser shows the points defined in the database associated to the current working Unit. By clicking button Unit in the Database Browser window, you can choose any other Unit defined in your Plant. The Database Browser will automatically display the points configured in the database associated with the Unit you have selected.

4.6.3 4.6.3.1

Finding records Finding Records

All the search types described can be used either alone, or combined together to carry out more complex searches.

Standard searches:
Searching by Point Type Searching by Symbolic Name

The results of a standard search are usually displayed in Normal format. The status bar shows the criteria applied to the current search. These codes are displayed in black if the Normal display format is currently applied, in red if the Extended format has been chosen.

Advanced searches:
Searching by Comment Searching by Record Type Searching by RTDS Fields
SIMATIC IT Services V4.4 SP2 User Manual 223

Tag Management Searching by Configuration

4.6.3.2

Searching by Point Type

To search by Point Type: 1. Click button Filter in the DATABASE NAME: database name window; the Filter Selection dialog box appears. 2. Check the By Type box in the Search area. 3. Check one or more Filter on Type boxes (Integer, Real, Logic, Character). 4. Click the Search button. The records found are listed in the DATABASE NAME: database name window.

4.6.3.3

Searching by Symbolic Name

To search by Symbolic Name: 1. Click button Filter in the DATABASE NAME: database name window; the Filter Selection dialog box appears. 2. Check the By Name box in the Search area. 3. Enter a string corresponding to the symbolic name of the point in the Filter on Name box. You can use wildcards ? and *. For example, type ? to find any single character (N?ME), or type * to find any string of characters (NAME*). 4. Click the Search button. The records found are listed in the DATABASE NAME: database name window.

4.6.3.4

Searching by Comment
To search by Comment: 1. Click button Filter in the DATABASE NAME: database name window; the Filter Selection dialog box appears. 2. Click the Advanced button. The Advanced Filter dialog box appears. 3. Enter a string in the Filter on Comment box. You can use wildcards ? and *. For example, type ? to find any single character (C?MMENT), or type * to find any string of characters (COMME*). 4. Click OK to return to the DATABASE NAME: database name window. 5. Click the Search button. The records found are listed in the window.

Search is performed on field "Comment (Primary Language)" or "Comment (Secondary Language)" according to the option selected with command Configuration > System > Workstation Configuration tab in SIMATIC IT Management Console (area Comment Display, button First comment or Second comment).

4.6.3.5

Searching by Record Type

To search by Record Type: 1. Click button Filter in the DATABASE NAME: database name window; the Filter Selection dialog box appears. 2. Click the Advanced button. The Advanced Filter dialog box appears.

SIMATIC IT Services V4.4 SP2 User Manual

224

Tag Management 3. In the Filter on Type area check the Scalar and/or Vector boxes to find all scalar and/or array records. 4. Click OK to return to the DATABASE NAME: database name window. 5. Click the Search button. The records found are listed in the window.

4.6.3.6

Searching by RTDS fields

To search by RTDS fields: This search type can be performed only for records with RTDS table. 1. Click button Filter in the DATABASE NAME: database name window; the Filter Selection dialog box appears. 2. Click the Advanced button. The Advanced Filter dialog box appears. 3. Enter the strings to be used for finding records in the Interface Name, User1, User2, User3 fields. You can use wildcards ? and *. For example, type ? to find any single character (C?MMENT), or type * to find any string of characters (COMME*). 4. Click OK to return to the DATABASE NAME: database name window 5. Click the Search button. The records found are listed in the window.

To restore the default values for all the fields (character *), click the Disable button

4.6.3.7

Searching by Configuration
To search by Configuration: 1. Click button Filter in the DATABASE NAME: database name window; the Filter Selection dialog box appears. 2. Click the Advanced button. The Advanced Filter dialog box appears. 3. Check the Filter on Configuration box. 4. Click the AND/OR option button and check one or more tables (AM, GUI, PDA, RTDS). For example, check OR, AM and PDA to find all records with AM or PDA table. Check AND, AM and RTDS to find all records with AM and RTDS table. 5. Click OK to return to the DATABASE NAME: database name window. 6. Click the Search button. The records found are listed in the window. 7. To display the tables of the records, click the Viewer button.

Note: When the RTDS check box is selected, you can specify search values in the fields of the Filter on RTDS Fields area

4.6.3.8

Choosing the Sorting Order

Records in the database can be sorted in ascending order by: SYMBOLIC NAME choosing Symbolic in the Mode area of the Filter Selection dialog box (button Filter) REAL NAME (i.e. Register Name) choosing Real in the Mode area of the Filter Selection dialog box (button Filter)

SIMATIC IT Services V4.4 SP2 User Manual

225

Tag Management

4.6.3.9

Choosing the Display Format

By default, records in the database are displayed in Normal format when you perform a standard search, and in Extended format when you carry out an advanced search. However, you can also select the Display Format: 1. In the Database Browser window, click Filter. 2. In the Display Format area of the Filter Selection dialog box, choose one of the following options: Normal Extended Compressed

3. Click Search to quit.

4.6.3.10

Display Format: Normal

With Symbolic sorting order, the following information is displayed: all scalars all array headers all array elements with symbolic name other than the corresponding array header name

With Real sorting order, the following information is displayed: all scalars all array elements

Note Keep in mind that, when the Symbolic sorting order is chosen, records are listed in ascending order by SYMBOLIC NAME. Instead, when the Real sorting order is chosen, records are listed in ascending order by REGISTER NAME.

4.6.3.11

Display Format: Extended

The following information is displayed: all scalars all array headers all array elements, listed beneath the corresponding array header. These elements are sorted by register name.

This display format is supported only if you choose the Symbolic sorting order, in which records are listed in ascending order by SYMBOLIC NAME.

4.6.3.12

Display Format: Compressed

The following information is displayed: all scalars all array headers

SIMATIC IT Services V4.4 SP2 User Manual

226

Tag Management

This display format is supported only if you choose the Symbolic sorting order, in which records are listed in ascending order by SYMBOLIC NAME.

SIMATIC IT Services V4.4 SP2 User Manual

227

Real Time Data Server

Real Time Data Server

5.1
5.1.1

Overview
What is SIMATIC IT Real Time Data Server?
SIMATIC IT Real Time Data Server is a software layer building up a bridge between SIMATIC IT components and field devices. It manages a common data memory for all data coming from the field, making it available to all upper-level components.

Configuring
Tags to be handled by SIMATIC IT components must be mapped to RTDS "points", whose definition is stored in a proprietary Database, also known as "Data Dictionary".

Initializing
RTDS reads the configuration of these points from the Database when it is started, and dynamically updates the memory area. If the configuration of some RTDS points is later updated from the Database Editor, it is possible to download these changes to the SIMATIC IT Real Time Data Server, without stopping it.

Reading
RTDS polls the device drivers and updates the values stored in the memory area. SIMATIC IT components read updated tag values from this memory area and deploy them for process management tasks.

Writing
SIMATIC IT components can set the values of tags at any time, by simply writing the new value to the memory area. RTDS forces these values to the device drivers. The Real Time Data Server can manage Integer, Float and Character registers.

SIMATIC IT Services V4.4 SP2 User Manual

228

Real Time Data Server

5.1.2

Starting SIMATIC IT Real Time Data Server

To launch SIMATIC IT Real Time Data Server: 1. In SIMATIC IT Management Console, click the 2. Select the icon of the RTDS/IMC Unit tab.

you want to use.

3. Select command Unit > Real Time Data Server > Start RTDS. SIMATIC IT Real Time Data Server is started.

Important This command is enabled only if you have selected an RTDS/IMC Unit and if the computer name assigned to the logical Unit is the same as the current workstation name.

SIMATIC IT Real Time Data Server has no user interface. To check if RTDS is running (two RTDS instances cannot be started concurrently on the same workstation) view the Management Console Tasklist in the System Toolbox. For more information, see Management Console Tasklist.
SIMATIC IT Services V4.4 SP2 User Manual 229

Real Time Data Server

SIMATIC IT Real Time Data Server can be configured in hot backup.

Tip For more information, see manual Managing Communications with External Devices Users Guide.

5.1.3

RTDS polling classes

Real Time Data Server can read point values from the device drivers at different time intervals and store them in the RTDS memory area. These time intervals are defined by default by the points polling class, which is configured when defining the point in the Database (Data Dictionary). RTDS provides the following polling classes (those written in blue behave differently with respect to the other classes):

Polling class Class 0 ("on request") Class 1 Class 2 Class 3 Class 4 Class 5 Class 6 Class 7 ("high priority")

Polling interval Not read 1 sec 2 sec 6 sec 10 sec 30 sec 60 sec 500 ms

Class 1 / 2 / 3 / 4 / 5 / 6
RTDS reads the point values cyclically according to the time interval specified by the class.

Class 0
This class specifies that the point value is not read cyclically, rather its value is acquired only when a component issues a specific read request. When a component requests to read a value, the point class is dynamically changed and set to the appropriate polling class e.g., if a component needs to read a tag value every 6 seconds, RTDS will set the polling class to 3). The behaviour of class 0 points can be configured by the user in order to be optimized for the users specific process needs.

Important SIMATIC IT Real Time Data Engine and IMC do not support dynamic class change management. Therefore, points managed by these components must be configured with classes different from 0.
SIMATIC IT Services V4.4 SP2 User Manual 230

Real Time Data Server

Class 7
It is a hidden class and cannot be configured by the user. It is used to exchange data on highpriority queues. It causes a class change to happen when values are read from the ODS or GUI environments.

5.1.4

Dynamic class change

The RTDS polling class represents the default, i.e. the frequency at which the point is read if no SIMATIC IT component requires it. However, it is always possible for SIMATIC IT components to change a slower polling class to a higher one, by simply issuing a read request. This process is known as "dynamic class change". Dynamic class change takes time, therefore it must be carefully planned.

Dynamic class changes with class-0 points

Dynamic class changes also occur when class-0 points are used. Since a point defined in class 0 is read only when a component needs it, using class 0 is appropriate for points which do not need to be refreshed frequently. This configuration optimizes the number of points to be read, minimizes the number of requests sent to device drivers and decreases the system workload. For example, if you have hundreds of variables in class 0 and you request them from SIMATIC IT Graphic User Interface by repeatedly changing panels, the system will always switch new requested variables from class 0 to class "n" and then back, when changing panel. This overloads the system workload and is not a recommended configuration.

Remarks
There is no "general rule" to decide which is the most appropriate polling class for a variable. Generally speaking, the class must represent a meaningful refresh time for each variable, according to the process needs.

5.1.5

Dynamic class change scenarios

SIMATIC IT Graphic User Interface scenario

Point TANK_LEVEL is configured with RTDS polling class 6 (1 minute refresh rate) in the Data Dictionary. SIMATIC IT Graphic User Interface loads a graphic panel, with refresh rate 1 second, containing a tank to which point TANK_LEVEL is associated. Upon loading, the TANK_LEVEL point polling class is automatically changed to 1 (1 second polling rate). When the panel is unloaded, it returns to class 6.

SIMATIC IT Alarm Manager scenario

The Boolean point TANK_LEVEL_ALARM is defined in the Data Dictionary with RTDS polling class 3 (3 seconds refresh rate). Then it is configured as a highest priority alarm in Alarm Manager (default refresh rate: 0.5 seconds). The system will always try to refresh the point with the priority established by Alarm Manager, even if the RTDS polling class is slower

SIMATIC IT Services V4.4 SP2 User Manual

231

Real Time Data Server

SIMATIC IT Plant Data Archive scenario

The real point OIL_TEMPERATURE is defined in the Data Dictionary with RTDS polling class 6 (60 seconds refresh rate). Then it is configured in PDA as a class 2 archiving (sampling rate: 3 seconds). The system will always try to refresh the point with the priority established by PDA, even if the RTDS polling class is slower.

Remarks
In general, if the refresh rate configured for a PDA/AM point is less than the RTDS polling class defined in the Data Dictionary, a process is started which causes the tag to be managed by the SIMATIC IT Real Time Data Server driver in a polling class associated with a time value that is less than or equal to the value set by PDA / AM component.

5.1.6

Reading and writing arrays with RTDS

Reading: from device drivers to RTDS

When an array is defined, the whole array is always associated with the same class defined in the array header. When getting data from the device driver, if all the elements are defined in such a way that they are really contiguous also on the PLC side, RTDS always reads all array elements in block.

Writing: from RTDS to device drivers

Independently of their class, all points can be set at any time by SIMATIC IT components and external applications.

By default, each element of an array is written independently of any other array element.

However, several drivers (e.g., the OPC Client driver) allow you to configure an array in such a way that all its elements are written to RTDS, even if just the value of one element changes. To do this, you must enter an appropriate keyword in the UserField3 field of the Data Dictionary. It is strongly recommended that you refer to the online documentation of each driver for more information.

5.1.7

Installing and Configuring the SIMATIC IT Real Time Data Server Drivers
The following RTDS drivers are supplied in order to exchange data with the relevant field devices, via the Real Time Data Server memory area. MODBUS - MODBUS PLUS Driver OPC Client Driver Siemens 3964R Driver

If you need to communicate with other field devices not listed above, you can create your own drivers.

Tip

SIMATIC IT Services V4.4 SP2 User Manual

232

Real Time Data Server

For more information, see manual "SIMATIC IT Driver Development Kit User Manual"

5.1.8

Data exchange between SIMATIC IT Real Time Data Server and the RTDS interfaces

5.1.9

Updating the SIMATIC IT Real Time Data Server

Changes to the Database Editor can be applied to SIMATIC IT Real Time Data Server in two different ways: By shutting down SIMATIC IT Real Time Data Server and starting it again. In this manner RTDS reads the whole configuration and automatically loads new points. This method is recommended when a large number of changes has been applied. By dynamically updating SIMATIC IT Real Time Data Server without shutting it down. This can be obtained as follows:

To update SIMATIC IT Real Time Data Server: 1. Select command Configuration > Real Time Data Server from SIMATIC IT Management Console. The RTDS tab of the Server Configuration window is displayed. 2. If necessary, connect to the SIMATIC IT Real Time Data Server instance you want to update button. In a hot-backup configuration, this command allows you to by clicking the connect only to a master RTDS. 3. Click the button on the toolbar.

4. If RTDS is successfully updated, a detailed description of the operations performed during the update transaction (e.g. number of added, changed and deleted points) will be reported in a log file. To view this log file click the 5. Otherwise an error message will appear. button on the toolbar.

Note: The number of points currently loaded in the SIMATIC IT Real Time Data Server can be displayed by clicking the button on the toolbar and then the More Info button.

SIMATIC IT Services V4.4 SP2 User Manual

233

Real Time Data Server

5.1.10

Troubleshooting the RTDS update

Too many modification on single array(s)

Too many changes have been applied to a single array. Shut down the RTDS and restart it. In this way all changes will be automatically loaded by the SIMATIC IT Real Time Data Server.

Database locked.
Online update cannot be performed since the database is locked (either because it has been opened or, for example, due to file replication). Close the Database Editor or wait for a few minutes and then retry.

Generic error
A generic error has occurred. Read the private RTDS log file or the interface log file.

Interface(s) not configured or obsolete

The RTDS interface does not exist (for instance, an invalid interface name has been entered in the Database Editor) or the interface is obsolete and does not support online modifications.

Interface not connected

The RTDS interface has not yet connected to SIMATIC IT Real Time Data Server Wait until the interface connects to SIMATIC IT Real Time Data Server or verify if the interface has been correctly configured and launched. See the Message Alerter for more details.

Slave server not ready

In a hot-backup configuration, the slave RTDS server is not synchronous (i.e. it has not been completely aligned yet) or the interfaces connected to the slave server have not finished reading the database. Retry later when the above operations have been completed.

Update in progress
The server is updating, but another Update request has been issued. Retry later when the current update is completed.

Update successfully executed only partially

RTDS can acquire a limited number of changes from the Database Editor in a single update transaction. Click the Update button to start another update transaction when the previous one is completed.

SIMATIC IT Services V4.4 SP2 User Manual

234

Real Time Data Server

5.2
5.2.1

Data Memory Area

Data Memory Area
SIMATIC IT manages one or more logical Units, each associated with a memory area, which is used by applications to read and write data. These memory areas are handled differently according to the configuration used. The memory area occupies 64Kb by default, but this size can be modified by the user up to a maximum of 512 Kb, for some Unit types (currently this size is supported only for Real Time Data Engine and RTDS/IMC Units). The configuration of the memory area is described in a file, called LOCREG, which defines the number of registers for each type (integer, floating, character, etc.). SIMATIC IT Services provides a number of System Locreg classes that can be modified by the user to create User Locregs.

Each locreg handles both User Registers and System Registers , which can only be updated from SIMATIC IT Management Console. SIMATIC IT Real Time Data Server supports Integer, Float and Character data types.

The variables (points) used by all SIMATIC IT applications are physically represented by these memory registers. The association between the register name and the symbolic name of a variable is achieved by creating the Points Database.

5.2.2

RTDS Data Types

SIMATIC IT Real Time Data Server supports the following data types:

Integer
The size of an Integer register is 16 bits (1 word). Integer registers can be handled in integer, hexadecimal and binary format. You can access a single bit of an integer register in order to handle boolean variables.

Float
The size of a Float register is 32 bits (2 words). Float registers can be handled only as <integer part>.<decimal part>.

Character
The size of a Character register is 8 bits (1 byte). Character registers can be handled in alphanumeric format.

5.2.3

System Locregs for SIMATIC IT Real Time Data Server

SIMATIC IT Services supplies 6 system locregs for SIMATIC IT Real Time Data Server:

SIMATIC IT Services V4.4 SP2 User Manual

235

Real Time Data Server RTDB_0 RTDB_1 RTDB_2 RTDB_3 RTDB_4 RTDB_5

Each system locreg can be used to create custom User Locregs by changing the number of Integer, Float and Character registers in the areas reserved for I/O and user registers (P and F registers). SIMATIC IT Real Time Data Server Drivers can handle only I/O variables (FI, FF, FC where F stands for field). User registers (P) can be used by the IMC module as internal variables for storing program variables.

5.2.4
Type I/O

Locreg RTDB_0
Register FC FF FI Number 13504 8000 10000

5.2.5
Type I/O

Locreg RTDB_1
Register FC FF FI Number 1000 750 800 2000 8500 5500

User Registers

PC PF PI

5.2.6
Type I/O

Locreg RTDB_2
Register FC FF FI Number 1000 1400 1000 2000 8000 5000

User Registers

PC PF PI

SIMATIC IT Services V4.4 SP2 User Manual

236

Real Time Data Server

5.2.7
Type I/O

Locreg RTDB_3
Register FC FF FI Number 2000 3400 2000 1000 6000 4000

User Registers

PC PF PI

5.2.8
Type I/O

Locreg RTDB_4
Register FC FF FI Number 3000 5400 4000 1000 3500 2500

User Registers

PC PF PI

5.2.9
Type I/O

Locreg RTDB_5
Register FC FF FI Number 4600 8000 8000

5.2.10

User Registers
User Registers are subdivided according to the Locreg type: Registers for RTDS Locregs Registers for P.M.C. Locregs

5.2.11

Registers for RTDS Locregs

The following User Registers are available in RTDS Locregs:

Name P, i.e. permanent F, i.e. field

Description Used by SIMATIC IT applications to store internal variables Used to exchange data with non-proprietary control networks
237

SIMATIC IT Services V4.4 SP2 User Manual

Real Time Data Server

B, i.e. backup Used by SIMATIC IT Real Time Data Server if this module is configured in hot backup. These registers can be used to store variables which must be aligned on the slave RTDS memory area.

P, F and B registers can be Integer, Float or Character. Therefore the following register types are available:
Register Type FI FF FC PI PF PC BI BF BC Description Exchange Integer data with external devices (non-proprietary control networks) Exchange Floating point data with external devices (nonproprietary control networks) Exchange alphanumeric data with external devices (nonproprietary control networks) Internal integer variables Internal Floating point variables Internal Alphanumeric variables Integer variables to be aligned on the slave RTDS Floating point variables to be aligned on the slave RTDS Alphanumeric variables to be aligned on the slave RTDS

The number of these registers can be changed by the user (up to 4Kb), only for User Locregs , using the Locreg tool supplied in SIMATIC IT Management Console.

5.2.12

Registers for PMC Locregs

If you use Siemens Orsi proprietary controllers (P.M.C.)the following user registers are available:

Name P, i.e. permanent R, i.e. not permanent

Description The values stored in these registers are maintained even after power-off, thanks to the presence of a buffer battery. The values stored in these registers are cancelled upon system startup, unless a different configuration has been chosen.

P, and R registers can be Integer, Float or Character. Therefore the following register types are available:
Register Type RI RF RC PI PF PC Description Non-permanent Integer registers Non-permanent Floating Point registers Non-permanent Character registers Permanent Integer registers Permanent Floating Point registers Permanent Character registers

The number of these registers can be changed by the user, only for User Locregs, using the Locreg tool supplied in SIMATIC IT Management Console.
SIMATIC IT Services V4.4 SP2 User Manual 238

Real Time Data Server

In addition the following registers are available:

Register Type II OI AI Description 16 bit input registers holding values read from the field 16 bit output registers holding values written to the field Alarm registers (16 bit integers) used to generate the alarm messages to be sent to the supervision program.

Tip For more information on P.M.C. registers and memory areas, see the software manual of the P.M.C. family you want to use.

5.2.13

System Registers
System registers are used for special purposes such as troubleshooting, reading system date and time, etc.

The following system registers are available:

Register Type SA SP SR SS EI Description System diagnostics messages Special integer/logical registers used to monitor the system status Registers holding the remaining interval for each sequence Registers holding the sequence status Registers reserved for ITER II instructions

Tip For more detailed information on how user programs can use these registers, see manual Control Environment Programming Users Guide

5.3
5.3.1

Configuring the Locreg

Configuring the Locreg
Locreg configuration is the tool which allows you to define the amount of integer, float and character registers to fit your requirements. The system provides a number of pre-defined RTDS (used for RTDS User units) and PMC (used for CONTROL Units) locregs. These are the so-called "system" locregs and cannot be modified by the user.

In the Locreg Configuration environment, you can:

SIMATIC IT Services V4.4 SP2 User Manual 239

Real Time Data Server Create new user locregs; Modify a user locreg; View the registers of a locreg.

5.3.2

Creating a new user locreg

To create a new user locreg: 1. Select command Configuration > Locreg Configuration in SIMATIC IT Management Console. 2. Select command File > New in the Locreg Configuration window.

3. The Class Selection dialog box appears. Select the System Locreg you want from the list box and click OK. 4. The Locreg Configuration window shows the following information about the selected locreg:
Parameter Locreg Class Name Device Type Device Sub Type Operating System Version System Library Segment Address Iter System Library Name Block Diagram System Library Name Ladder System Library Name Description Name of the system locreg to be used as a model to create the user locreg Type of the CPU assigned to the Unit (RTDS or P.M.C. series) Reserved for future use Version of the operating system installed (only for P.M.C.) Address of the segment containing the system modules stored in the system libraries (only for P.M.C.) Name of the Iter system library Name of the Block Diagram system library Name of the Ladder system library

5. If you have chosen an RTDS locreg, see If you have selected a RTDS Locreg. 6. If you have chosen a P.M.C. locreg, see If you have selected a P.M.C. Locreg. 7. Select command File > Save or Save as to save the locreg you have modified with a name other than the system locreg. User locregs are saved in directory \Plant Name\DATABASE. 8. Select command File > Exit to quit the Locreg environment.

5.3.3

If you have selected an RTDS Locreg

1. Select command Configuration > Locreg Configuration in SIMATIC IT Management Console. 2. In the Locreg Configuration window, the following tabs are available: Type Field Memory User Memory Backup Memory
240

SIMATIC IT Services V4.4 SP2 User Manual

Real Time Data Server 3. Modify the number of bytes reserved for each type according to your needs (1 word = 16 bit, 1 double word = 32 bit, 1 byte = 8 bit).

5.3.4
Parameter Type

Type
Description Type of Locreg Name of the memory map file Memory used (in Words) for the Alarms (AI registers)

Memory Map Name Alarm Memory

5.3.5

Field Memory
This tab contains information relative to F registers.

Parameter Integer/logic Variables Real Variables Char/String Variables Total Bytes

Description The memory used (in words and bytes) by integer/logic type variables The memory used (in double words and bytes) by real type variables The memory used (in bytes) by character/string type variables The total memory used by all variable types

5.3.6

User Memory
This tab contains information relative to P registers.

Parameter Integer/logic Variables Real Variables Char/String Variables Total Bytes

Description The memory used (in words and bytes) by integer/logic type variables The memory used (in double words and bytes) by real type variables The memory used (in bytes) by character/string type variables The total memory used by all variable types

5.3.7

Backup Memory
This tab contains information relative to B registers. A small memory area is reserved for these registers (maximum 4 Kb).

Parameter Integer/logic Variables Real Variables

Description The memory used (in words and bytes) by integer/logic type variables The memory used (in double words and bytes) by real type
241

SIMATIC IT Services V4.4 SP2 User Manual

Real Time Data Server

variables Char/String Variables Total Bytes The memory used (in bytes) by character/string type variables The total memory used by all variable types

5.3.8

If you have selected a PMC Locreg

1. Select command Configuration > Locreg Configuration in SIMATIC IT Management Console. 2. In the Locreg Configuration window the following tabs are available: Type Permanent Memory Not Permanent Memory

3. Modify the number of bytes reserved for each type according to your needs (1 word = 16 bit, 1 double word = 32 bit, 1 byte = 8 bit).

5.3.9

Permanent Memory
This tab contains information relative to P registers.

Parameter Integer/logic Variables Real Variables Char/String Variables Number of free bytes Number of available bytes

Description The memory used (in words and bytes) by integer/logic type variables The memory used (in double words and bytes) by real type variables The memory used (in bytes) by character/string type variables The number of free bytes The available memory

5.3.10

Not permanent Memory

This tab contains information relative to R registers.

Parameter Integer/logic Variables Real Variables Char/String Variables Number of free bytes Number of available bytes

Description The memory used (in words and bytes) by integer/logic type variables The memory used (in double words and bytes) by real type variables The memory used (in bytes) by character/string type variables The number of free bytes The available memory

SIMATIC IT Services V4.4 SP2 User Manual

242

Real Time Data Server

5.3.11

Modifying a user locreg

To modify a user locreg: 1. Select command Configuration > Locreg Configuration in SIMATIC IT Management Console. 2. Select command File > Open in the Locreg Configuration window.

3. The Locreg Selection dialog box shows by default the names of all the user locregs. SYSTEM LOCREGS CANNOT BE EDITED BY THE USER. 4. Select the user locreg you want to update from the list and click OK. 5. The Locreg Configuration window shows the following information about the selected locreg:
Parameter Locreg Class Name Device Type Device Sub Type Operating System Version System Library Segment Address Description Name of the system locreg to be used as a model to create the user locreg Type of the CPU assigned to the Unit (RTDS or P.M.C. series) Reserved for future use Version of the operating system installed (only for P.M.C.) Address of the segment containing the system modules stored in the system libraries (only for P.M.C.) Name of the Iter system library Name of the Block Diagram system library Name of the Ladder system library

Iter System Library Name Block Diagram System Library Name Ladder System Library Name

6. If you have chosen an RTDS locreg, see If you have selected a RTDS Locreg. 7. If you have chosen a P.M.C. locreg, see If you have selected a P.M.C. Locreg. 8. Select command File > Save or Save as to save the locreg you have modified. User locregs are saved in directory \Plant Name\DATABASE. 9. Select command File > Exit to quit the Locreg environment.

5.3.12

Viewing the registers of a locreg

To view the registers of a user locreg: 1. Select command Configuration > Locreg Configuration in SIMATIC IT Management Console. 2. Select command File > Open in the Locreg Configuration window.

3. The Locreg Selection dialog box shows by default the names of all the user locregs. To display system locregs click the System button in the Type area. 4. Select the user locreg you want to view from the list and click OK. 5. The Locreg Configuration window shows the following information about the selected locreg:

SIMATIC IT Services V4.4 SP2 User Manual

243

Real Time Data Server

Parameter Locreg Class Name Device Type Device Sub Type Operating System Version System LIbrary Segment Address Iter System Library Name Block Diagram System Library Name Ladder System Library Name Description Name of the system locreg Type of the CPU assigned to the Unit (RTDS or P.M.C. series) Reserved for future use Version of the operating system installed (only for P.M.C.) Address of the segment containing the system modules stored in the system libraries (only for P.M.C.) Name of the Iter system library Name of the Block Diagram system library Name of the Ladder system library

6. Select command File > Display. The Locreg Display dialog box shows the following information:
Parameter Name Mem. Type Type Address (Hex) Address (Dec) Number Description Symbolic name of the register Memory type of the register (alarm, permanent, I/O, system) Register type (Integer, Float, Character) Starting address in hexadecimal format Starting address in decimal format Number of available registers

7. Click Exit to return to the Locreg Configuration window. 8. To print the locreg displayed, select command File > Print dialog box for setting printing parameters appears. . The standard Windows

5.4
5.4.1

Configuring SIMATIC IT Real Time Data Server

Configuring SIMATIC IT Real Time Data Server
The SIMATIC IT Real Time Data Server component manages the RTDS memory area and allows data exchange between a large number of non-proprietary supervisory / control systems and SIMATIC IT applications. This integration is achieved via modules called drivers, which have been developed by Siemens A&D AS MES for a large variety of PLCs, DCSs, Loop Controllers, etc.

The behaviour of SIMATIC IT Real Time Data Server can be configured in offline mode, such as far as the following features are concerned: The interfaces to the drivers The size of RTDS queues 0 class points management Oneshot reading Quality flags management
SIMATIC IT Services V4.4 SP2 User Manual 244

Real Time Data Server Time Stamp management

5.4.2

Configuring the interfaces to the RTDS drivers

When configuring RTDS in offline mode, you define the drivers required by SIMATIC IT applications to communicate and exchange data with PLCs and other market devices.

Notes You can configure up to 16 drivers. You can select the command only if you have selected a USER UNIT - RTDS/IMC or a USER UNIT Real Time Data Engine logical Unit.

Procedure
1. In SIMATIC IT Management Console, click the 2. Select an RTDS or RTDEM Unit. tab.

3. Select command Unit > Real Time Data Server (or Real Time Data Engine) > RTDS Offline Configuration or Expand the Unit tree, then expand the Management item and double click the RTDS icon. Offline Configuration 4. In the Real Time Data Server dialog box, click the Real Time Data Server Offline Configuration tab. Enter the following data:
In the box Interface Name Executable Name Enter the name of the driver used to exchange data with external devices. This name is defined when you install the driver. the name of the driver executable program (without extension). This file has been copied by the driver setup program to the SIMATIC IT system directory, and will be executed upon SIMATIC IT Real Time Data Server start-up. To find out the name of the executable program, see the Installation and Configuration documentation of the relevant RTDS driver. (Optional) the name of the directory to which the driver executable program has been copied.

Interface Location

Note: The Interface Name is inserted also in the Interf. field of the Points Database associated with the RTDS/IMC Unit. This name identifies the type of the external device relevant for each variable.

For example, if you use the Siemens SINEC H1 interface, the program creates the SINEC Interface Name. A progressive number is added to the string if you install more than one instance of the same interface (e.g. SINEC1, SINEC2, SINEC3).

SIMATIC IT Services V4.4 SP2 User Manual

245

Real Time Data Server 5. Check the Save User Registers box to save the values stored in the permanent registers (P) when SIMATIC IT Real Time Data Server is deactivated and restore them when RTDS is re-started. 6. Check the Save Backup Registers box to save the values stored in the backup registers (B). 7. Click the Add button. The names of the driver, the executable program and the directory are displayed. Check the Read-only box if you want the driver only to read from and not to write on the RTDS. Note: Click buttons Change and Delete to modify or remove the selected driver, respectively.

Important If you plan to use the PDE Programming Development Environment to process the data acquired from external devices, you must check the Start Integral Multifunction Controller box. In this way the IMC module will be executed upon SIMATIC IT Real Time Data Server start-up (this option is available only for RTDS/IMC Units).

5.4.3

Defining the size of RTDS queues

In order to exchange data between the memory area and the interfaces to third-party drivers, SIMATIC IT Real Time Data Server writes data to and reads data from dedicated queues. In greater detail, there are two input queues from the interfaces (one with high priority, the other with low priority) and as many output queues as the number of configured interfaces. A simple diagram illustrates this architecture. High-priority input queues are used by class 7, as well as to return the result of settings. Whenever you force a value from RTDS to the field, this triggers a re-reading of the value, in order to check whether the attempt to reset the value has been successful or not. These rereadings, in addition to class-7 samplings, are managed via high-priority input queues. Low-priority input queues are used by all other classes. Furthermore, when using IMC or Data Engine: High-priority input queues are refreshed at the end of EACH task/sequence. Low-priority input queues are refreshed only at the end of each DE/IMC system time tick.

The size of these queues can be customized by the user, as follows: 1. Select command Unit > Real Time Data Server (or Real Time Data Engine) > RTDS Offline Configuration or Expand the Unit tree, then expand the Management item and double click the RTDS icon. Offline Configuration 2. In the Real Time Data Server dialog box click the Advanced tab. 3. Click the Queue tab. Configure the queues by entering the number of queue items, which can be stored in each of them. This value must be:
High Priority Low Priority Interfaces 2000 up to 8000 8000 up to 20000 1000 up to 20000

SIMATIC IT Services V4.4 SP2 User Manual

246

Real Time Data Server

Since these queues have a limited size, it is important to monitor their occupation and the relative peaks. This operation can be performed from the RTDS Online Configuration environment.

Note: The currently configured size of RTDS queues can be viewed by clicking the on the toolbar and then the More Info button.

button

5.4.4

Monitoring the RTDS queue status

To check the occupation rate of the queues used by SIMATIC IT Real Time Data Server to exchange data between the memory area and the interfaces, do as follows: 1. Select command Configuration > Real Time Data Server from SIMATIC IT Management Console. The RTDS tab of the Server Configuration window is displayed. button on the toolbar. A chart is displayed: the first trend corresponds to the 2. Click the peak occupation of the high priority input queue. 3. You can select the trend to be monitored in the Parameters list, relative to input high priority, input low priority or output queues and choose one of the following options:

Peak occupation Peak counter Average occupation Occupation > 90% counter

Maximum occupation reached in this queue How many times the peak has been reached Average occupation of the queue How many times the average has reached 90%

5.4.5

Defining the management of 0 class points

Class zero points are not acquired at regular time intervals but only when a SIMATIC IT component requests their value. Therefore their management can be configured by the user. To define class-0 point management: 1. Select command Unit > Real Time Data Server (or Real Time Data Engine) > RTDS Offline Configuration from SIMATIC IT Management Console, or Expand the Unit tree, then expand the Management item and double click the RTDS icon. Offline Configuration 2. In the Real Time Data Server dialog box click the Advanced tab. 3. Click the General tab. You can configure the following options:

Option Disable change class error management

Description Since a certain time usually elapses before tag values are actually read, during this interval some SIMATIC IT components display a series of # in place of the point value. Check this box not to display the "read error" string which appears when loading class zero points. Select On value change to send class zero points to the interface when their value changes in comparison to the previous one. This is the default configuration.

Setting of zero class point

SIMATIC IT Services V4.4 SP2 User Manual

247

Real Time Data Server

Select Unconditioned to send class zero points to the interface whenever their setting is requested, even if the value is the same as the previous one.

5.4.6

Optimizing the setting of values on device drivers for 0 class points

Typically the value of a point, of a single array element or of a whole array is written to the device driver only when it changes in the Real Time Data Base memory area (e.g. because a SIMATIC IT component has modified it).

As of version 3.01, SIMATIC IT Real Time Data Server can be configured in order to write a value to the device driver, even if the value to be written is the same as the one currently stored in the Real Time Data Base memory area. This approach is useful for points in class 0, which are not polled: the device driver might have modified the tag value, but, since this value has not been read by RTDS, as no application requested it, the Real Time Data Base memory area contains a value which is not aligned with the current value on the device driver. With this configuration new values written by a SIMATIC IT component or an application to the Real Time Data Base memory area can be sent to device drivers independently of the current values stored in SIMATIC IT Real Time Data Server.

5.4.7

Enabling oneshot reading

The oneshot reading option allows you to refresh the values in the RTDS memory with the most updated PLC values. To enable oneshot reading: 1. Select command Unit > Real Time Data Server (or Real Time Data Engine) > RTDS Offline Configuration from SIMATIC IT Management Console or Expand the Unit tree, then expand the Management item and double click the RTDS icon. Offline Configuration 2. In the Real Time Data Server dialog box click the Advanced tab. 3. Click the Oneshot reading tab. Check the Enable oneshot reading box. The settings area below is activated. 4. In the Max execution time for oneshot reading box insert a number indicating the maximum time a oneshot reading of a single variable may last. When the time expires, the oneshot reading request becomes invalid and an error will be sent to the requesting client. 5. In the Max number concurrent requests box, insert a number indicating the maximum number of simultaneous requests from divers clients the RTDS can manage. Note Each request contains one or more oneshot readings.

5.4.8

Enabling quality flags management

In order to manage quality flags, their use must be enabled, as follows: 1. Select command Unit > Real Time Data Server (or Real Time Data Engine) > RTDS Offline Configuration from SIMATIC IT Management Console or

SIMATIC IT Services V4.4 SP2 User Manual

248

Real Time Data Server Expand the Unit tree, then expand the Management icon. Offline Configuration item and double click the RTDS

2. In the Real Time Data Server dialog box click the Advanced tab. 3. Click the General tab. Check the Enable quality management box and select OK.

5.4.9

Enabling Time Stamp

To allow the clients to know the specific time at which the value of a variable was modified, proceed as follows: 1. Select command Unit > Real Time Data Server (or Real Time Data Engine) > RTDS Offline Configuration from SIMATIC IT Management Console Or Expand the Unit tree, then expand the Management item and double click the RTDS icon. Offline Configuration 2. In the Real Time Data Server dialog box, click the Advanced tab. 3. Click the General tab. Check the Enable Time Stamp box and select OK.

5.4.10

Displaying quality information

SIMATIC IT Real Time Data Server manages the state of a variable and, as such, the validity index of the variable value. This value respects the OPC standards of quality flags (good, bad, uncertain). The quality value of field variables is assigned directly by the associated interface. The quality value of non field variables or of field variables without an associated interface / with an interface that does not manage variable states, can be handled by the user, by using appropriate instructions supplied by the proprietary programming languages (Iter, Ladder and Diagram Block). For more information on how to use these instructions, please see the Iter, Ladder and Block Reference Guides.

Quality information for a variable can be only displayed from the ODS and SIMATIC IT Graphic User Interface components.

Important Quality flag management must be enabled in order for SIMATIC IT Real Time Data Server to manage quality values.

Attribute Status value Quality Substatus Limit

Description Integer value, not masked Quality value. Value describing the quality status. Detailed description of the quality status. Depends on the quality value, which can be GOOD, BAD, UNCERTAIN. Value providing useful diagnostic information.

SIMATIC IT Services V4.4 SP2 User Manual

249

Real Time Data Server

5.4.11

The GOOD quality attribute

This is the substatus value for the GOOD quality, according to the OPC standards.

SSSS 0 1-5 6 7-15

Define Non-specific N/A Local Override N/A

For a detailed description of each quality flag, please refer to the "The OPC Data Access Custom Interface Specification" document, which can be downloaded from the www.opcfoundation.org web site.

5.4.12

The BAD quality attribute

This is the substatus value for the BAD quality, according to the OPC standards.

SSSS 0 1 2 3 4 5 6 7 8-15

Define Non-specific Configuration Error Not Connected Device Failure Sensor Failure Last Known Value Comm Failure Out of Service N/A

For a detailed description of each quality flag, please refer to the "The OPC Data Access Custom Interface Specification" document, which can be downloaded from the www.opcfoundation.org web site.

5.4.13

The UNCERTAIN quality attribute

This is the substatus value for the UNCERTAIN quality, according to the OPC standards.

SSSS 0 1 2-3 4 5 6 7-15

Define Non-specific Last Usable Value N/A Sensor Not Accurate Engineering Units Exceeded Sub-Normal N/A

SIMATIC IT Services V4.4 SP2 User Manual

250

Real Time Data Server For a detailed description of each quality flag, please refer to the "The OPC Data Access Custom Interface Specification" document, which can be downloaded from the www.opcfoundation.org web site.

5.4.14

The quality status

This is the status value, according to the OPC standards.

QQ 0 1 2 3

Define Bad Uncertain N/A Good

Description Value is not useful for reasons indicated by the Substatus. The quality of the value is uncertain for reasons indicated by the Substatus. Not used by OPC The Quality of the value is Good.

5.4.15

The limit field

This is the limit value, according to the OPC standards.

LL 0 1 2 3

Define Not Limited Low Limited High Limited Constant

Description The value is free to move up or down The value has pegged at some lower limit The value has pegged at some high limit. The value is a constant and cannot move.

5.5
5.5.1

Hot backup (redundancy)

Details on RTDS hot backup (redundancy)
The configuration of RTDS in hot backup reflects what is valid for the other SIMATIC IT modules in which this particular configuration is possible.

For what concerns register management. There exist differences acoording to the type of register for which you want to maintain synchronization between master and slave RTDS.

5.5.2

Register management with RTDS in hot backup

Register alignment between master and slave RTDS is a time- and resource-consuming activity. Therefore, register synchronization occurs as follows: Only B (Backup) registers are always kept synchronous by the system. P (Permanent) registers are kept synchronous only when modified by one of the upper level components (GUI, ODS...), Real Time Data Engine and IMC excluded.

SIMATIC IT Services V4.4 SP2 User Manual

251

Real Time Data Server F (Field) registers are not kept synchronous by the system because their synchronization is guaranteed by field devices.

5.5.3

The DB-Align function

Purpose
The DB-Align executable (dbalign.exe) was specifically developed to permit the alignment of the dbfiles from the server to the clients that have "image" plants, i.e. which support pairs of RTDS in Backup.

Location
It is installed by default in C:\ICUBESYS\BIN.

Behaviour
This application must be launched manually on the client inside the "image" plant that you want to maintain aligned. If no "image" plant exists, the application fails (however, a private log file named DBALIGN.LOG keeps trace of the programs activities and lists any reasons for stops or warnings). After being launched, the DB-Align application examines the list of defined RTDS Units, searching for one the associated device of which corresponds to the computer name of the machine on which the program is running. If more than one such Unit is present, the application signals this in the log file, but nonetheless considers only the first of such Units that it detects. After finding the Unit associated to the appropriate workstation, the program determines the name of its associated database and corresponding locreg file and then copies the files from the master server found to the local PC. If there is no Unit associated to the appropriate workstation, then the DB-Align program searches for a Unit associated to the workstation (if one exists) on which RTDS runs in backup in relation to the machine considered. If such a Unit is found, the program determines the name of the database and locreg and then copies them. If no such Unit is found, then the program interrupts its execution. Once the Copy operation is completed, an alert message informs the user as to the conclusion of the process and its outcome.

5.5.4

Launching the DB-Align application (dbalign.exe)

Prerequisites
The application must be configured as a Custom application on the clients where there exists an "image" Plant. The workstation must be logged on to a remote Plant. Local replication of files must be active. There exists a RTDS Unit configured to run on the workstation.
SIMATIC IT Services V4.4 SP2 User Manual 252

Real Time Data Server No other instance of the DB-Align application must be running.

Procedure
1. Logon to the "image" Plant. 2. Add the dbalign.exe application to the Client menu as a Custom application in Management Console. 3. Operating in Management Console, launch the application from the Client menu.

5.6
5.6.1

Advanced RTDS configuration

Advanced RTDS configurations
You can perform advanced configurations on RTDS by editing specific .INI files that come provided with the application.

Important Editing the aforementioned .INI files must be performed solely by expert users.

File COMMVIEWER.INI File GPSSOCK.INI File ITFLIB.INI File MENU.INI File NCSERV.INI File QBRIDGE.INI File RTDB.INI File USERBK.INI

5.6.2

COMMVIEWER.INI
[DATA* Max_Data_Loaded= N

N indicates the maximum number (set as default) of Audit Trail records loaded in the Viewer memory.

5.6.3

GPSSOCK.INI

Important Before performing any operations on this file, we recommend that you contact Siemens A&D AS MES Technical Support Service for any additional information.

[REGISTRATION]
SIMATIC IT Services V4.4 SP2 User Manual 253

Real Time Data Server NotRegNetChange = TRUE/False

If the key ComMode under the section [COMUNICATION_MODE] is GPS_RQM and the value of NotRegNetChange is TRUE, then refresh of the units visualization in the Management Console will not happen, when you update the net configuration. If the key ComMode under the section [COMUNICATION_MODE] is GPS_ONLY_PIPE, then the refresh of the units visualization in the Management Console will never happen, when you update the net configuration.

[FILE SYSTEM] UseFFSYS = YES/NO

If the key ComMode under the section [COMUNICATION_MODE] is GPS_RQM and the value of UseFFSYS is NO, then SIMATIC IT uses the network file system of the operating system for the I/O operations on files; if the value is YES, then the File System Server provided by SIMATIC IT Sevices is used. This final guarantees the support of the Ethernet redundancy realized by means of RIS. If the key ComMode under the section [COMUNICATION_MODE] has the value GPS_ONLY_PIPE, then SIMATIC IT always uses the network file system of the operating system for the I/O operations on files.

5.6.4

ITFLIB.INI
This file must be edited in the RTDB sub-directory of the central plant, on the master and slave plant servers. The file foresees a section name for each Interface Name that the user wants to configure. Example:

[InterfaceName1] noasciilog = 1 StopThreadTO=300000 [InterfaceName-n] noasciilog = 1 StopThreadTO=300000

Meaning of each available parameter: noasciilog: if the file is not edited, its value will be 0 (default): in this case, the driver writes an ASCII log file, having the same contents of the system log file shown by Log File Viewer. Instead, if the value is 1, the ASCII log file is disabled. This is useful when the ASCII log file resides on a remote hard disk. StopThreadTO : internal timeout in driver architecture; its default is 40000.

SIMATIC IT Services V4.4 SP2 User Manual

254

Real Time Data Server

5.6.5

MENU.INI
[DELAY] Retry=<integer specifying attempts number> You do not find in the file menu.ini, either the section [DELAY] or the Retry key. As default setting, SIMATIC IT Management Console performs 60 attempts of closing Production Modeler. Each attempt has a duration of 5 seconds, so that the maximum time to close this module reaches 5 minutes. It is possible to increase or decrease the attempts number by adding manually this section and specifying an integer greater than or equal to one.

5.6.6

NCSERV.INI
This file (read by SIMATIC IT Network Configuration Server) contains the setting of the time delay [in msec] prior to checking the status (running/not running) of the Historian modules. With this operation, Network Configuration Server checks whether all SIMATIC IT modules are still running. However, this is a time-consuming operation, which could be performed less frequently (in particular, whenever USERBK.INI file is configured).

Example of NCSERV.INI file:

[CONFIG] CheckAppLife=180000

CheckAppLife is given in msec (for instance, 180000 -> 3 minutes). The default value is 120000 -> 2 minutes. If the file does not exist, the default value will be applied. To bypass (disable) the check, CheckAppLife=-1. This configuration file must be edited in the directory ICUBE.CNF of each foundation master server.

5.6.7

QBRIDGE.INI
When the Cube Bridge Server is started, it searches the file QBRIDGE .INI in the directory ICUBE.CNF, where you can find all clients names that cannot perform forcing on PMCs. It is also possible to configure the Cube Bridge Server so that no client is able to perform any forcing on PMCs. Examples of the .ini format are as follows: 1) [RdOnlyAccess] ComputersCount = 3 Computer1 = ALPHA Computer2 = BETA Computer3 = GAMMA

SIMATIC IT Services V4.4 SP2 User Manual

255

Real Time Data Server

The computers ALPHA, BETA and GAMMA cannot perform any forcing on PMCs.

2) [RdOnlyAccess] ComputersCount = ALL

It is not possible to perform any forcing on PMCs when you connect to this Cube Bridge Server.

5.6.8

RTDB.INI
This file (found in the RTDB sub-directory of the central plant, on the master and slave plant servers) is usually not edited manually: its contents are written by using RTDS Offline configuration in SIMATIC IT Management Console. But queue dimensions can be manually modified in order to obtain a dimension that exceeds the limits foreseen by RTDS Offline configuration. This may be necessary when the number of points becomes very high. These queues are used by RTDS and drivers in order to communicate. Sections and parameters:

High-priority queue (500 ms reading operations), from all driver instances to RTDS:

[INHQUEUE] UnitName1=8000 UnitName2=8000 UnitName-n=8000

Low-priority Input queue (1 - 6 classes), from all driver instances to RTDS

[INLQUEUE] UnitName1=20000 UnitName2=20000 UnitName-n=20000

Output Queues (change class and write commands), from RTDS to each single driver instance:

[OUTQUEUE] UnitName1=20000 UnitName2=20000 UnitName-n=20000

SIMATIC IT Services V4.4 SP2 User Manual

256

Real Time Data Server In this manner, the number of queue elements are defined. They must be defined on each plant in order to permit rapid RTDS switches. Each queue element can contain the value of a read variable (input queue), or the value of a variable to be written (output queue), or the request to begin to read a variable (output queue). String variables use a number of elements equal to their length. If RTDS has been activated on a client, it is possible to force reading of the locally copied database by setting the following new key: [DBLOCAL] UnitName = YES

UnitName is the name of the unit associated to RTDS that runs on the client pc or on the backup pc. Note: The local copy of the database is done manually and can be performed if the client has been configured in order to manage the local copy of the plant.

5.6.9

USERBK.INI
This file contains the names of the computers on which RTDS is configured for hot backup.

Example of USERBK.INI file:

[BCKCONN] ComputerNum=4 ListPriority=TRUE Computer1=SERVER_1 Computer2=SERVER_2 Computer3=CLIENT_1 Computer4=CLIENT_2

In this example, there are two pairs of RTDS configured for hot backup. (first pair: SERVER_1 - SERVER_2, second pair: CLIENT_1 CLIENT_2). The RTDS configured in stand-alone need not be written in the .ini file. If set to TRUE, the ListPriority key permits the communication to RTDS without verifying the network registration of RTDS to SIMATIC IT Network Configuration Server. As a result, the traffic over the network is decreased. Therefore, the ListPriority key is significant also when there is no RTDS in hot backup (ComputerNum=0). This configuration file must be edited in the directory ICUBE.CNF of each client and each server (master and slave). It is also possible to balance the load of the ETHERNET clients toward two bridges configured for backup among each other, introducing an appropriate key in the file. In detail: [CUBEBRIDGE] Primary = computername1 Auxiliary = computername2

SIMATIC IT Services V4.4 SP2 User Manual

257

Real Time Data Server Primary is the name of the computer where the Bridge of reference for the client is running. If the client cannot reach the Bridge of reference, it connects to the auxiliary Bridge. The client does not switch over once the connection has taken place, even if the primary Bridge becomes available.

SIMATIC IT Services V4.4 SP2 User Manual

258

The SIMATIC IT OPC Browser

The SIMATIC IT OPC Browser

The SIMATIC IT OPC Browser is a tool, that exploits the OPC Server List and the OPC browsing interface in order to get information, as the OPC Server ProgID and the OPC ItemIDs, useful to connect and get data from locally and remotely registered OPC Servers. In addition, this tool can be used to automatically configure the OPC Client driver to connect and get data from an OPC Server, provided that it supports the OPC browsing interface.

With the SIMATIC IT OPC Browser, you can: Browse for all the local OPC Servers: that is, OPC Servers (supporting or not the OPC Server List) present on the local computer. See How to use SIMATIC IT OPC Browser. Browse for remote OPC Servers compliant with the OPC Server List: that is, all the OPC Servers present on the local network that have been registered according to the OPC categories and can therefore be found by means of OPCEnum server (OPC Server List). See How to use SIMATIC IT OPC Browser. Connect to each one of the above mentioned OPC Servers (local and remote) that exposes the OPC browsing interface, and browse the OPC items to get information about the variables, to which the OPC Server has access. See How to use SIMATIC IT OPC Browser. Connect to a remote OPC Server that is not compliant with the OPC Server List, provided it has been registered locally. If this OPC Server exposes the OPC Browsing interface (it is browsable), its OPC items can also be accessed by the tool. See Connecting to a locally registered server on a remote workstation. Configure the OPC Client driver, to get data from every browsable OPC Server, by selecting from the OPC Servers items, the single variable or group of variables to be accessed, and automatically inserting them in the Data Dictionary, with the suitable parameters. See Automatic configuration of OPC Client Database fields.

Important Remember that the OPC Browser is not a Database Editor, but a tool to insert points (to be handled by the OPC Client driver), in the Data Dictionary. To modify a point inserted by means of the SIMATIC IT OPC Browser, you still have to use the Database Editor.

6.1

How to use SIMATIC IT OPC Browser

To use SIMATIC IT OPC Browser: 1. From SIMATIC IT Management Console, select command Tools > OPC Browser. The SIMATIC IT OPC Browser window appears. 2. To view the OPC Servers running on the local workstation, expand the My Computer icon from the tree list displayed in the left pane of the OPC Browser window. All OPC Servers present on your PC are displayed. 3. To view the OPC Servers running on any workstation connected to the network, expand the icon and then choose a workstation. Network Neighborhood

SIMATIC IT Services V4.4 SP2 User Manual

259

The SIMATIC IT OPC Browser 4. If you want to browse for a server on a remote workstation, that cannot be found by the OPC Server List, you can try to connect to it by clicking the Connect Locally Registered Servers icon. 5. Select one of the OPC Servers. The Server Information tab, in the right pane, shows some Registry information and the server name to be used in order to configure SIMATIC IT Real Time Data Server User Field 1. . If you are not using the Automatic DB Configuration, you can copy and paste this value into the Database Editor. 6. Expand the icon in order to display the OPC server variable hierarchy. This hierarchy, depending on the server, can consist of one or more levels. Intermediate levels are called Branches , while terminal levels are called Leaves . You can expand each intermediate level to browse for the leaves of the lower level. 7. To select a variable (item), expand all the Branches until you get the Leaf of interest and select it. The Item Information tab in the right pane of the OPC Browser window shows the Variable Name to be used in SIMATIC IT Real Time Data Server User Field 2. If you are not using the Automatic DB Configuration, you can copy and paste this value into the Database Editor. Depending on the OPC Server, some further details about the variable may be displayed (Description, Canonical Data Type, Array or Scalar, Array dimension, High EU, Low EU, Access Rights, Server Scan Rate).

SIMATIC IT Services V4.4 SP2 User Manual

260