IndustrialIT 800xA - System System Version 4.1 Configuration IndustrialIT 800xA - System System Version 4.1 Configuration NOTICE The information in this document is subject to change without notice and should not be construed as a commitment by ABB. ABB assumes no responsibility for any errors that may appear in this document. In no event shall ABB be liable for direct, indirect, special, incidental or consequential damages of any nature or kind arising from the use of this document, nor shall ABB be liable for incidental or consequential damages arising from use of any software or hardware described in this document. This document and parts thereof must not be reproduced or copied without written permission from ABB, and the contents thereof must not be imparted to a third party nor used for any unauthorized purpose. The software or hardware described in this document is furnished under a license and may be used, copied, or disclosed only in accordance with the terms of such license. This product meets the requirements specified in EMC Directive 89/336/EEC and in Low Voltage Directive 72/23/EEC. Copyright © 2003 - 2005 by ABB. All rights reserved. Release: Document number: June 2005 3BDS011222R4101 TRADEMARKS Registrations and trademarks used in this document include: Windows Registered trademark of Microsoft Corporation. Windows 2000 and Windows XP Registered trademark of Microsoft Corporation. ActiveX and Visual Basic Registered trademarks of Microsoft Corporation. PostScript Registered trademark of Adobe Systems Inc. Acrobat Reader Registered trademark of Adobe Systems Inc. Industrial IT Trademark of ABB. Aspect Object Trademark of ABB Ltd., Switzerland Aspect Studio Trademark of ABB Ltd., Switzerland. Aspect Express Trademark of ABB Ltd., Switzerland. Process Portal Trademark of ABB Ltd., Switzerland. TABLE OF CONTENTS About This Book General ............................................................................................................................27 Intended User...................................................................................................................28 Document Conventions ...................................................................................................29 Use of Warning, Caution, Information, and Tip Icons ....................................................31 Terminology.....................................................................................................................31 Related Documentation ...................................................................................................50 Section 1 - Introduction System Overview.............................................................................................................57 System Functions .................................................................................................58 System Infrastructure ...........................................................................................64 System Scope .......................................................................................................66 Prerequisites and Requirements ......................................................................................67 Section 2 - Concepts Aspect Object Model.......................................................................................................70 Aspect Objects in Engineering ........................................................................................73 Objects .............................................................................................................73 Aspects .............................................................................................................73 Views .............................................................................................................74 Object Types.........................................................................................................75 Creating a New Object Instance..........................................................79 Basic Structures....................................................................................................80 Designations .........................................................................................................81 Identification of Aspect Objects..........................................................81 3BDS011222R4101 5 Table of Contents Principles of Reference Designations ................................................. 82 Structured Plant Modelling .................................................................................. 83 Functional Relations Between Aspect Objects ................................... 83 Basic Object Types for Functional Structure ...................................... 85 Usage of Function Reference Designations........................................ 87 Creation of Objects in Functional Structure ....................................... 87 Relations Between Aspect Objects of the Control System................. 92 Basic Object Types for Control Structure ........................................... 92 Usage of Control Reference Designations.......................................... 93 Creation of Objects in Control Structure ............................................ 94 Relations Between Functional Structure and Control Structure ......... 96 Locational Relations Between Aspect Objects ................................... 98 Basic Object Types for Location Structure....................................... 100 Usage of Location Reference Designations...................................... 102 Creation of Objects in Location Structure ........................................ 103 Relations Between Aspect Objects for Documentation.................... 104 Basic Object Types for Documentation Structure ............................ 104 Usage of Documentation Reference Designations ........................... 107 Creation of Objects in Documentation Structure.............................. 107 User Defined Structures .................................................................... 108 Structures for Administration ........................................................... 108 Composite Object Types .................................................................................... 109 Adding Additional aspects................................................................ 110 Aspect Propagation ........................................................................... 111 Allowed Operations on Composite Instances ................................... 112 Details about the Formal Instance List ............................................. 113 Typical Solutions ............................................................................................... 114 Reuse Instructions.............................................................................................. 114 Libraries .......................................................................................................... 115 Library Management......................................................................... 116 Operations on a Library .................................................................... 117 Library Aspect Categories ................................................................ 118 6 3BDS011222R4101 Table of Contents Libraries as Distributable Units.........................................................119 Library States ....................................................................................119 Library States on the End User Side .................................................120 Tracking Library Components ..........................................................121 Creating a Library .............................................................................121 Adding Objects and Aspects to a Library .........................................122 Releasing a Library ...........................................................................122 Creating a new Version .....................................................................123 Exporting a Library ...........................................................................124 Activating a Library ..........................................................................124 Upgrade of Instances.........................................................................124 Deleting a Library .............................................................................124 Extending a Library...........................................................................125 Library Assistant ...............................................................................125 Import/Export ................................................................................................................125 Import and GUIDs.............................................................................126 Upgrading Files .................................................................................128 Filter Exports ....................................................................................128 Differences ....................................................................................128 Dependencies ....................................................................................128 Resolving Errors................................................................................130 Audit Trail ....................................................................................131 Recommendations for Archive Files.................................................131 Configuration Using Spread Sheets...............................................................................132 Data Area ....................................................................................133 Object Identification..........................................................................134 Filter ....................................................................................134 Track Changes...................................................................................134 Property References ..........................................................................134 Structured Properties .........................................................................136 Formatted Templates .........................................................................137 Pre Configured Bulk Data Applications............................................138 3BDS011222R4101 7 Table of Contents List Based Data Exchange ............................................................................................ 142 Export Data .................................................................................... 142 Import Data .................................................................................... 142 Distributed Engineering ................................................................................................ 142 (On-) Site Engineering System ......................................................... 143 Off-Site Engineering System ............................................................ 144 On-Site Engineering .......................................................................................... 144 Off-Site Engineering .......................................................................................... 146 Connectivity .................................................................................................................. 147 AC 800M Controller Connectivity..................................................................... 147 Standard Object Type Libraries ........................................................ 149 Display Elements Overview.............................................................. 149 Tool Routing Overview..................................................................... 150 Automation Solution ..................................................................................................... 151 Control Logic..................................................................................................... 151 Function Block / Program Programming.......................................... 154 Control Module Programming.......................................................... 155 Functional Planning with Function Designer ................................... 157 Function Components ....................................................................... 158 Function Diagrams............................................................................ 158 Connection Mapping......................................................................... 159 Switching Between Aspect Object and Symbol Object.................... 159 Name Synchronization...................................................................... 160 Data Flow Order ............................................................................... 160 Allocation and Code Generation....................................................... 161 I/O Signal Allocation ........................................................................ 161 Cross Application Communication Support ..................................... 162 Download and Test............................................................................ 162 List Based Configuration .................................................................. 163 Documentation Printing .................................................................... 164 Control Module Graphics ................................................................. 164 Sequential Function Chart ................................................................ 164 8 3BDS011222R4101 Table of Contents Further Readings ...............................................................................165 Control Hardware Units .....................................................................................166 I/O Signal Allocation ........................................................................167 I/O Signal Groups .............................................................................168 Topology Status Viewer ....................................................................169 Process Graphics ................................................................................................171 Graphics Builder ...............................................................................172 Graphic Aspects ................................................................................173 Graphic Aspects in Structures ...........................................................174 Object Aware and Generic Graphic Aspects .....................................175 Built in Graphic Aspect Categories...................................................176 Subsets of Elements ..........................................................................178 Building Blocks Used in Graphic Aspects........................................179 Using Object Types with Graphic Aspects .......................................180 Display Services................................................................................181 Alarm and Event.................................................................................................182 Alarm / Event Overview....................................................................185 Alarm Server and Storage .................................................................188 Event Server and Storage ..................................................................188 Alarm Expressions ............................................................................188 External Alarm ..................................................................................188 Soft Alarms ....................................................................................189 Alarm / Event User Interface Configuration .....................................189 Alarm / Event Service Configuration................................................190 Alarm / Event Overview - Controller................................................191 Inhibit and Disable Alarms and Events.............................................192 Set Up Alarm and Event Handling OPC Server ...............................194 Alarm and Event Buffer Configuration.............................................194 Alarm / Event Overview - Message Logging....................................196 History Services Message Log Overview .........................................196 Accessing Message Log Data ...........................................................197 Guidelines for Configuring Alarm/Event Logging ...........................197 3BDS011222R4101 9 Table of Contents Integrating Message-Generating Applications ................................. 198 Configuring Message Logs ............................................................... 198 Message Log Consolidation.............................................................. 198 Off-line Storage ................................................................................ 199 Configuring Oracle Access for Message Logs ................................. 199 SMS and e-mail Messaging .............................................................. 200 Fieldbusses / Field Devices................................................................................ 205 Fieldbus Builder PROFIBUS / HART .............................................. 205 Fieldbus Builder FOUNDATION Fieldbus ...................................... 210 Production Management .................................................................................... 214 Batch Management ........................................................................... 214 Manufacturing Management............................................................. 218 Information Management.............................................................................................. 219 Historical Process Data ...................................................................................... 219 Trend Log Configuration .................................................................. 219 Trend Configuration.......................................................................... 221 History Log Configuration................................................................ 223 Log Overview ................................................................................... 223 Information Management History Server Functions ........................ 225 Blocking and Alignment ................................................................... 226 STORE_AS_IS - Data Compaction.................................................. 226 Event Driven Data Collection ........................................................... 227 Consolidation .................................................................................... 228 Lab Data Logs for Asynchronous User Input ................................... 229 Calculations .................................................................................... 230 Seamless Retrieval ............................................................................ 230 Considerations for Oracle or File-based Storage .............................. 231 Off-line Storage ................................................................................ 231 Presentation of Historical Process Data............................................ 231 History Configuration Guidelines..................................................... 232 Configuring Node Assignments for Property Logs .......................... 233 Features for Optimizing CPU and Disk Usage ................................. 236 10 3BDS011222R4101 Table of Contents Allocating Disk Space for File-based Logs ......................................237 Configuring History Objects - Procedural Overview........................237 Archive Function Overview ..............................................................237 Archive Configuration.......................................................................238 Accessing Archived Data ..................................................................239 Planning for Reliable Archive Results ..............................................240 Archive Topics ..................................................................................240 Extended Configuration Data.............................................................................240 Parameter Management.....................................................................241 General Properties .............................................................................243 Softpoint Services .............................................................................243 Calculations ....................................................................................244 Documents..........................................................................................................245 Document Management ....................................................................245 Dynamic Documents .........................................................................246 Document Versions ...........................................................................246 Import of Document Files .................................................................246 Information Access ............................................................................................247 File Viewer ....................................................................................247 Bookmark ....................................................................................247 Web Page ....................................................................................248 ActiveX Wrapper ..............................................................................248 Windows Application........................................................................248 Help Aspect ....................................................................................249 Advantages for Object Type..............................................................249 Advantages for Object Instance ........................................................249 Version and Access Management ..................................................................................249 Security ...........................................................................................................250 Authorization......................................................................................................251 Access Control ...................................................................................................251 Authentication ...................................................................................252 Re-Authentication .............................................................................252 3BDS011222R4101 11 Table of Contents Double-Authentication...................................................................... 252 Log Over .......................................................................................................... 253 Electronic Signature........................................................................................... 254 Versioning and Life Cycle Management ........................................................... 255 System Configuration Version .......................................................... 256 System Synchronization ................................................................... 256 Audit Trail.......................................................................................................... 259 Audit Trail Configuration ................................................................. 261 Storage of Audit Trail Events ........................................................... 261 Audit Trail Viewing .......................................................................... 261 Archive .......................................................................................................... 262 System and Device Checks ................................................................................ 262 FDA 21 CFR Part 11 Support ............................................................................ 262 Asset Optimization........................................................................................................ 263 Maintenance Workplace and Asset Structure .................................................... 266 Asset Health Condition Reporting ..................................................................... 267 Asset Viewer .................................................................................... 267 Asset Reporter................................................................................... 268 Asset Monitoring System................................................................................... 268 Asset Monitoring .............................................................................. 268 Basic Asset Monitors ........................................................................ 269 IT Asset Monitoring ......................................................................... 270 Seamless Interaction Between Process, Maintenance, and Calibration............. 273 CMMS Integration ............................................................................ 274 Maximo Integration .......................................................................... 274 SAP/PM Integration.......................................................................... 275 DMS Calibration Integration ............................................................ 275 Asset Optimization Reporting ........................................................................... 277 AO Asset Condition History Report ................................................. 278 AO Calibration Report ...................................................................... 278 AO Running Time Report ................................................................. 278 Scripting ........................................................................................................................ 279 12 3BDS011222R4101 Table of Contents System Development .....................................................................................................280 Aspect Object Architecture ................................................................................281 Client / Server Model ........................................................................282 Afw OPC ....................................................................................283 Security ....................................................................................284 Aspect Systems .................................................................................285 System Status ....................................................................................287 Aspect Express ...................................................................................................287 Aspect Studio .....................................................................................................288 Data Access ...................................................................................................................288 Data Access Based on OPC ...............................................................................288 Overview ...........................................................................................................288 Aspect Directory and Control Structure............................................290 OPC Connect ....................................................................................291 DA Connector/Adapter......................................................................292 DA Injector ....................................................................................293 Redundancy ....................................................................................293 Failover Redundancy.........................................................................293 Parallel Redundancy..........................................................................295 Upload ....................................................................................295 Authenticated Write ..........................................................................296 Confirmed Write ...............................................................................296 Data Access Based on OLE DB.........................................................................297 Section 3 - Configuration Engineering Tasks..........................................................................................................300 Analysis and Design..........................................................................300 Domain Analysis ...............................................................................301 Identifying Aspect Objects................................................................302 Identifying Object Types ...................................................................302 Identifying Structures........................................................................302 Identifying Composite Object Types (Typical Solutions) .................302 Identifying Security Settings.............................................................302 3BDS011222R4101 13 Table of Contents Building of Objects ........................................................................... 303 Overall Project Workflow.............................................................................................. 304 Build Project Environment................................................................................. 308 Create System ................................................................................... 308 Load Libraries and Standards ........................................................... 308 Customize System............................................................................. 309 Build Project Library ......................................................................................... 309 Complete Project Library.................................................................. 310 Versioned Object Type Libraries ...................................................... 311 Build New or Adapt Existing Object Types...................................... 311 Specifications and Guidelines........................................................... 311 Create Basic Structures ...................................................................................... 312 Identification of Aspect Objects ....................................................... 313 Importing Design Information .......................................................... 315 Functional Structure.......................................................................... 317 Control Structure............................................................................... 317 Location Structure............................................................................. 319 Documentation Structure .................................................................. 319 Create Process Functions ................................................................................... 320 Build Lower Level Functional Structure........................................... 320 Build Lower Level Control Structure ............................................... 320 Build Lower Level Location Structure ............................................. 321 Modify / Allocate Process Functions................................................................. 321 Add Specific Control Logic .............................................................. 321 Assign I/O Signals ............................................................................ 321 Allocate Process Functions to Applications in Control Structure .... 321 Allocate I/O Signals to Boards in Control Structure ........................ 322 Design / Build Graphic Displays ....................................................................... 322 Finalize Graphic Displays from Object Types.................................. 322 Design and Build New Upper Level Graphic Displays .................... 322 Extend Configuration......................................................................................... 323 Add Production Management Functionality..................................... 323 14 3BDS011222R4101 Table of Contents Add Information Management Functionality....................................323 Add Asset Optimization Functionality..............................................323 Finalize Lower Level Location Structure..........................................323 Finalize Documentation Structure.....................................................323 Generate Application Software ..........................................................................324 Download and Test Application Software..........................................................324 Deploy Graphic Displays ..................................................................324 Download Controller Code ...............................................................324 Load other Run-time Configuration data ..........................................324 Test Complete Configuration ............................................................325 On-site Engineering Workflow ..........................................................................326 Libraries.........................................................................................................................328 Building Versioned Object Type Libraries.........................................................328 Starting from Plant Explorer .............................................................328 Starting from Control Builder ...........................................................329 New Version of a Library ..................................................................330 Using Versioned Object Type Libraries .............................................................331 Upgrade in Plant Explorer.................................................................332 Upgrade in Control Builder...............................................................332 Object Types ..................................................................................................................333 Building Object Types........................................................................................333 Object Type Group Creation .............................................................334 Object Type Creation ........................................................................334 Subtype Creation and Object Type Extensions .................................342 Extending an Object Type / Subtype.................................................343 Extend an Object Type / Object Type Extension Definition Aspect .345 Composite Object Type Creation ......................................................345 Examples of Object Types..................................................................................350 Control Object Types / Composite Control Object Types.................350 Aspect Object Creation in Control Structure ....................................351 Process Object Type with Signals .....................................................352 Process Object Type Built in Function Designer ..............................356 3BDS011222R4101 15 Table of Contents Signal Group .................................................................................... 361 Building Reuse Instructions............................................................................... 365 Automation Solution ..................................................................................................... 369 Control Logic..................................................................................................... 369 Function Diagrams............................................................................ 369 Copy Function Diagram.................................................................... 370 Export / Import Function Diagram ................................................... 371 Control Hardware Units..................................................................................... 373 Topology Status Viewer ..................................................................................... 373 Process Graphics................................................................................................ 375 Alarms and Events ............................................................................................. 375 SMS and e-mail Messaging ................................................. 376 Setup and Configuration Workflow .................................................. 377 Setup and Configuration Worksheets................................................ 378 Hardware Setup................................................................................. 378 GSM Hardware ................................................................................. 379 Modem Hardware (Hayes Compatible) ............................................ 391 Modem Hardware Test Utility .......................................................... 392 E-mail Test Utility............................................................................. 394 System Setup .................................................................................... 396 Modem Device.................................................................................. 396 Email Device .................................................................................... 399 Creating User Groups and Adding Users ......................................... 400 Message Subscriber .......................................................................... 401 Message Schedule............................................................................. 410 Messenger Event List........................................................................ 413 Enabling/Disabling SMS and e-mail Messaging .............................. 416 Checking SMS and e-mail Messaging Status ................................... 417 Configuration .................................................................................... 417 Alarm and Event List (Alarm Grouping).......................................... 417 Alarm and Event Message Source .................................................... 420 Message Handler............................................................................... 425 16 3BDS011222R4101 Table of Contents Alarm and Event Service Group Configuration ................................433 HART Field Devices ..........................................................................................435 Prerequisites and Requirements ........................................................436 Fieldbus Topology in System 800xA ................................................436 Preparing Device Object Types for Use ............................................438 Installation of Device Type Manager (DTM)....................................439 System 800xA Server Path Settings..................................................440 Preconfiguration of OPC Server PROFIBUS/HART........................443 Precommissioning Control Networks, AC 800M and OPC..............446 Creation of an AC 800M Controller..................................................446 OPC Server Assignment to a Connectivity Server............................448 AC 800M OPC Server.......................................................................452 Preconfiguration of AC 800M Controller .........................................453 Setting up a Fieldbus Topology for HART .......................................454 Local S800 Modules of AC 800M ....................................................455 PROFIBUS Remote I/O and HART Modules...................................455 Presetting for Instantiation ................................................................457 Fieldbus Builder Communication Mode (Fieldbus Management)....457 Fieldbus Builder Communication Mode (Device Functions ... ) ......459 Instantiation of HART Device Objects .............................................460 HART Device Objects Below HART I/O Modules ..........................460 Channel Allocation on I/O Modules .................................................462 Configuration and Commissioning of HART Device Objects ..........464 Verify ....................................................................................465 Download and Upload.......................................................................465 Export and Import .............................................................................465 Channel Changes on I/O Modules ....................................................465 Deleting Device Objects....................................................................467 Starting the Device Type Manager (DTM) .......................................468 Open DTM via Device Management Aspect ....................................468 Open DTM via Context Menu in Control Structure .........................469 Starting OPC Server PROFIBUS/HART ..........................................471 3BDS011222R4101 17 Table of Contents HART Device Objects in Function Diagrams .................................. 473 PROFIBUS Field Devices.................................................................................. 474 Prerequisites and Requirements........................................................ 476 Preparing Device Object Types for Usage ........................................ 477 Installation of Device Type Manager (DTM) ................................... 478 Preparing Hardware Definition Files (hwd) for Control Builder M . 479 Update Hardware Definition............................................................. 480 Update PROFIBUS Device HWD File ............................................. 482 Precommissioning Control Networks, AC 800M and OPC ............. 484 Creating an AC 800M Controller...................................................... 484 AC 800M OPC Server ...................................................................... 484 Preconfiguration of the AC 800M Controller ................................... 484 Setting up a Fieldbus Topology for PROFIBUS............................... 485 Communication Interface CI854....................................................... 486 Hardware Definition File Integration................................................ 487 Presettings for Instantiation .............................................................. 489 Fieldbus Builder Communication Mode (Fieldbus Management) ... 490 Fieldbus Builder Communication Mode (Device Functions ...) ....... 491 Instantiation of PROFIBUS Device Objects..................................... 492 Control Structure............................................................................... 492 Control Builder M Project ................................................................ 493 Configuration and Commissioning of PROFIBUS Device Objects . 495 Verify .................................................................................... 496 Download and Upload ...................................................................... 496 Export and Import ............................................................................. 496 Deleting Device Objects ................................................................... 496 Starting the Device Type Manager (DTM) ....................................... 497 Starting OPC Server PROFIBUS/HART .......................................... 497 FOUNDATION Fieldbus Field Devices ............................................................ 498 Prerequisites and Requirements........................................................ 499 Target Group .................................................................................... 500 Step1: Creation of an FF Library ...................................................... 500 18 3BDS011222R4101 Table of Contents Step 2: Creation of an HSE Subnet ...................................................505 Step 3: Configuration of an FF Application......................................511 Step 4: Loading of the FF Application..............................................519 Step 4a: Precommissioning ...............................................................520 Step 4b: Commissioning ...................................................................522 Step 5: Using FF Data .......................................................................526 For use in the AC 800M ....................................................................526 For use in Process Portal A ...............................................................528 Production Management ....................................................................................528 Flexible Batch Processing .................................................................528 Configuration Overview....................................................................529 Batch Management Configuration ....................................................530 Equipment Database Configuration ..................................................530 Procedure Configuration ...................................................................530 Miscellaneous Batch Configuration ..................................................531 Manufacturing Management .............................................................532 General Administration Configuration..............................................532 Inventory Configuration ....................................................................532 Quality Configuration .......................................................................533 Operation Configuration ...................................................................533 Weigh and Dispense ..........................................................................533 IForm Design ....................................................................................534 Information Management ..............................................................................................535 Historical Process Data ......................................................................................535 Bulk Configuration of Log and Trend Configuration Aspects..........535 Bulk Configuration of Property Logs................................................535 Work Flow ....................................................................................536 Extended Configuration Data.............................................................................537 Parameter Management.....................................................................537 Softpoint Configuration Workflow....................................................539 Pre-configuration Set-up ...................................................................539 Softpoint Configuration.....................................................................540 3BDS011222R4101 19 Table of Contents Importing and Exporting Softpoint Configuration Data................... 540 Calculations Configuration ............................................................... 541 Document Management ..................................................................................... 541 Information Access Aspects .............................................................................. 544 How to use the File Viewer............................................................... 545 File Viewer Functions ....................................................................... 552 Template Support .............................................................................. 557 How to use the Bookmark Aspect .................................................... 561 How to use the Web Page Aspect ..................................................... 564 How to use the ActiveX Wrapper Aspect ......................................... 566 How to use the Windows Application Aspect .................................. 569 Help Aspect........................................................................................................ 570 How to use the Help Aspect ............................................................. 570 Version and Access Management.................................................................................. 573 Authorization ..................................................................................................... 573 Access Control................................................................................................... 573 Log Over .......................................................................................................... 573 Electronic Signature........................................................................................... 574 Versioning and Life Cycle Management ........................................................... 574 System Configuration Version .......................................................... 574 System Synchronization Setup ......................................................... 575 Installed Products.............................................................................. 575 User Security Set Up......................................................................... 575 Setup of Service Groups ................................................................... 577 Node Administration Structure ......................................................... 578 General Workflow............................................................................. 578 Creating a Synchronization Package ................................................ 579 Applying a Synchronization Package ............................................... 580 System Synchronization Functions................................................... 581 20 Definitions .................................................................................... 581 Scope .................................................................................... 582 Differences .................................................................................... 585 3BDS011222R4101 Table of Contents Synchronization Package ..................................................................588 Load Synchronization Package .........................................................590 Re-Authenticate.................................................................................593 Digital Signature ...............................................................................596 Conflict Detection .............................................................................597 Categories Excluded by the System ..................................................597 Configurable Category Exclusion .....................................................598 Audit Trail ....................................................................................599 Dependencies ....................................................................................600 Important Objects..............................................................................601 Consistency ....................................................................................601 Aspects with External Data ...............................................................601 Synchronizing Use Cases ..................................................................601 Adding a new Control Project ...........................................................601 Adding a New Controller to an Existing Control Project .................602 Adding a New Application to an Existing Project and Controller ....602 Modifications to an Existing Application .........................................603 Removing an Existing Control Application ......................................603 Removing an Existing Control Project..............................................603 Modification to a Library ..................................................................604 Remove an Existing User Library .....................................................604 Batch Configuration ..........................................................................604 Changes to the FF Configuration ......................................................605 Audit Trail ..........................................................................................................606 Archive ...........................................................................................................607 System and Device Checks ................................................................................607 Asset Optimization ........................................................................................................608 Asset Monitoring................................................................................................608 Maximo Integration............................................................................................609 SAP/PM Integration ...........................................................................................610 DMS Calibration Integration..............................................................................611 PC, Network and Software Monitoring..............................................................612 3BDS011222R4101 21 Table of Contents Data Access ................................................................................................................... 613 OPC DA Server Support .................................................................................... 613 OPC DA Compliancy........................................................................ 613 OPC AE Server Support .................................................................................... 614 OPC AE Compliancy........................................................................ 614 OPC HDA Server Support ................................................................................. 615 OPC HDA Compliancy..................................................................... 616 Generic OPC DA Client..................................................................................... 617 Integration .................................................................................... 617 Connect to an OPC Server ................................................................ 618 Data Source Definition Aspect ......................................................... 621 The Connectivity Tab........................................................................ 621 The OPC Configuration Tab ............................................................. 622 Configuring the System 800xA OPC DA Connector Service .......... 623 Service Group ................................................................................... 623 Service Provider................................................................................ 624 OPC Control Connection Aspect ...................................................... 624 Test of Data Access........................................................................... 625 Properties of the Control Connection Aspect ................................... 625 Property View Tab ............................................................................ 626 Property Info Tab .............................................................................. 628 Additional Info Tab........................................................................... 629 OPC Settings .................................................................................... 632 Item Properties .................................................................................. 633 Upload .................................................................................... 634 Standard Upload ............................................................................... 635 Advanced Upload.............................................................................. 636 Changes of the Settings for Uploaded Items .................................... 639 Property Signal Generator Aspect .................................................... 639 Configuration Steps .......................................................................... 639 DCOM Security Settings for OPC..................................................................... 640 Settings on Windows XP SP2 ........................................................... 641 22 3BDS011222R4101 Table of Contents OPC DA Client...................................................................................................644 OPC Node in the same Domain ........................................................644 OPC Node in another Domain or without Domain ...........................644 OPC DA Server ..................................................................................................645 OPC Client Node in the same Domain .............................................645 OPC Client Node in another or without Domain ..............................645 Upload ...........................................................................................................646 OPC Node in the same Domain ........................................................646 OPC Node in another Domain or without Domain ...........................646 OPC HDA Server ...............................................................................................647 OPC HDA Client Node in the same Domain ....................................647 OPC HDA Client Node in another or without Domain.....................647 OPC AE Server ..................................................................................................648 OPC Client Node in the same Domain .............................................648 OPC Client Node in another or without Domain ..............................648 How to use the OLE DB Provider......................................................................649 Command Line..................................................................................649 Keywords ....................................................................................650 Example Command Line...................................................................650 Short References ...............................................................................651 Configuration ....................................................................................651 Appendix A - Object Structures Admin Structure ............................................................................................................656 Aspect Category Structure.............................................................................................656 Aspect System Structure................................................................................................657 Asset Structure...............................................................................................................658 Control Structure ...........................................................................................................658 Documentation Structure...............................................................................................660 Equipment Structure ......................................................................................................660 Functional Structure ......................................................................................................661 Graphics Structure .........................................................................................................662 Library Structure ...........................................................................................................663 3BDS011222R4101 23 Table of Contents Location Structure......................................................................................................... 664 Maintenance Structure .................................................................................................. 665 Node Administration Structure ..................................................................................... 666 Object Type Structure.................................................................................................... 667 Obsolete Structure......................................................................................................... 668 Procedure Structure ....................................................................................................... 668 Product Type Structure.................................................................................................. 668 Product Structure........................................................................................................... 668 Reuse Design Structure ................................................................................................. 668 Scheduling Structure ..................................................................................................... 669 Service Structure ........................................................................................................... 669 System Structure ........................................................................................................... 669 User Structure................................................................................................................ 670 User Roles.......................................................................................................... 670 Workplace Structure ...................................................................................................... 672 Appendix B - Object Types Reference Information for Object Types....................................................................... 673 Object Type Groups ........................................................................................... 673 Object Types ...................................................................................................... 673 Aspect Groups.................................................................................................... 674 Aspects .......................................................................................................... 675 Object Type Definition Aspect ......................................................... 675 Object Type Reference Aspect.......................................................... 675 Super Type Reference Aspect ........................................................... 675 Object Type Extension Definition Aspect ........................................ 676 Object Factory Aspect....................................................................... 676 Object Type Group Reference Aspect .............................................. 676 Aspect Category Definition Aspect .................................................. 677 Formal Instance List Definition Aspect ............................................ 677 Formal Instance Definition Aspect ................................................... 677 Formal Instance Reference Aspect ................................................... 677 Relative Name................................................................................... 677 24 3BDS011222R4101 Table of Contents Aspect Group Definition Aspect .......................................................677 Aspect Group Reference Aspect .......................................................678 Configuration Dialogs ........................................................................................678 Type Info Tab ....................................................................................678 Create Info Tab..................................................................................679 Aspect Control Tab............................................................................681 Category Control Tab ........................................................................682 Child Control Tab..............................................................................684 Composite Info Tab ...........................................................................687 Consistency Tab ................................................................................688 Formal Instance List Definition Aspect ............................................689 Composite Object Types ....................................................................................690 Terminology ....................................................................................691 Instantiation of Composite Types......................................................692 Structure Propagation........................................................................693 Aspect Propagation ...........................................................................694 Relative References in Composite Types ..........................................694 Creating an Object Icon Aspect .........................................................................694 Creating Other Aspects ......................................................................................696 Appendix C - FDA 21 CFR Part 11 Support Introduction ...................................................................................................................697 Authorization .................................................................................................................699 Access Control...............................................................................................................699 Electronic Signature ......................................................................................................699 Versioning and Life Cycle Management .......................................................................700 Audit Trail .....................................................................................................................700 Archive ..........................................................................................................................700 System and Device Checks............................................................................................700 National Language & Training......................................................................................700 SOPs for Part 11 and cGMPs ........................................................................................701 Appendix D - SMS and E-Mail Messaging 3BDS011222R4101 25 Table of Contents Setup and Configuration Worksheets ............................................................................ 703 GSM Service Providers................................................................................................. 712 GSM Hardware Devices................................................................................................ 714 INDEX 26 3BDS011222R4101 About This Book General This book gives you an overview on engineering and configuration of the IndustrialIT Extended Automation System 800xA in the context of an engineering project. It is an introductory manual with system scope containing short descriptions of the engineering and configuration concepts of the system and step by step instructions on important configuration workflows. Typically an engineering project that automates a plant is seen to cover the phases plant design, software production and test, installation and commissioning. The term configuration is mainly used for the concrete tool based activities to bring the the results of all engineering tasks performed in software production and test into the system. The control system connectivity for AC 800M is presumed. Other connectivity options are not covered in this book. Building the automation solution is described with focus on the process oriented Functional Planning approach, based on Function Designer, including Library Structure, Object Type Structure, Functional Structure and Control Structure. It is described in more detail in IndustrialIT 800xA - System, Engineering Workplace Function Designer. To build the automation solution based on IEC 61131 Function Block programming or on ABB´s Control Module programming, including Library Structure, Object Type Structure and Control Structure is also described shortly in this manual. It is described in detail in the manual IndustrialIT 800xA - Control and I/O, Basic Control Software, Introduction and Configuration. Furthermore all three approaches to build an automation solution are also supported by Bulk Data Management and pre-configured Bulk Data Management templates 3BDS011222R4101 27 Intended User About This Book and applications described here and in IndustrialIT 800xA - Engineering, Engineering Workplace, Basic Engineering Functions. You will find System 800xA configuration topics related to basic functions described in more detail than those related to the options of System 800xA. Where applicable topics are handled by references to corresponding other manuals. Section 1, Introduction introduces you to the main features of the system. In Section 2, Concepts you find the descriptions of the engineering and configuration concepts. Section 3, Configuration gives you an introduction to the engineering tasks and to an overall project workflow and contains more detailed step by step workflow instructions and reference information. Appendix A, Object Structures gives you a summary of all predefined hierarchical structures in the system and what they are used for. Appendix B, Object Types contains reference information for configuration of object types. Appendix C, FDA 21 CFR Part 11 Support outlines how System 800xA supports to reach FDA 21 CFR Part 11 compliancy. Appendix D, SMS and E-Mail Messaging contains configuration worksheets and reference information to be used when configuring SMS and e-mail messaging. The following subsections of this section are a guide to the conventions, the terminology and the document references used throughout this book. Intended User This book is written for application engineers performing • either the tasks to set up the system for engineering project work • or the tasks to engineer and configure the automation solution when working for an engineering project. This book´s focus is on engineering and configuration tasks performed in software production and test of an engineering project. 28 3BDS011222R4101 About This Book Document Conventions As a reader of this book you should have basic knowledge of engineering and configuration of process automation systems in general. You should be interested to get an overview on the configuration and engineering concepts and introductory “how to do” instructions. If you work on system set up please read Section 1, Introduction and Section 2, Concepts, and Appendix A, Object Structures.You further should read the section on Configuration Wizard in IndustrialIT 800xA - System, Administration and Security and the IndustrialIT 800xA - System, Post Installation Setup instructions. If you do engineering and configuration please read Section 1, Introduction, and Section 2, Concepts, and Section 3, Configuration. Additionally the appendices Appendix A, Object Structures, and Appendix C, FDA 21 CFR Part 11 Support are recommended. Of course reading can be minimized according to the concrete task profile of an application engineer in an engineering project, for example: • Using ready-made object type libraries does not require to study the subsections on library and object type design and creation. • If no process data access from / to third party systems or programs is to be implemented in the project reading of the Data Access subsections can be skipped. • Only use of an On-Site Engineering System requires reading the System Synchronization subsections. • Working in a small project just using Control Structure does not require reading the subsection on Structured Plant Modelling. Please read the applicable System 800xA release notes before you start work on an engineering project. They contain important information not contained in the ordinary user documentation. It is recommended that you have participated in introductory ABB training courses for IndustrialIT Extended Automation System 800xA. Document Conventions The following conventions are used for the presentation of material: 3BDS011222R4101 29 Document Conventions About This Book • The words in names of screen elements (for example, the title in the title bar of a window, the label for a field of a dialog box) are initially capitalized. • Capital letters are used for the name of a keyboard key if it is labeled on the keyboard. For example, press the ENTER key. • Lowercase letters are used for the name of a keyboard key that is not labeled on the keyboard. For example, the space bar, comma key, and so on. • Press CTRL+C indicates that you must hold down the CTRL key while pressing the C key (to copy a selected object in this case). • Press ESC E C indicates that you press and release each key in sequence (to copy a selected object in this case). • The names of push and toggle buttons are boldfaced. For example, click OK. • The names of menus and menu items are boldfaced. For example, the File menu. • – The following convention is used for menu operations: MenuName > MenuItem > CascadedMenuItem. For example: select File > New > Type. – The Start menu name always refers to the Start menu on the Windows Task Bar. System prompts/messages are shown in the Courier font, and user responses/input are in the boldfaced Courier font. For example, if you enter a value out of range, the following message is displayed: Entered value is not valid. The value must be 0 to 30. You may be told to enter the string TIC132 in a field. The string is shown as follows in the procedure: TIC132 Variables are shown using lowercase letters. sequence name 30 3BDS011222R4101 About This Book Use of Warning, Caution, Information, and Tip Icons Use of Warning, Caution, Information, and Tip Icons This publication includes Warning, Caution, and Information where appropriate to point out safety related or other important information. It also includes Tip to point out useful hints to the reader. The corresponding symbols should be interpreted as follows: Warning icon indicates the presence of a hazard which could result in personal injury. Caution icon indicates important information or warning related to the concept discussed in the text. It might indicate the presence of a hazard which could result in corruption of software or damage to equipment/property. Information icon alerts the reader to pertinent facts and conditions. Tip icon indicates advice on, for example, how to design your project or how to use a certain function Although Warning hazards are related to personal injury, and Caution hazards are associated with equipment or property damage, it should be understood that operation of damaged equipment could, under certain operational conditions, result in degraded process performance leading to personal injury or death. Therefore, comply fully with all Warning and Caution notices. Terminology The following is a list of terms associated with the System 800xA that you should be familiar with. The list contains terms and abbreviations that are unique to ABB or have a usage or definition that is different from standard industry usage. 3BDS011222R4101 31 Terminology About This Book Table 1. Terms Term/Acronym Description ACD Asset Condition Document. Contains all information necessary to describe an asset condition. Generated by the Asset Monitor. Adaptor The data source dependent parts of the Afw OPC/DA sever. An Afw OPC/DA Server consists of a connector, which includes common functionality, and an adaptor that provides the necessary adaptations for a particular data source. The connector is a shared component provided by the System 800xA platform. The adaptor is a specific component for each type of data source. Adaptors are easier to implement than OPC servers, because much of the required OPC functionality is provided by the connector and the service handler. For data sources where an OPC server is already available, a platform provided adaptor for OPC servers is used. Affinity definition Defines how a specific group of workplaces shall connect to a specific group of servers, to control how the server capacity is utilized, e.g. to ensure that operators always have good response times. Affinity also describes how workplaces shall be reconnected to different servers in various failure situations. Afw OPC server An OPC server that unifies a client's access to all data sources, by splitting a request into separate requests for separate data sources, and merging the responses. Afw OPC servers are modeled after the Afw Service concept. The System 800xA platform provides OPC servers for OPC/DA, HDA, and AE. 32 3BDS011222R4101 About This Book Terminology Table 1. Terms Term/Acronym Afw Service Description A software component that provides a certain set of functions in the system, typically for use by various client applications. An Afw Service is designed to run around the clock. It can normally be portioned into several service groups, each group handling part of the scope of the service (e.g. part of the object space). For redundancy each group can contain several service providers running on different servers. Afw service handler A COM object that a client application includes and runs as an in-process object to access an Afw service Alarm An alarm is an abnormal state of a condition associated with an Aspect Object. For example, the object FC101 may have the following conditions associated with it: HighAlarm, HighHighAlarm, Normal, LowAlarm, and LowLowAlarm. An alarm is active as long as the abnormal state of the corresponding condition persists. An alarm is unacknowledged until a user has acknowledged it. Alarm acknowledgement A user action to confirm the recognition of an alarm. Acknowledgement changes the state of an alarm from unacknowledged to acknowledged. Application See System Application and User Application. Application Server Server that runs system applications, such as the Information Management History Services, Production Management (Batch Management and Production Management), Asset Optimization, Process Optimization, Simulation, and also third party and user provided applications 3BDS011222R4101 33 Terminology About This Book Table 1. Terms Term/Acronym Application log (AppLog) 34 Description The application log is the primary debug and diagnostics tool. An AppLog message includes information on submitting process (name and PID), thread, node, time, component, log channel and level, plus a message text. ARD The absolute reference designation is a hierarchical concatenation of relative Aspect Object names like Functional Designation or Location Designation within a structure. Aspect A representation of a facet of a real world entity, which entity is represented as an Aspect Object. An aspect defines a piece of information, and a set of functions to create, access, and manipulate the information. Aspect category A specialization of an aspect type. For example, the aspect type Graphic Display includes the categories Overview, Group, and Object Display. Aspect Framework (Afw) Platform functionality that supports integration of aspect systems and connectivity components, including concepts, APIs, and tools. System 800xA platform A collection of software that forms the basis for an IIT system, and provides the development and execution environment for IIT compliant applications. The System 800xA platform includes the Aspect Framework. Aspect ObjectTM Aspect Objects are representations of real world entities that a user interacts with, such as valves, reactors, products, material, production orders, batch procedures, customer accounts, etc. Different facets of these real world entities are modeled as aspects. An Aspect Object is not an object in a strict sense, e.g. like a COM object, but rather a container of references to implementations of its aspects. 3BDS011222R4101 About This Book Terminology Table 1. Terms Term/Acronym Aspect Object Architecture Description The Aspect Object Architecture defines the Aspect Object concept, the System 800xA platform, the Aspect Framework, the system topology, underlying technologies, and concepts and rules for development of Aspect Systems and for device integration. Aspect Object structure An organization of Aspect Objects in a hierarchical structure, based on some specific form of parent-child relationships between the objects. Examples are Functional Structure, where the relationships are defined by functional containment, and Location Structure, where the relationships are defined by physical placement of the objects. Aspect Object type An Aspect Object type defines certain characteristics that are shared between several Aspect Object instances, such as a basic set of common aspects. This makes it possible to create and efficiently re-use standardized solutions to frequently recurring problems. For example, rather than building an Aspect Object from scratch for every valve in a plant, you can define a set of valve types, and then create all valve objects as instances of these types. Aspect Server A server that runs the central functions of the Aspect Object architecture, such as Aspect Directory, Structure and Name Server, Cross Referencing, File Set Distribution, etc. Aspect system A software system, which implements one or several aspect types by providing one or several aspect system objects. 3BDS011222R4101 35 Terminology About This Book Table 1. Terms Term/Acronym Description Aspect system object (ASO) A COM object through which an aspect system provides (part of) the functionality associated with an aspect type. This COM object supports certain framework-defined interfaces, through which the application can initiate and participate in common operations on Aspect Objects and aspects. Aspect type An aspect type represents the implementation of a certain aspect. For example, the aspect system Process Graphics implements the aspect types Graphic Display, Faceplate, and Display Element. Aspect view An aspect can typically present its information in several different ways. These presentations are called aspect views. Audit event An event that is recorded in the audit trail. Audit trail An automatic record of all operator and engineering actions, showing who made the action and when. Actions include operator actions, such as opening a valve, starting a manufacturing sequence, entering some data, acknowledging an alarm, etc., as well as entries, changes, moves or deletes of electronic records, system configuration data, and security settings. In the IndustrialIT System 800xA, the audit trail is a subset of all events, including those events that are classified as audit events. 36 Authentication The process by which the system validates the user's logon information. A user's name and password are compared against an authorized list. If the system detects a match, access is granted to the extent specified in the permissions list for that user. Biometrics Authentication techniques that rely on measurable physical characteristics, e.g. fingerprints, that can be automatically checked. 3BDS011222R4101 About This Book Terminology Table 1. Terms Term/Acronym Description Client application Client applications are applications that utilize the functionality provided by one or more Afw Services, e.g. to present some information to a user. Client/Server Library (CSLIB) A component library with COM objects that implement client-server communication based on sockets. Client/Server network A client/server network is used for communication between servers, and between workplaces and servers. COM The Microsoft’s Component Object Model (COM) is a software architecture that allows applications to be built from binary software components. Composite Aspect Object An Aspect Object instance that contains other object instances. This containment is implemented by having other objects as children in one or more structures where the composite object is placed. The set of objects placed under the composite object are the children of the composite object. Usually the term "composite object" means a composite object including all its children. Composite Aspect Object type A composite Aspect Object type describes a set of Aspect Objects organized in a structure, with a parent object and one or several child objects. The children in a composite object type are called formal instances, because they inherit from object types defined elsewhere in the Object Type Structure, but they are not actual instances. When a composite object is instantiated actual instances are created for these child objects. Connectivity component A connectivity component provides access to real time data, historical data, and/or alarm and event data, from a certain type of device. 3BDS011222R4101 37 Terminology About This Book Table 1. Terms Term/Acronym 38 Description Connectivity package Connectivity components, up-loader, supporting aspect systems (e.g. for configuration), and graphical elements, faceplates, Aspect Object types, etc., bundled together to provide the integration of a certain type of devices into the IIT system. Connectivity Server A server that provides access to controllers and other sources for real-time data, historical data, and alarm and event data. A Connectivity Server runs services related to OPC/DA, APC/AE, OPC/HDA, and SysMsg Connector The generic part of an Afw OPC/DA server. See also adaptor. Context menu A menu that appears when you right-click on an Aspect Object or an aspect. The context menu lists aspect operations, actions, aspects, and global operations. Control network A control network is a local area network (LAN) that is optimized for high performance and reliable communication with predictable response times in real time. Control network devices and servers are connected to the control network. Control network device Device connected through an IIT supported control network. Examples are controllers, robots, variable speed drives, etc. Default action The action that is initiated when you select (double click with the left mouse button) an Aspect Object. A typical action is to select a default aspect. Device An entity that in some form of dedicated environment provides part of the functionality of certain aspects. 3BDS011222R4101 About This Book Terminology Table 1. Terms Term/Acronym Description Digital signature A digital code, that can be attached to electronically stored or transmitted data record, and that uniquely identifies the data and the individual that signed the data. Like a written signature, the purpose of a digital signature is to guarantee that the individual signing the data record really is who he or she claims to be, and that the data has not been altered since it was signed. DMS Device Management System - 3rd party software used for the DMS Calibration Integration option of Asset Optimization. See also Meriam DMS. Double authentication The process of identifying two individuals, usually based on usernames and passwords. Double authentication is typically used to ensure that certain critical operations are performed by an authorized individual and approved by an additional individual, where the additional individual has the authority to approve such operations. Downstream history server A down-stream history server is a history server that provides its own collection and storage functions, but wants to make its data accessible through the unified OPC/HDA access mechanism that is provided by Afw OPC/HDA. See also History linked collector. Electronic record Any combination of text, graphics, data, audio, pictorial, or other information representation in digital form that is created, modified, maintained, archived, retrieved, or distributed by a computer system. Electronic signature A computer data compilation of any symbol or series of symbols executed, adopted, or authorized by an individual to be the legally binding equivalent of the individual's handwritten signature. 3BDS011222R4101 39 Terminology About This Book Table 1. Terms Term/Acronym Description Event An event is a detectable occurrence, which is of significance to an Aspect Object. An event may or may not be associated with a condition. For example, the transitions into HighAlarm and Normal conditions are events, which are associated with conditions. However, operator actions, system configuration changes, and system errors are examples of events, which are not related to specific conditions. OPC Clients may subscribe to be notified of the occurrence of specified events. Extension library See Library Faceplate A faceplate is an aspect that provides a graphical representation of a certain Aspect Object, with presentation of certain properties related to the object, and mechanisms for operator interaction such as on/off, increase/decrease, etc. Aspect Object types often include several different faceplate aspects, providing different presentation and interaction possibilities. See also Object display. 40 Fieldbus A fieldbus is used to interconnect field devices, such as I/O modules, smart sensors and actuators, variable speed drives, PLCs, or small single loop devices, and to connect these devices to the IIT system. Fieldbus device Device connected through an IIT supported fieldbus. Examples are remote I/O and smart sensors and actuators, but also controllers, robots, variable speed drives, etc., when these devices are connected through a supported fieldbus. Generic device Device connected to an IIT system through other means than IIT supported control networks and fieldbuses. Examples are devices connected through Modbus and similar protocols. 3BDS011222R4101 About This Book Terminology Table 1. Terms Term/Acronym Description Graphic display A graphic display is an aspect that provides a visual presentation. It consists of static graphics representing for example tanks, pipes, etc., and graphic elements that present dynamic information. Graphic displays are often used to present the state of a process or a part of a process, but are useful in any context where dynamic graphical information needs to be presented. Examples of predefined graphic display categories are Graphic Display, Overview Display, Navigation Display, Status Display, etc. Graphic element A graphic element is an aspect that is associated with an Aspect Object type, to be used in graphic displays to present dynamic information for instances of that type. An object type may have several different graphic element aspects to allow the user to select among different visual presentations. History collector A history collector is part of a connectivity package. It is used by the Afw OPC/HDA server for collecting historical data from data sources that support some form of data streaming or other access means that are more efficient for collecting historical data than OPC/DA. History linked collector A linked history collector is an OPC/HDA sever that is linked as a downstream history server under the Afw OPC/HDA server. See also Downstream history server IT Industrial ABB's vision for enterprise automation. IndustrialIT certification A concept and a set of criteria for verifying that a product is IndustrialIT conformant. IndustrialIT Enabled A concept and a set of criteria for verifying that a product is IndustrialIT conformable. IndustrialIT installation An installation of IndustrialIT products at a particular site 3BDS011222R4101 41 Terminology About This Book Table 1. Terms Term/Acronym Description IndustrialIT product A product that meets certain criteria for IndustrialIT conformance (see IndustrialIT enabled) IndustrialIT system An arrangement of IndustrialIT products, which work together as a system, implementing (part of) the IndustrialIT vision. IndustrialIT system offering A defined offering to the market of IndustrialIT products intended for a particular area of application or use. The products that are included in an IndustrialIT offering are verified together, and the resulting system has a defined behavior, capacity, and performance. KKS Kraftwerk-Kennzeichensystem, german standard naming rules for power plants. Library A collection of Aspect Object types that are kept together from a distribution and life cycle management point of view. (Object type library) Log over Temporarily changing user, without first logging out the current user and without breaking the current context. This function is useful in cases were a certain operation requires higher authority than that held by the current user, in which case e.g. a supervisor may temporarily assume the responsibility, allowing his or her authority to be temporarily applied. 42 Meriam DMS Meriam Process Technologies Device Management System (DMS) database software. Provides calibration management through the companion MFT 4000 Series Calibrator/HART Communicator, and MFC 4100 HART Communicator. MFT 4000 Multifunctional Modular Calibrator / HART Communicator (DPC). 3BDS011222R4101 About This Book Terminology Table 1. Terms Term/Acronym Description Object display An object display is an aspect that provides a graphical representation of an Aspect Object, with a comprehensive presentation of the object's properties. Interaction mechanisms include support for tuning, calibration, etc., in addition to operator related interaction such as on/off, increase/decrease, etc. (cf. Faceplate). Object trend An object trend is an aspect that provides a curve representation of historical values of certain properties of an Aspect Object OPC item OPC items represent connections to data sources, i.e. object properties. An OPC item is identified by a string <object path>:<property name>. Associated with each OPC item are Value, Quality and Time Stamp. Note that OPC items are not identical with the data sources - they represent connections to them. See also Property. Operation (Aspect Object operation) The system defines a set of operations that can be performed on Aspect Objects, such as Edit, Lock, Configure, Tune, View, etc. An aspect system (actually an aspect type) can define additional operations, as part of the registration done by every aspect system. Permission A permission (or access mask) groups a set of operations that require the same authority. For each operation defined for an aspect, the aspect category specifies the permission needed to use that operation Plant Explorer A configuration of the Internet Explorer for creating the Aspect Object that you use to put together the plant. You can also use it to browse and search the structures of the plant. 3BDS011222R4101 43 Terminology About This Book Table 1. Terms Term/Acronym Description Product family A range of products within a Product suite, forming a scalable offering. Examples: a range of controllers, a family of I/O products. Product suite Products with similar functionality are kept together in a suite. Suites names have a superscripted IT-suffix. Examples: OperateIT, ControlIT, ProduceIT, etc. Project A Project collects all data of an engineering project. They are administrated by the Configuration Wizard application of the System 800xA platform. System is an synonym for Project. Property Aspect Objects can have properties. A property is a named data item that is related to an Aspect Object. Properties are typically owned and managed by aspect systems. (Object property) An aspect system supplies information through framework-defined interfaces about the properties it exposes. These properties become accessible through Afw OPC/DA.A control aspect, for example, may expose properties such as VALUE, SETPOINT, and OUTPUT for a control function. The Name aspect provides the properties NAME and DESCRIPTION. See also OPC item. Re-authentication The process of re-identifying an individual previously identified through authentication. Re-authentication serves two purposes 1. It verifies that the individual trying to perform a certain operation is identical with the user that is currently logged on. 2. It means that the user electronically signs that he or she is performing the operation. 44 3BDS011222R4101 About This Book Terminology Table 1. Terms Term/Acronym Security Description Security controls a user's authority to perform different operations on Aspect Objects, depending on several parameters: - The user's credentials, as provided by Windows - The node where the user is logged in. This makes it possible to give a user different authority depending on where he or she is located, e.g. close to the process equipment, in a control room, or at home accessing the system through Internet - The operation the user wants to perform - The Aspect Object that the user wants to perform the operation on Security definition aspect An aspect that holds one ore more security descriptors Security descriptor A security descriptor includes an access control list, where each entry specifies a permission (access mask) and the users and/or user groups that are granted (or denied) access. The security descriptor also includes an audit control list, specifying which operations shall be logged for auditing purposes. See also relevant documentation on Microsoft Windows security functions. Server A node that runs one or several Afw Services Service A software component that provides a certain set of functions in the system, typically for use by various client applications. See also Afw Service. Service provider A process that runs a service. SNMP Simple Network Management Protocol. A network management standard that defines a strategy for managing TCP/IP and Internet Packet Exchange (IPX) networks. 3BDS011222R4101 45 Terminology About This Book Table 1. Terms Term/Acronym Description Solution A configuration of software and hardware components that can be applied to a certain class of problems. The design and functional scope of a solution should be optimized to make it re-usable in a practical way.A solution is built from other solutions and/or basic system functions. It consists of simple and composite Aspect Object types, with default parameter values and other configuration data for the aspects, e.g. control logic, process graphics, alarm and event specifications, reports, etc. Structure A hierarchical tree organization of Aspect Objects that describes the dependencies between the real objects. An Aspect object can exist in multiple structures, for example both in a functional structure and in a location structure. System A System collects all data of an engineering project. They are administrated by the Configuration Wizard application of the System 800xA platform. Project is an synonym for System System application A software component, based on the Aspect Object architecture, which provides functionality. System applications cooperate according to rules defined by the Aspect Object architecture. They are normally bundled into system products or system extensions. System applications are implemented as client applications or services. To participate in Aspect Object operations, an application must present itself as an aspect system (or possibly as several aspect systems). When there is no risk for confusion, the term "application" may be used instead of "system application". 46 3BDS011222R4101 About This Book Terminology Table 1. Terms Term/Acronym Description System offering A defined collection of IndustrialIT products that work together in verified configurations, with guaranteed function, capacity and performance, and behavior. A system offering defines the basis for version management, and for definition and verification of requirements. System product A system product consists of applications bundled together with relevant parts of the System 800xA platform. Several system products can be installed on the same physical node. System extension A system extension consists of one or more system applications that are bundled as an extension to one or several existing system products. A system extension can only be installed if (one of) the corresponding system product(s) has been installed previously. System version A system version defines the collection of specific versions of IndustrialIT products, as well as operating system and similar components, which constitute a system offering at a given point in time. System product extension A System product extension consists of one or more applications that are bundled as an extension to one or several existing System Product. A System Product Extension can only be installed if (one of) the corresponding System product(s) has been installed previously. Tag The perception of a Tag is basically that it is an object you can put a label on, e.g. motor, transmitter or valve. In the 800xA system an object that has a Faceplate is considered a Tag. This means that a Tag is any Aspect Object in the Control Structure which has a Faceplate Aspect attached. 3BDS011222R4101 47 Terminology About This Book Table 1. Terms Term/Acronym Description Thin client A thin client is a web browser connected to the Internet (or Intranet). It does not require any ABB-related pre loaded software. It supports ActiveX controls, but it communicates with the IndustrialIT only through Internet technologies. Internet Explorer is used as browser. Ultra-thin client An ultra-thin client is similar to a thin client, but any web browser can be used. It does not support ActiveX, and it does not make any assumption about screen sizes. Up-loader An up-loader is used to 'import' a configuration from devices, to read in and build a set of Aspect Objects from information present in the devices. User application A configuration of software and hardware components that applies to a specific problem, e.g. a specific process control problem. A user application consists of a set of simple and composite Aspect Object instances, with parameter values and other configuration data for the aspects, e.g. control logic, process graphics, alarm and event specifications, reports, etc. A user application is built from solutions and/or basic system functions. When there is no risk for confusion with system application, the term "application" may be used instead of "user application". 48 View (see also Aspect View) Web device Device that includes a web server through which information and functionality of the device is accessed. 3BDS011222R4101 About This Book Terminology Table 1. Terms Term/Acronym Description WMI Windows Management Instrumentation. A scalable system management infrastructure that uses a single consistent, standrads-based, extensible, object-oriented interface. WMI provides software developers with a standard way to interact with system management information. Workplace User interactive functions that are combined for a particular use case, e.g., Operator Workplace, Engineering Workplace, etc. A node that runs one or several workplace applications. 3BDS011222R4101 49 Related Documentation About This Book Related Documentation The following is a listing of documentation related to configuration of 800xA systems. Table 2. Related Documentation Category Installation Title IndustrialIT 800xA - System Installation IndustrialIT 800xA - System Post Installation Setup IndustrialIT 800xA - Control and I/O OPC Server for AC 800M Installation and Configuration IndustrialIT 800xA - System Automation System Network Description Introduces to the system and describes installation of the 800xA system. Describes post installation setup of the 800xA system. Describes installation and product configuration of the OPC Server for AC 800M. Describes installation and configuration of the automation system network. Design and Configuration IndustrialIT 800xA - System Upgrade and Installation IndustrialIT Device Library Wizard Describes upgrade and installation setup of the 800xA system. Describes installation and use of the Device Library Wizard. FOUNDATION Fieldbus, HART, PROFIBUS User Instructions Administration IndustrialIT 800xA - System Administration and Security 50 Describes administration and security setup of the 800xA system. 3BDS011222R4101 About This Book Related Documentation Table 2. Related Documentation Category Operation Title IndustrialIT 800xA - System Basic Operation IndustrialIT 800xA - System Extended Operation Description Gives an overview of the operation of the 800xA system. Describes operation of the 800xA system in detail. IndustrialIT 800xA - Information Management Operation Describes operation of Information Management functions IndustrialIT 800xA - Asset Optimization Operation Describes operational activities related to Asset Optimization and PC, Network and Software Monitoring. 3BDS011222R4101 51 Related Documentation About This Book Table 2. Related Documentation Category Configuration Title IndustrialIT 800xA - Engineering Engineering Workplace Basic Engineering Functions IndustrialIT 800xA - Engineering Engineering Workplace Function Designer IndustrialIT 800xA - System Topology Designer IndustrialIT 800xA - Operations Operator Workplace Configuration IndustrialIT 800xA - Engineering Graphics IndustrialIT 800xA - Control and I/O Basic Control Software Introduction and Configuration ControlIT IEC 61131 Control Languages Introduction 52 Description Describes the basic engineering functionality of the Engineering Workplace including Bulk Data Manager, IO Allocation, Script Manager, Parameter Manager, Document Manager and Reuse Assistant. Describes the functionality of and engineering with Function Designer tool. Function Designer is part of Control Builder M Professional of the Engineering Workplace. Describes the Topology Designer tool used to create system wide Topology Status Viewer diagrams. Describes configuration of the Operator Workplace and Plant Explorer. Describes configuration of process graphics for Operator Workplace. Introduces to working with Control Builder M Professional in the Engineering Workplace and describes control module and function block based application programming strategy and design topics. Introduces to IEC 61131 languages supported in Control Builder M Professional of the Engineering Workplace. 3BDS011222R4101 About This Book Related Documentation Table 2. Related Documentation Category Configuration Title IndustrialIT 800xA - Control and I/O Extended Control Software Binary and Analog Handling IndustrialIT 800xA - Safety Safety Manual AC 800M High Integrity. IndustrialIT 800xA - Control and I/O OPC Server for AC 800M Installation and Configuration IndustrialIT800xA - Control and I/O Addendum Description Describes how to create re-usable automation solutions using the ABB standard libraries that are supplied with System 800xA. Describes guidelines and safety considerations related to all safety lifecycle phases of an AC 800M High Integrity controller. Also lists the available SIL certified library object types. Describes installation and product configuration of the OPC Server for AC 800M. Provides important product data and design information. Product Data and Design IndustrialIT 800xA - Information Management Describes configuration of Information Management applications. Configuration. IndustrialIT 800xA - Information Management Display Services Configuration IndustrialIT 800xA - Asset Optimization Configuration IndustrialIT 800xA - Production Management Configuration (includes Batch Management and Manufacturing Management) 3BDS011222R4101 Describes configuration of Information Management Display Services applications Describes configuration of Asset Optimization applications. Describes configuration of Batch Management and Manufacturing Management applications. 53 Related Documentation About This Book Table 2. Related Documentation Category Configuration Title Description IndustrialIT 800xA - Device Management Describes configuration of Foundation Fieldbus Device Integration FOUNDATION Fieldbus applications. Configuration IndustrialIT 800xA - Fieldbus Basic PROFIBUS DTM / PROFIBUS DTM Builder Describes configuration of PROFIBUS DTM Builder applications. Configuration IndustrialIT 800xA - Device Management Describes configuration of PROFIBUS Device Integration applications. PROFIBUS Configuration IndustrialIT 800xA - Fieldbus Basic HART DTM / HART DTM Builder Describes configuration of HART DTM Builder applications. Configuration IndustrialIT 800xA - Device Management Describes configuration of HART Device Integration applications. HART Configuration IndustrialIT 800xA - Control and I/O PROFIBUS DP Engineering and Configuration IndustrialIT 800xA - System AC400 Connect Describes the configuration of PROFIBUS DP-V1 in System 800xA using the communication interface CI854/CI854A. Describes configuration and use of AC400 Connect. Configuration 54 3BDS011222R4101 About This Book Related Documentation Table 2. Related Documentation Category Other Title IndustrialIT 800xA - Engineering Aspect StudioTM IndustrialIT 800xA - Engineering Describes aspect system development for System 800xA with Aspect Studio tools. Aspect Express Describes aspect system development for System 800xA with the Aspect Express tool. IndustrialIT 800xA - System Programming Guide Describes programming for System 800xA extensions. Meriam Process Technologies Device Management System User’s Guide Describes DMS configuration. TM Third Party Description 3BDS011222R4101 55 Related Documentation 56 About This Book 3BDS011222R4101 Section 1 Introduction System Overview The IndustrialIT Extended Automation System 800xA, System Version 4.1, covers operation as well as engineering and configuration of continuous and batch automation solutions and supports FDA 21 CFR part 11 compliance of these applications. The foundation of System 800xA is the Aspect Object architecture implemented by the Aspect framework. This framework is included into the basic system functions of System 800xA. The Aspect ObjectsTM technology enables enterprise wide information availability, browsing and navigation in a unified way. The information resides in an integrated environment configurable for various types of users. The user interface can be used with default settings or be customized providing user categories such as operators, engineers and maintenance personnel, all with an environment focused on their main tasks. As a result, the users can concentrate on the right actions, with a minimum of effort, resulting in increased productivity. For building your plant model, the unique engineering tool Plant Explorer is integrated as a part of the system. Based on the Aspect ObjectTM technology it offers a powerful way of creating object oriented solutions, re-usable within the project or saved in libraries for later use. The engineering tools for configuration of the different functional areas of the 800xA system are integrated into Plant Explorer and accessible via Engineering Workplace. Further introductory information on Aspect Object technology is given in Aspect Object Model on page 70 and in Aspect Object Architecture on page 281. 3BDS011222R4101 57 System Functions Section 1 Introduction System Functions The IndustrialIT Extended Automation System 800xA is a comprehensive process automation system providing functionality for operation as well as for engineering and configuration of an extended automation solution. It is offered in two variants: • Extended Automation System 800xA • Engineering System 800xA While the Extended Automation System 800xA offering covers the complete system functions and licences to engineer and configure, test, and run the extended automation solution for a plant in production, the Engineering System 800xA offering covers the system functions and licenses needed to engineer and configure and test the extended automation solution on an engineering system configuration. Both offerings base on the same pool of system functions, categorized as functional areas providing features. Functional areas and features included/offered with Engineering System are tagged with (*): • 58 System 800xA*) The basic functions manage the Aspect Objects, the communication between them and information access to them and includes the features: – (One) Operator Workplace (Client) (*,0) – (One) Engineering Workplace (Client) (*,0) – AC800M Connectivity (*,0) – Redundant Aspect Server (*,0) – System Synchronization (*,0) – Plant Explorer (*,0) – Topology Status Viewer / Topology Designer (*,0) – Softpoint Server (*,0) – Scheduler (*,0) – Primary History Logs (*,0) – Asset Monitors (10) (*,0) – Diagnostics Collection (*,0) 3BDS011222R4101 Section 1 Introduction System Functions Operator Workplace provides the functions to interact with the process running in the plant using a graphical user interface (graphical displays, faceplates, and alarm and event lists, etc.). Engineering Workplace provides the functions of the engineering tools, see functional area Engineering below. Further the following optional features can be licensed: – Audit Trail (*,0) – Advanced Access Control (Re-Authentication and Double Authentication) (*,0) – Log Over (*,0) – Digital Signature (*,0) – SMS and e-mail Messaging (*,0) – Calculation Engine (*,0) – OLE-DB Real Time Data-Client Connection (*,0) – System 800xA OPC-Client Connection (*,0) – Connectivity options to other ABB controller and I/O series are also available. (*,0) (*,0):Feature included in Engineering System 800xA In addition to the basic functions of System 800xA (listed above) more functions are provided for different areas listed by the following bullets: • Operations Operator Workplaces allow you to supervise and control your automated plant via graphical displays and faceplates, alarm and event lists, and trend displays. (Functionality of and one license for Operator Workplace is already included in basic System 800xA .) • Engineering (*) Engineering Workplaces (*) with a comprehensive set of engineering and development tools give you access to configuration of the functionality of all functional areas. (Functionality of and one license for Engineering Workplace including Standard Engineering Tools is already included in basic System 3BDS011222R4101 59 System Functions Section 1 Introduction 800xA.) Standard Engineering Tools (*): Engineering Base, Function Designer, Control Builder M Professional, Graphics Builder (required external product Microsoft Visual Basic 6.0 not included), Bulk Data Management, I/O Allocation, Document Manager, Parameter Manager and Script Manager Basic. Professional Engineering Tools (*, 1): Script Manager Professional, Reuse Assistant, Library Assistant, Aspect Express (required external product Microsoft Visual Basic 6.0 not included). Developer Engineering Tools (*, 2): Aspect Studio (including Aspect Express and System Development Kit). (*, 1) and (*,2):Basic engineering tools for Engineering System • • • Control and I/O – AC800M Process Control Software Integration – SoftController Safety – AC800M High Integrity Control Software Integration – AC800M High Integrity and Process Control Information Management (*) Information Management provides a repository of process, event and production information including – Basic Historian Server (*,3) – History Logs (*,3) – Dual History Logs (*,3) – Consolidated History Logs (*,3) (*,3): History Engineering 60 – Display Builder for MDI Client (*,4) – Multiscreen Display Interface (MDI) (*,4) – Desktop Trends (*,4) 3BDS011222R4101 Section 1 Introduction – System Functions Excel Data Access (*,4) (*,4): MDI Engineering • – ODBC Historical Data Server – ODBC-Client Connection – OLE-DB Historical Data Server – OLE-DB Client Connection Production Management Production Management comprises the Batch Management and Manufacturing Management functions. Batch Management (*) provides flexible batch processing which permits control logic and resources such as equipment to be used in a variety of ways to produce different products. – Batch Client (*,5) – Batch Procedures (*,5) – Batch Equipment (*,5) – Batch Server (*,5) – Batch Server Redundant (*,5) – Batch Advanced Phases (*,5) – Batch Schedule Interface (*,5) (*,5): Batch Management Engineering Manufacturing Management 3BDS011222R4101 – Manufacturing Management Server – Manufacturing Management Client – Inventory Management – Weigh and Dispense – Quality Management – Operations Management 61 System Functions • Section 1 Introduction Asset Optimization Asset Optimization functionality includes asset condition reporting, asset monitoring, CMMS (Computerized Maintenance Management System) integration, DMS (Meriam Process Technologies Device Management System) calibration integration to the 800xA system. This optimizes the use of plant equipment and processes. When integrated with SMS and e-mail Messaging, Asset Optimization provides a method for sending messages based on alarm and event information to user devices such as mobile telephones, e-mail accounts, and pagers. When integrated with FOUNDATION Fieldbus, HART, or PROFIBUS Device Integration, Asset Optimization provides a method for detecting field device problems. – Asset Monitoring – PC, Network and Software Monitoring (*,6) – Maximo Integration – SAP / Plant Maintenance Integration – DMS Calibration Integration (*,6): PC, Network and Software Monitoring for Engineering System 800xA supports two CMMS, Maximo and SAP/PM. The supported functionality varies between Maximo Integration and SAP/PM Integration. • Device Management Integration of field devices is supported for HART, PROFIBUS and FOUNDATION Fieldbus. – HART Device Integration (*,7) Includes Fieldbus Builder PROFIBUS/HART with OPC Server, Basic HART DTM (DTM Builder Runtime), HART Device Library, S800/S900 DTMs. (*,7):HART Device Integration for Engineering – 62 HART Multiplexer Connect Enables HART Device Integration to connect to HART devices via HART Multiplexers 3BDS011222R4101 Section 1 Introduction – System Functions FOUNDATION Fieldbus Device Integration (*,8) Includes Fieldbus Builder FOUNDATION Fieldbus, FF Device Library, FF Instrument Asset Monitor Library, OPC Server. (*,8):FOUNDATION Fieldbus Device Integration for Engineering – PROFIBUS Device Integration (*,9) Includes Fieldbus Builder PROFIBUS/HART with OPC Server, Basic PROFIBUS DTM (DTM Builder Runtime), PROFIBUS Device Library, S800/S900 DTMs. (*,9): PROFIBUS Device Integration for Engineering How to install and setup the install packages providing these system functions is described in the IndustrialIT 800xA - System, Installation and IndustrialIT 800xA System, Post Installation Setup handbooks. Operation functions are described in IndustrialIT 800xA - System, Basic Operation and IndustrialIT 800xA - System, Extended Operation. 3BDS011222R4101 63 System Infrastructure Section 1 Introduction System Infrastructure System 800xA bases on a system of computers and devices that communicate with each other over different types of communication networks. Conceptually this is shown in Figure 1 Figure 1. Conceptual communication network configuration A node is an addressable machine (a PC) in a network. The distributed set of server and client nodes that reside on a network comprises: The network and network devices support communication between the various system nodes, as well as communication outside the system (via plant intranet, or world wide web). 64 3BDS011222R4101 Section 1 Introduction System Infrastructure The client/server network is used for communication between servers, and between servers and workplaces. Servers run software that provides system functionality, workplaces run software that provides various forms of user interaction - for small systems, server and workplace software may be installed and run on the same machine. The control network is a local area network (LAN) that is optimized for high performance and reliable communication with predictable response times in real time. It is used to connect controllers to the servers. Fieldbusses are used to interconnect field devices, such as I/O modules, smart sensors and actuators, variable speed drives, PLCs, or small single loop devices, and to connect these devices to the system, either via a controller or directly to a server. The client/server network can be connected to a plant network, such as an office or a corporate network (intranet), via some form of network isolation device. Different system functions are provided by different nodes.The basic node types are: A Domain Server runs the Domain Controller and Domain Name System (DNS)(not required for single-node systems, or when system uses workgroups). An Aspect Server runs the central intelligence in the system, including the aspect directory and other services related to object management, object names and structures, security etc. A Connectivity Server provides access to controllers and other data sources. Several groups of connectivity servers may exist in a system, each serving one set of data sources, for example AC 800M Controllers. An Application Server runs various types of system applications: • Batch Server runs Batch Management • MM Server runs Manufacturing Management • IM Server runs Information Management • AO Server runs Asset Optimization • Other applications, for example large Softpoint and Calculation Server applications, integrated third partly applications, etc. A Remote Client Server provides terminal server functionality to connect to remote workplaces. 3BDS011222R4101 65 System Scope Section 1 Introduction Clients run workplace functionality, such as Operator Workplaces and Engineering Workplaces, including Batch clients and Information Management clients. All computer node types except the Domain Server include client functionality. These clients are referred to as server based clients. In order to optimize the cost/performance ratio for a particular installation, certain server functions can be combined in the same node. Depending on what functions are combined there are different limitations to system sizes. Approved combinations are for example: • Aspect and Connectivity Server (AS + CS) • Aspect, Connectivity and Asset Optimization Server (AS + CS + AO) • Batch, Information Management, and Manufacturing Management Server (Batch + IM + MM) • Single node engineering system Controllers run applications for real-time process control. Controllers connect to the control network. I/O systems provide the interface to process transducers. I/O-stations connect to controllers, either directly, or via fieldbusses. For details regarding planning and physical set up for networks, domains or workgroups, refer to IndustrialIT 800xA - System, Automation System Network, Design and Configuration. Regarding administration and security setup of the system see IndustrialIT 800xA - System, Administration and Security. System Scope 66 • Traditional process automation, as well as Hybrid automation. The control level ranges from DCS closed loop control to simple binary control, for wide area applications, including interface to the field, either through direct I/O or remote I/O via fieldbus, and with operator interface options including History, Alarm & Event Management, etc. • The control and automation system configuration includes the MES (Manufacturing Executions Systems) level of products and functions, such as Historian, Batch, Simulation Packages, Asset Optimization, Enterprise/Plant Optimization, etc. 3BDS011222R4101 Section 1 Introduction • Prerequisites and Requirements System 800xA scales from very small to very large systems. For process operation different 800xA systems can be connected. Prerequisites and Requirements For hardware and software requirements please read the IndustrialIT 800xA System, Installation handbook. 3BDS011222R4101 67 Prerequisites and Requirements 68 Section 1 Introduction 3BDS011222R4101 Section 2 Concepts This section provides you with introductory conceptual information on System 800xA engineering and configuration. It first introduces you to the Aspect Object Model as the foundation of the 800xA system, then it outlines how you use Aspect Objects in Engineering. Then you learn about the principles of handling important engineering and configuration topics in System 800xA: • Import/Export • Configuration Using Spread Sheets • List Based Data Exchange • Distributed Engineering • Connectivity • Automation Solution • Production Management • Information Management • Version and Access Management • Asset Optimization • Scripting • System Development • Data Access 3BDS011222R4101 69 Aspect Object Model Section 2 Concepts Aspect Object Model A central problem in plant operations and engineering as well as in asset life cycle management is that you need a way to keep together, manage, and have access to information about all different aspects of a great number of plant and process entities. Each of these real world objects needs to be described from several different perspectives. Each perspective defines a piece of information, and a set of functions to create, access, and manipulate this information. We call this an aspect of the object. And the object we call Aspect Object. It is for many reasons necessary to be able to implement these aspects using many different applications, existing and new ones, from ABB, third parties and customers, now and in the future. It is desirable to be able to do this without changing the way these applications work internally. It is not reasonable to require that all different applications are aware of each other. Still, the applications must be able to cooperate to provide an integrated view and functionality of the object. Aspect objects provide a solution to this problem. Rather than creating one single object or data model in the system to represent the real world object, each aspect is modeled separately. An aspect object is a container that includes these independent models. Figure 2. Aspect Object as a Container of Aspects Different kinds of Aspect Objects have different sets of aspects. Aspects are implemented by software systems known as aspect systems, each of which stores, manages and presents its information in its own optimal way. The environment in which aspect systems are integrated is called the Aspect Framework (AfW). This framework provides mechanisms by which the aspects systems can cooperate and 70 3BDS011222R4101 Section 2 Concepts Aspect Object Model share data, to provide an integrated view and functionality of the object, and one time data entry. An aspect system defines one or several aspect types, each representing the implementation of a certain aspect. Of each aspect type, one or more aspect categories can be defined as different specializations. Aspect systems present their functionality through COM objects. The internal implementation of an aspect system, however, is not restricted to COM; it can use any suitable implementation technology. In the Aspect Object architecture, aspect systems cooperate with other aspect systems without knowing which they are, or even how many they are. To make this possible, they do not interact directly with each other, but only with the Aspect Framework. The framework includes an Aspect Directory, where all Aspect Objects and their aspects are registered, and also all aspect systems and the operations they support. To perform an operation on an Aspect Object, an application (e.g. an aspect system) invokes a framework interface for that operation. Using information in the Aspect Directory, the framework then invokes the corresponding interfaces of all aspect systems that are concerned by that particular operation for that particular object. The result is a system of integrated but independent software systems. A natural way to represent relations between different entities is to organize them in a structure. Depending on from which perspective we look at it, the same entity fits naturally in several different structures. The concept of structures is central in the Aspect Object architecture. A number of structures are used to represent different types of information related to the system. All Aspect Object structures are hierarchical, i.e., the structures are defined by parent-child relations between Aspect Objects. Standards dealing with structural relationships between entities, such as IEC 61346 and S88, are supported. The relation to a certain structure is represented as an aspect. By adding several structure aspects to an Aspect Object, the object can be placed in several structures, or even in several positions within the same structure. By dynamically adding, deleting, and changing structure aspects, the object can be inserted in, deleted from, or moved to different positions in various structures. The Plant Explorer is used for navigation in and between object structures. It is the default tool to create and manage Aspect Objects and to browse for information. It is 3BDS011222R4101 71 Aspect Object Model Section 2 Concepts based on the Windows Explorer metaphor, but instead of folders and files it deals with Aspect Objects and aspects. Aspect Objects can have properties. A property is a named data item that is related to an Aspect Object and owned and exposed by an aspect system. A control aspect, for example, may expose properties such as VALUE, SETPOINT, and OUTPUT for a control function. The Name aspect provides the properties NAME and DESCRIPTION. Properties are identified through strings <object path>:<property name>, where <object path> identifies an Aspect Object either by a unique object name or by a reference (path) that identifies its position in an object structure. Through framework-defined interfaces, each aspect system supplies information about the properties it exposes for the aspects that it implements. These properties become accessible through Afw OPC/DA. The Aspect Object model also provides Aspect Object types as the basic re-use concept, see Object Types on page 75. 72 3BDS011222R4101 Section 2 Concepts Aspect Objects in Engineering Aspect Objects in Engineering Objects The Aspect Objects handled in the engineering process for System 800xA represent physical objects or virtual objects, for example functions, and are used as containers for engineering and runtime data. The engineering tools support a concept of plant modeling by using Aspect Objects and structures. Aspect Objects can for example be grouped into groups according their function in the plant: • Plant Section Objects Consist of a group of units that each contains a set of process objects for each of which the control system has a set of signals. This kind grouping is typically described by the structures in the system. • Process Objects More objects representing the process such as Blender, Feeder, Mixer, Pump, Reactor, Silo/Tank, Valve, Motor etc. • Signal Objects The objects corresponding to I/O signals in the control system. Signal Objects are objects for signal engineering as provided by Engineering Workplace : System extension AC 800MC Signal Extension, object type group CBM_Signals. • System Objects For example Network object, Node object, Workplace object, User object, Service Group object etc. Aspects The properties (holding engineering or runtime data) of the Aspect Object are given by the properties of its aspects. An aspect is an assembly of data describing certain properties of an Aspect Object, such as: • 3BDS011222R4101 Functional properties 73 Views Section 2 Concepts • Physical construction properties • Location properties • Control properties • etc. An Aspect Object has several aspects. Each aspect is handled by assigned tools. Figure 3 illustrates the definitions Aspect Object and aspect. Views Aspect data are presented by the assigned tools in views. An aspect may have several views. Opening aspect views gives access to the aspect system with the relevant tool to inspect, create, modify and delete the data. The data and their mapping may be presented, for example as: • Lists • Tables • Diagrams (Circuit Diagram) • Drawings (Arrangement Drawing) • Graphics • Function Diagrams Views are predefined by the aspect systems in the System 800xA software. Each aspect has one or several predefined views. See Figure 3. 74 3BDS011222R4101 Section 2 Concepts Object Types Advant OCS Product Guide, EO Section 2 Software Functions, Engineering Software All tools communicate via a common interface and are integrated by common methods into the environment. Tools within the AdvaBuild family may run on different hardware environments, like - ...... MS-Word -....... -....... Operated Plant Explorer Functional Description Valve Graphic Builder Valve Graphic Element & & & Function Chart Builder OCS circuit This is an alarm tebbxt with very small fontsnn so it is not likely to be read by anyone.xxxxx It is a representatiollllln an alarm list and nothing else, it is difficult to make the right column OK so I think I quit this work bbbnnnbbbnnhere Alarm and Event Real world object Aspect Object Aspects Alarm Config View Alarm List Views Figure 3. Illustration of an Aspect Object with its Aspects and Views Object Types An Aspect Object type defines certain characteristics that are common to several Aspect Object instances, such as a basic set of common aspects. This makes it possible to create and efficiently re-use standardized solutions to frequently recurring problems. For example, rather than building an Aspect Object from scratch for every valve in a plant, you can define a set of valve types, and then create all valve objects as instances of these types. 3BDS011222R4101 75 Object Types Section 2 Concepts When an instance of an object type is created, the aspects that are defined in the object type are instantiated and associated with it. You can add aspects to a specific instance, or replace inherited aspects with instance specific aspects of the same type, but it is not possible to delete aspects that were inherited from the object type. An object type has rules associated with it. These are either aspect rules that control what aspects can be associated with an instance of that type, or child rules that control what objects can be placed as children under an instance of that type, in a particular structure. Object types can be created as specializations of other types. A specialized object type inherits aspects and other characteristics from the type it is derived from, the supertype. The specialized object type then is a subtype to this supertype. For example, from a generic valve type that has a certain set of aspects, you can create specializations for block valves, control valves, etc., adding aspects and other characteristics that are specific to those types. A simple object type describes one object; each time it is instantiated, precisely one object is created. A composite object type describes a set of objects organized in a structure, with a parent object and one or several child objects. The children in a composite object type are called formal instances, because they inherit from object types defined elsewhere in the Object Type Structure, but they are not actual instances. Only when a composite object is instantiated are actual instances created for these child objects. An Object Type is defined by an Aspect Object in the Object Type Structure. Object types can be collected in Object Type Groups in the Object Type Structure. 76 3BDS011222R4101 Section 2 Concepts Object Types The existing object types initially provided in the Object Type Structure differs depending from the system extensions loaded. The following Figure 4 shows the initial structuring of the 800xA system´s Object Type Structure. Figure 4. Object Type Structure The object types are organized as follows: • 3-rd party OPC server support This group is currently only for generic OPC Support. • ABB System This group is currently only for internal use within ABB. • Control System Here is where the network and controller connectivity objects are found. • Location The proposed place for Location object types. • Plant & Mill The proposed place for Plant&Mill object types. • Plant <system name> System Specific The proposed place for the customer’s business specific object types. • Project <system name> System specific The proposed place for your own, project specific object types. Object Types can be packaged, delivered, and installed as versioned Object Type Libraries. Libraries are based in Library Structure and provide a container for its 3BDS011222R4101 77 Object Types Section 2 Concepts Object Types in Object Type Structure (see Libraries on page 115 and Building Versioned Object Type Libraries on page 328). For more details about Object Types and Composite Object Types see Composite Object Types on page 109, and Building Object Types on page 333. There is also an independent mechanism to group related aspects, Aspect Groups, see Aspect Groups on page 674 in Appendix B, Object Types. 78 3BDS011222R4101 Section 2 Concepts Object Types Creating a New Object Instance The Object Type concept offers a lot of functionality when an aspect object instance is created using the New Object dialog of Figure 5. Figure 5. New Object Dialog Example: Functionality automatically available for a typical process object through inheritance from its object type is: • A Control aspect. • A couple of Graphic Element aspects. • A Close Up display. • A couple of faceplate aspects. • An Alarm and an Event List aspect - providing a list of alarms and list of events for this specific process object only. • A Trend aspect - providing an on-line trending of the signal, or if there is a history log aspect for an object, providing trending of the history data together with an on-line trending. 3BDS011222R4101 79 Basic Structures Section 2 Concepts Basic Structures The Plant Explorer tool of System 800xA allows you to build up and maintain a model for the plant that has to be controlled and supervised. The relations between aspect objects are established by placing them in one of the following predefined basic structures for aspect objects: • Functional Structure • Location Structure • Control Structure • Object Type Structure Placing aspect objects into these predefined structures supports the navigation among engineering data, and the designation of the aspect objects in the plant. You may also use the structures as an end-user of different categories (Operator, Maintenance Engineer,...) for fast navigation to, and location of, certain information. One aspect object can be part of several structures at the same time, see Figure 6. Figure 6. One Aspect Object in Two Structures 80 3BDS011222R4101 Section 2 Concepts Designations Designations Identification of Aspect Objects Each level in the basic structures (represented by Aspect Objects) should be identified unambiguously in accordance to the designation system used by customer. The Plant Explorer supports for this purpose two different concepts: 1. Identification of Aspect Objects by name This is the default mechanism using the Name aspect and is the preferred concept, if the customer uses no reference designations. 2. Identification of Aspect Objects by reference designations This is the preferred concept, if the customer uses reference designations according to IEC 61346. Examples are: – Function reference designation (=), via Functional Designation aspect. – Location reference designation (+), via Location Designation aspect. Reference Designation Name Type Name (Object type) Figure 7. Identification of Aspect Objects At least when building the upper levels of the basic structures only one of those concepts should be used consequently. When adding details during later design 3BDS011222R4101 81 Designations Section 2 Concepts stages, it might be necessary to use combinations of reference designations and names for identification. Principles of Reference Designations The general principles and ideas behind reference designations are described in international standard IEC 61346. Absolute reference designations are built automatically within Plant Explorer by concatenation of relative designation parts according to structure hierarchy. You can configure generation of absolute reference designations for the following structures: • Functional Structure by use of Functional Designation aspect. • Location Structure by use of Location Designation aspect. • Control Structure by use of Control Designation aspect. • Documentation Structure by use of Documentation Designation aspect. Example for function reference designation: • • 82 The relative part of function reference designation is stored per aspect object in a Functional Designation aspect within properties: – Name: relative designation string. – Prefix: prefix used for the relative designation. The absolute function reference designation is concatenated according relative designations and hierarchy: Level 1: = M -> =M Level 2: = D -> =M.D Level 3: = SL1 -> =M.D.SL1 3BDS011222R4101 Section 2 Concepts Structured Plant Modelling Figure 8. Building Absolute Function Reference Designation To make Absolute Reference Designations visible in the Plant Explorer you have to customize your system. Structured Plant Modelling This section uses a collection of example object types called Basic Object Types for explanations. This collection is delivered as an import archive with the install package Engineering Studio, see folder Plant Modeling Example. You can import them to your system to exercise structured plant modelling. Functional Relations Between Aspect Objects The functional relation between aspect objects are presented in a function oriented structure. This structure is built up by placing aspect objects into this structure according to their hierarchical relations. The following example Figure 9 shows a number of aspect objects representing a Storage Tank with its drain system and quantity control. 3BDS011222R4101 83 Structured Plant Modelling Section 2 Concepts Figure 9. Functional Relation of a Storage Tank 84 3BDS011222R4101 Section 2 Concepts Structured Plant Modelling Basic Object Types for Functional Structure According to standards, it is recommended to build the levels within Functional Structure according the following figure. . Figure 10. Hierarchy Levels within Functional Structure Device (Equipment Module, Control Loop, Tag) in this context does not mean just the apparatus. It includes also the related I/O, control and Man Machine Interface (MMI) parts. So a better term might be Device Loop. The alternative terms for Device listed in brackets may be used within projects for chemical industry. 3BDS011222R4101 85 Structured Plant Modelling Section 2 Concepts The Basic Object Types that can be imported to a system include a set of object types, which can be used to build the basic Functional Structure according to that recommendation. The Object Types are organized within the Object Type Structure window according to the proposed levels. Figure 11. Basic Functional Object Types Those object types provide the functionality: • Include sensible icons. • Include Functional Designation aspect. • Propose sensible object types according to level definitions when creating new children objects. If those basic object types are not sufficient it is possible to: 86 • Add own, project specific object types (for example by copy). • Derive own, project specific object types from those by using the Supertype Reference mechanism. 3BDS011222R4101 Section 2 Concepts Structured Plant Modelling Usage of Function Reference Designations Before building the basic Functional Structures it should be clarified, how to identify objects unambiguously by function reference designations. Reference designations identify (in opposite to names) the objects in hierarchical way according to international standards and allow easy navigation within big structures. The function reference designation shall identify objects according to its position within Functional Structure. Levels are optional and can be skipped, if not relevant. Figure 12. Reference Designations within Functional Structure Creation of Objects in Functional Structure To create the top object within a structure: 1. Right-click into the white space of Functional Structure area. 2. Select New Object... from right mouse button menu. 3. Navigate to plant level object types within New Object dialog. 4. Enter name of object to be created. 5. Click Create 3BDS011222R4101 87 Structured Plant Modelling Section 2 Concepts Figure 13. New Object of Type Plant To create objects in subordinated level: 1. Right-click on object, which serves as parent. 2. Select New Object... from right mouse button menu. 3. Select object type from offered list. Object types are normally configured in that way, that only the most sensible object types are offered when creating new objects. Nevertheless in most cases it is possible to select other object types by enabling the Show all check button with New Object dialog. 88 4. Enter name of object to be created. 5. Click Create. 3BDS011222R4101 Section 2 Concepts Structured Plant Modelling Figure 14. New Object of Type Line 6. 3BDS011222R4101 Enter function reference designation: – Select Functional Designation aspect. – Enter value in Name property. – Press Apply. 89 Structured Plant Modelling Section 2 Concepts Figure 15. Enter Functional Designation of Object MilkProduction 7. Continue in that way to complete basic Functional Structure. Figure 16. Completion of Functional Structure A basic Functional Structure as shown in Figure 16 you can easily specify and load into the system using an Excel spreadsheet with the Bulk Data Management tool of 90 3BDS011222R4101 Section 2 Concepts Structured Plant Modelling System 800xA included, see Figure 17. Excel spreadsheets together with Bulk Data Management enable you to save manual object by object instantiation work. Figure 17. Building Basic Functional Structure with Bulk Data Manager 3BDS011222R4101 91 Structured Plant Modelling Section 2 Concepts Relations Between Aspect Objects of the Control System The relations between aspect objects representing the control system are presented in Control Structure. The structure is built up by creating / placing the relevant aspect objects into this structure. The basic structure of the control system is specified and broken down into networks, nodes, buses and stations. Note that as the highest levels also Control System and Plant Network could be introduced additionally. Basic Object Types for Control Structure Figure 18 shows general generic structuring recommendations for Control Structure. Figure 18. General Generic Hierarchy Levels within Control Structure In the concrete case the levels depend on the target control system, by default AC 800M. The AC 800M Connect Object Type Libraries that can be loaded for each system include a set of object types, see Figure 19, which can be used to build Control 92 3BDS011222R4101 Section 2 Concepts Structured Plant Modelling Structure in accordance with the rules imposed by the AC 800M controller configuration with Control Builder M Professional and similar to the recommendation in Figure 18. Figure 19. AC 800M Connect Object Types for Control Structure (Control Builder M) Usage of Control Reference Designations Before building the basic Control Structure it should be clarified, how to identify objects unambiguously in this structure. Reference designations identify (in opposite to names) the objects in hierarchical way according to international standards and allow easy navigation within complex structures. The control reference designation shall identify objects according to its position within the Control Structure. Levels are optional and can be skipped, if not relevant. 3BDS011222R4101 93 Structured Plant Modelling Section 2 Concepts Figure 20. Reference Designations within Control Structure If you work according to the Functional Planning approach or if you only use the signal engineering part of this approach you make use of signal engineering features provided by the AC 800MC Signal Extension system extension / object type group CBM_Signals and the corresponding I/O-Allocation function (both delivered with installation package Engineering Studio). In this case you have to specify the relative control designations in Control Designation aspects on Controller (Node), Hardware Unit (Interface/Board) and Signal (Channel) object level. Control Builder M Professional itself does not need control designations in Control Designation aspects. But it uses designation numbers in the Name aspect and the corresponding path for identification. The Signal objects of AC 800MC Signal Extension and the corresponding I/O-Allocation function take care of the mapping between Control Designation and Name aspect. Creation of Objects in Control Structure Creation of objects in Control Structure can be performed similar as shown for Functional Structure, taking care of the corresponding object types and filling in the Control Designation aspect. 94 3BDS011222R4101 Section 2 Concepts Structured Plant Modelling The Basic Object Types that can be imported to a system only include object types representing Control System and Plant Network, which are the (optional) levels above the levels shown in Figure 21. The levels of Figure 21 are covered by object types loaded with the AC 800M Connect system extension, see Figure 19. The hierarchy below and including Control Network in Control Structure is pre-defined by AC 800M Connect and Control Builder M Professional. Figure 21. Basic Control Structure Defined by AC 800M Connect 3BDS011222R4101 95 Structured Plant Modelling Section 2 Concepts Relations Between Functional Structure and Control Structure A proposal how to build up Functional Structure in the context of a 800xA system with AC 800M connectivity is shown in Figure 22. How it maps to Control Structure is shown in Figure 23 In Functional Structure you see • Relation within a function • Relation between functions • Relation between Control Module/Function Block and Hardware IO • Relations between Control Objects and other Aspect Objects having Graphic Displays • Relation between Control Module/Function Block and Variables (Only when using Function Designer) In Control Structure you see: 96 • Relations within an Application • Structuring of the program code • Controller hardware structuring 3BDS011222R4101 Section 2 Concepts Structured Plant Modelling Figure 22. Proposed Levels of Functional Structure Figure 23. Functional Structure Mapped to Control Structure 3BDS011222R4101 97 Structured Plant Modelling Section 2 Concepts Locational Relations Between Aspect Objects Locational relations between aspect objects are presented in a location oriented structure. Distinguish between topographic locations like: • Areas • Buildings • Rooms And mounting locations like: • Cabinets • Desks • Racks • Slots The topographic location structure and the mounting location structure can be created independently from each other and connected in a later stage. The connection is performed by placing mounting location structure trees into the topographic location structure. The mounting location structure contains a number of aspect object structure trees that represent, for example, the cabinets, desks and other units of the plant. Figure 24 shows the principles of a location oriented structure. 98 3BDS011222R4101 Section 2 Concepts Structured Plant Modelling AREA Area BUILDING Building FLOOR Floor Room Topographic location structure ROOM Mounting location structure CUNIT Constructional unit CABINET Cabinet RACK BOARD BOARD Rack BOARD Device BAR CABINET RACK Cabinet Figure 24. Principle of a Location Oriented Structure The basic Location Structure in this context includes at least the topographic locations like buildings, floors, rooms,…. It should be detailed down to the level that is necessary for clarification in the current stage of project work. 3BDS011222R4101 99 Structured Plant Modelling Section 2 Concepts If available, topographic layout diagrams and descriptions are added to the objects. Basic Object Types for Location Structure The following figure shows the topographic location levels proposed to be used. Figure 25. Hierarchy Levels within Location Structure 100 3BDS011222R4101 Section 2 Concepts Structured Plant Modelling The Basic Object Types that can be imported to a system include a set of object types, which can be used to build the basic Location Structure according to that recommendation. For easy understanding and navigation those Object Types are also organized within the Object Type Structure window according to those levels. Figure 26. Basic Location Object Types Those object types provide the functionality: • Include sensible icons. • Include Location Designation aspect. • Propose sensible object types according to level definitions when creating new children objects. If those basic object types are not sufficient it is possible to: • Add own, project specific object types (for example by copy). • Derive own, project specific object types from those by using the Supertype Reference mechanism. 3BDS011222R4101 101 Structured Plant Modelling Section 2 Concepts Usage of Location Reference Designations Before building the basic location structures it should be clarified, how to identify objects unambiguously by location reference designations. Reference designations identify (in opposite to names) the objects in hierarchical way according to international standards and allow easy navigation within big structures. The location reference designation shall identify objects according to its position within Location Structure. Levels defined within the location reference designation are optional and can be skipped, if not relevant. Figure 27. Reference Designations within Location Structure 102 3BDS011222R4101 Section 2 Concepts Structured Plant Modelling Creation of Objects in Location Structure Creation of objects in Location Structure can be performed similar as shown for Functional Structure, taking care of the corresponding object types and filling in the Location Designation aspect. Figure 28. Completion of Location Structure 3BDS011222R4101 103 Structured Plant Modelling Section 2 Concepts Relations Between Aspect Objects for Documentation The documentation of the project is modeled by folder/binder and sub folder/grip/package objects and document objects in Documentation Structure. Each level is identified by an absolute documentation reference designation and/or object name. The document objects either are Aspect Objects containing one or more aspects holding documents or are placed Aspect Objects from other structures holding also one or more aspects holding documents. Basic Object Types for Documentation Structure The following figure shows the documentation structure levels proposed to be used. Figure 29. Hierarchy Levels within Documentation Structure The Basic Object Types that can be imported to a system include a set of object types, which can be used to build the basic Documentation Structure according to those recommended levels. For easy understanding and navigation those Object Types are also organized within the Object Type Structure window according to those levels. 104 3BDS011222R4101 Section 2 Concepts Structured Plant Modelling Figure 30. Basic Documentation Object Types Those object types provide the functionality: • Include sensible icons • Include Documentation Designation aspect • Propose sensible object types according to level definitions when creating new children objects. If those basic object types are not sufficient it is possible to: • Add own, project specific object types (for example by copy). • Derive own, project specific object types from those by using the Supertype Reference mechanism. In addition to those simple object types also some predefined document folder object types according to ABB internal standard definitions are provided as composite object types. 3BDS011222R4101 105 Structured Plant Modelling Section 2 Concepts Figure 31. Composite Folders Object Types Those are ready made folders including: 106 • Folder names and reference designations. • Package definitions including package names and reference designations. • Binder definitions including binder names and reference designations. 3BDS011222R4101 Section 2 Concepts Structured Plant Modelling Usage of Documentation Reference Designations Before building the basic documentation structures it should be clarified, how to identify objects unambiguously by Documentation reference designations.The documentation reference designation shall identify objects according to its position within Documentation Structure. Figure 32. Reference Designations within Documentation Structure Creation of Objects in Documentation Structure Creation of objects in Documentation Structure can be performed similar as shown for Functional Structure, taking care of the corresponding object types and filling in the Documentation Designation aspect. To get ready made folders according to a typical definition you should choose the object types: – Project Administration Folder – Design Information Folder – Design Documents Folder – Document Sets Folder In this way the basic documentation structure can be created in an efficient way. 3BDS011222R4101 107 Structured Plant Modelling Section 2 Concepts Figure 33. Completion of Documentation Structure User Defined Structures It is possible that you define own structures to map your special project requirements to the system, see IndustrialIT 800xA - Engineering, Engineering Workplace, Basic Engineering Functions. Structures for Administration The structures described so far are used in engineering and operation of a plant. There are also structures mainly used for administration and other activities. In Appendix A, Object Structures you find a brief description of all structures in the system. 108 3BDS011222R4101 Section 2 Concepts Composite Object Types Composite Object Types Composite Object Types are used to define typical solutions that decrease the engineering effort. This section outlines the principles how to build and use composite object types. The reasons for building composite object types are: • The engineering time is decreased due to field proven solution. A composite object type that is tested and verified does not need the same amount of testing when it is reused. • By using composite object types, you are able to break down your system into blocks. This makes it easier to build and maintain the structures. A Composite Object Type describes a set of aspect objects organized in a structure, with a parent object and one or several child objects. The children in a composite object type are called formal instances, because they inherit from object types defined elsewhere in the Object Type Structure, but they are not actual instances. When a composite object is instantiated, actual instances are created for these child objects. A composite object type also includes a description of how its child objects shall be inserted into different structures when the composite object is instantiated. The instantiation is described separately for each structure using a formal instance list. Below the formal instance list the wanted object hierarchy for a certain structure is specified. 3BDS011222R4101 109 Composite Object Types Section 2 Concepts Same object inserted at two places Formal instances Figure 34. A Composite Object Type When you instantiate a composite object type you get a composite object instance. The composite instance is one single unit, although it can include several child objects spread out in different structures. The sub-objects that belong to the composite instance are called embedded instances. Instances that are not controlled by a surrounding composite instance are called independent instances. Figure 35. Independent and Embedded instances Adding Additional aspects To make the Composite Object type really useful you should do as much aspect configuration as possible on the object type. For example, you may want to add a Graphic Element aspect on the main type object that either presents data retrieved from its child objects or incorporates subordinate Graphic Elements that already exist on the child objects. To be able to reference the child objects correctly in all composite instances, we use relative references. All formal instances have Relative Name aspects that are 110 3BDS011222R4101 Section 2 Concepts Composite Object Types inherited to all corresponding actual child objects. The actual instances also have a local Name aspect that initially gets the same value, but the user can change it to an instance-specific name. Using the inherited and fixed relative names, a child object can still be identified using a relative name path consisting of a series of relative names. For example Graphics Builder automatically inserts such relative references when you create a Graphics aspect on an object type. Its object list in the Expression Builder and Element Browser dialogs shows the available formal instances as shown in Figure 36. Figure 36. Element Browser Other aspects often created on composite object types are the Faceplate aspect, the Alarm List aspect, and the Trend aspect. Aspect Propagation The Type Definition aspect of the main type object, controls the aspects on the top instance. This works in the same way for both simple and composite types. Aspects on the main type object are copied to the instance objects if Copy when object is created is specified on the Aspect Control tab. This kind of aspect propagation is default for aspects on the formal instance objects. Formal instances do not have an Aspect Control tab where the behavior of each individual aspect is configured. Instead the formal instance object acts as a template that defines what aspects should exist on the corresponding instantiated child object, and also the initial values of these aspects. 3BDS011222R4101 111 Composite Object Types Section 2 Concepts This relation is dynamic for these child objects. If you add, change, or delete aspects on the formal instance, then all these changes are propagated to the already created instances. This propagation is active until the aspect on an actual instance is locally modified. If you do local changes on an aspect, that aspect will no longer be affected by changes in the formal instance because it is only the initial value that is propagated. If the formal instance itself is an instance of an object type, the object type defines its set of aspects. These aspects can then be modified on the formal instance, and new aspects can be added. When you create aspects on a formal instance, they are not enabled for inheritance (unless they already are inherited). This is different from aspects on the top-level type, for which Plant Explorer automatically enables inheritance when such aspects are created. So the default mode for formal instances is that all non-inherited aspects should be copied to the actual instances as described above. If you want to inherit an aspect to the actual instances, you can enable inheritance by right-clicking the aspect and selecting the Properties dialog. The inheritance mode can then be controlled on its Aspect Details tab. Allowed Operations on Composite Instances Instances of the composite type must follow the structure defined by the type, and instances must be created and deleted as a whole unit. For example, it is not possible to instantiate only a part of a composite type, or to delete a sub-object from an instance of a composite type. Though it is allowed to add additional sub-objects to an actual instance, without defining corresponding formal instances in the type. The type only defines a minimum structure for the instance, not the complete structure. The minimum structure can be extended in each instance, but not reduced. 112 3BDS011222R4101 Section 2 Concepts Composite Object Types Details about the Formal Instance List What is the difference between the object types A and B in the example below? Figure 37. Formal Instance List Type A is a simple non-composite object type. If an instance of A is created in a structure, for example Functional Structure, it will only be placed in that structure. The type B on the other hand is a composite object type, although it has no child objects. If an instance of B is created in Functional Structure, nothing special would happen. On the other hand, if you create an instance of B in e.g. Location Structure, the instance will also be inserted in Functional Structure. This is because the composite object type requires that the instance always is present in that structure. When objects are inserted into other structures due to formal instance lists, they are always inserted at the top of those structures. They can then be moved to the wanted place. The composite object type is a general mechanism that can be used to create quite complex objects in many levels. One composite object type may use other composite object types, which in turn use other composite object types, and so on. At each step, the formal instances can be extended with local aspects, and extra child objects may be added. However, if you build and use composite object types based on object types of an connectivity package, for example for AC 800M, there may be restrictions. Refer to the documentation for your connectivity install package for more information. For configuration steps for composite object types see Building Object Types on page 333, for examples see Examples of Object Types on page 350. Examples in the latter subsection show composite object types to be used with Control Builder M Professional and Function Designer. 3BDS011222R4101 113 Typical Solutions Section 2 Concepts Typical Solutions Defining and re-using typical solutions is a suitable method to decrease the engineering effort. You can build and re-use a typical solution as a Composite Object Type as described in Composite Object Types on page 109. Or you can build it outside the Object Type Structure for example in Functional Structure as a composite object instance. The object instances in such a (typical) solution can be derived from object types and / or composite object types and / or from the generic object type. When ever possible build your typical solutions as composite object types in the Object Type Structure and include them into a version handled library (see Libraries on page 115). Using version handled object type libraries results in better application quality, less validation costs, and the possibility to reuse well proven object types/ composite object types in other projects. You can easily re-use a typical solution built either as composite object type or as composite object instance using the spreadsheet based configuration functions of Bulk Data Manager to populate your plant model in the system. Composite object types you can instantiate and parameterize several times via a Bulk Data Management worksheet, composite object instances you can copy and parameterize several times via a Bulk Data Management worksheet. Reuse Instructions Often the task is given to manage, design and use typical solutions with variants. The system extension Reuse Assistant of the 800xA system supports you in performing this task. The Reuse Assistant Architect Mode enables you to design Reuse Instructions in the Reuse Design Structure. For such an instruction you define substitution variables and a tree-like structure of questions with a set of possible answers and operations to be performed for each answer. After you have finished design you generate the Reuse Instruction into a corresponding Reuse Instruction aspect of an object type in the Object Type Structure. After you have instantiated the object type you use the Reuse Assistant Build Mode on the ReuseAssistantBuilder aspect to apply the instruction stored in the Reuse 114 3BDS011222R4101 Section 2 Concepts Libraries Instruction aspect to the instance. In a wizard-like view you are asked to answer the questions and enter the values for the substitution variables. Once this is completed you can create the solution by executing the Reuse Instruction. Depending on the answers given and the operations defined, objects get created or modified accordingly. Typically a composite object instance results. With one Reuse Instruction you can for example generate several variants of a highly standardized Control Builder M Professional Program or Single Control Module. Values for substitution variables of Reuse Instructions can be set using Bulk Data Management worksheets. For configuration steps see Building Reuse Instructions on page 365, for more details the IndustrialIT 800xA - Engineering, Engineering Workplace, Basic Engineering Functions manual. Libraries System 800xA supports development, distribution and management of versioned libraries. Libraries are collections of object types and composite object types. In libraries you can accumulate your solution knowledge developing over time and make maximum profit from it. Versioning of object type libraries gives the possibility to distribute, manage and track object types changes in a standardized, traceable way. A library belongs to an aspect system or to a group of aspect systems (a product package) or is a application specific library (specific for example for a business unit, a customer, or an application area). The libraries loaded into the system with their object types and additional aspects can be used for application engineering. A library consists of new object types. These are created in the Object Type Structure. (For more information on building object types see Building Object Types on page 333.) Each library has a Library object with a Library Definition aspect in the Library Structure.This object is an instance of the Library object type. A Library Version object with a Library Version Definition aspect defines a version for a library underneath a Library definition object in the Library Structure. This object is an instance of the Library Version object type. 3BDS011222R4101 115 Libraries Section 2 Concepts The Library Version object is also used as the root object for the object types of the library in the Object Type Structure. This means that all object types of a Library Version are created or moved underneath this object in the Object Type Structure. A new Library Version requires a new Library Version object. The Library Member aspect represents object type's membership in the certain Library. This aspect is placed on every item, which belong to the Library. A Library Member keeps information about the current library and the history of the member inside of the library (e.g. creation date/time, who and when has added the new aspects to the library). Basic configuration steps for versioned libraries you find in Libraries on page 328. It is possible to package a Library as a System Extension installation kit using Aspect Express, see IndustrialIT 800xA - Engineering, Aspect Express. Library Management A library introduces object types from which applications can be built. A library has its own version and is, when used by end users, normally released. A released library cannot be changed and the system safe-keeps the integrity of a library above security settings and similar protection mechanisms. Note that this means that if a library is released, then no aspect defined in that library can be changed. Libraries are distribution units that support version handling and controlled upgrades, i.e. changing an application from using one version of a library to another. Libraries also supports edit history and various properties that describes the library and how it can be used (owner, supporting organization etc.). Libraries encapsulate solutions in forms of object types / composite object types and aspect groups. A library contains object types and their aspects, which are necessary to run the product that the library is designed for. AC 800M connectivity of System 800xA comes with a set of libraries which are the initial libraries for AC 800M application development, see Figure 38. 116 3BDS011222R4101 Section 2 Concepts Libraries Figure 38. Libraries for AC 800M Operations on a Library The main operations that you can perform on a library as a library developer are: • Create a library • Close a library • Open a library for editing • Release a library • Export a library • Add, delete and edit object types and other items that belong to the library. 3BDS011222R4101 117 Libraries Section 2 Concepts A released library cannot be changed and it is therefore required that a new version of the library is created to make changes to the library. The main operations that you can perform on a library as an end user are: • Install the library • Remove a library • Create and use the instances based on the library object types • Upgrade/downgrade the chosen instances to the certain version of a library • Explore the library contents. Search for library items and their instances using the different criteria (e.g. library version, key, aspect category) • Read the documentation, history and release notes for the certain object types of the library or for the whole library. Library Aspect Categories The library categories user interfaces are all tabbed pages. The table below lists the tab each category displays and the information contained in the pages. Table 3. Tabs of the Library Categories Category Tab Description Library Definition Identification An identification page showing the name and description of a library Library Version General Basic information concerning a library. Owner information, version information and the state of a library History Shows history data for a library Dependencies Dependency information for a library. Upgrade Upgrade and downgrade functionality for a library 118 3BDS011222R4101 Section 2 Concepts Libraries Table 3. Tabs of the Library Categories Category Library Member Tab Description Assignment Assignment / de-assignment of aspects to the library General Shows information of the library, which the object type belongs to and the history information. Libraries as Distributable Units A library in any state (see Library States) can be exported and distributed as an *.afw file, see Exporting a Library on page 124. When this *.afw file is loaded into a system then it is represented by an instance of the Library and Library Version type. Libraries can have dependencies to other libraries or applications (other system extensions). Libraries can also contain aspect groups which are entities similar to object types in terms of allowing aspects to be shared with instances but aspect groups does not type an object as an object type do. Library States A Library Version has a state. This state is used to describe how a library (version) can be used. The states a library can be in are: Open, closed or released. In the open state the contents of the Library Version may be edited. When editing temporarily is completed, the library can be closed. Or if the library is ready for release it can be released. When a Library is closed then it cannot be edited but it can be reopened to allow additional edits. 3BDS011222R4101 119 Libraries Section 2 Concepts When a Library Version has been released then it can no longer be changed. If any modifications are necessary then a new version of the library must be created. Note that a library cannot be released unless all libraries it depends on are released. Figure 39. The Library Version State Diagram During Development Figure 39 above illustrates the states through which a library will evolve. The library can go through a number of edit/close transitions for editing but after a library has been released it cannot be changed unless a new version is created. When editing of a library is temporarily completed then the library is set as closed. It is possible to have more than one library open at the same time. A closed library can further be frozen by releasing it. Library States on the End User Side Regardless of the other Library Version's presence, a library is activated immediately after it is loaded into a system. Every Library in a system is active. We have unique identifiers for the different versions of members of the library. If the object type, existing in the old version of the library, disappears in the newer version, a corresponding message is given. Instances of this object type can't be upgraded and keep the assignment to existing version of the object type. The object types of the previous and the new versions coexist in the Object Type Structure. The chosen instances of the library members can be upgraded to the new library's version. 120 3BDS011222R4101 Section 2 Concepts Libraries The upgrade process changes the old object type of the instances to the new one. The downgrade functionality is available as well. Tracking Library Components For each library that is created, an aspect key of category Library Key is created. This key identifies all aspects that belong to the library. The key has the name of the library and the key is placed on the Library Definition aspect as well as on all other aspect of the library. The Library key is important when creating aspects on an object type or aspect group as setting this key allocates the new aspect to the specified library. When a new aspect is created for an object type or aspect group then the New Aspect dialog asks the user to select one of the open libraries as the owner of the aspect. The default is that the aspect is part of the library if it is open. Creating a Library A library is defined by its Library definition object and is therefore created by creating an instance of the Library object type. The library must be created in the Library Structure. Underneath the Library definition object a Library Version object has to be created for each version of a library. If you create a Library object the first Library Version object is created automatically beneath the Library object in Library Structure and inserted beneath a parent object you have to select in Object Type Structure. The Library Version object in the Object Type Structure defines the root for the object types of a library. When a library is created it is set as Open allowing modifications of the types in the library. This means that a Library developer can start to create and edit types in the library directly (in the Object Type Structure). For more information on building object types see Building Object Types on page 333. A library can initially be created in Plant Explorer or in Control Builder M Professional. If you use Control Builder M Professional a Library aspect is created automatically in the Library Version object. This aspect makes a library known to Control Builder 3BDS011222R4101 121 Libraries Section 2 Concepts M Professional. Further the required sub-structure objects for a control library are created automatically beneath the Library Version object. If you use Plant Explorer you have to add manually the (Control) Library aspect in the Library version object and the sub-structure objects beneath the Library version object. Adding Objects and Aspects to a Library An object type must be created below the Library object in the Object Type Structure for that type to belong to a library. The object type then naturally belongs to the library under which it was placed. Object types can, as long as the libraries involved are open, be deleted or moved between libraries freely. For more information on building object types see Building Object Types on page 333. When an aspect is created onto an object type or aspect group then the New Aspect dialog contains a selector to assign the new aspect to a library. The selector only allows no Library or the current open Library to be selected. Aspects can be added to an object type in a released library. These aspects remain project specific without an assignment to a library, see Extending a Library on page 125. Aspects can be moved or assigned to a library by using the Aspect property dialog and removing/adding the corresponding library key. Releasing a Library Use the General tab in the Config View of the Library Version Definition aspect to release a library. A released library cannot be modified and the Aspect Directory rejects any modification to aspects that belong to released library. It is only possible for the user to expand an object type with released aspects by creating additional aspects, see Extending a Library on page 125. 122 3BDS011222R4101 Section 2 Concepts Libraries Creating a new Version The context menu in Plant Explorer offers the possibility to create a new version of the library. Using the New Object dialog on the Library object does this (see Figure 40 below). This operation creates a new Library Version object with its new id. Figure 40. Creating a new Library Version If the initial Library Version object contains a Library aspect the new version of this library is also introduced in Control Builder M Professional. The Library Member aspects on the library's object types contain all change information about the object type and the existing aspects. When creating a new version of a Library, all members of an object type belonging to that library are copied to the new version. Aspects added to the object type but not added into the library are not copied either. This means that the new Library Version contain only copies of the aspects, which were assigned to the previous version. The new object types get the assignment to the new Library Version (Library Key) and keep a track record of its predecessors (corresponding object types in the previous version). 3BDS011222R4101 123 Libraries Section 2 Concepts Exporting a Library When a library is ready to be shipped (or backed up) you can export it using the Library Archive button on the General tab of the Library Version Definition aspect. The Import/Export tool also directly can be used to cover this functionality. Activating a Library Regardless of the other library version's presence, a library is activated immediately after it is loaded into a system. Every library in a system is active. There are different GUIDs for an object type object in different versions of the library but the aspects keep the same GUIDs. If the object type, existing in the old version of the library, disappears in the newer version, a corresponding message is generated. Instances of this object type cannot be upgraded and they keep the assignment to the current version of the object type. Upgrade of Instances The object types of the previous and the new versions coexist in the Object Type Structure. The customer has a possibility to carry out an upgrade of the chosen instances of the previous Library Version to the new one. The Upgrade tab of the Config View of Library Version Definition aspects offer mechanisms to perform an Upgrade/Downgrade. The Upgrade function changes the old object type of the instances to the new one. The Downgrade function changes the new object type of the instances to the old one. That means that the older version of the library can be activated. Upgrade/Downgrade in Control Builder M Professional is done based on the library version connected last to an application. Deleting a Library A Library Version object can only be deleted if the object types, belonging to the library, do not have any instances. Otherwise the delete is rejected. On delete of the Library Version, its contents are deleted from the Object Type Structure. The Library Version object is deleted from the Library and the Object Type Structure. 124 3BDS011222R4101 Section 2 Concepts Import/Export Extending a Library If you want to extend object types of a released library with additional functionality (e.g. faceplates) you can • either add aspects to be inherited or to be auto-instantiated and not inherited • or you can create a new Library Version and add the aspects to the object types of this Library Version with the full scope of instantiation behavior settings in the Object Type Definition aspect. Note that the first method does not result in aspects belonging to the library but only belonging to the object type of the library in your system. Library Assistant The tabs General, History, Dependencies, Assignment on a Library Version Definition aspect are the user interface of Library Assistant. Close and release operations of Libraries are tied to a special Library Assistant license. Users without the license can create one version of a library but they neither can close it nor can protect it against change and they can not create versions of a library. Import/Export During engineering of a project you often need to transfer your engineering work or parts of it to another engineering system (for example from an off-site engineering system to an on-site engineering system, see Distributed Engineering on page 142) or to a production or test system. Or you need to save limited project specific application data before introducing changes or before executing an upgrade of a software component or of object types. These engineering tasks are supported by the Import/Export tool. The Import/Export tool allows you to import and export data to and from any 800xA system. The data is saved as objects and aspects in archive files, structured files with file extension .afw. The tool allows you to store and restore objects and aspects. It is also possible to view the contents of an archive file, detect and show differences between two archives and between an archive and the system, and to create reports 3BDS011222R4101 125 Import/Export Section 2 Concepts on the contents of the archive file. The user interface of the Import/Export tool is similar to the user interface of the Plant Explorer. The Import/Export tool should be used to transfer small applications in the form of object types and/or object instances between configurations. For backup and restore actions, use the Backup/Restore tool described in IndustrialIT 800xA - Operations, Operator Workplace, Configuration should be used. Do not export or import very large amounts of aspect objects at one and the same time. It is very time consuming and the Import/Export tool loads the system significantly. An upper limit of about 5000 aspect objects or one Controller Node (from Control Structure) at a time is recommended. Exporting objects and aspects are done by drag and drop from the Plant Explorer. There are some restrictions regarding dragging afw-files into the Plant Explorer structure window. As default, it is not allowed to import by drag and drop. The Import/Export tool gives you a powerful instrument for storage and distribution of objects and aspects. Import and GUIDs To understand the behavior of the Import/Export tool during import the concept of GUID (Global Unique IDentifier) is crucial to understand. The unique identifier of Aspect Objects and its Aspects within the 800xA system is the GUID and not a name or a path. The GUID is, as the name says a globally unique ID. It is impossible that just by chance two Aspects or Aspect Objects in an 800xA system, have the same GUID. Some important facts about GUID with 800xA systems: 126 • When one Aspect Object references another one it is done by the GUID. • Therefore when two Aspect Objects with a reference among them shall be exported and imported the reference does only work in the destination System when the GUID of the referenced Aspect Object/Aspect did not change. • When the same GUID is already existing in the Import-System, the Import/Export tool recognizes this and asks the user weather the Aspect Object should be overwritten or not. This is independent from the fact if the two Aspect Objects look the same. 3BDS011222R4101 Section 2 Concepts Import/Export • With Import/Export of Aspect Objects the GUID (of the Aspect Object and all its Aspects) stays the same, according to Table 4 below. • When import methods are chosen that keep the original GUID the same a procedure like Import/Export procedure from systemA -> B ->A realizes that this Aspect Object already exists (even though the location might be different). • During import of single Aspects (without its Aspect Object) the GUIDs of Aspect might stay the same (according to Table 4), the GUID of the new Aspect Object however is new. • Import via drag and drop creates a copy (different GUID) of the Aspect Object. It is the same functionality as Copy&Paste and therefore does not need to test existence of identical Aspect Objects, as the Import/Import All method does. Table 4. Resulting GUIDs with different import methods Aspect Object Method of import (Aspect)Object single Aspect Aspect at Object Import at existing location in destination system (same Aspect Object-path or same Aspect Object) original GUID original GUID original GUID Manual placing at new location in destination System (new Aspect Object-path or new Aspect Object) original GUID original GUID new GUID Drag and drop (= same as copy and paste!) new GUID new GUID new GUID Comments to Table 4 about GUID within in a 800xA system: • 3BDS011222R4101 The import at an existing path/Aspect Object is recommended. 127 Import/Export Section 2 Concepts • Be aware of the different behavior of Aspect Object and Aspect in the second line. • The drag and drop method is not recommended and is by default disabled. Upgrading Files The Import/Export tool supports old file formats through a conversion scheme that uses the old model to perform the actual load. This allows you to import afw-files of previous system versions. Filter Exports The Find Tool of Plant Explorer can be used to make filtered exports based on creation dates, creation user. This allows you to filter the most recent changes or certain aspect categories or certain objects of your engineering work and to export them for saving or transferring them. Differences With the differences function you can check the contents regarding Aspect Objects and Aspects of an archive against the contents of another archive or the contents of the system to decide which has the contents you want to work on. Or, if you like to import only the new parts you can detect these in the archive and then import only these parts. Dependencies The Import/Export function is dependency aware. This behavior you can switch on or off. Dependency aware export means that dependencies are brought in automatically and exported to the same file as the dependant aspect. If an aspect depends on another aspect or object that is part of a system extension a note is made in the file, but the system extension is not exported. To view dependencies for an aspect, select the aspect and click the Dependencies button in the tool bar. The aspect list view is replaced by a dependency tree view. 128 3BDS011222R4101 Section 2 Concepts Import/Export The imported file might be dependent on a specific version of System 800xA, a System Extension or a Library. In this case, it is necessary to resolve the dependencies by installing them - before continuing the import. 3BDS011222R4101 129 Import/Export Section 2 Concepts Further the following weak dependencies are not taken care in Export: • Windows Application and Web Page aspects can reference files. You have to take care of referenced files yourself: Store a copy of these files with the archive file set and describe where to store and how to install them in the import system so that the corresponding imported aspects can find them. • ActiveX Wrapper aspects reference the GUID of an installed and registered ActiveX control. You have to take care of transferring the ActiveX control, installing and registering it in the import system yourself. • MS Excel or MS Word files of Document Manager and of File Viewer aspects can require macros. You also have to take care of them yourself. • Property references (as supported by Document Manager, Function Designer, Topology Designer and Control Builder M Professional) specify dependencies which are not exported. You have to export/import the corresponding objects additionally if not already covered. All other dependencies are fulfilled automatically by importing the archive file. This allows you to export and import complete applications, for example a control application as configured with Control Builder M Professional including control aspects and user defined libraries and insertions of the objects into other structures than Control Structure, using one file. If you switch off the dependencies during export you have to take care of the dependencies yourself as it was necessary in previous versions of the Import /Export tool. A notification of missing dependencies is shown at load-time (if a system is running) as well as when trying to import. Resolving Errors While importing, there might be situation where you have to make a decision for the import to be able to continue. One common situation is that the father of the object that's being imported, does not exist in the system. You need to resolve this by defining which object should become father object. Another example is if you have imported an aspect that already exists. You need to resolve this by choosing whether to replace that aspect or skip it and continue with 130 3BDS011222R4101 Section 2 Concepts Import/Export the rest of the import. It is possible to let the tool make the same decision every time a similar incident occurs. Audit Trail The Import/Export components support Audit Trail. It means that all major operations performed by these components are published in the Audit Trail log. Information about when the operation occurred and which user performed it is also visible here. Recommendations for Archive Files Archives are afw-files that you can store somewhere in a directory on a disk of your computer or on a disk in the network. As with all files it is recommended to follow certain rules that make retrieval and reuse of the files easier. You should chose a filename that make it easy to understand the purpose of the file and, if the file is only one of a set of files, you should take care of the import order already in the file name. Enter short additional information about the contents and use of each file in the archive file properties description field. Write a documentation file that describes the purpose of the file set, the prerequisites for importing it and how to import it. Store the documentation file with the archive file set. You always should remember that importing the contents of a file set in the wrong way can seriously disturb or even destroy the work of the users of your archive file set. If you change one or more files make sure that the whole set of files is consistent including the documentation. The full functionality and use of the Import/Export tool is described in the IndustrialIT 800xA - Operations, Operator Workplace, Configuration manual. 3BDS011222R4101 131 Configuration Using Spread Sheets Section 2 Concepts Configuration Using Spread Sheets Engineering data describing an automated plant under design and configuration often is collected in Microsoft Excel spreadsheets. These informations define the design of the plant. It is most favorable to use these bulk engineering data directly to create and parameterize all the needed objects forming the plant model in Plant Explorer as there can be needed hundreds or thousands of objects. To create and parameterize these objects manually in Plant Explorer object by object would consume too much time and is error-prone. This basic requirement and many more requirements regarding the efficient handling of bulk engineering data are supported by the Bulk Data Management functionality included in System 800xA. Bulk Data Management bases on Microsoft® Excel, a set of Excel Add-Ins that integrate Microsoft Excel into a 800xA system and set of predefined templates and applications. Bulk Data Manager connects the full productivity benefits of Microsoft Excel worksheets to System 800xA configuration activities. Connections to relational databases can be implemented using the corresponding external data source functionality of Excel. The possibility to re-import lists of objects and aspects and to track changes in Bulk Data Manager supports an iterative analysis and design process. When different persons or group of persons (customers, external contractors) are involved in the engineering process Bulk Data Manager supports you to organize a controlled design data list exchange. The basic functionality of Bulk Data Management allows you to configure a worksheet for reading out and writing back the properties of aspects of objects. You configure the worksheet by dropping in the aspects from Plant Explorer and selecting the aspect properties of your interest. The data contents of this worksheet you can acquire by dropping in the objects of interest from Plant Explorer. Each row holds the data for one object. The properties of the corresponding aspects of the dropped in objects are shown in the configured columns. This worksheet also allows you to create new objects from object types or from already existing object instances and to create the placement of the objects in structures. An example is already shown in section Creation of Objects in Functional Structure on page 87, Figure 17. 132 3BDS011222R4101 Section 2 Concepts Configuration Using Spread Sheets To duplicate a substructure of objects you just copy the area of rows corresponding to the objects of your interest in the worksheet using well-known Excel functionality, you edit the names of the new objects and the data of other properties and save the changed spreadsheet contents to the system by executing a Save All Objects command. Once you have configured a worksheet you can use it for off-line editing or for importing and mapping engineering data from other sources (see List Based Data Exchange on page 142) without having attached it to the system. After finishing offline work you can re-attach the worksheet to the system and work on-line again. Typical examples for worksheets that are edited off-line (for example by a contractor) and then used on-line to create and/or parameterize objects are Signal Object Lists, Process Object Lists, I/O-Board Lists. You can choose to include a Bulk Data Management worksheet into an object as a Document aspect. Then the worksheet is automatically attached to the system when you open the worksheet. Data Area In a worksheet you can configure either one Default Data Area (this we assumed in the short description above) or several Auto-Update Data Areas. Each data area has a configuration headline that defines which properties of which aspect category are to be handled in the data area. You can configure the headline by dragging and dropping in aspects of the categories of interest from Plant Explorer to the worksheet. During drop of an aspect you select also the properties of interest, the properties that then define the columns in the configuration headline. Data of a Default Data Area is loaded by drag and drop of objects of the attached system from Plant Explorer. Data of a Auto-Update Data Area is loaded automatically from the attached system when opening the worksheet or if you execute an Update command on the whole worksheet or the selected data area. An Auto-Update Area is especially useful if you want to monitor changes or do changes in the system repeatedly. 3BDS011222R4101 133 Configuration Using Spread Sheets Section 2 Concepts Object Identification Bulk Data Management can identify objects and their locations in structures by names, paths, Absolute Reference Designations or object ids (GUIDs). You have to choose a corresponding option to define the identification method fitting for your case. For saving data the objects must be identified unambiguously. Filter For every data area you can configure a filter criterion that is executed during the loading of data. You can for example filter for all objects in Functional Structure having the object type MotorUniM and a certain value of a property of the Control Properties aspect. Track Changes The Track Changes function allows you to compare two Data Areas in order to identify changes. Those changes can be modified property values, created and deleted objects. The Data Areas needed to track changes can be located in different workbooks or in the same workbook but on different worksheets. This function helps you to check for changes and introduce changes to your system in a controlled way if you exchange your worksheet with other engineers, for example with a contractor. Property References Additionally to configuring Data Areas to read / write object (aspect) properties Bulk Data Management supports insertion of property references into cells of your worksheet. A Property Reference is a dynamic link to a property of an aspect of any object. It allows to access the data provided by the property it is pointing to. Property references are a means to configure a view on different properties of different aspects (of different aspect systems) for data access. In general a Property Reference is specified by a character string with a defined syntax describing the path to locate the property. As this string can be complex a dialog to all engineering tools supporting property references is provided that allows to specify the path by navigating through the structures, objects, aspects and aspect properties. 134 3BDS011222R4101 Section 2 Concepts Configuration Using Spread Sheets In Bulk Data Management this dialog is provided by context menu on a cell: Property Reference >Insert...>Create Property Reference. Figure 41. Create Property Reference A Property Reference is automatically updated when the workbook is opened, this means the property value is read into the workbook cell carrying the reference. When a workbook cell carrying a Property Reference is changed, the modification is written back to the source aspect property where the reference points to. Two kinds of Property References exist: Absolute References and Relative References. Absolute References are independent of the context or the object to which the workbook was attached as Document Aspect. They point to the same object when the object the Workbook is related to is copied. 3BDS011222R4101 135 Configuration Using Spread Sheets Section 2 Concepts Relative References point to properties of aspects of objects relative to the Start Object, i.e. they access the Start Object or child/parent objects of the Start Object. Using Relative References has the advantage of making a template independent of an object. Property References can be configured to subscribe for live data. This means the value retrieved by the Property Reference updates itself automatically whenever it changes at the source. Subscription allows you, for example, to create animated bar graphs in your worksheet. Structured Properties Structured properties have a substructure of structured or simple sub-properties. Examples are given by the configuration data exposed by the Log Configuration aspect, by control aspects of Control Builder M Professional or by user defined structured properties of Parameter Manager aspects. Bulk Data Management supports reading and writing structured property data exposed via System 800xA bulk data interfaces. The latter bulk data interfaces are supported in the examples mentioned above. A structured property is mapped to a grid of cells in an Excel worksheet as shown in Figure 42. This partly resolves the structure but gives the possibility to perform bulk data operations. 136 3BDS011222R4101 Section 2 Concepts Configuration Using Spread Sheets Figure 42. Structured Properties Mapped to Cells After configuring the configuration headline of a worksheet by dropping in an aspect exposing a structured property and selecting the components of the structured property to include into the headline you can read in the data in a next step by dropping in the corresponding objects and then change the data values and save them back to the object. Formatted Templates Combining Auto-Update Data Areas, Filters and Property references you can configure sophisticated formatted templates. Formatted templates are Microsoft Excel based spreadsheet applications that allow you to enter, manipulate, and document data in a user definable format including calculations, graphics and business charts. Data included in the template can be retrieved from or saved to the system. Examples of templates are budget planning, resource calculations, price calculations, or even advanced applications like TagSheets, SignalLists, LoopDiagrams, dimensioning of motors or valves. Bulk Data Management provides some formatted template examples for you: • LoopDiagram.xls, a template for documenting Control Loops • TagSheet.xls, a template for documenting Tags • and others Most of formatted template examples are available as Document Management templates. 3BDS011222R4101 137 Configuration Using Spread Sheets Section 2 Concepts Pre Configured Bulk Data Applications Combining the standard Bulk Data Management functions with VBA script programs that access standard Aspect Object Programming Interfaces and specific tool interfaces (for example Open Interface of Control Builder M Professional) you can build own powerful Bulk Data Applications. Some pre configured Bulk Data Applications based on this implementation principle and supporting Control Builder M Professional are included in Bulk Data Management: • CBM_CrossReferences.xls, an application to produce a cross reference lists of your control applications • CBM_IO_Variables, an application to create, delete and edit Variables for your control applications • CBM_Applications_old.xls, an application to create, delete and edit Control Modules and Function Blocks of control applications (Still available for compatibility reasons). • CBM_FunctionBlockDiagram.xls, an application to create, delete and edit (change) Function Blocks for Function Block Diagram, including positioning on Code Block and page of Code Block. Another set of pre configured Bulk Data Applications is available that bases on the the System 800xA Bulk Data Interfaces for structured properties supported by some aspect systems (Log Configuration, Control Builder M Professional, Parameter Manager) and by Bulk Data Management: • LogConfig.xls: Supports configuration of Log Configuration aspects. • TrendConfig.xls: Supports Trend configuration. The following applications support Control Builder M Professional: • 138 CBM_Applications.xls: This template is divided into the following sections supporting various operations on Application objects: – Global Variables/Variables: Global variables/variables can be created, deleted or properties like name, type or initial value can be modified. – Structured Variables Initial Values: Initial values of variables which are of structured data type can be set or modified 3BDS011222R4101 Section 2 Concepts • • • 3BDS011222R4101 Configuration Using Spread Sheets CBM_Programs.xls: This template is divided into the following sections supporting various operations on Program objects: – Task Connection: Set, modify or delete the connection of the program to a task – Variables: Create, modify or delete program variables including their properties like Name, Data Type, etc. – Function Blocks: Create, modify or delete Function Block declarations within the program – Code Blocks: Add or delete code blocks of type Structured Text. Moreover the code of these code blocks can be edited in the related cell. This allows you for example to build Function Block calls in an MS Excel sheet and copy it into the cell ST_Code. – Structured Variables Initial Values: Initial values of structured variables can be set or modified CBM_FunctionBlockTypes.xls:This template is divided into the following sections supporting various operations on Function Block Type objects: – Description: Add or change the description of the Function Block Type – Parameters: Add, modify or delete parameter declarations of the Function Block Type incl. all properties like Name, Data Type, etc. – Variables: Add, modify or delete local variable declarations of the Function Block Type incl. all properties like Name, Data Type, etc. – External Variables: Add, modify or delete external variable declarations of the Function Block Type incl. all properties like Name, Data Type, etc. – Function Blocks: Add, modify or delete Function Block declarations within the Function Block Type incl. all properties like Name, Type, etc. – Control Modules: Add, modify or delete Control Module declarations within the Function Block Type incl. all properties like Name, Type, etc. – Code Blocks: Add or delete code blocks of type Structured Text. Moreover the code of these code blocks can be edited in the related cell. CBM_ControlModuleTypes.xls:This template is divided into the following sections supporting various operations on a Control Module Type objects: 139 Configuration Using Spread Sheets • • • 140 Section 2 Concepts – CM Parameters: Add, modify or delete CM Parameters incl. their properties like name, type, etc. – Variables: Add, modify or delete Variables incl. their properties like name, type, etc. – External Variables: Add, modify or delete External Variables incl. their properties like name, type, etc. CBM_FunctionBlocks.xls: This template is divided into the following sections supporting various operations on a Function Block objects: – Task Connection: Enter or modify the connection of the Function Block to a Task – Initial Values: Initial values of variables can be set or modified CBM_ControlModules.xls: This template is divided into the following sections supporting various operations on a Control Module object as stated below – Task Connection: Enter or modify the connection of the Control Module to a Task – CM Connections: Set or modify the actual parameter value for a CM connection – Initial Values: Initial values variables can be set or modified CBM_SingleControlModule.xls: This template is divided into the following sections supporting various operations on Single Control Module objects: – Description: Set or modify the description of the Single Control Module – CM Parameters: Add, modify or delete CM Parameters incl. their properties like name, type or initial value – Variables: Add, modify or delete Variables incl. their properties like name, type or initial value – External Variables: Add, modify or delete External Variables incl. their properties like name, type or initial value – Function Blocks: Add, modify or delete Function Block declarations within the Single Control Module incl. all properties like Name, Type, etc. 3BDS011222R4101 Section 2 Concepts • Configuration Using Spread Sheets – Control Modules: Add, modify or delete Control Module declarations within the Single Control Module incl. all properties like Name, Type, etc. – Code Blocks: Add or delete code blocks of type Structured Text. Moreover the code of these code blocks can be edited in the related cell. – CM Connections: Set or modify the actual parameter value for a CM connection of the Single Control Module – Structured Variables Initial Values: Initial values of structured variables can be set or modified CBM_HWUnits.xls: This template is divided into the following sections supporting various operations on Hardware Unit objects: – Parameter Settings: The value of HW-unit specific properties can be set or modified. Remark: New properties can neither be added nor deleted. This is ignored during save. – HW Channels: Properties like Min, Max, Unit, (Connection-) Variable, etc. can be set or modified. Remark: New properties can neither be added nor deleted. This is ignored during save. These templates can be modified. To change the structure of the sheet you have to re-configure the headline via a dialog that allows to include the components of the structured properties into the configuration headline. There are some rows and columns hidden, which must be un-hidden first before the headline can be configured. The pre configured Bulk Data Applications and corresponding documentation files are available in the folder Engineering Templates on the desktop of your Engineering Workplace. Hints on when and how to use Bulk Data Management are included in many subsections of the Concepts and the Configuration section of this manual. Bulk Data Management is further described in the section Bulk Data Manager of the IndustrialIT 800xA - Engineering, Engineering Workplace, Basic Engineering Functions manual. 3BDS011222R4101 141 List Based Data Exchange Section 2 Concepts List Based Data Exchange Engineering data describing an automated plant under design and configuration are often collected by third party engineering tools in other spreadsheets than Microsoft Excel or relational databases.The Excel functionality of Bulk Data Management can be used to import this engineering data lists to an 800xA system and to export data so that the third party engineering tools can import them. Export Data Data stored in the system can be retrieved into a Workbook and saved from there to different formats like “character separated values (csv)”,“html”, etc. (see Microsoft Excel save formats). These formats can be imported by corresponding other engineering tools. Import Data Data can be imported into Microsoft Excel from a variety of data sources (Menu item File > Open or Data > Get External Data). The imported data must be mapped to the configuration headline of a data area. Ensure that the columns “Command”, “Object Identification”, “Source Object” are in this order. After the properties of the external data source have been mapped to the properties of aspects save the data (menu item Bulk Data Manager > Save). Distributed Engineering System 800xA supports distributed engineering: You can do engineering work for a Production System on an Off-Site Engineering System and/or an On-Site Engineering System (short: Site Engineering System). Using the Import/Export tool you can transfer results of engineering work done on an Off-Site Engineering System to an On-Site Engineering System. Using System Synchronization you can transfer the results of the engineering work from an On-Site Engineering System to a Production System. 142 3BDS011222R4101 Section 2 Concepts Distributed Engineering This working scenario is shown in Figure 43. Figure 43. On-Site and Off-Site Engineering (On-) Site Engineering System The Site Engineering System is an Engineering System installed at the same location and in the same domain as the Production System and connected to it via LAN. It is used for final testing of applications before introducing them into the Production System, and for changes and additions occurring once the Production System is in operation. Moving application data between the Site Engineering System and the Production System is done using the function System Synchronization. To make it possible to use System Synchronization for application data transfer, the Engineering System and the Production System must have the same software products and product versions installed, and the same system extensions must be loaded in both. 3BDS011222R4101 143 On-Site Engineering Section 2 Concepts It is not necessary that both systems have the same hardware configuration. A Site Engineering System can be a single node, or have up to 10 engineering clients depending on the needs. Clients are permanently connected to the Site Engineering System (stationary PCs). Off-Site Engineering System The Off-Site Engineering System is a system installed at another location than the Production System. It is used for distributed development and testing of applications before introducing them in a Site Engineering or Production System. Moving application data between Off-Site Engineering Systems, and from an OffSite to a Site Engineering System or a Production System is done using Export/Import. Since Export/Import is used for application data transfer, the Engineering System and the Production System do not need to have the same software products installed. The Engineering System only needs to contain the software products needed for doing the actual engineering work. It is not necessary that the Engineering System and the Production System have the same hardware configuration. Similar to a Site Engineering System, an Off-Site Engineering System can be a single node, or have up to 10 engineering clients, depending on the needs. Clients are permanently connected to the site Engineering System (stationary PCs). An Off-Site Engineering System can be an island system at any location in the world without any network access to the On-Site Engineering System. Import/Export data can be transferred via removable media. On-Site Engineering A typical engineering task concerns only a certain part of the Production System, e.g. applications associated with a specific production unit or process line. There may be several engineering tasks going on at the same time, each concerning a different part of the process, and each with its own schedule. The results of the different engineering tasks can be moved over to Production System at different points in time, each transfer affecting only the part of the process that is concerned by the change. 144 3BDS011222R4101 Section 2 Concepts On-Site Engineering Multi-user engineering relies on manual procedures for sorting out which engineer works with which application, i.e. there is no check-out/check-in mechanism. There is no automated support for life cycle management. Engineering changes are carried over from Engineering System to Production System by means of System Synchronization. While this function is similar to import/export, there are some important differences. Rather than just adding a number of new objects and aspects to the destination system, the System Synchronization process first compares user selected substructures of the source and destination systems and then performs object and aspect additions, deletions, and changes as required, one object at a time. The synchronization procedure is a two-phase operation. These are normally performed at different points in time: The first phase when engineering is finished and everything is approved, and the second phase when it is acceptable with consideration to production and process conditions to introduce changes. The first phase is performed from a workplace that is connected to the source system, typically the Engineering System. In the second phase changes are exported from the source system. The output from the first phase, a difference report and the changed objects, are stored as a set of files, called a synchronization package. The second phase is performed from a workplace that is connected to the destination system, typically the Production System. In the second phase the changes are imported from the synchronization package to the destination system. Audit trails are generated both in the Production System and in the Engineering System, i.e. if Audit Trail is activated in the System. The audit trails describe what has been done in the corresponding system. A system audit would thus start by investigating the Production System audit trail for important changes to the Production System, and then go into the Engineering System audit trail for details on what engineering actions have been done. For more information on System Synchronization see System Synchronization on page 256. Versioning is accomplished by taking a complete backup of the system configuration data. For more information on system versioning see System Configuration Version on page 256. 3BDS011222R4101 145 Off-Site Engineering Section 2 Concepts Off-Site Engineering In addition to On-Site Engineering System and Production System, there may be a number of Off-Site Engineering Systems, such as an off-site engineering office system, or an engineer's laptop, where libraries and applications may be developed independently off and asynchronous to activities in the On-Site Engineering System. Transfers between these Off-Site Engineering Systems and the On-Site Engineering System are done with the Import/Export tool.This requires some manual procedures: 1. Export the corresponding complete entity on the Off-Site Engineering System 2. Transfer the file(s) using changeable media or network to the On-Site Engineering System 3. Prepare for import on the On-Site Engineering System: Save existing parts, clarify and exclude possible side-effects 4. Import the complete entity on the On-Site Engineering System In general the following entities and combinations of them can be exchanged between an (On-site) Engineering System and (Off-Site) Single Engineering Nodes using Import/Export: • • • 146 IIT in general – Aspects – Objects – Libraries AC800M Control Logic – Control Application – Control Library – Controller Fieldbus Foundation Logic – Library Project – HSE Sub-Net 3BDS011222R4101 Section 2 Concepts • Connectivity Process Graphics – Graphic Displays – Graphic Elements See Import/Export on page 125 for more informations on Import/Export functionality. Connectivity System 800xA includes the AC 800M Controller Connectivity. Furthermore a generic OPC connectivity, see Data Access Based on OPC on page 288, is included and several optional controller connectivity packages are available additionally. In an 800xA system we distinguish two kinds of servers: Aspect Server and Connectivity Server. In its Aspect Directory an Aspect Server stores data on all objects defined in the system and that can be accessed by System 800xA clients such as Operator Workplace or Engineering Workplace. A Connectivity Server provides the integration between the System 800xA Aspect Server and a controller or some type of device capable of sourcing data. In cases with low demands on number of process points and on availability Aspect Server and Connectivity Server can be run on the same physical machine. In all other cases they run on different machines and can also be configured redundant. For general information on Aspect Server, Connectivity Server and Redundancy see IndustrialIT 800xA - System, Installation. AC 800M Controller Connectivity The full scope of AC 800M controller connectivity functions in the 800xA system is provided to you by the install packages Control Builder M Professional, AC 800M Connect and the OPC Server for AC 800M. An additional install package provides a soft controller which you can use for testing controller applications without having AC 800M controller hardware. Control Builder M Professional is the integrated controller configuration tool. 3BDS011222R4101 147 AC 800M Controller Connectivity Section 2 Concepts A basic introduction how you can work with integrated Control Builder M Professional and Plant Explorer in the 800xA system is given in IndustrialIT 800xA - Control and I/O, Basic Control Software, Introduction and Configuration. How to work with integrated Control Builder M Professional and its Function Designer based on the systemwide functional planning concept you find in the section Automation Solution, subsection Control Logic on page 151. AC 800M Connect provides: • Access to alarms and events and properties from AC 800M • Standard Object Type Libraries for AC 800M • Tool routing services for HART devices connected to AC 800M • Time Adapter for AC 800M. The Time Adapter detects time settings on the Control Network and sets the time for the 800xA system. • SFC Viewer Aspect System The system extension AC 800M Connect has to be loaded to have these functions available. The OPC Server provides access to controller run-time data for operation. The main data flow between the mentioned parts is shown in Figure 44 Figure 44. Data Distribution in System 800xA with AC 800M Connectivity 148 3BDS011222R4101 Section 2 Concepts AC 800M Controller Connectivity The configuration entities (for example: Application, Program, Function Block, Control Module, Controller, Hardware Unit) of Control Builder M Professional are available in the 800xA system as Aspect Objects with a corresponding Control aspect and, in most cases, a Control Properties aspect. While the Control aspects typically provide access to the OPC properties of these entities (run-time), the Control Properties aspects provide access to the configuration data. Examples of Control aspects are: Application, Program, Function Block, Control Module, Controller, Hardware Unit. Integrated Control Builder M Professional works with a number of additional aspect categories, see the complete list in Appendix E of IndustrialIT 800xA - Control and I/O, Basic Control Software, Introduction and Configuration. Standard Object Type Libraries The object types in the Object Type Libraries provided with AC 800M Connect contain besides the Control and Control Properties aspects graphic aspects such as graphic elements and faceplates and alarm and event related aspects where applicable. In this way the object types serve both as base for control configuration and for configuration of graphical displays for operation. The contained faceplates and interaction windows are the base for standardized control operation and test. Creating an instance of an object type from the library can be done in Plant Explorer or in Control Builder M Professional. But note that graphic aspects of for example a Control Module aspect object cannot be created or accessed by Control Builder M Professional. Instead, the position of the object in Plant Explorer must be located, and the required graphics aspect must be added or accessed from within Plant Explorer. Short descriptions of the standard libraries of AC 800M Connect / Control Builder M Professional you find in IndustrialIT800xA - Control and I/O, Addendum, Product Data and Design. Display Elements Overview Over thirty display elements, representing different common functions, are delivered with AC 800M Connect. Most of these consist of an icon and an object name, but several also contain a bar graph and unit/value fields for in/out values. Examples of the former are different min./max. values, selectors, process objects 3BDS011222R4101 149 AC 800M Controller Connectivity Section 2 Concepts (valves and motors) and fuzzy-logic controllers. Examples of the latter are PID controllers, pulse width, three-position control, AnalogIn and AnalogOut. A number of icons are associated with each display element. Thus, the center icons may be replaced with others, more suitable for the object in question. The number of icons for each display element varies from three up to around 25. Tool Routing Overview Tool Routing makes possible accessing secondary values in HART devices from a workstation on the Control Network, as well as scaling and calibrating of values. ModuleBus is used for local I/O, PROFIBUS-DP for remote I/O. Functionality for accessing various devices is built according to the FDT/DTM concept. The Field Device Tool (FDT) is encapsulated within the Fieldbus Aspect System (FAS), which is part of the HART and PROFIBUS Device Integration install package. Tool Routing functionality for AC 800M involves several components: Busmaster DTMs (AC 800M ModuleBus DTM and CI854 DTM) integrated in the FAS, Tool Routing Service (TRS) running on the workstation, and the AC 800M controller. For further information concerning Tool Routing and the components concerned, see the online help for the TRS Panel, accessible from the Tool Routing Service panel. 150 3BDS011222R4101 Section 2 Concepts Automation Solution Automation Solution In an 800xA system Automation Solutions are seen to comprise • the controller software parts (control logic) • the graphic displays, faceplates and trend displays for process operation • the alarm and event functionality and related functionality such as logging and messaging • the controller/ I/O and Fieldbus / Field device communication parts • the field device control software (if it can be configured) • the graphic displays for diagnostic and test. These parts together implement an Automation Solution. The 800xA system allows you to treat these parts and even more parts together in Aspect Objects representing the control solution. Control Logic The tool to configure control logic for an 800xA system with included AC 800M controller connectivity is Control Builder M Professional. Besides flexible basic control configuration functions based on IEC61131 languages and the additional Control Module concept Control Builder M Professional provides you with Function Designer. This tool enables you to configure control logic according to a Functional Planning approach. 3BDS011222R4101 151 Control Logic Section 2 Concepts Control Builder M Professional additionally is the certified tool to configure SIL certified applications. SIL stands for Safety Integrity Level, as specified in the standard IEC-61508. To run SIL certified AC 800M applications, you need the SIL certified AC 800M High Integrity controller. Function Designer is not certified for building SIL-certified applications. It can be used to configure non-SIL-certified applications for the AC 800M High Integrity controller. For information on guidelines and safety considerations related to all safety lifecycle phases of an AC 800M High Integrity controller see IndustrialIT 800xA Safety, Safety Manual, AC 800M High Integrity. This manual also lists the available SIL certified library object types. SIL-application related configuration procedures to perform with Control Builder M Professional are described in IndustrialIT 800xA - Control and I/O, Basic Control Software, Introduction and Configuration. With Control Builder M Professional including Function Designer you can follow three different approaches to configure control logic: • IEC61131 Function Block / Program Programming • Control Module Programming • Functional Planning with Function Designer Base languages in each of these cases are the IEC61131 control languages. While the first approach typically is used for PLCs, the second approach (involving deep Control Module structures) extends the first approach in an ABB-specific way for DCS-like systems. It was introduced with the ABB SattLine system. System-wide Functional Planning is a typical DCS configuration strategy not limited to control logic. Regarding control logic it bases on the first two approaches. Which approach to follow in a project depends on the customer´s requirements, on technical design issues and, to a certain extent, on preferences and experiences of the project team. Some basic information on configuration of control logic according the two first controller or task oriented approaches you find in Function Block / Program 152 3BDS011222R4101 Section 2 Concepts Control Logic Programming on page 154 and Control Module Programming on page 155. Comprehensive information on these topics is contained in ControlIT IEC 61131 Control Languages Introduction and in IndustrialIT 800xA - Control and I/O, Basic Control Software, Introduction and Configuration. The latter manual among other topics describes the basic design issues to take care for Function Block and Control Module programming. These basic design issues also apply to control logic configured using Function Designer. The main decision points for Functional Planning with Function Designer are: • Configuration driven by Functional Structure (functional decomposition) of the plant. • Control application independent planning in early planning stages. • Electronic Function Diagram documentation (offline and online) to ease commissioning and maintenance. – Including diagram based horizontal and vertical navigation. – In online mode with live data display and value forcing. • Function Diagram documentation bulk printing. • Function Components not only restricted to control logic elements (by default Engineering Signals and Field Devices) • Configurable Function Components. • Automatic creation of connection variables • Automatic control logic generation for cross application MMS communication. Functional Planning allows you to work in comprehensive Function Diagrams that can cover control logic, engineering signals, field devices and even representations of information items of other aspect systems important for the plant functionality from your own perspective. Function Diagrams are an excellent means to configure, maintain and document the control system of a plant from a functional perspective. To configure control logic within Function Diagrams you insert Control Modules and / Function Blocks or Functions from Libraries, connect them graphically and 3BDS011222R4101 153 Control Logic Section 2 Concepts generate them into Single Control Modules allocated to a control application in Control Builder M Professional. Basic concepts of Functional Planning are described in Functional Planning with Function Designer on page 157, more details are described in IndustrialIT 800xA Engineering, Engineering Workplace, Function Designer. Function Block / Program Programming The IEC 61131-3 standard describes programs, function blocks, and functions as Program Organization Units (POUs). These units help you organize your control project into code blocks, to minimize code writing, and to optimize code structure and code maintenance. A POU can be described as an object type that contains an editor, where you can write code and declare parameters and variables. All POUs can be repeatedly used in a hierarchical structure, except for programs that can only be a top-level POU, inside an application. The use of Functions and Function Blocks encourages well-structured design which in return will speed up program development. This is especially true in plants containing a lot of similar control functions which means that Functions and Function Blocks can be reused many times. Reuse is accomplished by first establishing a Function Block Type and then creating one or many Function Block Instances of that type. The Function Block Instance only contains data that are unique to the particular set of Function Block Type. This means that although a Function Block Type may use a very complicated algorithm the memory required to store the data for each Function Block Instance may be very modest. An application program based on several Function Blocks therefore requires less memory than programs containing duplicates of code. Functions and Function Blocks are executed list driven and cyclic. You define execution by observing rules like “top / left” to “down / right” such that the required cycle and the enclosed actions are maintained. 154 3BDS011222R4101 Section 2 Concepts Control Logic Control Module Programming Control Modules extend the IEC 61131-3 standard to support requirements of object-oriented programming and of larger applications. Besides application program code they can contain graphics to visualize and operate the implemented function during test and commissioning. They are executed data flow-driven, the compiler automatically determines the execution order by analyzing the data flow between the modules. Figure 45 shows a software model for both the standard and the extensions. Figure 45. ABB Software Model To use Control Modules is recommended for: • Larger applications, because of increased performance. • Process objects, as code sorting facilitates application structuring. • When a flexible solution is needed: Object orientation, re-use. 3BDS011222R4101 155 Control Logic Section 2 Concepts The main differences between Function Blocks and Control Modules are listed in Table 5. Table 5. Comparison Between Control Module and Function Block Control Module Execution order 156 Function Block Automatic: Compiler Manual: Code statements, determined via code based on program flow as sorting/data flow optimization. implemented by the programmer. Execution per scan The code blocks are always executed once per scan according to data flow analysis. A function block can be called and executed, zero, one, or several times per scan. Static parameter connections Supported. A most important feature: A static parameter connection does not change during execution. It can only be changed via code changes and recompilation. The static connections are set at compile time and yields efficient code generation. Compiler-based program analysis. Better performance. Not Supported. Parameters are copied each time the function block is executed according to the IEC61131-3 standard. For deep and complex hierarchies, the parameter copying of function blocks costs significant CPU time. Graphics Yes FB diagram auto-layout and indirectly via inclusion of sub control modules. Parameters In_out, can be connected to graphics. Connections cannot be inverted: NOT "actual parameter name" is invalid.). In, Out, or In_out, only In- and Out parameters can be connected to sub control modules. 3BDS011222R4101 Section 2 Concepts Control Logic Functional Planning with Function Designer Function Designer allows you to configure control logic in Function Diagrams using Control Modules and Function Blocks and other Function Components (for example field devices or engineering signals). A Function Diagram typically shows a process control loop with all its function components and their signal connections. Figure 46. Example Function Diagram With Function Designer you are able to perform graphical plant function oriented engineering with Aspect Objects. This is different from the traditional controller or task oriented engineering. The graphical user interface makes complex control strategies easy to engineer and even easier to maintain and document. The Function Designer provides you with a Component view and a Diagram view on a Function Aspect. 3BDS011222R4101 157 Control Logic Section 2 Concepts Function Components In Component view you design a graphical symbol for a Function Aspect representing an Object Type or Composite Object Type from the functional perspective. Instances of such an Function Component object type you can insert in a Function Diagram and connect the graphically based on the representing graphical symbol. For object types of AC 800M / Control Builder M Professional standard libraries you need not design graphical symbols yourself: After loading Function Designer system extensions into your system these object types are equipped with Function aspects and default graphical symbols. The same applies for HART device object types supplied by HART Device Library of HART Device Integration. For object types you have designed for AC 800M / Control Builder M Professional you only need to add a Function aspect to the object type to make it work as a Function Component with a fitting default graphical symbol. The object type can have aspects of one or several different aspect systems. You can use basic graphic components as for example line, box, text and circle and ports referencing to a configuration entity in the represented Aspect Object to configure your specific graphical representation for an object type. You can configure Function Components for any aspects of aspect system that you need to represent in Function Diagrams. Control Module aspects and Function Block aspects as supported by Control Builder M Professional are the basic aspects for Function Components regarding control logic. You use the corresponding editors of Control Builder M Professional to configure these aspects in the object types / composite object types. You can use the supported IEC 61131 languages Structured Text (ST). Instruction List (IL), Sequential Function Chart (SFC), Function Block Diagram (FBD) or Ladder Diagram (LD) to write the Code Blocks for the Control Module and Function Block types. Function Diagrams In Diagram view you are using the graphical symbols of Aspect Objects needed to implement a certain control strategy when you arrange them on a diagram and interconnect ports of them. The ports of the Aspect Objects can be connected with an easy drag and drop operation. You can nest Function Diagrams according to the 158 3BDS011222R4101 Section 2 Concepts Control Logic functional hierarchy. Interconnections between Aspect Objects on different pages of a diagram as well as those between different diagrams are shown as connection symbols. Connections can hide complex IEC61131 data types behind one connection line. You can follow the connection using point and click operations. Point and click navigation across Function Diagrams following the functional hierarchy of nested diagrams top down is also possible. These navigation features give you a comprehensive Function oriented view on plant wide configuration. In a Function Diagram you also can use the set of functions from the System Library and the set of Function Blocks from the Basic Library of Control Builder M Professional. By default these Function Components are not visible as object instances in Functional Structure and Control Structure, they are only visible in the Function Diagram and in the generated code of it. To display any reachable Aspect Object property you can insert corresponding property references into Function Components and Function Diagrams. This follows the same mechanism as known from Document Manager, Parameter Manager, Bulk Data Manager and Control Builder M Professional Control Properties aspect. During work Diagram States are assigned to Function Diagrams that are displayed in the Function Designer window and in System Status Viewer. The basic Diagram States are modified (red), generated (yellow), and downloaded (green). Connection Mapping Connection mapping of Function Designer provides a function to connect components of variables of different structured data type. You use this function to connect two ports of different structured data type. It is implicitly invoked for connections that cannot be automatically casted. You can also explicitly invoke the Connection Mapping command from the context menu of a link or of a variable component. In both cases you can select which substructures shall be interconnected. Necessary variables and links get automatically created. Switching Between Aspect Object and Symbol Object To give you the possibility to determine which Function Components shall be handled as aspect objects in System 800xA platform Function Designer provides a function that allows you to switch Functions, Procedures, Variables, Function 3BDS011222R4101 159 Control Logic Section 2 Concepts Blocks, Control Modules and Diagram Parameters to be switched from aspect objects to symbol objects, and vice versa. Symbol objects are stored and visible on a function diagram only, but not in Plant Explorer Functional Structure nor in Control Structure. Inside a function diagram, select one or more Function Blocks, Control Modules, or Diagram Parameters and use context menu item Aspect Object to switch between aspect objects and symbol objects. Function Designer modifies the aspect properties Name, Description of the Name aspect and Control Builder Name aspect, to set the name or Control Builder name of symbol objects. Name Synchronization To support efficient object naming and to allow names beginning with digits (not allowed in IEC 61131-3), for example names according KKS naming rules, Function Designer synchronizes the different naming properties of Function Diagrams, Control Modules, Function Blocks, Variables, Signals in the Function Structure. For naming properties ruled by Control Builder M Professional it generates corresponding IEC 61131-3 compliant names. Data Flow Order The data flow order influences configuration data generation, for example generation of additional move blocks for variables and additional code blocks for Control Modules. Thus the data flow order gets additionally displayed for • CBM signals • HART devices • Variables • Diagram parameters • Diagram references. It is possible to either show or hide the data flow order for all components, but not for individual components, for example Control Modules. 160 3BDS011222R4101 Section 2 Concepts Control Logic A dialog allows to change the data flow order for all components. On instantiation, a default data flow order gets calculated on base of the graphical position. Allocation and Code Generation Allocation of the Function Components of a Function Diagram to an Application is is based on a so called Allocatable Group which by default is assigned to a Function Diagram. An Allocatable Group can be allocated to / inserted below an Application in Control Structure. The contents of a Function Diagram also can be divided in parts which in turn can be assigned to different Allocatable Groups. The concept of allocating Allocatable Groups allows you to build your Function Diagrams in Functional Structure without taking care of the concrete control system structuring in early stages of work. You can separate functional design and configuration work from control system related structuring and configuration work. Allocatable Groups also allow you to define the execution order of the AC 800M related Function Components. An Allocatable Group is mapped to a Single Control Module in Control Builder M Professional. If you have allocated/inserted a Function Diagram into Control Structure, you can generate the appropriate code in Function Designer for the control system devices (such as AC 800M controller and I/O devices) including variable and connection generation. Bulk configuration data generation is supported in Bulk Data Manager by context menu items and multiple select on the aspect name column of the Function aspect. Code of the Single Control Modules generated by Function Designer for consistency reasons cannot be changed by other Control Builder Professional tools. Changes done by Control Builder M Professional or other tools to other items (global variables, object names, ...) generated by Function Designer are detected and correctly reflected in Function Designer. I/O Signal Allocation The system extension AC 800MC Signal Extension / object type group CBM_Signals provides you with Signal object types (CBM_AIS, CBM_AOS, 3BDS011222R4101 161 Control Logic Section 2 Concepts CBM_DIS, CBM_DOS and CBM_PulseS) that allow to plan and configure the required I/O Signal informations for functions in Functional Structure. Do not mix up these Signal objects with the Function Blocks Types in the SignalLib of Control Builder M Professional. They have a totally different purpose. At the latest possible point in time you can allocate the Signal instances in bulk to I/O Board hardware units in Control Structure using the I/O Allocation tool included into Engineering Workplace. See also I/O Signal Allocation on page 167. Code generation of an Allocatable Group which includes Signals already allocated to I/O Boards creates the corresponding variables and connections and configures the corresponding hardware units with the informations from the Signal objects. Cross Application Communication Support For efficient engineering Function Designer supports automatic cross communication configuration for connections across different applications. A corresponding tool function reads data from Function Diagrams (Diagram References etc.) and creates additional Function Diagrams inside the Function Designer with the required function blocks for a cross application communication. You can call the tool on a project object, or a network object or on the root object in Control Structure, when allocation and configuration data generation are finished. After this step of work it is known where really communication across applications happens. The created diagrams for sender and receiver applications can then be transferred to Control Builder M Professional by generation of configuration data. The generated diagrams include provisions for supervision of communication validity. Standard functionality of Function Designer is available for these generated cross communication Function Diagrams. Download and Test You download the control logic of allocated Function Diagrams using Control Builder M Professional Tool menu functions. Loaded Function Diagrams can show Live property values and Configuration values. Besides the values of signals / page references shown by default any port can be configured (added to display list) to be shown. Items from the display list can be forced using a Watch Window provided access rights allow this. Additionally 162 3BDS011222R4101 Section 2 Concepts Control Logic Component and Diagram view are enabled to host bitmaps and controls (e.g. ActiveX and Graphic Elements made with Graphics Builder). Further, for a Function Component inserted into a Function Diagram, you can open and operate all aspects for the component, for example the faceplate. Applying these capabilities you can use Function Diagrams to test your control logic including signals and field devices. List Based Configuration Often there are many loops in a plant that equal each other except for the names, some parameter values and the assignment to Applications and Hardware Units. To configure these loops efficiently you can pre-configure the loop and then use Bulk Data Manager to instantiate or copy the needed instances. You can do it in at least three different ways: • • • 3BDS011222R4101 Configure a composite object type for the loop with the ready made Function Diagram in the Function aspect of the top object. – Introduce names according to naming rule support in Bulk Data Manager (same as naming rule support in Function Designer). – Configure the Aspect Properties of the Function Aspect to hold all properties of sub-ordinate objects needed for parametrization. – Introduce the needed Allocatable Groups and assign the Function Components to them. – Instantiate and parametrize the needed number of instances via a Bulk Data Manager worksheet. You could also do allocation to Control Structure in this or another Bulk Data Manager worksheet. Configure a composite object instance for the loop in Functional Structure with the ready made Function Diagram in the Function aspect of the top object. – Configure it as outlined above for the composite object type. – Copy and parametrize it as the needed number of typical solution instances using a Bulk Data Manager worksheet, if needed including allocation to Control Structure Build up the composite object instances for the loops by instantiating and parametrizing the Function Component Object Types from the standard 163 Control Logic Section 2 Concepts libraries, add a Function aspect to the loop object and finalize the Functions and their Function Diagrams manually instance by instance. This proceeding you could for example use if there are significant differences between the loops to take care. Documentation Printing To provide documentation to customer on paper or as .pdf-files the configured Function Diagrams can be printed in bulk. Starting with a configurable contents diagram, into which the contents list is generated automatically, and including the diagrams and child diagrams you can print subtrees of Functional Structure or the whole Function Structure. Control Module Graphics You can configure the interaction window of a Control Module type with graphical representations including interaction elements for the control algorithm implemented. The interaction window then can be opened in Test Mode and Online Mode of Control Builder M Professional and can help you in test, diagnostic and commissioning of the control algorithms. For configuration of the contents of an interaction window the Control Module Diagram Editor CMD of Control Builder M Professional includes a graphical editor. The interaction window of Control Module types of the Standard libraries typically contain faceplate-like representations and interaction elements. See IndustrialIT 800xA - Control and I/O, Basic Control Software, Introduction and Configuration and Control Builder M Professional Help for further informations. Sequential Function Chart Sequential Function Charts (SFCs) can be configured in Control Builder M Professional and viewed on a workplace (especially on the Operator Workplace) via the SFC Viewer aspects. They also can be operated using corresponding faceplates. You can integrate and connect SFCs into Function Diagrams by configuring a Function Component for the Control Module or Function Block implementing the SFC or by using Off-Diagram References. 164 3BDS011222R4101 Section 2 Concepts Control Logic Further Readings Basic configuration steps using Function Designer you find in Process Object Type with Signals on page 352, Process Object Type Built in Function Designer on page 356, Function Diagrams on page 369 and HART Field Devices on page 435. A comprehensive description of Function Designer functionality and a basic tutorial on configuration of Function Components and Function Diagrams is given in IndustrialIT 800xA - Engineering, Engineering Workplace, Function Designer. Especially see subsections Tutorial and Function Designer AC 800M/C Integration of this manual. I/O Allocation is described in IndustrialIT 800xA - Engineering, Engineering Workplace, Basic Engineering Functions. An introduction to the IEC 61131 languages you find in ControlIT IEC 61131 Control Languages Introduction. Hints on programming Control Module types and Function Block types you can find IndustrialIT 800xA - Control and I/O, Basic Control Software, Introduction and Configuration and in Control Builder M Professional Help. 3BDS011222R4101 165 Control Hardware Units Section 2 Concepts Control Hardware Units You can create Control hardware units such as AC 800M Controller and CPU, communication units of the controller (Ethernet, Com, ppp, ModuleBus) and I/O boards beneath ModuleBus using Plant Explorer and you can configure them in the Hardware Editor of Control Builder M Professional as single units one by one. Figure 47. Control Hardware Units in Plant Explorer If your engineering task is to create and configure a lot of these units, especially I/O boards, you use Bulk Data Manager. From a Bulk Data Management worksheet you 166 3BDS011222R4101 Section 2 Concepts Control Hardware Units can create the I/O boards and parametrize (configure) their properties from a list in one shot as shown in example Figure 48. Figure 48. Import I/O Boards I/O Signal Allocation When you do Signal engineering in Functional Structure using the I/O Signal objects of the AC 800MC Signal Extension / object type group CBM_Signals you finally have to allocate the Signal objects to the channels of the I/O boards, configure the channel properties, and create the I/O variable. The I/O Allocation function and the function Write I/O Allocation to CBM relieves you from doing these tasks manually item by item. Both are available in the object context menu of Engineering Workplace. The smart I/O Allocation function gives you a tabular view on the I/O boards and their channels and on the Signals. The Signals can be allocated to the channels using multiple selection and drag and drop, as outlined by Figure 49. Executing the menu item Write I/O Allocation to CBM configures the channel properties of the I/O boards in Control Structure beneath and including the selected object from the Signal Parameter aspect properties of the allocated Signal objects including I/O variable creation. You can switch this function to auto-update the hardware units during I/O Allocation. 3BDS011222R4101 167 Control Hardware Units Section 2 Concepts Figure 49. Advanced Context Menu and I/O Signal Allocation I/O board hardware units affected by I/O Allocation are locked to prevent changes in Control Builder M Professional to keep consistency. The lock can be removed in Control Builder M Professional. Existing allocations done in Control Builder M Professional can be read back with some limitations by executing the menu item Read I/O Allocation from CBM. I/O Signal Groups I/O Signal Allocation also does support Signal Grouping. A Signal group is a specific signal object type and represents a couple of base IO signal objects types (e.g. CBM_AIS, CBM_DOS) which are combined in a structured data type of Control Builder M. Signal group object types can be build below a generic object type group or below a Control Builder library. Further information on I/O Allocation you find in IndustrialIT 800xA - Engineering, Engineering Workplace, Basic Engineering Functions. 168 3BDS011222R4101 Section 2 Concepts Control Hardware Units Topology Status Viewer Diagrams that show the network topology of the system, the status of the devices and additional important information are a valuable help when it comes to problem tracing and maintenance. With Topology Designer you can configure graphical network topology diagrams that include the hardware devices of the whole plant network, the client/server network and of the control Hardware Units of the Control Network in including live hardware status information of devices that expose these informations. An operator or a maintenance employee that inspects a completely configured graphical network topology diagram including status information on an Operator Workplace uses the Diagram view of a Topology aspect as Topology Status Viewer. Loading the Topology Designer system extension equips the Hardware Units for AC 800M on CPU and I/O board level with Topology aspects which hold graphical symbols representing these hardware units. These symbols are available in the Component view. Further standard skeletons for Topology Diagrams (in Diagram view) on Controller and on Network level are available. You also can add Topology aspects to objects and object types as you require and configure the Component view specifically. If you open the corresponding skeleton on the Topology aspect of the Controller object then you automatically get a Topology Diagram showing the Controller and its I/O. 3BDS011222R4101 169 Control Hardware Units Section 2 Concepts Figure 50. Topology Diagram on Controller Level If you create a Topology aspect and open the corresponding skeleton on the Network object then you get a Topology Diagram populated with the Controllers of the Network. If you create a Topology aspect and open the corresponding skeleton on a higher level object the diagram contains, provided the objects are prepared with Topology components, additionally these symbols.You easily can finalize the diagram by arranging and connecting the controller symbols and other symbols. From the Controller symbols you can call up the Controller Topology diagrams. 170 3BDS011222R4101 Section 2 Concepts Process Graphics Figure 51. Topology Diagram on Plant Network Level When the corresponding OPC server is operating and the controllers are running you see the live hardware status information of the Hardware Units displayed in the Topology Diagrams. The basic configuration steps you find in Topology Status Viewer on page 373, more information on Topology Designer you find in IndustrialIT 800xA - System, Topology Designer. Process Graphics With Process Graphics functionality in System 800xA you can • Build graphic elements • Configure faceplates • Configure graphic displays • View graphics 3BDS011222R4101 171 Process Graphics • Section 2 Concepts Use faceplates for information and control You configure graphic aspects with the Graphics Builder engineering tool. Graphics Builder Graphics Builder allows you to configure of graphic aspects, for example graphic displays, graphic elements and faceplate elements. It is a tool built on Microsoft Visual Basic. Graphics Builder provides several powerful features for configuring graphic aspects, and writing expressions. Even though the Visual Basic environment is a full-fledged programming environment, the configurator of graphic displays or graphic elements is not required to be a programmer or have a Visual Basic background. Graphics Builder allows the full power of Visual Basic if needed. The Visual Basic code panes are available and the environment is accessible. The following features are specific for Graphics Builder: • An Expression Builder that allows you to assign expressions, that is to specify subscriptions and specify the relationship between the process data and the data that is to be displayed. • A Graphic Libraries dialog that allows you to add Primitives and Subelements to your toolbox. • An Element Browser in which you can select appropriate graphic elements. • A Deploy function that stores the graphic aspects and enables viewing of process displays by process operators. Before a graphic element is deployed, it can only be seen in the Graphics Builder. • Ability to define input properties using the Expression Builder. These features are accessed through the pull-down menu in the menu bar or through tool buttons. Figure 52 shows the main user interface characteristics of Graphics Builder. 172 3BDS011222R4101 Section 2 Concepts Process Graphics Figure 52. Graphics Builder How to work with Graphics Builder is described in IndustrialIT 800xA Engineering, Graphics. Graphic Aspects The Graphics aspect system defines two aspect types: • 3BDS011222R4101 Graphic Display 173 Process Graphics • Section 2 Concepts Graphic Element Aspects created from the aspect categories of each of these aspect types are in most respects the same. They are configured using the same tool, the Graphics Builder, and the same mechanisms can be used in each of them. The major difference is that graphic displays are intended to be handled and invoked directly by the process operator, the person that uses graphics for monitoring and control in the run time situation. Graphic elements on the other hand are building blocks that are used when configuring graphic displays, or other graphic elements, but also faceplates. Faceplates are supported by a Faceplate Framework. Graphic Aspects in Structures Graphic aspects may be created on objects found in various structures. The structure used reflects the purpose for the graphic aspect. Structures used and the corresponding purpose of the aspect is described in Table 6. Table 6. Relevance of Structures for Graphic Aspects Structure Purpose of aspect Object Type Structure A graphic aspect placed on an object type object is inherited by all instances created from the object type. Built in aspect categories suitable for object type objects are Graphic Element, Faceplate Element and Object Display. 174 3BDS011222R4101 Section 2 Concepts Process Graphics Table 6. Relevance of Structures for Graphic Aspects Structure Purpose of aspect Graphics Structure Aspects placed in Graphics Structure shall be generic. See Object Aware and Generic Graphic Aspects on page 175 for a description of generic elements. Graphics Structure is used to create toolboxes in the Graphics Builder. An object placed in Graphics Structure corresponds to a toolbox tab. Built in aspect categories suitable for Graphics Structure are Property Element, Subelement and Symbol Element. Any other structure (typically Functional Structure) Graphic aspects placed in other structures are typically aspects of the Graphic Display aspect category. Graphic aspects placed for example in the functional structure are sometimes called “instance graphics”. Object Aware and Generic Graphic Aspects A major characterization of graphic aspects is to divide them into one of the following subsets: • Generic Graphic Aspects Generic graphic aspects are characterized by being applicable regardless of object type and even of the controller family connected to. Generic graphic aspects are therefore quite versatile creatures. Yet, they require more configuration, as every property that requires dynamic data must be connected individually. Generic graphic aspects are entered, using Graphics Builder, by selecting them from a toolbox. • 3BDS011222R4101 Object Aware Graphic Aspects In object aware graphic aspects there is in contrast to generic graphic aspects, support for object references. The main feature is that there is always an invocation object available in each instance of object aware aspects. The invocation object makes it possible to use relative references to aspect objects, aspects and aspect object properties within the graphic aspect. 175 Process Graphics Section 2 Concepts For more information about graphic aspects dividing into different subsets, see Subsets of Elements on page 178. The invocation object is set up differently for graphic displays and for instances of graphic elements: • Graphic Element aspects has a property named ObjectPath. This allows object aware graphic element instances to be parameterized with a reference to an object. This parameterization takes place automatically when using the Element Browser. • For graphic displays the invocation object is set up in runtime by the runtime system. Built in Graphic Aspect Categories For each of the Graphic Display and Graphic Element aspect types, there are a number of built in (predefined) aspect categories, see Table 7 and Table 8. It is also possible for users of graphics to create custom aspect categories with templates. By selecting a certain aspect category when you create a graphic aspect, you select a number of predefined quantities like: 176 • The default size of the graphic aspect • The background color of the graphic aspect • A set of properties available • Some Visual Basic code that fits with the intension of the aspect category 3BDS011222R4101 Section 2 Concepts Process Graphics Table 7 describes built in aspect categories used to configure object aware graphic aspects. Table 7. Built in Aspect Categories Used for Object Aware Graphic Aspects Aspect category Description Graphic Display The aspect category is intended for “instance graphics” i.e. graphic displays that are built and placed in a concrete structure, typically Functional Structure. Object Display The aspect category is intended to be used on object types to be general presentations for all objects of the type Faceplate Element The category of graphic aspects used by faceplates to perform monitoring and control of the process Graphic Element Aspects of the Graphic Element aspect category typically represents objects of a certain object type. For example a valve. ABB provides libraries of object aware graphic aspects as part of the connectivity for various controllers, while others may be built by you, or purchased from other sources in the form of graphic libraries. Table 8 describes built in aspect categories to configure generic aspect aspects. Table 8. Built in Aspect Categories Used for Generic Graphic Aspects Aspect category Description Subelement Aspects of the Subelement aspect category are generic aspects intended for presentation purposes, i.e. elements with properties to which data can be provided using expressions. 3BDS011222R4101 177 Process Graphics Section 2 Concepts Table 8. Built in Aspect Categories Used for Generic Graphic Aspects (Continued) Aspect category Description Property Element Aspects of this category are intended to be used when configuring Faceplate elements. The usage is not limited to faceplate elements though. Symbol Elements The Symbol Element aspect category is prepared to create elements of “icon” type, shapes. The symbol element, by default, contains an Image Control to which a picture (icon, windows metafile, gif-file etc.) can be assigned. ABB provides libraries of generic elements as standard building blocks. Subsets of Elements There are a number of terms that are used to define different subsets of elements used by and produced by Graphics. In some cases these terms are equivalent with names of aspect categories. This section tries to clarify these terms. Factors that control if an element belongs to a certain subset are the following: 178 • Whether the element is object aware not • Implementation, i.e. whether implemented as a graphics aspect using the Graphics builder or if implemented in any other way • Usage - Whether the element is used directly by the process operator in the run time situation or if it is a building block. 3BDS011222R4101 Section 2 Concepts Process Graphics Table 9 defines a number of these subsets. The columns describes values of controlling factors. An “X” means that the factor is not relevant for the subset. Table 9. Subsets of Graphics Elements Object aware Implemented using Graphics Builder Usage Element X X X Graphic aspect X Yes X Graphic Display Yes Yes By operator Graphic Element Yes Yes Building block Generic graphic aspect No Yes Building block Generic Element No X Building block Object aware graphic aspect Yes Yes Subset X (So far always) Generic graphic aspects constitutes, as can be seen from Table 9, the subset of the graphic aspects that are implemented using the Graphic Builder. Other generic elements are Graphic Primitives, Extended Graphic Primitives, standard Visual Basic components and third party ActiveX controls. Building Blocks Used in Graphic Aspects Elements used in the graphic aspects are: • Generic elements • Object aware graphic elements Generic elements can be used to implement the static part of the configured graphic aspect. Generic elements can also be used to present dynamic information by connecting expressions to their properties. 3BDS011222R4101 179 Process Graphics Section 2 Concepts Object aware elements represent the other way to implement presentation of dynamic information in a graphic aspect. Object aware elements are usually a more convenient to use than generic elements as the only requirement is that a reference to an object is set up, in contrast to defining the data subscription using expressions. Generic elements are, on the other hand much more flexible. Graphic aspects are described in detail in IndustrialIT 800xA - Engineering, Graphics. Using Object Types with Graphic Aspects The AC 800M Connect graphical object type library for example contains object types with object aware graphic elements. After instantiating a PID controller object type in Functional Structure below a tank object you can use the corresponding graphic element in Graphics Builder by browsing to the element and placing it in the tank´s graphic display. 180 3BDS011222R4101 Section 2 Concepts Process Graphics After deploying the display you have available the graphical elements dynamic representation and you can call-up the faceplates of the PID controller by mouse clicks as shown in Figure 53. Figure 53. Tank Graphic Display: Regulator Valve with Connected PID Controller Display Services Additionally you can use Information Management Display Services to build and distribute graphical process monitoring capabilities in your plant. A Display Server as a collection of service and data providers for graphic display call-up, management, and data access handles an interface to several Display Clients. A data provider for the 800xA system exists. The Display Client provides a graphical user interface for display building and viewing and for administration of Display Services. See IndustrialIT 800xA - Information Management, Display Services Configuration. 3BDS011222R4101 181 Alarm and Event Section 2 Concepts Alarm and Event Alarm and event management support in System 800xA is available on several levels. The alarm and event information flow is treated in a consistent way over these levels. While an event just informs the user that something has happened, an alarm is an event that alerts the user of an abnormal state and needs to be acknowledged. System 800xA handles alarm and event information generated in controllers or other hardware units or applications and provides presentation, alarm acknowledgement, logging, archiving, transfer to SMS and e-mail, and management functions. Figure 54 shows the conceptual alarm and event flow from a Controller to the Operator Workplace, to SMS and E-Mail devices and to Information Management. Figure 54. Conceptual Alarm and Event Flow 182 3BDS011222R4101 Section 2 Concepts Alarm and Event The following schematic figures show more details on alarm and event handling on Controller (Figure 55) and on Server and Workplace level. Figure 55. Alarm and Event Handling on Controller Level (AC 800M) 3BDS011222R4101 183 Alarm and Event Section 2 Concepts Figure 56. Alarm and Event Handling on Server and Workplace Level 184 3BDS011222R4101 Section 2 Concepts Alarm and Event Disabling / inhibiting and hiding functions as shown by Figure 57 are available that allow to configure provisions against alarm floods which would overstrain the operator. Figure 57. Reducing Alarm Flood Alarm / Event Overview The basic 800xA system provides an alarm and event message handling called Alarm and Event. • Alarm lists or event lists are presented in a table type format. • An alarm logger is supported for printer output. • Alarm Bands provides a number of unacknowledged alarms in a summary display for selected alarm lists. • The Sequence Bar is a status display, where the defined number of alarms is displayed horizontally. • From user´s perspective the system provides a server holding a timestamped queue of all alarm and event messages. • Alarm list configurations can be shared between lists. 3BDS011222R4101 185 Alarm and Event • Section 2 Concepts Irrelevant Alarms can be removed from alarm lists by configuring Hiding Masks. Single alarms can be hidden as well as signals from an object and its descendants. Six services as shown in Figure 58 provide the functionality of Alarm and Event:. Figure 58. Alarm / Event Related Services in Service Structure 186 • The Event Collector Service is used to affiliate one or more connectivity Alarm and Event OPC Servers to the 800xA system. • The Alarm Manager Service provides the alarm state machine • The Alarm Logger Service is a service which makes it possible to print the alarms or write them to file. • The External Alarm Service makes it possible to enable external alarms. 3BDS011222R4101 Section 2 Concepts Alarm and Event • The Soft Alarms Service is used for the Alarm Expressions and for Programmer API. • The System Message Service is used for system events and messages. As an operator, you can view alarms according to the selected filter and presentation settings or you can easily make changes. For example, a list can be sorted by double clicking on a head line, columns can be resized or they can be moved using drag and drop. Filtering and presentation functions let you view alarms in dedicated ways as well as monitor and maintain the plant in a more effective way. For example, a list can show all alarms or only those for the associated object and its descendants. A details page is also associated with each item in the alarms list. Alarm acknowledgment or silencing of local audible sounds is fast and easy. You can also acknowledge an alarm when it occurs on an object within graphics. Up to 1000 priorities can be defined with acknowledged and unacknowledged colors. An audible sound can be set to any file (in.wav format) and played once or until silencing. Date formats are selectable and time stamps can be generated (as from the controller). Customized set-ups can be used for other alarm lists. In a configuration with redundant alarm servers, a server that is starting up will be updated from controllers that support this function. You can access the alarm and event functionality as part of the configuration (Application Bar, Status Bar, display shortcuts) or through aspects selectable from a workplace. Typical of what you can do includes: • Alarm List - view current alarm status for all objects or for a particular set of object and descendants (optional) • Event List - view events • Alarm Acknowledge - you can acknowledge alarms from lists or from graphics displays or using the context menu Acknowledge verb • Alarm Band - view the number of Unacknowledged Alarms and use the button type link to the associated list view (commonly placed in the Application Bar) • The Sequence Bar is a status display, where the defined number of alarms is displayed horizontally • Message List - view selected categories of messages in a list type format 3BDS011222R4101 187 Alarm and Event Section 2 Concepts • Logging - printout alarms and or events to a dedicated line printer • Acknowledge security - set up security to allow and deny groups or users to acknowledge alarms • External Alarm - activate and deactivate an external alarm notification. Alarm Server and Storage The Alarm Server holds the Alarm Database, storing the current status of alarms for the objects accessed by the server. In other words, each process object added to your system automatically gets alarm information stored. Event Server and Storage The Event Server (system message server) holds the Event Database storing all process events that occur as well as all system messages including audit trail messages. By default the system message server holds approximately 6000 messages in a “circular” file but the size can be changed. Alarm Expressions The Alarm Expression is a useful tool to get information in an Alarm and Event list based on property values. You can define an expression related to a property value, which gives you a predefined message line in the list. Configuration is done via an Alarm Expression aspect in an Aspect Object associated to the property. If you have for example an OPC server without event handling, you easily can configure an alarm related to a special property value with help of the Alarm Expression aspect. External Alarm The External Alarm function provides aspect systems and components to make it possible to activate and deactivate an external alarm notification. The user of the external alarm selects an alarm list and a destination output in the configuration view. The alarm list filter is used to subscribe for alarms and events from the alarm and event server. Set and silence are done via Data Subscription to the destination output. When alarms fulfilling the filtering criteria are received by the external alarm function the destination output is set. The operator can silence the external 188 3BDS011222R4101 Section 2 Concepts Alarm and Event alarm through the silence view. Silence can be done for all configured alarms or for one explicit external alarm. Soft Alarms The Soft Alarms (COM-) component allows different applications to define alarm conditions and then associate these conditions with an Aspect Object to allow its state to be manipulated. The component implements an interface that it uses to list, define, update and manipulate the state of a condition. An application may select to define all its conditions when it starts (or reconnects to a Soft Alarms server) or to let the Soft Alarms service retain the condition definitions itself. The communication between the handler and the service is accomplished by use of the system module CSLib. The Soft Alarms service is also used as a provider for the Alarm & Event server. The Soft Alarms service will send alarms to the Alarm & Event server, which will broadcast them to its clients that has a subscription that matches the alarm. Alarm / Event User Interface Configuration You can reconfigure System 800xA Alarm / Event handling by changing the default presentation layouts or create new layouts in the Library Structure. The default layouts are: • Default Alarm Line (is used with the Alarm and Event List aspect, and sets the filter for alarm type messages and the columns, that is appropriate, for three lines of alarms) • Default Alarm List (is used with the Alarm and Event List aspect, and sets the filter for alarm type messages and the columns, that is appropriate, for 500 lines of alarms) • Default Event List (is used with the Alarm and Event List aspect, and sets the filter for event type messages and the columns, that is appropriate, for 500 lines of events) • Default System Event Line (is used with the Alarm and Event List aspect, and sets the filter for system type messages and the columns, that is appropriate, for one line of events) 3BDS011222R4101 189 Alarm and Event Section 2 Concepts • Default System Event List (is used with the Alarm and Event List aspect, and sets the filter for system type messages and the columns, that is appropriate, for 500 lines of events) • Default System Alarm List (is used with the Alarm and Event List aspect, and sets the filter for system type messages and the columns, that is appropriate, for 500 lines of System Alarms) • Default Logger Config (is used with the Alarm Logger aspect, and sets the filter for alarm type messages and the columns, that is appropriate, for alarms) • Default Operator Message Line (is used with the Alarm and Event List aspect, and sets the filter for operator type messages and the columns, that is appropriate, for one line of events) • Default Operator Message List (is used with the Alarm and Event List aspect, and sets the filter for operator type messages and the columns, that is appropriate, for 500 lines of events). • Default Audit List (is used with the Alarm and Event List aspect, and sets the filter and columns that is appropriate, for 100 lines of Audit (Trail) events). Among the things you can configure for each layout are: • filtering • included columns, their size and name • setting of presentation details, such as alarm color, date and time format • time range • sorting of the list • WAV file alarm annunciation for audible signaling of alarms by priority. Alarm / Event Service Configuration Some of the six system services (see Figure 58) for Alarm and Event found in the Service Structure need to be or can be configured. The services Alarm Logger, System Message, External Alarm and Soft Alarms do not need configuration. 190 3BDS011222R4101 Section 2 Concepts Alarm and Event For the Alarm Manager service you can configure the Service Group Definition aspect using the Special Configuration tab regarding Alarm Handling, Event Logging and Alarm Storage items. For the Event Collector service you have to configure the Service Group Definition aspect using the Special Configuration tab regarding OPC A&E Server and Collection Mapping (Collection Definition to use) items. Alarm / Event Overview - Controller If you use of the AC 800M connectivity of the 800xA system, then the alarms and events presented at the Operator workplace are generated from the AC 800M controllers. The principle that the alarms and events are generated from the controller applies for other tightly integrated controller series too. Alarms and events can be generated in the AC 800M controller in three ways: • By using objects based on library object types containing alarm and event functions, for example objects derived from the object types of ProcessObjExtLib or SignalLib. • By using objects especially made for alarm and event handling (based on object types in the AlarmEventLib) • By hardware units throughout the system (system alarms and events). The standard alarm functions delivered with the AC 800M controller product are packed in a library called AlarmEventLib. 3BDS011222R4101 191 Alarm and Event Section 2 Concepts The library comprises seven alarm/event Function Block Types and two Control Module Types provided to be used for implementation of alarm and event handling in control applications when not using objects that already include it. For available types see Figure 59. Figure 59. Object Types of AlarmEventLib Alarm and event handling on controller level based on objects of the AlarmEventLib library are described in detail in IndustrialIT 800xA - Control and I/O, Basic Control Software, Introduction and Configuration. The built-in alarm and event handling in Signal-, Process- and Control loop - object types of other standard libraries is based on the same principles as implemented by AlarmEventLib and is described in IndustrialIT 800xA - Control and I/O, Extended Control Software, Binary and Analog Handling. Inhibit and Disable Alarms and Events Sometimes there is a need for temporarily suspending alarm and event generation, for example to reduce an alarm flood. This can be done for all objects with built-in alarm handling: • 192 Disable – the alarm condition is disabled, no alarms and events are generated, nothing is logged, and no control action is taken (that is, the system does not act upon the alarm condition). 3BDS011222R4101 Section 2 Concepts • Alarm and Event Inhibit – the control action itself is inhibited (that is, the system does not act upon this alarm or event), while alarms and events are still logged and presented to the operator in the operator interface. Alarms and events can be disabled from the faceplate and from alarm list, as well as from the application, via interaction parameters. Figure 60 illustrates the difference between inhibiting and disabling an alarm. Figure 60. Disabling /Inhibiting Alarms Normally, the control action will be a boolean signal that causes a certain reaction, for example, a signal that stops a motor. However, a control action could also cause a more complex series of actions. Inhibit is only available in certain the object types. In a SIL application, alarms cannot be enabled or disabled via MMS. However, alarms can be disabled or enabled from the IEC-61131-3 code. 3BDS011222R4101 193 Alarm and Event Section 2 Concepts Set Up Alarm and Event Handling OPC Server Before alarms and events can be received, it is necessary to connect the OPC Server for AC 800M to the System 800xA Alarm and Event Server in the Connectivity Server node. You do this by configuring the Event Collector Service Group in the Service Structure of Plant Explorer. Note that the System 800xA Alarm and Event Server and the OPC Server must run in the same node. Alarm and Event Buffer Configuration The alarms from the process are stored in buffers in the controller(s) and then distributed to buffers in the OPC Server for further distribution to 800xA system (see Figure 61). 194 3BDS011222R4101 Section 2 Concepts Alarm and Event The figure illustrates a buffer configuration for a control system, where OPC clients have subscriptions on alarms and events from different OPC Servers. When a buffer is full, a System Simple Event is sent upward to 800xA system. All buffers are created in accordance with CPU and OPC Server settings. Figure 61. Example of a buffer configuration. When a buffer is full, a System Simple Event is sent upward to IndustrialIT System 800xA For more details on System 800xA Alarm and Event configuration see IndustrialIT 800xA - Operations, Operator Workplace, Configuration and Section 3, Configuration, subsection on configuration of Alarms and Events on page 375. 3BDS011222R4101 195 Alarm and Event Section 2 Concepts Alarm / Event Overview - Message Logging All alarm and event messages for the 800xA system, including Process, Operator, and Audit Trail messages, are collected and stored by the 800xA system´s System Message Server. This provides a short-term storage facility with the capacity to store up to 50,000 messages. The messages can be organized into filtered lists for viewing. This functionality is described in IndustrialIT 800xA - Operations, Operator Workplace, Configuration. If your system has Information Management History Services installed, the messages stored by 800xA system´s System Message Server may be forwarded to a History Services message log for extended on-line storage. This message log can store up to 12 million messages. In addition, with History Services you can consolidate messages from multiple servers onto a dedicated consolidation node, and save the messages on an archive media for permanent off-line storage. Figure 62. Alarm/Event Message Logging Overview History Services Message Log Overview Message logs store events and system messages that are generated by control and operator applications. Three types of message logs are available, depending on where the events occur and what functionality is needed: 196 3BDS011222R4101 Section 2 Concepts Alarm and Event • Alarms and events which are buffered in the 800xA system´s System Message Service may be forwarded to an OPC_MESSAGE log type. This type of storage is modeled after the data definitions in the OPC/Alarm and Event specification. This includes Audit Trail messages. The Audit Trail function tracks operator changes such as activating/deactivating historical logs, changes to production data, log configuration changes, and so on. The log stores the identification of the person that made the change, time that the change was made, previous and new value for the data being changed, as well as other information. • The PDLMSGLOG log type is a special implementation of the OPC_MESSAGE log type for storing batch events related to the Batch Management application. • The DCS_MESSAGE log type is provided to support consolidation of Advant OCS messages from earlier Enterprise Historian nodes (version 3.2/1 or earlier). Accessing Message Log Data The messages can be read via interactive dialogs in DataDirect and Desktop Trends. DataDirect also lets you specify re-executable functions for implementing reports.You can also access the data directly using SQL queries. For instructions and guidelines on using these tools, refer to the applicable section in IndustrialIT 800xA - Information Management, Configuration. Guidelines for Configuring Alarm/Event Logging The configuration and set-up requirements for message logs are listed and briefly described below. Detailed instructions are provided in the referenced documents. • Integrate message-generating applications with 800xA system´s System Message Server. • Configure the 800xA system´s System Message Server. • Configure message logs. • Configure consolidation for message logs. • Configure archival and off-line storage for message logs. 3BDS011222R4101 197 Alarm and Event Section 2 Concepts • Tune the interface for System 800xA and Information Management Message Services • Configure Oracle access for message logs. Integrating Message-Generating Applications Certain message-generating applications in the 800xA system, including History Services, Softpoint Services, and AC 800M, write their messages to the 800xA system´s System Message Server via application-specific OPC alarm servers. These application-specific OPC alarm servers must be added to the Alarm and Event Service Group for each connectivity server where the applications run. These Service Groups reside under the Alarm and Event Services category in Service Structure. This configuration should have already been done as part of the Information Management post-installation. Guidelines for verifying this configuration (or performing the configuration if not already done) are provided in IndustrialIT 800xA - Information Management, Configuration. Configuring Message Logs The operating parameters for a message log are specified in a Message Log object. A dedicated object is required for each message log that you need to configure. Typically, you only require one message log for each message log type you are using (OPC, PDL, or DCS). These Message Log objects must be added under a specific node in Node Administration Structure. Instructions are provided in IndustrialIT 800xA - Information Management, Configuration. Message Log Consolidation Alarm/event messages from multiple server nodes may be consolidated onto a dedicated consolidation node. This functionality is configured using the Scheduling Services and IM Consolidation action plug-in. Instructions are provided in IndustrialIT 800xA - Information Management, Configuration. 198 3BDS011222R4101 Section 2 Concepts Alarm and Event Off-line Storage All events and messages stored in a message log can be copied to an off-line storage media. How to configure this functionality is described in IndustrialIT 800xA Information Management, Configuration. Configuring Oracle Access for Message Logs Message log data is stored in an Oracle database. Client applications such as DataDirect and Display Services access Oracle-based History data, including message logs, via an ADO data provider named DBA. The data provider must be configured and must reside on the same node where the message logs reside. This configuration is performed as a post-installation procedure. You can verify the ADO data provider configuration via the ADSS Config tool in the Windows Control Panel. For details regarding configuration requirements, refer to the Information Management section in IndustrialIT 800xA - System, Post Installation Setup. 3BDS011222R4101 199 Alarm and Event Section 2 Concepts SMS and e-mail Messaging SMS and e-mail Messaging is a system extension to System 800xA. It provides a method for sending messages based on alarm and event information to user devices such as mobile telephones, e-mail accounts, and pagers. It is possible to control sending messages by configuring a message schedule for each user. The message schedule allows one active paging time interval for each day of the week. Figure 63 shows and Table 10 lists the three methods SMS and e-mail Messaging employs to notify users of alarm and event information. The table also lists the devices that are compatible with each notification method, and which devices, using the SMS/GSM notification method, allow the user to confirm receipt of the message back to the 800xA system. SMTP/EMAIL INTERNET SMS/GSM WIRELESS SERVICE PROVIDER (SHORT MESSAGE SERVICE CENTER, SMTP SERVER, CENTRAL PAGING TERMINAL) LAND TELEPHONE LINE TAP/MODEM TARGET DEVICE (MOBILE TELEPHONE, E-MAIL, PAGER) T05164A Figure 63. Notification Methods 200 3BDS011222R4101 Section 2 Concepts Alarm and Event Table 10. Notification Methods Notification Method Device1 SMTP/E-mail TAP/Modem SMS/GSM — — — Alphanumeric Pager Notify Notify Notify 2-Way Pager - Fixed Reply Notify Notify Notify 2-Way Pager - User Entered Reply Notify Notify Notify/Confirm Receipt 2-Way GSM Pager Notify Notify Notify/Confirm Receipt Text Messaging Enabled Telephone Notify Notify Notify/Confirm Receipt Wireless Equipped PDA Notify Notify Notify/Confirm Receipt E-mail Notify Numeric Pager Notify/Confirm Receipt NOTE: 1. This table lists the capabilities of SMS and e-mail Messaging. The selected hardware and/or service provider may impose other limiting factors. 3BDS011222R4101 201 Alarm and Event Section 2 Concepts The notification methods work as follows: 202 • SMS/GSM - uses Short Message Service (SMS), a service for sending short text messages to compatible devices, to send messages based on alarm and event information to the Global System for Mobile Communication (GSM) service provider’s Short Messaging Service Center (SMSC) over a wireless network. The SMSC sends the message to compatible devices of users configured to receive them. This method allows users of the compatible devices to confirm receipt of the message. • SMTP/Email - uses Simple Mail Transfer Protocol (SMTP), a protocol for sending e-mail messages between SMTP servers, to send messages based on alarm and event information to an SMTP server over the Internet. The SMTP server sends the message to e-mail accounts, or to compatible devices via e-mail accounts, of users configured to receive them. • TAP/Modem - uses Telocator Alphanumeric Protocol (TAP), a protocol for submitting requests to a pager service, to send messages based on alarm and event information to the pager service provider’s Central Paging Terminal over a land telephone line. The Central Paging Terminal sends the message to compatible devices of users configured to receive them. 3BDS011222R4101 Section 2 Concepts Alarm and Event A block diagram of SMS and e-mail Messaging is shown in Figure 64. ALARMS AND EVENTS PLANT OPERATIONAL STRUCTURES (FUNCTIONAL, LOCATION, CONTROL, ETC.) ALARM AND EVENT LIST ALARM AND EVENT MESSAGE SOURCE MESSAGE HANDLER USER STRUCTURE MESSAGE SUBSCRIBER MESSAGE SUBSCRIBER • • • MESSAGE SUBSCRIBER MESSAGE SCHEDULE MESSAGE SCHEDULE • • • MESSAGE SCHEDULE SMS/GSM, SMTP/EMAIL, TAP/MODEM SMS/GSM, SMTP/EMAIL, TAP/MODEM • • • SMS/GSM, SMTP/EMAIL, TAP/MODEM MESSAGE MESSAGE • • • MESSAGE USER DEVICES TO5061C Figure 64. Block Diagram The figure shows the data flow from the time the Alarm and Event List is notified of an event. SMS and e-mail Messaging consists of several components. When an alarm is generated, it is sent to the Alarm and Event List. An SMS and e-mail Messaging component, the Alarm and Event Message Source, monitors the Alarm and Event List associated with it. When it senses an event it formats a message (based on configured values) and sends the message to the Message Handler. The Message Handler sends the message to destinations (individual users or user groups) subscribed via the Message Subscriber. 3BDS011222R4101 203 Alarm and Event Section 2 Concepts The Message Schedule determines which users receive messages based on their schedule. If it determines a user is scheduled to receive a message via SMS/GSM, SMTP/Email, or TAP/Modem, the message is sent to that user. 204 3BDS011222R4101 Section 2 Concepts Fieldbusses / Field Devices Fieldbusses / Field Devices System 800xA gives you the choice to use and communicate with Field Devices from the device spectrum of • HART • PROFIBUS DP/PA • FOUNDATION FIELDBUS HSE/H1. Each of these important Fieldbus protocols is supported by System 800xA with a Device Integration Package: • HART Device Integration • FOUNDATION Fieldbus Device Integration • PROFIBUS Device Integration Each Device Integration Package provides the three components needed to run a field device in the 800xA system: • A Field Device Library consisting of Object Types for devices from ABB and third party vendors • A Fieldbus Management Tool for configuration, parametrization, commissioning and detailed diagnosis functions • A Fieldbus OPC-Server providing field device variables and status information to the Asset Optimization applications and the Operator Workplaces (only for FOUNDATION Fieldbus). Fieldbus Builder PROFIBUS / HART PROFIBUS is a standardized, open, digital communication system for all areas of application in manufacturing and process automation. The PROFIBUS Protocol is based in the international standards EN 50170 and IEC 61158. This technology is suitable for replacement of discrete and analog signals. PROFIBUS PA was explicitly specified for process automation. HART is a communication technology based on the conventional analog data technology 4...20 mA. HART defines the communication protocol between intelligent digital field devices and a control system. 3BDS011222R4101 205 Fieldbusses / Field Devices Section 2 Concepts Fieldbus Builder PROFIBUS/HART integrates the Field Device Tool / Device Type Manager (FDT/DTM) technology for intelligent field devices for PROFIBUS and HART into the 800xA system and allows the integration of devices from different manufactures and the two different fieldbusses into the system. An integrated OPC server provides for easy data exchange between field devices and applications of different manufacturers without special adjustments. The Fieldbus Builder PROFIBUS/HART supports the FDT 1.2 standard interface specified by the PNO (Profibus Nutzer Organisation [Profibus Trade Organization]). The FDT 1.2 specification describes the interface between the engineering tool and the device-specific software (DTM – Device Type Manager). A DTM is a component supplied by the device manufacturer of an intelligent field device. The DTM is familiar with the way the device works (plausibility), contains graphical user dialogs, manages device configuration and diagnostics, and supplies the device-specific documentation. Field devices provided with a corresponding DTM according to FDT 1.2 are enabled to be integrated into the 800xA system. The PROFIBUS and HART fieldbus protocols are currently supported. Fieldbus Builder PROFIBUS/HART provides the infrastructure in the 800xA system for configuration of and access to all PROFIBUS DP/PA and HART devices. Fieldbus Builder PROFIBUS/HART aspect system adds the following six aspect categories to the 800xA system: • Fieldbus Management • Device Definition • Device Management • Module Definition • Module Management • PROFIBUS Management Fieldbus Builder PROFIBUS/HART allows you to create field device object types as shown in Figure 65. 206 3BDS011222R4101 Section 2 Concepts Fieldbusses / Field Devices Figure 65. Creation of HART Field Device Object Types During engineering you can populate the 800xA system with device objects based on field device object types. You can do population using the Plant Explorer for single objects or using a Bulk Data Management worksheet for many objects. Allocation of the device objects to boards you can do in Plant Explorer, allocation of the HART device objects to channels of boards you can perform in the extended hardware topology of Control Structure in the Fieldbus Management aspect pane (see Figure 66) provided by Fieldbus Builder PROFIBUS/HART. These two allocations you can efficiently do using a Bulk Data Management worksheet for many objects. 3BDS011222R4101 207 Fieldbusses / Field Devices Section 2 Concepts Figure 66. Ext. Hardware Topology of Control Structure / Fieldbus Management Fieldbus Builder PROFIBUS/HART supports the following functionality at the extended hardware topology in the aspect pane of Fieldbus Management aspect: • Selecting an object/device in the hardware topology starts the corresponding DTM. • The selected DTM is supplied with instance data from the 800xA system. • Uploading / downloading the current DTM instance data • Managing the fieldbus structure for the HART field devices • Configuration and removal of the communication paths for online communication between the DTM and the physical field device in the system. Via the DTM the following functions for a field device can be accessible on the Device Management Aspect: 208 3BDS011222R4101 Section 2 Concepts Fieldbusses / Field Devices – Configuration – Parameterization – Diagnostics – Maintenance – Documentation Figure 67. Device Management / Diagnostics For the operator device functions as Online Parametrize, Force, Observe, Diagnosis, Online Compare can be available. 3BDS011222R4101 209 Fieldbusses / Field Devices Section 2 Concepts Basic configuration steps you find in HART Field Devices on page 435 and PROFIBUS Field Devices on page 474. For more information on support and configuration of PROFIBUS and HART devices see IndustrialIT 800xA - Fieldbus, Basic PROFIBUS DTM / PROFIBUS DTM Builder, Configuration, IndustrialIT 800xA - Device Management, PROFIBUS , Configuration, IndustrialIT 800xA - Fieldbus, Basic HART DTM / HART DTM Builder Configuration and IndustrialIT 800xA - Device Management, HART, Configuration. For HART and PROFIBUS asset monitoring functionality Asset Optimization Asset Monitoring functionality is required. Refer to the IndustrialIT 800xA - Asset Optimization, Configuration. Fieldbus Builder FOUNDATION Fieldbus FOUNDATION Fieldbus (FF) is a fieldbus protocol based on international standards and designed for applications in the manufacturing industry, process automation and buildings automation. The guidelines for this fieldbus standard are published by the Fieldbus Foundation. FF defines two communication profiles, H1 and HSE. The H1 profile is preferably used for direct communication between field devices in one link (H1 link). The HSE profile, which is based on standard Ethernet, serves first and foremost as a powerful backbone for the connection between H1 links, connected via FF linking devices. A FOUNDATION Fieldbus network (FF network) is linked with an AC 800M controller of an 800xA system via a optionally redundant FOUNDATION Fieldbus HSE communication interface module CI 860. This module is installed as an HSE host on the powerful HSE subnet. FF specifies a Standard User Application based on the concept of function blocks. This allows an automation task to be distributed to several FF devices. For this purpose, the Standard User Application defines the Function Block Application Process (FBAP). Using resource blocks (RB), function blocks (FB) and transducer blocks (TB) the automation task to be carried out is described. Additionally, the User Application also defines network management and system management. 210 3BDS011222R4101 Section 2 Concepts Fieldbusses / Field Devices Resource blocks describe general features of the device (device name, manufacturer ID, device type, serial number etc.). There is only one resource block in a device. Function blocks provide processing functions (analog input, PID controller, analog output etc.) within the field devices. Inputs and outputs of function blocks can be linked via the fieldbus. The time at which each function block is to be executed is specified exactly. The Fieldbus Foundation defines a set of function blocks (such as AI Analog Input, AO Analog Output, PID Control, etc.) known as the standard function blocks. Transducer blocks decouple the function blocks from local input/output functions of the sensor and actuator hardware. They contain, for example, information one calibration and sensor type. There is normally one transducer block for each input or output function block. Inputs and outputs from FF function blocks can be mapped to FF signals. FF signals enable the signal flow within the FF network. FF signals are transferred cyclically by means of the Publish/Subscribe communication mechanism. An FF signal has one and only one source which publishes the signal cyclically, and any number of sinks which subscribe the signal. For access from the AC 800M application, FF signals can be mapped to channels on the HSE host. In Control Builder M Professional I/O variables can be introduced for the channels of the CI 860 HSE host device configured by Fieldbus Builder FF. To configure the function block application process, Fieldbus Builder FF uses the FF Application, which is edited with the help of the FF Application Editor. The FF Application Editor is a graphical function chart editor that allows to handle FF Function Blocks and FF Signals connected by signal flow lines. 3BDS011222R4101 211 Fieldbusses / Field Devices Section 2 Concepts Figure 68. FF Application Editor Execution of the FF Applications is controlled by the H1 Scheduler. The graphical Schedule Editor of Fieldbus Builder FF allows to inspect and modify the automatically generated processing sequence. Fieldbus Builder FF provides the infrastructure in the 800xA system for configuration of and access to all FF devices. This includes an OPC Server for FOUNDATION Fieldbus (OPC Server FF) which makes data from FOUNDATION Fieldbus devices available to any desired OPC Client. As a result visualization packages which have an OPC Client interface, e.g. System 800xA, can access the data of the connected fieldbus devices. 212 3BDS011222R4101 Section 2 Concepts Fieldbusses / Field Devices Fieldbus Builder FF aspect system adds the aspect categories listed in Figure 69 to the 800xA system. The aspects are used in aspect objects of the kinds listed also in the first column of Figure 69. Figure 69. Aspects of Fieldbus Builder FF / Used in Objects Fieldbus Builder FF provides an H1 and HSE Device Library and a FF Block Library as Object Type Groups in the Object Type Structure. The structure of the FF device libraries in Object Type Structure of Plant Explorer corresponds to the structure of these libraries in Fieldbus Builder FF. The structure of the FF block library in the Object Type Structure of Plant Explorer essentially differs from the structure of this library in Fieldbus Builder FF in one 3BDS011222R4101 213 Production Management Section 2 Concepts point. In the Plant Explorer, an object type group for the function block type, under which both the corresponding standard function block type and the vendor specific function block types are arranged, takes the place of a standard function block in the block library of the Fieldbus Builder FF. For further configuration information on Fieldbus Builder FF see FOUNDATION Fieldbus Field Devices on page 498 and IndustrialIT 800xA - Device Management, FOUNDATION Fieldbus, Configuration. Production Management Production Management contains the Batch Management and Manufacturing Management functions. Batch Management Batch configuration is the process of setting up the batch process control system. The first step in configuration is planning. Process engineers list the functions of the (plant equipment) hardware used for batch processing. The engineers segment the process, breaking it into units and shared equipment modules (SEM). A unit performs a function, such as filling a tank or mixing ingredients. The equipment has 214 3BDS011222R4101 Section 2 Concepts Production Management the capability to execute phases identified in the procedure. An example of a process diagram displaying unit and SEM boundaries is shown in Figure 70. R AW M ATE R IA L S E M (R M ) FC T R AW M ATE R IA L 1 FI R AW M ATE R IA L 2 R AW M ATE R IA L 3 LI F E E D TA N K 1 E Q U IP M E N T (F T1) R AW M ATE R IA L 4 FE E D TA N K 1 P M IX F E E D E R 1 SEM (M X 1) LI FEED TA N K 2 P FC FI FI C ATC H TA N K 1 TC R E A C TO R 2 E Q U IP M E N T (R 2) LI TI LI R E A C TO R 1 FI SEE N O TE TI TC LI C ATC H TA N K 3 R E AC TO R 2 PI FI SEE N OT E PI P C ATC H TA N K 2 SEM (C T2) C ATC H TA N K 3 SEM (C T3) T R E A C TO R 1 E Q U IP M E N T (R 1) LI M IX FE E D E R 2 SEM (M X 2) FC T C ATC H TA N K 1 SEM (C T1) FE E D TA N K 2 E Q U IP M E N T (F T1) C ATC H TA N K 4 SEM (C T4) P LI LI C ATC H TA N K 2 FC FC FI T FI T FI C ATC H TA N K 4 FI P R O D U C T FE E D ER S E M (P F) N O TE : S TE A M LIN E S TO R E AC TO R ’S JA C K E T N OT S H O W N T03 459B Figure 70. Process Diagram Example A SEM also consists of hardware and software that work together to perform an operation. However, a SEM can not run phases, and there are no equipment phases associated with it. A SEM can be acquired by more than one unit, causing the batch manager software to treat it differently than a unit. An example of a SEM is a set of pipes that serve more than one tank. Once the process engineers have decided how the process will be organized, a name is assigned to and a corresponding configuration is created for all batch equipment in the controller. The equipment database contains information about the equipment, including what phases can be executed using each unit, the names of the parameters 3BDS011222R4101 215 Production Management Section 2 Concepts that would be used by the phases, and attributes of the equipment that may be needed when determining which will be used by a particular batch. A unit can be used by only one batch at a time. However, a SEM may be used by more than one batch simultaneously, depending on how it is defined in the equipment database. If the maximum number of users is one, the SEM is an exclusive use SEM. If two or more users can share it, the SEM is a shared use SEM. The equipment database can also contain definitions for pseudo equipment. Pseudo equipment can be some resource required for batch processing, even though the resource is outside the control system. There are no phases associated with pseudo equipment. A procedure can be configured to reserve use of pseudo equipment, preventing another batch from running simultaneously if both batches require the same resource. For example, a system can be configured so the pseudo equipment represents a human operator. Each unit must have an equipment phase logic associated with it residing in the controller. At run time, the names and parameters of the phase are downloaded to the controller by the batch manager. The process engineers write the equipment phase logic required to accomplish tasks using the unit. For example, equipment phase logic can: • Open valves. • Transfer raw material from a feed tank to a reactor. • Measure amount of material delivered to the reactor. • Close valves. Once the equipment database has been configured, the chemist or other product specialist can take over configuration. Procedures are created using graphical symbols that represent operations, phases, and batch manager actions. 216 3BDS011222R4101 Section 2 Concepts Production Management These symbols are combined into procedure function charts (PFC) as shown in Figure 71. A PFC is a flow chart that depicts the batch’s progress. Figure 71. Procedure Function Chart The main concept of procedure design in the batch manager is to create procedures out of reusable components. The process engineer configures phases that perform certain tasks such as moving material from a feed tank or heating a reactor. The product specialist can use these phases repetitively in a variety of combinations. In addition, the PFCs representing procedures can themselves be reused (alone or inside another procedure). At run time, a selected master recipe is copied to be used as a control recipe. The appropriate phase parameter values are passed to the equipment phases in the controller subsystem. 3BDS011222R4101 217 Production Management Section 2 Concepts Manufacturing Management Manufacturing Management is an optional component to a 800xA system that provides collaborative production management capabilities. It automates, monitors, controls, and documents quality system requirements (cGMP) compliance for manufacturing processes in FDA-regulated industries. It manages raw materials, equipment instructions, and production procedures used in manufacturing. The Manufacturing Management functionality allows the specification of these materials, instructions, and procedures. The system ensures that the manufacturing process conforms to the procedures to yield consistent results. Manufacturing Management configuration is a multi-step process: 1. General administration and configuration 2. Inventory configuration 3. Quality configuration 4. Operation configuration 5. Weigh and Dispense configuration These configuration steps are defined in more detail later in this document, see Manufacturing Management on page 532. 218 3BDS011222R4101 Section 2 Concepts Information Management Information Management The whole set of information management functionality of System 800xA is provided by functions of the functional areas Information Management and Engineering and the basic functions of System 800xA. • Collection, storage and presentation of Historical Process Data • Access and storage of Extended Configuration Data • Access and management of dynamic Documents • Access to non-dynamic documents or applications using Information Access aspects. Historical Process Data Historical process data collection refers to the collection and storage of numeric values from aspect object properties. It may be implemented on two levels in the 800xA system. The basic offering supports short-term data storage via trend logs, see Trend Log Configuration. When the Information Management History Server function is installed, long-term storage and permanent off-line storage (archive) is supported via history logs, see History Log Configuration. The basic trend logging function then may be integrated with the Information Management History Server to implement historical process data collection using history logs. Trend Log Configuration Two aspect categories are used to configure trend logs: Log Template and Log Configuration. The Log Template defines how to log and the Log Configuration is used to produce a log for every object you would like to log. The Trend Aspect System, which is used to display trends, interact with the Log Configuration to retrieve information about the logs that exists for an object. 3BDS011222R4101 219 Historical Process Data Section 2 Concepts Historical data is stored in logs. Each data source requires its own log. See Figure 72. Figure 72.Historical Data The Data Source can be an OPC object or a Control Connection Specific Collector. The Data Collection contains common information for the log. The Log is normally stored on hard disk in one server connected to the Control Network. All logs are circular, which means the oldest Data Entry is overwritten by the newest when the whole Log Capacity is used. Log data can not be archived. You build hierarchical logs where it is possible to chose between a lot of log algorithms (Aggregates) for all logs with a log as source. There is no virtual limit on hierarchical levels. See example Figure 73. Figure 73.Example of Log Hierarchy 220 3BDS011222R4101 Section 2 Concepts Historical Process Data The History service can be distributed among different service groups. The History Source aspect is used to specify which service group to use for a set of log configurations. For more information see the manual IndustrialIT 800xA - System, Operator Workplace Configuration. To obtain the best possible logging performance you should follow the guidelines given in the respective Connect or 3:rd party OPC Server instructions. A Log Template is a re-usable template for building many similar logs. If you modify an existing Log Template, the changes will affect existing logs that has been created using that Log Template. The History Source aspect is used to define the service group that shall handle a subset of logs, i.e. the Log Configurations on all child objects. This functionality enables distribution of the History Service among the service group in the system. It is for example possible to have one group handling one control network and another handling another control network. Log Configuration aspects are placed on the object that should be logged. More information on History configuration you find in IndustrialIT 800xA Operations, Operator Workplace, Configuration. Trend Configuration The Trend System displays history data graphically. The history data and run-time data are seamless integrated. The data can be displayed as traces or as XY- plot. 3BDS011222R4101 221 Historical Process Data Section 2 Concepts A Trend Display example is shown in Figure 74 below: Figure 74.Trend Display Example The Trend Aspect System defines two Aspect Types, the Trend Template and the Trend Display. A Trend Template is a re-usable template for building many similar Trend Displays. If you modify an existing Trend Template, the changes will not automatically affect existing Trend Displays that has been created using that Trend Template. Settings that are affected are those that you can not change in your existing trend display such as number of areas and configurable rows, trace colors and Hide/Show Table. Still it is possible to fetch the Trend Template changes to the Trend Display. In the Config View of a Trend Display you select which Trend Template to use. There are three different aspect categories of Trend Displays, the Object Trend, the Operator Trend and the Trend Display. The differences between the three categories of Trend Displays are the privileges required to modify them. • 222 Object Trend - require software engineer privileges to be modified. 3BDS011222R4101 Section 2 Concepts Historical Process Data • Operator Trend - require operator privileges to be modified. • Trend Display - require application engineers privileges to be modified. More information on Trend configuration you find in IndustrialIT 800xA Operations, Operator Workplace, Configuration. History Log Configuration Process data collection includes properties for live process data, softpoint data, and lab data (programmatically generated, or manually entered). This functionality is supported by property log objects. This section describes how the basic trend logging function may be integrated with the Information Management History Server to implement historical process data collection using history logs. Log Overview logs typically collect synchronous (periodic) data from properties that represent real-time process measurements. Logs may also collect asynchronous data that is input manually (lab data), or synchronous data generated by a user program. To implement process data collection you must first create one or more History Log Templates in the Library Structure. Each template serves as a model for a specific data collection function such as the one shown in Figure 75. The template defines a log hierarchy where component logs provide different views of the historical data. Actual logs are instantiated within a Log Configuration aspect, based on a specified History Log template. The Log Configuration aspect is added to the object whose property values you want to collect, typically in Control Structure. One log is required for each property whose values you want to collect. The Log Configuration aspect will support as many properties and as many logs as required for the object. Therefore, it is recommended that you create just one Log Configuration aspect for an object. If you choose to create more than one Log Configuration aspect for an object, there is a restriction that all logs for a given property must be in the same Log Configuration aspect. The first component log inserted within a log hierarchy must be a trend log1, and it must be inserted as a direct log type. This direct trend log collects directly from an 3BDS011222R4101 223 Historical Process Data Section 2 Concepts OPC data source and resides on the connectivity server local to the data source. It supports short term trend viewing and data storage. This log should be configured to store data for a time period that is slightly greater than the time the History Server may go off line. This will allow the history log to back fill data that was collected by the trend log while the History Server was off-line. The trend log also supports redundancy when parallel connectivity servers are configured. The Information Management History Server function lets you connect history logs in hierarchical fashion to the direct trend log. These history logs support long term storage, historical data consolidation, and off-line storage. The first hierarchical history log that collects directly from the direct trend log is referred to as the primary history log. If you have additional history logs connected to the primary history log, those logs are referred to as secondary history logs. For example, in Figure 75, the trend log stores high resolution data for a short time span, while the history log stores the same high resolution data for a much longer time span. Figure 75. Example, Log Hierarchy 1. 224 The one exception to this rule is when you create a log to collect historical data from an earlier platform such as an Enterprise Historian with MOD 300 or master software. 3BDS011222R4101 Section 2 Concepts Historical Process Data As an option you may configure a dual log where the same trend log feeds two history logs on two different history server nodes, Figure 76. This may be required when your application cannot wait for history data to be back-filled in the event that a history server goes off line. For example, you may require shift reports to be executed at the end of each 8-hour shift, and cannot wait days or weeks for the data to be back-filled. Figure 76. Example, Dual Log Configuration Information Management History Server Functions The following sections provide a brief overview of the extended historical collection and storage functionality supported by history logs: • Blocking and Alignment on page 226 • STORE_AS_IS - Data Compaction on page 226 • Event Driven Data Collection on page 227 • Consolidation on page 228 • Lab Data Logs for Asynchronous User Input on page 229 • Calculations on page 230 • Considerations for Oracle or File-based Storage on page 231 3BDS011222R4101 225 Historical Process Data • Section 2 Concepts Off-line Storage on page 231 Blocking and Alignment You can configure a Sample Blocking Rate for the primary history log. This allocates a buffer in the collection function to hold the blocking rate worth of samples before applying a calculation and (if applicable) deadband algorithms and sending the samples to storage. The blocking rate can be used to optimize performance by phasing the rate at which numeric data is collected from the trend log, and phasing the writing of historical data to disk. STORE_AS_IS - Data Compaction STORE_AS_IS is an option in the Calculation Algorithm section on the Data Collection tab of the Log Configuration aspect. For OPC type logs, this calculation lets you use the OPC server’s exception-based reporting as a deadband filter. This effectively increases the log period so the same number of samples stored (as determined by the log capacity) cover a longer period of time. When collecting from an OPC/DA source, OPC returns data at the subscription rate, only if the data is changing. For all calculations other than STORE_AS_IS, if data is not changing and samples are not being received, History will insert previous values with the appropriate time stamps. This is required for calculations to occur normally. With STORE_AS_IS, no other calculations are performed (including INSTANTANEOUS); therefore, data does not need to be stored at the specified sample rate. Samples will only be recorded when a tag’s value changes, or at some other minimum interval based on the log configuration. STORE_AS_IS also lets you implement data compaction on the collection node, before data forwarding to the consolidation node. This saves disk space on the collection node. When data forwarding deadbanded data to a consolidation node, you must use STORE_AS_IS rather than INSTANTANEOUS as the calculation algorithm for the hierarchical log on a consolidation node. 226 3BDS011222R4101 Section 2 Concepts Historical Process Data Event Driven Data Collection Data collection for property logs may be event-driven. The event which triggers data collection is specified as a job description object configured via the Scheduling Services, and an attached Data Collection Action aspect. TCP/IP must be enabled for OMF if you intend for the job to trigger data collection for logs on a different History server. This setting is configured via the Communication Settings dialog. To check, launch this dialog, from the Windows task bar. Choose Start>Programs>ABB Industrial IT>System Services> Settings>Communications. For further information, refer to the appendix on extending the OMF domain to TCP/IP in IndustrialIT 800xA - Information Management, Configuration. The property log is configured much like any other property log. The only special requirements when configuring the log for event driven data collection are: • The direct trend log must always be active in order to collect data before the event actually triggers data collection. • The event-driven log must be a history log, and it must be the primary (first) log connected to the direct trend log, Figure 77. This log must be configured to start deactivated. The log will go active when the event trigger occurs. Figure 77. Example, Event-driven Data Collection 3BDS011222R4101 227 Historical Process Data • Section 2 Concepts Logs that reside on a consolidation node cannot be event-driven. Consolidation Data from property logs on history server nodes in different Aspect Systems may be consolidated onto one central consolidation node as illustrated in Figure 78. Also, property logs can be configured to collect from pre-existing History logs that are part of an earlier Enterprise Historian system. This lets you integrate historical data from earlier systems into the consolidation node. Figure 78. Example - Consolidating Property Log Data 228 3BDS011222R4101 Section 2 Concepts Historical Process Data Setting up Historical data consolidation is a three-step process (or four-step when consolidating from the Enterprise Historian 2.2 HP-UX platform): • Interaction between two or more History nodes (as is the case with historical data consolidation) requires the OMF domain to be extended to TCP/IP. This must be done prior to performing the other steps described in this section. For details, refer to the appendix on extending the OMF domain to TCP/IP in IndustrialIT 800xA - Information Management, Configuration. • This step is only required when consolidating logs from the Enterprise Historian 2.2 (HP-UX) platform. In this case you must execute a script to create an ocshis user (within Oracle) and corresponding synonyms on the HPUX-based Enterprise Historian node. • The log configurations on the nodes from which historical data is being consolidated must be imported to the consolidation node. This prerequisite step does not establish historical data collection and storage on the local (consolidation) node for the imported logs. The Log Configuration aspects created as a result of this step merely provide a window for viewing the historical data stored in the log configurations on the remote nodes. The History Access Importer used in this procedure is available via the Windows task bar. To access this tool, the IM 3.5 Importer Link must be present in the History Service Group for the consolidation node. This link is typically added as a post-installation step as described in IndustrialIT 800xA System, Post Installation Setup. • To establish local data collection and storage on the consolidation node for the imported logs, you must create a second set of Log Configuration aspects on the consolidation node. Lab Data Logs for Asynchronous User Input The lab data log is a special type of property log. This log type is used to collect asynchronous data entered manually, or by an external application such as a User API program. Lab Data logs are added in the property log hierarchy at the same level as direct logs. You can add a lab data log as a trend log, or as a history log linked via the IM 3.5 Collector. The applicable configuration tabs will be displayed accordingly. The 3BDS011222R4101 229 Historical Process Data Section 2 Concepts source field is disabled since this is not applicable for lab data logs. You can add a Lab Data log alone, or as part of a log hierarchy with a direct log, Figure 79. When configured with synchronous logs, the asynchronous log does not receive data from the data source. The connection is only graphical in this case. Figure 79. Representation of Lab Data Log in Property Log Hierarchy When configuring a history-type lab data log, most of the tabs specific to Information management history are not applicable. Calculations Although both trend and history logs let you perform calculations on collected data prior to storage, it is generally recommended that you collect and store raw data, and then perform the required calculations using the data retrieval tool, for example, DataDirect. Seamless Retrieval Seamless retrieval makes it easier for applications to access historical data. For trend data representation, when scrolling back in time beyond the capacity of the specified 230 3BDS011222R4101 Section 2 Concepts Historical Process Data log, the seamless retrieval function will go to the next (secondary) log in the log hierarchy. Applications do not need to know the name of the log in order to retrieve data. Attributes such as access name (data source), log period, calculation algorithm, and retrieval type can be specified and History will search for the log which most closely fits the profile. Considerations for Oracle or File-based Storage Log entries can be stored either in Oracle tables or directly in files maintained by History. File storage is faster and uses less disk space than Oracle storage. Filebased storage is only applicable for synchronous property logs. There are five filebased storage options as well as the Oracle storage option: • TYPE1 - File-based storage, 24 bytes per entry. Full status data for each entry. This type supports collection for floating point data only. • TYPE2 - File-based storage, 4 bytes per entry. Partial status data for each entry. This type supports collection for floating point data only. • TYPE3 - File-based storage, 8 bytes per entry. TYPE3 is identical to TYPE2, except that an additional 4 bytes are required per entry. This additional storage space supports precision time stamps. • ORACLE - Storage in Oracle tables. This is mandatory for Asynchronous logs. This type supports collection for floating point data only. • TYPE4 - Profile data (not applicable for this release of History Services • TYPE5 - File-based storage, variable size based on the type of data being collected. Off-line Storage All process data stored in a property log can be copied to an off-line storage media. This is described in Archive Function Overview on page 237. Presentation of Historical Process Data Data Presentation in trend format is supported by Operator Workplace trend displays, Desktop Trends, and trend displays built with Display Services. These 3BDS011222R4101 231 Historical Process Data Section 2 Concepts displays are simple graphs of process variables versus time, as shown in Figure 80. All analog and digital attributes recorded in History can be trended. Trend sources can be changed and multiple trends can be displayed on one chart to compare other tags and attributes. Stored process data may also be viewed in tabular format in Microsoft Excel using DataDirect add-ins. Figure 80. Historical Data on a Trend Display History Configuration Guidelines Detailed instructions for configuring process data collection and storage for your system are provided in the section on configuring property logs in IndustrialIT 800xA - Information Management, Configuration. The sections below provide a quick overview of the procedures involved • 232 Configuring Node Assignments for Property Logs on page 233 3BDS011222R4101 Section 2 Concepts Historical Process Data • Features for Optimizing CPU and Disk Usage on page 236 • Allocating Disk Space for File-based Logs on page 237 • Configuring History Objects - Procedural Overview on page 237 Configuring Node Assignments for Property Logs The trend logs and history logs use different methods to establish their respective node assignments (on which node each log will reside). For history logs, the node assignment is established by selecting the node’s History Service Group when the log is added to a property log template. For trend logs the node assignment is established when the Log Configuration aspect is instantiated on an object, for example a Control Application object in Control Structure. When this occurs, the Log Configuration aspect looks upward in the object hierarchy to find and associate itself with the first History Source aspect it encounters. The History Source aspect points to a History Service group on a specified Connectivity Server. To ensure that logs are assigned to the correct nodes, you must add one or more History Source aspects in the applicable structure where the log configuration aspects will be instantiated. This must be done before the logs are activated and historical data collection begins. When you do this you must take care to situate the History Source aspects such that each log will find the History Source that points to its respective Connectivity Server. Two examples are illustrated in Figure 81 and Figure 82. Figure 81 shows an example where all logs are to be associated with the same Connectivity Server. In this case, only one History Source aspect is required, and it should be placed near or at the top of the applicable structure, for example, at the root. 3BDS011222R4101 • Logs will not run without being associated with a History Source aspect. • History Source aspects must be placed in the same structure where log configuration aspects are to be instantiated. • Add History Source aspects as early as possible in the engineering process. If you need to update the History Server for a Service Group, the change can take long time for large configurations. All logged data will be lost during change of Service Group for affected log configurations. 233 Historical Process Data Section 2 Concepts Figure 81. Using One History Source 234 3BDS011222R4101 Section 2 Concepts Historical Process Data In Figure 82, the property logs for Control Applications 1 and 2 must reside on different Connectivity Servers. This is accomplished by adding a History Source aspect to each of the Control Application objects. Figure 82. History Source Associations The History Source aspect must be configured to point to the History Service Group for the same node where the OPC Data Source aspect points. This is illustrated in Figure 83. 3BDS011222R4101 235 Historical Process Data Section 2 Concepts Figure 83. Example, History Source Configuration Features for Optimizing CPU and Disk Usage How you configure certain data collection and storage parameters directly affects CPU load and disk usage. If you need to optimize CPU load and disk usage, consult the configuration guidelines in IndustrialIT 800xA - Information Management, Configuration before you begin configuring logs. 236 3BDS011222R4101 Section 2 Concepts Historical Process Data Allocating Disk Space for File-based Logs You may need to expand storage capacity for file-based logs (Storage Type = TYPE1 - TYPE5). This involves specifying the directory (or disk), and how much of the disk is to be allocated to History. You must allocate disk space BEFORE you create any file-based logs. Do this online via the Directory Maintenance History Utility. Configuring History Objects - Procedural Overview You can configure property logs on-line using the Plant Explorer Workplace, or offline via the Bulk Log Configuration Import/Export utility. The Plant Explorer Workplace provides a graphical user interface for history configuration. The Bulk Log Configuration Import/Export utility lets you use Microsoft Excel to create a list of object properties, and then match object properties with their respective log templates. This method is much quicker than using the Plant Explorer when you have a large number of object properties that will use the same log template. You must use the Plant Explorer to configure all other History objects. This includes archive devices and archive groups (if using archive functionality), message logs, report logs, and log sets. You must also use the Plant Explorer to create log templates. You can then use the log templates with the Bulk Log Configuration Import/Export utility to instantiate log configuration aspects on their respective objects. After you have created the supporting History objects required by your application, build the basic property log structures to be used as templates for your property logs. Finish the remainder of your History database configuration using the Bulk Log Configuration Import/Export utility. Archive Function Overview Archive is an Information Management function which supports permanent off-line storage for: • numeric process data stored in history logs. • finished reports scheduled and executed via Scheduling Services, and stored in report logs, or stored as FileViewer aspects. 3BDS011222R4101 237 Historical Process Data Section 2 Concepts • production data from batch control applications stored in Production Data Logs (PDLs). • alarm messages, event messages (including audit trail events), and system messages generated by 800xA system applications and stored in message logs. When a history log becomes full, the oldest entries will be overwritten by newer entries. With archiving, the contents of specified logs are copied to a designated archive media to prevent the loss of critical historical data. Two types of archive media are supported: • a single Magnetic/Optical (MO) disk - With this media, MO platters must be removed and replaced as they become full. • hard disk - The hard disk may be partitioned into multiple volumes which are sized to match CD ROM or DVD media. The archive backup function may be set up to write the contents of archive volumes to ISO Image files as volumes become full. The ISO image files may be burned onto CD ROM or DVD media for permanent storage. As files are saved on the CD or DVD media, the file copies on hard disk must periodically be purged to make room for new archive entries. As an alternative, you may specify the archive backup function to create shadow copies of filled archive volumes on network file servers. You may use both ISO image files and shadow copies. Archive Configuration Archiving is managed by one or more archive device aspects which are configured in Node Administration Structure. An archive device is a logical entity that defines where and how archive data is written. Every MO or disk drive used for archiving must have at least one archive device aspect configured for it. A single drive may have several archive device aspects configured for it to satisfy several different archive requirements. For example, more sensitive data may be archived through a separate device which is configured to prevent automatic overwriting of stored data. Archiving may be scheduled to occur on a periodic or event-driven basis through the Scheduling Services, or you may execute manual archive operations on demand. Scheduled archiving is implemented through archive groups. These are user-defined 238 3BDS011222R4101 Section 2 Concepts Historical Process Data groups of logs which are archived together as a single unit. One archive operation for logs in an archive group is called an archive entry. Scheduling parameters are specified within job description objects created in Scheduling Structure. The schedules are associated with their respective archive groups through an archive action aspect attached to the job description object. Manual archiving may be done on an ad-hoc basis (selecting the logs to archive on demand), or on an archive group basis. Accessing Archived Data Archive volumes support viewing of archive data (through the corresponding archive volume aspect). The MO media has one archive volume. You can partition the hard disk media into any number of archive volumes. Archive volumes are automatically created for all removable disk drives (DVD and CD drives) to support viewing of archive data on DVDs and CDs which contain archive files. Further, you can create additional read-only volumes for reading archive volumes that have been copied to a mapped network drive, or for viewing archive files that have been copied to the local drive. Archived historical data may be viewed via desktop applications such as DataDirect, Desktop Trends, and Operator Workplace tools. Archived data may also be incorporated into reports which are created with a report building package such as DataDirect or Crystal Reports, and then scheduled and executed via the Scheduling Services. In order for client applications to access archived log data, the archived logs must be restored from the archive media to the restored history database, or the applicable archive volume must be published. The method you use depends on the log type. Oracle-based log types (reports and PDL) must be restored. This writes the archive data to Oracle tables in the restored history database where tools such as DataDirect, Desktop Trends, and Crystal Reports can access the data. For numeric (property) logs, the archive volume where the archived data resides must be published. The contents of a complete volume, or even multiple volumes can be published in relatively few steps. This method does not require the archive data to be written to Oracle tables in the restored database. Since Oracle tablespace is limited, the publishing method lets you expose a larger amount of archive data for client applications at any one time. 3BDS011222R4101 239 Extended Configuration Data Section 2 Concepts Message log data stored on the published volume is also published. This lets you access the message log data via alarm/event lists configured in the Operator Workplace. Archive message logs must be restored if you want to access the archive data via the SQL-based tools in DataDirect, Desktop Trends, and Crystal Reports. Planning for Reliable Archive Results Occasionally, one or more scheduled archive operations may be missed due to the storage device being full, or hardware failure. This produces an accumulation of data to be archived until a successful archive operation occurs. This accumulation may eventually exceed the capacity of the archive media. You can reduce the risk of this occurring by configuring your archive device and archive groups according to the guidelines described in IndustrialIT 800xA - Information Management, Configuration. Archive Topics Instructions for configuring and managing the archive function are provided in the following books: • For planning and configuring the archive function, refer to the section on archiving in IndustrialIT 800xA - Information Management, Configuration. • For managing and maintaining archive data, for example invoking manual archives, removing/replacing platters, or purging archive data from the disk drive, refer to the section on managing archive operations in IndustrialIT 800xA - Information Management, Operation. • For viewing archive data, or integrating archive data into reports, refer to IndustrialIT 800xA - Information Management, Operation. This book also provides instructions for restoring/publishing archived data. Extended Configuration Data During engineering and operation of an automated plant in many cases storage and access to additional informations of different kinds is required. Examples of such informations are parameters for solutions, product and physical device informations or process or laboratory informations originating from foreign systems or products. 240 3BDS011222R4101 Section 2 Concepts Extended Configuration Data System 800xA gives you various possibilities to integrate these informations into the plant model of your system for easy access via Plant Explorer and from Aspect Systems. Parameter Management With Parameter Management you can flexibly create own aspect categories to hold engineering and configuration informations and complementary object or aspect informations for operation. Parameter aspects provide these data for data sharing via property references, AESPropertyTransfer aspects or programmatic use and for access using Bulk Data Management. Note that Bulk Data Management stores data in Excel files (.xls) only,while Parameter Management uses a relational database for storage of data. Parameter aspect property data and the parameter aspect category definitions are stored in a Microsoft SQL Server 2000 Desktop Engine data base. If you need to extend existing aspect categories these extensions are propagated to the existing instances. You can define parameter aspect categories of several kinds: • Table-like (containing non-structured properties) • Structured (containing structured properties) • Extendable (allows to introduce instance-specific properties) • Customized (mixture of structured and extendable) For the properties you can configure default values, pick lists, validation rules, units and number of digits. Expressions and property references can be used to provide the property value. Data types supported are: Bit, datetime, decimal, float, integer, nchar, nvarchar, smallint, uniqueidentifier. Besides support for aspect category definition Parameter Management gives you support for entering, modifying and storing dedicated data into properties of aspect instances of these categories. You can view and enter data of one Parameter aspect in the aspect pan. To view and edit parameter aspects and their properties in bulk, Parameter Management interfaces via the Open Properties context menu item to a pre-configured Bulk Data Management Excel worksheet. Here you can configure 3BDS011222R4101 241 Extended Configuration Data Section 2 Concepts and apply filters to filter out corresponding sets of Parameter aspects. In this way it is also possible to use Bulk Data Management to configure and produce reports of Parameter aspect data. Of course you can configure your specific Bulk Data Management worksheets to import and enter data to Parameter aspects. Changes to Parameter aspect properties can be audit trailed with old and new value. Parameter aspect properties data are available for all System 800xA clients such as Graphics, Trends and OPC clients. This means that you can present them in Graphics, in Trends and in Reports. Via property references the property values can be used as parameters in aspects of other Aspect Systems. Property references can be made to properties of parameter aspects in the same or in other Aspect Objects. To transfer the property values of a Parameter aspect to the properties of another aspect in an object automatically, you can configure a corresponding AESPropertyTransfer aspect. For example, you can configure a Control Module object type that gets its instance specific initial values and variable connections from the contents of a corresponding Parameter aspect. If you have created the instances, for example using a Bulk Data Management worksheet, the Control Properties aspects can already hold property references transferred during instantiation by AESPropertyTransfer aspects. After you have imported, entered or changed the variable names and initial values in the Parameter aspects data base you transfer them to the Control Properties aspects just executing Update References on the Action Tab of the Control Properties aspect on Application level. The pre-configured aspect category examples DriveSpecification and TagData allow you to explore working with Parameter aspects and corresponding document templates DriveSpecification and TagSheet. They show how you can include physical device information into the system. Parameter Management has been combined with Document Management to one system extension due to the fact that both tools share the same Microsoft SQL Server 2000 Desktop Engine data base, flexible category definition functionality and common user interface parts. 242 3BDS011222R4101 Section 2 Concepts Extended Configuration Data Basic configuration steps for Parameter Management you find in Parameter Management on page 537. Parameter Management is further described in IndustrialIT 800xA - Engineering, Engineering Workplace, Basic Engineering Functions manual. General Properties Aspects of the General Properties aspect category can also be used to store engineering and configuration data, but the focus is on complementary object or aspect informations for operation. The main differences to the Parameter Management aspect categories are: • No category support, only templates. If you need to extend existing aspect categories these extensions are not propagated to the existing instances. • The data is not stored in a database but in the aspect directory. • Property configuration and property value entry support is more limited. • Support of structured data does not reach the functional level of Parameter Management aspects and their Bulk Data Management based user interface. The General Properties aspect is useful for storage of data of any kind such as integer, real, boolean and string formats. Current main usage of General Properties is to store Industrial IT product certification data. General Properties are available for all System 800xA clients such as Graphics, Trends and OPC clients. This means that you can present them in Graphics, in Trends and in Reports (through the OLE DB provider). General Properties can be configured using Bulk Data Management Excel worksheets. Softpoint Services SoftPoint Services lets you configure and use internal process variables not connected to an external physical process signal. Once configured, the softpoints may be accessed by other information management applications as if they were actual process points. For example, softpoint values may be stored in property logs in History Services. Reporting packages such as Crystal Reports may access 3BDS011222R4101 243 Extended Configuration Data Section 2 Concepts softpoints for presentation in reports. Also desktop tools such as Desktop Trends and DataDirect can read from and write to softpoints. Softpoint alarms can be configured and are directly integrated with system alarms and events. Engineering unit definitions for softpoints include minimum/maximum limits and a unit descriptor. The Softpoint Services software may run on any number of servers within an Aspect System. Each Softpoint Server can have up to 2500 softpoint objects. Each softpoint object can have up to 100 signals; however, the total number of signals cannot exceed 25,000. Data types supported are: Boolean, integer (32bit), single precision floating point (32 bit) and string. Also, double precision floating point (64 bit) is supported as an extended data type. For details on Softpoint services see IndustrialIT 800xA - Information Management, Configuration. Calculations Calculations Services lets you configure and schedule calculations for aspect objects. Typically calculations are applied to real-time database objects, including both softpoints and actual process points. Calculations may also be applied to object types. This lets you re-use the calculation each time a new object is instantiated from the object type. Calculations can be triggered by changes to the inputs, or be scheduled to execute cyclically or at a given date and time. A calculation aspect may be applied to any aspect object such as a unit, vessel, pump, or softpoint. Inputs can be any aspect object property, and outputs can be any writable point in the system. Input/output definitions can be made relative to the object for which the calculation is defined. Data quality and alarm generation are supported. Calculation logic is written in VBScript. For details on Calculations services see IndustrialIT 800xA - Information Management, Configuration. 244 3BDS011222R4101 Section 2 Concepts Documents Documents During engineering and operation of an automated plant many documents are required to be available and accessible. Examples of such documents are functional descriptions, specifications, data sheets, tag sheets and memos. System 800xA gives you various possibilities to integrate these documents into the plant model of your system for easy access via Plant Explorer. Document Management With Document Management you can configure your Microsoft Word and Excel documents and your AutoDesk AutoCad drawings to be dynamic documents, containing up to date information of Aspect Object properties. Other file based documents (for example .PDF files of Acrobat Reader) and Web pages or html documents are supported as non-dynamic documents. The documents can have meta data (administrative data like title, author, status, creation date, etc.) which are stored in a relational database based on Microsoft SQL Server 2000 Desktop Engine. This functionality supports you in managing large amounts of documents in an automation plant. Document Management provides the Aspect Categories Document and AutoCad_Drawing. It further provides a collection of document file and folder template examples in the Library Structure. The top object of this collection is named Document Manager Templates. Document file templates are applicable to create new documents, document folder templates allow to include a set of document files into one aspect with one file to be displayed by default. You can extend the given collection of templates by creating own templates. You can introduce a document file for an aspect of category Document or AutoCad_Drawing by creating it new from a template file, copying it from an existing document file or by referencing an existing document file. You can also configure a Document Aspect to display a referenced Web page using a URL. Using the Document folder template feature you can configure a Document aspect to display the contents of a Web folder, for example a Microsoft Powerpoint slide set saved as .htm/.html file. 3BDS011222R4101 245 Documents Section 2 Concepts Dynamic Documents To make a document dynamic you have to insert property references pointing to the properties of interest. The property references are handled bi-directional: If you open or refresh the document the actual values of these properties are read and shown in the document. If you change the values in the document (provided you have the permission to do so and the document is not read only) the new values are written to the properties. For Microsoft Excel documents (including the Bulk Data Management functions) additionally you can configure property references that subscribe for live property data (for example process values) and auto-update data areas. The latter functionality provides tabular areas that read out directly properties covered by the area´s configuration headline and filters if you open the worksheet or refresh the worksheet. If you change the values in the data area and save them they are written to the corresponding properties. Document Versions Document Management handles a checked in version of a document and a checked out version. If a document is checked in you can only can view it. If you check out the document you can change it, and no other user can change it. Other users can view the checked in version or the checked out version. Import of Document Files You can easily import Document files initially stored on a directory in the file system to their corresponding aspects using Bulk Data Management. Copies of the documents are checked in during import. You can use the same import worksheet to create the objects and the Document aspects. For a re-import of the document files you have to delete the Document aspects first. You can do this easily in bulk with Document Management. After executing Open Properties on a Document Aspect you can execute the Show All or Show Subtree command to get a list of the Document aspects. In this list you can do multiple selection and apply the Delete Aspect command on the selection. Basic configuration steps for Document Management you find in Document Management on page 541. Document Management is further described in 246 3BDS011222R4101 Section 2 Concepts Information Access IndustrialIT 800xA - Engineering, Engineering Workplace, Basic Engineering Functions manual. Information Access Additionally System 800xA provides five different aspect categories typically referenced as Information Access aspects. You can use the Information Access aspects to integrate applications and documents. File Viewer Another possibility to integrate document files into your system is the File Viewer aspect. You can use the File Viewer aspect to integrate non-dynamic document files without database-administrated document properties into your system. It is possible to have a Work document and a Public document for the same aspect. Only the Public document can be accessed by users of the operator category. The Work document can be the source document of the Public document, or a work in progress. Work and Public documents can be stored in different formats. For example, the Work document can be a Microsoft Word document, and the Public document the corresponding Adobe Acrobat pdf-document. Another function is the ability to create and use templates. A collection of File Viewer aspect categories with pre-configured templates needed for example for product documentation is provided by the system. For the Work document file of an File Viewer aspect a versioning mechanism is available based on a Check Out operation and on counting up a number as file name part is during Check In operation. See How to use the File Viewer on page 545. Bookmark In addition to the File Viewer aspect category and its template categories a Bookmark aspect category is available. This category allows you to configure the starting view page of a Public .pdf document file of a parallel File Viewer aspect. See How to use the Bookmark Aspect on page 561, 3BDS011222R4101 247 Information Access Section 2 Concepts File Viewer and Bookmark aspects can be created using Bulk Data Management but the aspect properties cannot be configured using Bulk Data Management. Therefore the files of File Viewer and Bookmark aspects cannot be imported using lists. Web Page You can use the Web Page aspect to access any Web page or html document. It utilizes the WebBrowser ActiveX component from Microsoft. You configure the Web Page aspect towards a Web page/html document, which in turn may contain URLs linked to other pages on the Web. When you click on such an URL, the referenced Web page will be displayed. This is the normal way of web browsing, and the only thing you need to do is to configure the Web Page aspect. The Web Page aspect can be created and configured using Bulk Data Management. See How to use the Web Page Aspect on page 564. ActiveX Wrapper The ActiveX Wrapper aspect provides you with a method to wrap any ActiveX Control installed on your Windows system. When you have configured the ActiveX Control, you simply select that aspect to execute it. See How to use the ActiveX Wrapper Aspect on page 566. ActiveX Wrapper aspects can be created using Bulk Data Management but the properties cannot be configured using Bulk Data Management. Windows Application The Windows Application aspect makes it possible for you to launch any executable installed on your Windows system. There are a number of useful Windows applications, like office applications, administrative tools for your plant, etc. that may be useful to access as aspects, using the same user interface as for the other features. Windows application aspects can be created using Bulk Data Management but the properties cannot be configured using Bulk Data Management. See How to use the Windows Application Aspect on page 569 248 3BDS011222R4101 Section 2 Concepts Version and Access Management Help Aspect The Help aspect is used to provide online-help for an object type or an object instance. You can create files containing on-line help information, using various third party tools. You can also refer to information in the comprehensive set of online help files. Advantages for Object Type If you create on-line help aspects and place them on the object type, that help can function as help for that specific object type. If you choose to use inheritance for the help, you can even change the help later on and get an automatic update of the object instances help. Advantages for Object Instance You can create individual instructions and help for the respective object. For complex application objects created in a plant this can be very useful. Tuning instructions, maintenance instructions or help for emergency situations can be part of the help. See How to use the Help Aspect on page 570. Version and Access Management Version and Access Management of System 800xA is assuring that the manufacturing process the system is controlling consistently produces results according to the specifications. It helps to build, run and maintain applications that comply with FDA cGMP and 21 CFR Part 11, see FDA 21 CFR Part 11 Support on page 262. The 800xA system provides means to manage versions of the configuration data of a whole system, so called system versions, via a backup / restore mechanism. It further supports controlled synchronization of a Production System with configuration data changes done on an Engineering System. Regarding authorization and access management the 800xA system allows managing of the user's access to entities down to the single property of an aspect object. 3BDS011222R4101 249 Security Section 2 Concepts Changes on aspects of a certain category can be secured by requiring reauthentication or digital signatures. All changes done in an Production System or an Engineering System can be audit trailed. Audit Trail messages can be archived. Regarding health of process data the 800xA system for example provides signal quality support and regarding health of the hardware devices system status support. SFCs in Control Builder M Professional and corresponding SFC displays on the Operator Workplace can be the base for checking the permitted sequencing of steps and events. Security In general data security of a plant installation requires taking care of risk management, physical security, computer security and personnel security. Base for personnel Authorization and Access Control is the Security functionality provided by the 800xA system. The System Security model of System 800xA is based on extensions to Windows security model. The extensions make it possible to set permissions for users or user groups on an 800xA system, a structure or part of a structure, or an aspect object.The security setting can also be limited to a single node, or all nodes. This feature makes it possible to require an operation to be performed from a node with a visible view of the area it controls. Connected to the security is the usage of roles. The roles adapt the user interface for different user groups. Some operations require an application engineer or system engineer role to be performed. However, having the correct role does not give the user the permission to perform the operation. The permission is completely controlled by the security configuration of the system. The security and audit in an 800xA system are set with the Security Definition aspects, which are added to Aspects Objects. You set the security by changing the Authority Range, Permissions (related to User Identity/Group and Node) and Search Option of a Security Definition aspect. By these settings you can define a wanted security level for your plant. You set the Audit function more or less in the same way as the security. By logging the audit you can follow what happens in your plant from a security point of view - for example attempts to access secured objects etc. 250 3BDS011222R4101 Section 2 Concepts Authorization By adding Security Definition aspects to Aspect Objects and change their settings, you can set the security you want on a system, structure or on an object level. The general principle when configuring System Security of 800xA systems is to keep it as simple as possible. A complicated security configuration is, in it self, a security problem, since the overview is lost. For a small installation it may be enough to change the Default Security Definition (an aspect in the 800xA system). A larger installation may have several operator groups with allowed permissions on different areas in Functional Structure. Only exceptionally should Security Definition be put on individual Aspect Objects. It is also recommended to work with groups instead of individual users. Detail information on security configuration of the 800xA system you find in IndustrialIT 800xA - System, Administration and Security. Authorization Security controls a user’s authority to perform different operations on Aspect Objects, depending on several parameters: • The user’s credentials, as provided by Windows. • The node where the user is logged in. This makes it possible to give a user different authority depending on where he/she is located, e.g. close to the process equipment, in a control room, or at home accessing the system through Internet. • The operation the user wants to perform. You define authorization of a user by setting the security, this means you change the Authority Range, Permissions (related to User Identity/Group and Node) and Evaluation Search Option of a Security Definition aspect. Access Control Basic access to the system is controlled based on user's credentials entered during Windows Logon. Advanced Access Control provides re-authentication and double authentication. 3BDS011222R4101 251 Access Control Section 2 Concepts Authentication For process critical operations, an aspect category may be configured to require an explicit authentication operation for the operation to be performed. Two different authentication operations are supported: • Re-authentication is used to guarantee that an operation is performed by the correct person. To require a re-authentication immediately before a change can be performed guarantees that nobody has the possibility to use a workplace when an operator temporarily leaves it. • Double-authentication is used for operations critical to the quality of the product or required by regulation. It is used where the knowledge of an operator is too limited or where there must be another operator that verifies the change before it is done. Re-Authentication The re-authentication dialog box is used to guarantee that the correct person performs an operation. When a change is made to an OPC property or aspect that requires a re-authentication, the dialog box pops up. You must type your User ID with domain and your password and select a reason from the Reason drop-down menu before you can press OK. It is optional to type a comment in the Approval Comment text field. If the provided information is accepted the dialog box disappears and the operation proceeds. If it fails a pop-up error message appears which you have to acknowledge before making a new attempt. If it fails three times in a row the dialog box will be terminated and you will be notified about the failure. A system event is also created. Double-Authentication The double-authentication dialog box is used to guarantee that the correct persons perform an operation. When a change is made to an OPC property that requires double-authentication, the dialog box pops up. You must type your User ID with domain, password and select a reason from the Reason drop-down menu in the First Approval area before pressing Apply. It is optional to type a comment in the Approval Comment text field. 252 3BDS011222R4101 Section 2 Concepts Log Over If the information provided by you as the primary authenticator is accepted the Second Approval area is activated. If it fails a pop-up error message is displayed which you have to acknowledge before making a new attempt. If it fails three times in a row the dialog box will be terminated and you will be notified about the failure. In the Second Approval area a secondary authenticator, which must have Approve permission granted on the object, shall type his/her User ID with domain, password and reason before pressing OK. It is also here optional to type a comment in the Approval Comment text field. If the provided information is accepted the dialog box disappears and the operation proceeds. If it fails a pop-up error message appears which you have to acknowledge before you can make a new attempt. If it fails three times in a row the dialog box will be terminated and you will be notified about the failure. A system event is also created. Log Over The log over function enables a fast and temporary switch between users in a running workplace. For example if an operation requires a permission not held by an operator, another user (e.g. a system engineer) that holds the required permission, can log on to perform that operation. The log over changes the permissions and user roles but keeps all open windows with their present contents. The permitted actions in the open windows are controlled by the permissions of the logged over user. The log over only affects the System permission. Windows security is still the same as the user logged in. This means that the access to files is still controlled by the user logged in. To change a user, right click on the user name in bottom line of your workplace window and select Change User. A Change-user authentication dialog box appears and the new user has to type his/her User ID with domain and password. If the User ID with domain and password are accepted the dialog box disappears and the new user can operate the workplace. If the User ID with domain and password fail a pop-up error message appears which must be acknowledged before a new attempt can be made. If it fails three times in a 3BDS011222R4101 253 Electronic Signature Section 2 Concepts row the dialog box will be terminated and you will be notified about the failure. A system event is also created. To return to the first user right click on the user name again and select Revert User. The Revert User operation requires authentication of the user to revert to. Additionally an Inactivity User can be configured that the system reverts to automatically after a certain time period of inactivity of the logged over user. To enable Log Over requires setting corresponding system settings in the Log Over Settings aspect of your System object in Admin Structure. Electronic Signature The digital signature function allows you to electronically sign an aspect (typically representing a document) according to the requirements from different national authorities. The Digital Signature Server is also used for verification of who signed the aspect, when it was signed and if the aspect is unchanged since it was signed. To be able to sign an aspect you need to have the permission configured for the First and/or Second Signature operations. You sign by opening the aspect context menu and executing the Add Signature item and filling out the authentication dialog. Clicking OK will create a Signatures aspect containing the signature. An audit trail event will also be generated if the audit trail function is active. You can use the Find tool for finding signed and unsigned aspects. The first signature is given to aspect categories that hold important information and therefore need to be digitally signed. The second signature is given to aspect categories that also hold important information but need an additional authentication, i.e. two digital signatures. The Digital Signature Server is used programmatically to handle signing in the context of System Synchronization. 254 3BDS011222R4101 Section 2 Concepts Versioning and Life Cycle Management Versioning and Life Cycle Management The 800xA system supports you in maintaining System Configuration Versions of a Production System using the system's Backup/Restore function and in performing semi-automatic, controlled transfer of engineering changes from an Engineering System to the Production System using System Synchronization, as already mentioned in On-Site Engineering on page 144. Figure 84. System Configuration Versions and System Synchronization 3BDS011222R4101 255 Versioning and Life Cycle Management Section 2 Concepts System Configuration Version Versioning is accomplished by taking a complete (full) backup of the system configuration data and assigning it a version number and a label that identifies it as a System Configuration Version. Default for a full backup is to include all aspects, objects and all services that support Backup/Restore. Restore of a System Configuration Version can be executed from Configuration Wizard´s Restore System entry. For more details System Configuration Version and Backup / Restore see IndustrialIT 800xA - System, Administration and Security. System Synchronization System Synchronization provides the ability to synchronize two separate systems with each other. It is mainly intended for synchronizing engineering data between applications. This can be done with object trees or single objects. The most common case is to synchronize between an Engineering System and a Production System. To use System Synchronization for application data transfer, the Engineering System and the Production System must have the same software products and product versions installed, and the same system extensions must be loaded in both. It is not necessary that both systems have the same hardware configuration. The Engineering System has to be installed at the same location and in the same domain as the Production System and shall be connected to it via LAN. During synchronization all modified objects are updated. If an object is missing in the target system then the object is created in the target system and if it is not present in the source system then it is deleted in the target system. Audit trails are generated for these changes, i.e. if Audit Trail is activated. There are aspects of specific aspect categories that cannot be handled directly since they are computer node specific. These categories are filtered out during the synchronization process. System Synchronization works as a two-phase process. The first phase consists of entering information in a Synchronization Definition aspect in the System Synchronization aspect system. All objects selected for 256 3BDS011222R4101 Section 2 Concepts Versioning and Life Cycle Management synchronization are scanned for differences between the source system and the destination system. Found differences are placed in a difference report. If the differences are valid, then a synchronization package can be created and Objects that have differences are written to a file called package.afw file. The information about these changes are written to a file called package.xml file. These two synchronization files along with the difference report, written as package.html, are placed in a file set, as a synchronization package, which can be distributed with the help of FSD (File Set Distribution). The synchronization package is later on used by the System Synchronization process to do the actual synchronization. See Figure 85 below. Figure 85. System Synchronization: First Phase 3BDS011222R4101 257 Versioning and Life Cycle Management Section 2 Concepts The second phase consists of loading a synchronization package via FSD, verify it and finally to run the synchronization. This is done via the Configuration Wizard. It is not possible to cancel when synchronization has started. See Figure 86 below. Figure 86. System Synchronization: Second Phase A Synchronization Definition object/aspect beneath the Synchronization Definitions sub- root object in the Maintenance Structure is used to define a specific synchronization. Two tabs are available on the Synchronization Definition aspect: Synchronization differences and Synchronization Scope. In the Synchronization Scope tab you define Structures, Trees and Objects to be used for scanning differences against the destination system. Scanning for differences is done using the Synchronization differences tab. The scan algorithm operates in general as follows: For each source object that is to be synchronized, check if the object exists in the same location in the destination. If it does not exist then it should either be copied, i.e. retaining its object identifier, or be placed. If the object exists, i.e. its object id exists in the system, it should be placed here. If there are objects in the 258 3BDS011222R4101 Section 2 Concepts Audit Trail destination system that do not exist in the expected location in the source system then remove these objects from the destination system. The results of scanning are documented in a differences report. If the report matches your expectation you can generate the synchronization package. You are required to re-authenticate yourself. Then the package is created, utilizing audit trail messages Start and End and a digital signature, i.e. if Audit Trail and digital signatures are activated in the system. A Synchronization Package object beneath the Synchronization Packages sub-root object in the Maintenance Structure holds the Synchronization Package data. This package object contains one System Synchronization Information aspect. This aspect holds information about the differences found when scanning two systems for differences. It also contains data about the created synchronization package. The package object is created automatically from the System Synchronization Definition aspect. The second phase in System Synchronization is to load a synchronization package into a destination system. This is done using the Configuration Wizard. In this tool you select the entry System Administration, then the destination system, the source system and the sysnchronization package and then you start the actual synchronization process. A Synchronization object beneath the Synchronizations sub-root object in the Maintenance Structure holds the Synchronization data. This synchronization object contains one System Synchronization Information aspect. This aspect holds information about the changes made when synchronizing two systems. The synchronization package object is created automatically when performing a System Synchronization. When the synchronization process starts an Audit trail message is set, if Audit Trail is activated. Data from the synchronization package is copied to the destination system. This data is used for the actual synchronization. Further boundary conditions and detail configuration steps for System Synchronization are described in Version and Access Management on page 573. Audit Trail Regulations in many industries, for example the food and drug industry requires that all changes that may affect the produced product should be logged in an audit trail. The logging is made in the form of audit events that are generated from 800xA system parts that support auditing. 3BDS011222R4101 259 Audit Trail Section 2 Concepts The Audit Trail function is based on the System Message functionality of the 800xA system, but has additional features to specify what audit trail events that shall reach the system message log. The following message classes are used for the audit trail: • AuditEvent_Acknowledge - An alarm generated by the process is inserted into the alarm list, but is not entered into the audit trail. When an operator acknowledges the alarm an audit event is inserted into the in the audit trail using the AuditEvent_Acknowledge message class. • AuditEvent_ConfigurationChange - A configuration change is a change that is persistently stored in the system. • AuditEvent_ConfigurationViewChange - Changes the way a configuration is displayed, but doesn't change the process. • AuditEvent_ForcedChange - A forced change substitutes the real-time value with a user defined value that is subsequently used instead of the actual value. • AuditEvent_Import - Event generated during import. • AuditEvent_OperatorAction - An operator action sets a variable that is not part of the configuration parameter set and therefore does not lead to a new version. • AuditEvent_Backup - Generated when making a backup • AuditEvent_Restore - Generated during restore of a backup. • AuditEvent_Security - A user fails to obtain privileges to an object. • AuditEvent_System - Generated during start or stop of services. • AuditEvent_Upload - Events generated during upload of OPC properties. • AuditEvent_CMMS - Documents the changes to a work order tracked in a CMMS. • AuditEvent_Calibration - Documents the calibration process of a device. • AuditEvent_AspectDirectory - Used for generic events from the Aspect Directory. The audit event classes are defined in Library Structure/System Messages/Message Classes. 260 3BDS011222R4101 Section 2 Concepts Audit Trail Audit Trail Configuration The Audit Trail function is controlled with the Audit Trail Configuration aspect. There is only one Audit Trail Configuration aspect in a system. It is placed in the Admin Structure under Administrative Objects\Domains\<node> system. All changes in the Audit Trail Configuration settings are documented as high severity audit events, regardless if the Audit Trail function is activated or not. When the Audit Trail function is activated an audit event is generated that becomes a starting point in the Audit Trail. You can add new Audit Event message classes to extend the predefined message classes, by creating a new message class object in the Library Structure. Storage of Audit Trail Events The audit trail events are temporary stored by the System Messages service. If the System Message service has been configured for redundancy, the audit trail events automatically get redundant storage. The System Message service stores the events in binary files in a circular manner, overwriting the oldest information when the storage gets full. Archiving of the Audit Trail is accomplished by transferring the audit events to Information Management, in the form of OPC Events. When the system message server receives a new audit event it converts it to an OPC event and sends it to the Information Management History Services OPC message log. During the creation of the OPC Event some information is expanded form the internal format stored in the system message server into plain text information. For instance the UserId is converted into a string with the users Windows login name. The Information Management History Services has archive facilities for long time storage of the Audit Trail. For more informations see IndustrialIT 800xA Information Management, Configuration. Audit Trail Viewing As the Audit Trail is stored as system messages the Alarm/Event viewer aspect can be used as a basic viewer to display audit events. The alarm/event viewer can only 3BDS011222R4101 261 Archive Section 2 Concepts display a subset of the information available in an audit event. Information that must be visible in the alarm/event viewer must be formatted into the message column. Archive The archive function of Information Management History Services supports permanent off-line storage for historical data collected in property, message, and report logs, as well as the Operator Workplace alarm/event message buffer, including audit trail messages. When a history log becomes full, the oldest entries are replaced by new entries, or deleted. The archiving mechanism copies the contents of selected logs to a designated archive media. See also Historical Process Data on page 219. For further informations see IndustrialIT 800xA - Information Management, Configuration. System and Device Checks The 800xA system provides comprehensive functions that allow determining the health of the process and of the controlling control system and of the allowed sequences of steps and events. Examples are: Regarding health of process data the 800xA system for example provides signal quality support and regarding health of the hardware devices system status support. System status can also be displayed in the context of topology diagrams using Topology Status Viewer. Asset Monitoring provides a way to access the status information for IT assets / IT devices used in the context of the control system. SFCs in Control Builder M Professional and corresponding SFC displays on the Operator Workplace can be the base for checking the permitted sequencing of steps and events. FDA 21 CFR Part 11 Support How Version and Access Management functions of System 800xA helps to comply with FDA cGMP and 21 CFR Part 11 regulations is outlined in Appendix C, FDA 21 CFR Part 11 Support. 262 3BDS011222R4101 Section 2 Concepts Asset Optimization Asset Optimization System 800xA - Asset Optimization consists of system extensions to the 800xA system product. Asset Optimization functionality includes Asset Condition Reporting, Asset Monitoring, CMMS (Computerized Maintenance Management System) integration, and Calibration Integration to the 800xA System. This optimizes the use of plant equipment and processes. When integrated with SMS and e-mail Messaging, Asset Optimization provides a method for sending messages based on alarm and event information to user devices such as mobile telephones, email accounts, and pagers. When integrated with FOUNDATION Fieldbus, HART, or PROFIBUS Device Integration, Asset Optimization provides a method for detecting field device problems. The 800xA system supports two CMMS, Maximo® and SAP/PM. The supported functionality varies between Maximo Integration and SAP/PM Integration. The 800xA system supports calibration integration for Meriam Process Technologies Device Management System (DMS) software. Asset Optimization brings maintenance management to the operator environment to provide a single window interface for multiple systems. This allows plant personnel to collect, compare, and monitor field device data to accurately assess equipment conditions in real time. For maintenance personnel, Asset Optimization provides a default Maintenance Workplace that supports daily maintenance activities in a most efficient way. The combination of innovative automation architecture plus advanced information technologies, including integrated fieldbus solutions, allows Asset Optimization to monitor and optimize all plant assets in real time. This includes field devices, control systems, and automation elements, as well as major assets such as heaters and generators. This architecture provides the required infrastructure to monitor and record asset performance over the entire life span of the asset. Information subsequently can be used to set future performance and profitability goals and to assist managers in making these decisions. Asset Optimization significantly reduces costly production interruptions by enabling predictive maintenance. It records the maintenance history of an asset and 3BDS011222R4101 263 Asset Optimization Section 2 Concepts identifies potential problems to help avert unscheduled shutdowns, maximize uptime, and operate closer to plant design limits. Plant managers have the opportunity to collect, compare, and monitor data on field devices and larger equipment to accurately assess equipment operating performance in real time. As a result, faltering performance can be uncovered before breakdowns occur, and maintenance can be scheduled accordingly. The Asset Optimization software provides for the following functionality: • Maintenance Workplace and Asset Structure • Asset Health Condition Reporting • • 264 – Asset Viewer – Asset Reporter Asset Monitoring System – Basic Asset Monitors – IT Asset Monitoring generated via PC, Network and Software Monitoring – HART Asset Monitors – FOUNDATION Fieldbus Asset Monitors – PROFIBUS Asset Monitors – DMS Asset Monitors Seamless Interaction Between Process, Maintenance, and Calibration – Maximo Integration – SAP/PM Integration – DMS Calibration Integration • Asset Optimization Reporting • System 800xA - Asset Optimization for Process Portal B (see OperateIT, Process Portal Version B2.0 instruction). 3BDS011222R4101 Section 2 Concepts Asset Optimization Figure 87 shows the interaction between the various functional components of Asset Optimization. ASSET OPTIMIZATION ASSETS DATA SOURCES ASSET MONITORING (REFER TO NOTE 1) ASSET MONITORING SERVER (LOGIC EXECUTION) BASIC ASSET MONITORS DMS ASSET MONITOR PC, NETWORK AND SOFTWARE MONITORING HART ASSET MONITORS FOUNDATION FIELDBUS ASSET MONITORS PROFIBUS ASSET MONITORS PROBLEM IDENTIFIED ASSET CONDITION DOCUMENT (ACD) GENERATED SMS AND E-MAIL MESSAGING USER DEVICES PAGER E-MAIL MOBILE TELEPHONE 800xA HUMAN SYSTEM INTERFACE (HSI) ASSET VIEWER (ASSET TREE SUMMARY) ASSET REPORTER (OBJECT SUMMARY) INDUSTRIAL IT CMMS (MAXIMO,SAP/PM) VIEWS FAULT REPORT SUBMITTER (REFER TO NOTE 2) MAXIMO, SAP/PM PORTAL VIEWS DMS WORKPLACE VIEWS MAXIMO SAP/PM WORK ORDER WORK ORDER DMS NOTES: 1. FUNCTIONALITY FOR PC, NETWORK ACTION ITEM AND SOFTWARE MONITORING, HART ASSET MONITORS, FOUNDATION FIELDBUS ASSET MONITORS, AND/OR PROFIBUS ASSET MONITORS MUST BE ADDED TO ASSET OPTIMIZATION. 2. FAULT REPORTS WILL BE SENT TO MAXIMO, SAP/PM DMS, OR ALL DEPENDING ON THE SYSTEM EXTENSIONS SELECTED. MAINTENANCE ACTION CONDITION CORRECTED Figure 87. Asset Optimization Functionality 3BDS011222R4101 265 Maintenance Workplace and Asset Structure Section 2 Concepts Maintenance Workplace and Asset Structure Asset Optimization information can be accessed from any workplace in the 800xA system. The Maintenance Workplace is a default Workplace for Maintenance personal. It is basically a Plant Explorer Workplace with an Alarm Band that shows Asset Monitoring Alarms for default Asset groups. Figure 88. Maintenance Workplace and Asset Structure The Asset Structure provides the possibility for maintenance personal to group and arrange plant assets in the way it is needed for efficient daily work. Control topology constraints can be overcome and even devices with different fieldbus protocols can be grouped together if they require similar maintenance procedures. The Asset Structure comes by default with 5 major groups of Assets (Drives, Field Instruments, IT Assets, Motors and Process Equipment). 266 3BDS011222R4101 Section 2 Concepts Asset Health Condition Reporting Asset Health Condition Reporting The Asset Health Condition Reporting system provides the infrastructure that reports asset status/condition information to notify operators and maintenance personnel when an abnormal condition calls for a maintenance action. Asset Optimization provides asset condition reporting via the Asset Viewer and Asset Reporter. The Asset Tree, visible in the Asset Viewer, shows the status of associated plant objects (assets) based on Plant Explorer hierarchies. Assets can be control system hardware components, control system networks, control system devices, fieldbus networks, fieldbus components, machines, pumps, motors, process equipment (boiler, reactor), etc. Condition Monitoring systems can report accessed asset conditions into the Asset Health Condition Reporting infrastructure, Asset Viewer and Asset Reporter. Condition Monitoring systems include Asset Monitoring and DMS Calibration Integration. Asset Viewer The Asset Viewer , when added to an object, allows the Asset Tree to be displayed. Asset Tree indicators propagate the most severe condition up the Asset Tree. Asset Tree indicators distinguish the level of severity using OPC and Asset Monitor severity range (1 to 1,000). Each Asset Tree indicator represents composite severity of an object and all children beneath the object for the current structure. In addition to displaying composite severity for each asset, the Asset Tree displays, and propagates up the tree, the quality of the condition (or the Asset Monitor itself, i.e. bad configuration), as well as Fault Report availability. Fault Report availability is indicated by bold text. Context menus permit Fault Report submission directly from within the Asset Viewer. The Asset Viewer is accessible within the Plant Explorer Workplace and the Operator Workplace on the Asset Optimization Application Server node and System 800xA Client nodes. It is also accessible as a web-enabled view on non-800xA systems. When the Asset Viewer is active in the System 800xA Client nodes, the 3BDS011222R4101 267 Asset Monitoring System Section 2 Concepts status of the assets in the view update automatically when values change. Webenabled views require a manual refresh to update the view. The Asset Tree and the Fault Reports are updated with a certain delay based on the size of the queue in the AssetMonitoring Service. This can be accessed by viewing the Service Queue Stats: row under the Runtime Statistics tab in the AO Server aspect. A queue of 1000 ACDs translates into a delay of approximately 15 minutes from the time the ACD has been exposed in the 800xA system as an Alarm/OPC Property. Asset Reporter The Asset Reporter is a detailed view of all asset monitor conditions for an asset. It displays the severity indicator for an object itself. It displays information available to it from all Asset Monitors and their corresponding current subconditions. For each condition, the Asset Reporter will provide information about current subconditions, severity, Asset Monitor status, Fault Report availability, and Work Order availability. The Asset Reporter must be added to each object for which it is desired to propagate up the Asset Tree in the Asset Viewer. The Asset Reporter is accessible within the Plant Explorer Workplace, Operator Workplace, and Maintenance Workplace on the 800xA system nodes. It is also accessible as a web-enabled view on non-800xA systems. When the Asset Reporter is active in the System 800xA clients, the status of the assets in the view update automatically when values change. Web-enabled views require a manual refresh to update the view. Asset Monitoring System Asset Monitoring An Asset Monitor is an application responsible for retrieving data from, and interacting with, multiple data servers (real-time data servers, OPC-DA servers, etc.). It analyzes the data and when necessary, issues an Asset Condition Document (ACD) and notifies the 800xA system of the detected condition. An ACD contains all information necessary to describe an asset condition, that in turn may be used to generate a Work Order for maintenance purposes. 268 3BDS011222R4101 Section 2 Concepts Asset Monitoring System ABB Asset Monitoring consists of the following: • Basic Asset Monitors. Requires licensing for Asset Optimization Asset Monitoring functionality. • IT Asset Monitoring. Requires licensing for Asset Optimization Asset Monitoring and PC, Network and Software Monitoring. The PC, Network and Software Monitoring software can independently monitor the status of Information Technology (IT) Assets. By default, IT Asset status is viewable via the System Status Viewer of the 800xA system, or through the standard faceplates provided with each of the predefined IT Asset types. When used in conjunction with Asset Optimization, alarms can be generated based on error conditions, and IT Asset status is viewable via the Asset Viewer and Asset Reporter. • HART Asset Monitors. Requires licensing for Asset Optimization Asset Monitoring and HART Device Integration system functionality. • FOUNDATION Fieldbus Asset Monitors. Requires licensing for Asset Optimization Asset Monitoring and FOUNDATION Fieldbus Device Integration system functionality. • PROFIBUS Asset Monitors. Requires licensing for Asset Optimization Asset Monitoring and PROFIBUS Device Integration system functionality. • DMS Asset Monitors: Requires licensing for Asset Optimization DMS Calibration Integration only. No license for Asset Optimization Asset Monitoring is required. Refer to DMS Calibration Integration on page 275. Basic Asset Monitors Asset Optimization Asset Monitoring provides the following Basic Asset Monitors: • Bad Quality Check. Reports the quality status (good, bad, uncertain) represented by the value of the monitored Input Record. • Bool Check. Monitors a signal with two states: normal and alarm. Notifies if the signal is in alarm state. • Flow Delta. Monitors the difference between two numeric values (e.g. steam flow and feedwater flow) and notifies if the difference exceeds a configured percentage of the first value. 3BDS011222R4101 269 Asset Monitoring System Section 2 Concepts • High Limit Check. Monitors a process value and notifies if it exceeds configured limit values that include the high limit value and the high limit value plus a negative offset value. • HighLow Limit Check. Monitors a process value and notifies if it exceeds configured limit values that include the high limit value, the high limit value plus a negative offset value, the low limit value, and the low limit value plus a positive offset value. • Low Limit Check. Monitors a process value and notifies if it exceeds configured limit values that include the low limit value and the low limit value plus a positive offset value. • Running Time Check. Monitors the accumulated runtime hours of a device and notifies, for preventive maintenance, that the runtime has accumulated up to a configured limit. • XY Profile Deviation. Compares a two-dimensional value against a baseline function and notifies if the deviation from the baseline is less than or greater than the configured limit. IT Asset Monitoring The PC, Network and Software Monitoring (PNSM) software can independently monitor the status of Information Technology (IT) Assets. By default, IT Asset status is viewable via the System Status Viewer of the 800xA system, or through the standard faceplates provided with each of the predefined IT Asset types. When used in conjunction with Asset Optimization, alarms can be generated based on error conditions, and IT Asset status is viewable via the Asset Viewer and Asset Reporter. Standard PCs and networking equipment are used extensively in automation systems. Correct behavior of these parts of the system has a significant impact on the performance and reliability of the automation system as a whole. Watching for indications of impending problems, via continuous monitoring of the equipment, makes it possible to be proactive and ensure optimum system availability. The PC, Network and Software Monitoring package provides a set of predefined IT Assets that represent common devices and system processes within the 800xA system (for example printers, computers, switches, and software programs). These IT Assets provide data from the simple (printer out of paper), to the sophisticated 270 3BDS011222R4101 Section 2 Concepts Asset Monitoring System (detection of a slow memory leak in a computer). When problems are detected (or anticipated), the software can automatically generate alarms, informing the user of the problem. PC, Network and Software Monitoring also provides two tools that are installed as part of the base package or can be loaded independently, as determined by your network and configuration designs. The Network and Device Scanning Tool lets a user retrieve and interpret information from SNMP enabled devices. This information is then used to determine what is of importance in the operation of the device. The tool can then determine if this data is readable by WMI for use in PNSM Assets. The Network Monitoring Tool allows users it to monitor traffic on a network segment, for a given node or traffic between nodes. The predefined IT Assets and IT Devices monitor the items listed in Table 11. Table 11. Items Monitored by Predefined IT Assets Type Networked Assets Monitored Generic Network Device Hirschmann Switch Cisco Switch Generic Printer Network Monitor Computer Assets System 800xA Nodes PPB Nodes Batch Nodes Inform IT Nodes Generic Computer Software Assets Inform IT Performance Generic Computer 3BDS011222R4101 271 Asset Monitoring System Section 2 Concepts The software package also provides faceplates for all asset types, showing overall status and key indicators (refer to IndustrialIT 800xA - Asset Optimization, Operation). Creation of customized assets is supported allowing users to create IT Asset and IT Device configurations that are tailored to their unique devices or components. • HART Asset Monitors Asset Optimization with HART Device Integration system functionality provides two types of HART Device Asset Monitors: – HART Generic Device Asset Monitor: Reads, via OPC-DA, HART_RESPONSE_BYTE1 to assess the following conditions: - Device malfunction. - Configuration changed. - Cold start. - More status available. - Analog output current fixed. - Analog Output Saturated. - Nonprimary Variable Out of Limits. - Primary Variable Out of Limits. – HART Device Specific Asset Monitors: Extend the functionality of the HART Generic Device Asset Monitor by assessing device specific conditions. Refer to the HART Device Library documentation for details. • FOUNDATION Fieldbus Asset Monitors Asset Optimization with FOUNDATION Fieldbus Device Integration system functionality provides two types of FOUNDATION Fieldbus Device Asset Monitors: – FF Generic Device Asset Monitor: Reads, via OPC-DA: - Resource Block: MODE_BLK.Actual and BLOCK_ERR. - Transducer Blocks: BLOCK_ERR. To assess the following conditions: - Device out of service or initializing. 272 3BDS011222R4101 Section 2 Concepts Seamless Interaction Between Process, Maintenance, and Calibration - Blocks out of service or powering up. - Input or output failure. - Block configuration error or link configuration error. - Data or memory error. - Device requires maintenance. - Fault state set. - Readback check failed. - Unspecified error. – FF Device Specific Asset Monitors: Extend the functionality of the FF Generic Device Asset Monitor by assessing device specific conditions. Refer to the FF Device Library documentation for details. • PROFIBUS Asset Monitors Asset Optimization with PROFIBUS Device Integration system functionality provides two types of PROFIBUS Device Asset Monitors: – PROFIBUS PA Channel Asset Monitor: Reads, via OPC-DA, PROFIBUS_StatusByte1 to assess the following conditions: - Signal quality - Block alarm - Limit. – Basic PROFIBUS PA Device Asset Monitor: Extend the functionality of PROFIBUS Asset Monitoring accessing device specific conditions. Refer to the PROFIBUS Device Library documentation for details. Seamless Interaction Between Process, Maintenance, and Calibration Asset Optimization uses CMMS Integration and DMS Calibration Integration to make information within the CMMS system and Meriam Process Technologies Device Management System (DMS) database software transparently accessible to users in the process control, maintenance, and calibration management system environments. System 800xA supports two CMMS, Maximo and SAP/PM. The supported functionality varies between Maximo Integration and SAP/PM Integration. 3BDS011222R4101 273 Seamless Interaction Between Process, Maintenance, and Calibration Section 2 Concepts CMMS Integration CMMS Integration establishes the link that removes the barrier to information exchange between the Computerized Maintenance Management Systems (CMMS) and the process control system environments. One of the issues that traditionally inhibits free interchange between these functional areas is their different naming conventions: an asset often has one name in the operations environment and another in the maintenance environment. This is because these systems have vastly different focuses, purposes, and needs that their naming conventions must satisfy. CMMS Integration removes these barriers by pointing to the right context, regardless of the naming convention. CMMS Integration brings maintenance management to the operator environment to give a single window interface for multiple systems. Context menus on process graphics, the Alarm and Event List, etc. provide access to several views and actions for the specific CMMS item. This allows plant personnel to collect, compare, and monitor field device data to accurately assess equipment conditions in real time. Maximo Integration Maximo Integration includes a Maximo Equipment ID aspect, a Maximo Credentials aspect, and CMMS Views aspects. The Fault Report Submitter aspect, which is part of the Asset Optimization Server system extension, makes it possible to submit Fault Reports to the SAP and DMS systems. The CMMS Views consist of the following: 274 • Active Work Order View • Work Order History View. • Equipment Status View. • Preventive Maintenance Schedule View. • Spare Parts/Availability of Spare Parts Views • Maximo portal views For every entry in the CMMS view, it is possible to navigate to related Maximo portal view. The Maximo portal view is a web view that allows direct interaction with the Maximo data if the user has appropriate rights. Change to the data is possible. 3BDS011222R4101 Section 2 Concepts Seamless Interaction Between Process, Maintenance, and Calibration The Fault Report Submitter consists of the following: • Create Fault Report Form/Submit Fault Report • Fault Report Viewer/Submit Fault Report SAP/PM Integration SAP/PM Integration includes a SAP Equipment ID aspect, a SAP Credentials aspect, and CMMS Views aspects. The Fault Report Submitter aspect, which is part of the Asset Optimization Server system extension, makes it possible to submit Fault Reports to the SAP and DMS systems. The CMMS Views consist of the following: • Active Work Orders View. • Work Order History View. • Equipment Status View. • Preventive Maintenance Schedule View The Fault Report Submitter consists of the following: • Create Fault Report Form/Submit Fault Report. • Fault Report Viewer/Submit Fault Report. DMS Calibration Integration Calibration management is an important facet of the plant maintenance strategy. By streamlining calibration workflow, quality of the process/product is improved while cost is reduced. In many cases, calibration is a manual operation that is scheduled haphazardly, through trial and error. Assessing field device data to determine the optimal schedule eliminates problems of late or unnecessary calibrations. Information such as historical data, fault analysis, process analysis, and the calibration strategy can be used to create a calibration trigger, which initiates a calibration Work Order. DMS Calibration Integration brings a calibration management solution, for HART or conventional 4-20 mA devices, to the operator environment by integrating Meriam Process Technologies Device Management System (DMS) database 3BDS011222R4101 275 Seamless Interaction Between Process, Maintenance, and Calibration Section 2 Concepts software with Asset Optimization. It provides a single window interface to DMS as the DMS aspect system supports calling DMS driven aspects from different objects within the 800xA system. It manages data exchange between DMS and the 800xA system for items such as alarms, synchronization of topology, device instances, and device specific parameters needed for calibration. Usually Fieldbus Builder PROFIBUS/HART manages and owns the HART device configuration. All device parameters that are needed in the DMS system and the MFT to run a calibration procedure are stored in the 800xA system and propagated into the DMS system. DMS does not store configuration information for those devices. Device configuration data from the MFT or the MFC is not loaded back into the DMS system or the 800xA system. If the configuration of the HART device is not managed by Fieldbus Builder, the DMS system owns the device configuration and stores the data. Device configuration data from the MFT or MFC can be loaded back into the DMS system. The device information will not be available as a property in the 800xA system. DMS Calibration Integration allows plant personnel to monitor field devices for calibration information and opens the workflow towards the CMMS. Work orders required for calibration procedures are submitted to either the DMS system only, or the DMS system and CMMS (if Maximo or SAP Connectivity system extension is installed) using the Fault Report Submitter. DMS Calibration Integration supports: 276 • Calibration Administration (DMS). – Classification of devices and descriptions of general calibration procedures for different device types. – Calibration schedule for devices in a plant. – Calibration history and reports per device. – Calculation of device specific calibration steps depending on device specific parameterization. – Generation of Work Orders and instructions for devices due for calibration. • Calibration process in the field with a hand-held calibrator and HART communicator: – Providing a device TAG specific instruction list for calibration. – Logging of all executed steps for documentation purposes. 3BDS011222R4101 Section 2 Concepts Asset Optimization Reporting – – – • Generation of the precise signals required to calibrate the device. Device trim to bring the device into calibration limits. Reporting of the results. Calibration Condition Monitoring – Notification of device due or overdue for calibration. This condition participates in the asset condition reporting infrastructure Asset Optimization Reporting System 800xA provides three Asset Optimization Report Templates that summarize important maintenance information to provide maintenance engineers with comprehensive data to make decisions. The Asset Optimization Report Templates are preconfigured as Microsoft Excel spreadsheet (.xls) files. These spreadsheets are used as templates for the Asset Optimization Reports and contain logic for extracting the Alarm and Event data and properties from the specified Asset Optimization objects. After the report data is read, it is formatted in the spreadsheet using Excel functions (pivot table) and sorted appropriately. To execute the reports, the Scheduling Definition and Action aspects must be configured. The reports can be executed automatically according to a certain schedule or on demand by clicking RUN NOW in the Scheduler Definition aspect. The Asset Optimization Report Templates are: • • • AO Asset Condition History Report. AO Calibration Report. AO Running Time Report. These reports are implemented as a Microsoft Excel (.xls) files. The templates are used in conjunction with the Inform IT Scheduler system extension. Reports are run manually and can be scheduled periodically as defined in the Scheduling Definition aspect. Report data is retrieved through DataDirect macros or by using custom macros written in Visual BASIC. All report parameters are defined in a second configuration sheet. When data is collected and formatted, the reports can be optionally printed or historized, if Information Management is installed and appropriately configured. 3BDS011222R4101 277 Asset Optimization Reporting Section 2 Concepts The Asset Optimization Report Template implementation requires that the following System 800xA features be installed on the target Aspect System: • Asset Optimization: required as a source for the report data. • Scheduler: required for the report template to be triggered, run, and stored. • DataDirect (Excel add-in): required for retrieving data from the Aspect System. • Information Management: required if long term archiving of reports is required. AO Asset Condition History Report The AO Asset Condition History Report provides, for every asset, a detailed listing of all asset maintenance conditions that have been active in a time interval, and counts the number of faults per each condition. This report is based on an Alarm and Event list (Event type) configured to display Asset Conditions. The AO Asset Condition History Report identifies repeating asset condition offenders and highlights critical assets with high failure rates. This report can be used to define a proactive maintenance strategy. AO Calibration Report The AO Calibration Report lists, for every device, all calibration events with the time that the event occurred and shows the current calibration state on top of the list. This report is based on an Alarm and Event list (Event type) configured to display calibration events. The AO Calibration Report helps to identify the current calibration state for every device for; example, waiting for approval, due for calibration, work in progress, etc. AO Running Time Report The AO Running Time Report lists all assets in a given structure with a Runtime Asset Monitor. It shows, per asset, the configured runtime limit value, the hours of operation, indication that the runtime limit is active, and the date of the last Asset Monitor reset. Furthermore, it calculates the remaining time of operation until the runtime limit is reached based on the current calculated average runtime rate. The AO Running Time Report allows sorting by tag, object type, runtime limit, and alarm active. 278 3BDS011222R4101 Section 2 Concepts Scripting Scripting Scripting provided by Script Management enables you to develop Object Types or specific object instances that implement: • Special plausibility checks and limited automated planning tasks • Extended rules and actions to Aspect Objects • Dependencies between objects and structures • Extended logging and tracing • User and application specific dialogs and menus (aspect or object verbs) • Calculations and arithmetic functions • Interface external tools that support VBScript and Windows Scripting Host. System 800xA includes execution of scripts by means of the Script Manager Basic functionality. The functions needed to develop scripts are provided by the Script Manager Professional option. The Script Manager system extension provides an aspect category Script for aspects holding a script and an aspect category Script Property Bag for aspects that store persistent values of the script of a Script aspect in the same object. The values stored in the Script Property Bag aspect are published as properties and therefore can be read and written by other aspect systems using property references. For development of scripts Script Manager Professional provides: • An editor to create and edit scripts. • Dialogs to specify trigger conditions for scripts. • A debug environment. • VBScript language extensions to access aspect objects and structures easily. • A dialog for specifying general script settings. • A Type Library browser. • A script trace window environment. • A simple programming interface. 3BDS011222R4101 279 System Development Section 2 Concepts With Script Management you can use the entire scope of the Automation Interface of the 800xA system. You can develop scripts that are started either manually or automatically based on structural- or aspect parameter changes. Manually started scripts can be assigned to aspect verbs or object verbs, which in turn can be assigned to hot keys using the Hot Key Configuration aspect system (see IndustrialIT 800xA - Operations, Operator Workplace, Configuration). Automatically started scripts can commit or cancel modifications. Therefore the script of an Aspect Object may decide, whether to allow or reject a modification. Script Management is further described in IndustrialIT 800xA - Engineering, Engineering Workplace, Basic Engineering Functions manual. For backward compatibility reasons the 800xA system additionally contains a Scripting aspect system providing the aspect categories Scripting Aspect, Simple Scripting Aspect, Scripting Property Bag and User Settings and History. This Scripting aspect system only has very basic editing, debugging and triggering capabilities. It is recommended to use Script Manager aspect system instead or, in the context of Information Management, the Calculation aspect system. System Development For development of customer specific extensions of the 800xA system according to the Aspect Object Architecture outlined below, a collection of tools is available, the System Development Toolkit, including: • Aspect Express • Aspect Studio It provides support for a high integration level by means of aspect systems. The System Development Toolkit fulfills the needs of the developer who seeks quick and usable results as well as the one who focuses on flexibility and performance. 280 3BDS011222R4101 Section 2 Concepts Aspect Object Architecture Aspect Object Architecture The Aspect Object architecture divides the system topology as shown in Figure 1 into separate functional layers for control, server, and workplace functions respectively. The architecture deals with the workplace and server layers, and defines how the control layer is interfaced. Understanding these layers is essential to understanding the Aspect Object architecture. Figure 89. Functionality Layers Two main concepts are central to the Aspect Object architecture: the concept of Aspect Objects, and the concept of Afw Services. The Aspect Framework (Afw) implements these concepts on the Microsoft Windows operating system platform. Functionality in the server and workplace layers is provided by software components referred to as system applications (or just applications). An important feature of System 800xA is that information and functions are centered on Aspect Objects. To participate in Aspect Object operations, an application must present itself as an aspect system (or possibly as several aspect systems). In essence this means that the application provides COM objects called aspect system objects, which support certain framework-defined interfaces, through which the application can initiate and participate in common operations on objects and aspects. Functionality in the control layer is connected to the server layer through connectivity components. A connectivity component provides Aspect Object types, 3BDS011222R4101 281 Aspect Object Architecture Section 2 Concepts access to real time data, and various forms of supporting functionality for different types of controllers and devices. Figure 90. The Afw Aspect Framework Client / Server Model Applications are implemented as client applications or services. A service is an entity that provides a certain set of functions in the system. Services run in the server layer. Client applications are applications that utilize the functionality provided by one or more services, e.g. to present some information to a user. A client application can also support thin clients by providing an interface to an Internet Information Server. Services must conform to the Afw Service model. An Afw Service is designed to run around the clock. It is partioned into several service groups, each group handling part of the scope of the service (e.g. part of the object space). For redundancy each group can contain several service providers running on different servers. A service manager initiates and supervises the execution of Afw services. An Afw Service provides a service handler. This is a COM object that a client includes and runs as an in-process object to access the service. Using information from the Aspect Directory, the service handler provides one uniform interface to the 282 3BDS011222R4101 Section 2 Concepts Aspect Object Architecture service, relieving the client from having to deal with issues such as how the service is partitioned, redundant service providers, etc. Figure 91. The Afw Service Model Afw OPC The OPC (OLE for Process Control) specification is a non-proprietary technical specification that defines a set of standard interfaces based on Microsoft's COM technology. The purpose of the OPC standard interface is to facilitate interoperability between automation and control applications, field devices, and business and office applications. Traditionally, each application developer was required to write different custom interfaces to exchange data with different data sources. OPC eliminates this need by defining a common, high performance interface that permits this work to be done once, as an OPC server that can be used by many different applications. Different OPC servers are available for different brands of controller, fieldbusses, and other data sources. OPC plays a vital role in the Aspect Object architecture - it is through OPC compliant interfaces that applications have access to real-time data, historical data, and alarm and event data from controllers, field devices, and other software applications. The Afw OPC server concept allows many different OPC servers to be placed under a one common server that unifies access to data from different sources. This common server provides one set of OPC compliant interfaces, eliminating the need for client applications to know which OPC server to use for each data item. 3BDS011222R4101 283 Aspect Object Architecture Section 2 Concepts There are three Afw OPC servers: Afw OPC/DA for real-time data access; Afw OPC/HDA for access to historical data; and Afw OPC/AE for access to alarm and event data. The Afw OPC Servers are designed as Afw Services, and thus consist of two parts: • An Afw service handler that runs as an in-process COM object with the client application, and provides a unified OPC interface to all data sources in the system. • Server components that are accessed by the client component, and perform the actual access to data provided by different data sources. Security Security in the Aspect Object architecture is based on Windows security, adding certain features and capabilities that allow products and systems built on the architecture to comply with relevant regulatory requirements Security controls a user's authority to perform different operations on Aspect Objects, depending on several parameters: • The user's credentials, as provided by Windows. • The node where the user is logged in. This makes it possible to give a user different authority depending on where he or she is located, e.g. close to the process equipment, in a control room, or at home accessing the system through Internet. • The operation the user wants to perform. • The Aspect Object that the user wants to perform the operation on. These parameters are checked against a security descriptor provided by a security definition aspect held by the Aspect Object. A security descriptor includes an access control list, where each entry specifies an access mask (permission) and the users and/or user groups that are granted (or denied) access. The security descriptor also includes an audit control list, specifying which operations shall be logged for auditing purposes. Security settings can be inherited from a parent object through a structure. It is thus possible to define the security settings for all Aspect Objects in a certain area or 284 3BDS011222R4101 Section 2 Concepts Aspect Object Architecture other division of a plant, or for other collections of Aspect Objects, simply by adding a security definition aspect with the appropriate settings to the top object in the corresponding substructure. For example, a control valve may be part of a flow control loop for a mixing unit in a liquid processing area, which has a security definition aspect. The valve is placed as a child to the flow control loop in Functional Structure, and thus inherits the security settings that apply to the liquid processing area. Although that is the effect, in reality the security definition aspect is not actually inherited. Instead, when security is checked for an object, the structure is traversed until a parent object that has a security definition aspect is found. This aspect is then applied to the first object. Security inheritance is dynamic. When an Aspect Object is inserted in a particular structure, it inherits security settings from an ancestor in that structure. When it is deleted from a structure, it loses the security settings that were inherited through that structure. When it is again inserted in a different position in the same structure, or in a different structure, it inherits security settings from a new ancestor. An object may be placed in several structures, and thus inherit security settings from several parent objects in different structures. In such cases, if there is a conflict, a system defined precedence order is used to determine which security setting applies. Afw defines a list of operations that can be performed on Aspect Objects. Additional operations can be defined for specific aspect types - this is part of the information that an aspect system registers with the Aspect Directory. Operations are mapped into permissions per aspect category. For each aspect type it is thus possible to create several categories with different security settings. An end user of the system normally works only with permissions, configuring the security settings for each object or group of objects. The Afw OPC Server performs security checks and audit logging on all OPC accesses. Aspect Systems To participate in Aspect Object operations, an application must present itself as an aspect system (or possibly as several aspect systems). Aspect systems provide the functionality that is defined for Aspect Objects. Examples are Control, Graphics, 3BDS011222R4101 285 Aspect Object Architecture Section 2 Concepts Alarm & Event, History, Reports, Documentation, Simulation, Asset Optimization, Material Tracking, Production Scheduling, etc. An aspect system provides implementations for one or several aspect types through COM objects, referred to as aspect system objects (ASO). These objects interact with the Aspect Framework through different sets of framework-defined interfaces for common object and aspect operations. ASOs may also expose object properties through OPC. The Aspect Framework provides COM representations of Aspect Objects and aspects. Aspect systems provide their functionality through aspect system objects. Users identify and access aspect system objects through Aspect Objects and Aspects. Each aspect system is responsible for storing and maintaining its own data. However, in many cases data must be shared among a group of aspect systems. Unless handled in a correct way, this may cause data consistency problems. The Aspect Object architecture offers two ways to avoid that: • A shared data item is stored in only one copy by one aspect system, and other aspect systems access it from there, through framework defined interfaces. • Several aspect systems hold their own copies of a shared data item. When an aspect system updates its copy, it must inform the framework, which in turn informs other aspects systems to update their copies. An aspect system may provide one or more user interfaces, implemented in a suitable technology. Many aspect systems provide some degree of configurability, typically by means of some form of configuration tools. To ensure that engineering can be done in an efficient and consistent way, there are certain rules defined for how aspect systems shall handle and share configuration data. Different aspect systems can be more or less well integrated into the system. To be able to easily describe how well integrated an aspect system is, different integration levels are defined. Depending on which integration level is selected, the aspect system objects must support different sets of framework-defined interfaces for common object and aspect operations. 286 3BDS011222R4101 Section 2 Concepts Aspect Express System Status Aspect Objects are used to model not only plants, equipment, products, processes and procedures, but also the IIT system itself, including all its hardware and software components. The status of these system parts is modeled as properties of the corresponding Aspect Objects. To make it possible to present status information for all kinds of Aspect Objects in a structured and uniform way, these object properties and the way they are provided must follow certain rules. The System Status framework includes interface definitions and guidelines for how system status information shall be provided, and a System Status Viewer aspect system for presentation of system status to a user. Two levels of system status properties are defined: basic, and additional. The System Status Viewer aspect system presents an overview of the system status as a tree structure of Aspect Objects, based on any of the object structures, with status indications for those objects that provide system status. An Aspect Object can provide a summary status for subordinated objects. This is referred to as propagated status. For example, an object representing a controller can show a summary of the status of all its I/O units. The aspect system that provides system status for the top object, i.e. the controller in this example, is responsible for computing the propagated status. Applications that provide system status information should also report the occurrence of a fault either directly to the system message service or as an OPC/AE event. Besides system status properties, an Aspect Object can also provide further object specific status details through specific aspect views. Aspects that provide system status details have the key System Status Details. The System Status Viewer user interface presents a Show Details link to such aspects. Aspect Express Aspect Express is an excellent tool for rapid aspect system development and it is easy to use. Just a basic knowledge of the Aspect Object architecture is needed. A step-by-step wizard turns ActiveX controls developed in Microsoft Visual Basic 6.0 into aspect systems. The aspect systems can then be packaged and distributed as install able products. 3BDS011222R4101 287 Aspect Studio Section 2 Concepts Aspect Studio Aspect Studio is a comprehensive set of tools for aspect system development. It contains tools both for programming support (including Aspect Express) and software management. A flexible but yet structured and homogenous development environment is provided. It is designed to be run together with the Microsoft Visual Studio package - Visual C++ and Visual Source Safe on the first hand. Aspect systems with extensive functionality and high performance can be developed. For more information on the System Development Toolkit see IndustrialIT 800xA Engineering, Aspect Studio, IndustrialIT 800xA - Engineering, Aspect Express and IndustrialIT 800xA - System, Programming Guide Data Access Data Access Based on OPC Overview IndustrialIT System 800xA OPC Data Access functionality consists of two main functions, OPC Connect and OPC Support. A more detailed description can be found in OPC Connect on page 291. OPC Support is the functionality provided when the 800xA system acts as an OPC Data Access Server. Clients can subscribe data from the OPC Data Access Server. OPC Connect provides connectivity to other OPC Data Access Servers. The OPC Data Access Server of System 800xA is a generic switch which can access other servers referred to as Data Sources. The Data Sources can consist of: • OPC Data Access servers. • Specialized adapters via the DA Connector component. • Aspects that provide OPC properties. • PPA service applications that has been extended with the PPA DA Injector in order to provide OPC access to the service application data. An overview of the Data Access concept is shown in Figure 92. 288 3BDS011222R4101 Section 2 Concepts Data Access Based on OPC Figure 92. Block Diagram of the Data Access Concept The boxes filled with grey denotes Data Access related Components or Aspects. The OPC items represents connections to the Data Sources of the OPC server. In the OPC Data Access Server of System 800xA each item refers to a Data Access property that belongs to an object in the Aspect Directory. The properties of the object are defined by one or more Property Definition Aspects. In System 800xA OPC Data Access there are different types of Property Definition Aspects available. • Direct Access Aspects: Defines Data Access properties implemented by the aspect system. The System 800xA OPC Data Access Server will access these properties by directly invoking these types of aspects. • Control Connection Aspects (CCA) Defines Data Access properties that exist in an external device and are accessed via a System 800xA DA Connector/Adapter. • Global Properties Aspects (GPA) Defines Data Access properties that are common for all objects in the 800xA 3BDS011222R4101 289 Data Access Based on OPC Section 2 Concepts system. A system service application extended with the DA Injector handles these properties in System 800xA . The DA Injector enables the System 800xA OPC Data Access Server to connect to the service. Aspect Directory and Control Structure Aspect Directory is the main component that defines the objects of the 800xA system. The component keeps track of and stores the association between Objects and Aspects. Figure 93. Control Structure Control Structure is stored in the Aspect Directory and maps Objects to Service Groups. In Figure 93 a Control Structure is shown. 290 3BDS011222R4101 Section 2 Concepts Data Access Based on OPC The node Net Root Object holds one or more Data Source Aspects. The Data Source Aspect identifies the service group for the objects pointed out in the Control Structure. OPC Connect Connection to a third party OPC Data Access Server can be made in some different ways. The recommended solution is to run the third party OPC Data Access Server in a Connectivity Server node as shown in Figure 94. A connectivity server may run several OPC Servers, but depending on load, third party OPC Servers may have to run in a separate servers. Figure 94. OPC Server in Connectivity Server Thereby all the benefits with a CSlib connection are achieved. 3BDS011222R4101 291 Data Access Based on OPC Section 2 Concepts If the third party OPC Data Access Server runs in a non-system node, the connection is made via DCOM. This is shown in Figure 95. Figure 95. OPC Server in non-system Node DA Connector/Adapter The System 800xA DA Connector process is a System service of System 800xA controlled by the System service manager of System 800xA. It can only run in a server node in the system. The server node is called a Connectivity Server. In the Connectivity Server an Adapter is specifically designed to access data from a particular type of Data Source. The Adapter is a component that is hosted by the DA Connector process. The Connectivity Server communicates with the clients via the CSLib/System framework. CSLib is a standard communication protocol in the 800xA system. The CSLib component allows redundant, asynchronous or synchronous client/server communication. The System 800xA OPC Server Toolkit provides a special System 800xA OPC Server Adapter to access third party OPC servers. If the third party OPC server is running in the same node as the DA Connector, COM is used for communication. Otherwise DCOM is used. 292 3BDS011222R4101 Section 2 Concepts Data Access Based on OPC DA Injector System 800xA DA Injector is used as a component in a System Service application of System 800xA to expose data to the System 800xA OPC Data Access Server via CS Lib. The System Service application hosts the DA Injector component. The OPC Data Access Server will handle the “injected” service application as if it was the DA Connector. Redundancy Data from a redundant Service Provider is processed by the System 800xA OPC Data Access Server according to provider, quality, timestamp and value. Redundant Service Providers form a logical unit called a Service Group. When the 800xA system is redundant, the OPC Data Access Server can realize two types of redundancy: • Failover • Parallel Failover Redundancy Failover redundancy is the default configuration of redundancy. A subscription is reestablished to a redundant service provider at failure. Load balancing in the Service Group decides which Service Provider the client will be connected to. If a Data Source fails or the contact is lost due to network failure a new connection is established to another service provider in the same service group (failover). The new connection is kept until the original Data Source has been restarted or the network failure has been handled. When the original Data Source is operational again a reconnect is made to the first Service Provider. 3BDS011222R4101 293 Data Access Based on OPC Section 2 Concepts Figure 96 illustrates a redundant connection between client A, B and process control objects AI117, AI118, and AI119 respectively. Figure 96. Redundancy Concept Process control objects AI118 and AI119 have a Data Source that is referring to Service Group 2 containing two service providers. This means that redundancy can be provided by access through either Server B or Server C. Process control object AI117 is represented by Service Group 1 which contains only one Service Provider. Hence redundancy is not provided in this case. 294 3BDS011222R4101 Section 2 Concepts Data Access Based on OPC Parallel Redundancy Each OPC DA Connector Service Group is by default configured to allow parallel redundancy. When parallel redundancy is applied, subscription is always established to two redundant service providers, OPC servers. Load balancing in the Service Group has no effect on the Service Provider selected. Parallel redundancy has the benefit of no loss of data if one service provider fails. Selection of good quality data is performed when data quality differs between the Service Providers. Parallel redundancy might increase Controller Network load. Upload The uploader function is used to import a configuration from the connected devices. The function collects the Objects of the OPC Server and appends them as Aspect Objects in the Control Structure. Each node in Control Structure is represented by an Object Type. The levels of Control Structure tree are described below with reference to Figure 93: • Level 1 This is the Net Root node. Each root has an Uploader Data Source Aspect. The root node must exist before the Uploader is launched. • Level 2 to n-1 Node objects such as Station, Controller and Type. • Level n, leaf nodes As each leaf node corresponds to a process object, each leaf node has a Control Connection Aspect (CCA). The aspect type is determined by the previous node in the tree. The Name Aspect of a leaf node indicates the name of the control object together with name saved in the CCA. 3BDS011222R4101 295 Data Access Based on OPC Section 2 Concepts Authenticated Write Authentication of write operations to certain OPC Items can be performed before the actual access to the Item. This is to protect the OPC Item from unauthorized writing or writing by mistake. Authenticated write can only be used if: • The write operation is asynchronous. • The System 800xA OPC Data Access Server is executing within an Operator Workplace application process. Each property is, in the Property Info tab of the Control Connection aspect, configurable if it should be: • Not authenticated • Authenticated • Double authenticated. Every property in the write operation must be granted access for the authentication to succeed. If the authentication is successful, the operation is passed on to the corresponding Data Source, otherwise it will be rejected. Confirmed Write Confirmed write may not be supported by all 3rd party OPC Servers. To ensure that an operator writes correct values to correct properties in a controller a confirmed write function is introduced. This is particularly useful in safety critical applications where online operations are performed. The Confirmed Write function supports user confirmation and data protection of OPC write operations. Confirmed write can only be used if: • The write operation is asynchronous. • The OPC Client is running in an Operator Workplace application process. A synchronous read or a write performed by a System Service of System 800xA will not trigger the Confirmed Write function. The accessed device may in this case stop the write access. Write operations from third party OPC clients will be terminated unconditionally. 296 3BDS011222R4101 Section 2 Concepts Data Access Based on OLE DB To reduce the risk for unintended write operations the following functions are added: • A confirmation dialog box shows the property and the write value before the actual write operation is performed. The user is prompted to proceed or reject the operation. • A data transfer check is realized by means of Cyclic Redundancy Check (CRC) or other methods to ensure that data value is written correctly. This is to protect against transmission or program failures. The feature is optional and is activated if any Aspect on the object that holds the CCA supports it. Confirmed write is configured for each property. Configuration details on data access based on OPC see Data Access on page 613. Data Access Based on OLE DB You can use the OLE DB provider included into IndustrialIT System 800xA as the access path for report tools. Most of the existing third party report tools can use OLE DB providers to retrieve information and then produce reports. The name of the OLE DB provider is ABB OLE DB Provider for Data Access. You access the OLE DB provider through a command syntax. Furthermore, you can utilize a graphical user interface to specify a short reference to the data that you want to refer to from your client software. Configuration details on data access based on OLE DB see How to use the OLE DB Provider on page 649. 3BDS011222R4101 297 Data Access Based on OLE DB Section 2 Concepts 298 3BDS011222R4101 Section 3 Configuration This section provides you with more detailed information on engineering and configuration workflow and working steps than the Concepts section. It first introduces you into Engineering Tasks and an Overall Project Workflow, then you learn about configuration steps to perform when you work with • Libraries • Object Types • Automation Solution • Production Management • Information Management • Version and Access Management • Asset Optimization. • Data Access The configuration steps are described either as general instruction steps or as example based instruction steps. Some areas such as Object Types and SMS and email Messaging contain information as detailed as reference information whereas other subsections reference the corresponding detail information given in other System 800xA manuals. 3BDS011222R4101 299 Engineering Tasks Section 3 Configuration Engineering Tasks The engineering and configuration of an Industrial IT System 800xA consists of a number of engineering tasks and incremental steps within those tasks. Many of these engineering tasks can be performed in parallel and others can be executed in a different order. The project workflow shown in Figure 97 and described in this manual is an example workflow how the engineering tasks could be executed. When your experience grows you will also realize where you can execute them in parallel or in another order and where not. Which aspects to configure depends on the aspect systems and the combination of aspect systems in your special instance of a 800xA system. A sketch of Functional Structure built early, for example derived from P&IDs, can help to identify typical solutions to implemented as Object Types/ Composite Object Types. If you have designed and implemented these Object Types / Composite Object Types you can start to build final Functional Structure and the further structures. Every entity on the road that exists more that once could be made as a composite object type. A (composite) object type might not just be a motor or valve. It can tanks, process units or even whole production lines. There are four major reasons for using a type object based application design: • Better application quality in the first place, since less coding is needed. • Less validation work in validated installations, since less coding is needed. • Less application maintenance costs, since less code exist. • Less memory need in the controller, since many instances refer to the same code (type). Analysis and Design Before you start the engineering work, you need to make an analysis of the system you are going to build. This analysis can be seen split into six parts: • 300 Domain analysis 3BDS011222R4101 Section 3 Configuration Engineering Tasks • Identifying Aspect Objects • Identifying Object Types • Identifying Structures • Identifying Composite Object Types (Typical Solutions) • Identifying Security Settings If the analysis and design to come to a Plant model is done during the Plant Design phase or in the early steps of the Configuration (Software Production and Test) phase depends on the concrete project. User Roles User roles adapt your environment depending on your role. You assign user role when you add a user to a specific Industrial IT user group. The following user roles exist: • Operator can control the process. • Application Engineer can do engineering operations. • System Engineer can do system administrative tasks. User roles help to customize the environment to suit the needs of each user. This means that the operations the user needs to act on are visible. Domain Analysis The intention of the domain analysis is to identify entity objects and structures in the domain. This analysis should be based on existing standards for how systems are composed into different structures, for example IEC61346. See International Electrotechnical Commission’s home page (www.iec.ch) for details. Normally, you start with the top object in the functional structure and start to decompose it according to functionality, thus creating a functional structure of objects. 3BDS011222R4101 301 Engineering Tasks Section 3 Configuration Identifying Aspect Objects The found domain entity objects are mapped into aspect objects. The aspect objects are used as container models for the domain entity objects. Their aspects will correspond to the functionality of each respective entity. Identifying Object Types If applicable, the found domain entity objects are mapped into existing standard Object Types. You should also identify if new object types need to be developed. Identifying Structures The aspect objects are put into structures. Try to identify the structures of the real objects in order to make models of them in the Plant Explorer tool. Identifying Composite Object Types (Typical Solutions) Try to identify functionality that occurs in several parts of the plant. These functionality parts should be identified and described in order to be a base for a Composite Object Type (built and stored in the Object Types Structure). Composite Objects Types are used as big building blocks. If applicable, the found Functionality parts are mapped into existing standard Composite Object Types. Identifying Security Settings When you plan for the data security of a plant installation, you have to take the total security into consideration. It is not enough to make a strong fire wall if people have free access to the operator’s room in the plant. Establish a detailed risk management program which covers the complete spectra of risks. Make a catastrophe plan. Make plans for how to recover and how to restore. You also need to have procedures for testing, that your security plans function in a number of situations. You have to inform and educate your employees about the security plans for the plant. Update the plan requirements once per year. For further information read the IndustrialIT 800xA - System, Administration and Security manual. 302 3BDS011222R4101 Section 3 Configuration Engineering Tasks Building of Objects After the analysis and design you can start to build, or import if earlier created, the building blocks - the Composite Object Types. The reasons for you to create these are: • Each Composite Object Type that can be used repeatedly will save engineering work. • You get a methodology with which you can break the process down into smaller parts that are easier to grasp and handle. As soon as you have the blocks available you can get started. Many are provided initially when you install the libraries provided with the IndustrialIT System 800xA product. In principle you have to create / build • the Plant Structures (Functional, Control, Location, Documentation) and Overview Drawings / Graphical Displays • the Controller Applications • and the remaining Applications (covering Alarm and Event-,Trend-, History-, Asset Optimization-, Information Management-, and Batch Managementfunctionality). 3BDS011222R4101 303 Overall Project Workflow Section 3 Configuration Overall Project Workflow In the following sections the overall project workflow for configuration of the 800xA system shown in Figure 97 and additionally explained in Table 12 is referenced as a guideline. This workflow is typically executed on an Engineering System (either on-site or offsite). When executed on an On-site Engineering System it is included into the workflow described in Figure 102 and Table 13. Please be aware that this workflow is an example reference workflow you can and probably have to adapt to the needs of your concrete engineering project. The generic term Process Function used in Figure 97, Table 12 and in the following subsections represents a building block implemented by an object type or composite object type. It represents a building block of different granularity, for example a whole process section, a tank, a drain system or a single PID loop. Both Figure 97, Table 12 and the following subsections do not mention iterations in the engineering workflow. Such iterations of course exist and have to be passed if a step leads to non satisfactory results and the causes have to be corrected in the step(s) before. 304 3BDS011222R4101 Section 3 Configuration Overall Project Workflow Build Project Library - Identify common equipment and devices from P&ID's and select reusable entities - Select applicable Objects from Base Library, - Add to and modify as necessary - Create basic Structures Create Process Functions - Use Objects from Project Library Modify/Allocate Process Functions - Add Specific logic - Assign I/O Channels - Assign to Controller Applications Design/Build Graphics -Using graphic elements defined during library creation. Extend Configuration - Add extended functionality (IM,AO,Batch Management, etc) Generate Application Software Download and Test Application Software Figure 97. Overall Project Workflow 3BDS011222R4101 305 Overall Project Workflow Section 3 Configuration Table 12. Workflow Activities Workflow Step Activities Create Project Environment Create System (Remark: Not mentioned in workflow chart) Select and Load Standard Object Type Libraries Load / Import other reusable entities and standards Customize Project Environment Build Project Library Identify common equipment and devices from P&IDs and select reusable entities Select applicable Object Types from Standard Libraries Complete Project Library: - Build New Object Type Libraries - Adapt Standard Object Type Libraries - Write Specifications / Guidelines Create Basic Structures - Create Upper Level Plant Structures (Functional,Control, Location, Documentation) from Object Types Create Process Functions Build Lower Level Functional Structure from Standard Object Types Build Lower Level Functional Structure from Adapted Object Types Modify / Allocate Process Functions Add Specific Logic Assign I/O Signals Allocate to Applications in Control Structure Allocate I/O Signals to Boards in Control Structure 306 3BDS011222R4101 Section 3 Configuration Overall Project Workflow Table 12. Workflow Activities Workflow Step Design / Build Graphic Displays Activities Finalize Graphic Displays from Object Types Design and Build New Upper Level Graphic Displays Using graphic elements defined during library creation Extend Configuration Add Production Management Functionality (Batch Management and Manufacturing Management) Add Information Management Functionality Add Asset Optimization Functionality Finalize Lower Level Location Structure Finalize Documentation Structure Generate Application Software Generate Controller Code Download and Test Application Software Deploy Graphic Displays Download Controller Code Load other Run-time Configuration data Test complete Configuration 3BDS011222R4101 307 Build Project Environment Section 3 Configuration Build Project Environment Create System At first you have to create the standard environments on the aspect server and, if available, on the client(s). This requires, that all programs and libraries, necessary for the execution of a project, are already installed on the server and on the clients. 1. On the aspect server create a system using Configuration Wizard. (A system contains all data of a project, therefore we will further talk of a system / project or, short, of a project.) Configuration Wizard must be accessed with a local administrators account. 2. Load all necessary system extensions. (There are system extensions of different categories: Applications or Libraries). 3. Introduce the users for that system/project via Windows 2000 / XP tools and Configuration Wizard 4. Configure access from the client workplaces to the system / project on the server using Configuration Wizard For more information on system creation and related tasks to perform with Configuration Wizard see the section on System Creation in IndustrialIT 800xA System, Post Installation Setup and the section on Configuration Wizard in IndustrialIT 800xA - System, Administration and Security. Load Libraries and Standards 308 1. Install and load the libraries for the target control system. For AC 800M the object type libraries are loaded with the AC 800M Connect system extension. 2. Install and load basic standard object type libraries such as Basic Object Type Library. 3. Install and load further standard object libraries and typical solution libraries needed for the project and depending on libraries installed and loaded in step 1 and 2. For example for AC 800M signal engineering you need the CBM_Signals object type group loaded with the AC 800MC Signal Extension system extension. 3BDS011222R4101 Section 3 Configuration Build Project Library Depending on the library you include it into your project either via loading a corresponding system extension or via import using the Import Export tool (AfwImport/Export). An example of the first kind of loading is the collection of libraries included in the AC 800M Connect system extension which also loads the AC 800M Connect Aspect System. An example for the second kind of loading is the Basic Object Type Library. Available standard libraries for AC 800M are shortly described in IndustrialIT800xA - Control and I/O, Addendum, Product Data and Design Customize System During and after system creation some settings/actions are required to ensure that the system can be used by application engineers in the engineering project effectively. A collection of such settings and actions are described in IndustrialIT 800xA - System, Post Installation Setup. Build Project Library Assumption is that the basic analysis and design is already done and the results are available to be used as data for example in tabular formats (for example in data base or spreadsheet tables) and overview drawings (such as P&IDs). You have identified common equipment and devices from P&IDs and you have selected reusable entities. Whenever possible you map the reusable entities to applicable Object Types / Composite Object Types from existing standard libraries and, if no applicable object type is available, you implement these reusable entities as own object types / 3BDS011222R4101 309 Build Project Library Section 3 Configuration composite object types of own versioned libraries or as extensions to existing object types / composite object types. First task to perform when doing engineering within the 800xA system is to obtain an enough powerful tool-box of reusable objects, the object types / composite object types you need to build the automation solution. These objects may be derived from several different sources: Some are already included in the standard libraries of AC 800M Connect / Control Builder M Professional, some are included in libraries made by ABB End User Divisions or OEMs, some may come from previously made projects, and some you need to built yourself. Whenever possible base these objects on the objects delivered with the standard libraries of System 800xA. Whenever possible also Extended Configuration issues should to be taken care in building the object types / composite object types of the Project Library. In general as little instance specific additions as possible should be done. Complete Project Library In this working step you do adaptations and introduce extensions to the standard project environment regarding the solutions to reuse. In general you finally specify and build the common base for reuse of solutions in your engineering project: 310 • Versioned Object Type Libraries in the Library Structure • Object Types / Object Type Groups in the Object Type Structure • Reuse Instructions in the Library Structure and corresponding Object Types in the Object Type Structure • And further reusable elements in the Library Structure: – Document Manager Templates – Alarm&Event Configurations – History Log Templates – Trend Templates – Scripts 3BDS011222R4101 Section 3 Configuration Build Project Library Versioned Object Type Libraries Whenever applicable you create your own new and adapted object types and composite object types in own versioned object type libraries. This gives you the path for controlled introduction of new versions of object types supported by Control Builder M Professional. Steps and examples how to create a versioned library and how to switch to a new version is described in Libraries on page 328. Build New or Adapt Existing Object Types How you build new Object Types and Composite Object Types or adapt existing object types in general is described in Building Object Types on page 333. How to build object types from Control Builder M Professional perspective is described in IndustrialIT 800xA - Control and I/O, Basic Control Software, Introduction and Configuration. Any of the five IEC 61131 languages are preferably used when building the control logic in the Composite Object Types. Function Designer can be used to build control module types too. An example how to build an own composite Process Object Type with Signal objects of AC 800MC Signal Extension / object type group CBM_Signals that supports functional planning is given in Process Object Type with Signals on page 352 and in Process Object Type Built in Function Designer on page 356. Specifications and Guidelines Another work part for completing the project library is to collect and/or write and adapt the specification, description, guideline and template documents for your project. At this stage of the project work you can store all your project documents an document templates on a work directory on your local disk. The templates you can introduce as Document Manager templates in the Library Structure. 3BDS011222R4101 311 Create Basic Structures Section 3 Configuration If the templates shall be used in object types of your Project Library you extend these object types with corresponding document aspects. After the basic Documentation Structure (see Create Basic Structures on page 312 below) has been built the specification, description, guideline documents can be made available in folder/binder objects of Documentation Structure using Document Manager aspects. Typically there are a lot of project documents. The objects with the document aspects can be created/imported using Bulk Data Management functions. Corresponding example instructions you can find in Document Management on page 541. Create Basic Structures In this working step you create the upper level plant structures (Functional,Control, Location, Documentation) from object types of your project library. Depending on the design of the library the objects on upper level are of a descriptive / structuring kind or they already have a relevant process function part. Typically a plant is modeled in three structures: • Functional Structure • Control Structure Be aware that the structuring of the Control Structure in the default case for a 800xA system is given by AC 800M connectivity • Location Structure The documentation of a plant can additionally be modeled in Documentation Structure. For small projects it might be sufficient to work in Control Structure only. 312 3BDS011222R4101 Section 3 Configuration Create Basic Structures Figure 98. Basic Structures: Functional, Control and Location Building Basic Structures in this context means always to specify the hierarchy of the upper level for the relevant structures by use of Aspect Objects. The Basic Structures build the base for adding design information in later stages: • Add information as additional aspects. • Add information by additional Process/Location/Control (System) /Document Objects. Identification of Aspect Objects Each level in the Basic Structures (represented by Aspect Objects) should be identified unambiguously in accordance to the designation system used by customer. The Plant Explorer supports for this purpose two different concepts: 3BDS011222R4101 313 Create Basic Structures Section 3 Configuration 1. Identification of Aspect Objects by name This is the default mechanism using the Name aspect and preferred concept, if the customer uses no reference designations. 2. Identification of Aspect Objects by reference designations This is the preferred concept, if the customer uses reference designations according to IEC 61346. Examples are: – Function reference designation (=), via Functional Designation aspect. – Location reference designation (+), via Location Designation aspect. At least when building the Basic Structures only one of those concepts should be used consequently. When adding details during later design stages, it might be necessary to use combinations of reference designations and names for identification. Be sure to include the needed designation aspects already in the object types of your project library. To be able to identify objects unambiguously in every practical case Bulk Data Manager additionally supports object identification via absolute reference designation (ARD) with Name, object path, path combined with absolute reference designation (ARD), and object and structure aspect GUID (internal globally unique identifier). 314 3BDS011222R4101 Section 3 Configuration Reference Designation Create Basic Structures Name Type Name (Object type) Figure 99. Identification of Aspect Objects Make sure that your Plant Explorer Settings configure the Name Composer so that Absolute Reference Designations (%ARD%) are displayed for the object instances. Principles of Reference Designations, usage of Function Reference Designations, Control Reference Designations, Location Reference Designations, and Documentation Reference Designations are described Structured Plant Modelling on page 83. Importing Design Information Result of the analysis and design process is a certain amount of design information describing aspect objects and aspects. Typically the design information are / can be made available as data in relational databases or spread sheets as lists. The tools of the Engineering Workplace supports you in solving the problem to bring in the design information into the structures / objects of your system /project. The data representing the design information can be entered into Plant Explorer manually object by object: Create object from object type and enter the property values. 3BDS011222R4101 315 Create Basic Structures Section 3 Configuration Or, which is much more efficient when an lot of objects result from the analysis and design process, the data available in relational databases or spread sheets are used to create the aspect objects from object types and setting the object properties automatically using Bulk Data Management functions. Starting data entry in Plant Explorer manually, for example just for the first two structure levels, does not exclude switching to list based configuration with Bulk Data Management when it comes to real bulk work. You can easily extract the manually entered data to a Bulk Data Management worksheet, refine it, extend it and then write it back to the system / project. 316 3BDS011222R4101 Section 3 Configuration Create Basic Structures Functional Structure The example in Figure 98 shows a basic Functional Structure imported using a Bulk Data Manager worksheet. How you can configure such a worksheet is described in the IndustrialIT 800xA - Engineering, Engineering Workplace, Basic Engineering Functions manual. Figure 100. Basic Function Structure Imported via Bulk Data Manager Importing design data via Bulk Data Manager as shown in Figure 100 can be applied to all structures. If available, functional layout diagrams and descriptions are added to the objects via Document or AutoCAD_Drawing aspects. Control Structure At an early stage of the project work Control Structure might be specified by basic analysis and design considerations. Below the Control Network there are several 3BDS011222R4101 317 Create Basic Structures Section 3 Configuration Control Projects splitting the configuration work into reasonable part projects. Below the Applications folder of each Control Projects there are a number of Applications assumed. The Applications each are connected to at least one Controller of the controllers under the Controllers folder. (More often several applications are connected to only one controller then an application is distributed in several controllers.) The number of controllers needed to run the applications are estimated. It might be that the Hardware units of the controllers are already estimated. You can create basic Control Structure in Plant Explorer or in Control Builder M Professional object by object or you can create it from a Bulk Data Manager worksheet. Figure 101. Basic Control Structure in Control Builder M Professional and Plant Explorer 318 3BDS011222R4101 Section 3 Configuration Create Basic Structures How to design basic Control Structure depend on the concrete project requirements and on the experience how applications can be run on controllers. Some design hints are given in IndustrialIT 800xA - Control and I/O, Basic Control Software, Introduction and Configuration. Location Structure The basic Location Structure in this context includes at least the topographic locations like buildings, floors, rooms,…. It should detailed down to the level that is necessary for clarification in this stage. If available, topographic layout diagrams and descriptions are added to the objects using Document or AutoCAD_Drawing aspects. You can create the basic Location Structure in the Plant Explorer object by object or you can create it from a Bulk Data Manager worksheet. Documentation Structure The documentation of the project is modeled by folder/binder and sub folder/grip/package objects and document objects. Already at this stage you can build the basic folder/grip/package structure of your project´s Documentation Structure. You can create the basic Documentation Structure in the Plant Explorer object by object or you can create it from a Bulk Data Manager worksheet. Next you can create documentation objects within the structure that contain the standard documents and templates in your project. You can do this by configuring a Bulk Data Management worksheet that creates the Objects and Documentation aspects and imports the document files. Additionally you can insert the objects of basic Functional Structure, Control Structure and Location Structure holding Document or AutoCAD_Drawing aspects beneath corresponding folder/grip/package objects in Documentation Structure. You can build up Documentation Structure to hold the whole user-created documentation base for the 800xA system, for the engineering project work and for the plant operation and maintenance. This gives you quick and structured access to all needed informations contained in documents. 3BDS011222R4101 319 Create Process Functions Section 3 Configuration Create Process Functions Build Lower Level Functional Structure What is considered to be the start of the lower levels in Functional Structure depends on the granularity of the objects you deal with to build the process function part of your project. Presuming the object types delivered with AC 800M connectivity of System 800xA you deal here with Process Objects (for example of the ProcessObjExtLib), Control Loops (for example of the ControlBasicLib) and corresponding Signal objects provided additionally by the AC 800MC Signal Extension / object type group CBM_Signals of Engineering Workplace. You instantiate the object types object by object using Plant Explorer or Control Builder M Professional or using Bulk Data Management worksheets.The latter is recommended when you have to create many objects, have to parameterize their properties or if you expect several change cycles. If you have built composite Process Object types or Control Loop object types including the required Signal objects as shown in the example Process Object Type with Signals on page 352 instantiation results in a complete Process Object or Control Loop including the components for the Function Diagram for the process function. To build a Function Diagram of a process function in an object of the next level above some Process Objects / Control Loops you create a Function aspect in this next level object and configure a new diagram within Function Designer. The function component representations for the objects of the Process Objects / Control Loops below are available in this Function Diagram immediately and only have to be connected and placed. Build Lower Level Control Structure Assuming you have already created Control Structure down and including to the level of application objects and to down and including the Controllers you now create the Communication Boards, I/O Stations, I/O Boards from Object Types of the Project Library as required. You do this either object by object Plant Explorer or Control Builder M Professional or Bulk Data Management worksheets. The latter is 320 3BDS011222R4101 Section 3 Configuration Modify / Allocate Process Functions recommended when you have to create many objects, have to parameterize their properties or if you expect several change cycles. Build Lower Level Location Structure You create location objects like Floor / Room / Coordinate from Object Types of the Project Library. You do this either object by object using Plant Explorer or Control Builder M Professional or with Bulk Data Management worksheets. The latter is recommended when you have to create many objects, have to parameterize their properties or if you expect several change cycles. Modify / Allocate Process Functions Add Specific Control Logic In the Function Diagrams of the process functions you can add glue and interlock logic at your requirements. See IndustrialIT 800xA - Engineering, Engineering Workplace, Function Designer. Assign I/O Signals If you have used object types as shown in the example Process Object Type with Signals on page 352 and Process Object Type Built in Function Designer on page 356 the needed Signal objects are already available and in place. If not you have to create them (could be you have done it during Build Lower Level Functional Structure on page 320) and insert them beneath the process object in Functional Structure. Both can be done using Bulk Data Management worksheets. Allocate Process Functions to Applications in Control Structure The function components (including the control logic) of the process functions have to be assigned to allocatable groups. How you can do this in detail in Function Designer or in Plant Explorer is described in IndustrialIT 800xA - Engineering, Engineering Workplace, Function Designer. By default the Function Diagram of a process function object corresponds to an Allocatable Group (the object contains an Allocatable Group aspect). 3BDS011222R4101 321 Design / Build Graphic Displays Section 3 Configuration An object with an Allocatable Group aspect has to be inserted below the Control Modules folder of an Application object in Control Structure. This results in generation of a Single Control Module in Control Builder M Professional, containing all functions, function blocks and control modules contained in the Function Diagram and covered by the Allocatable group. The Application object in turn is connected to a Task of a Controller. Allocate I/O Signals to Boards in Control Structure The I/O Signal objects (of AC 800MC Signal Extension / object type group CBM_Signals) have to be allocated to corresponding channels of I/O boards. This you easily can do with the smart I/O-Allocation function and the Write Allocation to CBM function both provided in the object context menu of Engineering Workplace. If the Signals have already been allocated before the Function Designer itself executes the Write Allocation to CBM function part. See IndustrialIT 800xA Engineering, Engineering Workplace, Basic Engineering Functions. Design / Build Graphic Displays Finalize Graphic Displays from Object Types If you have instantiated object types on the process function level with preconfigured graphic displays yo now can finalize these displays using graphic elements defined in the Process Object, Control Loop and other object types from your Project Library. How you do this in detail is described in IndustrialIT 800xA Engineering, Graphics. Design and Build New Upper Level Graphic Displays If you do not have already pre-configured graphic displays in the process function objects you create Graphic Display aspects and build the corresponding displays from scratch. You use graphic elements defined in the Process Object, Control Loop and Signal object types from your Project Library. How you do this in detail is described in IndustrialIT 800xA - Engineering, Graphics. 322 3BDS011222R4101 Section 3 Configuration Extend Configuration Extend Configuration Whenever possible also Extended Configuration issues have to be taken care in building the object types of the Project Library. In general as little instance specific additions as possible should be done. Add Production Management Functionality See Production Management on page 528 for principal information how to add Batch Management and Manufacturing Management functionality. Add Information Management Functionality How to handle documents in Documentation Structure already is described in subsections on Documentation Structure. See Historical Process Data on page 535, Extended Configuration Data on page 537 and Document Management on page 541 on informations how to add information management functionality. Add Asset Optimization Functionality See Asset Optimization on page 608 for principal information how to add Asset Optimization functionality. Finalize Lower Level Location Structure You do final updates of the already existing location objects and add or insert additional objects in Location Structure. Depending on the size of the plant at least the locational overview of the most important hardware units and process functions should be reached. Finalize Documentation Structure You do final updates of the already stored documents and add additional document aspects or document objects with document aspects. In general all needed project documents and all needed operation / maintenance documents should be accessible via Documentation Structure. 3BDS011222R4101 323 Generate Application Software Section 3 Configuration Generate Application Software As Control Builder M Professional works on one Control Project in Control Structure at a time the application software for the controllers has to be generated Control Project by Control Project. For one Control Project: When Signal objects (of AC 800MC Signal Extension / object type group CBM_Signals) have been allocated to their I/O boards in Control Structure and all allocatable groups of Function Diagrams have been allocated to Application objects in Control Structure the application software for the Control Project is already generated. Before downloading you can test the application software using the Test Mode in Control Builder M Professional or using SoftController. See IndustrialIT 800xA Control and I/O, Basic Control Software, Introduction and Configuration and IndustrialIT 800xA - Engineering, Engineering Workplace, Function Designer. Download and Test Application Software Deploy Graphic Displays After development of the Graphic Displays they have to be deployed to be ready to be used in the system. See IndustrialIT 800xA - Engineering, Graphics. Download Controller Code You download the control application software per Control Project using Control Builder M Professional Tools>Download Project and Go Online. This also the way to load changes. They are detected and loaded automatically. See IndustrialIT 800xA - Control and I/O, Basic Control Software, Introduction and Configuration and IndustrialIT 800xA - Engineering, Engineering Workplace, Function Designer. Load other Run-time Configuration data Depending on your 800xA system´s hardware and software configuration you might have to load or introduce additional configuration results on servers / clients to be ready to test. See the configuration instructions of the corresponding functional area. 324 3BDS011222R4101 Section 3 Configuration Download and Test Application Software Test Complete Configuration You use Control Builder M Professional and Function Designer in Online mode to verify the functionality of the control application software running on the controllers. You use the given 800xA system´s hardware and software configuration to test all functions of your application software: From the I/O hardware to the displays, printers, archives, alarm devices, etc. and back. Depending on the test process simulation you have available/ have developed you include also process simulations in your test. See IndustrialIT 800xA - Control and I/O, Basic Control Software, Introduction and Configuration and IndustrialIT 800xA - Engineering, Engineering Workplace, Function Designer and further corresponding configuration instructions. 3BDS011222R4101 325 On-site Engineering Workflow Section 3 Configuration On-site Engineering Workflow In an On-site Engineering environment the project workflow extends as shown in Figure 102. Figure 102. Extended Project Workflow for On-site Engineering 326 3BDS011222R4101 Section 3 Configuration On-site Engineering Workflow Table 13. Workflow Activities On-site Engineering Workflow Step Activities according overall project workflow on ES Activities See Table 12. See Figure 97. Create System ConfigurationVersion on PS Define System Configuration Version in System Configuration Version Definition object /aspect in the Maintenance Structure. Execute Creation of the System Configuration Version (full backup). Connect ES with PS Make sure you have network access from ES to PS (same domain). Connect ES as client to PS and vice versa. Create Synchronization Package on ES Define Synchronization in a Synchronization Definition object/aspect in Maintenance Structure Define Synchronization scope (Structure, tree, object) Execute Find Differences between ES and PS Verify the differences Execute Synchronization package creation Load Synchronization Package on PS (Synchronize ES with PS) Verify Changes in PS Check conditions on PS for a synchronization On PS execute Synchronization from Configuration Wizard > System Administration>Synchronize System Verify structures/trees/objects changed by synchronisation: - If OK: Continue - If not OK: Restore System Configuration Version Download / Activate Changes in PS 3BDS011222R4101 If applicable: Download/activate changes 327 Libraries Section 3 Configuration For details on System Synchronization see the corresponding subsections in Versioning and Life Cycle Management on page 574. Libraries Building Versioned Object Type Libraries The following example creates a new versioned library that shall get object types with control aspects for Control Builder M Professional. How to create object types in this new library is shown in Process Object Type with Signals on page 352 and Process Object Type Built in Function Designer on page 356. The activities described correspond to Build Project Library, Versioned Object Type Libraries if you need to build an own library. It is possible to package an own library as a System Extension installation kit using Aspect Express, see IndustrialIT 800xA - Engineering, Aspect Express. Starting from Plant Explorer 328 1. In the Library Structure you select the Libraries object. 2. On the Libraries object you create an instance of the Library object type. You name it ProcObjSigExtLib. 3. In the Additional Arguments dialog showing next you select the Object Type Structure Insertion Point, for example: Object Types/Control System/AC 800M\/C Connect / Libraries. 4. Open Control Builder M Professional on the Project that you want to use for library development: On your Control Project object execute context menu item Open Project. 5. Select the Library Version object ProcObjSigExtLib 1.0-0 below the Library object and add a Library aspect (provided by the AC 800M Connect aspect system). This aspect makes the Library known to Control Builder M Professional. 6. On the General tab of Library Version Definition aspect of the Library Version aspect edit the fields Company , Department and Developer and press Apply. 3BDS011222R4101 Section 3 Configuration Building Versioned Object Type Libraries 7. Now you can start to add your object types to the library below the Library Version object in the Object Type Structure (see Building Object Types on page 333 for more general considerations and Process Object Type with Signals on page 352.). 8. After you have added your object types, you Close the library on the General tab for test. 9. To test the library on another machine you create a Library Archive via the corresponding button in the General tab, transfer the archive to the other machine and import it there. 10. For changes you Open the library again add the changes and repeat the previous two steps. 11. After having finished the test you can Release the library in the General tab and create the final archive using the Library Archive button. In the Save Archive Dialog you determine where the .afw archive file is stored. Changes to a released library you can only introduce by creating a new library version of that library. The library archive is an .afw file loadable with Import / Export tool. Starting from Control Builder 1. In Project Explorer of Control Builder M Professional opened on your Control Project select the Libraries folder 2. On the Libraries folder (with right mouse click) create a new Library. You name it ProcObjSigExtLib. The following happens automatically in Plant Explorer: The Library object and the Library Version object below is created in the Library Structure below the Libraries folder object. The Library Version object is inserted in the Object Type Structure below Object Types/Control System/AC 800M\/C Connect / Libraries. Below the Library Version object the folder objects Control Module Types, Data Types, Function Block Types and Internal Types are created. 3. On the General tab of Library Version Definition aspect of the Library Version aspect edit the fields Company, Department and Developer and press Apply. 3BDS011222R4101 329 Building Versioned Object Type Libraries Section 3 Configuration 4. Now you can start to add your object types to the library below the Library Version object in the Object Type Structure (see Building Object Types on page 333 for more general considerations and Process Object Type with Signals on page 352.). 5. After you have added your object types, you Close the library on the General tab for test. 6. To test the library on another machine you create a Library Archive via the Library Archive button in the General tab. In the Save Archive Dialog you determine where the .afw archive file is stored. Transfer the archive to the other machine and import it with the Import / Export tool there. 7. For changes you Open the library again, add the changes in and then repeat the previous two steps. 8. After having finished the test you can Release the library in the General tab and create the final archive using the Library Archive button. In the Save Archive Dialog you determine where the .afw archive file is stored. Changes to a released library you can only introduce by creating a new library version of that library. The library archive is an .afw file loadable with Import / Export tool. New Version of a Library A new version of an existing released library can be created from Plant Explorer. 330 1. In the Library Structure you select the Library object. (Control Builder M Professional has to be opened on the Control Project you used to develop the initial library version.) 2. On the Library object you create an instance of the Library Version object type. You enter or accept the proposed the version designation (e.g. 1.1-0) for the predetermined Library (in our case ProcObjSigExtLib). 3. Select the Library Version object ProcObjSigExtLib 1.1-0 below the Library object and add a Library aspect (provided by the AC 800M Connect aspect system). This aspect makes the Library known to Control Builder M Professional. 3BDS011222R4101 Section 3 Configuration Using Versioned Object Type Libraries 4. On the General tab of Library Version Definition aspect of the Library Version aspect edit the fields Company, Department and Developer and press Apply. 5. Now you can start to add your changes to the object types of the library below the Library Version object in the Object Type Structure (see Building Object Types on page 333 for more general considerations and Process Object Type with Signals on page 352.). 6. After you have added your changes, you Close the library on the General tab for test. 7. To test the library on another machine you create a Library Archive via the Library Archive button in the General tab. In the Save Archive Dialog you determine where the .afw archive file is stored. Transfer the archive to the other machine and import it with the Import / Export tool there. 8. For changes you Open the library again, add the changes in and then repeat the previous two steps. 9. After having finished the test you can Release the new library version in the General tab and create the final archive. using the Library Archive button. In the Save Archive Dialog you determine where the .afw archive file is stored. Using Versioned Object Type Libraries Having imported a new version of a library with the Import / Export tool into your system you have to insert this new library version into your control project: 1. Open your Control Project via object context menu item Open Project. 2. In the Control Project object select the Project aspect. 3. On the Libraries tab of the aspect view press the Insert button. 4. Select the Library Version object from the Select a Library dialog and press OK. Then you can upgrade object instances created based on the object types of the previous library version to the object types of the new library version. You can do this on a per application base (for all object instances created from object types of the library) either in Plant Explorer or in Control Builder M Professional by connecting the new library version as the substitution of the previous library version. 3BDS011222R4101 331 Using Versioned Object Type Libraries Section 3 Configuration If needed you can perform downgrade accordingly. Upgrade in Plant Explorer Using Application aspect: 1. Select the Application object /aspect 2. Select Libraries Tab of the Application aspect 3. Select the offered Library version, for example ProcObjSigExtLib 1.1-0 and press Connect. 4. As a result all object instances in the Application of the object types in ProcessObjSigExtLib 1.0-0 are upgraded to the corresponding object types of ProcessObjSigExtLib 1.1-0. Using Library Version Definition aspect: 1. Select the Library Version Definition object/aspect of ProcObjSigExtLib 1.1-0 in Library Structure 2. Select the Upgrade Tab 3. Browse to the Application object 4. Press the Search button 5. Move all objects created from object types of ProcObjSigExtLib 1.0-0 available in the left list to the right list 6. Press Apply. 7. As a result all object instances in the Application of the object types in ProcessObjSigExtLib 1.0-0 are upgraded to the corresponding object types of ProcessObjSigExtLib 1.1-0. Upgrade in Control Builder 332 1. Select the Connected Libraries folder of your Application in Project Explorer 2. After pressing right mouse button execute Connect Library 3. From the Connect Library dialog´s combo box select ProcessObjExtSigLib 1.1-0 3BDS011222R4101 Section 3 Configuration Object Types 4. Press OK 5. Press OK for the warning message that another version of the library is connected and that this connection will be replaced. 6. As a result all object instances in the Application of the object types in ProcessObjSigExtLib 1.0-0 are upgraded to the corresponding object types of ProcessObjSigExtLib 1.1-0. Object Types Building Object Types This chapter will show, step by step, how to create a simple object type for an imaginary application. A lot of other possibilities are available even for a simple object type, but the full description of all possibilities is in the reference part (Reference Information for Object Types on page 673 in Appendix B, Object Types). The activities described here correspond to Build Project Library, Versioned Object Type Libraries if you need to build an own library. The imaginary application consists of a large number of manufacturing cells. Each cell should have one aspect object containing an operating manual, a general property aspect with cell data and an operator note aspect. It should also be possible, and easy to create a file viewer document to log information about the cell in. One way to create these information objects could have been to create each object for the cells individually and add the needed aspects on them. Another, more effective, way is to create an object type describing how instances of this object type should be created. This example will show how to create an object type Cell Information. To create an Object Type you need to have the Application Engineer role. 3BDS011222R4101 333 Building Object Types Section 3 Configuration Object Type Group Creation Object types are collected into object type groups placed in the Object Type Structure. The following steps have to be done to create a new object type group, in our case named Cell Information Object Type Group. 1. Go to the Object Type Structure and select the root object Object Types. 2. Using the New Object dialog, make a new aspect object of the type Object Type Group below the object Object Types, and name it Cell Information Object Type Group. The object type group is itself an instance of an object type that only allows object type groups, object types and aspect groups to be created below it. Object Type Creation Object types are created within an object type group. To create the Cell Information Object Type, do the following steps: 1. Select the Cell Information Object Type Group object. 2. Using the New Object dialog, make a new aspect object of the type Object Type, and name it Cell Information. When the Cell Information object is created it gets the following aspects. Table 14. Aspects on an Empty Object Type 334 Aspect Description Name Name of the object type. Object Type Structure Structure aspect. Aspect Category Definition The object type is also an aspect category, which allows aspects to be inherited from the object type. Cell Information Object Type Group Reference A reference to the object group where the object type is placed. 3BDS011222R4101 Section 3 Configuration Building Object Types Table 14. Aspects on an Empty Object Type Object Type Type Reference A reference to the type of the Cell Information object. Since it is an object type, it is a reference to an predefined object type “Object Type”. Cell Information Type Definition The definition aspect for the Cell Information object type. It is in this aspect most configuration work is done. So far the object type is empty. We can already now create an instance of the object type, but to make the object type more useful we first want to configure its aspects. There are two ways to configure which aspects an instance will get. Either with preconfigured aspects or by creating empty new aspects. • Preconfigured aspects are described using the Aspect Control tab. These aspects are placed on the object type. • New empty aspects are described using the Category Control tab. These aspects are not available on the object type, only on the instances. Our next step is to add the preconfigured aspects to the object type: 3. To add an aspect to the object type, select the object Cell Information object type and make a new aspect of the aspect category Operating Manual and configure it. 4. Add and configure a General Properties aspect and a File Viewer aspect. 3BDS011222R4101 335 Building Object Types Section 3 Configuration The Cell Information object type should now look like this: Figure 103. Aspects on the Cell Information Object Type Next step is to define how the new aspects should be treated when an instance of the object type is created. There are three different methods to treat an aspect on the object type when an instance is created. It can be inherited to the instance, it can be used as a template for new aspects, or a new aspect of the same aspect category can be created on the instance. 336 3BDS011222R4101 Section 3 Configuration Building Object Types For our Cell Information Object Type we use the following reasoning for the different aspects. Table 15. Aspects Treatment for the Cell Information Object Type Aspect Treatment and reason General Properties Copy since most of the properties are the same in all cells, but it is likely that we need to change them. File Viewer Template for a log document for the cell. Only used if an aspect of the File Viewer category is created on an instance of the Cell Information object type. Operating Manual Inherit since the same operator manual will be used for all cells. 5. 3BDS011222R4101 In the Aspect Control tab, on the Cell Information Type Definition aspect, select the General Properties aspect. Uncheck the Inherit to all instances check box and check the Use as template. For Log Document check the Copy to all instances check box and leave Inherit to all instances check box for the Operating Manual. 337 Building Object Types Section 3 Configuration Figure 104. Cell Information Object Type Aspect Control Tab 6. 338 We also want to create a new Operator Note aspect on all instances, and make the File Viewer aspect proposed when new aspects are created on the instances. The way to do this is to use the Category Control tab. Add a File Viewer category and a Operator Note category to the category list. Select the File Viewer category and check the Propose when creating new aspect check box. Select the Operator Note and check Create on all instances check box. Also specify that only one aspect of each aspect category can be created. The result should be: 3BDS011222R4101 Section 3 Configuration Building Object Types Figure 105. Cell Information Object Type Category Control Tab These steps are the minimal configuration that has to be done for a simple object type. There are a lot of other configurations described in Reference Information for Object Types on page 673 in Appendix B, Object Types. The newly created object type will immediately show up in the New Object dialog. See Figure 106. 3BDS011222R4101 339 Building Object Types Section 3 Configuration Figure 106. New Object Dialog Box with the Cell Information Object Type An instance of the Cell Information object type will get these aspects: Figure 107. Instance of Cell Information Object Type 340 3BDS011222R4101 Section 3 Configuration Building Object Types The Cell Information Type Reference aspect is the reference to the object type this object is an instance of. Figure 108. Relation between Object Type and Object Type Instances When the New Aspect dialog is activated on the Cell Information instance the dialog only will contain the proposed File Viewer category, until the Show all check box is checked. 3BDS011222R4101 341 Building Object Types Section 3 Configuration Figure 109. New Aspect Dialog Box on a Cell Information Instance The General Properties aspect and the Operating Manual aspect are required by the object type, and cannot be deleted from the instance. If an aspect on the object type is changed, the change will be propagated to all instances, unless the aspect on an instance has been overridden by a local change. Subtype Creation and Object Type Extensions The object type system allows an object type to be extended in two ways, either with a subtype or with an object type extension. An instance from a subtype inherits its type rules from both the subtype and from the supertype. An object type extension adds more type rules directly to an object type. The major difference between subtyping and object type extension is that instances created from the supertype are not changed when subtyping it, but an object type extension on an object type changes all created instances. An example makes the statements above a little bit easier to understand. 342 3BDS011222R4101 Section 3 Configuration Building Object Types Extending an Object Type / Subtype Assume that we, in our imaginary application, have a protected cell that needs additional information compared with an ordinary cell. Instead of doing a complete new object type Protected Cell Information, the Cell Information object type could be extended with the additional information for a protected cell. The following steps creates a subtype of the Cell Information object type and adds new document aspects, Maintenance and Service Manual, to it. 1. Select the Cell Information Object Type Group, create a new Object Type object, and name it Protected Cell Information. 2. On the Protected Cell Information Type Definition aspect, select the Type Info tab. Uncheck the No supertype check box. Press Select and select the Cell Information object type. Figure 110. Defining a Protected Cell Information as a Subtype 3BDS011222R4101 343 Building Object Types Section 3 Configuration 3. Create the Maintenance and Service Manual aspects on the Protect Cell Information object type and configure them. 4. Select the Aspect Control tab on the Protected Cell Information Type Definition aspect and check the Inherit to all instances check box for the Maintenance and Service Manual aspect. The supertype, in this case the Cell Information object type, will show that Protected Cell Information is a subtype to it in the Type Info tab of the Cell Information Definition aspect. Figure 111. The Supertype Cell Information after Subtyping All configuring done on the supertype will be inherited to the subtype. The Aspect Control tab of the Protected Cell Information object type shows all aspects that will be created for an instance of this type, but the inherited aspects are not possible to configure. All options are dimmed. 344 3BDS011222R4101 Section 3 Configuration Building Object Types Extend an Object Type / Object Type Extension Definition Aspect Sometimes it is necessary to be able to develop an object type at different locations. It could be, for an example, that the subcontractor for the electronic drawings will deliver the drawings that should be part of the Cell Information object type. The Object Type Extension Definition aspect makes it possible to add, for example a Electrical Drawing aspect to the object type Cell Information from an import file without having to change the Cell Information object type. To make an extension to an object type in another aspect system than the system where the object type is defined, make the following steps. 1. Create a new Object Type Group and an Object Type. Name it the same way as the object type group and object type to extend. 2. Create an Object Type Extension Definition aspect on the object type to extend. 3. Create and configure the aspects the object type extension should have. 4. Select the Aspect Control tab for the Object Type Extension Definition aspect and configure the treatment of the added aspects, just as we did when creating a simple object type. 5. Export the aspect that extends the object type and the Object Type Extension Definition aspect to an afw-file with the Import/Export tool. 6. Open the afw-file on the system where the object type to extend available using the Import/Export tool. The aspects has to be manually placed on the object type to be extended. Composite Object Type Creation Composite Object Types are used to define more complex typical solutions that decrease the engineering effort. This section will outline the principles and provide examples of how to build and use composite object types. The reasons for building composite object types are: • 3BDS011222R4101 The engineering time is decreased due to field proven solution. A composite object type that is tested and verified does not need the same amount of testing when it is reused. 345 Building Object Types Section 3 Configuration • By using composite object types, you are able to break down your system into blocks. This makes it easier to build and maintain the structures. • A composite object type makes it possible to create multiple objects in more than one structure. As an example of how to use composite object types, consider a tank with a drain system that is used in a milk reception, see Figure 112. Drain system Figure 112. Example of Drain System The drain system is a good example of a typical solution that can be built using a composite object type. In this example we have a drain system that consists of a flow transmitter and a transfer pump. We assume that the object types for the flow transmitter and the pump (which also can be composite) already exist. 1. 346 First we build a simple Drain System object type and configure it using the Drain System Type Definition aspect. 3BDS011222R4101 Section 3 Configuration 2. Building Object Types Below the object type, we then create a Formal Instance List object, with the New Object dialog, for each structure where we require that the composite object will be created. Below each formal instance list we will describe the wanted layout of the composite instance for this particular structure. Each formal instance list defines a required minimum structure. The instance objects can later be inserted at other places, but the default structure defined by the formal instance lists can only be changed in the type, and not in individual instances. In our example we create three formal instance lists, for Functional Structure, Documentation Structure and Location Structure. The wanted structure is chosen in the Additional Arguments area of the New Object dialog. Figure 113. New Object Dialog Box for Formal Instance List 3BDS011222R4101 347 Building Object Types Section 3 Configuration When you create a formal instance list, Plant Explorer will automatically insert the top-level type object below the formal instance list. Since the objects below the formal instance lists defines the complete wanted object hierarchy we must include also the top object. It is allowed to remove the inserted top object if we only want to insert some child objects in a specific structure. This is often the case for Location Structure, where we in our case only want to place the flow transmitter and the transfer pump, and not the drain system itself. 3. The first time the child objects are used, they are created in the New Object dialog. You create them in the same way as you create instances in other structures. But if you want to place a child object below several formal instance lists, you must use the Insert Object dialog to place them at the additional places. You can also just drag a child object to the new place while you have <SHIFT+CTRL> pressed. In this example we first create the child objects for Functional Structure. We then remove the Drain System object from Location Structure formal instance list, and insert the child objects Flow Transmitter and the Transfer Pump instead. The final result is shown in Figure 114. Figure 114. The Result in the Object Type Structure 348 3BDS011222R4101 Section 3 Configuration 4. Building Object Types We can now create an instance of the Drain System type in Functional Structure, see Figure 115. Figure 115. Instance of Drain System in Functional Structure In the structure where you are working, the object instance is placed where you create it. In all other structures it is placed at the root level, from where you can drag it into its proper position. In our example we have specified that the top object of the instance also should be inserted into Documentation Structure. Here it will appear at the root as shown in Figure 116. Figure 116. Instance of the Drain System in Documentation Structure We have also specified that the child objects Flow Transmitter and Transfer Pump should be inserted into Location Structure. They will also appear at the root of the 3BDS011222R4101 349 Examples of Object Types Section 3 Configuration structure. In Figure 117 we have already moved these objects below the Building object where they belong. Figure 117. Instance of the drain System in Location Structure Examples of Object Types Control Object Types / Composite Control Object Types To build object types or composite objects with control aspects you can either start from within Control Builder M Professional or from within Plant Explorer. Start with CBM: 1. Create the object type in the your library in CBM 2. Edit the control contents in CBM 3. Add a Function Aspect in Plant Explorer to the corresponding object type aspect object in the Object Type Structure in Plant Explorer if the object type shall be used in Function Designer. 4. Add the non-control aspects to the corresponding object type aspect object in the Object Type Structure in Plant Explorer. Start with Plant Explorer: 350 1. Create object type in your library in Plant Explorer 2. Add a Control Module Type or Function Block Type aspect 3. Add a Function Aspect in Plant Explorer to the corresponding object type aspect object in the Object Type Structure in Plant Explorer if the object type shall be used in Function Designer. 3BDS011222R4101 Section 3 Configuration Examples of Object Types 4. Add the non-control aspects to the corresponding object type aspect object in the Object Type Structure in Plant Explorer. 5. Edit the control contents in CBM or, if the control aspect is a Control Module Type, in Function Designer. To edit control content of a Control Module Type aspect of such an object type you can use Function Designer as shown in Process Object Type Built in Function Designer on page 356. See IndustrialIT 800xA - Control and I/O, Basic Control Software, Introduction and Configuration and in Control Builder M Professional Help for more details on building control aspect contents of object types in Control Builder M Professional. When you create control object types you should carefully consider which objects shall show up in Control Structure / Function Structure of Plant Explorer as described in the following subsection. Aspect Object Creation in Control Structure In order to avoid performance issues in the Aspect Directory, there is a way to minimize the number of Aspect Objects created from Control Builder M Professional. Aspect Object is an attribute on object types, on instances of object types in the application, and on formal instances (instances inside function block or control module types) in Control Builder M Professional. If the attribute is true on the type an Aspect Object is created. Otherwise, no Aspect Object is created. On object types it is set by the verb Instantiate as Aspect Object, on instances by the verb Aspect Object. Objects not interacting with other objects in Plant Explorer should have the aspect object attribute set to False for not loading the Aspect Server performance. The user can change the Aspect Object attribute on the instance if he wants to override the default creation as described above. For objects created from the Plant Explorer the attribute Aspect Object is always by default set to true. 3BDS011222R4101 351 Examples of Object Types Section 3 Configuration Function Designer has a corresponding function to switch between Aspect Object and Symbol Object, see Switching Between Aspect Object and Symbol Object on page 159. Process Object Type with Signals In the following example you add an composite object type to the library ProcObjSigExtLib created in Versioned Object Type Libraries on page 311. It shall contain a process object type with the needed engineering I/O signal objects (from the CBM_Signals object type group provided with the AC 800MC Signal Extension system extension) to support • I/O Signal Engineering • and I/O Allocation from Functional Structure to Control Structure • and creation of a complete Function Diagram of the instance in a process function object on the level above the instance. In our example case the I/O Signal objects correspond to Global Variables on Application level which will be connected to Parameters of the Control Module Type named EW_MotorUniM_IOGAppl_Var. Steps to build the composite object type 352 1. Build the Control Module Type or Function Block Type in CBM beneath the ProcObjSigExtLib 2. Add the needed graphical aspects to the object in Object Type Structure 3BDS011222R4101 Section 3 Configuration 3. Examples of Object Types Extend the object type in Object Type Structure with formal instances of Signal objects in Functional Structure as shown in Figure 118. Figure 118. Process Object with its Signal Objects 3BDS011222R4101 353 Examples of Object Types 4. Section 3 Configuration Modify the CBM_SignalInformation aspect of each Signal object as follow: Select Create and Connect to Application Global Variable Figure 119. Figure 119. Modify Signal Information Aspect 5. 354 Result after Instantiation and having performed I/O Allocation: The instance in Functional Structure shows the Process Object and its corresponding Signal objects (as shown in Figure 120), the engineering data contained in the Parameter aspects of the Signal objects is transferred to the corresponding Control Module properties using the I/O Allocation function of Engineering Workplace. In a process function object above the instance a Function Diagram in Function Designer shows immediately shows the components that easily can be placed an connected to show the complete 3BDS011222R4101 Section 3 Configuration Examples of Object Types function as shown in Figure 121. Figure 120. Process Object Instance with its Signal Objects Figure 121. Function Diagram of the Process Object Instance with its Signals 3BDS011222R4101 355 Examples of Object Types Section 3 Configuration The example object type shown here demonstrates how process object types similar as contained in the ProcessObjectExtLib of Control Builder M Professional can be extended to fit to Functional Planning including I/O-Signal engineering objects. As you see in Figure 119 the CBM_SignalInformation aspect in cooperation with the I/O Allocation function supports the whole spectrum of connection cases. More details are given in IndustrialIT 800xA - Engineering, Engineering Workplace, Basic Engineering Functions and IndustrialIT 800xA - Engineering, Engineering Workplace, Function Designer. Process Object Type Built in Function Designer The basic steps to built an object type comparable to the one described in Process Object Type with Signals on page 352 within Function Designer are: 356 1. Create a Control Module Object Type beneath the Library Version object in Object Type Structure to represent the process function 2. Add a Function aspect 3. On the Function aspect of the Control Module Object Type representing a process function open the Diagram view and create a new Diagram. 4. Use the Insert> Symbol... menu item and its Insert Objects dialog to insert the the needed objects of object type MotorUniM , CBM_DIS (2x), CBM_DOS(2x) and CBM_AIS. Their component representations show up in the Diagram, the objects are created in Object Type Structure 5. Do the graphical connects for the components in the Diagram using e.g. the mouse 6. Change the names for the components as required by right clicking the component representation and selecting the corresponding Name aspect from the context menu: For the Signal components use the Relative Name aspect, for the MotorUniM component use the Control Builder Name aspect. It is recommeneded to use a naming scheme for the Signal components like <control builder name>_<signalpostfix>, as this is supported by instance name generation mechanisms in Bulk Data Management (and in the Engineering Workplace context menu item Advanced>Rename Substructure). 3BDS011222R4101 Section 3 Configuration Examples of Object Types 7. Configure the CBM_SignalInformation aspects of the Signal objects to connect to local variables: Select Connect to Local Variables on CM,FB 8. In the Object Type Structure insert the formal instance of the object type MotorUniM (created by Function Designer below the Formal Instance List for Control Structure) also under the Formal Instance List for Functional Structure in parallel to the formal instances of the signal objects. 9. With the Insert> Symbol... menu item and its Insert Objects dialog add Input/Output Parameters (from Functional Planning / Generic Function Components / Connectors / Diagram Parameters / ...) as required and connect them to function component ports as required. This will allow you to connect to corresponding ports of the new object type´s component in an upper level Function Diagram. 10. Execute File>Generate Configuration Data: Now the object type is ready to be used. Note that Function Designer supports creation of Control Module object types. It does not support creation of Function Block object types. 3BDS011222R4101 357 Examples of Object Types Section 3 Configuration Result is shown in and in Figure 122 and Figure 123. Figure 122. Object Type with Signals in Function Diagram 358 3BDS011222R4101 Section 3 Configuration Examples of Object Types Figure 123. Object Type with Signals in Plant Explorer Note that Input / Output Parameter objects of Figure 123 by default are Symbol Objects and therefore not visible in Functional Structure. They can be switched to Aspect Objects. When instantiating this object type the instance shows as shown in Figure 124 and Figure 125. 3BDS011222R4101 359 Examples of Object Types Section 3 Configuration Figure 124. Instance in Function Structure and Control Structure You can navigate from the Function Diagram on the upper level to the nested diagram on the lower level with the context menu item Goto Nested Diagram. This is called vertical navigation. 360 3BDS011222R4101 Section 3 Configuration Examples of Object Types Figure 125. Instance in Function Diagram on Upper Level / Goto Nested Diagram Signal Group A Signal Group is a specific signal object type and represents a couple of base IO signal objects types (e.g. CBM_AIS, CBM_DOS) which are combined in a structured data type of the Control Builder. To build a Signal Group you perform the following steps: 3BDS011222R4101 361 Examples of Object Types 1. Section 3 Configuration In Control Builder M create a new structured data type which represents the IO connection. Figure 126. Structured Datatype for I/O 2. Add an additional Object Type Group in your library and create a new object type, for example IOSAgitator. Figure 127. Object Type IOSAgitator 3. 362 Add a Control Builder Name aspect to object IOSAgitator and set the Aspect Control in the Object Type Definition aspect to Copy to all instances. 3BDS011222R4101 Section 3 Configuration 4. Examples of Object Types Add a CBM_SignalInformation aspect and configure as shown in Figure 128 Figure 128. Signal Information 5. Add for each structured data type component the appropriate signal object below the Formal Instance List of object type IOSAgitator (see Figure 127). a. The Relative Name should be the component Name of the Data Type (e.g. FB1, FB0, Cmd0, Cmd1, Current). b. Each IO signal should get an additional Name aspect which has the Signal Group name as prefix with an additional suffix. c. For each IO signal the CBM_SignalInformation aspect has to be set as "Create and connect to Application Global Variable of Structured Data Type (Signal Group)".See step 4. This will create a global variable during code generation in the Application. The following additional steps have to be performed if the object type shall be used in Function Designer: 6. 3BDS011222R4101 Copy and paste the Function Parameter aspect and then the Function aspect from the CBM_DIS object type into IOSAgitator signal group object type. 363 Examples of Object Types 7. Section 3 Configuration Open the component view from the Function aspect and modify the component according to Figure 129. Figure 129. Representation of IOSAgitator as Function Component 364 3BDS011222R4101 Section 3 Configuration 8. Building Reuse Instructions Open the Aspect Properties (right mouse click on background) and adapt according to Figure 130. Figure 130. Aspect Properties IOSAgitator 9. In the Object Type Definition aspect of object type IOSAgitator set the Aspect Control for the CBM_SignalInformation aspect to Copy to all Instances. 10. Open the Diagram view from the Function aspect and add a diagram template A3 Landscape. The child signal objects will be displayed on the diagram. Building Reuse Instructions To build a Reuse Instruction and to generate it into an object type you have to perform the principal steps: 1. Open the Reuse Design Structure. 2. Create a new object of type Reuse Instruction, name it at your choice. 3BDS011222R4101 365 Building Reuse Instructions Section 3 Configuration 3. Define needed substitution variables in the Reuse Substitution aspect as required by the solution you want to implement as a Reuse Instruction. 4. If you need a Reuse Global Operation or Reuse Pre Operations or Reuse Post Operations insert an aspect of the corresponding aspect category into the Reuse Instruction object. 5. On the Reuse Global Operation aspect you enter the operation code in VBScript. 6. On the Reuse Pre Operations or Reuse Post Operations aspect you enter the operations using the New button as required by your solution by selecting prepared operations from three different categories: General Operations (New Object, New Aspect, Modify Property, Script Block, Insert Object, Overwrite Aspect), Object Type Operations (New Object Type, Modify Aspect Control, Modify Category Control, Modify Child Control, Set Supertype) or Control Builder M operations (Add Variable, Add Parameter, Add Alarm, Modify Alarm, Generate FB Calls). 7. Below the Reuse Instruction object you configure the Question and Answer tree by creating instances of Reuse Question and Reuse Answer object types. You name the objects according to the questions and answers. Designate one of the answers to a question as default answer using the object context menu item Default Answer. 8. In each Reuse Answer object you configure the Reuse Answer Operations aspect with operations (see above, as with Reuse Pre Operations or Reuse Post Operations) implementing the answer. 9. When done you select the Reuse Instruction Generator aspect in the Reuse Instruction object and you browse to the object type you want to generate the Reuse Instruction into (and, if not yet available, you create it). 10. To enable consistency checks when instantiating a Reuse Instruction enter the check marks for the required system extensions in the Required System Extension tab. 11. If you have entered script code for operations then also complete the entries in the Required Object Types tab and in the Required Aspect Categories tab. 366 3BDS011222R4101 Section 3 Configuration Building Reuse Instructions 12. Finally you generate the Reuse Instruction into the object type using the Check and Gen button. To instantiate the object type with the Reuse Instruction you perform the steps: 1. Create an instance of the object type in an applicable structure.. 2. Select the ReuseAssistantBuilder aspect of the instance. 3. Enter the required values for the substitution variables. 4. Press Next button to go to the first question displayed in the aspect pane and press the radio button for the required answer. 5. Do this for all questions. 6. When done, press the Execute button and confirm execution: The object instances will be build / extended according to the choices you have made. The example in Figure 131 and Figure 132 show a generic drive system implemented by a Reuse Instruction. Figure 131. Reuse Instruction for Drive System Variants in Reuse Design Structure 3BDS011222R4101 367 Building Reuse Instructions Section 3 Configuration Figure 132. Instantiated Reuse Instruction for a Drive System Variant 368 3BDS011222R4101 Section 3 Configuration Automation Solution Automation Solution Control Logic How to configure control logic in Control Builder M Professional see IndustrialIT 800xA - Control and I/O, Basic Control Software, Introduction and Configuration and in Control Builder M Professional Help. This subsection´s focus is implementing control logic using Function Designer. The activities described here correspond to step Create Process Functions. Function Diagrams Having prepared Libraries with own object types like shown in Process Object Type with Signals on page 352 or Process Object Type Built in Function Designer on page 356 you build your project´s control logic for Function Diagrams with the following principal steps: 1. Configure a Bulk Data Management workbook/worksheet for instantiation and basic parametrization of the object types 2. Create and parameterize the instances in Functional Structure using the Bulk Data Management workbook (or do it object by object in Plant Explorer). 3. In the objects representing the process functions in Functional Structure create a Function aspect. 4. In the Function aspects create a new empty Function Diagram: The Function Components of the levels below show up in the diagram automatically. 5. Connect the component ports on the current diagram graphically as required. 6. If needed add additional glue or interlock control logic by inserting and connecting further Function Components 7. Add Diagram References as required to connect to other Function Diagrams and connect them to ports on the current diagram. 8. Create Diagram Variables for the Diagram References respectively connect the to existing Diagram Variables. Besides implementing the connections between the control logic of the diagrams this implements horizontal navigation between the connected diagrams of the process function objects. 3BDS011222R4101 369 Control Logic Section 3 Configuration 9. Allocate the Function Diagrams to Applications in the corresponding Control Project. 10. Allocate the I/O Signal objects to (channels of) boards. 11. Generate Configuration Data for the Control Project. 12. In Control Builder M Professional go into Test-Mode / Download Project and Go Online to test. 13. Test in Control Builder M Professional and Function Designer online mode. If you use the standard object type libraries of AC 800M connectivity you have to create, parameterize and assign the needed I/O Signal objects for functional planning in separate steps. Copy Function Diagram If you want to reuse the finalized Function Diagram of the process function object you copy it with a Bulk Data Management worksheet. 370 1. Make sure that the names of the subordinated objects all contain the name of the process function object at the beginning as a provision for automatic renaming of the copies. 2. Open an empty Bulk Data Management worksheet, for example on an object above the process function object containing the Function Diagram to be copied. 3. Make sure that the Bulk Data Manager options Object Path, Full Path, Transaction by Object are set and Subtree enabled is checked. 4. Make sure that all aspect properties you intend to parameterize for the copied Function Diagram are published as Publish via Parent Diagram using the Aspect Properties/Parameter dialog. 5. To configure the configuration headline drop in the Function aspect of the process function object containing the Function Diagram to copy. 6. Select the published properties to be included into the configuration headline from the Configure Properties dialog shown during drop. 7. Get the template line for copying by dropping in the process function object 3BDS011222R4101 Section 3 Configuration Control Logic 8. Copy the line as often as you require. 9. Fill out the Source Object column cells with the full path to the process function object using for example Insert Object Path... cell context menu item. 10. Edit the new destination names in the Object Identification column cells and in the Control Builder Name.Name column cells. 11. Edit the actual values for the parameters (published properties). 12. Press the Save All Objects button. 13. The process object function including its subtree is copied and renamed and parametrized n-times. The copies are ready to be allocated. Detail information on building, allocating Function Diagrams, on generating configuration data for Function Diagrams and on testing Function Diagrams is given in IndustrialIT 800xA - Engineering, Engineering Workplace, Function Designer. This manual also contains step by step instructions on Enhanced Bulk Data Manager Support and Bulk Operations for Function Diagrams: • Copy Diagram(s) • Copy and Rename Loop Diagram(s) • Bulk Connect Diagram References • Bulk Allocate Diagrams • Bulk Generate Configuration Data • Diagram Status in Bulk Data Manager and in System Status Viewer • Bulk Documentation and Contents Chapter • Create Diagram(s) How to configure Bulk Data management worksheets in general is described in IndustrialIT 800xA - Engineering, Engineering Workplace, Basic Engineering Functions. Export / Import Function Diagram To export/ import a single Function Diagram: 3BDS011222R4101 371 Control Logic Section 3 Configuration 1. Export function diagram (Single Control Module) without dependencies and with children: a. Drag and drop the diagram object from Control Structure and from Functional Structure into the Import/Export tool into the same AFW file, uncheck Include Dependencies and check Include Children. Note that the smallest unit that can be exported with dependencies is a Control Application. b. In case of a nested diagrams (or diagrams with multiple allocatable groups) that are allocated to different applications, the substructure in Functional Structure differs from the one in Control Structure. c. Make sure that you add all children in functional structure, and all diagrams / allocatable groups in Control Structure that correspond to the allocation of the nested diagrams / allocatable groups. Otherwise you might get inconsistent data on import. d. You will get the diagram with its children in Control Structure and in Functional Structure, including diagram references in Functional Structure. 2. On import, used types (application defined and library defined ones) must exist in the system. 3. In import of a diagram with references to other diagrams, you will get a query to replace existing diagram variables: a. Yes: Diagram references get connected to the diagram variable(s). b. No: Diagram references get unconnected. More export / import use cases for Function Diagrams are described in IndustrialIT 800xA - Engineering, Engineering Workplace, Function Designer. 372 3BDS011222R4101 Section 3 Configuration Control Hardware Units Control Hardware Units You add the needed hardware units (typically the I/O boards) to your control project with the following principle steps corresponding to Create Process Functions, Build Lower Level Control Structure, (Assign I/O Signals) and Allocate I/O Signals to Boards in Control Structure: 1. Configure a Bulk Data Management workbook/worksheet for instantiation (and, if needed for basic parametrization) of the hardware unit object types into Control Structure. 2. Create the hardware unit objects in Control Structure using your Bulk Data Management worksheet. 3. Allocate bulks of I/O Signals (for example Signal objects created and /or parameterized with Bulk Data Manager and assigned to process objects) to channels of hardware units (boards) with the smart I/O Allocation function available via Engineering Workplace object context menu item Advanced > IO Allocation. 4. Do channel parameterization from the I/O Signal objects to I/O board hardware unit objects either explicitely via Engineering Workplace object context menu item Advanced > Write Allocation into CBM or implicitely performing Generate Configuration Data in Function Designer or from the Config View of an Allocatable Group aspect. You need to use Generate Configuration Data in Function Designer if the Name of a Signal object used in a Function Diagram was changed. How to configure Bulk Data Management worksheets and how to use I/O Allocation is described in IndustrialIT 800xA - Engineering, Engineering Workplace, Basic Engineering Functions. Topology Status Viewer To configure a Topology Diagram to view status for the whole plant you perform the following principal steps. They correspond to Create Process Functions, Build Lower Level Control Structure and also to Download and Test Application Software: 1. 3BDS011222R4101 On every Controller object: Add a Topology aspect, open Diagram view and add a new Diagram based on the skeleton for the Controller level (AC 800M 373 Topology Status Viewer Section 3 Configuration Single / AC 800M Redundant). Controllers and the Hardware Units below by default have Topology aspects with pre-configured Component views. They are placed by default on the diagram. Save the diagram. 2. Create Topology aspects and configure the Component view for the objects to represent in the hierarchy above the controllers. 3. If applicable add texts/labels to the new Components with aspect property references that subscribe to status information. Or include other elements with access to and representation of status information, for example ActiveX controls. 4. On the object representing the plant add a Topology aspect and create a new Topology Diagram from the skeleton Plant Network. It is populated automatically with the Topology Components in Control Structure hierarchy below your plant object down to the Controller objects. 5. Arrange the Components and connect them as required. Add additional labels/ texts / graphical symbols as required. 6. Switch on Subscribe for Live Data in the View menu Live Data status information is shown. Prerequists are: OPC servers are operating and Controllers are running. 7. To view and navigate such Topology Diagrams (as already shown in Figure 51 and Figure 50) from a Graphic Display on Operator Workplaces you include an Aspect Link to the top Topology aspect in Control Structure into this Graphic Display. 8. Then operators or maintenance persons (with Operator Role) can inspect the live status information in the diagrams and navigate in the hierarchy of diagrams by a. pressing the Aspect Link button in the Graphic Display to open the pop-up window with the Topology Diagram, b. using the object context menu item Goto Nested Diagram (for example on a controller object shown in the diagram), c. setting Window >Workbook Mode for the pop-up window, d. and switching on View>Subscribe for Live Data for the diagrams. Additionally these persons can print out the Topology Diagrams. 374 3BDS011222R4101 Section 3 Configuration Process Graphics Process Graphics Typically you build a graphic display per process function. The principal steps, corresponding to Design / Build Graphic Displays and also to Download and Test Application Software, are: 1. Create a Graphic Display aspect (or use the template display that might be available in your process function object, for example provided via the object type) 2. Edit it with Graphics Builder 3. Draw / adapt the background picture 4. Insert and configure the Graphic Elements provided with the instances of the Process Objects and Signal Objects. (Typically these are inherited from the corresponding object types.) 5. Test the Graphic Display in Graphics Builder 6. Deploy the Graphic Display 7. Test the Graphic Display with downloaded an running application software on the controller. How to build and use Graphic Displays, Graphic Elements and Faceplates is described in detail in IndustrialIT 800xA - Engineering, Graphics. Alarms and Events Configuration of the basic System 800xA workplace functionality for Alarms and Events is is done using Alarm and Event List Configuration aspect and an Alarm and Event Logger Configuration aspect (or their default configurations) as provided in the Library Structure in the Plant Explorer. Details of basic Alarm and Event configuration are described in IndustrialIT 800xA - Operations, Operator Workplace, Configuration. The following subsections describe how you extend basic Alarm and Event handling with SMS and e-mail Messaging. 3BDS011222R4101 375 Alarms and Events Section 3 Configuration SMS and e-mail Messaging Throughout the SMS and e-mail Messaging procedures, unless otherwise specified, access to aspect views is accomplished by right-clicking on the object and selecting the aspect from the context menu. This opens the aspect in a new window. It is also possible to double-click an aspect in the Aspect List Area to open the aspect in a new window. To view the aspect in the Aspect Preview Area of the Plant Explorer Workplace, select the aspect in the Aspect List Area. When creating aspects, it is possible to add a description and name to the aspect as desired. If the aspect is not named, the aspect category name is used and displayed in the Aspect List Area. Unless otherwise specified, the SMS and e-mail Messaging procedures use the aspect category name. When the various structures are set up as desired, it may become necessary to move some SMS and e-mail Messaging aspects to other areas in the structures by using the drag and drop method. Attempting to use the drag and drop method on SMS and e-mail Messaging aspects while they are active will result in the following loss of configuration: • Alarm and Event Message Source: loses reference to Alarm and Event List and resets it to blank. Message Handler referencing the Alarm and Event Message Source loses its reference. • Message Handler: loses reference to Alarm and Event Message Source. • Message Subscriber: loses reference to TAP/Modem, SMS/GSM, and/or SMTP/Email Device. • TAP/Modem, SMTP/Email, and/or SMS/GSM Device: Message Subscriber loses reference to device. • Message Schedule: No effect. To avoid these problems, copy and paste the aspects to the desired location, and then delete them from the original location. SMS and e-mail Messaging will not stop acting on the previous configuration until the service is disabled and then enabled. Refer to Enabling/Disabling SMS and e-mail Messaging on page 416. 376 3BDS011222R4101 Section 3 Configuration Alarms and Events Setup and Configuration Workflow The following is a typical setup and configuration workflow for SMS and e-mail Messaging. 1. 2. Set up hardware (one, two, or all). a. Set up GSM hardware. b. Set up Hayes compatible modem hardware and run test utility. c. Run e-mail test utility. Set up system. a. Define default telephone number for Central Paging Terminal of paging service provider. b. Define default e-mail address that appears in from field when users receive messages and where error messages may be sent. c. Create User Groups and add users to groups if required. d. Set up message subscriber for each user: Add devices. Configure devices. Assign priority. 3. e. Set up Message Schedule for each user. f. Set up Messenger Event List. g. Check status of SMS and e-mail Messaging service. Configure system. a. Configure Alarm and Event Message Source: Select Alarm and Event List to monitor. Set message content and length. b. Configure Message Handler: Select Alarm and Event Message Source and enable/disable source. Select users and/or groups to send messages to and assign priority. 3BDS011222R4101 377 Alarms and Events Section 3 Configuration Configure timeout before resending the message and number of attempts before changing destinations. Enable/disable destinations. c. Configure Alarm and Event Service Groups if required. Setup and Configuration Worksheets Appendix D, SMS and E-Mail Messaging, subsection Setup and Configuration Worksheets on page 703 contains worksheets to help in setting up and configuring SMS and e-mail Messaging. • Table 22: GSM Hardware Setup Worksheet. • Table 23: Aspect System Structure Setup Worksheet. • Table 24: Users Worksheet. • Table 25: User Setup Worksheet. • Table 26: Configuration Worksheet. The worksheets are also designed to be used as configuration records. Each one starts on a new page for ease of copying. Keep these records in a safe place for future backup/restore or upgrade activities. It is very important to read, understand, and follow the setup and configuration procedures before filling in the worksheets.The following procedures, which the worksheets are designed to be used with, are divided into three major categories: • • • Hardware Setup. System Setup. Configuration. Hardware Setup Perform the following procedures before setting up and configuring the SMS and email Messaging aspects in the Plant Explorer Workplace: • • • 378 GSM Hardware. Modem Hardware (Hayes Compatible). Modem Hardware Test Utility (optional). 3BDS011222R4101 Section 3 Configuration • Alarms and Events E-mail Test Utility (optional). GSM Hardware GSM hardware (GSM modem or a telephone with a built-in GSM modem) supporting the AT+C command set (GSM 07.05 and GSM 07.07) are compatible with the SMS/GSM Device. Configuration of each individual personal GSM telephone number occurs while setting up the Message Subscriber. Refer to Message Subscriber on page 401. A list of GSM service providers is shown in Appendix D, SMS and E-Mail Messaging, GSM Service Providers on page 712, Table 27. The list of GSM service providers shown in the table can be made available in a pick list used later in this procedure by using Windows Explorer to navigate to: ...\Program Files\ABB Industrial IT\Operate IT\Messenger\bin and launching SrvSetup.exe. The GSM hardware is set up using the Aspect System Structure. This procedure requires that the Messenger Server be disabled before configuring the SMS device (refer to Enabling/Disabling SMS and e-mail Messaging on page 416). 1. Connect the GSM hardware to an available COM port and turn on the power. 2. Open Aspect System Structure. 3. Navigate to: Messenger, Aspect System > SMS Device, Aspect Type > SMS Device, Aspect Category. 4. Select SMS Device in Aspect List Area. 3BDS011222R4101 379 Alarms and Events 5. Section 3 Configuration When the view appears, click ConfigureSMSDevice . Figure 133. ConfigureSMSDevice 6. The Settings dialog appears with the General tab selected; however, the settings in the Ports tab must be set up before the settings in the General tab. Select the Ports tab to produce the view shown in Figure 134. Figure 134. Settings Dialog - Ports Tab 380 3BDS011222R4101 Section 3 Configuration 7. Alarms and Events Click Add to produce the COM Port Settings dialog shown in Figure 135. Figure 135. COM Port Settings Dialog 8. 3BDS011222R4101 Select the COM port the GSM hardware is connected to from the Port: drop-down list box. 381 Alarms and Events 9. Section 3 Configuration The settings in the Baud Rate:, Data Bits:, Parity:, and Stop Bits: drop-down list boxes are dependent on the GSM hardware configuration. Refer to the specific GSM hardware documentation, choose the appropriate settings, and click Next to produce the PIN and Properties dialog shown in Figure 136. Figure 136. PIN and Properties Dialog 10. The PIN is used to prevent unauthorized use of the GSM hardware. If it is required by the GSM hardware, or if it is desired to have the GSM hardware protected by a PIN, check the Query PIN: check box and enter the PIN in the PIN: field. To save and encode the PIN so that it does not have to be entered every time the GSM hardware is turned on, check the Save PIN: check box. 11. Enter the telephone number of the SIM card in the GSM hardware in the Own number: field. Enter the number without spaces and always include the Country Code. This is the number that will be called back by the message receiver’s GSM telephone to confirm that the message was received. 382 3BDS011222R4101 Section 3 Configuration Alarms and Events 12. Click Next when done entering information into the PIN and Properties dialog. This produces the Initialization dialog shown in Figure 137. Figure 137. Initialization Dialog 13. Enter the initialization string for the specific type of GSM hardware. A list of GSM hardware is shown in Appendix D, SMS and E-Mail Messaging, Table 28. The table indicates whether or not the specific type of GSM hardware has been tested by ABB and also contains initialization strings. The table presents a sample list and does not contain every compatible type of GSM hardware. There are several ways to enter the initialization string: 3BDS011222R4101 a. Type the string exactly as it appears in the table into the Initialization commands frame in the Initialization dialog. b. If viewing this instruction with Adobe Acrobat Reader, use the text tool to copy the initialization string and paste it into the Initialization commands frame in the Initialization dialog. 383 Alarms and Events Section 3 Configuration c. The information in the table is also available by clicking Help in the Initialization dialog. Click the Index tab, double-click on Initialization in the list that appears, and click Display in the Topics Found dialog. This launches the help file that contains the initialization strings. Copy the desired string from the help file and paste it into the Initialization commands frame in the Initialization dialog. d. If the initialization string for the GSM hardware in use does not appear in the list, consult the manufacturer’s documentation and type the initialization string into the Initialization commands frame in the Initialization dialog. 14. Click Next to return to the Ports tab. OK in the status column indicates the COM port configuration is correct. 384 3BDS011222R4101 Section 3 Configuration Alarms and Events 15. Select the General tab to produce the view shown in Figure 138. Figure 138. Settings Dialog - General Tab 16. Check the Activate Outbox Spooler: and Activate Inbox Spooler: check boxes. 17. Set the interval for checking for incoming messages. The greater the interval, the less the system will have to work. This results in increased speed for sending messages. Click Apply when finished. 3BDS011222R4101 385 Alarms and Events Section 3 Configuration 18. Select the Services tab to produce the view shown in Figure 139. The pick list shown in the figure only appears if SrvSetup.exe was run before starting this procedure. Figure 139. Settings Dialog - Services Tab 386 3BDS011222R4101 Section 3 Configuration Alarms and Events 19. If the pick list appears and the service provider appears in the pick list, select the service provider and click Properties. If the service provider does not appear in the pick list, click Add. Either method opens the General tab of the Service Properties dialog as shown in Figure 140. The example shown in the following figure uses Voicestream (T-Mobile) as the service provider. Figure 140. Service Properties Dialog - General Tab 20. Fill in the fields with the appropriate information and click Apply. Always use the Country Code in the SMSC: field. If the service provider was selected from the pick list, some of the fields will be filled in. The SMSC numbers provided by the configuration software of the Derdack GSM modem driver are subject to change. Please verify the number for your provider before you commission your SMS and e-mail Messaging GSM application. 3BDS011222R4101 387 Alarms and Events Section 3 Configuration 21. Select the Splitting tab to produce the view shown in Figure 141. Figure 141. Service Properties Dialog - Splitting Tab The check boxes are defined as follows: – Splitting: Splits messages that are too long and sends them in multiple messages. – Optimize Splitting: Prevents the splitting of words. – Enumerate: Enumerates the split parts of the message (e.g. 1/2 Part 1 ..., 2/2 Part 2 ..., etc.). – Narrowband Sockets: Messages are split according to the specification of narrowband sockets. This increases the readability on some GSM telephones because the parts are reassembled into one message. The maximum allowable message length is dependent on the service provider and is configured in the Message Configuration tab of the Alarm and Event Message Source. Refer to the GSM hardware manufacturer’s documentation for the maximum message length and to Alarm and Event Message Source on page 420 to configure it. 388 3BDS011222R4101 Section 3 Configuration Alarms and Events Check the desired check boxes and click Apply. 22. Select the Messaging tab to produce the view shown in Figure 142. Verify that all fields are empty or 0 and click OK to return to the Services tab of the Settings dialog. Figure 142. Service Properties Dialog - Messaging Tab 3BDS011222R4101 389 Alarms and Events Section 3 Configuration 23. Select the Messages tab to produce the view shown in Figure 143. Check the check box to increase the readability of messages and click Apply. Keep in mind that this may increase the length of the messages. Figure 143. Settings Dialog - Messages Tab 24. Repeat Step 19 through Step 23 to add/select other service providers. 25. Select the Services tab and select the desired service provider in the Default Service: drop-down list box, and click Apply. 26. To test the device settings, select the Ports tab, select the desired port, and click Properties. Click OK when finished. 27. Click OK. A warning dialog is displayed to enable Messenger Service. 28. Be sure to re-enable the Messenger Service after configuration. Be sure to enable the Messenger Server after configuring the SMS device (refer to Enabling/Disabling SMS and e-mail Messaging on page 416). 390 3BDS011222R4101 Section 3 Configuration Alarms and Events Modem Hardware (Hayes Compatible) If a new modem is being installed in, or connected to the machine, perform Step 1 through Step 19. If a modem is already installed in, connected to, and recognized by the machine, perform Step 2 through Step 4 and Step 11 through Step 19. The following is a general procedure for setting up modem hardware. It may differ depending on the specific modem hardware and the Windows operating system being used. Refer to the appropriate documentation for specific settings and procedures. If more than one modem is installed, SMS and e-mail Messaging will use the first device that supports MakeCall. 1. Connect the modem hardware to an available COM port. 2. Right-click on My Computer on the desktop. 3. Select Properties from the context menu that appears. 4. Click the Hardware tab in the System Properties dialog box. 5. Click Hardware Wizard and the Hardware Wizard appears. Some operating systems (Windows XP Professional for example), require using Windows Control Panel to access the Hardware Wizard. 6. Click Next and the Choose a Hardware Task dialog box appears. 7. Select Add/Troubleshoot a Device and click Next. 8. The Search for New Hardware dialog box appears, followed by the Choose a Hardware Device dialog box. 9. Verify that the modem hardware installed in Step 1 appears in the list. 10. Click Cancel. 11. Click Device Manager under the Hardware tab in the System Properties dialog box and the Device Manager appears. 12. Right-click on the modem and select Properties from the context menu that appears. 3BDS011222R4101 391 Alarms and Events Section 3 Configuration 13. The Modem Properties dialog box appears. Click the Driver tab. 14. Install or update the driver if necessary. 15. Click the Advanced tab in the Modem Properties dialog box. 16. Click Change Default Preferences. 17. Under the General tab in the Default Preferences dialog box, set the following fields to: – – Port speed: 9,600 or greater. Flow control: Xon/Xoff. 18. Under the Advanced tab in the Default Preferences dialog box, set the following fields to: – – – Data bits: 7. Parity: Even. Stop bits: 1. The parameters of the General tab and the Advanced tab are the most common used by TAP providers, however specific setting should be verified with the provider as they may be different and are subject to change. If the communication settings are changed after the Modem Device has been configured to use the port, the machine must be rebooted for the new settings to take affect. 19. Click OK in the Default Preferences and Modem Properties dialog boxes. Modem Hardware Test Utility This utility requires that the modem hardware under test and a pager to send the test message to are available. It is used to verify the compliant functionality of the modem. 1. Use Windows Explorer to navigate to: ...\Program Files\ABB Industrial IT\Operate IT\Messenger\Bin 392 3BDS011222R4101 Section 3 Configuration 2. Alarms and Events Double-click on TestModemObj.exe. The Test Modem Connection dialog box shown in Figure 144 appears. Figure 144. Test Modem Connection Dialog Box 3. Click Load Request and the modem test utility code appears in the Request field as shown in Figure 145. Figure 145. Modem Hardware Test Utility 3BDS011222R4101 393 Alarms and Events Section 3 Configuration 4. If an access number is required to access an outside line, insert it between the T and the 1 in the PhoneNumber line of the code. For example, a 9 might be required to access an outside line. Commas can be used after the access number if a pause is required to access the outside line. The comma usually creates a pause of one second; however it can vary by modem. Refer to the modem hardware documentation for the exact duration. It may also be necessary to change the T. Refer to the modem hardware documentation for the appropriate code. 5. Enter a valid PIN for the pager used in the test in the PIN line of the code. 6. Click GO. 7. Verify that the message in the Reply field indicates that the message was sent and that the pager receives the message Test Msg 1. E-mail Test Utility This utility requires: • Valid sender e-mail address. • Valid receiver e-mail address. • If necessary, the domain name or IP address of an SMTP server with permissions to relay outgoing e-mail messages, from other internal SMTP servers, directly to the internet. The SMTP server is needed if it is necessary to bypass the local SMTP service pickup directory if, for example, a firewall blocks direct SMTP traffic through port 25. 1. Use Windows Explorer to navigate to: ...\Program Files\ABB Industrial IT\Operate IT\Messenger\Bin 394 3BDS011222R4101 Section 3 Configuration 2. Alarms and Events Double-click on TestEmailObj.exe. The Test E-mail dialog box shown in Figure 146 appears. The example in the figure has fields filled in for clarity. Figure 146. Test E-Mail Dialog Box 3. Fill in the fields with the required information identified at the beginning of this procedure. 4. Click Send e-mail and verify that the message in the Result field says Email sent and that the e-mail recipient receives the message. It is very important to verify that the e-mail recipient receives the message. Email sent in the Result field only indicates that the e-mail was sent to the queue in the root:Inetpub\mailroot directory. 5. 3BDS011222R4101 To repeat the test, click Clear Result before clicking Send e-mail. 395 Alarms and Events Section 3 Configuration System Setup This section contains procedures for setting up the following: • Aspect System Structure. – Modem Device. – Email Device. – SMS Device. • User Structure. – Creating User Groups and Adding Users. – Message Subscriber. – Message Schedule. • Operational (Functional, Control, Location, etc.) Structures. – Messenger Event List. • Service Structure. – Enabling/Disabling SMS and e-mail Messaging. – Checking SMS and e-mail Messaging Status. Modem Device Setting up the Modem Device (TAP/Modem) in the Aspect System Structure provides the default telephone number for the Central Paging Terminal of the paging service provider for each instance of it applied to individual objects in the Operational (Functional, Control, Location, etc.) Structures. Working and properly set up modem hardware must be connected to an available COM port in order for the Modem Device to function. Refer to Modem Hardware (Hayes Compatible) on page 391 for more information. Configuration of each individual personal pager number and/or mobile telephone number occurs while setting up the Message Subscriber. Refer to Message Subscriber on page 401 for more information. Table 16 lists the paging service providers and their telephone numbers that have been tested and verified by ABB as functional for use with SMS and e-mail Messaging as of the original publication of this instruction. The communication method used is Telocator Alphanumeric Protocol (TAP). There are literally 396 3BDS011222R4101 Section 3 Configuration Alarms and Events hundreds of numbers that support TAP, but tests have only been performed using the paging service providers listed in the table. Table 16. Paging Service Providers Paging Service Provider1 Central Paging Terminal Telephone Number Arch Wireless™ 18002506325 Cingular ® 18004774550 SkyTel 18006792778 Verizon 18668230501 NOTE: 1. The paging service providers listed in this table are only those tested and verified by ABB as of the original publication of this instruction. The exclusion of paging service provider information is not intended to imply that the paging service provider is not compatible with SMS and e-mail Messaging. ABB recommends all paging service providers, whether or not they appear in this table, be tested and verified before using SMS and e-mail Messaging. The factory default is set to the telephone number shown in the table for the SkyTel Central Paging Terminal. It is set for tone dialing and without the need for a digit to access an outside line. If the default is acceptable, there is no need to perform the following procedure. To change the factory default Central Paging Terminal telephone number: 1. Use the Structure Selector to open the Aspect System Structure. 2. Use the Object Browser to navigate to: Aspect System Structure, Aspect Category > Messenger, Aspect System > Modem Device, Aspect Type > Modem Device, Aspect Category 3BDS011222R4101 397 Alarms and Events 3. Section 3 Configuration Right-click Modem Device, Aspect Category and select Modem Device from the context menu that appears. This opens the Modem Device shown in Figure 147. Figure 147. Modem Device 398 4. Delete everything in the Phone Number: field to the right of the T (T is for tone) and the 1. It may also be necessary to change the T. Refer to the specific modem hardware documentation for the appropriate code. 5. If an access number is needed to access an outside line, enter it to the immediate right of the T. For example, a 9 might be required to access an outside line. Commas can be used after the access number if a pause is required to access the outside line. The comma usually creates a pause of one second; however it can vary by modem. Refer to the modem hardware documentation for the exact duration. 6. Enter the new Central Paging Terminal telephone number to the right of the 1. 7. Click Apply. 8. Close the Modem Device. 3BDS011222R4101 Section 3 Configuration Alarms and Events Email Device If SMTP was not installed during system installation or operating system set-up, it must be installed before attempting to configure the Email Device. The operating system CD may be needed to complete the installation. Add SMTP to a Windows Server 2003 system by following the commands below: Control Panel > Add Remove Programs > Add Remove Windows Components > Application Server > Internet Information Server (IIS) > SMTP (select option checkbox) Add SMTP to a Windows Server 2000 system by following the commands below: Control Panel > Add Remove Programs > Add Remove Windows Components > Internet Information Server (IIS) > SMTP (select option checkbox) Configuration of each individual e-mail address occurs while setting up the Message Subscriber. Refer to Message Subscriber on page 401 for more information. For Windows 2000 Server, the local SMTP server is automatically configured when IIS is loaded. For Windows 2003 Server, the local SMTP server is not automatically configured. The SMTP server must be configured on Windows 2003 Server when the user chooses not to use a relay server. Contact your network administrator for details on how to do this activity as it will vary from site to site. Setting up the Email Device (SMTP/Email) in the Aspect System Structure provides default values for each instance of the aspect applied to individual objects in the Operational (Functional, Control, Location, etc.) Structures. The Email Device contains the default e-mail address that appears in the From: field when the user receives the message and where error messages may be sent (e.g. delivery failure). It also contains the SMTP relay server name if it is desired to use one and bypass the local SMTP service pickup directory. 1. Use the Structure Selector to open the Aspect System Structure. 2. Use the Object Browser to navigate to: Aspect System Structure, Aspect Category > Messenger, Aspect System > Email Device, Aspect Type > Email Device, Aspect Category 3BDS011222R4101 399 Alarms and Events 3. Section 3 Configuration Right-click Email Device, Aspect Category and select Email Device from the context menu that appears. This opens the Email Device shown in Figure 148. Figure 148. Email Device 4. Delete the existing text from the From: field. 5. Enter a valid e-mail address in the From: field. This e-mail address will appear in the From: field of all users while configuring the Message Subscriber. 6. The SMTP Relay Server: field makes it possible to bypass the local SMTP service pickup directory if, for example, a firewall blocks direct SMTP traffic through port 25. Enter the domain name or IP address of an SMTP server with permissions to relay outgoing e-mail messages, from other internal SMTP servers, directly to the internet. 7. Click Apply. 8. Close the Email Device. Creating User Groups and Adding Users The User Structure holds the defined users and user groups allowed to work in the system. Adding users and defining user roles is performed using the Configuration Wizard. All users must have a related Windows user account. The User object 400 3BDS011222R4101 Section 3 Configuration Alarms and Events contains information about a user and what the user is allowed to do within the system. It also contains data specific to the user, such as profile configuration values. The User Structure contains two levels under the root object: the first level holds User Groups, and the second holds Users. The Everyone, IndustrialITUser User Group contains all Users. Users can be added to the system and to User Groups using the Configuration Wizard. Refer to the appropriate 800xA system documentation for detailed information on creating User Groups, adding Users, and the User Structure. Message Subscriber The Message Subscriber identifies users who receive event messages, specifies devices available to each user, and configures those devices. This example configures a Message Subscriber for a single user who subscribes to the SMS/GSM, SMTP/Email, and TAP/Modem Devices. 1. Use the Structure Selector to open the User Structure. 2. Navigate to a User in Everyone - IndustrialITUser, User Group. 3. Right-click on the user and select New Aspect... from the context menu that appears. 3BDS011222R4101 401 Alarms and Events 4. Section 3 Configuration The New Aspect dialog box appears. a. Navigate to and select Message Subscriber from the list that appears to produce the view shown in Figure 149. b. Click Create. Figure 149. New Aspect Dialog Box (Message Subscriber) 402 3BDS011222R4101 Section 3 Configuration 5. Alarms and Events Right-click on the user and select Message Subscriber from the context menu that appears. This opens the Message Subscriber shown in Figure 150. Figure 150. Message Subscriber 6. Click New to add the SMS/GSM Device to this user. The New Device dialog box appears with SMS/GSM as the default in the Device: drop-down list box as shown in Figure 151. 7. Click OK. Figure 151. New Device Dialog Box (SMS/GSM) 3BDS011222R4101 403 Alarms and Events Section 3 Configuration 8. Click New to add the SMTP/Email Device to this user. The New Device dialog box appears with SMS/GSM as the default in the Device: drop-down list box. 9. Click the down arrow and select SMTP/Email from the list that appears in the Device: drop-down list box. 10. Click OK. 11. Click New to add the TAP/Modem Device to this user. The New Device dialog box appears with SMS/GSM as the default in the Device: drop-down list box. 12. Click the down arrow and select TAP/Modem from the list that appears in the Device: drop-down list box. 13. Click OK. 14. Figure 152 shows the Message Subscriber at this point in the procedure. Select SMS/GSM in the Message Subscriber and click Edit to access the SMS/GSM Device. Working and properly set up GSM hardware must be connected to an available COM port in order for the SMS/GSM Device to function. Refer to GSM Hardware on page 379 for more information. 404 3BDS011222R4101 Section 3 Configuration Alarms and Events Figure 152. Message Subscriber with Added Devices 15. Click the down arrow in the Service: drop-down list box and select the desired GSM service provider. 3BDS011222R4101 405 Alarms and Events Section 3 Configuration 16. Enter this user’s GSM telephone number to produce a view similar to the one shown in Figure 153. Enter the GSM telephone number without spaces and always include the Country Code. Figure 153. SMS/GSM Device 17. Click Apply and then close the SMS/GSM Device. 18. Select SMTP/Email in the Message Subscriber and click Edit to access the SMTP/Email Device. 406 3BDS011222R4101 Section 3 Configuration Alarms and Events 19. Enter the e-mail address for the user in the To: field to produce a view similar to the one shown in Figure 154. The information in the From: and Relay Server: (if desired) fields were configured in the Aspect System Structure under Email Device on page 399. Figure 154. SMTP/Email Device 20. Click Apply and then close the SMTP/Email Device. 21. Select TAP/Modem in the Message Subscriber and click Edit to access the TAP/Modem Device. 22. Either accept the default in the Phone Number: field that was entered in the Aspect System Structure under Modem Device on page 396, or change it to the desired telephone number. Working and properly set up modem hardware must be connected to an available COM port in order for the TAP/Modem Device to function. Refer to Modem Hardware (Hayes Compatible) on page 391 for more information. 3BDS011222R4101 407 Alarms and Events Section 3 Configuration 23. Enter a valid PIN for this user in the PIN: field to produce a view similar to the one shown in Figure 155. Figure 155. TAP/Modem Device The PIN is the 10-digit personal pager and/or mobile telephone number for the current user. 24. Click Apply and then close the TAP/Modem Device. 25. The list in the Message Subscriber shows the configured devices. The top device has the highest priority, followed by the rest in top-down order. To change the order in the list, and thus the priority order, select the device and click Move Up or Move Down. Although the list in the Message Subscriber has priority assigned to it, The device used is dependent on the configuration of the Message Handler (refer to Message Handler on page 425). If this user is a member of a user group that messages are being sent to (selected during Message Handler configuration), messages are only sent to the highest priority device in the list for each user in the user group. If the messages are being sent to this user, the user device selected in the Message Handler configuration is used. In order to send the same message to multiple devices for the same user, multiple Alarm and Event Message Sources and Message Handlers pointing to the same Alarm and Event List must be set up and configured. 408 3BDS011222R4101 Section 3 Configuration Alarms and Events 26. To delete a configured device from the list, select the device and click Delete. 27. The Message Subscriber now looks like the view shown in Figure 156. Figure 156. Configured Message Subscriber 3BDS011222R4101 409 Alarms and Events Section 3 Configuration 28. To enable these devices, make sure the Enabled check box in the Message Subscriber is checked (Figure 156). To disable these devices, clear the check box. If the check box is cleared the user will not receive messages. 29. Click Apply and then close the Message Subscriber. Message Schedule The Message Schedule identifies the times of day and days of the week that users receive event messages on configured user devices. If a Message Schedule is not added to a user, the default behavior is that of Always Deliver. 1. Use the Structure Selector to open the User Structure. 2. Navigate to a user in Everyone - IndustrialITUser, User Group. 3. Right-click on the user and select New Aspect... from the context menu that appears. 4. The New Aspect dialog box appears. a. Navigate to and select Message Schedule from the list that appears to produce the view shown in Figure 157. b. Click Create. Figure 157. New Aspect Dialog Box (Message Schedule) 410 3BDS011222R4101 Section 3 Configuration 5. Alarms and Events Right-click on the user and select Message Schedule from the context menu that appears. This opens the Message Schedule shown in Figure 158. The default value in the Delivery Options frame is Always Deliver. Figure 158. Message Schedule (Always Deliver) 3BDS011222R4101 a. To have this user receive messages 24 hours a day, seven days a week, leave Always Deliver selected. b. To disable sending of messages to this user, choose Never Deliver and click Apply. c. To schedule the delivery of messages for this user: – Select Delivery Based on Schedule. – Check the check boxes for the desired days of the week in the Time Schedule frame. – There are two ways to configure the scheduled times: 411 Alarms and Events Section 3 Configuration – a. Select the Use Sunday Start and End time for all days check box. If the time range is the same for every day of the week for which the schedule is active, use the down arrows in the Start Time Hour, Start Time Minute, End Time Hour, and End Time Minute fields in the Sunday row only to define the time range. Click Apply and the time range appears for every day of the week. The schedule is still only active for the days of the week selected. Figure 159 shows and example. When the Use Sunday Start and End time for all days check box is selected, the other days of the week are disabled (the down arrows are grayed out), so the time range for those days can not be changed individually. Figure 159. Message Schedule (Delivery Based on Schedule, Use Sunday Start and End time for all days) -or– 412 b. Do not select the Use Sunday Start and End time for all days check box. If the time range is not the same for every day of the week for which the schedule is active, use the down arrows in the Start Time Hour, Start Time Minute, End Time Hour, and End Time Minute fields in the 3BDS011222R4101 Section 3 Configuration Alarms and Events applicable rows to define the time range for each day. Click Apply. Figure 160 shows and example. When the Use Sunday Start and End time for all days check box is not selected, the other days of the week are enabled, so the time range for those days can be changed individually. Figure 160. Message Schedule (Delivery Based on Schedule) 6. Click Apply and then close the Message Schedule. If the start time is equal to the end time, the messages will always be active for the days of the week selected. If the start time is later than the end time, the delivery schedule assumes that the schedule goes past midnight and the active day list corresponds to the day the schedule starts. 7. To perform message configuration for other users, repeat the procedures under Message Subscriber on page 401 and Message Schedule on page 410 for each user. Messenger Event List The Messenger Event List is a preconfigured Alarm and Event List that filters out everything but SMS and e-mail Messaging activity. It contains information on how many messages were successful, why a user did not receive a message (for example, 3BDS011222R4101 413 Alarms and Events Section 3 Configuration they were not on schedule), and the reasons why a message was not successfully sent (for example, wrong PIN, service not accessible, modem not turned on, etc.). It also logs message receipt confirmation from GSM compatible devices that received the message via the SMS/GSM Device. Message receipt confirmation is a simple event in the Messenger Event List. It is not audited. To set up the Messenger Event List: 1. Use the Structure Selector to open the desired structure. 2. Use the Object Browser to navigate to the desired object. 3. Right-click on the object and select New Aspect... from the context menu that appears. 4. The New Aspect dialog box appears. a. Check the Show all check box and uncheck the List presentation check box. b. Navigate to and select Alarm and Event List from the list that appears. c. Enter something specific in the Name field, such as System Event List to produce a view such as the one shown in Figure 161. d. Click Create. Figure 161. New Aspect Dialog Box (Alarm and Event List) 414 3BDS011222R4101 Section 3 Configuration Alarms and Events 5. Select the object in the Object Browser and select the newly created aspect in the Aspect List Area. This opens the Main View in the Aspect Preview Area. 6. Click the Main/Config View button on the toolbar and select Config View as shown in Figure 162. Figure 162. Main/Config View Button 7. Click the down arrow in the Configuration Name drop-down list box and select Default Messenger Event List from the list that appears to produce a view similar to the one shown in Figure 163. Figure 163. Alarm and Event List - Config View 3BDS011222R4101 415 Alarms and Events 8. Section 3 Configuration Click Apply. Figure 164 shows an example Messenger Event List that includes message receipt confirmation (Received reply in the figure) from a GSM compatible device that received the message via the SMS/GSM Device. Figure 164. Example Messenger Event List Refer to the appropriate 800xA system documentation for information on creating and customizing preconfigured Alarm and Event Lists Enabling/Disabling SMS and e-mail Messaging SMS and e-mail Messaging can be enabled and disabled in the Service Structure. 1. Use the Structure Selector to open the Service Structure in the Plant Explorer. 2. Use the Object Browser to navigate to: Services > Messenger Server, Service 416 3. Select Service Definition in the Aspect List Area. 4. Click the Configuration tab. 5. To disable the service, uncheck the Enabled check box. 6. To enable the service, check the Enabled check box. 3BDS011222R4101 Section 3 Configuration Alarms and Events Checking SMS and e-mail Messaging Status The status of the SMS and e-mail Messaging service can be checked in the Service Structure. 1. Use the Structure Selector to open the Service Structure in the Plant Explorer. 2. Use the Object Browser to navigate to: Services > Messenger Server, Service 3. Select Service Definition in the Aspect List Area. 4. Click the Status tab to view the status. Configuration In order to make the SMS and e-mail Messaging operational, it is necessary to perform the following procedures: • Alarm and Event List (Alarm Grouping). • Alarm and Event Message Source. • Message Handler. Alarm and Event List (Alarm Grouping) Alarm and Event Lists are part of the 800xA system and are added to objects when building the various structures. Building the various structures is beyond the scope of this instruction. Refer to the appropriate 800xA system documentation for detailed information on the various structures. The Alarm and Event Lists are used to group alarm points together. They define the group of events being sent to the same group of people. For ease of use, take advantage of the defined structures to group the assets. All child objects in the structure can be defined as being included. Operators can view Alarm and Event Lists according to the selected filter and presentation settings. These settings can be changed. For example, a list can be sorted by clicking on a column header, resizing columns, or moving them by using drag and drop. 3BDS011222R4101 417 Alarms and Events Section 3 Configuration Filtering and presentation functions allow alarms to be viewed in dedicated ways. For example, a list can be configured to show all alarms or only those alarms relevant for the associated object and its descendents. Acknowledging and silencing alarms can be done within a list, for one or more selected alarms, for multiple alarms per page, or entire lists. Object alarms can be acknowledged through process graphics displays. Up to 1,000 priorities can be defined with acknowledge and unacknowledged colors. To add and configure an Alarm and Event List: 418 1. Use the Structure Selector to open an Operational Structure. 2. Use the Object Browser to navigate to the desired object. 3. Right-click on the object and select New Aspect... from the context menu that appears. 4. The New Aspect dialog box appears. a. Check the Show all check box and uncheck the List presentation check box. b. Navigate to and select Alarm and Event List from the list that appears to produce the view shown in Figure 165. 3BDS011222R4101 Section 3 Configuration c. Alarms and Events Click Create. Figure 165. New Aspect Dialog Box (Alarm and Event List) 5. Right-click the object and select Alarm and Event List from the context menu that appears. This opens the Alarm and Event List. 6. Click the View Configuration button in the Alarm and Event List as shown in Figure 166 and the Alarm and Event List Configuration dialog box shown in Figure 167 appears. VIEW CONFIGURATION T05051B Figure 166. View Configuration 3BDS011222R4101 419 Alarms and Events Section 3 Configuration Figure 167. Alarm and Event List Configuration Dialog Box 7. Click Help or refer to the appropriate 800xA system documentation to configure the properties under the various tabs in the Alarm and Event List Configuration dialog box. 8. Click Apply and then close the dialog box. 9. Repeat the procedure for all other Alarm and Event Lists. Alarm and Event Message Source The Alarm and Event Message Source allows the user to select the Alarm and Event list to monitor, the content of alarm and event messages, and edit the message field length. 420 1. Use the Object Browser to navigate to the desired object. 2. Right-click on the object and select New Aspect... from the context menu that appears. 3BDS011222R4101 Section 3 Configuration 3. Alarms and Events The New Aspect dialog box appears. a. Check the Show all check box and uncheck the List presentation check box. b. Navigate to and select Alarm and Event Message Source from the list that appears to produce the view shown in Figure 168. c. Click Create. Figure 168. New Aspect Dialog Box (Alarm and Event Message Source) 3BDS011222R4101 421 Alarms and Events 4. Section 3 Configuration Right-click the object and select Alarm and Event Message Source from the context menu that appears. This opens the Alarm and Event Message Source shown in Figure 169 with the Alarm List tab selected. This tab allows for selection of the Alarm and Event List to monitor. Figure 169. Alarm and Event Message Source - Alarm List Tab 5. Click the down arrow and select the Alarm and Event List to monitor from the drop-down list box. 6. Choose the desired action in the Message action for a new alarm condition frame. The actions are defined as follows: – Only send message if previous alarm condition was acknowledged: Sends only one message for an alarm that goes from active to inactive and back to active again (once or several times). Choose the Only send message if previous alarm condition was acknowledged option carefully. It is designed to prevent the same alarm condition from sending several messages due to alarm chatter (alarm going from inactive to active and back again several times over a relatively short period of time). If this option is selected and the state changes happen over a long period of time, and the first alarm condition is not acknowledged, subsequent alarm conditions will not cause a message to be sent and this alarm may go unnoticed. 422 3BDS011222R4101 Section 3 Configuration Alarms and Events Choosing Only send message if previous alarm condition was acknowledged also requires configuration of the Basic and/or Soft Alarm Services in the Service Structure. Refer to Alarm and Event Service Group Configuration on page 433. – Always send message: Sends a new message every time the alarm condition changes from inactive to active. 7. Click Apply. 8. Click the Message Configuration tab and check the check box next to the field in the Name column if the field is to be part of the message. This produces a view similar to the one shown in Figure 170. The Message Configuration tab is where the messages are formatted for user devices. Figure 170. Alarm and Event Message Source - Message Configuration Tab 9. The checked fields in the Name column are in the order they will appear in the message, with the top field at the beginning of the message (after the prefix, if configured) and the bottom field at the end (before the suffix, if configured). Click Move Up or Move Down to change the position of the field. Alarm and Event Message Source aspects created by Bulk Data Manager tool will have empty Message Configuration information. The Message Configure information must be configured independent of Bulk Data Manager tool. 3BDS011222R4101 423 Alarms and Events Section 3 Configuration 10. To change the maximum field length, select the desired field in the Name column and click Edit. The Edit Length dialog box shown in Figure 171 appears. Figure 171. Edit Length Dialog Box 11. Enter the new field length (number of characters). Enter 0 for unlimited length. Check with your service provider for information on maximum allowable message length for the device in use. Make sure the total message length is less than or equal to the maximum allowable message length for the particular device. Exceeding the maximum allowable message length may cause SMS and e-mail messaging to malfunction. 12. Click OK. 13. Repeat Step 8 to Step 12 for the other fields. 14. The message prefix is optional. If desired, enter a message prefix in the Message Prefix: field. 15. The message suffix is optional. If desired, enter a message suffix in the Message Suffix: field. 16. The field delimiter (space, comma, colon, etc.) is required. It separates the items selected in the Name column from each other in the message. Enter the field delimiter in the Field Delimiter: field. The total message length is shown at the lower right corner of the view in the Message Configuration tab. 17. Click Apply. 424 3BDS011222R4101 Section 3 Configuration Alarms and Events 18. Repeat this procedure for each other object with Alarm and Event Lists to monitor. Message Handler The Message Handler specifies the destinations of the messages. A separate Message Handler is required for each Alarm and Event Message Source. The Log tab in the Message Handler contains a message directing the user to the Messenger Event List. It has no other functionality. Refer to Messenger Event List on page 413. 1. Use the Object Browser to navigate to the desired object. 2. Right-click the object and select New Aspect... from the context menu that appears. 3. The New Aspect dialog box appears. 3BDS011222R4101 a. Check the Show all check box and uncheck the List presentation check box. b. Navigate to and select Message Handler from the list that appears to produce the view shown in Figure 172. 425 Alarms and Events Section 3 Configuration c. Click Create. Figure 172. New Aspect Dialog Box (Message Handler) 4. 426 Right-click the object and select Message Handler from the context menu that appears. This opens the Message Handler. 3BDS011222R4101 Section 3 Configuration 5. Alarms and Events Select the Message Source tab and click the down arrow in the Message Source field. Select the desired Alarm and Event Message Source from the drop-down list box. This produces a view similar to the one shown in Figure 173. The Message Source tab allows for selection of the Alarm and Event Message Source and whether or not to enable message sending from that source. Figure 173. Message Handler - Message Source Tab 6. Check the Enabled check box so that the Alarm and Event Message Source will send messages. Clear the check box to disable message sending. 7. Click Apply. 3BDS011222R4101 427 Alarms and Events 8. Section 3 Configuration Click the Destination tab. The view shown in Figure 174 appears with no destinations configured. The Destination tab allows for selection of the message destination (devices associated with user groups and/or users), whether or not those devices are enabled, time-out before resending the message or switching destinations, and number of attempts before switching destinations. Figure 174. Message Handler - Destination Tab 428 3BDS011222R4101 Section 3 Configuration 9. Alarms and Events Click New to create a new destination. The New Destination dialog box as shown in Figure 175 appears. If User Group is selected in the New Destination dialog box, messages go to the device with the highest priority for each user in that group. If User is selected, messages go to the device selected for that user. Figure 175. New Destination Dialog Box (Users Selected) 10. Select either a User Group or a User device. To select a User Group, perform Step a through Step c. To select a User device, perform Step d through Step g. 3BDS011222R4101 a. To select a User Group, click Groups. b. Select a User Group from the Groups/Users pane on the left. c. Click OK. d. To select a User device, click Users. e. Select a User from the Groups/Users pane on the left. The devices for that User appear in the Devices pane on the right. f. Select a device from the Devices pane. 429 Alarms and Events Section 3 Configuration g. Click OK. 11. Select the new destination from the list in the Message Handler. 12. Click Edit and the Edit Destination dialog box shown in Figure 176 appears. Figure 176. Edit Destination Dialog Box 13. Check the Enabled check box so that messages will be sent to the destination. Clear the check box to disable the destination. 14. The Timeout (s.): field contains the number of seconds SMS and e-mail Messaging waits for the user to acknowledge the alarm line corresponding to the message before the message is resent to that destination. If it is the last attempt, it is the number of seconds before switching to the next destination. Enter a time-out in seconds in the Timeout (s.): field. 15. The Attempts: field contains the number of times SMS and e-mail Messaging sends a message to the destination before switching to the next destination. Enter the number of attempts in the Attempts: field. 16. Click OK. 17. Repeat Step 9 to Step 16 for each additional destination. 18. The message is sent to the top destination first. If the message is successfully sent and the user acknowledges the alarm, or confirms receipt of the message (messages sent via SMS/GSM Device only), within the configured time limit and/or number of attempts, the rest of the destinations do not receive the message. If the user does not acknowledge the alarm line corresponding to the message, or confirm receipt of the message (messages sent via SMS/GSM 430 3BDS011222R4101 Section 3 Configuration Alarms and Events Device only), within the timeout interval, the message is sent again provided the attempts parameter is greater than one. If the attempts count on the first destination is exhausted without acknowledgement or receipt confirmation, the Message Handler moves to the next destination in the list (if there is one). If the destination is a group, the message is sent to the device with the highest priority for every group member before timing begins; however, the lower priority devices do not receive messages. Acknowledgement of the alarm, or receipt confirmation (messages sent via SMS/GSM Device only), by one member of the group is considered successful notification of the group. 19. To change the order in the list, and thus the send order, select a destination and click Move Up or Move Down. 20. To delete a destination from the list, select it and click Delete. 21. Figure 177 shows a completed message destination configuration with two user groups (Page Sample ePlant and Operators) and a TAP/Modem Device for an individual user (Guest) configured. Figure 177. Configured Destinations Tab 22. Repeat this procedure for each Alarm and Event Message Source. For example, using the configuration shown in Figure 177, the sequence of events is illustrated in Figure 178. 3BDS011222R4101 431 Alarms and Events Section 3 Configuration PAGE SAMPLE EPLANT USER GROUP USER 1 HIGHEST PRIORITY DEVICE USER 2 HIGHEST PRIORITY DEVICE USER 3 HIGHEST PRIORITY DEVICE USER 4 HIGHEST PRIORITY DEVICE ALARM ACKNOWLEDGED YES WITHIN TIME OUT PERIOD? NO NO LAST ATTEMPT? YES OPERATOR USER GROUP OPER 1 HIGHEST PRIORITY DEVICE OPER 2 HIGHEST PRIORITY DEVICE OPER 3 HIGHEST PRIORITY DEVICE OPER 4 HIGHEST PRIORITY DEVICE ALARM ACKNOWLEDGED WITHIN TIME OUT PERIOD? YES NO NO LAST ATTEMPT? YES GUEST USER ALARM ACKNOWLEDGED YES WITHIN TIME OUT PERIOD? TAP/MODEM DEVICE NO NO LAST ATTEMPT? YES NOTE: ALARM ACKNOWLEDGE INCLUDES CONFIRMING RECEIPT OF MESSAGE VIA GSM COMPATIBLE DEVICE (ONLY WHEN MESSAGE WAS SENT VIA SMS/GSM DEVICE). TIME OUT RECORDED IN MESSENGER EVENT LIST DONE T05073B Figure 178. Sequence of Events for Message Handler in Figure 177 432 3BDS011222R4101 Section 3 Configuration Alarms and Events Alarm and Event Service Group Configuration The Only send message if previous alarm condition was acknowledged in the Alarm and Event Message Source is designed to prevent the same alarm condition from sending several messages due to alarm chatter (alarm going from inactive to active and back again several times over a relatively short period of time). However, this option also requires configuration of the Alarm Manager Basic Service Group in the Service Structure. 1. Use the Structure Selector to open the Service Structure in Plant Explorer. 2. Use the Object Browser to navigate to: Services > Alarm Manager, Service > Basic Service, Service Group 3. Select Service Group Definition in the Aspect List Area. 4. Click the Special Configuration tab. 5. Uncheck the Make new alarms entry each time a condition gets active. Figure 179. Service Group Definition Special Configuration Tab 6. 3BDS011222R4101 Click Apply to save the entered data. 433 Alarms and Events Section 3 Configuration Alarm Storage Number of alarms in main storage is 10000. This means the Alarm manager server can keep 10000 conditions* (alarms) in memory. Default value is 10000 and system engineer has permission to modify it. This number is for the total of alarms for all categories. Each category value can be modified. Default value for each category is the total alarm storage divide number of categories. For instance if there are 10 categories and alarm storage is 10000, it means we have 1000 condition for each category. *)These conditions that have be saved in alarm manager process are Enable/Active/UnAcknowledge or Enable/UnActive/Unacknowledge or Enable/Active/Acknowledge. 434 3BDS011222R4101 Section 3 Configuration HART Field Devices HART Field Devices This subsection uses step by step examples to describe how HART device objects with asset monitors are used in a fieldbus system and how DTMs are started (Information about DTM functionality can be found in each device-specific description.): This section does not include configuration parts of HART Multiplexer Connect. The HART Multiplexer integration is described in IndustrialIT, 800xA Device Management - HART, Configuration. Configuration activities are described in the following parts: • Preparing Device Object Types for Use • Precommissioning Control Networks, AC 800M and OPC • Setting up a Fieldbus Topology for HART – Local S800 Modules of AC 800M – PROFIBUS Remote I/O and HART Modules • Starting the Device Type Manager (DTM) • Starting OPC Server PROFIBUS/HART It also describes how HART device objects can be used and represented with Function Designer in Function Diagrams: HART Device Objects in Function Diagrams 3BDS011222R4101 435 HART Field Devices Section 3 Configuration Prerequisites and Requirements The following requirements must be met, in order to be able to carry out the actions described in this section. • All necessary software is installed on the related system node. Please refer to IndustrialIT, 800xA - System, Installation for detailed information. • DCOM settings for PROFIBUS Device Integration components are adapted according IndustrialIT, 800xA - System, Post Installation Setup manual. • A directory must be shared for DTM access on every system node. Please refer to Industrial IT, 800xA - System, Post Installation Setup manual, section Shared Folder for PROFIBUS and HART Device Integration. • An 800xA system has been created and started. • The following system extensions have been loaded: – AC 800M/C Connect (if AC 800M is used) – Fieldbus Builder PROFIBUS/HART – HART Device Integration Library - Basics – optional HART Device Integration Library - Asset Monitoring • Plant Explorer of Engineering Workplace or Plant Explorer Workplace has been started. • The user has Configure and Download permissions. • For use of Function Designer the system extensions Function Designer, Function Designer for AC 800M and Function Designer for FB P/H have been loaded. Fieldbus Topology in System 800xA Once an 800xA system has been started, a fieldbus topology starting at the controller and ending at the field device can be created in Control Structure of Plant Explorer. Starting with the root node, the simplest example of a fieldbus system for PROFIBUS and HART is set up as follows using Plant Explorer context menu (right mouse button): 436 3BDS011222R4101 Section 3 Configuration HART Field Devices Control Network > Control Project > Controller Group > AC 800M > Field devices Figure 180. Control Structure with Fieldbus Topology 3BDS011222R4101 437 HART Field Devices Section 3 Configuration Preparing Device Object Types for Use The HART device objects are present in the Object Type Structure once the system extensions of the HART Device Integration Library have been loaded into the 800xA system. Some Device Object Types, which are implemented with HART Device Integration Library of System 800xA, have a device specific DTM for device configuration, parametrization and operation. The device-specific DTM may also include licensing, whereby the end user has to purchase the license directly from the device manufacturer. The HART Device Integration package copies the installation routines of the DTMs to the local hard disk. After that the DTMs can be executed based on the device object types. In case, that the Device Library Wizard is used to extend the HART Device Integration Library, the Device Type Manager (DTM) is installed automatically on the 800xA’s system node. License for device-specific DTMs are not subject to the System 800xA licensing arrangements and are not included in the HART Device Integration Package. Licenses for device-specific DTMs have to be applied for from the relevant device manufacturer. Device specific DTMs have to be installed on every 800xA system node that runs the HART Device Integration. The DTM specific license agreements have to be observed here. Device Object Types cannot be used or instantiated if the corresponding DTM is not installed. 438 3BDS011222R4101 Section 3 Configuration HART Field Devices Installation of Device Type Manager (DTM) This subsection can be skipped, if the device object type is installed separately via Device Library Wizard. Details can be found in IndustrialIT, Device Library Wizard, FOUNDATION Fieldbus, HART, PROFIBUS, User Instructions The installation of the Device Type Manager (DTM) is mandatory for object types, which are used in the field device topology. In case, that the DTM is already installed on the system nodes, this subsection is not applicable. Notice, that it is mandatory to install specific Device Type Manager (DTM) before the device object is instantiated in Control Structure of Plant Explorer. That applies also to device objects, coming into the system as instances in already created Control Structure via import, e.g. during upgrade or recovery procedures. Detailed information for upgrade procedure are described in the 800xA system upgrade manual. The following steps have to be executed for the corresponding object type, if the device specific DTM is not installed yet on the system node: DTMs can be also installed via setup tool, located in Start > All Programs > ABB Industrial IT 800xA > Device Mgmt PROFIBUS > HART DTM Setup Tool 1. Switch to Object Type Structure in Plant Explorer 2. Open the folder object Field Devices For HART, object types are stored inside the Field Devices catalog. The object types in the Basics, Object Type Group catalog are generic object types, which are not designed for direct use. Please use device types from HART Actuators and HART Transmitter Object Type Groups instead. 3. 3BDS011222R4101 A folder structure containing the various device objects appears. Click "+" to open the next level of the partial tree and select the required device object 439 HART Field Devices 4. Section 3 Configuration Select Install <DTM> aspect, if applicable The Basic HART DTM is automatically assigned to device object types which do not have a specific DTM and therefore also do not have an “Install <DTM>” Aspect. This DTM is already installed with the HART Device Integration Package. 5. Double click on the Install <DTM> aspect starts the corresponding installation program 6. Follow the instruction of the DTM setup program Steps 1.) to 6.) need to be carried out on every 800xA system node on which the HART Device Integration has been installed. For further information on Device Object Types see section Field Device Library in IndustrialIT 800xA - Device Management, HART, Configuration. System 800xA Server Path Settings Once the shared folder (please refer to IndustrialIT, 800xA - System, Post Installation Setup manual, section Shared Folder for PROFIBUS and HART Device Integration) has been enabled for use on the server, it is necessary to notify the paths to the Fieldbus Builder PROFIBUS/HART and the OPC Server. 1. 440 Open Control Structure in Plant Explorer 3BDS011222R4101 Section 3 Configuration 2. HART Field Devices Select the FBB PH Settings aspect at the Root object in the aspect window Figure 181. FBB PH Settings Aspect in Control Structure 3. Change the path below the Value tab to the directory of the specific server using the UNC path setting. If no redundant or fewer servers are entered in the 800xA system leave the Value tab empty. This configuration needs to be carried out once per system. The paths which are included are stored in the Aspect Directory where they are available to each connected client. Example for an Aspect Server: \\aspect server\Fieldbus Builder PH Please ensure, that the Fieldbus Builder PH folder is shared on each Aspect and Connectivity Server. 4. Click Apply All Aspect Server and Connectivity Server with its share folder shall be included in the FBB PH Settings aspect. If more Connectivity Server then configuration rows of the FBB PH Settings are connected to the system, additional rows can be included manually. 3BDS011222R4101 441 HART Field Devices 5. Section 3 Configuration Change to the configuration mode of the FBB PH Settings aspect Figure 182. FBB PH Settings Config Menu 6. Select a Server in the left side window Figure 183. Configuration Mode 7. Press Add... button in the window Figure 184. Add ...> Property After 8. 442 Change Name and Value field 3BDS011222R4101 Section 3 Configuration HART Field Devices – Name is the new name of the server, e.g Connectivity_Server_4 – Value is the UNC path to the share folder Figure 185. New Configuration of Server 9. Confirm change with Apply Steps 6.) to 9.) need to be repeated till all servers are included in the aspect. Preconfiguration of OPC Server PROFIBUS/HART The OPC Server PROFIBUS/HART is executed on the Connectivity Server of the system, whereby the OPC-specific data are also swapped out to a directory enabled beforehand via sharing. The default path in the OPC Server Control Center is already set to the shared folder on the local drive. Please ensure, that the folder is shared as described in IndustrialIT, 800xA - System, Post Installation Setup manual, section Shared Folder for PROFIBUS and HART Device Integration). 3BDS011222R4101 443 HART Field Devices Section 3 Configuration The steps described below must be carried out, if the user has defined different shared folder as described in this documentation. The paths to the directories should be set manually in the OPC Server Control Center. 1. Launch the OPC Control Center from: Windows Start Menu > All Programs > ABB Industrial IT 800xA > Device Mgmt - HART > OPC Server PROFIBUS-HART 2. Change to Config Settings Figure 186. OPC Control Center 3. Set the DTM Project root path to the shared folder of the Connectivity Server. Example: \\127.0.0.1\<shared folder> Do not change any other settings in the configuration window. 444 3BDS011222R4101 Section 3 Configuration 4. HART Field Devices Check Namespace configuration Figure 187. OPC Control Center 5. Set the path of the OPC export file to the install drive on the local disc. The path shall be: <Install Drive>:\Program Files\ABB Industrial IT \Engineer IT\Fieldbus Builder\OPCServerConfig\TopologyImExport.xml Normally only the <Install Drive> need to be changed, if the installation drive is not drive C. Do not change any other settings in the configuration window. 6. Click Apply and OK] Repeat steps 1.) to 6.) locally as required for the relevant server if redundant or additional Connectivity Servers are used. 3BDS011222R4101 445 HART Field Devices Section 3 Configuration If OPC Server PROFIBUS/HART is already running it will need to be restarted in the 800xA system after configuration of the OPC Control Center (see also OPC Server Assignment to a Connectivity Server on page 448). In Plant Explorer, switch to Service Structure > OpcDA Connectors > <service group, name of the group was given beforehand during configuration> > Configuration > Uncheck enable > Apply > Check enable again >Apply. Precommissioning Control Networks, AC 800M and OPC In order to create an AC 800M controller network with the associated communications interfaces for e.g. PROFIBUS as well as the I/Os (local, remote) in Control Structure, a Control Network must first be set up. The Control Network also comprises the assignment of the particular OPC servers to Connectivity Server. Creation of an AC 800M Controller 1. Switch to Control Structure in Plant Explorer. 2. Select the root node. 3. Click with the right mouse button and select New Object. Figure 188. Select New Object... 446 3BDS011222R4101 Section 3 Configuration 4. HART Field Devices Browse to the Control Network object (Object Types > Control System > AC 800M/C Connect > Control Types), select Control Network, and insert a new name, if required. Figure 189. Select Control Network as the New Object 5. Click Create. 6. Select the newly created Control Network object and click with the right mouse button. 7. Select New Object in the context menu. 3BDS011222R4101 447 HART Field Devices 8. Section 3 Configuration Select the project object type for the required controller type, for example AC 800M, and enter a project name in the Name box. Figure 190. Selecting the Project Object Type for AC 800M 9. Click Create. You have now created the Control Network with an AC 800M Controller. Several AC 800M Controllers can be created under one Control Network. Repeat steps 6.) to 9.) as required to do this. To create a new Control Network and AC 800M Controller, repeat steps 1.) to 9.). For more information on creation of AC 800M controllers see IndustrialIT 800xA Control and I/O, Basic Control Software, Introduction and Configuration. OPC Server Assignment to a Connectivity Server A Connectivity Server on which the OPC Server PROFIBUS/HART can be executed is assigned to each Control Network. Only one OPC Server PROFIBUS/HART per Connectivity Server can be started. OPC Servers of other software options, for example the AC 800M OPC Server, can be executed on the same Connectivity Server, provided the relevant product documentation does not state other rules. 1. 448 Switch to Control Structure in Plant Explorer. 3BDS011222R4101 Section 3 Configuration 2. HART Field Devices Select the control network in the fieldbus topology. The following steps shall be done on every control network, placed in the system and containing the FBB-OPC Data Source Definition aspect. 3. Select the FBB-OPC Data Source Definition aspect Figure 191. FBB-OPC Data Source Definition Aspect in Control Structure 3BDS011222R4101 449 HART Field Devices 4. Section 3 Configuration Select the Connectivity tab. Figure 192. Connectivity Tab 450 3BDS011222R4101 Section 3 Configuration 5. HART Field Devices Click New…. Figure 193. New Service Group 6. Change the name of the service group, if required. The service group name can be found under Service Structure > Services > OpcDA_Connector. Example of a service group name: FBB_OPC_ControlNetwork1 Each control network needs a unique service group name and shall not given twice in the system 7. Click Add.... Figure 194. Adding a Service Provider 3BDS011222R4101 451 HART Field Devices Section 3 Configuration 8. Select the Connectivity Server on which the PROFIBUS/HART OPC Server is installed and running. 9. Click the OK button in the main window. 10. The OPC Server is now configured for data access to device internal data via OPC communication . If redundant Connectivity Servers are used in the system they have to be assigned to the same Control Network. To do this the steps 1 to 10 have to be repeated for each redundant Connectivity Server. For the case that not only one Control Network is instantiated, the steps 1 to 10 have to be repeated also for these Control Networks. Different service group names as well as different Connectivity Servers shall be used. Figure 195. OPC Server Configuration Complete AC 800M OPC Server Parameter display and faceplates are mainly supplied with data via the AC 800M OPC Server. Configuration of this OPC Server needs to repeat steps 1 to 10 on the OPC Data Source Definition Aspect. 452 3BDS011222R4101 Section 3 Configuration HART Field Devices Information about configuring and starting the AC 800M OPC Server can be found in IndustrialIT 800xA - Control and I/O, OPC Server for AC 800M. The OPC Server PROFIBUS/HART and the AC 800M OPC Server do not necessarily need to be operated on the same Connectivity Server. Preconfiguration of AC 800M Controller To ensure error-free communication for a field device with a DTM, an additional setting must be made for the AC 800M controller in Plant Explorer. In order that field devices can be accessed with DTM (Device Type Manager) via the AC 800M controller, the communication path (Tool Routing) must be enabled in each controller. Only when Tool Routing is enabled is communication with DTMs for field devices possible in the 800xA system. Tool Routing is disabled by default. In order to activate it, the processor module of the AC 800M controller, e.g. PM860/TP860, is selected in Control Structure. The Control Properties aspect appears in the aspect window. Select the aspect to open an overview of the various properties of the module in the main Plant Explorer window. One of the property entries is TOOLROUTING. 3BDS011222R4101 453 HART Field Devices Section 3 Configuration Set this Property Value to Enabled and click Apply. Figure 196. Tool Routing Enabled for DTM Access Increase TOOLROUTINGNBRCON to 50, if more than 50 devices are placed on Modulebus I/Os or if also PROFIBUS device objects are used. Setting up a Fieldbus Topology for HART Together with the AC 800M Controller, the 800xA system is capable of setting up a HART communication both by means of local S800 modules and also via remote I/Os and the PROFIBUS. This section describes a sample set-up for the S800 I/O modules. The following steps have been performed in Plant Explorer in Control Structure. The S800 I/O modules can also be instantiated in Control Structure using Control Builder M Professional or Bulk Data Manager. HART devices can be instantiated (not only in Control Structure) in Plant Explorer or using Bulk Data Manager. 454 3BDS011222R4101 Section 3 Configuration HART Field Devices Local S800 Modules of AC 800M 1. Open Plant Explorer 2. Switch to Control Structure 3. Open the substructure below the Project object. 4. To place S800 local I/O on the controller, select the ModuleBus object. 5. Click with the right mouse button and select New Object. 6. Browse to the required S800 module, e.g. AI895. 7. Enter the slot number of the module placed, e.g. 1, in the Name box. S800 local I/Os always start at slot 1. Further information on S800 modules and their instantiation see IndustrialIT 800xA - Control and I/O, Basic Control Software, Introduction and Configuration and the hardware related manuals on S800 I/O. 8. Click Create. The modul is instantiated with the slot number in Control Structure of Plant Explorer as well as in Project Explorer of Control Builder M Professional. Repeat steps 4 to 8 until the needed modules are created. PROFIBUS Remote I/O and HART Modules 1. Open Plant Explorer 2. Switch to Control Structure 3. Open the substructure below the Project object. 4. To place a PROFIBUS communication interface on the controller, select the Hardware object. 5. Right-click with the mouse and select New Object in the context menu. 6. Browse to the required communication interface, e.g. CI854 for PROFIBUS. DTMs exchange data with field devices using acyclic communication (DPV1). CI854(A) supports this type of communication, although CI851 does not. 3BDS011222R4101 455 HART Field Devices 7. Section 3 Configuration Enter the CEX bus number of the module placed, for example 1, in the name box. The CEX bus is the internal communication bus for data transmission between AC 800M controller and the connected communication interfaces. The communication interfaces are located on the left side of the controller and are numbered from left to right. Starting number is 1. Example: If the CI854 module is the second module on this bus, the number 2 must be entered in the name box. Information relating to CI854 modules and instantiation instructions can be found in the relevant product documentation. 8. Click Create. The settings for the PROFIBUS master are listed in the product documentation of CI854, IndustrialIT 800xA - Control and I/O, PROFIBUS DP, Engineering and Configuration. 9. To place S800 communication interface on the PROFIBUS, select the CI854 object. 10. Click with the right mouse button and select New Object. 11. Browse to the required S800 gateway, for example CI840. DTMs exchange data with field devices using acyclic communication (DPV1). CI840 supports this type of communication, although CI830 does not. 12. Enter the PROFIBUS address of the gateway placed, e.g. 20, in the Name box. 13. Click Create. 14. To place S800 modules on the CI840, select the CI840 object. 15. Click with the right mouse button and select New Object. 16. Browse to the required S800 module, for example AI895. 456 3BDS011222R4101 Section 3 Configuration HART Field Devices 17. Enter the slot number of the module placed, for example 1, in the Name box. S800 local I/Os always start at slot 1. Further information on S800 modules and their instantiation see IndustrialIT 800xA - Control and I/O, Basic Control Software, Introduction and Configuration and the hardware related manuals on S800 I/O. 18. Click Create. The module for Remote I/O is instantiated in Control Structure of Plant Explorer as well as in Control Builder M Professional. Repeat steps 13 to 17 until the required modules are created for Remote I/O The steps described above also have to be performed for instantiating of S900 Remote I/O modules. Then S900 modules and specific gateways have to be selected. Presetting for Instantiation Instantiation of field devices are only possible with the Fieldbus Builder PROFIBUS/HART in Communication disabled mode. If Communication enabled mode is active, it MUST be deactivated (Communication disabled). Two possibilities are available to set the Fieldbus Builder in Communication disabled: • Via context menu of the Fieldbus Management aspect at the device object. • Via Device Functions ... context menu in Control Structure of Plant Explorer. Fieldbus Builder Communication Mode (Fieldbus Management) 1. Select the CI854 or Modulebus object in Control Structure. Both object types, the CI854 and the Modulebus, have to be switched of, if HART field devices shall instantiated below the certain communication aspect. 2. 3BDS011222R4101 Select the Fieldbus Management aspect in the Aspect window. 457 HART Field Devices 3. Section 3 Configuration The mode icon in the preview window indicates the current mode (will be Communication disabled for fieldbus configuration). The icon appears on the bottom left of the preview window. 4. If the mode is Communication enabled, select the Fieldbus Management aspect in the preview window. Figure 197. Fieldbus Management Aspect 5. Click with the right mouse button and select Communication enabled (the check mark will disappear from this item). 6. The Mode icon switches to Communication disabled. 7. The device object can be switched to Communication enabled mode by selecting Communication enabled in the context menu. In Communication enabled mode, the DTMs required for the communication sequence are started although they do not affect actual fieldbus communication. In Communication disabled mode, only the DTM for the selected object is called. 458 3BDS011222R4101 Section 3 Configuration HART Field Devices Fieldbus Builder Communication Mode (Device Functions ... ) 1. Select the CI854 object in Control Structure. 2. Click with the right mouse button to open the context menu. 3. Select Device Functions in the context menu. Figure 198. Device Functions ... 4. The sub menu of Device Functions ... indicates the current mode (will be Communication disabled for fieldbus configuration). The sub menu allows also changing the mode by selecting the menu item. 3BDS011222R4101 459 HART Field Devices Section 3 Configuration Instantiation of HART Device Objects Instantiating HART device objects can be performed only in the Plant Explorers Control Structure. HART device objects are integrated into the fieldbus topology as follows. The HART Device Integration Library include HART Device Objects, prepared for use of vendor specific DTM. In this case the DTM has to be installed manually before instantiation. For a description of how to install specific DTMs, see Installation of Device Type Manager (DTM) on page 439 Vendor specific DTMs sometimes include a license mechanism to run the DTM without limitations. Only the DTM software is part of the Device Integration Package, the specific license of a DTM not. The DTM license has to be ordered separately from the DTM vendor. Licenses for a DTM are not included in the System 800xA licensing. HART Device Objects Below HART I/O Modules If they are located below multi-channel I/O modules, field devices that support the HART protocol must be assigned to the relevant channel of the I/O module. For a description of how to do this, see Channel Allocation on I/O Modules on page 462. Field device of the HART Device Library are integrated into the fieldbus topology as follows: 460 1. Open Plant Explorer 2. Switch to Control Structure 3. Open the substructure below the Project object. 4. Select the object below which the device object will be placed, for example AI895 5. Click with the right mouse button to open the context menu. 3BDS011222R4101 Section 3 Configuration 6. HART Field Devices Select the New Object in the context menu. Figure 199. Creating a new Device Object 7. 3BDS011222R4101 A folder structure containing the various device objects appears. Click "+" to open the next level of the partial tree and select the required device object (see also IndustrialIT 800xA - Device Management, HART , Configuration). 461 HART Field Devices 8. Section 3 Configuration Enter a name for the specific device in the Name box, e.g. the TAG. Figure 200. Selecting a Device Object 9. Click Create. The new device object is placed below the master object.Repeat steps 4 to 9 until all of the desired device objects have been placed on the I/O module. Channel Allocation on I/O Modules Field devices that support the HART protocol may only be placed below I/O modules that support this protocol in hardware and software (DTM) technology. HART field devices are managed exclusively by the Fieldbus Builder PROFIBUS/HART in Control Structure of Plant Explorer. Cyclic data communication must already have been started by Control Builder M Professional. The following operations must be carried out to assign the field devices to the module channels: 462 3BDS011222R4101 Section 3 Configuration HART Field Devices 1. Open Plant Explorer 2. Switch to Control Structure 3. Open the substructure below the Project object. 4. The field devices are added to Control Structure of Plant Explorer as new objects under the parent modules (for example AI895). 5. Select the Fieldbus Management aspect on the master object type (for example AI895). 6. The user interface of the Fieldbus Builder PROFIBUS/HART appears in the main window. The Fieldbus Builder PROFIBUS/HART copies the fieldbus tree from Control Structure to its fieldbus tree in the main window. To improve performance levels, the partial tree is not copied in its entirety. 7. Click "+" to open the next level of the partial tree. 8. All positioned field devices, together with the channel information from the parent objects, now appear in the partial tree. Figure 201. Fieldbus Management View 9. 3BDS011222R4101 The field device is selected and moved to the required channel by pressing and holding down the mouse button (drag and drop). The field device automatically moves to the channel. 463 HART Field Devices Section 3 Configuration 10. If the check box next to the device object is selected, the status window is updated and the object information is displayed. Figure 202. Assigned Device Objects with DTM Information Configuration and Commissioning of HART Device Objects After instantiation the HART device objects can be configured for application by means of DTM. A configuration describes the creation of a set of parameters for the particular device in the data base (Aspect Directory) of Aspect Server. For this task Fieldbus Management has to be switched to Communication disabled mode (see Presetting for Instantiation on page 457). How to start the particular DTM is described in detail in Starting the Device Type Manager (DTM) on page 468. The configuration of the device using a DTM is described in the associated DTM documentation and is not included in this documentation. Once the configuration phase is complete for all HART device objects the data sets for the particular devices or for a selection of the devices can be • verified • loaded to the devices / selection of devices • saved into one or more export file(s). These functions are performed on the Fieldbus Management aspect and its subconditions. 464 3BDS011222R4101 Section 3 Configuration HART Field Devices Instance data can be verified and exported with the Fieldbus Management in Communication disabled mode, but loading is only possible in Communication enabled mode. In order to load fieldbus lines, select the line via the context menu of the Fieldbus Management and then click on Download selection to start. Verify Selecting the verify option in the Fieldbus Management menu compare the online device date with the inside the 800xA stored offline configuration data set. The result is true, if the data set are equal, otherwise false. If the verification result is false, an up- or download is recommended for data synchronization. Download and Upload When several devices are selected, the PROFIBUS/HART Fieldbus Builder starts a batch process for up- or download, which is processed sequentially. Execution of the batch process continues even if errors occur in individual DTMs. Each event (faulty/successful execution) is documented in the Fieldbus Management status window. If an error occurs, an error message is displayed after the end of the batch process to indicate that the batch process is faulty. Loading errors can arise if this function is not supported by the DTM, e.g. S800 modules, or if the DTM cannot establish a connection to the device. Export and Import The export file of an instance data record is saved with a time stamp in a folder which is specific to the Device Object. This makes it possible to build up a device configuration history. Exported device data set can be imported again by selecting the specific export file. The export and import process is carried out manually by the user. Channel Changes on I/O Modules Channel changes can only be made in Communication disabled mode. The following operations must be carried out to reassign the field devices to the module channels: 3BDS011222R4101 465 HART Field Devices 466 Section 3 Configuration 1. Open Plant Explorer 2. Switch to Control Structure 3. Open the substructure below the Project object. 4. Select the object below which the device object will be placed, for example AI895 5. Select the Fieldbus Management aspect. 6. Click "+" to open the next level of the partial tree. 7. All positioned field devices, together with the channel information from the parent objects, now appear in the partial tree. 8. Select and move the field device to be reassigned to the required channel by pressing and holding down the mouse button (drag and drop). The field device automatically moves to the channel. 3BDS011222R4101 Section 3 Configuration HART Field Devices Deleting Device Objects Deleting device objects can only be made in Communication disabled mode. The following operations must be carried out to delete the field device from Control Structure: 1. Open Plant Explorer 2. Switch to Control Structure 3. Open the substructure below the Project object. 4. Select the field device to be deleted in Control Structure of Plant Explorer. 5. Click with the right mouse button to open the context menu. 6. Select Delete in the context menu. Figure 203. Delete Device Object 3BDS011222R4101 467 HART Field Devices Section 3 Configuration Starting the Device Type Manager (DTM) In addition to the Fieldbus Management aspect, every field device features a Device Management aspect. The Device Management aspect opens the associated DTM (Device Definition) in the main window with the instance data record. DTMs can be started in Communication disabled mode to configure field device objects or, if changes are to be made directly in the device, in online mode. Depending on the mode, the DTM will appear with various functional windows. The various modes are selected via the Fieldbus Management aspect of the relevant device object. Communication enabled mode starts all DTMs required for the communication sequence. Individual DTMs in this connection sequence can then not switch to Communication disabled mode without affecting other DTMs started in this sequence. Setting this object to Communication disabled/enabled mode is described in Presetting for Instantiation on page 457. Two possibilities are available to open a DTM: • Via Device Management aspect in the aspect window. • Via Device Functions ... context menu in Control Structure of Plant Explorer. Certain device-specific DTMs can only be started via the Device Functions context menu. With these DTMs, the Device Management window has a gray background and does not allow graphic interfaces to be displayed. Open DTM via Device Management Aspect The following operations must be carried out to open the field device’s DTM using Device Management aspect: 468 1. Open Plant Explorer 2. Switch to Control Structure 3. Open the substructure below the Project object. 4. Select the field device object in Control Structure. 5. Select the Device Management aspect in the aspect window. 3BDS011222R4101 Section 3 Configuration 6. HART Field Devices The DTM appears in the main window of Plant Explorer by using the Device Management Aspect or in its own window by using the Device functions context menu. Double click on an aspect in the aspect pane opens an own overlap (popup) window fro this aspect. 7. Other DTM views can be activated via the menu bar of the Device Management window. Figure 204. Preview Window with DTM and Context Menu via Device Management. Open DTM via Context Menu in Control Structure The following operations must be carried out to open the field devices DTM via context menu in Control Structure: 1. 3BDS011222R4101 Open Plant Explorer 469 HART Field Devices Section 3 Configuration 2. Switch to Control Structure 3. Open the substructure below the Project object. 4. Select the field device object in Control Structure. 5. Click with the right mouse button to open the context menu. 6. Select Device Functions ... in the context menu. Figure 205. Device Functions ... 470 7. The DTM appears in new window in front of Plant Explorer 8. Other DTM views can be activated via the menu bar of the DTM window bar or if applicable via DTM specific menus. 3BDS011222R4101 Section 3 Configuration HART Field Devices Starting OPC Server PROFIBUS/HART New instantiated device objects as well as changed topologies have to be transferred into OPC Server PROFIBUS/HART configuration. If device objects are only deleted from an existing topology, then the OPC Server does not necessarily need to be configured again. Configuration is only essential if topologies are changed and new device instances are created.. Please read the IndustrialIT, 800xA Device Management - HART, Configuration manual, whether special configuration may be required to run the OPC Server properly. 1. Open Plant Explorer 2. Switch to Control Structure 3. Open the substructure below the Project object. 4. Select a master object (e.g. Modulebus, CI854) in Control Structure 5. Select the Fieldbus Management aspect. 6. Select the Fieldbus Management node in the Fieldbus Management tree. 7. Click with the right mouse button to open the context menu. 8. Switch to Communication enabled mode. To provide the complete fieldbus architecture of the 800xA system to the OPC Server PH, it is mandatory to switch all CI854 objects and the Modulebus objects to the Communication enabled mode once. 9. Click again with the right mouse button to open the context menu. 10. Select Synchronize DTM related path. 11. Click again with the right mouse button to open the context menu. 3BDS011222R4101 471 HART Field Devices Section 3 Configuration 12. Select Configure OPC Server. Figure 206. Configuring the OPC Server 13. The message window indicates the current status of the configuration.. This shall be done for every Control Network object configured in the system. If changes in the topology are done, a new configuration of the OPC Server is mandatory. OPC Server configuration is now complete. The workstations containing the HART Device Integration installation, now has direct access to device data via the OPC Server. After a configuration of the OPC Server PROFIBUS/HART a reconfiguration of the AO Server is recommended. Information about configuring and starting the Asset Optimization (AO) Server can be found in the relevant product documentation. 472 3BDS011222R4101 Section 3 Configuration HART Field Devices HART Device Objects in Function Diagrams HART Device Objects of the HART Device Integration Library can be created and parameterized using Bulk Data Management worksheets and are supported in Function Designer by default. To configure a signal connection to a HART device in a Function Diagram: 1. Insert the Function Component for the HART device. 2. Insert the Function Component for a CBM_AIS / CBM_AOS Signal 3. Connect the pin of the HART device to the CBM_AIS/ CBM_AOS Signal 4. Connect the CBM_AIS / CBM _AOS Signal to a corresponding logic Function Component, for example of a Process Object Figure 207. Function Diagram with HART Device 3BDS011222R4101 473 PROFIBUS Field Devices Section 3 Configuration See Figure 207 how a signal connection to a HART device is represented in Function Diagram. To allocate CBM-Signal and HART Device: 1. Insert the CBM_Signal object below the corresponding HART-I/O board, for example AI895/AO895, in Control Structure 2. Insert the HART device object below the corresponding AI895/AO895 board in Control Structure 3. Insert the HART device object below the corresponding AI895/AO895 board channel in the Fieldbus Management aspect of the AI895/AO895 board 4. Make sure that the Control Designation Name field in the ChannelNumber aspect of the CBM_Signal contains the same channel number as the one used for the HART device in the Fieldbus Management aspect (property ParentChannel). Allocation of the CBM_Signals to boards in Control Structure you can do with the I/O Allocation function. For HART devices you can configure Bulk Data Manager worksheets that do creation, parametrization and allocation to boards in Control Structure. For allocation you use the Fieldbus Management aspect, for parametrization the Property Management aspect. PROFIBUS Field Devices This section uses step by step examples to describe how PROFIBUS device objects with asset monitors are used in a fieldbus system and how DTMs are started. Information about DTM functionality can be found in each device-specific description. Configuration activities are described in the following parts: 474 • Preparing Device Object Types for Usage • Precommissioning Control Networks, AC 800M and OPC • Setting up a Fieldbus Topology for PROFIBUS • Starting the Device Type Manager (DTM) • Starting OPC Server PROFIBUS/HART 3BDS011222R4101 Section 3 Configuration PROFIBUS Field Devices PROFIBUS Devices of the PROFIBUS Device Integration Library can be created and parameterized using Bulk Data Management worksheets. They are currently not supported in Function Designer by default, but for the corresponding object types you can create Function aspects / Function Components yourself. 3BDS011222R4101 475 PROFIBUS Field Devices Section 3 Configuration Prerequisites and Requirements The following requirements must be met, in order to be able to carry out the actions described in this section. • All necessary software is installed on the related system node. Please refer to IndustrialIT, 800xA - System, Installation for detailed information. • DCOM settings for PROFIBUS Device Integration components are adapted according IndustrialIT, 800xA - System, Post Installation Setup manual. • A directory must be shared for DTM access on every system node. Please refer to Industrial IT, 800xA - System, Post Installation Setup manual, section Shared Folder for PROFIBUS and HART Device Integration. • An 800xA system has been created and started. • The following system extensions have been added: – AC 800M/C Connect – Fieldbus Builder PROFIBUS/HART – HART Device Integration Library - Basics (Mandatory for DTM communication. The required license is covered by the PROFIBUS Device Integration.) – PROFIBUS Device Integration Library - Basics – PROFIBUS Device Integration Library - Asset Monitoring (Optional, requires Asset Optimization installation and loading of the relevant system extensions.) • Plant Explorer of Engineering Workplace or Plant Explorer Workplace has been started. • The user has Configure and Download permissions. General information on Fieldbus Topology in System 800xA already given in Fieldbus Topology in System 800xA on page 436. 476 3BDS011222R4101 Section 3 Configuration PROFIBUS Field Devices Preparing Device Object Types for Usage The PROFIBUS device objects are present in Object Type Structure once the system extensions of the PROFIBUS Device Integration Library have been loaded into the 800xA system. Some device object types which have been implemented in the 800xA system using the PROFIBUS Device Integration Library have a device-specific DTM for device configuration, parameterization and operation. The device-specific DTM may also include licensing, whereby the end user has to purchase the license separately directly from the device manufacturer. The PROFIBUS Device Integration Package copies the installation routines of the DTMs to the local hard drive. Afterwards the DTMs can be executed via the relevant device object type. In case, that the Device Library Wizard is used to extend the PROFIBUS Device Integration Library, the Device Type Manager (DTM) is installed automatically on the 800xA’s system node. Licenses for device-specific DTMs are not subject to the System 800xA licensing arrangements and are not included in the PROFIBUS Device Integration Package. Licenses for device-specific DTMs should be applied for from the relevant device manufacturer. Device-specific DTMs need to be installed on every 800xA system node on which the PROFIBUS Device Integration is executed. The DTM-specific licensing arrangements need to taken into account. Device object types cannot be used or instantiated if the associated DTM is not installed. 3BDS011222R4101 477 PROFIBUS Field Devices Section 3 Configuration Installation of Device Type Manager (DTM) This subsection can be skipped, if the device object type is installed separately via Device Library Wizard. Details can be found in IndustrialIT, Device Library Wizard, FOUNDATION Fieldbus, HART, PROFIBUS, User Instructions The installation of the Device Type Manager (DTM) is mandatory for object types, which are used in the field device topology. In case, that the DTM is already installed on the system nodes, this subsection is not applicable. Notice, that it is mandatory to install specific Device Type Manager (DTM) before the device object is instantiated in Control Structure of Plant Explorer. That applies also to device objects, coming into the system as instances in already created Control Structure via import, e.g. during upgrade or recovery procedures. Detailed information for upgrade procedure are described in IndustrialIT 800xA System, Upgrade and Installation. The following steps need to be carried out for the relevant object type, if the device specific DTM is not installed on the system node. DTMs can be also installed via setup tool, located in Start > All Programs > ABB Industrial IT 800xA > Device Mgmt PROFIBUS > PROFIBUS DTM Setup Tool 478 1. Switch to Plant Explorer Object Type Structure 2. A folder structure containing the various 800xA system object groups appears. Click "+" to open the folder structure Object Types\Control System\AC 800M/C Connect\Controller Hardware 3BDS011222R4101 Section 3 Configuration 3. PROFIBUS Field Devices Select the master device object used in the system For PROFIBUS, object types are stored inside the Object Types\Control System\AC 800M/C Connect\Controller Hardware catalog. This catalog level includes a master object type and the suitable module object types of the master object type. The master object type contains device specific parameter for the cyclic communication, documentation, CMMS and Asset aspects. Optional a Device Type Manager (DTM) is assigned to the master object type. For instantiation of new device types in Control Structure only the master object type shall be used. Module object types can only be placed below master object types. The name of the master object type are described in the product release notes. 4. Select the Install <DTM> Aspect, if applicable 5. Double-click on the Install <DTM> Aspect to start the associated installation program 6. Follow the instruction of the DTM setup program Steps 1 to 6 need to be carried out on every 800xA system node on which the PROFIBUS Device Integration has been installed. Preparing Hardware Definition Files (hwd) for Control Builder M Hardware Definition files are needed in the Control Builder M Professional project to establish the communication between AC 800M controller and the certain PROFIBUS devices. The Hardware Definition files (hwd) is based on the specific GSD file of the PROFIBUS devices and contains basic communication parameter as well as user specific parameter and diagnosis for the cyclic communication. Hardware Definition files for PROFIBUS devices are part of the PROFIBUS Device Integration Library. The hwd file is mandatory for object types, which are used in the field device topology. In case, that the hwd file is already integrated in the Control Builder M project, this subsection is not applicable. This subsection describes the first steps to copy hwd files of the used PROFIBUS devices to the related path of the Control Builder M project. The integration of the hwd file is described in Hardware Definition File Integration on page 487. 3BDS011222R4101 479 PROFIBUS Field Devices Section 3 Configuration Two possibilities are available to copy a hwd file to the Control Builder M Professional project path: • In Object Type Structure on the master object type via Update Hardware Definition aspect This aspect allows upload hwd files, if a complete new AC 800M control network shall be setup and if the AC 800M project is not placed yet in Control Structure. • In Control Structure on the CI 854 object instance via Update PROFIBUS Device HWD File aspect This aspect allows upload hwd files during commissioning, if a AC 800M project and a CI 854 object is already inserted in Control Structure. Update Hardware Definition The aspect Update Hardware Definition is only available in Object Type Structure of Plant Explorer at the PROFIBUS master object type. The following steps have to be carried out: 480 1. Open Plant Explorer and switch to Object Type Structure 2. Browse to the PROFIBUS master object type (Object Types\Control System\AC 800M/C Connect\Controller Hardware) 3BDS011222R4101 Section 3 Configuration 3. PROFIBUS Field Devices Select PROFIBUS master object type Figure 208. Update Hardware Definition Aspect 4. Double click the aspect Update Hardware Definition Figure 209. Upload Message Box 5. Click OK The hwd file is now copied to the Control Builder M Professional project directory. Please go ahead with System 800xA Server Path Settings on page 440. The alternative procedure described below can be performed to copy Hardware Definition files to the Control Builder M project. 3BDS011222R4101 481 PROFIBUS Field Devices Section 3 Configuration Update PROFIBUS Device HWD File The aspect Update PROFIBUS Device HWD File is only available in Control Structure of Plant Explorer at the PROFIBUS object type CI 854. The following steps have to be carried out: 1. Open Plant Explorer and switch to Control Structure 2. Browse to the PROFIBUS object CI854 3. Select the CI 854 object 4. Select the Update PROFIBUS Device HWD File aspect Figure 210. Update PROFIBUS Device HWD File Aspect 482 3BDS011222R4101 Section 3 Configuration 5. PROFIBUS Field Devices Select the device, which shall be inserted in the project. Use the pull down menu Select Device Figure 211. Select Device 6. Click Upload Hardware Definition File Figure 212. Upload Message Box 7. Click OK The hwd file is now copied to the Control Builder M Professional project directory. Please go ahead with System 800xA Server Path Settings on page 440. Alternatively the procedure described in Update Hardware Definition can be performed to copy Hardware Definition files to the Control Builder M project. 3BDS011222R4101 483 PROFIBUS Field Devices Section 3 Configuration Precommissioning Control Networks, AC 800M and OPC In order to create an AC 800M controller network with the associated communications interfaces for e.g. PROFIBUS as well as the I/Os (local, remote) in Control Structure, a Control Network must first be set up. The Control Network also comprises the assignment of the relevant OPC Server to a Connectivity Server. Creating an AC 800M Controller These steps are already described in Creation of an AC 800M Controller on page 446. AC 800M OPC Server Parameter display and faceplates are mainly supplied with data via the AC 800M OPC Server. Information about configuring and starting the AC 800M OPC Server can be found in the relevant product documentation. Preconfiguration of the AC 800M Controller To ensure error-free communication for a field device with a DTM, an additional setting must be made for the AC 800M controller in the Plant Explorer. In order that field devices can be accessed with DTM (Device Type Manager) via the AC 800M controller, the communication path (Tool Routing) must be enabled in each controller. Only when Tool Routing is enabled, communication with DTMs for field devices is possible in the 800xA system. Tool Routing is disabled by default. In order to activate it, the processor module of the AC 800M controller, e.g. PM860/TP860, is selected in the Control Structure. The Control Properties aspect appears in the aspect window. Select the aspect to open an overview of the various properties of the module in the main Plant Explorer window. One of the property entries is TOOLROUTING. 484 3BDS011222R4101 Section 3 Configuration PROFIBUS Field Devices Set this Property Value to Enabled. Figure 213. Tool Routing Enabled for DTM Access Increase TOOLROUTINGNBRCON to 50, if more than 50 devices are placed below a CI 854 PROFIBUS communication interface or if also HART device objects are used. Setting up a Fieldbus Topology for PROFIBUS Together with the AC 800M Controller and the CI 854 communication interface, the 800xA system is capable of setting up a PROFIBUS communication. This section describes a sample set-up for a PROFIBUS PA device. The following steps have been performed in Plant Explorer in Control Structure. The PROFIBUS devices can also be instantiated using Control Builder M Professional or Bulk Data Manager. 3BDS011222R4101 485 PROFIBUS Field Devices Section 3 Configuration Communication Interface CI854 The communication interface CI854 establishes the PROFIBUS network for an AC 800M controller. Up to 12 CI854 can be placed at the Controller, 6 lines can be build up in redundant mode. Also line redundancy is supported from each CI854 interface. This section describes a simple PROFIBUS network configuration. Mainly the configuration via Device Type Manager is part of this document. Detailed information are described in the relevant product documentation of the Control Builder M Professional. Additionally there is a document describing how to build up a physical PROFIBUS network. 1. Open Plant Explorer. 2. Switch to Control Structure. 3. Open the substructure below the Project object. 4. Browse to the Hardware object, placed below the AC 800M controller. Figure 214. Control Structure with AC 800M 486 5. Select the Hardware object. 6. Right-click on the mouse and select New Object. 7. Browse to the CI854 object, stored in the AC 800M hardware catalog. 3BDS011222R4101 Section 3 Configuration 8. PROFIBUS Field Devices Enter the CEX bus number of the module placed, e.g. 1, in the name box. The CEX bus is the internal communication bus for data transmission between AC 800M controller and the connected communication interfaces. Example: If the CI 854 module is the second module on this bus, the number “2” must entered in the name box. Information relating to CI 854 modules and instantiation instructions can be found in the relevant product documentation. 9. Click Create. The module is instanced both on the slot number in Control Structure of Plant Explorer and in the Control Builder M project. Repeat steps 5 to 8 until all of the desired modules have been placed. Hardware Definition File Integration Control Builder M Professional needs to have converted GSD files to establish cyclic communication between CI 854 and the related field device. The converted GSD file, which is stored in a Hardware Definition file (hwd), can be inserted in the Control Builder M Professional project. All device object types in the PROFIBUS Device Integration Library as well as device object types, included into the library via Device Library Wizard, do contain a valid Hardware Definition file. The hwd file has to be copied manually to the Control Builder M directory via a specific aspect at the device object type. Please follow the procedure described in Preparing Hardware Definition Files (hwd) for Control Builder M on page 479 before perform the steps below. 1. 2. 3BDS011222R4101 Open Control Builder M Professional. a. Open Plant Explorer b. Switch to Control Structure c. Browse to the Control Project object d. Select the Control Project object e. Right-click on the mouse and select Open Project Switch to the Control Builder M Professional project window. 487 PROFIBUS Field Devices 3. Section 3 Configuration Select File > Insert Hardware Definitions. Figure 215. Insert Hardware Definitions 4. Move up one directory level. Figure 216. CBM Project Path 5. Open Hardware Definitions folder. Figure 217. Hardware Definitions Folder 488 3BDS011222R4101 Section 3 Configuration 6. PROFIBUS Field Devices Select hwd files (multiple selection is possible). Figure 218. Select Hardware Definition Files 7. Click Open Hardware Definition files are inserted in the Control Builder M Professional project Hardware Definition files are only inserted into a single project. If more AC 800M projects with PROFIBUS are used in the 800xA system, steps 1 to 7 have to be repeated. Presettings for Instantiation Field device objects in the device library must be integrated into the fieldbus topology as follows. The steps described below are only possible with the Fieldbus Builder PROFIBUS/HART in Communication disabled mode. If Communication enabled mode is active, it MUST be deactivated for device instantiation (Communication disabled). Two possibilities are available to set the Fieldbus Builder in Communication disabled: 3BDS011222R4101 489 PROFIBUS Field Devices Section 3 Configuration • Via context menu of the Fieldbus Management aspect at the device object. • Via Device Functions ... context menu in Control Structure of Plant Explorer. Fieldbus Builder Communication Mode (Fieldbus Management) 1. Select the CI 854 object in Plant Explorer´s Control Structure 2. Select the Fieldbus Management aspect in the Aspect window. 3. The mode icon in the preview window indicates the current mode (must be Communication disabled for fieldbus configuration). The icon appears on the bottom left of the preview window. 4. If the mode is Communication enabled, select the Fieldbus Management node in the preview window. Figure 219. Fieldbus Management Aspect 490 5. Click with the right mouse button and select Communication enabled (the check mark will disappear from this item). 6. The Mode icon switches to Communication disabled. 3BDS011222R4101 Section 3 Configuration 7. PROFIBUS Field Devices The device object can be switched to Communication enabled mode by selecting Communication enabled in the context menu. In Communication enabled mode, the DTMs required for the communication sequence are started although they do not affect actual fieldbus communication. In Communication disabled mode, only the DTM for the selected object is called. Fieldbus Builder Communication Mode (Device Functions ...) 1. Select the CI 854 object in Plant Explorer´s Control Structure 2. Click with the right mouse button to open the context menu. 3. Select Device functions in the context menu. Figure 220. Device Functions ... 4. The sub menu of Device Functions ... indicates the current mode (will be Communication disabled for fieldbus configuration). The sub menu allows also changing the mode by selecting the menu item. 3BDS011222R4101 491 PROFIBUS Field Devices Section 3 Configuration Instantiation of PROFIBUS Device Objects Instantiating PROFIBUS device objects can be performed either in Control Structure of Plant Explorer or in the Control Builder M Professional project window. Field device library field devices can be integrated into the fieldbus topology as follows. The PROFIBUS Device Integration Library include PROFIBUS Device Objects, prepared for use of vendor specific DTM. In this case the DTM has to be installed manually before instantiation. For a description of how to install specific DTMs, see Installation of Device Type Manager (DTM) on page 478 Vendor specific DTMs sometimes include a license mechanism to run the DTM without limitations. Only the DTM software is part of the Device Integration Package, the specific license of a DTM not. The DTM license has to be ordered separately from the DTM vendor. Licenses for a DTM are not included in the System 800xA licensing. It is recommended to know the device addresses of each PROFIBUS device, located on the PROFIBUS line, before starting the device instantiation. If the devices are already connected to the PROFIBUS network, download the created project first. Then start the PROFIBUS CI854 Web Server to get the live list of connected PROFIBUS devices. The Web Server is described in the related CI854 product documentation (IndustrialIT 800xA - Control and I/O, PROFIBUS DP, Engineering and Configuration). Control Structure 492 1. Open Plant Explorer. 2. Switch to Control Structure. 3. Open the substructure below the Project object. 4. To place a PROFIBUS device on the CI 854, select the CI 854 Hardware object. 5. Right-click on the mouse and select New Object in the context menu. 3BDS011222R4101 Section 3 Configuration PROFIBUS Field Devices 6. Browse to the required PROFIBUS master object in the AC 800M hardware catalog, e.g. ABB_TFx12_YP0_v1_0. 7. Enter the PROFIBUS address of the object placed, e.g. 20, in the name box. 8. Click Create. 9. To place a specific device module below the PROFIBUS master object, select the PROFIBUS master object. 10. Right-click on the mouse and select New Object. 11. Browse to the required device module in the AC 800M hardware catalog, e.g. ABB_TFx12_Temp. 12. Enter the slot number of the module placed, e.g. 1, in the name box. Modules always start at slot 1. 13. Click Create. The device module is instantiated both in Control Structure of Plant Explorer and in the Control Builder M Professional project. Repeat steps 9 to 13 until all of the desired modules have been placed on the remote I/O. The above steps should be applied analogously for instantiating of an S800 and S900 Remote I/O. In this case the S800 and S900 modules and the specific gateways are selected. Control Builder M Project 1. 2. 3BDS011222R4101 Open Control Builder M Professional. a. Open Plant Explorer workplace b. Switch to Control Structure c. Browse to the Control Project object d. Select the Control Project Object e. Right-click on the mouse and select Open Project Switch to the Control Builder M Professional project window. 493 PROFIBUS Field Devices Section 3 Configuration 3. Browse to the CI 854 object. 4. Select the CI 854 object. 5. Right-click on the mouse and select New Unit > GSD Import > <device>. Figure 221. Select Device in the CBM Project 6. Select the PROFIBUS address of the object placed, e.g. 20, from the pull down menu. 7. Click OK. 8. To place a specific device module below the PROFIBUS master object, select the PROFIBUS master object. 9. Right-click on the mouse and select New Unit > GSD Import > <module>. 10. Browse to the required device module, e.g. ABB_TFx12_Temp1. 11. Select the slot number of the module placed, e.g. 1, in the pull down menu. 12. Click OK. 494 3BDS011222R4101 Section 3 Configuration PROFIBUS Field Devices The device module is instantiated both in Control Structure of Plant Explorer and in the Control Builder M Professional project. Configuration and Commissioning of PROFIBUS Device Objects There is no synchronization of device configuration data between Control Builder M project and the Device Type Manager (DTM). Device parameter, which may be necessary for both parts, must be configured twice - in the Control Builder M project and the DTM. For example: The device modules, which are configured in the Control Builder M project, are not automatically available in the DTM. The used device module must be configured also in DTM, if applicable. Once the PROFIBUS Device Objects have been instantiated they can be configured for the application via DTM. A configuration describes the creation of a parameter set for a particular device in the database only (in the Aspect Server). To do this, the Fieldbus Management must be switched to Communication disabled mode (see Instantiation of PROFIBUS Device Objects on page 492). A detailed description of how to start the relevant DTM is given in Starting the Device Type Manager (DTM) on page 497. The configuration of the device via a DTM is described in the associated DTM documentation and is not included in this documentation. Once the configuration phase is complete for all PROFIBUS Device Objects, the data records for the relevant device or selection of devices can be • verified • loaded to the device/selection of devices • saved in one or more export file(s). These functions are executed via the Fieldbus Management aspect and its subconditions. Instance data can be verified and exported with the Fieldbus Management in Communication disabled mode, but loading is only possible in Communication enabled mode. In order to load fieldbus lines, select the line via the context menu of the Fieldbus Management and then click on Download selection to start. 3BDS011222R4101 495 PROFIBUS Field Devices Section 3 Configuration Verify Selecting the verify option in the Fieldbus Management menu compare the online device date with the inside the 800xA stored offline configuration data set. The result is true, if the data set are equal, otherwise false. If the verification result is false, an up- or download is recommended for data synchronization. Download and Upload When several devices are selected, the PROFIBUS/HART Fieldbus Builder starts a batch process for up- or download, which is processed sequentially. Execution of the batch process continues even if errors occur in individual DTMs. Each event (faulty/successful execution) is documented in the Fieldbus Management status window. If an error occurs, an error message is displayed after the end of the batch process to indicate that the batch process is faulty. Loading errors can arise if this function is not supported by the DTM, e.g. S800 modules, or if the DTM cannot establish a connection to the device. Export and Import The export file of an instance data record is saved with a time stamp in a folder which is specific to the Device Object. This makes it possible to build up a device configuration history. The export process is carried out manually by the user. Deleting Device Objects Deleting device objects can only be made in Communication disabled mode. The following operations must be carried out to delete the field device from Control Structure: 496 1. Open Plant Explorer 2. Switch to Control Structure 3. Open the substructure below the Project object. 4. Select the field device to be deleted in Control Structure of Plant Explorer. 5. Click with the right mouse button to open the context menu. 3BDS011222R4101 Section 3 Configuration 6. PROFIBUS Field Devices Select Delete in the context menu. Figure 222. Delete Device Object Starting the Device Type Manager (DTM) How to start a DTM is already described in Starting the Device Type Manager (DTM) on page 468. Starting OPC Server PROFIBUS/HART How to start OPC Server PROFIBUS/HART is already described in Starting OPC Server PROFIBUS/HART on page 471. 3BDS011222R4101 497 FOUNDATION Fieldbus Field Devices Section 3 Configuration FOUNDATION Fieldbus Field Devices FOUNDATION Fieldbus Device configuration currently does not support Bulk Data Management and Function Designer. But you can use Function Designer to visualize existing FF device /hardware objects in Function Diagrams by adding corresponding Function aspects with Function Components yourself. The Fieldbus Builder FF is used from the Object Type Structure in order to edit the FF libraries and from Control Structure to edit HSE subnets. The editing of the libraries, e.g. the import of a new device or the change of block class parameters, is executed in Fieldbus Builder FF. After the changed library contents have been uploaded to 800xA system, the changes appear in the Object Type Structure. The configuration of an FF HSE subnet typically begins in Plant Explorer with the insertion of an HSE Subnet object in Control Structure. Further configuration of the HSE subnet is done in the Fieldbus Builder FF. After the configuration data of the HSE Subnet has been uploaded to 800xA system, the configured objects appear in Control Structure. In an Fieldbus Builder FF project, precisely one HSE subnet can be configured. The structure of the hardware used (H1 and HSE devices as well as OPC Gateway Stations) is set up, the functionality of the application configured and loaded into the devices and stations. One 800xA system can contain several HSE subnets. In this case, several Fieldbus Builder FF projects are combined in the 800xA system. Each of the HSE subnets is configured in its own Fieldbus Builder FF project and commissioned. If the 800xA system includes several HSE subnets, these are configured by different instances of Fieldbus Builder FF. All Fieldbus Builder FF instances and 800xA system work with the same FF libraries. Before editing an HSE subnet in Fieldbus Builder FF, it must be ensured that the latest library data is used. For achieving this library update may be required. This is initiated in the FF Upload Aspect of the HSE Subnet object. Commissioning is the operating mode of Fieldbus Builder FF which permits precommissioning and loading of objects. In addition, the commissioning mode offers the opportunity of displaying and modifying online data. 498 3BDS011222R4101 Section 3 Configuration FOUNDATION Fieldbus Field Devices In contrast to the configuration mode, however, no structural modifications may be made to the objects. Precommissioning can be performed and the configuration data can be loaded into the physical devices only if the configured structure has undergone a plausibility check, in commissioning mode. Besides precommissioning and the loading of objects, the individual parameters of the FF-blocks can also be edited. Therefore, parameter setting of the FF blocks is possible without reloading the FF Application objects concerned. Despite similar interface, configuration and commissioning are two different processes. Commissioning requires communication links with the devices on the HSE subnet and the subsidiary H1 links. It is possible to switch directly between configuration and commissioning modes. The following steps give you instructions how to configure and commission a FF Application using Fieldbus Builder FF : 1. Step1: Creation of an FF Library 2. Step 2: Creation of an HSE Subnet 3. Step 3: Configuration of an FF Application 4. Step 4: Loading of the FF Application 5. a. Step 4a: Precommissioning b. Step 4b: Commissioning Step 5: Using FF Data Prerequisites and Requirements The following requirements must be met, in order to be able to carry out the steps described here. • An 800xA system has been created and started. • The following system extensions have been added: 3BDS011222R4101 – AC 800M/C Connect, – Fieldbus Builder FF. – FF Device Integration Library - Basics 499 FOUNDATION Fieldbus Field Devices Section 3 Configuration • The Plant Explorer of Engineering Workplace or Plant Explorer Workplace has been started. • The user has Configure and Download permissions. Target Group The instructions address users, who are familiar with FOUNDATION Fieldbus and are acquainted with the parameter setting of the FF devices used. Step1: Creation of an FF Library The presence of an FF library is the basis for working with Fieldbus Builder FF. An FF library is a constituent part of the product FOUNDATION Fieldbus Device Integration. The extension of an existing library is described in this chapter. Files with descriptions are supplied with each FF device. For H1 devices, these are a CFF file and the DD files, a CFH file is supplied for HSE linking devices. The FF library is stored in the Plant Explorer Object Type Structure (refer to Figure 223) and edited using Fieldbus Builder FF. Figure 223. FF Library in the Object Type Structure 500 3BDS011222R4101 Section 3 Configuration FOUNDATION Fieldbus Field Devices To edit the FF library, select the object and then the FFUpload aspect. You start Fieldbus Builder FF in the Library Reference tab with Open Library in Fieldbus Builder FF. The FF library (refer to Figure 224) is displayed in the bottom left-hand section of Fieldbus Builder FF. Figure 224. FF Library If the FF library is not visible after the start of Fieldbus Builder FF, it can be displayed by means of View > Templates/Libraries. The FF library has three substructures: • FF HSE Device Library The FF HSE device library contains the class data for HSE linking devices. The devices are arranged according to manufacturer. • FF Block Library The FF block library contains the block classes. These are subdivided into function blocks, transducer blocks and resource blocks. Blocks are sorted according to block type. Blocks cannot be inserted directly. They are 3BDS011222R4101 501 FOUNDATION Fieldbus Field Devices Section 3 Configuration automatically created when H1 units are inserted or an existing block class is referenced by the device. • FF H1 Device Library The H1 device library contains the class data for H1 devices. The H1 devices are arranged according to manufacturer. To insert an FF device, select the relevant sub-library (FF HSE Device Library or FF H1 Device Library) and select Edit > Insert. In the Select Capabilities File dialog, select the CFH or CFF file of the FF device to be inserted and start the insertion with Open. Fieldbus Builder FF reads device information from the selected file and displays this in the Device Info dialog (refer to Figure 225). Figure 225. Insert Device You start the import of the device data into the FF library by means of OK. When inserting H1 devices, the corresponding DD is automatically read in via the assignment to the selected CFF file. Block-specific dialogs can be defined for newly inserted blocks to allow a simplified configuration and commissioning. Select the block class and start the dialog editor 502 3BDS011222R4101 Section 3 Configuration FOUNDATION Fieldbus Field Devices by means of Tools > Dialog Editor (refer to Figure 226). Refer to IndustrialIT Figure 226. Dialog Editor 800xA - Device Management, FOUNDATION Fieldbus, Configuration for use of the dialog editor. The extent of the parameters which can be accessed by OPC can be specified in the parameter dialog of the block class. To do this, roll to the right in the dialog until the OPC Access column appears. Here you can specify the parameters which can be used via OPC in the 800xA system. All parameters whose names do not include special characters and whose names are not double are preset. After all the requisite FF devices have been inserted into the library and edited, check the FF library for plausibility. To do this, select the Libraries object and start the logical error checking with Tools > Check subtree. After the logical error checking has been carried out, the Plausibility Check Error List is displayed. In the list, a differentiation is made between errors, warnings and information. Errors must be remedied for a successful plausibility check. The logical error checking status is indicated in the library tree. Here, stands for a plausible element and 3BDS011222R4101 503 FOUNDATION Fieldbus Field Devices Section 3 Configuration indicates an element which has not yet been checked for logical errors or which has an error (refer to Figure 227). Figure 227. FF library Checked for Logical Errors After a successful check for plausibility, save the FF library by means of FF Object editor > Save and close Fieldbus Builder FF. Change to the Plant Explorer Workplace Object Type Structure. Select the FFUpload Aspect and open the Library Upload tab. After changes have been made to the library, Library and Upload have different time-stamps. This is also indicated by the red traffic light (refer to Figure 228). Figure 228. Upload Required 504 3BDS011222R4101 Section 3 Configuration FOUNDATION Fieldbus Field Devices Start the FF library upload by means of Upload FF Library. After the upload has been concluded, Library and Upload have the same time-stamp. This is now indicated by the green traffic light (refer to Figure 229). The FF class objects Figure 229. Upload Successful configured in Fieldbus Builder FF are mirrored by the upload to the Object Type Structure in the Plant Explorer Workplace. Step 2: Creation of an HSE Subnet An FF network consists of at least one HSE subnet and any number of H1 links. HSE linking devices, HSEHostCI860 Devices and OPC Server FF can be connected to the HSE subnet. HSE linking devices connect the H1 links to the HSE subnet. The H1 devices are connected to the H1 link. HSEHostCI860 objects are used for the configuration of the data exchange between the FF Network and an AC 800M controller. OPC Servers FF are used for communication of System 800xA objects with the FF network. An HSE subnet is created in Plant Explorer Control Structure and edited by means of Fieldbus Builder FF. To create an HSE subnet, select the Root object and insert a new object with New Object. Select the HSE Subnet object and define a name for 3BDS011222R4101 505 FOUNDATION Fieldbus Field Devices Section 3 Configuration the object (refer to Figure 230). Insert the object by means of Create. The data has Figure 230. Selection of the HSE Subnet already been transferred in the following dialog. Check the settings and confirm 506 3BDS011222R4101 Section 3 Configuration FOUNDATION Fieldbus Field Devices them with OK (refer to Figure 231). Figure 231. HSE Subnet Reference You have thereby created a new HSE subnet for Fieldbus Builder FF. To configure the HSE subnet the type informations from the FF Library will be used. For this the data in the FF Library have to be transferred to the HSE Subnet. A library update is required to transfer the FF devices data from the FF Library to the HSE subnet. To do this, select the FFUpload aspect in the newly created HSE Subnet object. Start the update in the Library Update tab by means of Update Library. The data for the FF device and block classes contained in the FF Library is transferred to the HSE Subnet. Select the FFUpload aspect in the HSE Subnet object. Start the Fieldbus Builder by means of Open Subnet in Fieldbus Builder FF in the HSE Subnet Reference tab. 3BDS011222R4101 507 FOUNDATION Fieldbus Field Devices Section 3 Configuration Fieldbus Builder FF starts with an empty HSE subnet. Now configure your desired FF network by inserting objects in the sub-level from an object by means of Edit > Insert as per Table 17. Table 17. Structuring of FF Objects FF Object FF object types of the subordinate level FF Network HSE Subnet OPC Server FF (GWY) HSE Subnet Linking Device Module HSE Host CI860 (HSEHostCI860) HSE Linking Device H1 Link H1 Link H1 Schedule H1 Devices H1 Schedule FF Applic’n (FF Application) H1 Link and H1 Schedule are always inserted together. An HSE subnet with all the FF objects listed in Table 17 is shown in the example in Figure 232. Figure 232. Example of a Configured H1 Link After the FF devices have been inserted into the FF Application, their parameters must be set. 508 3BDS011222R4101 Section 3 Configuration FOUNDATION Fieldbus Field Devices Define the IP addresses and network settings for all stations in the HSE Subnet: • HSE Linking Device Select the HSE linking device object > Edit > Parameters. • HSEHostCI860 Device Select the HSEHostCI860 object > Edit > Parameters. • OPC Server FF Tools > Network > Select the OPC Server FF and press Edit. Input Resource ID and IP address. Some H1 devices do not display any function blocks after the insertion. These are H1 devices with instantiatable function blocks, into which the required number of different block types can be inserted. Open the context menu in the graphic view of the H1 device > Create Function Block. All the available block types are displayed in the following dialog (refer to Figure 233). Select a block and insert it in the H1 device with Create. The number of created instances is displayed in the Created Instances column and the available number of function blocks for each type is displayed in the Available Instances column. Figure 233. Instantiation of Function Blocks 3BDS011222R4101 509 FOUNDATION Fieldbus Field Devices Section 3 Configuration It is normally necessary to customize the settings of the H1 Link after the H1 devices have been inserted. To do this, select the H1 Link object and open the parameter dialog by means of Edit > Parameters. Now press the Proposal button. The H1 settings of the H1 devices connected to the H1 link are customized by this means. Close the dialog with OK. After all the FF objects have been edited, check the whole project for plausibility by means of Tools > Check whole project. After the logical error checking has been carried out, the Plausibility Check Error List is displayed. In the list, a differentiation is made between errors, warnings and information. Errors must be remedied for a successful plausibility check. The engineering status comprising the logical error checking status and the commissioning status is indicated in the tree. Here, stands for a plausible element, for a plausible element which has not yet been loaded, for a plausible element which has not yet been precommissioned, for a plausible element for which download information has not yet been generated, and indicates an element which has not yet been checked for logical errors or which has an error (refer to Figure 234). Figure 234. HSE Subnet Partially Checked for Logical Errors After a successful check for plausibility, store the HSE Subnet by means of FF Object editor > Save and close Fieldbus Builder FF. Change to the Plant Explorer Control Structure, select the FFUpload aspect in the HSE Subnet object and open the HSE Subnet Upload tab. After changes have been made to the HSE Subnet, HSE Subnet and Upload have different time-stamps. This 510 3BDS011222R4101 Section 3 Configuration FOUNDATION Fieldbus Field Devices is also indicated by the red traffic light. Start the HSE Subnet upload by means of Upload HSE Subnet. After the upload has been concluded, HSE Subnet and Upload have the same time-stamp. This is indicated by the green traffic light (refer to Figure 235). The objects configured in Fieldbus Builder FF are mirrored by the upload to Control Structure in Plant Explorer. Figure 235. Upload of Completed HSE Subnet Step 3: Configuration of an FF Application FF blocks are linked together in an FF Application, in order to execute the desired automation function. In the following example, a simple control loop is configured in FF devices, which is controlled by means of an external set point from the AC 800M controller. 3BDS011222R4101 511 FOUNDATION Fieldbus Field Devices Section 3 Configuration Select an FF Application object in the Plant Explorer Control Structure (refer to Figure 236). Figure 236. Selection of the FF Application Select the FF Management Aspect and start Fieldbus Builder FF with Show Object in Fieldbus Builder FF (refer to Figure 237). Figure 237. FF Management Aspect Fieldbus Builder FF opens the FF Application Editor for the selected object. The editor starts with an empty canvas. The function blocks are placed on the canvas of the editor and connected to each other. 512 3BDS011222R4101 Section 3 Configuration FOUNDATION Fieldbus Field Devices To insert a function block, switch to Link View in the lower part of the editor. All the H1 devices of the H1 link are displayed with their function blocks in the Link View (refer to Figure 238). Figure 238. Link View Select a function block and place it on the canvas with the left mouse button held down. For the example, use an analog input (AI), a controller block (PID) and an analog output (AO) as shown in Figure 239. After insertion, give the function blocks Figure 239. Function Blocks a tag name by selecting the function block and opening the parameter dialog by means of Edit > Parameters. Enter the tag name in the Name field and close the dialog by means of OK. FF signals are used for the connection to the AC 800M controller. Insert an FF signal by means of FF Application > Signal (read) and place it on the canvas (refer 3BDS011222R4101 513 FOUNDATION Fieldbus Field Devices Section 3 Configuration to Figure 240). End the insert mode with a right mouse click. Open the signal dialog Figure 240. FF Signals by double clicking the FF signal frame. Define a name (in the example FIC1201_SP) for the FF signal. Check the settings in the following dialog • Data Type: Analog; Discrete or Bitstring, • Usage: H1 local; HSE + H1 or HSE + H1 (LP), slow cycle and conclude it with OK. For the example, select the Analog data type and the HSE + H1 usage. Insert another FF signal by means of FF Application > Signal (write) and configure it accordingly. The data type bitstring is not supported by the HSEHostCI860 object. Now connect the function blocks and FF signals as shown in Figure 241. To do this, hold down the CTRL key and drag the connecting lines with the left mouse button held down. If the Shift key is pressed in addition to the left mouse button and the CTRL key, the course of the signal line is automatically defined by Fieldbus Builder FF. 514 3BDS011222R4101 Section 3 Configuration FOUNDATION Fieldbus Field Devices Figure 241. FF Application Please note that the FF PID control loop requires a feedback from the FF AO block. In the example, the BKCAL_OUT of the FF AO block is fed back to the BKCAL_IN of the FF PID block. The same applies for the master controller in the AC 800M controller. In the example, the external set point from the AC 800M controller is communicated to the FF block by means of FF signal FIC1201_SP. The FF Signal FIC1201_BKCAL is used for feedback to the AC 800M controller. After the function blocks have been inserted into the FF Application, their parameters must be set. To do this, open the parameter dialog of a function block by 3BDS011222R4101 515 FOUNDATION Fieldbus Field Devices Section 3 Configuration double clicking the block in the FF Application object or in the H1 device object (refer to Figure 242). Figure 242. Standard Dialog If block-specific dialogs are in existence, they should be used for the parameter definition. In principle, check the following parameters during the parameter definition: 516 • ALERT_KEY The value of the ALERT_KEY must be in the range 1 .. 255. • MODE_BLK The mode parameter consists of several parts. The Target mode defines the 3BDS011222R4101 Section 3 Configuration FOUNDATION Fieldbus Field Devices mode of operation which the block should adopt. The modes of operation into which the block can be switched via the Target mode are specified by means of the Permitted Mode. The Actual mode shows the current mode of the block. The following modes of operation should be set for the block types (refer to Table 18). Table 18. Recommended Modes of Operation for FF blocks Block type Recommended mode of operation Resource Block Auto Transducer Block Auto Analog input (AI) Auto PID Controller Block Man, Auto or Cas(1) Analog Output (AO) Cas (1) Dependent on the functionality of the controller. For the Cascade mode, Auto and Cas are to be set in the target mode at the same time. • Scaling Customize the scaling of the individual blocks to the requirements of your process. The HSEHostCI860 object must be configured for data exchange with the AC 800M controller. An FF host can access all FF signals which were defined by the HSE + H1 usage. Select the HSEHostCI860 object and open the parameter dialog with Edit > Parameters. Select the Published/Subscribed tab. Insert a new channel via the context menu by means of Create Component. Define • Data type: Analog (DS-65) or Discrete (DS-66) and • Direction: FF -> IEC61131 - from the FF device to the AC 800M or IEC61131 -> FF - in the opposite direction for the channel. Select the FF signal field and open the Signal Selection Dialog by means of the F2 key. Select the desired FF signal and transfer it to the HSEHostCI860 object by means of OK. The configuration of the HSEHostCI860 3BDS011222R4101 517 FOUNDATION Fieldbus Field Devices Section 3 Configuration object for the above example can be seen in Figure 243. Repeat this for all FF Figure 243. Example of an HSEHostCI860 Configuration signals which you wish to use in programs in the AC 800M controller. The thus defined channels of the CI860 module can be assigned with I/O variables in Control Builder M. A schedule which includes the time sequence of the function blocks and communications from FF signals is automatically generated on storage of the FF Application object. The contents of the schedule are based on the created FF Application and the performance specifications of the H1 devices used. To display, 518 3BDS011222R4101 Section 3 Configuration FOUNDATION Fieldbus Field Devices select the H1 Schedule object (refer to Figure 244). For experienced users, there is the possibility of moving the individual blocks in the schedule manually. Figure 244. Example of a Schedule After the FF Applications have been created, check the whole project for plausibility by means of Tools > Check whole project and correct any errors which occurred. After a successful check for plausibility, store the HSE subnet by means of FF Object editor > Save and close Fieldbus Builder FF. Change to the Plant Explorer Control Structure. Select the FFUpload Aspect in the HSE Subnet object and open the HSE Subnet Upload tab. After changes have been made to the HSE Subnet, HSE Subnet and Upload have different time-stamps. Start the HSE Subnet upload by means of Upload HSE Subnet. After the upload has been concluded, HSE Subnet and Upload have the same time-stamp. The configuration of the FF network with the FF Application has now been completed. The configured data must now be distributed to the connected devices. Step 4: Loading of the FF Application Once it has been loaded, the data of the FF Application is distributed over the FF network. The FF Application is loaded in two steps. In the first step, the precommissioning, a device assignment between the configured devices and the devices which are actually present is carried out. Basic settings are written to the devices. 3BDS011222R4101 519 FOUNDATION Fieldbus Field Devices Section 3 Configuration In the second step, the commissioning, the data of the FF Application is loaded into the individual devices. Step 4a: Precommissioning The precommissioning is different for linking devices and H1 devices. During the precommissioning of a linking device the tag name is written and the configured H1 links are activated. For H1 devices, the tag name is written to the device and the bus address set. The device ID is read out of the device and stored in the Fieldbus Builder FF database. As a result, the device can subsequently be detected. The configured blocks are loaded into H1 devices with instantiatable function blocks. For the precommissioning, select a linking device object in the Plant Explorer Control Structure. Select the FF Management Aspect and start Fieldbus Builder FF with Show Object in Fieldbus Builder FF. Switch Fieldbus Builder FF into the commissioning mode by means of FF Object editor > Commissioning. Status information for the individual objects is displayed in the commissioning mode. Open the Write Linking Device Settings dialog by means of Object > Linking device initialization and address assignment... and start the precommissioning of the linking device by means of Start (refer to Figure 245). Figure 245. Precommissioning of Linking Device Successfully Concluded 520 3BDS011222R4101 Section 3 Configuration FOUNDATION Fieldbus Field Devices After the linking device settings have been successfully written, select an H1 link of the linking device. Open the Live List by means of Object > Live list.... The live list is divided into two sections (refer to Figure 246). The H1 devices actually present in the H1 link are Figure 246. Device Assignment listed in the left-hand section. The right-hand section contains a list of the configured H1 devices. Select an actual H1 device in the left-hand section and use the mouse to drag it to the configured H1 device in the right-hand section which contains the configured data for the actual H1 device. The tag name is written to the H1 device and the bus address of the H1 device set during the device assignment. The device ID is read out of the H1 device and stored in the Fieldbus Builder FF database. You can also carry out the device assignment by selecting an H1 device and opening the H1 Live List by means of Object > Assign device.... Select the H1 device to be assigned from the list and start the device assignment with Assign. 3BDS011222R4101 521 FOUNDATION Fieldbus Field Devices Section 3 Configuration Repeat this process for all H1 devices in the H1 link and for further H1 links and linking devices if required. Step 4b: Commissioning After all the requisite FF devices have been assigned, the FF Application can be loaded into the individual FF devices. Select the HSE Subnet and open the download dialog with Object > Download... (refer to Figure 247). Figure 247. Download Dialog After the on-line version check has completed, the commissioning status displayed in the tree structure of the download dialog indicates, which objects will be loaded. Here, indicates that the object will not be loaded because on-line data is up to date, indicates that an incremental download will be performed, and indicates that a full download will be performed. and stand for incremental or full download respectively where at an H1 link the Link Acitve Scheduler (LAS) will be 522 3BDS011222R4101 Section 3 Configuration FOUNDATION Fieldbus Field Devices stopped and at an H1 device the resource block will be stopped. indicates an element for which no on-line version check has been performed yet. It is recommended not to change the default settings of the download options which will result in an incremental download with block parameters not being loaded and the LAS on the H1 links not being stopped. Start the download by means of Start Download. In a separate window the progress of the loading operation and any errors or warnings that may occur are displayed (refer to Figure 248). All the configured data is loaded to the H1 devices and the linking device during the download. The window and the download dialog closes after successful completion of the download. Figure 248. Load Parameters To load the OPC server, select the OPC Server FF object and start the download with Object > Download.... The settings for the OPC Server FF are loaded into the latter by this means. After the FF Application and the OPC Server FF have been successfully downloaded, online data are available from the devices. 3BDS011222R4101 523 FOUNDATION Fieldbus Field Devices Section 3 Configuration Select an FF Application object. If the mouse cursor is held down on a block pin or an FF signal line, the current values are displayed (refer to Figure 249). Figure 249. Online Data 524 3BDS011222R4101 Section 3 Configuration FOUNDATION Fieldbus Field Devices Online data for the block parameters is also displayed in the commissioning mode. To do this, open the parameter dialog of a function block by double clicking the block in the FF Application object or in the H1 device object (refer to Figure 250). Figure 250. Online Parameters The yellow background of individual values indicates a difference between the real value in the H1 device and the configured value in the Fieldbus Builder FF database. For the commissioning of your FF Application, compare the Actual and Target mode of the individual blocks. Actual and Target mode can differ from each other, dependent on the signal statuses at the inputs of a block. In this case, check the cause, e.g. a sensor not connected to the device. 3BDS011222R4101 525 FOUNDATION Fieldbus Field Devices Section 3 Configuration Values of individual parameters can be changed by changing the value in the value field. The button bar is toggled as a result. The new value is written to the H1 device by means of Write and the value is written to the H1 device and the Fieldbus Builder FF database by means of Correct. Current values in the H1 device which are not in the Fieldbus Builder FF database (highlighted with yellow background) can be loaded into the database. For this, mark one or more lines in the parameter dialog. Open the context menu and start the transfer of the data by means of Upload marked. Step 5: Using FF Data For use in the AC 800M The FF signals entered in the HSEHostCI860 object in Fieldbus Builder FF are automatically transferred to the CI860 object in Control Builder M. In this connection, define the requisite hardware in a Control Network in the Plant Explorer Control Structure. Follow the appropriate manual. Select a CI860 object and insert an object with Insert Object. Select the HSEHostCI860 object in an HSE subnet in the following dialog and confirm the insertion with Insert (refer to Figure 251). Figure 251. Insertion of an HSEHostCI860 Object 526 3BDS011222R4101 Section 3 Configuration FOUNDATION Fieldbus Field Devices Figure 252 shows the inserted HSEHostCI860 object. Figure 252. Example of an HSEHostCI860 Object in a Control Network Select the CI860 object in Control Structure and change to Control Builder M. Open the hardware editor via the context menu by means of Editor (see Figure 253). Figure 253. Hardware Editor of the CI860 Object The FF signals assigned in Fieldbus Builder FF are displayed in the Connections tab in the Protocol Info column. I/O variables which can be used in the programs and control modules of Control Builder M can be assigned to the channels in the Variable column. 3BDS011222R4101 527 Production Management Section 3 Configuration For use in Process Portal A After upload of the FF configuration and download of the FF devices and the OPC Server FF, online data from the FF devices are available in the block objects in Plant Explorer. Prerequisites are the specification of the OPC Access for the respective classes in Fieldbus Builder FF and the correct configuration of the OPC Data Source Definition aspect at the HSE Subnet object in Control Structure of Plant Explorer. Close Fieldbus Builder FF before uploading the HSE Subnet configuration to Plant Explorer. The data for the FF objects is available in the Control Connection Aspect. Graphics, faceplates, trends, archives, among others, can access this data. Please use the respective manuals to configure these applications. For further configuration information on Fieldbus Builder FF see IndustrialIT 800xA - Device Management, FOUNDATION Fieldbus, Configuration. Production Management Production Management consists of the Batch Management and Manufacturing Management functions. Flexible Batch Processing Flexible batch processing permits control logic and resources such as equipment to be used in a variety of ways to produce different products. Flexibility is built into the Batch Management approach to configuring recipes. The master recipe is created by drawing a flowchart of the process using an object oriented approach. This flowchart is called a procedure function chart (PFC). The objects used in the PFC represent: 528 • Batch manager actions such as allocating an equipment resource, sending the operator a message, or collecting data to be used later in a batch report. • Phase operations (created during controller configuration) specifically for the requirements of a customer. 3BDS011222R4101 Section 3 Configuration • Production Management A subprocedure. These objects can be combined in any sequence supported by the batch resources. The system permits configuration of procedures consisting of a single thread of processing, branched logic, or parallel operations. At run time, the operator monitors the progress of the batch run while viewing a copy of the diagram created during procedure configuration. Flexibility of formulas used to create batch products is enabled in a number of ways: • The equipment phase logic can find parameters specified by name. • Values can be assigned to parameters in a number of ways, including by the operator at run time (if the recipe is so configured). • The values assigned to parameters can be logical expressions, as well as fixed values. Configuration Overview The tasks required to take advantage of the benefits of the Batch Management flexible batch subsystem are: • Planning resource use. • Writing equipment phase control logic. • Configuring the controller modules required to handle input and output data, control loops, and execution of sequence logic. • Configuring the equipment database that describes the hardware and software resources available at the site. • Creating recipes that can include both subprocedures and formulas, using reusable logic components. The controller and Batch Management can be configured simultaneously. Within Batch Management, equipment must be configured before it can be referenced by procedures. 3BDS011222R4101 529 Production Management Section 3 Configuration Batch Management Configuration Batch Management configuration tools (accessed various ways) provide access to the: • Equipment database configuration - Batch Management records information about the resources available for flexible batch processing in the equipment database. • Procedure configuration - Batch Management stores procedures in the recipe database. • Miscellaneous and default batch configuration. Equipment Database Configuration The equipment database is a collection of interrelated definitions of phases, equipment and equipment groups. Equipment must be configured before procedures can reference it (although changes can be made later). The steps to configure the equipment database are: 1. Configure phase definitions, including the phase parameters, default values, and access levels. 2. Verify the phases match the equipment phases defined for the controller (EPT control modules only). 3. Configure equipment names. 4. Specify equipment attributes. Identify characteristics of the equipment that could have an effect on which equipment should be used for a particular batch. 5. Specify which phases can run on which equipment. 6. Define equipment groups. Procedure Configuration Once the equipment has been configured, procedures can be created that reference the equipment. 530 3BDS011222R4101 Section 3 Configuration Production Management Prior to procedure configuration, the designer may want to specify batch cells. Batch Management procedures are configured by creating PFCs (procedure function charts). Procedures are drawn using an object oriented approach. The PFC created during procedure configuration will also be used at run time by the operator to monitor the progress of a batch. The steps to create a procedure are: 1. Configure the procedure header providing information about the procedure. 2. Configure the standard operating procedure (SOP), which is a textual representation of the procedure (optional). 3. Configure procedure parameters. 4. Create the PFC. a. Add objects representing batch manager actions to acquire equipment. b. Add objects representing phases, subprocedures, compute batch manager actions, message batch manager actions, etc., which includes defining each object. Procedure specific values for procedure and phase parameters can be included. c. Add objects representing batch manager actions to release equipment. d. Add connector objects linking objects on the PFC. Miscellaneous Batch Configuration Additional batch configuration activities are performed using various methods. These activities include defining message priorities, specifying the number of backup versions of procedures to be retained, and the option to change the colors used in PFCs. The retention limit for display of completed batches is also specified using these methods. The Batch Management batch manager runs under System 800xA. When the software is installed, a node is designated as a primary server. A second node can optionally be designated as a redundant server. 3BDS011222R4101 531 Production Management Section 3 Configuration Manufacturing Management General Administration Configuration General administration configuration is performed once after system installation and rarely changes. The following objects are configured during post-installation configuration: 1. Manufacturing Management System Parameters, Lot and Batch Code Algorithms 2. Authentication and Electronic Signature requirements 3. Applicable Document Types, Documents and Document Associations 4. Weigh scale and barcode printer Device Types and Devices 5. Units of Measure and UOM conversions 6. Transport Unit Types 7. Custom Properties Inventory Configuration Inventory configuration is performed once after system installation or more frequently based on business needs. The following objects are configured during Inventory configuration: 532 1. Material Types 2. Materials 3. Material Attributes 4. Material Custom Properties 5. Product Types 6. Products 7. Storage Locations 3BDS011222R4101 Section 3 Configuration Production Management Quality Configuration Quality configuration is performed once after system installation or more frequently based on business needs. The following objects are configured during Quality configuration: 1. Quality states for Materials 2. Material Expiration and Testing Controls 3. Cleaning, Maintenance and Calibration Controls for Transport Units 4. Transport Unit Control Lists 5. Cleaning, Maintenance and Calibration Controls for Location and Equipment 6. Sample Equations and Expressions 7. Sample Definitions 8. Sample Plans Operation Configuration Operation configuration is performed once after system installation or more frequently based on business needs. The following objects are configured during Quality configuration: 1. Bill of Material 2. Bill of Equipment 3. Bill of Output 4. Bill of Document 5. Bill of Parameter 6. Bill to Product Association 7. Intelligent Form (IForm) Design Weigh and Dispense The Weigh and Dispense module does not require configuration. It uses configuration information from the Inventory, Quality and Operation modules. 3BDS011222R4101 533 Production Management Section 3 Configuration IForm Design The IForm Designer is used to create and modify Intelligent Forms (IForms). When IForms are executed using the Manufacturing Management functionality, they specify the materials, equipment, and procedures for manufacturing. IForms also record the performance and verification data generated by the personnel carrying out the manufacturing tasks. Using the Manufacturing Management functionality, operators and supervisors are guided through the production process by following IForms containing IObjects. In the process, data is entered into these IObjects and the data is stored in the system database. The stored data becomes part of the System 800xA electronic batch record that documents the production of each batch. The tool used to create IForms containing IObjects is the IForm designer, a standard feature of the Manufacturing Management functionality. The IForm designer operates like a word processor with one exception. The IForm designer is specially adapted to insert IObjects into the document making the document an IForm. IObjects link to other IObjects, other IForms, and to tables in the database. When the IForms are executed, the IForm engine program displays the IForm. The IForm then guides the operator through production sequences and data collection processes. The IForm designer uses Microsoft® FrontPage® as the supporting structure for designing IForms. The code specific to the Manufacturing Management functionality for IForm design is an extension to Microsoft FrontPage which provides a number of specific functions described in this instruction. The IForm designer creates IForms using hypertext markup language (HTML) that is stored as a document in the Manufacturing Management database. Any document that can be opened in the IForm Designer can be a source of instructions. Once IObjects are added and the IForm is stored in Manufacturing Management, then only the IForm designer should be used to create or modify IForms because the IObjects used to build the IForms are not available to other word processors, text editors, etc. Further information on Manufacturing Management configuration steps including IForm you find in IndustrialIT 800xA - Production Management, Manufacturing Management, Configuration. 534 3BDS011222R4101 Section 3 Configuration Information Management Information Management Historical Process Data Configuration of the basic System 800xA workplace functionality for History is done using two aspect categories, the Log Template and the Log Configuration. The Log Template defines how to log and the Log Configuration is used to produce a log for every object you would like to log. Default Log Templates are provided in the Library Structure in the Plant Explorer. Configuration of the basic System 800xA workplace functionality for Trends is done using the Trend Template aspect category. Default Trend Templates are provided in the Library Structure in the Plant Explorer. Details of basic History and Trend (Traces or XY-plot) configuration are described in IndustrialIT 800xA - Operations, Operator Workplace, Configuration. Details of Information Management History configuration are described in IndustrialIT 800xA - Information Management, Configuration. The following subsections describe how you can do bulk configuration of Log Configuration aspects and of Property Logs of the Information Management History Services. Bulk Configuration of Log and Trend Configuration Aspects Bulk configuration of Log and Trend Configuration aspects of the basic System 800xA workplace functionality for History are supported by an Engineering Templates LogConfig.xls and TrendConfig.xls provided with Bulk Data Management in Engineering Workplace. How to use templates like LogConfig.xls based on bulk data interfaces is described in IndustrialIT 800xA - Engineering, Engineering Workplace, Basic Engineering Functions. Bulk Configuration of Property Logs The Bulk Configuration tool helps you configure and instantiate property logs for a large quantity of object properties without having to add the logs on an object-by- 3BDS011222R4101 535 Historical Process Data Section 3 Configuration object, and property-by property basis in the Plant Explorer. This tool is an add-in for Microsoft Excel. The Bulk Configuration tool lets you generate a load report which calculates the disk space occupied by existing file-based property logs, and additional disk space which will be required as a result of instantiating new property logs via this tool. This report helps you to determine whether you need to adjust the disk space allocation for file-based logs. This tool also lets you verify whether or not the logs have been created when you are done. Import filters in the Bulk Configuration tool can be used to shorten the time it takes to read information from aspect objects into the Excel spreadsheet. The most effective filter in this regard is an import filter for some combination of object types and properties. Since some objects may have hundreds of properties, the time savings can be significant. You can also create a list of properties for which logs have already been created, in the event that you want to modify or delete the log configurations for those properties. Work Flow Configure all other history objects, including log templates, before using this tool. The recommended work flow is as follows: 536 1. Configure log sets, message logs, report logs as required by your application. If you require archival, create an Archive Device and Archive Groups. 2. Configure the Log Templates. DO NOT create Log Configuration aspects at this time. 3. Create a new workbook in Excel and initialize the workbook to add the Bulk Configuration add-ins. 4. Create a list of object properties whose values are to be logged. 5. For each object property, specify the Log Template that meets its data collection requirements, and specify the name of the Log Configuration aspect. 6. Configure presentation attributes and access name if necessary. 7. Generate a load report to see whether or not you need to adjust the disk space allocation for file-based logs. Make any adjustments as required. 3BDS011222R4101 Section 3 Configuration Extended Configuration Data 8. Create new property logs based on the spreadsheet specifications. 9. Verify that all property logs and their respective component logs have been created. 10. Run the Load Report function again. This time, the report should indicate that all logs have been created (existing space used = proposed space requirement). 11. Create a backup copy of your database. 12. On all nodes where trend and history logs reside, check the system for fragmented files, and defragment the applicable disks as required. 13. History logs will not collect data until they are activated. Test the operation of one or more property logs. You can use the Status tab on the Log Configuration aspect, or you can use one of the installed desktop tools such as DataDirect or Desktop Trends. Extended Configuration Data Parameter Management Parameter Manager aspects can be used to gather extended configuration data and expose them to other aspects in the system in a very flexible manner. To provide extended configuration data in Parameter Management aspects you have to perform the following principal steps: 1. Define a corresponding Parameter Manager aspect category in Aspect System Structure with the needed properties. Simple properties, structured properties and instance specific properties are supported. 2. Create the instances of the new Parameter Manager aspect category in the objects that shall hold the data. Preferably an aspect instance is created in the corresponding object type so that each instance of this object type gets an aspect instance. 3. Fill in the data of Parameter Manager aspects using the Parameter Manager Open Properties aspect context menu item or your specifically configured Bulk Data Management worksheets. Only if single aspects have to be treated use the single aspect pane in Plant Explorer. 3BDS011222R4101 537 Extended Configuration Data 4. Section 3 Configuration Connect the properties of other aspects in this object or in other objects to the parameter aspect properties using either property transfer aspects (transferring from source aspect to sink aspect) or property references in the sink aspects. To “push” data property transfer aspects (for example of category AesPropertyTransfer) can be used. Source and sink aspect have to be contained in the same object. Note that AesPropertyTransfer cannot be used to write to Control Properties of Control Builder M Professional. To “pull” data you can use property references in the aspects that pull the data. They are supported by Document Management, Bulk Data Management, Control Builder M Professional, Graphics Builder (in the form of object references to configure with Expression Builder), Function Designer, Topology Designer / Topology Status Viewer and Parameter Management itself. Document Management and Bulk Data Management are able to support property references bi-directional. In cases none of the two methods are applicable you can configure a Bulk Data managment worksheet to transfer the data on demand. To create an own Parameter Manager aspect category with simple table-like properties you perform the steps: 1. In the Aspect System Structure select the Parameter Manager aspect type object. 2. Execute the New Object context menu item and create an object with a name at your choice. 3. In the aspect pane of this Aspect Category object add the properties via the context menu on the Categories item. 4. If you want to allow introduction of additional instance specific properties check the InstanceProperties check button. 5. When you create instances of your Parameter Manager aspect category you get a database for your extended configuration data that is optimized for your need. To create structured properties you have to include into your aspect category object the set of sub-categories each represented by an own categories aspect chained to the superior categories aspect via the SubCategoryOf property. The subcategories each have to contain a property designated as row identifier and specified with a default value. 538 3BDS011222R4101 Section 3 Configuration Extended Configuration Data When you instantiate a structured Parameter Manager aspect category the properties of the most superior category are shown in the instance, the properties of the subcategories have to be added instance specific by executing the New “sub category” context menu item on the Categories item of the superior category. If you need a fixed substructure in every case you can implement this by providing the corresponding Parameter Manager aspect in an object type or by providing a corresponding template Parameter Manager aspect in the Library Structure. See IndustrialIT 800xA - Engineering, Engineering Workplace, Basic Engineering Functions for details on configuration of Parameter Management. Softpoint Configuration Workflow Configuration of softpoints is done via the Plant Explorer. Softpoint objects are instantiated from softpoint object types configured in Object Type Structure. This requires you to create process object types as children of the Softpoint object type in Object Type Structure. These object types serve as models by which to instantiate actual process objects under a Softpoint Generic Control Network object in Control Structure. The softpoint object types specify the signal properties for the softpoint objects. This includes signal ranges for real and integer signals, alarm limits, event triggers, and whether or not the signals will be controllable. The process objects inherit the properties of the object types from which they are instantiated. Pre-configuration Set-up Some pre-configuration set-up is required to connect Softpoint Servers with their respective connectivity Servers, and with History Services. • 3BDS011222R4101 For each node where Softpoint Services is installed, you must create a virtual control network by which other system applications (History, desktop applications and so on) can access the softpoint data on that node. You must also configure a Source Definition aspect for each network. This is required to deploy the softpoints on their respective nodes. These procedures are described in the section on configuring softpoints in Information Management Configuration. 539 Extended Configuration Data Section 3 Configuration • A History Source object must be created under the Softpoints category in Control Structure. This is required to support historical data collection for softpoint values. Instructions for creating this object are provided in the section on History Set-up in IndustrialIT 800xA - Information Management, Configuration. • Make sure Softpoint service providers are created and enabled for all nodes where Softpoint Services must run. Softpoint Configuration The procedure for configuring softpoints involves the following basic steps: • Adding and configuring a new softpoint object type. • Adding signal types and configuring signal properties, including alarms and events for the signal types. • Instantiating softpoint objects in Control Structure from their respective softpoint object types. • Adjusting properties of the instantiated softpoint objects if necessary. • Defining alarm text groups. • Deploying the finished softpoint configuration. Whenever you create new softpoint objects, or make changes to existing softpoint objects, the new configuration will not go into effect until the changes are deployed. While softpoint configurations are being deployed, softpoint processing is suspended, current values and new inputs are held. This process is generally completed within five minutes, even for large configurations. These steps are described in detail in the section on configuring softpoints in IndustrialIT 800xA - Information Management, Configuration. Importing and Exporting Softpoint Configuration Data To make a complete import or export of a softpoint application, including both the softpoint data and the softpoint configuration, use the 800xA system Import/Export utility as described in IndustrialIT 800xA - Operations, Operator Workplace, Configuration. 540 3BDS011222R4101 Section 3 Configuration Document Management The Import and Export tabs on the Generic Control Network Configuration aspect provide an alternative method for importing/exporting a softpoint configuration. This exports softpoint objects and aspects only. The export file is created in XML format. You can import this file on another machine. The data will be added to the softpoint configuration database. This method is recommended to be used only as a supplemental backup to the backup created with the 800xA system Import/Export utility. Calculations Configuration The steps to configure calculations are described in the section on Configuring Calculations in IndustrialIT 800xA - Information Management, Configuration. Document Management Document Management functionality can be used for many purposes. It allows to make informations in documents available at aspect objects in structures where you need them. For example you can include a dynamic document into an object type of the ProcessObjExtLib delivered with of AC 800M connectivity to make it possible to get a snapshot status of the object for maintenance or operation documentation purposes. Assumption is that the Library is closed or released. The principal steps to include a dynamic document for into a Process Object object type are as follows: 1. Select the object type in the Object Type Structure. 2. Create a Document aspect, by default the Document aspect will be inherited to the instances. 3. Via the aspect context menu item Edit set the corresponding template, for example a blank Word document. 4. Then edit the document content: Texts, graphical parts and dynamic parts. For the dynamic parts you insert the corresponding property references via Document Manager>Insert Property Reference(s) or the corresponding context menu item. You can select properties of the other aspects of the object or of objects relative to your object. The properties can also be OPC properties of control aspects. Note that the Insert Property Reference(s) dialog can only 3BDS011222R4101 541 Document Management Section 3 Configuration support you if the Structures, Objects and object properties you want to reference are existing. Otherwise you may have to evaluate the needed Reference String by building a prototype in another structure. 5. Check in the document using aspect context menu item Checkin. 6. Create an Object Type Extension Definition if you want to change the default instantiation behaviour of your Document aspect, for example to Copy to all instances. This is required if the document content shall be saved per instance. 7. When instantiating the object type the object instance now gets the additional Document aspect. 8. When you open the document it gets updated with the instance specific values retrieved by the property references. In a Graphic Display of Operator Workplace you can view the document from the object context menu of the Graphic Element for the object the document is contained in. The steps before assumed that a fitting template was already available. To create an own template you have to perform the following steps: 1. Select the Library Structure / Document Manager Templates / Document File Templates / Documents 2. Select one of the existing document template aspects, copy and rename it or create a completely new one. 3. Edit the document as needed and check it in: The new template is ready. 4. When you now create a Document aspect in an object in the Object Type Structure or in another structure and you set the file for the Document aspect the new template is additionally offered for use. You also can define own Document aspect categories with a set of document properties adapted to your specific needs: 542 1. In the Aspect System Structure select the Document Manager Documents aspect type object. 2. Execute the New Object context menu item and create an Aspect Category object with a name at your choice. 3BDS011222R4101 Section 3 Configuration Document Management 3. In the aspect pane of this Aspect Category object add, delete or modify the properties using the context menu on the Categories item or on the CategoriesProp items. 4. When you create instances of your Document aspect category you get an document administration database optimized for your need. If you want to include an engineering project document into Documentation Structure already substructured as for example given by the documentation object types of the Basic Object Type library you perform the following steps: 1. You create a document object below the corresponding folder object and a Document aspect within this object. 2. Excute Set File on the aspect and select the dialogs tab named From File/Folder 3. Press one of the buttons Copy File, Move File or Reference File depending on how you want to include the file into the Document aspect. 4. Navigate to the stored file and press the Open button of the file selection dialog. 5. Now the Document aspect of your documentation object holds the file you selected either as a copied file or as a moved file or as a referenced file. If you have many of those files to include into documentation objects as copies you can import them using a Bulk Data Management worksheet. The steps are: 1. On for example the folder object open context menu item Advanced > Bulk Data Manager 2. Drop into the Excel worksheet Documentation Structure aspect and a Document aspect, from the set of properties of the Document aspect select ExternalFilePath 3. Drop in the folder object 4. In the Object Identification column add the document object name with a counting number at the end 5. In the Document.AspectName column edit the aspect name with counting number and the end 3BDS011222R4101 543 Information Access Aspects Section 3 Configuration 6. In the ExternalFilePath column enter the file path including document file name 7. Copy the column as often as needed and do final editing of the names. 8. Then save the objects with Save All Objects button of Bulk Data Manager tool bar. This creates the documentation objects as required including the Document aspects with the file copies. To re-import the same set or extended set of documents: 1. You first use Open Properties of Document Manager, press the Show All button and delete the imported aspects via multiple select on the AspectName column and using Document Manager > Delete Aspect. 2. Then you save the objects again from the Bulk Data Management worksheet you have configured and extended with the Save All Objects button of Bulk Data Manager tool bar. In a similar way as you have added engineering project documents to your system you can add operation / maintenance documents to existing object instances in your system. Instead of creating the objects for the first time from the worksheet you drop in the existing object subtree and add document aspect entries where needed. If you want also to access the operation / maintenance documents via Documentation Structure you can place the corresponding objects from Functional Structure, Control Structure or Location Structure additionally in the Documentation Structure, e.g. by configuring and using a corresponding Bulk Data Management worksheet. For more details on Document Management see IndustrialIT 800xA - Engineering, Engineering Workplace, Basic Engineering Functions. Information Access Aspects You can use the five Information Access aspects to integrate information handled by standard PC applications without any programming. • The File Viewer aspect The File Viewer aspect can be used to integrate non-dynamic documents into the 800xA system. It is possible to have Work and Public documents for the same aspect. 544 3BDS011222R4101 Section 3 Configuration Information Access Aspects Only the Public document can be accessed by users of the operator category. The Work document can be the source document of the Public document, or a work in progress. Work and Public documents can be stored in different formats. For example, the Work document can be a Microsoft Word document, and the Public document an Adobe Acrobat pdf-document. See the How to use the File Viewer on page 545. • The Bookmark aspect In How to use the Bookmark Aspect on page 561, you can read about the Bookmark aspect, which makes it possible to enter a document at a specific page. • The Web Page aspect The Web Page aspect can be used to associate a web page or html document to an object. See How to use the Web Page Aspect on page 564. • The ActiveX Wrapper aspect The Active X Wrapper aspect provides a container to allow an ActiveX Control to be used within the workplace environment. When you have configured the ActiveX Control, you simply select that aspect to display it. Read How to use the ActiveX Wrapper Aspect on page 566. • The Windows Application aspect This aspect makes it possible to launch any executable application installed on your Windows system. There are a number of useful Windows applications, like Office applications and administrative tools, that may be useful to access as aspects. For example you might want to store an Excel report locally on your computer. See How to use the Windows Application Aspect on page 569 How to use the File Viewer The File Viewer aspect provides full client/server support allowing aspects/documents added to any node in the current configuration to be available on all other nodes. The File Viewer also has the ability to create and use templates. This makes it possible to standardize the look on new documents attached to File Viewer aspects. 3BDS011222R4101 545 Information Access Aspects Section 3 Configuration All documents are fully associated with the aspect. This means that a copy and paste operation creates a new set of documents. It also means that when performing an Export or a Backup the documents will be contained inside the export files. This is not the case when using for example the Web Page aspect (see How to use the Web Page Aspect on page 564). To add a File Viewer aspect to an aspect object, do as follows: 1. Select an object in Plant Explorer. 2. Select New Aspect from the object’s context menu and add a File Viewer aspect, see Figure 254. Figure 254. File Viewer Aspect The first time you open a File Viewer aspect it will be empty. The main view displays a default page. 546 3BDS011222R4101 Section 3 Configuration Information Access Aspects The File Viewer aspect has two views, the main view and the configuration view. All formats that can be viewed inside Internet Explorer are applicable for viewing in the main view. See Figure 255. Figure 255. The Main View 3BDS011222R4101 547 Information Access Aspects Section 3 Configuration The configuration view includes two areas, one for a Public document and one for a Work document, see Figure 256 below. Pdf document to display in the Main View The source file used to generate the pdf-file Figure 256. The Configuration View 548 3BDS011222R4101 Section 3 Configuration Information Access Aspects Some status information is displayed in the Work Document area. An example is shown in Figure 257. Figure 257. Status Information • Locked by - displays the name of the user who performed an Edit or a Check Out. This information is only displayed if the document has been checked out by someone other then the current user. • Directory - displays the name of the directory in which the file is saved. This information is shown only if the current node is the node that the document was checked out from. • Filename - displays the file name of the document. This information is shown only if the current node is the node that the document was checked out from. • Attached by - displays the name of the user who performed the last update to the document. A document is updated during an Attach or a Check In. The Attached by information is always available. 3BDS011222R4101 549 Information Access Aspects • Section 3 Configuration Node - displays the name of the node from which the document was checked out. This information is shown only if the current node is different from the node that the document was checked out from. Only Adobe Acrobat pdf-documents have been tested and verified to work with in the File Viewer aspect main view. However, the File Viewer is based on Microsoft Internet Explorer technology and supports all document formats that can be displayed inside Internet Explorer. Make sure I E is properly configured. After having attached a Public document and switching to the main view, the associated application may launch in its own window instead of being embedded in the main window. If this is the case, then a file type configuration change is needed. To prohibit applications from launching in their own window, change the following setting in the Control Panel: 550 • Select Folder Options to bring up the Folder Options dialog. • Select the File Types tab and then select the extensions of the application that needs configuration. Click the Advanced button. • In the next dialog (Edit File Type dialog). Check the Browse in same window box and click OK. 3BDS011222R4101 Section 3 Configuration Information Access Aspects See the figure below. Figure 258. Folder Options 3BDS011222R4101 551 Information Access Aspects Section 3 Configuration File Viewer Functions The File Viewer functions available in the configuration view are described below, see Figure 259. Figure 259. File Viewer Functions Attach Use the Attach button to associate a document file with a File Viewer aspect. Attach can be performed on both Public and Work files. To attach a file: 1. Select the File Viewer aspect and the configuration view. 2. Click the Attach button in the Public Document or the Work Document area. A file dialog opens. 3. Select file and click Open in the dialog. You can access both Public and Work files from any node on the network. 552 3BDS011222R4101 Section 3 Configuration Information Access Aspects Automatic Detection of pdf-documents When you use the Attach and Check In operations on Work Documents, the file viewer aspect searches the same directory for pdf-files. If a pdf-file with the same name as the Work documents is detected, the file viewer will automatically propose to attach the pdf-file as the Public document. See Figure 260 below. Figure 260. Proposed pdf-file Edit To maintain and update Work files, you use the Edit button. The Edit operation automatically retrieves the Work file from the 800xA system, performs a check out and tags the file as locked in the configuration view. The Work file is placed on local disk, (under My Documents\File Viewer). An application suitable for editing the document is automatically launched. Follow the instructions below to edit a work file: 1. 3BDS011222R4101 Select aspect and the configuration view. 553 Information Access Aspects Section 3 Configuration 2. Select the Edit button in the Work Document area. This will, if available on the client, launch the associated application needed to edit the Work file. 3. Edit the Work file, save and close the application. 4. Use the Check In button to make the file available for other users. Check Out Check Out works similar to Edit, but a Check Out will not launch the associated application. To check out a Work file, follow the steps below: 1. Select aspect and the configuration view. 2. Click the Check Out button in the Work Document area. Client Version Handling When you use check out (or edit) a Work Document from an aspect of the File Viewer Aspect Category, the checked out file’s name will be modified in order to uniquely identify the file. For example, Work Document 3BSE004510.doc will become 3BSE004510_01.doc on disk when it is checked out, and Work Document 3BSE004510_04.doc is 3BSE004510_05.doc on disk. For all other categories of the File Viewer Aspect Type, the name is changed during Edit or Check Out according to the following rule: <object name>_<aspect name>_<client version>.<suffix> An example: A Technical Reference Manual aspect is created on an object with the name A1. The Technical Reference Manual aspect is of the File Viewer Aspect Type but not of the File Viewer Aspect Category. During Check Out or Edit the Work Document Technical Reference Manual.doc is A1_Technical Reference Manual_01.doc on disk, see Figure 261. 554 3BDS011222R4101 Section 3 Configuration Information Access Aspects Figure 261. Client Version Handling Check In If you check out or edit a Work file, you have to check it in before it is updated in the system. To check in a Work file: 1. Select aspect and the configuration view. 2. Click Check In in the Work Document area. The Edit and Check In operations are also available as aspect verbs. 3BDS011222R4101 555 Information Access Aspects Section 3 Configuration Undo Lock/Force Unlock If you have checked out a Work file, the Undo Lock button will be visible. Unsaved changes will be lost when using Undo Lock When the document is already checked out by another user, you are prompted to use the Force Unlock function (provided that you have write permission on that aspect), to unlock the Work document. This functionality is provided to prevent documents from being inaccessible when another user has checked them out. Force Unlock should be used carefully, since in most cases, a locked document indicates that someone is in the process of editing the document. Manual File Selection If you check the Manual File Selection box, you are able to select file name and directory during Edit, Check Out and Check In. For example, if you want to make a quick spelling correction, it does not matter where the system saves the file during check out. Whereas if you are going to make considerable changes to a Work file that will take a few days, you might want to save the file to a specific location. Save Copy Save Copy enables you to save a copy of an attached document contained in a File Viewer aspect. Save Copy can be used on both Public and Work documents and the operation never involves Check Out. To save a copy of a file: 556 1. Select aspect and bring up configuration view. 2. Select appropriate Save Copy button (Public area or Work area). This will open a save file dialog. 3. Select directory and file name and click Save in the file dialog to save the file to disk. 3BDS011222R4101 Section 3 Configuration Information Access Aspects Clear Clear enables you to remove an associated document from an aspect. Clear can be used on both Public and Work documents. This operation is not to be confused with the Delete aspect operation, that is available through the aspect context menu. To Clear a file: 1. Select aspect and bring up the configuration view. 2. Click the Clear button (in appropriate section). Template Support The File Viewer aspect supports template functionality. Templates are a quick and easy way to start creating documents. Any of the supplied File Viewer aspect categories (except the generic File Viewer aspect category) can be used to create a new document. All documents needed are delivered with the Operator Workplace. In addition, there are blank templates that can be used to create a new document. Usually the proposed name should be used, so that you know where to find documentation. The name of the Operating Manual should be Operating Manual and not Manual or Operators Instructions etc. The Predefined File Viewer aspects can be used for creating new documents or for associating existing documents. Then you generate the already associated documents and add your own, or use the existing ones. 3BDS011222R4101 557 Information Access Aspects Section 3 Configuration Follow the steps below to use any of the predefined templates: 1. Add a File Viewer aspect to a selected object. Figure 262. Existing Templates To create your own template, follow the steps below: 558 1. Go to the Aspect System Structure and select the File Viewer Aspect Type object. 2. Select New Object in the context menu and create a new Aspect Category. This object (Category) will represent the template. 3. Give it a suitable name and click OK. 3BDS011222R4101 Section 3 Configuration 4. Information Access Aspects Select the Technical Reference Manual object, see Figure 263. Figure 263. Technical Reference Manual, Aspect Category Object 5. Add a Technical Reference Manual aspect to the object. 6. Select Properties in the aspect’s context menu and then the Aspect Details tab. 7. Add a Template Aspect key and click OK, see Figure 264. 3BDS011222R4101 559 Information Access Aspects Section 3 Configuration Figure 264. The Aspect Details Tab 8. Select the configuration view and attach an empty template, in this case Technical Reference Manual, as Work Document, see the figure below: Figure 265. Attached Template 560 3BDS011222R4101 Section 3 Configuration Information Access Aspects Now you are able to create a Technical Reference Manual aspect on your objects. This aspect contains an empty Technical Reference Manual which can be modified to suit your needs. If you create your own category, user role and permission need to be set manually. How to use the Bookmark Aspect The Bookmark aspects are placed as bookmarks in a File Viewer aspect. This makes it possible to enter a document at a specific page You can use predefined Bookmark aspects, or create your own one. The Bookmark aspect is only supported in files formatted in pdf. To create a Bookmark aspect of a predefined Category, do as follows: 1. Create a new aspect of a suitable Bookmark Category, for example Technical Reference Manual, see the figure below: Figure 266. New Aspect Dialog 3BDS011222R4101 561 Information Access Aspects Section 3 Configuration The proposed name for a Bookmark aspect is the same as the proposed name for a standalone File Viewer aspect. For example the Technical Reference Manual Bookmark aspect gets the name Technical Reference Manual. This matches the File Viewer aspect of the same name. This functionality allows the user to easily find an aspect with a recognizable name. This is one of the main features of the File Viewer and Bookmark aspects. 2. To configure the Bookmark aspect, bring up the config view and use the Browse button. 3. Select the File Viewer aspect that contains the wanted document of the File Viewer aspect type, see Figure 267. 4. Enter the page number in the Document Page field. Figure 267. Technical Reference Manual - Chapter 5. 562 Select the main view to see the selected page of the pdf-document. 3BDS011222R4101 Section 3 Configuration Information Access Aspects To use the generic Bookmark aspect: 1. Create a new aspect of the general Bookmark Category. 2. Give it a proper name that identifies the page in the document, you want to enter, see Figure 268 and Figure 269. Figure 268. General Bookmark - Important Page 3. Bring up the config view and enter the number of the wanted page, Figure 269. An Important Page in a Technical Reference Manual 3BDS011222R4101 563 Information Access Aspects 4. Section 3 Configuration Select the main view to see the selected page of the pdf-document. How to use the Web Page Aspect To create a Web Page aspect, do as follows: 564 1. Add a Web Page aspect to the object concerned. 2. Open the config view of the Web Page aspect. See Figure 270. 3BDS011222R4101 Section 3 Configuration Information Access Aspects Address field Figure 270. The Web Page Aspect in the Config View 3. Enter the web address in the Address field. 4. Click Show or press Enter to open the web page. 5. Click Apply. It is also possible to browse another web page in the window and copy the new address to the Address field, by using the Copy Address button. Click Apply to save it. Use the Open file button to browse and open a file in the file system. 6. In the upper part of the window the Tool bars check boxes are shown. Select these if you want the Application Bar and the Navigation Bar be shown in the Main View. If you select Explore in the Web Page aspect context menu, your default web browser opens with the web page connected to the Web Page aspect. 3BDS011222R4101 565 Information Access Aspects Section 3 Configuration How to use the ActiveX Wrapper Aspect The ActiveX Wrapper aspect provides a container to allow ActiveX Control to be used with the workplace environment. This functionality allows ActiveX Components from various suppliers to be used. For example ActiveX Controls that are available as part of Windows, such as the Calendar can be used. When you have configured the ActiveX Control, you simply select that aspect to execute it. To create an ActiveX Wrapper aspect: 1. Add an ActiveX Wrapper aspect to the object concerned. 2. Open the config view of the aspect. 3. Enter in the ProgID to the ActiveX Control in the input field, or use the Browser, as in Figure 271 (the dialog box opens). Figure 271. Browse for Components Dialog 4. 566 Click on the OK button in the dialog (browser) window. 3BDS011222R4101 Section 3 Configuration 5. Information Access Aspects Click the Refresh button in the ActiveX Wrapper dialog, see Figure 272, to verify that you have selected the proper ActiveX Wrapper. Figure 272. The ActiveX Wrapper Aspect Dialog Box 6. A preview of the chart in the dialog box that pops up, see Figure 273. Figure 273. ActiveX Wrapper Aspect Dialog Box Showing a Preview of the Chart 7. 3BDS011222R4101 Click Apply to save your configuration. 567 Information Access Aspects 8. Section 3 Configuration Properties dialog can be opened if available for an ActiveX, by clicking the Properties button, see Figure 274. Figure 274. The Properties Dialog Box (showing MSChar20Lib.MSChart.2) You can now set the parameters for the Chart according to your preferences. 9. Click Apply, then OK to activate your parameter changes. You can use your own ActiveX in the Active Wrapper. The ActiveX can include controls like buttons and text controls. If you want to be able to move focus from one button to another with the keyboard, the ActiveX must have the control parent window style. Read about control parent in MSDN help, Extended Windows Styles. 568 3BDS011222R4101 Section 3 Configuration Information Access Aspects How to use the Windows Application Aspect In a multi client system, make sure to link to the executable application as well as to the argument files in such a way that they can be found from all of the current Workplaces. When wrapping documents, use the File Viewer aspect because it automatically provides client/server support. See How to use the File Viewer. To create a Windows Application aspect: 1. Add a Windows Application aspect to the aspect object concerned. 2. Open the Windows Application aspect and its config view. See Figure 275. Program Path Argument Figure 275. The Windows Application Aspect Dialog Box 3BDS011222R4101 569 Help Aspect Section 3 Configuration 3. Enter the path to the program to be used, or browse to the destination. Figure 276. The Windows Open Dialog 4. If the application takes arguments, enter these in the Program Arguments field (see Figure 275). 5. Click Apply to save the configuration. The default action for a non configured Windows Application aspect is to show the config view. For a configured Windows Application aspect the default action is Open. Help Aspect How to use the Help Aspect To use the Help aspect: 1. 570 Select an object type and add an Object Type Help aspect or an select an Object Instance and add an Instance Help aspect. 3BDS011222R4101 Section 3 Configuration 2. Help Aspect Select the aspect and the configuration view, see the figure below: Figure 277. The Instance Help Aspect 3. Use the Browse button in the File area to find the help file to be referenced. If no file is chosen, the default help file will be used. 4. Enter the index for the section in the help file you want to reference, in the Map area. The index can be an integer, string or a binary number, depending on the type of help-tags that are included in the document. 5. Click Apply to save the settings. 6. To view the help file, right-click on the object or the Help aspect and select Help from the context menu, see Figure 278 and Figure 279. The help file has to be an chm-file. 3BDS011222R4101 571 Help Aspect Section 3 Configuration Figure 278. Aspect Context Menu - Help Aspect Figure 279. Object Context Menu - Help Aspect 7. 572 Now view the help for the selected section. 3BDS011222R4101 Section 3 Configuration Version and Access Management Version and Access Management Authorization For configuration of Security and Authorization for an 800xA system see IndustrialIT 800xA - System, Administration and Security. Access Control Activation of Advanced Access Control features Re- and Double Authentication requires setting the corresponding overall system setting value in the System Settings aspect of your System object in Admin Structure to True. Further for an aspect category you have to configure if Authentication is required. You do this by checking corresponding check buttons in the Aspect Category Definition in the Aspect Category object in the Aspect System Structure. You can choose to require Re- Authentication or Double Authentication. For use of re-authentication in the context of System Synchronization see ReAuthenticate on page 593. For further details see IndustrialIT 800xA - System, Administration and Security. Log Over Activation of Log Over requires setting the corresponding log over settings in the Log Over Settings aspect of your System object in Admin Structure: To enable Log Over you: 1. Check the Enable Logover check box. 2. Click Apply. If you additionally want to configure an Inactivity User, you: 1. Enable multiple log over by checking the Multiple Logover check box. 2. Select which user should be the inactivity user in the Inactivity User drop-down menu. 3. Set the password for the inactivity user in the Password field. 3BDS011222R4101 573 Electronic Signature Section 3 Configuration 4. Set the time-out for automatic revert to inactivity user in the Revert to Inactivity User drop-down menu. 5. Click Apply. For further details see IndustrialIT 800xA - System, Administration and Security. Electronic Signature Before you can activate the first and second signatures you have to set the Signature Required property of the System Settings aspects of your System object in the Admin Structure to the value True. Further configure the First Signature required / Second Signature required on the Aspect Category Definition aspect of the Aspect Category object in the Aspect System Structure. You can choose to require First Signature or (First and) Second Signature. This is also the place where to configure the required permission for signing via the Permissions tab. For use of signatures in the context of System Synchronization see Digital Signature on page 596. For further details see IndustrialIT 800xA - System, Administration and Security. Versioning and Life Cycle Management System Configuration Version A System Configuration Version is defined by an System Configuration Version Definition object /aspect in the Maintenance Structure beneath the System Configuration Version Definitions root object. A version identity and a label can be set in the Summary tab on the Backup Definition aspect of the System Configuration Version Definition object. Backup / Creation of the System Configuration Version can be started from this tab. A System Configuration Version is stored in a corresponding object beneath the System Configuration Versions root object. For more details System Configuration Version and Backup / Restore see IndustrialIT 800xA - System, Administration and Security. 574 3BDS011222R4101 Section 3 Configuration Versioning and Life Cycle Management System Synchronization Setup Synchronization between an engineering system and a production system is a powerful mechanism to support distributed engineering(as described in Distributed Engineering on page 142 ) and versioning of configuration. The correct steps to synchronize changes between the engineering and production system are described below. These sequences for the various use cases need to be followed to ensure that the changes are deployed in the production system in a consistent order. Installed Products Both the engineering system and the production system must have the same products and product versions installed and the same system extensions must be added to both systems. In addition to the system extensions, it is required that the basic runtime software for these system extension is also present as part of the engineering system User Security Set Up To be able to perform the tasks described in this document concerning the synchronization packages the user needs to have the Application Engineer role and belong to the Industrial IT Application Engineer group. To be able to perform the tasks described in this document concerning the loading and the roll back of synchronization packages the user needs to have the System Engineer role and belong to the Industrial IT System Engineer group. The user also needs the Modify permission to create synchronization packages as well as to load synchronization packages To expand this further there are two permissions implemented i.e. Create synchronization package and Load synchronization package. These can be used in a security definition aspect to set a lower granularity of security on System Synchronization. The synchronization procedure requires that the machine in the engineering system used to create the synchronization package is connected to both the engineering system and the production system. This implies the possibility that the user 3BDS011222R4101 575 Versioning and Life Cycle Management Section 3 Configuration inadvertently opens the plant explorer, or work place for the non-default system (i.e. in the engineering system calls up the plant explorer for the production system). This must not be done since the user can by mistake make changes, to the production system, which were intended for the engineering system, and corrupt the configuration data. In the case of batch management, unintentional changes to the production system, using a client in the engineering system, can lead to corrupt batch configuration data in the production system Unintended changes to the production system from the engineering system, and the reverse, can be prevented by properly set the security rights for the users in the production system and the engineering system using node specific permissions for a user. Configure the access for the users in the following way: 1. Within the production system: – 2. Limit the user access to read only for the machines belonging to the engineering system. Within the engineering system: – Limit the user access to read only for the machines belonging to the production system. If a defined user utilizing this approach inadvertently opens the non-default 800xA system they can look at the data of the other system but will be prevented from changing any data. Any user not defined in this manner can accidentally corrupt data. 576 3BDS011222R4101 Section 3 Configuration Versioning and Life Cycle Management Figure 280. System Synchronization and User Configuration Setup of Service Groups Before you start synchronizing any control application content, you need to make sure that the service groups in Service Structure used in the production system is represented in the engineering system. It is recommended that this is accomplished via export/import of the service groups. Alternatively the service groups can be duplicated manually. In this case you have to make sure that you use the exact same name for the respective service groups. The system will automatically resolve the name to the object identifier to establish the appropriate references. The Service groups in the engineering system can have their own Service provider (for example: OPC Data Source) connected to controllers for the purpose of Simulation and checking the applications. The Service Group in the Connectivity Tab shall be the same in both the engineering system and the production system. 3BDS011222R4101 577 Versioning and Life Cycle Management Section 3 Configuration Node Administration Structure In order to accurately associate IM logs to the respective IM nodes Node Administration Structure in the engineering system needs to contain the node object for both the production system and engineering system so that the logs associated to objects in the other structures (i.e., Control Structure) can be correctly established in the production system. This can be achieved by using Export/ Import to make the same node object for the IM node in the production system available also in the engineering system. In the engineering system the IM node object shall have no active services. The Log Definition tab of the Log Templates in the engineering system should point to the service group representing the IM services in the of production system, IM.The IM Definition tab of the Log Template in the engineering system should point to the same Log Set as in the production system. General Workflow This subsection gives you an overview on the general workflow for System Synchronization. It references details in the subsection System Synchronization Functions on page 581. An introduction to this workflow has already been given in Overall Project Workflow, subsection On-site Engineering Workflow on page 326, Figure 102 and Table 13. It could be a good idea to synchronize in the opposite direction (from Production System to Engineering System) before the engineering starts. After this is done the engineering can be started. During this engineering phase the engineering system does not have to be connected to the production system. When changes are ready in the engineering system the systems must be connected again before the synchronization starts. Although the physical controllers are different in the engineering system and the production system, the engineering system will have the production controllers represented as aspect objects. We will use the terms testing controllers and production controllers to distinguish between the two kinds of controllers The workflow can be divided in two phases: 1. 578 Creating a Synchronization Package 3BDS011222R4101 Section 3 Configuration 2. Versioning and Life Cycle Management Applying a Synchronization Package To make handling of System Synchronization more secure you can use Audit Trail (see Audit Trail on page 599), Re-Authentication and Double Re-Authentication (see Re-Authenticate on page 593) and Digital Signature (see Digital Signature on page 596) with it. Creating a Synchronization Package The prerequisite for this phase is that your Production System and Engineering System are as similar as possible. They must have the same version of System 800xA. Furthermore they must have the same system extensions of the same versions installed and loaded. 1. Engineering System: Do your engineering, for example according to Overall Project Workflow. 2. Production System: Add the engineering node as a client to the production system. 3. Engineering System: 4. 5. 3BDS011222R4101 a. Go to Maintenance Structure in Plant Explorer. b. Select Synchronization Definitions object and create a new Synchronization Definition object. See Definitions on page 581. c. Now select the System Synchronization Definition aspect and go to the Synchronization Scope tab. See Scope on page 582. d. Here you now select what you want to synchronize over to the production system. Try to make the selection as narrow as possible.See Scope on page 582. Engineering System: a. Switch to the Synchronization Differences tab. See Differences on page 585. b. Select the production system as Destination System (this is the reason for step 2 above). Engineering System: 579 Versioning and Life Cycle Management Section 3 Configuration a. Press Find Differences. b. Examine the output carefully. c. If it looks good you can press Create Package and a synchronization package is created. See Synchronization Package on page 588. The synchronization package is visible under Synchronization Packages in Maintenance Structure. You now have a synchronization package. Applying a Synchronization Package The newly created synchronization package will become available through file set distribution, FSD. Step 1 is required to make this to work. 1. Engineering System: Add the production node as a client to the engineering system. This is to make the synchronization package available to Production System. 2. Production System , see also Load Synchronization Package on page 590: a. Start Configuration Wizard b. Select System Administration. c. Then select Synchronize Systems. d. Select the engineering system as source system and the available synchronization packages will get visible. e. Select the synchronization package and click Next. Now the same difference report as when creating the package is presented. f. Click Next to get to the confirmation page. g. Click Finish to start the actual synchronization. The synchronization is now performed. Additional steps might be required as described in some Synchronizing Use Cases below. It is possible to create any number of synchronization packages from a synchronization definition. However when any of these packages is selected and used for synchronization the others are invalidated. This is to avoid a situation where synchronization packages are loaded in the wrong order. 580 3BDS011222R4101 Section 3 Configuration Versioning and Life Cycle Management System Synchronization Functions Definitions The Synchronization Definitions object is defined by an object type called Synchronization Definition Root. This object can hold objects of type Synchronization Definition. The definition object is defined by an object type called Synchronization Definition. See Figure 281 below. This definition object contains one System Synchronization Definition aspect. This aspect is where the definitions for a specific synchronization is configured and saved. Figure 281. Synchronization Definitions Objects The Synchronization Packages object is defined by an object type called Synchronization Package Root. This object can hold objects of type Synchronization Package. The package object is defined by an object type called Synchronization Package. See Figure 282 below.This package object contains one System Synchronization Information aspect. This aspect holds information about the differences found when scanning two systems for differences. It also contains data about the created synchronization package. The package object is created automatically from the System Synchronization Definition aspect. Figure 282. Synchronization Packages Objects The Synchronizations object is defined by an object type called Synchronization Root. This object can hold objects of type Synchronization. The synchronization 3BDS011222R4101 581 Versioning and Life Cycle Management Section 3 Configuration object is defined by an object type called Synchronization. See Figure 283 below. This synchronization object contains one System Synchronization Information aspect. This aspect holds information about the changes made when synchronizing two systems. The synchronization package object is created automatically when performing a System Synchronization. Figure 283. Synchronization Objects The nodes involved in running synchronization must be connected as a client to each other. Scope Synchronization involves several steps. The first one is to set a scope. Create a System Synchronization Definition object on the Synchronization Definitions object in the Maintenance Structure. During this procedure a System 582 3BDS011222R4101 Section 3 Configuration Versioning and Life Cycle Management Synchronization Definition aspect is created. On that aspect there are two tabs: Synchronization differences and Synchronization Scope. Figure 284. System Synchronization Aspect - Scope On the Synchronization scope tab, there is a list view containing the entries used for scanning the differences. The list is populated entry by entry using any of the three available add-buttons. When the list has been populated with the entry points that the user wants to scan the user must press the button Apply to save this list. It is also possible to remove an entry from the list by selecting it and press the button Remove, followed by Apply. In the column Entry you see the name of the chosen object. In the column Type you can see the type description of the chosen object. • Tree • Object 3BDS011222R4101 583 Versioning and Life Cycle Management Section 3 Configuration To add a tree node, press the button Add tree…. Another dialog pops up. In this dialog select one tree node that need to be synchronized and press the button OK. See Figure 285 below. Figure 285. Select Tree Node To add an object, press the button Add object…. The same dialog as in Add tree pops up with a new title. In this dialog select one object that need to be synchronized and press the button OK. See Figure 286 below. Figure 286. Select Object 584 3BDS011222R4101 Section 3 Configuration Versioning and Life Cycle Management After doing one or many of the operations described above the list could look something like this. See Figure 287 below. At this point the scope for the scanning is set, i.e. when Apply is pressed. Figure 287. Selected Objects for System Scan Differences To scan for differences use the Synchronization differences tab. See figure 9 below. To get a difference report generated in HTML format, press the button Find differences…. Print the report by pressing the Print button. Figure 288. System Synchronization Definition Aspect - Differences 3BDS011222R4101 585 Versioning and Life Cycle Management Section 3 Configuration Before the Find differences… button is pressed a synchronization scope and a destination system must be set. Press the Browse button to select the destination system. See Figure 288 above. When doing this a dialog will pop up. See Figure 289 below. In this dialog the user needs to select a destination system, i.e. the system that the difference scan will be run on. The description is used when a synchronization package is created and will be put into the description of that specific package object's Name aspect. Figure 289. Select Destination System When a system is selected, and provided that the user has chosen a system different from the source system, the report is generated. This report is generated from the system as XML and run through a XSLT schema to be transformed to HTML. The report is constructed with sections. First there is a header where the names of the chosen source- and destination systems, along with a timestamp are shown. There are also three counters shown in the header. They are: Conflicts, Invalid signatures and Emphasized aspects. Then you have three sections called Create, Modify and Delete. Beneath each and one of these sections you will find objects that the scan algorithm has detected as a difference between the source- and the destination system. If a row turns up as yellow then this aspect is emphasized as an important one, i.e. the aspect has implemented a specific interface and has emphasized this particular aspect to be highlighted. If any aspect in one of these 586 3BDS011222R4101 Section 3 Configuration Versioning and Life Cycle Management three categories, i.e. Create, Modify, Delete, has a detected conflict an X is placed in the column called Conflict. Each aspect in a synchronization scan, which has been altered in the destination system since the last synchronization, is by definition a conflict. How this works is described more in detail in Conflict Detection on page 597. Furthermore if any aspect has an invalid signature an X is placed in the column called Invalid Signature. The last sections, marked with the color red, are called Conflicts, Emphasized aspects and Invalid Signatures. These sections are a summary of all aspects with an X placed in any of the columns Conflict and/or Invalid Signature and of aspects highlighted with a yellow background. If there are rows in this section then this is a warning signal to the user. Each and one of these rows accumulate the respective counter in the header. If the counter equals zero, then the warning section is not generated into the report. When you have a difference report that matches your expectations then the next step is to actually create the package. When the report is generated, then the Create package… button is enabled. 3BDS011222R4101 587 Versioning and Life Cycle Management Section 3 Configuration Synchronization Package When the Create package… button is pressed a lot of events takes place. The first thing that will happen is that the Re-Authentication dialog will pop up (i.e. if Advanced Access Control is activated globally in the system). In this dialog the user needs to enter a User Id, a corresponding password, a reason and optionally a description. Re-Authentication is described a little bit more in section 2.5. If the user is validated then a name for the package is set. The name will be constructed as follows. First the name of the definition object will be used e.g. MySync. Then the name _Package_ will be appended. Finally a timestamp will be appended. Giving a name e.g. MySync_Package_2003-03-16 11:12:30. The next thing that will happen is that an Audit trail message is generated, with the package name and the word 'Started' in it (i.e. if Audit Trail is activated globally in the system). Next the package itself is generated and the synchronization package object is created. During this procedure a System Synchronization Information aspect is created. On that aspect there are two tabs: Synchronization differences and Synchronization scope. This aspect looks almost exactly as the definition aspect. See Figure 290 and Figure 291 below. Figure 290. System Synchronization Information Aspect - Scope 588 3BDS011222R4101 Section 3 Configuration Versioning and Life Cycle Management The difference in the Scope tab is that all buttons except Help are removed, since this is a read-only aspect. Also there is a text box with the name of the destination system used when creating this package. Figure 291. System Synchronization Information Aspect - Differences The difference in the Differences tab is that the two buttons in the middle are removed, since this also is a read-only aspect. Finally the package, containing a package.XML file, a package.AFW file and a package.HTML file, is signed with a digital signature (i.e. if Digital Signatures is activated globally in the system). Also an Audit trail message is generated, with the package name and the word Ended in it. 3BDS011222R4101 589 Versioning and Life Cycle Management Section 3 Configuration Load Synchronization Package The second phase in System Synchronization is to load a synchronization package into a destination system. This is done using the Configuration Wizard. In this tool select the entry System Administration. In the list of systems, select the destination system and press the button Next. In the following action list select the row called Synchronize System and press the button Next. See Figure 292 below. Figure 292. Select Synchronize System 590 3BDS011222R4101 Section 3 Configuration Versioning and Life Cycle Management In the next page the user needs to first select the source system from the list. At that point all unused packages from that system are loaded into the list view. From that list the user selects the package to synchronize and presses the button Next. To the left in the list there is a pencil icon for all packages that has been digitally signed and verified. And for those that have not, the pencil icon is removed. There is also a column in the list saying by whom the aspect has been signed. See Figure 293 below. Figure 293. Select Synchronization Package 3BDS011222R4101 591 Versioning and Life Cycle Management Section 3 Configuration In the next page the user can see the difference report from the chosen synchronization package. See Figure 294 below. If it looks alright then the user may press the Next button again. Figure 294. Difference Report for Synchronization Package 592 3BDS011222R4101 Section 3 Configuration Versioning and Life Cycle Management The first thing that happens is that the digital signature of the chosen package is verified once again. If the signature is verified as OK then the next page can look like Figure 295 below. This is simply a confirmation and the user may press the button Finish to start the actual synchronization process or Cancel to abort the operation. Figure 295. Apply Synchronization Package Re-Authenticate If Re-Authentication is required on creating synchronization packages and loading them it must be activated globally in the system. Otherwise System Synchronization will ignore it and no authentication is made. This is done via an aspect called System Settings. To find this aspect, go to the Admin Structure and locate the 3BDS011222R4101 593 Versioning and Life Cycle Management Section 3 Configuration domain object with the name of your system. It is a child object to Domains. In this example it is called Source System. See Figure 296below. Figure 296. The Domain System Object Click on the object located as described above. In the aspect list you will find an aspect called System Settings, see Figure 297 below. Figure 297. The System Settings Aspect Click on this aspect and an aspect view will show up looking like Figure 298 below. Figure 298. The System Settings Aspect View 594 3BDS011222R4101 Section 3 Configuration Versioning and Life Cycle Management Set the value on the property Advanced Access Control to True and press the button Apply and authentication will be activated. The main function of the Authentication Dialog is to ask for a user's credential (i.e. the user's User Name and Password) via the User Interface and thereafter check the user name and password (i.e. authenticate the user). See Figure 299 below. Figure 299. Re-Authentication Dialog The user interface of the Re-Authentication Dialog contains edit boxes for the User's ID and Password, a write protected box for the User Name, a dropdown list of possible reasons, an edit box for a user comment and two push buttons, Ok and Cancel. To conceal the password in the Password edit box an * is displayed in place of each character that is typed. Reason is mandatory, i.e. a Reason must be selected before the OK button is activated. When moving the cursor over the Reason edit box an explanation of the reason is displayed in a ToolTip-message. Note that it is only possible to select a reason from the list; it is not possible to enter a new reason (the Reason box is write protected). The Comment box is used for the user's own comment. The Comment is optional, i.e. it can be left empty. 3BDS011222R4101 595 Versioning and Life Cycle Management Section 3 Configuration The OK button is deactivated (dimmed) until the User ID and Password are written and a Reason is selected from the dropdown list. When the User ID is written and the field loses focus the User Name field will be updated with the user's full name. If an illegal User ID is written the User Name field will be updated with the text Illegal User ID when the User ID field loses focus. When the OK button is pressed the User ID and Password are checked. If the User ID and the Password are accepted the dialog is terminated and the control is returned to the caller with a positive answer. If an illegal User ID and/or Password is/are written a pop-up error message is displayed and the user must acknowledge the message before a new attempt can be made. After three errors in a row the dialog will be terminated and the control is returned to the caller with an error code. Digital Signature The Digital Signature Server contains functionality such as: • Sign an aspect with usage of a calculated hash code and a private key • Verify the signature with help of a public key • User interface for signing of an aspect To be able to use this functionality properly, System Synchronization needs creation user, modifying user and signing users to be present in the destination system. This is why introduction of users in the system needs special considerations, which are: • All users that are introduced should be added in one system only, e.g. the Engineering System. • Users should be propagated from one system to other systems with the import/export tool. This ensures that the users are identical in both systems. In System Synchronization this service is used to programmatically sign the synchronization package. This produces a Signature aspect on the synchronization package object. But only if the global flag for Digital signatures is set to True. This is done by selecting the System Settings aspect in the Admin Structure. See 596 3BDS011222R4101 Section 3 Configuration Versioning and Life Cycle Management Figure 296 and Figure 297 above how to find this aspect. In the aspect view, set the property value for Signatures Required to True and digital signatures will be activated. See Figure 300 below. Figure 300. The System Settings Aspect View When a package is loaded into a destination system the signature service is used to verify the signature. Conflict Detection Conflict detection is done both at difference scanning before making a synchronization package, and before loading a synchronization package into the destination system. A conflict is present when an aspect is part of a synchronization scan and has been changed in the destination system since it was last synchronized. To perform this check, a list of aspect id's and dates are kept on the System Synchronization object in the destination system. If the change date for an aspect, found during a difference scan or a synchronization load in the destination system, is later then the synchronization date in the list, then this aspect will be listed with a conflict warning in the difference report. The user may choose to ignore conflict warnings and continue anyway making a synchronization package or loading a synchronization package. The latter operation will then overwrite current data. Categories Excluded by the System When setting synchronization scope on a synchronization definition there are some structures that are excluded by default. These structures can not be chosen nor seen in the structure selector i.e. when the button Add Tree ... is pressed. These structures are the following: 3BDS011222R4101 597 Versioning and Life Cycle Management Section 3 Configuration Admin Structure Maintenance Structure Obsolete Structure Service Structure User Structure But they may be involved anyway in the synchronization hence the dependency check gives that an object or aspect from one of these structures must be included in the synchronization package for dependency reasons. There are also aspect categories that are excluded even from the dependency check and therefore not included in any way in the synchronization process. These categories are the following: Affinity Definition Backup Definition Backup Info Domain Definition Node Definition Node Group Definition Permission Definition Security Definition Service Definition Service Group Definition Service Provider Definition System Synchronization Definition System Synchronization Information User Definition User Group Definition User Role Definition Configurable Category Exclusion There is a possibility to manually configure an aspect category to be excluded from System Synchronization. This is done on the Aspect Category Definition in the Aspect System Structure. To be able to do this the user must have the Software Developer role. 598 3BDS011222R4101 Section 3 Configuration Versioning and Life Cycle Management As an example if the System Synchronization Definition category should be excluded. You would have to select the System Synchronization Definition category object in the Aspect System Structure. Then select the Aspect Category Definition aspect in the aspect list. Finally in the aspect view, check the checkbox for Not synchronized and then press Apply. See Figure 301 below. Figure 301. Aspect Category Definition Aspect View Audit Trail During the synchronization process audit trails are generated both in the source system as well as in the destination system. This will only happen if the global flag for Audit trail is set. This is done by selecting the Audit Trail Config aspect in the Admin Structure. To find this aspect, go to the Admin Structure and locate the domain object with the name of your system. It is a child object to Domains. See Figure 296 above. Click on this object. In the aspect list you will find the Audit Trail Config aspect. Select this aspect by clicking on it. In the aspect view, see figure 26 below, first check the Audit Trail active checkbox and then check the checkbox for 3BDS011222R4101 599 Versioning and Life Cycle Management Section 3 Configuration AuditEvent_ConfigurationChange. Finally press Apply and the Audit Trail functionality for System Synchronization is activated. Figure 302. The Audit Trail Config Aspect View In the source system two messages are written when the synchronization package is created. The first one saying: Creating <package name> has Started and the second one saying: Creating <package name> has Ended. When loading a synchronization package into a system two messages are written. The first one saying: Synchronization of package <package name> has Started and the second one saying: Synchronization of package <package name> has Ended. Dependencies Aspect dependencies are dependencies that need to be fulfilled for an aspect to be able to function correctly. It means that the aspects dependent on need to be available with the aspect that specifies the dependencies. System Synchronization uses these types of dependencies to ensure that the necessary aspects are part of the scan process. A dependency is handled in a special way if the dependency refers to an aspect or object that belongs to the framework or to a system extension (which includes libraries). In this case the dependency is recognized as a dependency to the library or system extension and not to the individual aspect. 600 3BDS011222R4101 Section 3 Configuration Versioning and Life Cycle Management Important Objects Every aspect system and system extension that has objects with one or many aspects that needs to be emphasized in some way can implement this. Then this aspect will turn up with bold font and a yellow background in the difference report if the aspect is put there. Important objects are those that require further actions in the destination system after synchronization, e.g. download to Controllers or Field devices or objects that significantly impact system operation, e.g. Log templates. Consistency Consistency checks help the user to validate that his data are correct. A consistency check may be invoked directly by a user or indirectly by various system functions. Every aspect system or system extension that has data that need to be consistent can implement that System Synchronization can ask for / perform a consistency check. Aspects with External Data System Synchronization can only take care of external data, if the aspect system supports serialization of the data and modification time detection. The synchronization process always uses the most recent of external data modification time and aspect modification time. Synchronizing Use Cases The following subsections give additional instructions for typical use cases. Adding a new Control Project A newly created control project in the engineering system must be introduced into the production system in multiple synchronization steps. 1. Disconnect the Applications from the in Controllers before creating the synchronization packet in Engineering Source system 2. Synchronize the Control Project Object without children. 3. Synchronize the Applications Object without children. 3BDS011222R4101 601 Versioning and Life Cycle Management Section 3 Configuration 4. Synchronize the Controllers Object without children. 5. Synchronize the Applications belonging to the project one by one in separate synchronization steps while the applications are not assigned to a controller. 6. Assign application to target controller. Once all applications assigned to one controller are synchronized you can synchronize the controller associated to the project. Synchronize the controllers one after another in separate steps. Disconnect all applications belonging to a controller before creating the synchronization packet in the engineering system for controllers. Connect the applications in the production system after the Controller Object with its children is synchronized. If you have added process graphics in Functional Structure, make sure to synchronize the instances as well afterwards. Adding a New Controller to an Existing Control Project A newly created controller can be added to the engineering system. If you have new applications added to the project you need to first synchronize those applications one by one and then you synchronize the controller in a separate step. If you have reassigned applications from an existing controller to the new controller you synchronize the new controller. Please be aware that if you change the controller assignment of an application, the tasks assignments have to be modified as well. Changing Controller type is not allowed! Adding a New Application to an Existing Project and Controller A newly created control application in the engineering system must be introduced into the production system in two steps. 1. 602 Make sure that the control application is not connected to a controller and then synchronize only the control application into the production system. 3BDS011222R4101 Section 3 Configuration Versioning and Life Cycle Management 2. Connect the control application to a controller using the Control Builder, and then synchronize the controller. 3. Synchronize the controller in the production system, reconnect the already existing applications that were disconnected in step 2. Then download to the controller. Modifications to an Existing Application When you have made modifications or addition to the control logic inside of an existing application you synchronize them on the level of the modified application. Please make sure that any library or object type changes that is used in the modified application or object is at first synchronized separately to the production system, before you attempt to synchronize instances (application, or objects). Please make sure that you save the application before creating the synchronizing package, otherwise you might loose changes to the global variables. Removing an Existing Control Application When an existing control application is removed from the engineering system, remove the control application from the production system manually. If the difference report contains a control application, control project or user library that should be removed from the production system, you should go to the production system and remove them manually first and then create a new difference report with the modifications you want to synchronize. Removing an Existing Control Project When an existing control project is removed from the engineering system, remove the control project from the production system manually. If the difference report contains a control application, control project or user library that should be removed from the production system, you should go to the production system and remove them manually first and then create a new difference report with the modifications you want to synchronize. 3BDS011222R4101 603 Versioning and Life Cycle Management Section 3 Configuration Modification to a Library Released and closed libraries or library versions need to be installed on both the engineering system and the production system before any synchronization can be done that includes objects that use elements of those libraries or library versions. User libraries must at first be synchronized between the engineering system and the production system before any synchronization can be done that includes objects that use elements of those libraries or library version. When synchronizing modification to an already closed library, the library has to be opened in both Production System and the Engineering System. The library has to be closed after it has been synchronized into the production system. Remove an Existing User Library When an existing user library is removed from the engineering system, remove the user library from the production system manually. First make sure there are no instances referring to the library. If the difference report contains a control application, control project or user library that should be removed from the production system, you should go to the production system and remove them manually first and then create a new difference report with the modifications you want to synchronize. Batch Configuration When changes are done to the batch configuration synchronize the changes in the following steps: 604 1. First synchronize the changes to the Equipment Structure. 2. Synchronize the changes to Procedure Structure in a separate step after the Equipment Structure changes have been synchronized. 3. Other Batch aspects/objects (such as those in Control Structure, Functional Structure, etc.) will be exported with either Control or PPA. 3BDS011222R4101 Section 3 Configuration Versioning and Life Cycle Management Changes to the FF Configuration Make sure that new object types are synchronized first in a separate synchronization step before you start synchronizing HSE network configuration that use those object types. Check if the shared folder is created and the .pro-files are available in destination system before synchronize. The HSE Subnet has to be exported and imported in the destination system the first time. To synchronize changes to the FF configuration synchronize HSE networks one by one in separate synchronization packages. General workflow: 1. In the production System: Make sure that the traffic lights in the FF Upload aspect of the HSE Subnet object in Control Structure and in the FF Upload aspect of the FFLibraries object in Object Type Structure are showing a green status, indicating that the Fieldbus Configuration is fully uploaded to 800xA system. 2. Synchronize from Production System to Engineering System. 3. Use FBB FF to make the desired modifications to the application. 4. Upload the HSE subnet in Engineering System. 5. Create a synchronization package of the HSE Subnet and its Children objects (Complete tree) in Engineering System. Load the Package in Production System. 6. Proceed with Upload in both Object Type Structure and Control Structure in Production System 7. Load the devices in Production System, using FBB FF 3BDS011222R4101 605 Audit Trail Section 3 Configuration Audit Trail The Audit Trail function is controlled with the Audit Trail Configuration aspect that allows filtering of the audit event categories to suit the needed audit requirements in a system. The Audit Trail Configuration controls the audit settings for a whole system. Filtering cannot be set on object level. There is only one Audit Trail Configuration aspect in a system. It is placed in the Admin Structure under Administrative Objects\Domains\<node> system. The Security Configure user permission is required to alter audit trail settings. The available settings are shown in Figure 303 below. Figure 303. Audit Trail Configuration The Audit Trail active checkbox activates or deactivates the whole audit trail function. Log generic Audit Events controls if generic events from the Aspect Directory server shall be transferred to the message server and Log Detailed Audit 606 3BDS011222R4101 Section 3 Configuration Archive Events activates or deactivates the Audit Event class list where filtering of specific audit event classes can be specified. All changes in the Audit Trail Configuration settings are documented as high severity audit events, regardless if the Audit Trail function is activated or not. Re-authentication is required to apply changes in the Audit Trail configuration. You can add new Audit Event message classes to extend the predefined message classes, by creating a new message class object in the Library Structure. To get the Audit Event Configuration to detect that this is an Audit Event message class, the Audit Event Key must be added to the Class Definition aspect. For use of audit trail in the context of System Synchronization see Audit Trail on page 599. For further details see IndustrialIT 800xA - System, Administration and Security. Archive Archiving of data collected in audit trail logs is supported by Information Management History Services. For configuration instructions see IndustrialIT 800xA - Information Management, Configuration. System and Device Checks For configuration and use of system and device checks see the applicable configuration and operation manuals of the corresponding functional areas of System 800xA. 3BDS011222R4101 607 Asset Optimization Section 3 Configuration Asset Optimization Asset Monitoring Workflow for configuring Basic Asset Monitors: 1. Configure the Asset Monitoring Server a. Make sure that the Asset Monitor aspects to be downloaded are assigned to the target Asset Monitoring Server and that they are enabled. b. To Load the configured Asset Monitor Aspects to the AM Server click the Load All AMs button in the Asset Monitors tab of the Asset Optimization Server aspect: Figure 304. Load All AMs c. 608 To Load only selected Asset Monitor Aspects to the select them and click Load Selected Asset Monitors button in the "Asset Monitors" tab of the Asset Optimization Server aspect. 3BDS011222R4101 Section 3 Configuration d. Maximo Integration If Load operation fails click on Navigate to AssetMonitoring Service Provider in the Monitoring Service Tab and disabled the related AssetMonitoring Service. Wait a few seconds and try to download again. Then enable the AssetMonitoring Service. 2. Set Asset Monitor startup parameters using the Logic tab in the Config view of the Asset Monitor category in the Aspect System Structure. This configuration step applies to every instance of the Asset Monitor in the Primary Structure and can be used for the Running Time Check Asset Monitor. 3. Set up Process Portal B Provider (if desired, see OperateIT, Process Portal Version B2.0 manual). 4. Create User Groups and add Users if desired. 5. Add desired Asset Monitors to the object that represents the asset to be monitored. 6. Configure the Asset Monitors. For more details see IndustrialIT 800xA - Asset Optimization, Configuration. Maximo Integration Workflow for configuring Maximo Connectivity: 1. Set up Maximo Equipment ID in Aspect System Structure to provide CMMS identification information (provider properties). It provides information for mapping the Industrial IT object to the Maximo equipment in the CMMS database for a particular Maximo Server. 2. Set up Fault Report Submitter in Aspect System Structure to set default behavior of the Submit Fault Report view. Options are to delete the Fault Report from the Asset Optimization system and acknowledge the alarm in the Alarm and Event List upon successful submittal, or to not perform these actions. 3. Create User Group for Maximo users and add Users if desired. 4. Set up Maximo Credentials that contain the Maximo user credentials used to access the Maximo Server by the specific System 800xA user. 3BDS011222R4101 609 SAP/PM Integration Section 3 Configuration 5. Configure the Maximo Equipment ID on an object. This allows setting of the equipment ID to match that in the Maximo Server. 6. Add desired Asset Monitors to the object that represents the asset to be monitored. 7. Configure the CMMS views, which consists of adding the desired views to the desired objects. For more details see IndustrialIT 800xA - Asset Optimization, Configuration. SAP/PM Integration Workflow for configuring SAP/PM Connectivity: 1. Set up SAP/PM Equipment ID in Aspect System Structure to provide CMMS identification information (provider properties). It provides information for mapping the Industrial IT object to the SAP/PM equipment in the CMMS database for a particular SAP/PM Server. 2. Set up Fault Report Submitter in Aspect System Structure to set default behavior of the Submit Fault Report view. Options are to delete the Fault Report from the Asset Optimization system and acknowledge the alarm in the Alarm and Event List upon successful submittal, or to not perform these actions. 3. Create User Group for SAP/PM users and add Users if desired. 4. Set up SAP/PM Credentials that contain the Maximo user credentials used to access the SAP/PM Server by the specific System 800xA user. 5. Configure the SAP/PM Equipment ID on an object. This allows setting of the equipment ID to match that in the SAP/PM Server. 6. Add desired Asset Monitors to the object that represents the asset to be monitored. 7. Configure the CMMS views, which consists of adding the desired views to the desired objects. For more details see IndustrialIT 800xA - Asset Optimization, Configuration. 610 3BDS011222R4101 Section 3 Configuration DMS Calibration Integration DMS Calibration Integration Workflow for configuring DMS Calibration Integration: 1. Allow 800xA system users access to DMS system. Refer to Meriam Process Technologies Device Management System User’s Guide to: a. 2. 3. 4. Create all of the desired 800xA system users in the DMS system. Manage the connection between the 800xA system and the DMS system. a. Create the DMS Division aspect. b. Set up the DMS Division aspect. c. Set up division security. d. Assign access rights (permissions) to users. e. Define division roles and groups. f. Join users to groups, etc. Create the DMS HART Device Object Structure. a. Add and configure DMS aspects. b. Add and configure DMS Asset Monitors. c. Add and configure Parameter Mapping aspect (not required for conventional 4-20 mA devices). Refer to Meriam Process Technologies Device Management System User’s Guide and perform these additional DMS system configuration activities in order to have a fully operational system: a. Add Action Lists. b. Add calibration procedures. c. Assign calibration procedure to devices. d. Set calibration schedule. e. Register DPCs. f. etc. For more details see IndustrialIT 800xA - Asset Optimization, Configuration. 3BDS011222R4101 611 PC, Network and Software Monitoring Section 3 Configuration PC, Network and Software Monitoring Workflow for creating and configuring IT Asset objects using predefined Asset types. This workflow is generic for any IT Asset type. 1. Create a new object of the appropriate IT Asset type in Control Structure, under the IT OPC Server Network. 2. Edit the IT General Property aspect on the new object to set the appropriate general asset configuration parameters. 3. If necessary, edit the individual IT Device aspects to set the device-specific configuration parameters. 4. If necessary, add and configure additional IT Device aspects to the asset object. This is done by: a. Create a new aspect on the object of type IT Device. b. On the configuration view of the new IT Device aspect, set the Current IT Device Configuration setting to the appropriate Device Configuration. c. Edit the device-specific parameters as appropriate. 5. Go to the IT Device Manager aspect, and press click Populate. To confirm that the asset object was properly populated, view the property list on the IT Control Connection aspect. 6. If you have Asset Optimization installed and a license for IT Asset Monitoring, generate the Asset Monitor for the object. To do this: Click Generate on the IT Device Manager aspect. 7. Go to Asset Optimization a. Go to AO Server 1 b. Go to the Asset Optimization Server object c. Go to the Asset Monitor Tab d. Click on Load all AMs For more details see IndustrialIT 800xA - Asset Optimization, Configuration. 612 3BDS011222R4101 Section 3 Configuration Data Access Data Access OPC DA Server Support OPC DA Server Support in the 800xA system enables you to read, write or subscribe to system properties from a third party OPC DA client. The following list shows the Program Identities for the System 800xA OPC DA Server: • ABB.AfwOpcDaServer • ABB.AfwOpcDaSurrogate for remote DCOM connections Use ABB.AfwOpcDaServer when the OPC DA Client is running in same node as a 800xA system is running. For remote connection via DCOM use ABB.AfwOpcDaSurrogate. This application blindly aggregates the ABB.AfwOpcDaServer. There will be a new process every time a client connection is established. Use the DCOMCNFG tool to set the DCOM security setting, see DCOM Security Settings for OPC on page 640. To be considered when connecting to the OPC DA Server: The ABB.AfwOpcDaServer is a DLL and seen as a handler that is created and shared within the application's process. The first COM Apartment thread that creates the handler owns it and must stay alive as long as other threads are connected to the handler. OPC DA Compliancy The System 800xA OPC Server is compliant to the standards OPC Data Access 1.0 and 2.05A with some comments. OPC Data Access Version 2.05A IOPCBrowseServerAddressSpace • 3BDS011222R4101 Flat namespace is not supported. Retrieving an itemID enumerator from the BrowseOPCItemIDs method with OPC_FLAT as browse filter type will result in an empty enumerator 613 OPC AE Server Support Section 3 Configuration • The method BrowseAccessPaths is not supported and will always return E_NOTIMPL. • BrowseOPCItemIDs will not return any items from the Admin or Aspect System structures. It is however possible to manually add items from these structures. IOPCGroupStateMgt • SetState does not change the update rate for a group • AddGroup will always return revised update rate equal to the requested update rate • AddGroup allows requested update rate 0, which is handled as a special case. The items in the group will get a default update rate defined per item in the 800xA system. Revised update rate will be 0 for the group. • AddGroup will in some cases not allow the same group name for different clients. If the in-proc version of PPA OPC Server, ABB.AfwOpcDaServer, is instanced more than once within the same process unique group names must be used for all instances. An alternative is to send in an empty group name and let the server create a unique name. OPC Data Access Version 1.0 • Array data types are not supported OPC AE Server Support OPC AE Support in the 800xA system enables you to subscribe to system Alarm from a third party OPC AE client. The Program Identity for the System 800xA OPC AE Server is ABB.OpcEventServer. For connection via DCOM, use the DCOMCNFG tool to set the DCOM security setting, see DCOM Security Settings for OPC on page 640. OPC AE Compliancy The System 800xA OPC Server is compliant to the standards OPC Alarm and Events 1.02 with some deviations: 614 3BDS011222R4101 Section 3 Configuration OPC HDA Server Support • It is only possible to collect Condition based Events (i.e. Alarms). • The server does not completely follow the state machine described in the OPC AE 1.02 specification (2.4.6 Condition State). • QueryEventCategories and QueryEventAttributes do not follow the OPC AE standard. These methods do not check the EventType parameter and always return Categories and Attributes for OPCSimpleEvent, OPCTrackingEvent and OPCConditionEvent. • Comment argument in AckCondition is not forwarded to the connected OPC AE Server(s). • AckCondition Error handling does not follow the OPC Standard. It always sends an array of S_OK. OPC HDA Server Support OPC HDA Server Support in the 800xA system enables you to read, write or subscribe to history logs from a third party OPC HDA client. The following list shows the Program Identities for the System 800xA OPC HDA Server: • ABB.AdvHtHistoryHdlr (.dll) • ABB.AdvHtHistorySrv (.exe) for remote DCOM connections Use ABB.AdvHtHistoryHdlr when the OPC HDA Client is running on a System 800xA node. For remote connection via DCOM use ABB.AdvHtHistorySrv. This application blindly aggregates the ABB.AdvHtHistoryHdlr. There will be a new process every time a client connection is established. Use the DCOMCNFG tool to set the DCOM security setting, see DCOM Security Settings for OPC on page 640. 3BDS011222R4101 615 OPC HDA Server Support Section 3 Configuration OPC HDA Compliancy The 800xA System OPC HDA Server supports the specification OPC HDA 1.20 with some deviations. IOPCHDA_Server::CreateBrowse • Filters are not supported. If the number of attribute IDs in the filter is not equal to 0 then OPC_W_NOFILTER will be returned in the error vector with S_FALSE as return code from the method. IOPCHDA_SyncRead::ReadProcessed • In some cases when using the OPCHDA_INTERPOLATIVE aggregate the number of values returned is less than the number of intervals. IOPCHDA_AsyncRead::ReadProcessed • In some cases when using the OPCHDA_INTERPOLATIVE aggregate the number of values returned is less than the number of intervals. IOPCHDA_Browser::GetEnum • S_OK is returned regardless of the IENUM string enumerator being empty or not. IOPCHDA_Browser::GetItemID • E_INVALIDARG is returned if the item name given as input is a fully qualified item ID. • E_INVALIDARG is returned if the item name given as input is an empty string. IOPCHDA_Browser::ChangeBrowsePosition • 616 Browsing up from the root will return E_INVALIDARG. 3BDS011222R4101 Section 3 Configuration Generic OPC DA Client Generic OPC DA Client In this section you can read about how to connect to a 3rd party OPC Server. This means that you can integrate and then access data from a 3rd party OPC DA Server, conforming to OPC Data Access standard 2.0 and 1.0A. The OPC Server must implement the interface IOPCBrowseServerAddressSpace to be able to support the Uploader functionality. Integration Creating aspect objects in Control Structure performs integration of an OPC server into the 800xA system. Every aspect object corresponds to an object in the address space of the OPC Server. The 800xA system provides a Generic OPC Server Network Object Type with all functionality required for integration. By creating the Network object, a wizard guides you through the process of connecting an OPC server. On the Network object you find the Uploader aspect providing a generic tool to mirror the content of an OPC server into Control Structure. When you connect the OPC Server, you must decide if the OPC Server should run on a Connectivity Server or in a non-system node. See DCOM Security Settings for OPC on page 640 for security settings when running the OPC Server on a nonsystem node. Running the OPC Server in a Connectivity Server is the standard and recommended configuration. It is also possible to integrate an OPC Server into the aspect directory by importing a Control Structure using the Import/Export tool. Note that you have to add a Service Group from the Data Source Definition aspect, found in the Generic OPC Server Network object, see Configuring the System 800xA OPC DA Connector Service on page 623. Read about how to use the Import/Export tool in the IndustrialIT 800xA - Operations, Operator Workplace, Configuration manual. 3BDS011222R4101 617 Generic OPC DA Client Section 3 Configuration Connect to an OPC Server Connection to an OPC Server or a Generic OPC Server Network Object is described below. How to Connect to an OPC Server on a Connectivity Server 1. In Control Structure, create a new object of the type Generic OPC Server Network and name it for example Generic OPC Net. 2. Follow the wizard to select Connectivity Server and OPC Server. See Figure 305. A Service Group will be created and a Data Source Definition Aspect will be configured with this Service Group. The Service Provider will be enabled automatically. Figure 305. Connection of an OPC Server in Control Structure 3. 618 Perform an Upload. See Upload on page 634. 3BDS011222R4101 Section 3 Configuration 4. Generic OPC DA Client Check the Data Access functionality by looking in the Property View in the Control Connection Aspect. See Properties of the Control Connection Aspect on page 625. How to Connect to an OPC Server in a Non-System Node 1. In Control Structure, create a new object of the type Generic OPC Server Network and name it for example Generic OPC Net. 2. Follow the wizard to select Connectivity Server. See Figure 306. A Service Group with the name SG_Generic OPC Net will be created and a Data Source Definition Aspect will be configured with this Service Group. Figure 306. Connection of OPC Server in non-system node. 3. Go to the Service Structure and make manual configuration of the OPC Server and the remote node for every Service Provider. Enable each Service Provider. See Configuring the System 800xA OPC DA Connector Service on page 623. 4. Perform an Upload. See Upload on page 634. 3BDS011222R4101 619 Generic OPC DA Client 5. Section 3 Configuration Check the Data Access functionality by looking in the Property View in the Control Connection Aspect. See Properties of the Control Connection Aspect on page 625. How to Manually Create a Generic OPC Server Network Object 1. In Control Structure, create a new object of the Generic OPC Server Network type and name it for example Generic OPC Net. 2. Follow the wizard and do not select a Connectivity Server or OPC Server. See Figure 307. Only an object with a non configured Data Source Definition Aspect will be created Figure 307. Connection of Generic OPC Server Network Object 620 3. Manually create a Service Group and a Service Provider. See Configuring the System 800xA OPC DA Connector Service on page 623. 4. Manually configure the Data Source Definition Aspect. See Data Source Definition Aspect on page 621. 3BDS011222R4101 Section 3 Configuration Generic OPC DA Client Data Source Definition Aspect The Data Source Definition aspect binds a system OPC property to a data provider and is normally situated in Control Structure on the Network Object. You use the Data Source Definition aspect to create, modify or view a Service Group or a Service Provider in the Service Structure. A created Service Group can only be deleted in the Service Structure. If you remove a Data Source Definition aspect, the Service Group will not be deleted. Multiple service providers are used in a system with redundant connectivity servers. All service providers in a service group must provide the same data. The OPC servers, which the service providers are connected to, must collect data from exactly the same set of equipment. The Data Source Definition aspect has two tabs which are described below. The Connectivity Tab Figure 308. The Connectivity Tab 3BDS011222R4101 621 Generic OPC DA Client Section 3 Configuration • The Service Group drop down menu. Shows a list with available Service Groups defined in the Service Structure under the OPC DA_Connector Service. • The View button. Click here to view the selected Service Group Definition aspect. • The New button. Click here to create a new Service Group and add providers. • With the Modify button you add and remove providers to/from an existing Service Group. • The Data Key area. This is a connect specific key which binds the Control Connection aspect to the right OPC Data Source Definition aspect. The Data Key is normally not changed The OPC Configuration Tab Figure 309. The OPC Configuration Tab • 622 This field shows the identity of the OPC server that the service provider are using. It is also used when a new service group or provider is created from the OPC Data Source Definition aspect. The value can only be changed if the Service Group field in the Connectivity 3BDS011222R4101 Section 3 Configuration Generic OPC DA Client tab is empty. Configuration is normally set from the wizard shown in Figure 305, or on an object type. Configuring the System 800xA OPC DA Connector Service The configuration specific to Data Access is set in the Special Configuration tab on the Service Group and Service Provider Definition Aspects of the OPC DA Connector service object. Service Group Figure 310. Server Group Definition - Special Configuration Adapter Identity field: The ProgID for the Adapter to be used by the Service Providers in this group. Normally, no need to change. Allow Parallel Redundancy check box: When this alternative is checked, parallel redundancy is allowed for this Service Group. Parallel redundancy is only used when an OPC DA client requests it explicitly. If this alternative is unchecked, fail-over redundancy will always be used regardless of what the OPC DA client requests. The recommendation is to allow parallel redundancy, unless there are other controller specific recommendations. 3BDS011222R4101 623 Generic OPC DA Client Section 3 Configuration Service Provider Figure 311. Server Provider Definition - Special Configuration OPC server identity field: The ProgID for the OPC server. Click Refresh to update the list with available OPC servers. All service providers in the same service group should have the same OPC Server identity. Remote OPC node field: This parameter is left blank if the OPC server is running in the Connectivity Server. When running the OPC server in a non-system node this parameter is set to the computer name or IP address of the remote node. OPC Control Connection Aspect New Generic OPC objects are automatically created in Control Structure, underneath the Generic OPC Server Network object. 624 3BDS011222R4101 Section 3 Configuration Generic OPC DA Client Test of Data Access You can test data access to OPC items from the property view tab. Mark the Subscribe for live data check box to test the connection between this node and the OPC Server. Figure 312. The Subscribe for Live Data Option in the Property View Properties of the Control Connection Aspect The Properties of the Generic OPC Object are shown in the Control Connection Aspect. The dialog box has five tabs (some tabs are only visible in Object Type Structure): • Property View • Property Info • Additional Info • OPC • Item Properties 3BDS011222R4101 625 Generic OPC DA Client Section 3 Configuration Property View Tab The Property View Tab contains information about the properties in the Control Connection Aspect. See Figure 313. Figure 313. Property View 626 3BDS011222R4101 Section 3 Configuration Generic OPC DA Client Name Property name in the system. Data Type The data type of the property. Access The setting of the property, (readable and/or writable) Update Rate The default update rate for the property in milliseconds. Value The collected value of the property. Quality The quality of the property value. Timestamp The time when the property got its value. Flags See information about the Property Info Tab. Read Permission Security setting for reading. Write Permission Security setting for writing. Description Description of the property. Subscribe for live data Activate subscription on property for data. 3BDS011222R4101 627 Generic OPC DA Client Section 3 Configuration Property Info Tab Select the Property Info tab and mark one of the properties in the Properties area. The Property Info area contains information about the selected property. See Figure 314. Figure 314. Property Info 628 Data Type The data type of the property. Name Property name in the system. Update Rate The default update rate for the property in milliseconds. ID Internal ID number of property. Description Description field (for example a different name). R/W - Readable Manual setting if readable or not. R/W - Writable Manual setting if writable or not. Read Permission Security setting for reading. Write Permission Security setting for writing. 3BDS011222R4101 Section 3 Configuration Generic OPC DA Client Additional Info The selected property has additional Info. For example used by Trend and Historian. Can be used for other purpose. Real Time For application specific use. Runtime For application specific use. Primary For application specific use. Common For application specific use. Reauthenticate Enables Reauthenticate. Double authenticate Enables Double authenticate. Confirmed write Enables Confirmed write. Additional Info Tab The Additional Info tab contains additional information about some of the properties. These properties are displayed to the left in the Properties with additional Info area. You can also insert additional information in the text fields in the Presentation Attributes area. See Figure 315. These features are used by Trends and Historian. 3BDS011222R4101 629 Generic OPC DA Client Section 3 Configuration Figure 315. Additional Info 630 Normal Maximum Name of the property that specifies max range or a max range value. Example of a property: max_value. Example of a value: 100.00. Normal Minimum Name of the property that specifies min range or min range value. Example of a property: min_value. Example of a value: 0.00. Engineering Unit Name of the property that specifies Engineering Unit or a value. Example of a property: unit. Example of a value. No. of Decimals Name of the property that specifies number of decimals or a value. Example of a property: no_of_dec. Example of a value: 2. 3BDS011222R4101 Section 3 Configuration Generic OPC DA Client Data is displayed as vertically connected horizontal lines between points. See Figure 316. Presentation Mode Interpolated Data is displayed as sloped lines between points. See Figure 316. Value Value Normal Max Value Presentation Mode Stepped Normal Min Time The data collected through the data subscription. Time Data presentation with the Presentation Mode Stepped selected. Time Data presentation with the Presentation Mode Interpolated selected. Figure 316. Example of Presentation Modes 3BDS011222R4101 631 Generic OPC DA Client Section 3 Configuration OPC Settings Select the OPC tab to see the OPC settings. See Figure 317. Figure 317. OPC Settings Property Selector for the property name in the control connection aspect. Use the arrow to the right to show the properties. Item ID Property identity in the accessed OPC server. Edit according to the rules given for the connected OPC server. Access Path Optional. You may edit the path according to the rules given for the connected OPC server. The default settings are relevant in most cases. However, if you want to make changes, see the following sections. 632 3BDS011222R4101 Section 3 Configuration Generic OPC DA Client Item Properties The Item Properties tab is used for configuration of Item Properties for an object according to the OPC DA 2.0 specification. An Item Property consists of an ID, description, data type and a value. The source of the value is a property on the object that holds the Control Connection Aspect. All Item Properties for an object are displayed in the list view. See Figure 318. Figure 318. Item Properties Dialog Property The property to be configured Description A description to define the Item Property. Object Property Select the Object Property to define the source of the Item Property value. Default property for object Each object that has item properties defined must have a default property. This is done by checking Default property for object. 3BDS011222R4101 633 Generic OPC DA Client Section 3 Configuration If no Property is marked as default the first Property in the list will automatically be set as default. Only one Property can be marked as default. How to add a new Item Property: • Fill in the Property, Description and Object Property fields • Click the Add button. • The Item Property will be added for all properties in the Control Connection aspect. How to configure the Object Property individually for each Item Property: • Select a property in the Property drop down menu. • Select an Item Property. • Select another Object Property as value source. • Click Apply before you proceed to the next property in order to save the configuration. Upload By uploading, you collect all the objects in the OPC Server and append them as aspect objects in Control Structure. The Upload in Control Structure, reflects the structure of the branches in the OPC Server. All branches in the OPC Server are represented by aspect objects. The OPC branch’s leafs are declared in a Control Connection aspect as aspect object properties. OPC leafs are the items you can access in an OPC Server. To perform an Upload the user needs to have Security permission Configure. The Security settings are performed according to instructions in IndustrialIT 800xA System, Administration and Security. 634 3BDS011222R4101 Section 3 Configuration Generic OPC DA Client Standard Upload Double click on the upload aspect of the OPC server connection. A dialog box opens. Go to the Standard tab and click the Start button to start the upload. This may take some time, depending on the size of the system. As long as the upload is running, an hour glass is shown and the Stop button is activated. When the Start button is activated the upload is done. You can see the status of your upload in the message window. If you press the Stop button during the upload, the loading is interrupted. You are able to see how far the upload has come in the log file. If you want to delete the uploaded data, this must be done manually. See Figure 319 and Figure 320. Figure 319. Upload in Progress 3BDS011222R4101 635 Generic OPC DA Client Section 3 Configuration Figure 320. Result of Generic OPC Upload Advanced Upload An Advanced Upload is like a Standard Upload but the operation is split into two steps: • Retrieve objects (The command Retrieve creates an .ocs file). • Append objects (This will use the .ocs file created in the first step. This can be changed by typing in or browsing to another file.). The reason for an Advanced upload is that you retrieve in one system and later append in another system. If you enter the path manually, the Cancel and Apply buttons are activated. Press Apply to save your changes. 636 3BDS011222R4101 Section 3 Configuration Generic OPC DA Client Browse button Figure 321. Uploader - Advanced Tab Description of Uploader Append Name Resolving The Append function in the Uploader has a name resolving feature. The function tries to find an object with the same name in other structures than Control Structure. If an object is found, that object will be inserted into Control Structure according to the following rules: 1. An object is found in Functional Structure but not in Control Structure. See Table 19, example 1. 2. One object named AI_117, exists in Control Structure. Another object, named AI_117 exists in Functional Structure. The object in Control Structure will be moved to Obsolete Structure and the object in Functional Structure will be inserted in Control Structure, see Table 19, example 2. 3. One object named AI_117 exists in both Control Structure and Functional Structure. Another object, named AI_117 exist in Functional Structure. If this is the case, nothing will happen after the upload. See Table 19, example 3. 4. No object exists in Control Structure. Two different objects, with the name AI_117 exist in Functional Structure. A new AI_117 object will be created in Control Structure instead of selecting the ones in Functional Structure. This is seen as a conflict and reported in a log, see Table 19, example 4. 3BDS011222R4101 637 Generic OPC DA Client 5. Section 3 Configuration No object is found. An object will be created in Control Structure. See Table 19, example 5. Table 19. Uploader Append Name Resolving Before Upload Object Control Structure Ex 1 Ex 2 X AI_117 AI_117 AI_117 Ex 4 Ex 5 Control Structure X Other Structure X Obsolete Structure X X AI_117 Ex 3 Other Structure After Upload X X X X X X X X AI_117 X X AI_117 X X AI_117 X X X An obsolete object can be re-created from the Obsolete Structure. If an object with the same name is found, its type is not checked against the type given in the .ocs file created by the Retrieve function. This enables you to create your own object types and instantiate an object with the same name in another structure. The Uploader Append’s name resolving feature will find that object and the object’s property will be initiated with the OPC ItemID string. 638 3BDS011222R4101 Section 3 Configuration Generic OPC DA Client Changes of the Settings for Uploaded Items Normally only the Permission, Flags and Additional Info settings is changed. This can be done under the Property Info Tab. See Figure 314. Property Signal Generator Aspect You can use the Property Signal Generator aspect to generate a simulated value that can be used to test a display, a display element, or any other client application that subscribes for OPC items (object properties). The Property Signal Generator is only intended for test purposes. The Property Signal Generator aspect can generate a sinus formed wave, a ramp, a random value or a static value. Configuration Steps To be able to use the Property Signal Generator there must be a data source for the PPA OPC property to give the value to. A generic OPC property together with a test OPC adapter delivered with the product can be used as source. The following steps create a data source and a Property Signal Generator with a sinus wave. 1. Go to Control Structure and create a new object of type Generic OPC Server Network, under the OPC 3rd party OPC support Object Type group. Give the object the name TestAdapterNet. 2. In the Additional Arguments dialog, select the appropriate Connectivity Server and but do not select any OPC server. Press Create. 3. Go to the Service Structure and view the Service Group Definition aspect on the SG_TestAdapterNet object under the OpcDAConnector service. Select the Special Configuration tab and enter ABB.AfwDsGenericTestAdapter.1 in the Adapter field. Press Apply. 4. Go to the Service Provider object under the SG_TestAdapterNet object and view the Service Provider Definition aspect. Select the Configuration tab and check Enabled, then press Apply. 5. Go to Control Structure again. Create a new object of the type Generic OPC Object under the TestAdapterNet object. Give the new object the name Pump. 3BDS011222R4101 639 DCOM Security Settings for OPC Section 3 Configuration View the Control Connection aspect on the Pump object and select the Property Info tab. Add a new property, Flow, with the type VT_R4. Press Apply. 6. Create a Property Signal Generator aspect on the Pump object and view the aspect. Select the Flow property and select Sine Wave with default values. 7. To test the value, view the Control Connection Aspect and select the Property View tab. Check Subscribe for live data, dynamic values should now appear in the Value column. 8. You can now add other aspects to the object, e.g. a Trend Display or a Graphic Display. 9. It is now possible to add more properties to the object by repeating step 6-7 or to add more objects by repeating step 5-7. DCOM Security Settings for OPC The recommended configuration is to have all computers involved in remote OPC Data Access in the same domain. If this is not possible, it is however possible to configure DCOM security to allow OPC Access anyway. Regardless of the configuration some DCOM security setting are however necessary. DCOM security settings are made with the DCOM configuration tool, dcomcnfg. A general recommendation is to use accounts with passwords that never expires, otherwise you will need to change DCOM security settings every time the password is changed. Default DCOM properties for the non-system computers must be set to: Default Authentication Level = Connect and Default Impersonation Level = Identify. A remote OPC DA Server must use Authentication Level = Default. 640 3BDS011222R4101 Section 3 Configuration DCOM Security Settings for OPC Settings on Windows XP SP2 1. Go to the COM Security tab and note these are the four permission configurations that we will have to edit: Figure 322. COM Security Tab 2. Edit the Limits for Access and Launch a. 3BDS011222R4101 Access Permissions – Edit Limits... You need to check the Remote Access box for the user labeled ANONYMOUS LOGIN in this dialog. 641 DCOM Security Settings for OPC Section 3 Configuration Note: This setting is necessary for OPCEnum.exe to function and for some OPC Servers and Clients that set their DCOM 'Authentication Level' to 'None' in order to allow anonymous connections. If you do not use OPCEnum you may not need to enable remote access for anonymous users. Figure 323. Access Permissions – Edit Limits... b. Launch and Activation Permissions – Edit Limits... You need to check the remote boxes for the user labeled Everyone in this dialog. Note: Since Everyone includes all authenticated users, it is often desirable to add these permissions to a smaller subset of users. One suggested way to accomplish this is to create a group named “OPC Users” and add all user accounts to this group that will execute any OPC Server or Client. 642 3BDS011222R4101 Section 3 Configuration DCOM Security Settings for OPC Then substitute “OPC Users” everywhere that Everyone appears in these configuration dialogs. Figure 324. Launch and Activation Permissions – Edit Limits... 3. Edit Default Permissions for Access and Launch For each user (or group) that participates in OPC communication (e.g. “OPC Users”), make sure that both the Local Allow and Remote Allow checkboxes are both checked. Access Permissions per user: Figure 325. Access Permissions per User 3BDS011222R4101 643 OPC DA Client Section 3 Configuration Launch and Activation permissions per user: Figure 326. Launch and Activation Permissions per User You can find the original description for using OPC via DCOM with Windows XP SP2 under http://www.opcfoundation.org/WebUI/DownloadFile.aspx?CM=1&RI=161. OPC DA Client OPC Node in the same Domain Configure the computer(s) running the OPC Server. 1. Set Identity to This user and select the same domain account as used for the 800xA System services for the OPC Server. 2. Add the 800xA System service account to Launch and Access permissions for the OPC server. If you do not want to use the 800xA System service account, follow the steps for OPC Node in another Domain or without Domain on page 644. OPC Node in another Domain or without Domain Configure the computer(s) running the OPC Server. 644 1. Create a local account, e.g. OPCuser. 2. Set Identity to This user and select OPCuser created above for the OPC Server. 3BDS011222R4101 Section 3 Configuration OPC DA Server 3. Create a local account with the same name and password as the 800xA System service account. 4. Add the local account created in step 2 to Launch and Access permissions for the OPC server Configure the Connectivity Server(s): 5. Create a local account with the same name and password as created in step 1, on the OPC Server node. OPC DA Server You need to decide which operations that should be allowed from remote access. An OPC client accessing the System 800xA OPC DA server remotely will get the same permissions as the account that the AfwDsOpcSurrogate process is set to run as. If the account is not known in the 800xA System permissions will be the same as for the user Guest. Otherwise the permissions will be the same as for the 800xA System user, which the account is mapped to. The recommendation is to use an account that is known in the 800xA system. OPC Client Node in the same Domain Configure the System 800xA computer(s) on which you will access the System 800xA OPC DA server: 1. For the AfwDsOpcSurrogate application, set Identity to This user and select a domain account, which should be known in the 800xA system. Configure the computer(s) running the 3rd party OPC DA client: 2. Add the account used in step 1, to Access permissions in Default DCOM Security. OPC Client Node in another or without Domain Configure the computer(s) running the 3rd party OPC DA client: 1. 3BDS011222R4101 Create a local account, e.g. OPCuser. 645 Upload Section 3 Configuration 2. Create a local account with the same name and password as the account that is used in step 6. 3. Add the local account created in step 2 to Access permissions for Default DCOM Security. Configure the computer(s) on which you will access the System 800xA OPC DA server: 4. Create a local user with the same name and password as created in step 1. 5. Add the user created in step 4 to Launch and Access permissions for the AfwDsOpcSurrogate application. 6. For the AfwDsOpcSurrogate application, set Identity to This user and select a domain account, which should be known as user in the 800xA system. Upload For Upload to work it is necessary to configure DCOM security on the computer running the remote OPC Server. This must be done for the user(s) that should be able to perform an upload. First you need to configure security according to OPC DA Client on page 644. OPC Node in the same Domain Configure the computer(s) running the OPC Server. 1. Add the account(s) that will be used when performing an upload to Launch and Access permissions for the OPC server. OPC Node in another Domain or without Domain Configure the computer(s) running the OPC Server. 646 1. Create a local user with the same name and password as the account that will be used when performing an upload. Repeat this for all accounts that will be used when performing an upload. 2. Add the local user created in step 2 to Launch and Access permissions for the OPC server. 3BDS011222R4101 Section 3 Configuration OPC HDA Server OPC HDA Server You need to decide which operations that should be allowed from remote access. An OPC client accessing the System 800xA OPC HDA server remotely will get the same permissions as the account that the AdvHtHda process is set to run as. If the account is not known in the 800xA System permissions will be the same as for the user Guest. Otherwise the permissions will be the same as for the 800xA System user, which the account is mapped to. The recommendation is to use an account that is known in the 800xA system. OPC HDA Client Node in the same Domain Configure the System 800xA computer(s) on which you will access the System 800xA OPC HDA server: 1. For the AdvHtHda application, set Identity to This user and select a domain account, which should be known in the 800xA system. Configure the computer(s) running the 3rd party OPC HDA client: 2. Add the account used in step 1, to Access permissions in Default DCOM Security. OPC HDA Client Node in another or without Domain Configure the computer(s) running the 3rd party OPC HDA client: 1. Create a local account, e.g. OPCuser. 2. Create a local account with the same name and password as the account that is used in step 6. 3. Add the local account created in step 2 to Access permissions for Default DCOM Security. Configure the computer(s) on which you will access the System 800xA OPC HDA server: 4. Create a local user with the same name and password as created in step 1. 5. Add the user created in step 4 to Launch and Access permissions for the AdvHtHda application. 3BDS011222R4101 647 OPC AE Server Section 3 Configuration 6. For the AdvHtHda application, set Identity to This user and select a domain account, which should be known as user in the 800xA System. OPC AE Server You need to decide which operations that should be allowed from remote access. An OPC AE client accessing the System 800xA OPC AE server remotely will get the same permissions as the account that the AfwEventOPCServer process is set to run as. If the account is not known in the 800xA System permissions will be the same as for the user Guest. Otherwise the permissions will be the same as for the 800xA System user, which the account is mapped to. The recommendation is to use an account that is known in the 800xA system. OPC Client Node in the same Domain Configure the 800xA System computer(s) on which you will access the System 800xA OPC AE server: 1. For the AfwEventOPCServer application, set Identity to This user and select a domain account, which should be known in the 800xA System. Configure the computer(s) running the 3rd party OPC AE client: 2. Add the account used in step 1, to Access permissions in Default DCOM Security. OPC Client Node in another or without Domain Configure the computer(s) running the 3rd party OPC AE client: 1. Create a local account, e.g. OPCuser. 2. Create a local account with the same name and password as the account that is used in step 6. 3. Add the local account created in step 2 to Access permissions for Default DCOM Security. Configure the computer(s) on which you will access the System 800xA OPC AE Server: 4. Create a local user with the same name and password as created in step 1. 648 3BDS011222R4101 Section 3 Configuration How to use the OLE DB Provider 5. Add the user created in step 4 to Launch and Access permissions for the AfwEventOPCServer application. 6. For the AfwEventOPCServer application, set Identity to This user and select a domain account, which should be known as a user in the 800xA system. How to use the OLE DB Provider The name of the OLE DB provider is ABB OLE DB Provider for Data Access. You access the OLE DB provider through a command syntax. Furthermore, you can utilize a graphical user interface to specify a short reference to the data that you want to refer to from your client software. The purpose of this is twofold; you can decrease the complexity and length of the command and the limitation in command length, that some report clients have, can be circumvented. Each short reference is a generic object placed in the Library Structure and including aspect called OLE DB Access Table for DS. The syntax for the command line is built up with a command followed by one or several keywords. The command you use is GET_DATA. Command Line The syntax for the command line is built up by a command followed by one or several keywords as shown below. There is one exception and that is when you use the keyword STORAGEINFO alone, without the usage of other keywords or commands. The purpose of this is to be able to list all logs in the 800xA system. Command Syntax The command for Data Access is GET_DATA. The alternatives here are also: • GET_DATA(STORAGEINFO) You use the keyword STORAGEINFO to get a list of all short references that exits in the Library Structure and are related to data access. No other keywords are allowed. • GET_DATA(OBJECTHELPER=…) You use the keyword OBJECTHELPER to retrieve real time data according to one of the pre-configured short references. No other keywords are allowed. 3BDS011222R4101 649 How to use the OLE DB Provider • Section 3 Configuration GET_DATA(OBJECT=…; ASPECT=…; PROPERTY=…) You build a query by utilizing the keywords OBJECT, ASPECT and PROPERTY that specify the object and attribute name. There are no additional options for these cases. As mentioned in the beginning of this section you can use the keyword STORAGEINFO alone without any other commands or keywords. Keywords A description of the keywords and their respective meaning and syntax can be seen in the table below:. Table 20. Keywords Keyword Description OBJECTHELPER The name of the short references that holds the OleDB Tables. OBJECT The full path or the GUID(1) of the object. ASPECT The name or GUID of the aspect where the property belongs. PROPERTY The name of the property. (1) The Object GUID, Globally Unique Identifiers, uniquely identifies each object. Example Command Line Retrieve version information about the OLE DB provider: GET_DATA(VERSION) Get a list of all short references in the 800xA system: GET_DATA(STORAGEINFO) Get the data specified by a short reference: GET_DATA(OBJECTHELPER=DsReference) Get data by specifying object, aspect and property directly: 650 3BDS011222R4101 Section 3 Configuration How to use the OLE DB Provider GET_DATA(OBJECT=[Control Structure]MB300 Test Network/Extended Process Objects x/MB300 AI/AIC4_1; ASPECT=Control Connection; PROPERTY=VALUE) Note that the example shows a full path to the object. It is also possible to give shorter reference to the object, as long as it will uniquely identify the object. Short References In some report packages, it might not be possible to specify command strings as described in Command Line on page 649. When this is the case, you will need to use the OLE DB DA Access Table aspect. The OLE DB DA Access Table works as a short reference for the report package and contains all necessary information to get the data. Normally you create the aspect on an object in the Library Structure. The name of the object which has the OLE DB DA Access Table aspect is used with the keyword OBJECTHELPER, described earlier. Configuration 1. Browse for the object or write the full path for the object, in the Object Path area. 2. Select aspect in the Aspect Name drop-down menu 3. Select property in the Property Name drop-down menu. 3BDS011222R4101 651 How to use the OLE DB Provider 4. Section 3 Configuration Click Apply to verify the changes. Figure 327. The Help Aspect in Data Access. 652 3BDS011222R4101 Appendix A Object Structures In this appendix you will find an overview of the basic object structures present in Plant Explorer. The system comes with a set of predefined structures. The set of structures may be extended by an arbitrary number of structures by anyone using the system. The structures described have in some cases been filled with more data than when first installed. The structures described in this section are needed for correct system operation and must not be removed or modified in any way. Normally, these structures enforce their own rules, for example what can be inserted. Each structure is described in more detail in the sections below. The system contains the following primary structures for a workplace: • Functional Structure - gives the functional structure of the system. • Location Structure - contains the location of objects. • Control Structure - gives the control structure of the system. • Workplace Structure - contains the workplace definitions of a system. • Library Structure - which holds the alarm and event list configurations, the view classes, the tools, the workplace frames, the workplace panels, and the object type library objects. These structures are primary structures, because it is assumed that most Operators and Application Engineers in the running plant will perform most of their work within these structures. Some additional and important structures are: • Admin Structure - contain the administrative structure of the system. • Object Type Structure - contains the object types to be used in the system. • Aspect System Structure - contains the aspects to be used in the system. 3BDS011222R4101 653 Appendix A Object Structures • Graphics Structure - defines graphic primitives and subelements. • (Aspect Category Structure - for future use) These structures contain the objects that are used to configure and control the system itself. The administration structures are all structures that are pre-created, and which may contain only objects that are placed in the system domain. These objects typically have restricted access, requiring System or Application Engineer user role, to allow modifications. There are also a set of additional administration structures. All these structures have different purposes and control much of the system behavior. These additional administrative structures are: • Service Structure - holds service definitions. • User Structure - gives all user groups and where the users are placed. • Node Administration Structure - holds all node groups (sometimes called networks) and nodes defined in the system. • Maintenance Structure - defines backups and synchronization packages • System Structure - holds the project object There are also some additional structures supporting you with additional information: • Product Type Structure - contains all certified Industrial IT Products. • Product Structure - contains instances of different object types. • Documentation Structure - contains system documentation and, if built up during engineering accordingly, the plant documentation. • Obsolete Structure- holds obsolete objects Aspect systems can introduce own structures. Examples are: 654 • Reuse Design Structure - defines Reuse Instructions (Reuse Assistant). • Equipment Structure - defines Equipment Groups (Batch Management) • Procedure Structure - defines Procedures (Batch Management) 3BDS011222R4101 Appendix A Object Structures • Scheduling Structure - defines Scheduled / Running Jobs (Information Management) • Asset Structure - provides maintenance personal with the possibility to group/arrange plant assets. Each structure is implemented as an aspect category and has therefore, for example its own authority control. Every structure with objects has at least one root object. A structure may have multiple root objects, and these are displayed as top-level objects in Plant Explorer. 3BDS011222R4101 655 Admin Structure Appendix A Object Structures Admin Structure The root of Admin Structure is the administrative object´s root object. It currently contains two relevant objects, called Domains and Inventory. The Inventory object contains all aspect type objects of the aspect types that implement an admin object as its child. This means that all aspect systems, aspect types, affinities etc. are easily found in one place. Figure 328. Admin Structure Aspect Category Structure For future use. 656 3BDS011222R4101 Appendix A Object Structures Aspect System Structure Aspect System Structure Aspect System Structure defines the aspect systems, aspect types and aspect categories available in a system. The structure shows the aspect systems, the corresponding aspect types and under the aspect types their categories. The structure is primarily used to populate the New Aspect dialog used by Plant Explorer and other tools. The structure is typically updated by loading aspect system definitions during the loading of a system extension. Figure 329. Aspect System Structure 3BDS011222R4101 657 Asset Structure Appendix A Object Structures Asset Structure Asset Structure provides the possibility for maintenance personal to group and arrange plant assets in the way it is needed for efficient daily work. Control topology constraints can be overcome and even devices with different fieldbus protocols can be grouped together if they require similar maintenance procedures. Asset Structure comes by default with 5 major groups of Assets (Drives, Field Instruments, IT Assets, Motors and Process Equipment). Control Structure Control Structure is used to define where the different parts of the control application executes. It is initialized without any objects. After configuration is done, it contains the networks and nodes that are used to control the process, that is the equipment of the system and is also used to organize the process control environment in the system: Control networks, control projects, applications, controllers, stations, different types of sub-objects (like I/O boards and process objects as well as signals assigned to different objects within this structure). Control Structure is the base for the control operation of the system. The user can, for example, check consistency and system status. By configuring the objects with Control Designation aspects you can build and display control designations according to reference designation system standards in this structure. 658 3BDS011222R4101 Appendix A Object Structures Control Structure The figure below gives an example of how the structure could look for AC 800M after having done some configuration work on a control project. Figure 330. Control Structure for AC 800M The Lost and Found object collects useless alarms etc. An object under the Lost and Found object is removed in the same way as another object. The objects • System Alarms and Events and their sub-objects • and OPC Servers and their sub-objects are shown in Control Structure automatically for internal Control Builder M administration purposes. 3BDS011222R4101 659 Documentation Structure Appendix A Object Structures Documentation Structure The structure should be used for storage of project and plant documents. Build an object structure and add relevant documents to the objects as aspects. By configuring the documentation objects with Documentation Designation aspects you can build and display document designations according to reference designation system standards in this structure. Equipment Structure Equipment Structure is used to organize Batch Management equipment into Equipment Groups. 660 3BDS011222R4101 Appendix A Object Structures Functional Structure Functional Structure Functional Structure describes the functionality of the plant. It is used to structure the plant into systems and subsystems according to how the plant equipment operates together. By this it forms a base for the identification of reusable control solutions and can also be used to organize displays, alarm sectioning and other functions that are related to the structure of the plant. It can be used to display functions divided into several different control systems. It can also display aspect objects that are not directly related to any specific control logic, like a heat exchanger (the physical object) included in a control loop. By configuring the objects with Functional Designation aspects you can build and display functional designations according to reference designation system standards in this structure. The structure is initialized without any objects. The figure below shows an example of how Functional Structure can look when various types of objects have been added. Figure 331. Functional Structure 3BDS011222R4101 661 Graphics Structure Appendix A Object Structures Graphics Structure Graphics Structure holds the graphic primitives and subelements available in the system. This structure is typically not accessed nor modified by a user as it is updated by different tools. It is reflected in the Tools dialog in Graphics Builder, and also in the corresponding wizard page. Each object in the structure is listed in the Tools dialog, and has also a corresponding toolbox tab in Graphics Builder. The structure is updated when subelements are created or modified, or when new primitives are loaded or unloaded. It contains one root object, Graphics Tools. The root object then holds three objects, one holding the subelements and one holding the primitives. The third object holds the other graphical elements. Figure 332. Graphics Structure 662 3BDS011222R4101 Appendix A Object Structures Library Structure Library Structure Library Structure is used to categorize and store reusable entities beyond object types. It contains all object type libraries and its versions. Most of the work with libraries can be made in this structure, such as connect used libraries to a library, creating new libraries, create a new version for a released library, change the library state, and archive a library. The object types of these libraries are stored in Object Type Structure. Library Structure also holds the alarm and event list configurations, the view classes, the tools, the workplace frames, and the workplace panels. The alarm and event list configurations can be shared by a number of lists, and define the layout and filter parameters of the lists. Each object must contain one and only one configuration. The configurations are listed in the Config View of the Alarm and Event List aspect category. Figure 333. Library Structure 3BDS011222R4101 663 Location Structure Appendix A Object Structures Location Structure Location Structure is supplied to help the user identify the geography or location of the objects in the plant. This structure must be built with the knowledge of what buildings, rooms and locations that exist in the site. At system start-up this structure contains no objects. By configuring the objects with Location Designation aspects you can build and display location designations according to reference designation system standards in this structure. The figure below gives an example of how the structure could look when containing objects. Figure 334. Location Structure 664 3BDS011222R4101 Appendix A Object Structures Maintenance Structure Maintenance Structure Maintenance Structure is used to define and work on Backups, System Configuration Versions, and Synchronizations. Figure 335. Maintenance Structure 3BDS011222R4101 665 Node Administration Structure Appendix A Object Structures Node Administration Structure Node Administration Structure is used for node administration purposes. The main reason for this structure is that all nodes in the system must be found in at least one place and that nodes can be placed in multiple groups. The nodes in Node Administration Structure are typically also found in Control Structure. The structure contains two levels under the root: The first level contains node groups and the second level contains nodes. The node group named All Nodes has a prebuilt support that disallows manual changes and updates automatically with all nodes in the system. Figure 336. Node Administration Structure 666 3BDS011222R4101 Appendix A Object Structures Object Type Structure Object Type Structure Object Types act as types when you create objects. Almost all aspect objects are instances of an Object Type. In the Object Type Structure, the object types defined in the system are organized in Object Type Groups or Library Versions. For example you find in the Object Type Structure the Library Versions and the object types brought into the system by the AC 800M Connect system extension. Figure 337. Object Type Structure Read more about Object Types in Object Types on page 75 and in Building Object Types on page 333. 3BDS011222R4101 667 Obsolete Structure Appendix A Object Structures Obsolete Structure Obsolete Structure contains information about aspect objects that have been deleted by a system function, for example the up-loader in a connectivity package. An aspect object with the system function name, appended with the time when delete operation was performed, represents each delete operation. The aspect object has an Obsolete Object aspect, and from the Main view you can open an Import/Export file, which contains the deleted objects and aspects. Deletions made by the user are not logged in this structure. Procedure Structure Procedure Structure is used to contain Batch Management receipt procedures, unit procedures, operations, exception procedures, receipt phases, and functions. Product Type Structure Product Type Structure contains all certified Industrial IT Products organized according to their Product Suite. Product Structure Product Structure contains instances of different product types. The instances contain product information that are specific for an individually delivered product, e.g. serial numbers, test records etc. Reuse Design Structure Reuse Design Structure is a tool specific structure created and used by Reuse Assistant. You build Reuse Instructions in this Structure using the Reuse Assistant Architect part of Reuse Assistant. 668 3BDS011222R4101 Appendix A Object Structures Scheduling Structure Scheduling Structure Scheduling Structure is used to hold Information Management job descriptions of scheduled jobs and running jobs. Service Structure Service Structure holds the services, their groups and providers, and the relations between these defined in a system. A service is a global function in the network, and the objects and aspects in the Service Structure control the definition and deployment of the services. Figure 338. Service Structure System Structure System Structure only contains a project object, representing the whole project you are working on and some settings for it. 3BDS011222R4101 669 User Structure Appendix A Object Structures User Structure User Structure holds the defined users and user groups allowed to work in the system. You define user roles in the Configuration Wizard. All users must have a related Windows user account. The user aspect primarily contains information about a user and what the user is allowed to do within the system (his user role). It also contains data specific to the user, such as profile configuration values. The structure contains two levels under the root object: The first level holds groups, and the second holds users. The user group Everyone holds all users. Users can be added to groups by dragging and dropping them to different user groups. User Roles User Roles adapt your environment depending on your role. You assign user roles when you add a user to a specific Industrial IT group. The following User Roles exist: 670 • Operator - can control the process • Application Engineer - can do typical engineering operations • System Engineer - can do system administrative task 3BDS011222R4101 Appendix A Object Structures User Structure User roles help customizing the environment to suit the needs of each user. This means that operations that you are not assumed to perform are not displayed. Figure 339. User Structure The Industrial IT groups have to be associated to corresponding Windows groups. Only users and user groups objects can be placed in this structure. The Windows groups are used for the Security settings. See IndustrialIT 800xA System, Administration and Security for details. 3BDS011222R4101 671 Workplace Structure Appendix A Object Structures Workplace Structure Workplace Structure holds the workplace objects defined in a system. The structure is used by the users to organize the workplaces in use. A workplace lower in the structure inherits definitions from higher level workplaces. The workplace objects types of aspect that can be placed here are numerous, and they control the layout and function of a workplace, for example tool bars and menu items. Figure 340. Workplace Structure Only workplace objects are allowed in this structure. 672 3BDS011222R4101 Appendix B Object Types Reference Information for Object Types The chapter contains detailed information about object type configuration, and explains the mechanisms used when creating and maintaining instances of an object type. The Object Type Structure contains all object types, which are defined in the system. The object types are structured into different folders called Object Type Groups. Object Type Groups All object types groups are instantiated from the predefined type Object Type Group, or a subtype of it. An example of such a subtype is the Library Version object. It is possible to refer to an object type group when you specify the allowed children below an object on the Child Control tab. Instead of enumerating all allowed object types you can specify an object type group instead (see also Child Control Tab on page 684). The object type group is set up as an aspect category, and all objects in the group will automatically get an aspect of this category. Aspects can therefore be inherited from the parent group. However, use of this functionality is no longer recommended. The preferred ways of inheriting aspects to object types is either to use supertypes or to use aspect groups. Object Types All object types are instantiated from the predefined object type Object Type (or a subtype of it). 3BDS011222R4101 673 Aspect Groups Appendix B Object Types When an object type is created it automatically gets an Object Type Definition aspect. This aspect defines the behavior of the object type. Its Configuration View has a number of tabs, and they are described in detail in Configuration Dialogs on page 678. To create an instance of an object type you use the New Object dialog, where you can browse among the object types defined in the Object Type Structure. An object type also acts as an aspect category. When an instance is created from an object type, one aspect (the Object Type Reference aspect) is created from this aspect category. This implies that all aspects on the object type, which are specified as being ‘inheritable’, are automatically available on any instance of that object type. The inheritable setting can be controlled from the Aspect Control tab (see Aspect Control Tab on page 681). The Object Type Definition aspect can specify that aspects of certain aspect categories shall be created when object instances are created. Such aspect rules can be set up using the Category Control tab (see Category Control Tab on page 682). These aspects will be created from scratch. If a type-specific initial state is wanted, aspects can be copied from the type instead and this is specified below the Aspect Control tab. Only objects of the Object Type Group, Object Type, or Aspect Group object types (or subtypes of them) may be part of the Object Type Structure, and it is only allowed to place them in one object type group. Extra insertions into other object type groups are not allowed. However, it is allowed to insert object type groups, object types, and aspect groups into other structures. Aspect Groups An Aspect Group object hold groups of aspects intended to be shared between multiple objects or object types. An aspect group is always created in the Object Type Structure, and is then assigned the aspects it should hold. For example, an aspect group called ‘Master Motor Control’ may be created which holds a documentation aspect and a faceplate aspect. An aspect of that category can then be created on different types of (compatible) motor devices. 674 3BDS011222R4101 Appendix B Object Types Aspects An instance can only be of one object type, and an object type can only have one supertype. But with aspect groups it is possible to inherited aspects from other sources. When an aspect group is created it automatically gets an Aspect Group Definition aspect. It also gets an Aspect Category Definition aspect, which makes it an aspect category object. The aspect group categories are visible in the New Aspect dialog (below Aspect Groups / Aspect Group Reference), and aspects of these categories can be added to any existing object. All aspects on the aspect group, which are specified as being ‘inheritable’, will then be inherited to the object. Aspects Object Type Definition Aspect An aspect of the Object Type Definition aspect category is required on all object type objects. It is automatically created when the object type is created, and it is named based on the name of the type. If the type is called Motor, the definition aspect will be called Motor Type Definition. Object Type Reference Aspect All instances of an object type have an Object Type Reference aspect, which is an aspect of the aspect category that the object type defines. If the type is called Motor, then this aspect will be called Motor Type Reference. The type reference aspect has the same user interface as the type definition, but all controls are read-only. If an Object Type Extension Definition aspects exists on the type, the type reference aspect will show the summary of the main type definition and the extension definitions. Super Type Reference Aspect All subtypes have a Super Type Reference aspect, which is an aspect of the aspect category that the supertype defines. If the supertype is called Motor, then this aspect will be called Motor Super Type Reference. 3BDS011222R4101 675 Aspects Appendix B Object Types The super type reference aspect has the same user interface as the type definition, but all controls are read-only. Object Type Extension Definition Aspect The Object Type Definition aspect mentioned above is a central place where rules regarding many different aspect systems can be specified. If these aspect systems are delivered from different sources, it can be hard to combine all rules in one single type definition aspect. Aspects of the Object Type Extension Definition aspect category are therefore useful, because they can incrementally add rules to the object type definition aspect. Multiple type extensions are allowed. Object Factory Aspect The Object Factory aspect is used when you want to specify category rules and child rules as in the Object Type Definition, but without actually defining an object type. This can be used for untyped singleton objects, where it feels unnecessary to create an object type for this single instance. Typical examples are the root objects of many structures, such as Service Structure, Node Administration Structure, and User Structure. Object Factory aspects can also be placed on aspect category objects for structure aspects, to control which object types are allowed at the root of a structure. See Child Control Tab on page 684. Object Type Group Reference Aspect All aspect objects in an object type group have an Object Type Group Reference aspect, which is an aspect of the aspect category that the object type group defines. If the object type group is called Motors, then this aspect will be called Motors Reference. It is used as a parent link from each member of the object type group to the object type group itself. 676 3BDS011222R4101 Appendix B Object Types Aspects Aspect Category Definition Aspect The Aspect Category Definition aspect is used internally by the system, and is necessary to make aspect inheritance possible. This aspect is automatically created on object types, object type groups, and aspect groups. Formal Instance List Definition Aspect Each formal instance list object has a Formal Instance List Definition aspect that defines which structure the formal instance objects below it should be instantiated in. Formal Instance Definition Aspect A formal instance is a child object in a composite object type, below the formal instance list. Each formal instance has a Formal Instance Definition aspect, whose Aspect Control tab defines whether the aspects on the formal instance should be inherited or copied to the actual instances. Formal Instance Reference Aspect Each child object in an instance of a composite object type has a Formal Instance Reference aspect that refers to the corresponding formal instance in the object type. Relative Name A formal instance object has a Relative Name aspect instead of the normal Name aspect. The Relative Name aspect is inherited to the actual instances, and makes it possible to use type-relative name paths in the instances. Aspect Group Definition Aspect An aspect of the Aspect Group Definition aspect category is required on all aspect group objects. It is automatically created when the aspect group is created. It has an Aspect Control tab where inheritance can be enabled or disabled for each aspect in the aspect group. 3BDS011222R4101 677 Configuration Dialogs Appendix B Object Types Aspect Group Reference Aspect When you create an aspect group, you actually define a new aspect category of the predefined aspect type Aspect Group Reference. When you use the aspect group you create an aspect of this aspect category on the objects where you want to inherit the aspects in the aspect group. This aspect that you create acts as a reference to the aspect group, and its aspect name is the same as the aspect group. Configuration Dialogs Type Info Tab The Type Info tab contains the name of the object type, and information about whether the type has a supertype and if it has subtypes. It is available on the Object Type Definition, Object Type Reference and Super Type Reference aspects. Figure 341. Type Info Tab If you want your object type to inherit characteristics of another object type, unmark the No supertype check box and use the Select button to select the wanted supertype. 678 3BDS011222R4101 Appendix B Object Types Configuration Dialogs Mark the Can be subtyped check box, to allow this object type to be subtyped by other object types. If this box is unmarked, no subtypes are allowed. The Subtype Info area displays the names of the subtypes having inherited characteristics from this object type. A subtype inherits aspects and type rules of the supertype, and can specify additional aspects and type rules. The hierarchical relation between supertype and subtype is not visualized in the tree structure. The relation is only shown on the Type Info tab, and with an additional Super Type Reference aspect that is added on the subtype. Subtyping of composite object types is not supported. Create Info Tab The Create Info tab displays information about the creation of the object type instance. It is available on the Object Type Definition, Object Type Reference and Super Type Reference aspects. 3BDS011222R4101 679 Configuration Dialogs Appendix B Object Types Figure 342. Create Info Tab In the User Role Info area, mark the Can be created by all users check box, if instances of the object type can be created by all users. Click Select to choose a specific user role, for example the System Engineer role, to create the object type instance. In the Structure Info area you specify if the object type is allowed to be created as a root object, and if it can be created in all structures or just a specific one. If you want to select a specific structure for the object type, unmark the Can be created in all structures check box and click the Select button to select the desired structure. Structure limitations is only valid for the creation of the object. It is still possible to insert the object in other structures later on. 680 3BDS011222R4101 Appendix B Object Types Configuration Dialogs If you mark the Explicit object type check box, the object type will not be available in the New Object dialog, unless it is proposed as a child in the parent’s object type. The Explicit object type field is not inherited from supertypes. It needs to be set locally on each type. This makes it possible to have hidden supertypes (marked explicit) but visible subtypes. Other specifications are inherited from supertypes, but can be overridden in subtypes. The Domain Info area should not be changed from the default setting. Aspect Control Tab The Aspect Control tab controls how the aspects on the object type are related to the aspects on instances of the object type. It is available on the Object Type Definition, Object Type Extension Definition, Object Type Reference, Super Type Reference, Formal Instance Definition, Formal Instance Reference, Aspect Group Definition and Aspect Group Reference aspects. Figure 343. Aspect Control Tab 3BDS011222R4101 681 Configuration Dialogs Appendix B Object Types Normally, aspects are inherited from the object type to all instances of the object type, but instead of inheriting an aspect, you can set up an explicit aspect rule in the type definition to copy the aspect using aspect propagation. Propagated aspects are used as initial data for the instances, and are therefore copied to each instance when the object type is instantiated. This connection is dynamic. If you add, change, or delete aspects on the formal instance, then all these changes will be propagated to already created instances. This propagation is active until the aspect on an actual instance is locally modified. If you do local changes1 on an aspect, that aspect will no longer be affected by changes on the object type because it is only the initial value that is propagated. All propagated aspects are mandatory, and cannot be removed from instances. You can add additional aspects, but if you want to remove such an aspect it must be done in the type. If the aspect has not been locally changed on an instance, then the aspect is automatically deleted on the instance when deleted on the object type. But if it has been changed, the aspect will stay on the instance and be treated as an independent local addition. The Aspect Control tab contains a list with the aspects on the object type object. An aspect can be set to be automatically copied to instances or used as a template aspect for the New Aspect dialog. A template aspect is copied to an instance only if an aspect of the same category is chosen in the New Aspect dialog. Instead of creating a new aspect from scratch, the template aspect will be used instead. An aspect can also be set up to be inherited. This setting can also be affected using the Properties page of the aspect. If the selected aspect is inherited, e.g. from a supertype, an extra field appears at the right, which shows the name of the object that owns the aspect. Category Control Tab The Category Control tab controls the new aspect dialog, automatically created aspect categories, and limitations in number of aspects on instances of the object type. It is available on the Object Type Definition, Object Type Extension Definition, Object Factory, Object Type Reference and Super Type Reference aspects. 1. 682 An aspect is regarded to be locally changed if its modification time is later than its creation time. 3BDS011222R4101 Appendix B Object Types Configuration Dialogs Figure 344. Category Control Tab You add desired aspect categories to the list by clicking the Add button. In this example, we have added a File Viewer and a General Properties aspect category. To remove a category select the category and click the Remove button. If the Create on all instances check box is marked, an aspect with the chosen aspect category is created on all instances of the object type, both new ones and existing instances. The aspect will normally be created from scratch. But if a template exists for this aspect category (see Aspect Control Tab on page 681) it will be used instead. With the Proposed when creating new aspect check box, you decide if the aspect categories should be explicitly proposed in the New Aspect dialog. If proposed aspects exist, the user must mark the Show All check box in the New Aspect dialog to see the other allowed but not proposed aspects. If the Allow other categories check box is disabled, then only aspect categories in the list are allowed on instances of the object type. 3BDS011222R4101 683 Configuration Dialogs Appendix B Object Types In the Aspect Rule area, you specify how many aspects of an aspect category that are allowed per specific instance. The default values are displayed. Max value set to –1 implies unlimited number of aspects. If min value is greater than zero then the specified number of aspects will automatically be created on the instance. The limitations on number of aspects includes both automatically created and manually created aspects. Settings inherited from a supertype cannot be overridden, so they are dimmed out. Child Control Tab The Child Control tab lets the user control which object types should be allowed as children to instances of this object type. This is specified separately for each structure. This tab is available on the Object Type Definition, Object Type Extension Definition, Object Factory, Object Type Reference and Super Type Reference aspects. Figure 345. Child Control Tab 684 3BDS011222R4101 Appendix B Object Types Configuration Dialogs To add settings for a structure, click the Add button below the Structure drop-down menu. In our example Functional Structure has been added. The list in the tab contains object types that have some settings for the specified structure. Use the Add button below the list to add an object type. In our example a Pump object type is added. Use the Propose when creating new child check box, to set the object type (or object types in the group), to be explicitly proposed to a user in the New Object dialog. If proposed object types exist, the user must mark the Show All check box in the New Object dialog to see the other allowed but not proposed object types. In the Child Rule area you determine how many child objects of the object type (or object types in the group), there can be for instances of the object type. If the max value is set to –1, the number of child objects are unlimited. If the min value is greater than zero, then this number of child objects will automatically be created below the instances. The Allow other object types setting is for the specified structure. It determines whether child objects of any object type are allowed for the instances, or if only the types in the list are allowed. When the Is Group column is marked (x), the added object type is in fact an object type group. The result will be that settings will be done for all object types in the group, see Figure 346. 3BDS011222R4101 685 Configuration Dialogs Appendix B Object Types Figure 346. Select Group of Object Types In the Child Sort Order area, you specify how the children created under this object type should be sorted. By default, the As Default radio button is selected. This means that the configuration set up for the Plant Explorer is used as sort order. Rules inherited from a supertype can only be overridden if they have the default values, otherwise they are dimmed out. If a setting is inherited from a supertype and it refers to an object type that has subtypes, then a Reduce button appears. When you click on that button you get a dialog box where you can reduce the proposed object type to a subset of the available subtypes. To specify the allowed and proposed object types at the top of a structure, an Object Factory aspect (and possibly additional Object Type Extension Definition aspects) can be placed on the aspect category object of the structure. The Child Control settings will in this case apply to the top level of the structure. 686 3BDS011222R4101 Appendix B Object Types Configuration Dialogs Composite Info Tab The Object Type Reference aspect of a composite instance has an additional tab, the Composite Info tab that shows the embedded instances of the composite instance. Figure 347. Composite Info Tab 3BDS011222R4101 687 Configuration Dialogs Appendix B Object Types Consistency Tab The Consistency tab is used to activate consistency checking and correction on one specific object type or object type instance. If the object is composite, the children will be checked as well. This tab is available on the Object Type Definition, Object Type Extension Definition, Object Factory, Object Type Reference, Super Type Reference, Formal Instance Definition and Formal Instance Reference aspects. Figure 348. Consistency Tab The consistency checking is the same as performed by the Consistency Checker aspect, except that only the aspects belonging to the Object Types aspect system will be checked here. The consistency of user-added aspects will not be checked. The Try to Repair button is activated if inconsistencies are detected during a consistency check. If you press it the inconsistency may, if possible, be removed. It is recommended to make a backup before using the repair function. 688 3BDS011222R4101 Appendix B Object Types Configuration Dialogs Formal Instance List Definition Aspect Figure 349. Formal Instance List Definition Aspect View The Formal Instance List Definition aspect makes it possible to change the wanted instantiation structure of a formal instance list after it has been created. 3BDS011222R4101 689 Composite Object Types Appendix B Object Types Composite Object Types Formal instances are used when composing composite object types. Composite object types let the user create object types that when instantiated produces multiple objects in a structured way. This is illustrated in Figure 350. Figure 350. Composite Object Type and Instance The object type group contains two simple object types, AI and DI, and one composite object type Tank that has two formal instances of AI and DI. One instance of the composite object type is also shown in Figure 350. 690 3BDS011222R4101 Appendix B Object Types Composite Object Types Functional Structure object below Tank is a Formal Instance List object that determines which structure the branch below it will be created in. The AI1 and DI1 objects below the Tank object are formal instances, which in reality makes the object type a composite object type. A formal instance is an object type instance that can be configured as any other instance. When a composite object type is instantiated all formal instances are instantiated to real instances, which are copies of the formal instances. Every formal instance object has a Formal Instance Definition aspect, and actual instances of the formal instance have a corresponding Formal Instance Reference aspect. Terminology A composite object type describes a set of objects organized in structures, with a parent object and one or several child objects. The children in a composite object type are called formal instances, because they instantiate object types defined elsewhere in the Object Type Structure but they are not actual instances. When a composite object type is instantiated, actual instances are created for these child objects. A composite object type includes a description of how its child objects shall be inserted into different structures when the composite object type is instantiated. The instantiation is described separately for each structure using a formal instance list. Below the formal instance list the desired object hierarchy for a certain structure is specified. Formal Instance List Formal Instance Figure 351. Composite Object Type 3BDS011222R4101 691 Composite Object Types Appendix B Object Types When you instantiate a composite object type you get a composite object instance. The composite instance is one single unit, although it can include several child objects that are spread out in different structures. The child objects that belong to the composite instance are called embedded instances. Instances that are not controlled by a surrounding composite instance are called independent instances. Independent Instance Embedded Instance Figure 352. Composite Instance The main type object and the formal instance objects can belong to several formal instance lists (by using several structure aspects on the same object). In the actual instance, only one physical child object will be created, but it will be shown in all the wanted structures. The formal instance lists are placed directly below the top object of the composite type. The main type object itself must be repeated, using an additional structure aspect, in each formal instance list where you want the object to be visible. (When you create a formal instance list object using the Plant Explorer, it will automatically insert the top-level type object below the formal instance list.) This allows you to define target structures where only some child objects will be instantiated and not the top object itself. Instantiation of Composite Types The top object is always instantiated below the current insertion point, as for noncomposite types. If there is a formal instance list for the current structure with the top object inserted and formal instances below it, then corresponding actual subobjects will be created below the instantiated top object. If there are formal instance lists that specify instantiation in other structures (or formal instances directly below a formal instance list), these instance trees will be placed at the top of those structures. 692 3BDS011222R4101 Appendix B Object Types Composite Object Types Instances of the composite type must follow the structure defined by the type, and instances must be created and deleted as a whole unit. For example, it is not possible to instantiate only a part of a composite type, or to delete a child object from an instance of a composite type. It is allowed to add additional structure aspects or child objects to an actual instance, without defining corresponding formal instances in the type. The type only defines a minimum structure for the instance, not the complete structure. The minimum structure can be extended in each instance, but not reduced. In the same way, it is allowed to create additional subobjects below any formal instance. They will be treated as normal formal instances, and be propagated to the actual instances. The formal instances themselves can also be of composite types, and they must follow the same restrictions as actual instances. The types rules are here interpreted in the context of the structure specified by the formal instance list, and not the Object Type Structure. Structure Propagation When you make type changes they take effect immediately. You can add or remove formal instances, and already instantiated objects of the composite type will directly be updated accordingly. When a structure aspect is deleted below a formal instance list, the change is always propagated to all corresponding embedded instances. If a formal instance is removed completely from the type, all corresponding embedded instances will be deleted as well. However, this delete operation will be made using the Obsolete Handling functionality, which saves the deleted aspect in an import/export file and stores the file using File Set Distribution. This makes it possible to retrieve deleted aspects and place them on some other object. To retrieve an obsolete-handled aspect, go to the Obsolete Structure and expand the object named with the current date. Below it you find objects representing obsoletehandled delete operations. Select the object with the name “Formal Instance Delete” and the time for the operation, e.g. “14:55:33”. Open its Obsolete Objects aspect, and click on the Open import/export file button. This will open the Import/Export tool with the wanted file, where you can drag wanted aspects back to the system. 3BDS011222R4101 693 Creating an Object Icon Aspect Appendix B Object Types Aspect Propagation The aspects on the formal instances are configured using the Aspect Control tab of the Formal Instance Definition aspect, in the same way as aspects on the top-level object of the composite type are configured in the Object Type Definition aspect. The only difference is that the Copy to all instances check box is marked by default for formal instances, and not the Inherit to all instances check box. But aspect propagation can be disabled, or replaced with inheritance, using the Aspect Control tab. If the formal instance itself is an instance of an object type, that object type defines the initial set of aspects for the formal instance. These aspects can then be modified, and new aspects can be added. Relative References in Composite Types To make the composite object type really useful you want to do as much aspect configuration as possible on the object type. For example, you may want to add a Graphic Element aspect on the main type object that either presents data retrieved from its child objects or incorporates subordinate Graphic Elements that already exist on the child objects. To be able to reference the child objects correctly in all composite instances, we use relative references. All formal instances have a Relative Name aspect that is inherited to the corresponding embedded objects in the actual instances. The embedded objects also have a local Name aspect that initially gets the same value, but it can be changed by the user to an instance-specific name. Using the inherited and fixed relative names, an embedded object can still be identified using a relative name path consisting of a series of relative names. Note that the Graphics Builder automatically inserts such relative references when you create a graphics aspect on an object type. Creating an Object Icon Aspect If you create a new object type, you are also able to select its object icon. The object icon will be displayed in the object browser in Plant Explorer. In this document we do not describe how you create icons using one of the many possible graphical editors, we just describe how you use an available icon. 694 3BDS011222R4101 Appendix B Object Types Creating an Object Icon Aspect Follow the steps below to add an Object Icon aspect: 1. Add a new Object Icon aspect to the object type. 2. Right-click on the Object Icon aspect and select the config view. In the config view, a dialog box with three main buttons is displayed - Set Icons, Add Icons and Store Icons: – With the Set Icons button you set the default icon. – With the Add Icons you add icons to the aspect’s icon file. – With the Store Icons you can store the icons in a separate file and make them accessible in other software. Figure 353. Selecting an Icon 3. Browse the file system for the icon you have built and select it. 4. Click the Apply button. You have now added and selected an icon as default object icon to the object type, or added an icon to the aspect’s icon file. Icons added to the aspects icon file are seen 3BDS011222R4101 695 Creating Other Aspects Appendix B Object Types as consecutive numbers in the Additional Icons area. Each figure in this area represents an icon. The Object Icon aspect on the object type will be inherited to all instances of that type. Only one image of the icon is shown in the config view (small or large), but the other size (large or small) is synthesized if needed. If you subtype an object type with an Object Icon aspect, you must copy the icon aspect to the subtype. The Object Icon aspect can only be inherited one level. Creating Other Aspects Build the additional aspects of your choice to complement the object type: Graphical aspects, faceplates, web aspects, windows application aspects, control aspects, your own aspects etc. When you create aspects on an object type using the Plant Explorer, they will automatically be inherited to instances of that type (if the aspect category allows it). 696 3BDS011222R4101 Appendix C FDA 21 CFR Part 11 Support Introduction The Food and Drug Administration (FDA) issued 21 CFR Part 11 in response to the pharmaceutical industry's request to utilize paperless record systems under the current good manufacturing practice (cGMP) regulations in parts 210 and 211 (21 CFR parts 210 and 211). Part 11 went into effect on August 20, 1997. The regulation does not require a manufacturer to maintain records electronically. However it does provide the criteria under which the FDA will consider electronic records to be equivalent to paper records. Part 11 primary concern is security of record authenticity and reliability of the electronic records created by a system. It must be ensured that data and records can not be modified without recording details of change. It must be ensured that electronic signatures can not be falsified. Table 21. Terms Term Description FDA Food and Drug Administration, USA cGMP Current Good Manufacturing Practices Validation Establishing documented evidence that provides a high degree of assurance that a process, system, equipment or assay will consistently produce the desired results according to predetermined specifications and quality attributes CFR Code of Federal Regulations 3BDS011222R4101 697 Introduction Appendix C FDA 21 CFR Part 11 Support Table 21. Terms Term Description Electronic Record “… any combination of text, graphics, data, audio, pictorial, or other information representation in digital form that is created, modified, maintained, archived, retrieved, or distributed by the system.” Electronic Signature “… a computer data compilation of any symbol or series of symbols executed, adopted, or authorized by an individual to be the legally binding equivalent of the individual’s handwritten signature.” Feature Category Section references from 21 CFR Part 11 Regulation Authorization Aspect Operation (function) access control SubPart B, Sec 11.10: (g) Access Control System Access (i.e. logon) SubPart B, Sec 11.10: (d) Electronic Signature User identity verification during operation on a record SubPart B, Sec 11.50: (a) Subpart B, Sec 11.70 Subpart C, Sec 11.100: (a) Subpart C, Sec 11.200: (a) ,(1), (i), (ii), (3) Subpart C, Sec 11.300: (a), (b), (d) Versioning “Ability to discern invalid or altered records…” SubPart B, Sec 11.10: (a), (e) Audit Trail “Use of secure, computer-generated, time-stamped audit trails to indepependently record the date and time of operator entires and actions…” SubPart B, Sec 11.10: (a), (e) SubPart B, Sec 11.50: (a), (b) Archive “The ability to generate accurate and complete copies of record in both human readable and electronic form suitable for inspection, review and copying by the agency.” “Protection of records to enable their accurate and ready retrieval throughout the records retention period.” SubPart B, Sec 11.10: (b), (c) SubPart B, Sec 11.50: (b) System Checks “Use of operational system checks to enforce permitted sequencing of steps and events, as appropriate.” “Use of device (e.g. terminal) checks to determine, as appropriate, the validity of the source of data input or operational instruction.” SubPart B, Sec 11.10: (f), (h) Figure 354. Mapping of Regulation Parts to System Features The 800xA system comprises functions needed to support validation of an automated manufacturing process regarding its electronic records according to FDA 21 CFR Part 11 as listed in Figure 354. 698 3BDS011222R4101 Appendix C FDA 21 CFR Part 11 Support Authorization Compliance to Part 11 is an absolute, non-negotiable requirement for systems installed in manufacturing environments subject to FDA regulations. Primarily this applies to the life sciences industry, but it can also apply for other industries. Authorization System 800xA Security supports Authorization & Access Control according to a 3 dimensional model: Person, Object, Function. All combinations within the three dimensions are allowed with individual profiles for each person. Authorization is provided by System 800xA Security as described in Security on page 250 and Authorization on page 251. Access Control Access Control is provided by System 800xA Security and Advanced Access Control as described in Security on page 250 and Access Control on page 251. Electronic Signature The Digital Signature Server is a service that allows a user to electronically sign a document according to the requirements from the American Food and Drug Administration (FDA). The Digital Signature Server is also used to verify who signed the document, when it was signed and that a document is unchanged since it was signed. The Digital Signature Server implements this functionality by using the Windows Crypto API to calculate a hash key for the document together with a private-public key pair to bind the signature to an authenticated windows user. Electronic Signature support is provided by System 800xA Security and Electronic Signature as described in Electronic Signature on page 254. All aspects support Digital Signature, it is generated and linked to the aspect. Electronic documents typically are contained in Document Manager aspects or FileViewer Aspect (e.g. User SOPs). For Document Manager aspects the 1st and 2nd signature properties are read accessible and can be displayed in document footers as well as in Bulk Data Management worksheets. 3BDS011222R4101 699 Versioning and Life Cycle Management Appendix C FDA 21 CFR Part 11 Support Versioning and Life Cycle Management Versioning and Life Cycle Management is provided by System 800xA through System Configuration Versions and System Synchronization as described in Versioning and Life Cycle Management on page 255. In addition, Batch Management provides on-line versions for the recipe procedure model. Audit Trail Audit Trail is provided by System 800xA as described in Audit Trail on page 259. Additionally Windows Audit Trail configured by user can be enabled and archived with Microsoft or Third Party tools. Archive Archiving is provided by System 800xA by Information Management History Services as outlined in Archive on page 262 and described in Historical Process Data on page 219. System and Device Checks System and Device Checks are covered by all functional areas of the 800xA system. Examples are outlined in System and Device Checks on page 262. National Language & Training Users must operate in their native language. System 800xA allows Operation environment to be translated to native languages. 700 3BDS011222R4101 Appendix C FDA 21 CFR Part 11 Support SOPs for Part 11 and cGMPs SOPs for Part 11 and cGMPs Depending on the concrete project Standard Operating Procedures (SOPs) for an application subject to FDA Part 11 and cGMP could be provided by the delivering ABB division or an OEM house or the customer. 3BDS011222R4101 701 SOPs for Part 11 and cGMPs 702 Appendix C FDA 21 CFR Part 11 Support 3BDS011222R4101 Appendix D SMS and E-Mail Messaging Setup and Configuration Worksheets The following tables are worksheets to help in setting up and configuring SMS and e-mail Messaging. • Table 22: GSM Hardware Setup Worksheet. • Table 23: Aspect System Structure Setup Worksheet. • Table 24: Users Worksheet. • Table 25: User Setup Worksheet. • Table 26: Configuration Worksheet. The worksheets are also designed to be used as configuration records. Each one starts on a new page for ease of copying. Keep these records in a safe place for future backup/restore or upgrade activities. It is very important to read, understand, and follow the setup and configuration procedures (see SMS and e-mail Messaging on page 376), before filling in the worksheets. 3BDS011222R4101 703 Setup and Configuration Worksheets Appendix D SMS and E-Mail Messaging Table 22. SMS and e-mail Messaging GSM Hardware Setup Worksheet Item Setting/Value Spooler Settings Activate Outbox Spooler Checked (check and leave checked) Activate Inbox Spooler Checked (check and leave checked) Interval for Checking for Incoming Messages Value: _____ Seconds Minutes (circle 1) Port Settings COM Port Value: COM _____ Baud Rate Value: _____ Data Bits Value: _____ Parity Value: _____ Stop Bits Value: _____ PIN and Properties Query PIN Checked or Unchecked (circle one) PIN (only if Query PIN is checked) Value: ___________________ Save PIN (only if Query PIN is checked) Checked or Unchecked (circle one) Own Number (telephone number of SIM card (including Country Code) in GSM Value: ___________________ hardware) Initialization String for GSM Hardware 704 Value: _______________________________ _______________________________ _______________________________ _______________________________ 3BDS011222R4101 Appendix D SMS and E-Mail Messaging Setup and Configuration Worksheets Table 22. SMS and e-mail Messaging GSM Hardware Setup Worksheet (Continued) Item Setting/Value General Service Properties Name (GSM service provider) Value: ___________________ Port Value: COM _____ SMSC Value: ___________________ Default Country Code Value: ___________________ Default Prefix Value: ___________________ Number of Attempts Value: ___________________ Splitting Service Properties Splitting Checked or Unchecked (circle one) Optimize Splitting Checked or Unchecked (circle one) Enumerate Splitting Checked or Unchecked (circle one) Narrowband Sockets Checked or Unchecked (circle one) Messaging Service Properties Add Before Message Blank (verify and do not change) Use for Delivery Notification Only Unchecked (verify and do not change) Default Option 0 (verify and do not change) Message General Properties Replace CR LF for Incoming Messages Checked or Unchecked (circle one) 3BDS011222R4101 705 Setup and Configuration Worksheets Appendix D SMS and E-Mail Messaging Table 23. SMS and e-mail Messaging Aspect System Structure Setup Worksheet Item Setting/Value Modem Device Aspect Phone Number (default pager service provider’s Central Paging Terminal telephone number) Value: ___________________ Email Device Aspect 706 From (default e-mail address where error messages (e.g. undeliverable mail) are sent) Value: ___________________ SMTP Relay Server (default domain name or IP address of SMTP relay server) Using SMTP Relay Server? Yes or No (circle one) Value: ___________________ 3BDS011222R4101 Appendix D SMS and E-Mail Messaging Setup and Configuration Worksheets Table 24. SMS and e-mail Messaging Users Worksheet User Group (Check all that Apply) User Name Admin App Eng Everyone Oper SW Dev SW Eng User Groups Created √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ 3BDS011222R4101 707 Setup and Configuration Worksheets Appendix D SMS and E-Mail Messaging Table 24. SMS and e-mail Messaging Users Worksheet (Continued) User Group (Check all that Apply) User Name Admin App Eng Everyone Oper SW Dev SW Eng User Groups Created √ √ 708 3BDS011222R4101 Appendix D SMS and E-Mail Messaging Setup and Configuration Worksheets Table 25. SMS and e-mail Messaging User Setup Worksheet User Name: ___________________________________ Week of (week begins on Sunday): ________________ Message Subscriber Aspect Device Value Priority SMTP/Email TAP/Modem SMS/GSM Message Schedule Aspect Delivery Option Always deliver Always Start Time Delivery Based on Schedule Hour Min End Time Hour Min Sunday Monday Tuesday Wednesday Thursday Friday Saturday Never Deliver 3BDS011222R4101 Never 709 Setup and Configuration Worksheets Appendix D SMS and E-Mail Messaging Table 26. SMS and e-mail Messaging Configuration Worksheet Item Setting/Value Alarm and Event Message Source Aspect Alarm List (Alarm and Event List to monitor) Value: __________________________________ Message Action Selection (check one) Option Only send message if previous alarm condition was acknowledged (also requires Basic and/or Soft Alarm configuration in Service Structure) Always send message Message Configuration Item in Name Column Selection Order System Name Event Time Object Name Condition Sub Condition Priority Severity Category Message Description Actor Guid 710 Prefix Value: ________________________ Suffix Value: ________________________ Field Delimiter Value: ________________________ Message Length Value: ________________________ 3BDS011222R4101 Appendix D SMS and E-Mail Messaging Setup and Configuration Worksheets Table 26. SMS and e-mail Messaging Configuration Worksheet (Continued) Item Setting/Value Message Handler Aspect Message Source (Alarm and Event Message Source to send messages from) Value: __________________________________ Enabled Check Box Checked Destination Basic Alarms Soft Alarms 3BDS011222R4101 User or Group Name Unchecked (circle one) Enabled Priority Yes No Timeout (s) Attempts New Alarm When Condition Gets Active Checked Check Box Unchecked (Circle one) New Alarm When Condition Gets Active Checked Check Box Unchecked (Circle one) 711 GSM Service Providers Appendix D SMS and E-Mail Messaging GSM Service Providers Table 27. GSM Service Providers GSM Service Provider1 SMSC Number2 GSM Service Provider SMSC Number A1 - GSM (A) +436640501 Omnipoint - GSM (USA) +19179070004 Aerial Comms - GSM (USA) +18132630025 Optus - GSM (AUS) +61411990000 Airtel - GSM (E) +3407133000 Orange - GSM (GB) +44973100973 BellSouth - GSM (NZ) +6421600600 OTE Hellas - GSM (GR) +303850116005 Buoygues - GSM (F) +33660003000 Pacific Bell - GSM (USA) +12099042010 Celcom - GSM (PTM) +60193900000 Panafon - GSM (GR) +3094219000 CellNet - GSM (GB) +44802000332 Pannon - GSM (H) +36209300099 Comviq - GSM (S) +46707990001 Polkomtel - GSM (PL) +48601000310 Connex - GSM (RO) +4092004000 Postur og Simi - GSM (IS) +3548900100 D1 Telekom - GSM (D) +491710760000 Powertel - GSM (USA) +13343338200 D2 Message Plus - GSM (D) +491722270333 Proximus - GSM (B) +3275161616 VodaFone D2 - GSM (D) +491722270000 PTT - GSM (L) +352021100003 Eircell - GSM (IRL) +35387699989 PTT - GSM (NL) +31653131313 EMT - GSM (EW) +3725099000 Radiolinja - GSM (SF) +358508771010 E-Plus - GSM (D) +491770600000 Radiomobil - GSM (CZ) +420603051 Era GSM - GSM (PL) +48602951111 +6281615 Esat - GSM (IRL) +353868002000 SingTel - GSM (SGP) +6596400001 Europolitan - GSM (S) +46708000708 +358405202000 Eurotel - GSM (CZ) +420602909909 Sonofon - GSM (DK) +4543625250 Fido - GSM (CDN) +15149931123 Sprint - GSM (USA) +17044100000 Globe - GSM (PI) +6391702 Swisscom - GSM (CH) +41794998121 712 Satelindo - GSM (RI) Sonera - GSM (FIN) 3BDS011222R4101 Appendix D SMS and E-Mail Messaging GSM Service Providers Table 27. GSM Service Providers (Continued) GSM Service Provider1 SMSC Number2 GSM Service Provider SMSC Number GSM-XL - GSM (RI) +62818445009 Telcel - GSM (P) +351931770077 HK Telecom - GSM (HK) +85290217572 TeleDanmark - GSM (DK) +4540590000 Hutchinson - GSM (HK) +85294985795 Telefonica - GSM (E) +3409090909 Itineris 1800 - GSM (F) +338366320766 Telekom - GSM (SF) +358405202000 Itineris 900 - GSM (F) +33007001080 TeleNor - GSM (N) +4790002100 Lebancell - GSM (RL) +9613488888 Telestet - GSM (GR) +3093599000 Libertel - GSM (NL) +316540881000 Telia - GSM (S) +46705008999 LMT - GSM (LV) +3719202020 Telkomsel - GSM (RI) +62811130004 max.mobil - GSM (A) +43676021 Telstra - GSM (AUS) +61418706700 Maxis - GSM (PTM) +60120000015 TIM - GSM (I) +393359609600 Microcell Telecom - GSM (USA) +15149931123 TMN - GSM (P) +351936210000 Mobile One - GSM (SGP) +6596845999 Turkcell - GSM (TR) +905329010000 Mobistar - GSM (B) +32495002530 o2 - GSM (D) +491760000443 MTN - GSM (ZA) +27831000002 Vodacom - GSM (ZA) +27829119 Mutiara - GSM (PTM) +60162999000 Vodafone - GSM (AUS) +61415011501 Natel-D - GSM (CH) +4179191 Vodafone - GSM (GB) +44385016005 NetCom - GSM (N) +4792001000 Voicestream - GSM (USA) +12063130004 North West - GSM (RUS) +78129600096 Washington PCS - GSM (USA) +1410258953 3BDS011222R4101 713 GSM Hardware Devices Appendix D SMS and E-Mail Messaging Table 27. GSM Service Providers (Continued) GSM Service Provider1 Omni - GSM (I) SMSC Number2 GSM Service Provider SMSC Number +393492000200 Westel900 - GSM (H) +36309888000 NOTE: 1. This table lists GSM service providers and their SMSC numbers as of the original publication of this instruction. The exclusion of GSM service provider information is not intended to imply that the GSM service provider is not compatible with SMS and e-mail Messaging. ABB recommends all GSM service providers and their SMSC numbers, whether or not they appear in this table, be tested and verified before using SMS and e-mail Messaging. 2 The SMSC numbers provided by the configuration software of the Derdack GSM modem driver are subject to change. Please verify the number for your provider before you commission your SMS and e-mail Messaging GSM application. GSM Hardware Devices Table 28. GSM Hardware Devices GSM Hardware1 714 Initialization String Tested by ABB Ericsson SH888 AT+CNMI=0,0,0,0 AT+CPMS=”ME”,”ME” Yes Ericsson T39M AT+CNMI=3,0,0 AT+CPMS=”ME”,”ME” Yes Ericsson T65 Refer to manufacturer’s documentation Yes 3BDS011222R4101 Appendix D SMS and E-Mail Messaging GSM Hardware Devices Table 28. GSM Hardware Devices (Continued) GSM Hardware1 Initialization String Tested by ABB Ericsson GM25 GSM Module AT &F0 &W0 &Y0 Z0 ATEO &D ATV=1 *EDIF=0 AT*I106=0,0,0,0,0,0,0,0 AT*I107=0,0,0,0,0,0,0 AT*I109=0,0,0,0,0,0,0 *IDF=0,8,0,1 AT*IACT=0,0,0 +IFC=0,0 +FLO=0 AT+EB=0,0,0 +ES=3,1,3 AT*ECAM=0 AT+CNMI+3,1,0,0 No Falcom A1 AT+CMGF=0 Yes Nokia 30 GSM Connectivity Terminal AT+CMGF=0 AT+CNMI=1,0,0,1 AT+CPMS="SM","SM" No Nokia 6210 AT+CNGF=1 AT+CNMI=2,2 Yes Nokia 9000(i)/9110 Communicator AT+CNMI=1,2 Yes Nokia Cellular Data Suite AT+CPMS=”SM”,”SM” AT+CNMI=1,0 AT+CSCS=”HEX” Yes Siemens M1 No initialization necessary Yes Siemens M20 AT+CMGF=0 No Siemens S45 AT+CMGF=0 AT+CMGF="ME","ME" No Wavecom AT+CMGF=0 AT+CNMI=1,0,0,1 AT+CPMS="SM","SM" Yes 3BDS011222R4101 715 GSM Hardware Devices Appendix D SMS and E-Mail Messaging Table 28. GSM Hardware Devices (Continued) GSM Hardware1 Westermo GD-01 Initialization String AT+CSCS=”HEX” Tested by ABB Yes NOTE: 1. This table lists specific types of GSM hardware and their initialization strings as of the original publication of this instruction. The exclusion of GSM hardware information is not intended to imply that the GSM hardware is not compatible with SMS and e-mail Messaging. ABB recommends all specific types of GSM hardware and their initialization strings, whether or not they appear in this table, be tested and verified before using SMS and e-mail Messaging. 716 3BDS011222R4101 INDEX Numerics 21 CFR Part 11 697 800xA Core System 800xA OPC-Client Connection 59 AC800M/C Connect 58 Advanced Access Control 59 Asset Monitors 58 Audit Trail 59 Calculation Engine 59 Connectivity options 59 Diagnostics Collection 58 Digital Signature 59 Engineering Workplace 58 to 59 OLE-DB Real Time Data-Client Connection 59 Operator Workplace 58 to 59 Plant Explorer 58 Primary History Logs 58 Redundant Aspect Server 58 Scheduler 58 SMS and e-mail Messaging 59 Softpoint Server 58 System Synchronization 58 Topology Designer 58 Topology Status Viewer 58 A AC 800M/C Connect 147 AC 800M/C Controller Connectivity 147 Access Control 251, 573, 699 Acknowledge Alarm 187 ActiveX Wrapper 248 3BDS011222R4101 ActiveX Wrapper Aspect Add 566 Create 566 Additional aspects 110 Additional Info Tab 629 Advanced Access Control 573 Alarm Acknowledge 187 List 187 Server 188 Alarm and Event 182 Alarm and event buffer 194 Alarm and event list Configuration 417 Alarm list tab 422 Edit length dialog box 424 Message configuration tab 423 Alarm and event message source Configuration 420 Alarm Band 187 Alarm Expression 188 Alarm list tab 422 Alarms and Events 375 Allocatable Group 161 allocating disk space 237 Allocation 161 AO asset condition history report 278 AO calibration report 278 AO running time report 278 Application server 65 Application Software DownloadApplication Software 717 Index Test 324 Generate 324 Archive 262, 607, 700 archive 237 device 238 entry 239 group 238 guidelines 240 media 238 archived logs access 239 Aspect Control Properties 484 Aspect Category Definition 677 Aspect Control Tab 337, 674, 681 Aspect Express 287 Aspect Group 674 Aspect Group Definition 677 Aspect Group Reference 678 Aspect Object Object types provided with the release 350 Aspect Object Concept 70 Aspect Propagation 111, 682, 694 Aspect Server 65, 147 Aspect Studio 288 Aspect system structure Email device 399 Modem device 396 Aspects 73 Asset condition and monitoring system Asset monitoring 268 Asset condition reporting 267 Asset reporter 268 Asset tree 267 Asset viewer 267 Asset Monitoring 608 Asset monitoring 268 Basic asset monitors 269 Bad quality check 269 Bool check 269 Flow delta 269 718 High limit check 270 Highlow limit check 270 Low limit check 270 Running time check 270 XY profile deviation 270 FOUNDATION fieldbus asset monitors 272 HART asset monitors 272 PC, network and software monitoring 270 PROFIBUS asset monitors 273 Asset Optimization 62, 263, 323, 608 Asset Monitoring 62 DMS Calibration Integration 62 Maximo Integration 62 PC, Network and Software Monitoring 62 PC, Network and Software Monitoring for Engineering 62 SAP / Plant Maintenance Integration 62 Asset optimization Asset condition and monitoring system Asset monitoring 268 Asset condition reporting 267 Asset reporter 268 Asset tree 267 Asset viewer 267 Asset monitoring 268 Asset optimization PROFIBUS asset monitors 273 Basic asset monitors 269 Basic asset monitors, bad quality check 269 Basic asset monitors, bool check 269 Basic asset monitors, flow delta 269 Basic asset monitors, high limit check 270 Basic asset monitors, highlow limit check 270 Basic asset monitors, low limit check 270 Basic asset monitors, running time check 270 Basic asset monitors, XY profile deviation 270 3BDS011222R4101 Index FOUNDATION fieldbus asset monitors 272 HART asset monitors 272 PC, network and software monitoring 270 Asset tree 267 Asset viewer 267 Bad quality check asset monitor 269 Basic asset monitors 269 Bad quality check 269 Bool check 269 Flow delta 269 High limit check 270 Highlow limit check 270 Low limit check 270 Running time check 270 XY profile deviation 270 Bool check asset monitor 269 CMMS 275 Flow delta asset monitor 269 FOUNDATION fieldbus asset monitors 272 Functional components 265 HART asset monitors 272 High limit check asset monitor 270 Highlow limit check asset monitor 270 Low limit check asset monitor 270 Overview 263 PC, network and software monitoring 270 Running time check asset monitor 270 SAP integration 275 XY profile deviation asset monitor 270 Asset optimization reporting 277 AO asset condition history report 278 AO calibration report 278 AO running time report 278 Inputs 277 Output 277 Asset reporter 268 Asset Structure 658 Asset tree 267 Asset viewer 267 3BDS011222R4101 Attempts field 430 Audit Trail 115, 259, 606, 700 Configuration 606 Authentication 252, 573 Authorization 251, 573, 699 Automation Solution 151, 369 B Bad quality check asset monitor 269 Basic asset monitors 269 Bad quality check 269 Bool check 269 Flow delta 269 High limit check 270 Highlow limit check 270 Low limit check 270 Running time check 270 XY profile deviation 270 Basic engineering tools for Engineering System 60 Basic Object Types 85, 92, 100, 104 Basic Structures 80, 312 Batch client 66 Batch Management 61, 214, 323 Batch Advanced Phases 61 Batch Client 61 Batch Equipment 61 Batch Management Engineering 61 Batch Procedures 61 Batch Schedule Interface 61 Batch Server 61 Batch Server Redundant 61 Block diagram 203 Bookmark Aspect 561 Bool check asset monitor 269 bring on line 540 Buffer 194 Built 176 Bulk Configuration 535 Property Logs 535 Bulk Data Applications 138 719 Index Bulk Data Management 132 Bulk Data Manager 132 C Category Control Tab 338, 674, 682 Central paging system 398 CFR 697 cGMP 697 Child Control Tab 684 Client 66 client 308 client/server network 65 CMMS 275 CMMS integration 275 Code Generation 161 COM port settings 392 SMS/GSM hardware device 382 Component view 157, 169 Composite Control Object Types 350 Composite Info Tab 687 Composite Object 690 Composite Object Type 691 Composite Object Types 109, 345 Comunication Board 320 Configuration Additional DMS 611 Operational structures 417 Alarm and event list 417 Alarm and event message source 420 Message handler 425 SMS and e-mail messaging 417 Configure alarms and events 191 Connectivity 147 Connectivity Server 147 Connectivity server 65 Consistency Checker 688 Consistency Tab 688 Control and I/O AC800M Process Control Software 720 Integration 60 SoftController 60 Control and IO 60 Control Builder M Professional 147 Control Connection aspect 625 Control Designation 82 Control Hardware Units 166, 373 Control Logic 151, 369 Add Specific 321 Control Loop 320 Control Module Graphics 164 control network 65 Control Object Types 350 Control Reference Designations 93 Control Structure 82, 92, 94, 312, 317, 320 Aspect Object Creation 351 Controller 66, 320 Controller Code Download 324 controllers 65 Create Info Tab 679 Customization 309 D data archive 238 presentation 231 data collection event-driven 227 Data Exchange 142 Data Flow Order 160 Data Source Definition 621 DCOM Security Settings 640 Deploy 172 Design 322 Design Information 315 Designation 81 Destination tab 428 Developer Engineering Tools Aspect Express 60 3BDS011222R4101 Index Aspect Studio 60 Device Checks 262, 607, 700 Device Management 62 FOUNDATION Fieldbus 62 FOUNDATION Fieldbus Device Integration 63 FOUNDATION Fieldbus Device Integration for Engineering 63 HART 62 HART Device Integration 62 HART Device Integration for Engineering 62 HART Multiplexer Connect 62 PROFIBUS 62 PROFIBUS Device Integration 63 PROFIBUS Device Integration for Engineering 63 Diagram view 157, 169 digital signature 254 direct log type 223 Distributed Engineering 142 DMS Calibration Integration 611 DMS calibration integration 275 Additional configuration 611 Document Management 245, 541 Document Manager 312, 541 Documentation 104, 541 Documentation Designation 82, 105 Documentation Reference Designations 107 Documentation Structure 82, 104, 312, 319 Finalize 323 Domain Server 65 DNS 65 Domain Controller 65 Domain Name System 65 Double Authentication 573 Double-authentication 252 Download 162 Download and Upload DTM Data Set 465, 496 Dynamic Documents 246 3BDS011222R4101 E Edit destination dialog box 430 Edit length dialog box 424 Electronic Record 698 Electronic Signature 254, 574, 698 to 699 Element Browser 172 Email device 399 Message subscriber 403, 406 Relay server 394, 400 E-mail test utility 394 Embedded Instance 692 Engineering 59 Engineering System 60 Engineering Workplace 59 Engineering System 66 Engineering Workplace 57 to 59, 66 Aspect Express 60 Aspect Studio 60 Developer Engineering Tools 60 Library Assistant 60 Professional Engineering Tools 60 Reuse Assistant 60 Script Manager Professional 60 Standard Engineering Tools 60 Enumerate 388 Event List 187 Event Server 188 event-driven data collection 227 export 540 Export and Import DTM Data Set 465 Expression Builder 172 Extend Configuration 323 Extended Configuartion Data 537 Extended Configuration Data 240 External Alarm 188 F FDA 697 Field delimiter 424 Field Devices 205, 435, 474, 498 721 Index Fieldbusses 65 Fielddevices 205 File Viewer 247 File Viewer Aspect 545 How to use 546 File Viewer Functions 552 Flow delta asset monitor 269 Food and Drug Administration 697 Formal Instance 677, 690 Formal Instance Definition 677 Formal Instance Delete 693 Formal Instance List 347, 691 Formal Instance list 113 Formal Instance List Definition 677, 689 Formal Instance Reference 677 Formatted Templates 137 FOUNDATION fieldbus asset monitors 272 FOUNDATION Fieldbus Device Integration FF Device Library 63 FF Instrument Asset Monitor Library 63 Fieldbus Builder FOUNDATION Fieldbus 63 OPC Server 63 Foundation Fieldbus Devices 498 FOUNDATION FIELDBUS HSE/H1 205 Function Aspect 157 Function Components 158 Function Designer 148, 157 Function Diagram 320, 369 Copy 370 Function Diagrams 158, 369 Function Plans 369 Function Reference Designations 87 Functional components 265 Functional Designation 81 to 82, 86, 89, 314 Functional Structure 82 to 83, 87, 312, 317, 320 G Generic OPC Upload 634 Advanced 636 722 Standard 635 Graphic aspect categories differences 176 Graphic Aspects 173 Graphic Display 173 Graphic Displays 375 Deploy 324 DesignGraphic Displays Build 322 Finalize 322 Graphic Element 174, 694 Graphic element 177 Graphic Libraries 172 Graphics Builder 172 H Hardware setup 378 E-mail test utility 394 Modem 391 Modem test utility 392 SMS/GSM hardware device 379 Hardware Units 373 HART 205 HART asset monitors 272 HART Device Integration Basic HART DTM 62 DTM Builder Runtime 62 Fieldbus Builder HART 62 HART Device Library 62 OPC Server 62 S800/S900 DTMs 62 HART Devices 435 HART Multiplexer Connect 62 Help Aspect Instance Help 570 hierarchical log 224 High limit check asset monitor 270 Highlow limit check asset monitor 270 Historical Process Data 219, 535 History 263 3BDS011222R4101 Index history log template 223 history log 219, 224 History Source 221 I I/O Board 320 I/O Signal Allocation 161, 167 I/O Signal Engineering 352 I/O Signals Allocate 322 Assign 321 I/O Station 320 I/O system 66 Icon Aspect 694 import 540 Import/Export 125 Import/Export tool 125 Inbox spooling 385 Independent Instance 692 IndustrialIT Extended Automation System 800xA 58 Engineering System 800xA 58 to 59 extended automation solution 58 Extended Automation System 800 xA 58 features 58 functional areas 58 licenses 58 system functions 58 Information Management 60, 219, 323 Basic Historian Server 60 Consolidated History Logs 60 Desktop Trends 60 Display Builder for MDI Client 60 Dual History Logs 60 Excel Data Access 61 History Engineering 60 History Logs 60 MDI Engineering 61 Multiscreen Display Interface (MDI) 60 3BDS011222R4101 ODBC Historical Data Server 61 ODBC-Client Connection 61 OLE-DB Client Connection 61 OLE-DB Historical Data Server 61 Information Management client 66 Initialization string 383 IOPCBrowseServerAddressSpace 617 Isolated Engineering 144 Item Properties Tab 633 L lab data log 223 Libraries 115, 328 Library New Version 330 library 308 Library Archive 329 Library Assistant 125 Library Management 115 to 116 Library Structure 328 Life Cycle Management 255, 574, 700 List Alarm 187 Event 187 List Based 142 Location Designation 81 to 82, 101, 314 Location Reference Designations 102 Location Structure 82, 98, 103, 312, 319, 321 Finalize 323 log direct 223 hierarchical 224 history 219, 224 lab data 229 numeric 223 property 223 trend 219, 223 log configuration aspect 223 Log Over 59, 253 Log over 253 723 Index Log Template 221 log template 223 Logging 188 loop 304 Low limit check asset monitor 270 Modem device 396 Message subscriber 404, 407 Modem hardware device 392 COM port settings 392 Modem setup 391 Modem test utility 392 M Manufacturing Management 61 Inventory Management 61 Manufacturing Management Client 61 Manufacturing Management Server 61 Operations Mangement 61 Quality Management 61 Weigh and Dispens 61 Maximo Integration 274, 609 MDI Engineering 61 Message configuration tab 423 message data access 197 Message handler Configuration 425 Destination tab 428 Edit destination dialog box 430 Message source tab 427 New destination dialog box 429 Message length 424 Message List 187 message log consolidation 198 Message prefix 424 Message schedule Setup 410 Message source tab 427 Message subscriber Email device 406 Modem device 404, 407 Setup 401 SMS device 404 SMS/GSM 403 Message suffix 424 MO drive 238 724 N Name 81 to 82, 314 name 81, 314 Naming 109, 219 Narrowband sockets 388 National Language 700 network 64 network device 64 New Aspect Dialog 342, 683 New destination dialog box 429 New Object Dialog 339, 674, 685 node 64 Notification methods 200 to 201 O Object Factory 676 object libraries 308 Object Structures 653 Object Type 334, 673 Object Type Definition 675 Object Type Extension Definition 345, 676 Object Type Group 334, 673 Object Type Group Reference 676 Object Type Reference 675 Object Type Structure 86, 101, 328, 334, 673 Object Types 75, 333, 350 Objects and Aspects 73 Obsolete Handling 693 Obsolete Structure 693 Off-Site Engineering 146 Off-Site Engineering System 142 OLE DB Provider 297, 649 On-site Engineering 3BDS011222R4101 Index Workflow 326 On-Site Engineering System 142 OPC Configuration Tab 622 OPC Control Connection 624 OPC Server 617 OPC Server for AC 800M/C 147 OPC Settings 632 Operation SMS and e-mail messaging 200 Operational structures 417 Alarm and event list 417 Alarm list tab 422 Edit length dialog box 424 Message configuration tab 423 Alarm and event message source 420 Message handler 425 Destination tab 428 Edit destination dialog box 430 Message source tab 427 New destination dialog box 429 Operations 59 Operator Workplace 59 Operator Workplace 66 Optimize splitting 388 Outbox spooling 385 P Paging service providers 397 Parameter Management 537 Parameter Manager 537 PC, Network and Software Monitoring 612 PC, network and software monitoring 270 pdf-file 553 PIN 382 Plant Explorer 80, 82 plant network 65 Prefix 82 procedure function chart 217 Process Function 304 Process Functions 3BDS011222R4101 Allocate 321 Create 320 ModifyProcess Functions Allocate 321 Process Graphics 147, 171, 375 Process Object 320 Process Object Type 352 Built in Function Designer 356 Process Objects 73 Production Management 61, 528 Batch Management 61 Manufacturing Management 61 Production System 142 Professional Engineering Tools Aspect Express 60 Library Assistant 60 Reuse Assistant 60 Script Manager Professional 60 PROFIBUS asset monitors 273 PROFIBUS Device Integration Basic PROFIBUS DTM 63 DTM Builder Runtime 63 Fieldbus Builder PROFIBUS 63 PROFIBUS Device Library 63 S800/S900 DTMs 63 PROFIBUS Devices 474 PROFIBUS DP/PA 205 project 308 Project Environment 308 Project Library 309 Project Workflow 304 Property Info Tab 628 property log 223 Property Signal Generator 639 Property View Tab 626 R Re-Authentication 573 Re-authentication 252 reference designations 81 to 82, 314 725 Index relative designation 82 Relative Name 677 Relative Reference 694 Relay server 394, 400 Remote Client Server 65 Reporting 277 AO asset condition history report 278 AO calibration report 278 AO running time report 278 Inputs 277 Output 277 restored log access 239 Reuse Design Structure 365 Reuse Instruction 365 Running time check asset monitor 270 S Safety 60 AC800M High Integrity and Process Control 60 AC800M High Integrity Control Software Integration 60 SAP/PM Integration 610 Script Management 279 Script Manager 279 Scripting 279 Security 250, 573 Security Settings 302 Sequence Bar 187 Sequential Function Chart 164 server 308 servers 65 Service Group 623 Service Provider 624 Service providers Paging 397 SMS/GSM 712 Service structure 416 to 417 Soft alarms 416 to 417 shared equipment modules 214 726 Signal group 168 Signal Grouping 168 Signal Object 320 Signal Objects 73 SIM card telephone number 382 single magnetic/optical drive 238 SMS and e-mail messaging 376 Block diagram 203 Configuration 417 Notification methods 200 to 201 Operation 200 System setup 396 SMS device Message subscriber 404 SMS/GSM hardware device COM port settings 382 Inbox spooling 385 Initialization string 383 List of 714 Messaging tab 389 Outbox spooling 385 PIN 382 SIM card telephone number 382 Splitting 388 SMS/GSM hardware device setup 379 SMS/GSM hardware devices 714 SMS/GSM service providers 712 Soft Alarms 189 Soft alarms 416 to 417 Softpoint Configuration Workflow 539 SOP 701 Splitting 388 Spread Sheet 132 Spread Sheets 132 Standard Engineering Tools Bulk Data Management 60 Control Builder M Professional 60 Document Manager 60 Engineering Base 60 3BDS011222R4101 Index Graphics Builder 60 I/O Allocation 60 Parameter Manager 60 Script Manager Basic 60 Step by Step Commissioning 522 FF Application 512 FFLibrary 500 HSE Subnet 505 HSEHostCI860 517, 526 Precommissioning 520 Step by Step User Instructions 499 Structured Plant Modelling 83 Structures Admin Structure 656 Aspect System Structure 657 Control Structure 658 Documentation Structure 660 Functional Structure 661 Graphics Structure 662 Library Structure 663 Location Structure 664 Maintenance Structure 665 Node Administration Structure 666 Object Type Structure 667 Obsolete Structure 668 Product Structure 668 Product Type Structure 668 Reuse Design Structure 668 Service Structure 669 System Structure 669 User Structure 670 Workplace Structure 672 Subscribe 625 Subtype 343 Super Type Reference 675 Supertype 344, 682 Supertype Reference 86, 101, 105 Synchronization Categories Exclusion 597 3BDS011222R4101 Conflict Detection 597 Consistency 601 Dependencies 600 Differences 585 External Data 601 Important Objects 601 Load Synchronization Package 590 Scope 582 Synchronization Package 588 synchronous data collection 223 system 308 System Checks 262, 607, 700 System Configuration Version 574 System Development Kit 60 System Development Toolkit 280 System Objects 73 System setup Aspect system structure Email device 399 Modem device 396 SMS and e-mail messaging 396 Soft alarms 416 to 417 User structure 400 Message schedule 410 Message subscriber 401 System Synchronisation 575 System Synchronization 142 T Template Support 557 Test 162 Test utility 392, 394 Timeout(s) field 430 Tool Routing 150, 453, 484 Topology aspect 169 Topology Designer 169 Topology Diagram 169 Topology Status Viewer 169, 373 Training 700 Trend Display 222 727 Index trend log 219, 223 Trend Template 222 Trends 182 Type Info Tab 678 Typical Solution 308 Typical Solutions 114 U Unacknowledged Alarm Indicator 187 Upgrade 332 Upload 634 User Roles 301, 670 User structure 400 User setup Message schedule 410 Message subscriber 401 Users Message schedule 410 Message subscriber 401 V Validation 697 Verify DTM Data Set 496 Verify DTM Data Set 465 Version and Access Management 249 Versioned Object Type Libraries 328 Versioning 115, 142, 255, 574, 700 W Web Page 248, 564 Web Server 492 Windows Application 248, 569 workplaces 65 X XY profile deviation asset monitor 270 728 3BDS011222R4101 BackCover.fm Page 19 Wednesday, October 20, 2004 10:27 AM 3BDS011222R4101. Printed in Sweden June 2005 Copyright © 2003-2005 by ABB. All Rights Reserved ® Registered Trademark of ABB. ™ Trademark of ABB. http://www.abb.com Automation Technology Products Wickliffe, Ohio, USA www.abb.com/controlsystems Automation Technology Products Västerås, Sweden www.abb.com/controlsystems Automation Technology Products Mannheim, Germany www.abb.de/controlsystems