TriStation 1131 Developer’s Guide TriStation™ 1131 Developer’s Workbench Version 4.14.0 Assembly Number 9700100-019 September 2015 Information in this document is subject to change without notice. Companies, names and data used in examples herein are fictitious unless otherwise noted. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Invensys Systems, Inc., now part of Schneider Electric. © 2004–2015 Invensys Systems, Inc. All rights reserved. Foxboro, Foxboro Evo, Triconex, Tricon, Trident, and TriStation are trademarks of Schneider Electric SE, its subsidiaries and affiliates. All other brands may be trademarks of their respective owners. OpenSSL Toolkit License OpenSSL License © 1998–2011 The OpenSSL Project. All rights reserved. Original SSLeay License © 1995–1998 Eric Young (eay@cryptsoft.com). All rights reserved. This product includes software developed by the OpenSSL Project and Eric Young for use in the OpenSSL Toolkit. (http://www.openssl.org/). Redistribution and use in source and binary forms of the OpenSSL Toolkit software, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of OpenSSL Toolkit source code must retain the above copyright notice, this list of conditions, and the following disclaimer. 2. Redistributions in binary form of the OpenSSL Toolkit software must reproduce the above copyright notice, this list of conditions, and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. All advertising materials mentioning features or use of the OpenSSL Toolkit software must display the following acknowledgments: “This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. (http://www.openssl.org/)” and “This product includes cryptographic software written by Eric Young (eay@cryptsoft.com)” If you include any Windows specific code (or a derivative thereof) from the apps directory (application code) you must include an acknowledgement: “This product includes software written by Tim Hudson (tjh@cryptsoft.com)” 4. The names “OpenSSL Toolkit” and “OpenSSL Project” must not be used to endorse or promote products derived from the OpenSSL Toolkit software without prior written permission. For written permission, please contact openssl-core@openssl.org. 5. Products derived from the OpenSSL Toolkit software may not be called “OpenSSL” nor may “OpenSSL” appear in their names without prior written permission of the OpenSSL Project. 6. Redistributions of any form of the OpenSSL Toolkit software whatsoever must retain the following acknowledgment: “This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.openssl.org/)” This product includes cryptographic software written by Eric Young (eay@cryptsoft.com). This product includes software written by Tim Hudson (tjh@cryptsoft.com). THIS OpenSSL Toolkit SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT or ERIC YOUNG “AS IS” AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT, ERIC YOUNG, OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS OpenSSL Toolkit SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Document No. 9720100-019, Rev 0 Printed in the United States of America. Contents Preface xv New Features in TriStation 1131 4.14.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xv Summary of Sections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvi Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvi Product and Training Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xvii Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xvii We Welcome Your Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii Chapter 1 Project Administration 1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Project Administration Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Installing TriStation 1131 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Upgrading from Previous Versions of TriStation 1131 . . . . . . . . . . . . . . . . . . . . . . . . . 5 Changing a TriStation 1131 4.14.0 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Installing the TriStation 1131 Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Customizing the Security Banner Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Uninstalling the TriStation 1131 Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Verifying the TriStation 1131 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Using Multiple Instances of TriStation 1131 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Converting Existing Projects to Version 4.14.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Selecting the Target System Version During Project Conversion . . . . . . . . . . . . . . . 14 Converting Version 4.x Tricon Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Converting Version 4.x Trident or Tri-GP Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Converting Version 2.x and 3.x Tricon or Trident Projects . . . . . . . . . . . . . . . . . . . . . 19 Creating a New Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 The Project Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Creating a New Tricon Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Creating a New Trident Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Creating a New Tri-GP Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Working with Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Logging On to an Existing Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Using the Triconex Single Logon Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Using the TriStation 1131 Project Launcher Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Adding a Project Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Adding Audit Comments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Displaying Version Numbers of Projects and Documents . . . . . . . . . . . . . . . . . . . . . 39 TriStation 1131 Developer’s Guide, 4.14.0 iv Contents Specifying Project Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Specifying Language Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Specifying Annotation Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Specifying Monitor Colors for BOOL Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Specifying Forced Points Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Specifying Download Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Specifying Emulator Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Specifying TriStation 1131 Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 Specifying General Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Specifying Directory Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Specifying Drawing Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 Specifying FBD Editor Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 Specifying LD Editor Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Specifying CEM Editor Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Adding or Removing Custom Help Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Adding a Custom Help File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Viewing Custom Help Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Removing a Custom Help File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 Managing User Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Security Considerations for User Access Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Changing the Security Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Managing Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Adding and Modifying User Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 Managing the Recovery Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Changing the Security Level for Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 Changing Security Level Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 Viewing User Access Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 Working with Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 Creating a Library of Project Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 Managing Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 Adding a Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 Updating a Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 Deleting a Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Verifying a Library Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Generating Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Updating the Report Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Viewing and Printing a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Adding Custom Reports to a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Exporting Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 Report Database Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 Printing Project Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 Printable Project Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 Printing Individual Documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 Printing Multiple Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 TriStation 1131 Developer’s Guide, 4.14.0 Contents v Customizing Your Workspace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 Showing or Hiding a Window Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 Docking Window Panes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118 Moving and Resizing Window Panes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 Chapter 2 Application Development 123 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 Application Development Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 Application Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 The Application Workspace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 The Declaration Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 The Implementation Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 Parts of an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 Safety and Control Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 Programming Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 User Documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 Creating a User Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 Copying User or Library Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 Specifying Document Summary Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 Specifying Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 Restricting Access to a Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 Changing a Document Owner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 Function Block Diagram and Ladder Diagram Development . . . . . . . . . . . . . . . . . . . . . . 142 Using the FBD Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 Using the LD Editor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Function and Function Block Graphics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 Working with Logic Sheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146 Selecting Library Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 Specifying Function Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 Specifying Function Block Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 Specifying Function Block Application Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 Structured Text Development . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 Using the ST Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 Using Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 Defining an Enumeration Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 Defining an Array Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 Defining a Structured Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 Declaring a VAR CONSTANT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 Declaring a VAR_TEMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 Declaring a VAR_EXTERNAL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 Declaring Local Variables in ST. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 Declaring Input and Output Variables in ST. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 Using For Loop and Exit Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 Using a CASE Statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 TriStation 1131 Developer’s Guide, 4.14.0 vi Contents VAR_IN_OUT Function Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 Cause Effect Matrix Development . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 CEMPLE Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 Using the CEM Editor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 Setting up a CEM Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 Using User-Defined Functions and Application-Defined States . . . . . . . . . . . . . . . 176 Specifying Local Variables, Tagnames, and Constants in a CEM Program . . . . . . 178 Working with Cells, Rows, and Columns in a CEM Program . . . . . . . . . . . . . . . . . 179 Editing the Title Block. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 Managing Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 Variables and Constants. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 Declaring Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 Specifying Variable Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 Specifying Variable Annotation Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192 Naming Multiple Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193 Changing Multiple Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194 Viewing the Number of Variables and Tagnames in a Program . . . . . . . . . . . . . . . 195 Creating Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196 Specifying Constant Annotation Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197 Tagnames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198 Getting to Know the Tagname Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 Declaring Tagnames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 Assigning an Alias Number, Alias Type, and Physical Address . . . . . . . . . . . . . . . 205 Specifying the Engineering Unit Range for a DINT or REAL Point . . . . . . . . . . . . 211 Scaling a REAL Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212 Specifying Display Options for a Tagname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 Specifying the Location of a Tagname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 Creating Multiple Tagnames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 Updating Multiple Tagnames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217 Sorting, Filtering, and Grouping Tagnames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 Copying Tagnames from the Tagname Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 Renaming Tagnames. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224 Deleting Tagnames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224 Printing Tagnames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225 Managing Undeclared and Unused Tagnames. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226 Using the Property Sheet Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229 Configuring Alarm Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231 Configuring a Level, Deviation, or ROC Alarm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 Configuring a Trip Alarm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237 Managing Area, Equipment, and SIF Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 Importing and Exporting Tagnames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245 Exporting Tagname Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245 Format of an Exported Tagname File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246 TriStation 1131 Developer’s Guide, 4.14.0 Contents vii Preparing an Excel File for Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251 File Format Requirements for Tagname Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252 Import Options and Validation Criteria. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259 Importing Tagname Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260 Annotations and Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264 Adding Annotations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264 Specifying Annotation Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266 Adding a Comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267 Specifying Comment Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268 Picking and Dropping Elements for Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269 Editing Comment Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270 Using Macros with Annotations and Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270 Editing Macro Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272 Modbus Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273 Assigning Alias Numbers to Tagnames. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274 How Tricon Transmits REAL Values With Special Alias Numbers . . . . . . . . . . . . 276 Tricon Special Alias Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277 How REAL Numbers are Scaled to Integers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278 Scaling REAL Values to Integers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280 How Trident and Tri-GP REAL Values are Transmitted Without Scaling . . . . . . . 282 Disabling Scaling of REAL Values for Trident and Tri-GP Tagnames . . . . . . . . . . 283 Peer-to-Peer Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284 Peer-to-Peer Data Transfer Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286 Estimating the Peer-to-Peer Data Transfer Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286 Allocating Peer-to-Peer Memory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288 SOE Development . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290 Displaying the SOE Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290 Defining SOE Block Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291 Assigning Tagnames to SOE Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296 Specifying a Trip Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298 Tricon Application Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299 Restricting Access to a Tricon Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299 What Affects Tricon Write Access from External Devices . . . . . . . . . . . . . . . . . . . . 300 Restricting Write Access to Tricon Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302 Allowing Write Access to Tricon Points. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303 Trident and Tri-GP Application Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304 Restricting Access to a Trident or Tri-GP Controller . . . . . . . . . . . . . . . . . . . . . . . . . 304 What Affects Trident and Tri-GP Write Access from External Devices . . . . . . . . . 306 Restricting Write Access to Trident or Tri-GP Points. . . . . . . . . . . . . . . . . . . . . . . . . 308 Allowing Write Access to Trident or Tri-GP Points . . . . . . . . . . . . . . . . . . . . . . . . . . 309 Secure Communication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310 What Is a Certificate? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311 Using the Default Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312 Generating a Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313 TriStation 1131 Developer’s Guide, 4.14.0 viii Contents Importing a Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315 Managing Private Keys. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316 Viewing Detailed Information About a Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . 318 Deleting a Certificate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319 Configuring a Secure Connection with the Controller . . . . . . . . . . . . . . . . . . . . . . . 320 Building an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323 Specifying the Program Order and Scan Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323 Compiling a Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325 About the Process Alarms Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325 Building or Rebuilding an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327 Backing Up a Project File to the Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328 About the Application’s Initialization Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333 Chapter 3 Tricon Controller Configuration 337 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338 The Tricon Controller Workspace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339 Setting Tricon Operating Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341 Allocating Memory for Tricon Points. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343 Configuring the Tricon Target System Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345 Determining Your Tricon Controller’s System Version. . . . . . . . . . . . . . . . . . . . . . . 346 Validating a Tricon Target System Version Change . . . . . . . . . . . . . . . . . . . . . . . . . 347 Changing the Tricon Target System Version. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349 Results of a Tricon Target System Version Change . . . . . . . . . . . . . . . . . . . . . . . . . . 353 Performing an Online Upgrade to Model 3009 MPs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357 Configuring Tricon Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358 Adding a Tricon Chassis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358 Replacing a Tricon Main Chassis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360 Deleting a Tricon Chassis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361 Determining Tricon Chassis Power Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362 Inserting and Removing Tricon Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363 Configuring a Tricon AI Single-Ended or Differential Module . . . . . . . . . . . . . . . . 365 Configuring a Tricon DO Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367 Configuring a Tricon PI Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369 Adding a Tricon Thermocouple Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370 Configuring Tricon Communication Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372 Configuring Tricon ACM Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372 Configuring Tricon HIM Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374 Configuring Tricon EICM Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375 Configuring Tricon NCM Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376 Configuring Tricon SMM Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378 Configuring Tricon TCM Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379 Configuring Tricon UCM Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403 Configuring Tricon Time Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422 About Tricon Time Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422 TriStation 1131 Developer’s Guide, 4.14.0 Contents ix Using a Tricon ACM to Synchronize Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423 Using a Tricon NCM to Synchronize Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424 Using a Tricon NCM/G to Synchronize Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425 Using a Tricon SMM to Synchronize Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426 Using a Tricon TCM or UCM to Synchronize Time . . . . . . . . . . . . . . . . . . . . . . . . . . 427 Printing the Tricon Module Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434 Chapter 4 Trident and Tri-GP Controller Configuration 435 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436 The Trident and Tri-GP Controller Workspace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437 Setting Trident or Tri-GP Operating Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439 Allocating Memory for Trident or Tri-GP Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442 Configuring the Trident or Tri-GP Target System Version. . . . . . . . . . . . . . . . . . . . . . . . . 443 Determining Your Trident or Tri-GP Controller’s System Version . . . . . . . . . . . . . 444 Validating a Trident or Tri-GP Target System Version Change . . . . . . . . . . . . . . . . 446 Changing the Trident or Tri-GP Target System Version . . . . . . . . . . . . . . . . . . . . . . 448 Results of a Trident or Tri-GP Target System Version Change . . . . . . . . . . . . . . . . 451 Configuring Trident and Tri-GP Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455 Configuring the Trident or Tri-GP Main Processors (MPs) . . . . . . . . . . . . . . . . . . . 455 Inserting a Trident or Tri-GP Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462 Removing a Trident or Tri-GP Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463 Configuring a Trident or Tri-GP SDO Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463 Configuring a Trident or Tri-GP HRDI Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464 Configuring a Trident or Tri-GP PI or EPI Module . . . . . . . . . . . . . . . . . . . . . . . . . . 467 Configuring Trident or Tri-GP Communication Modules . . . . . . . . . . . . . . . . . . . . . . . . . 470 Configuring the Trident 1.x Communication Module . . . . . . . . . . . . . . . . . . . . . . . . 470 Configuring the Trident or Tri-GP 2.x/3.x Communication Module . . . . . . . . . . . 474 Configuring the Trident or Tri-GP 3.x Communications Integration Module. . . . 491 Configuring Trident or Tri-GP Time Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511 About Trident and Tri-GP Time Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . 511 Using a Trident 1.x CM to Synchronize Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512 Using a Trident or Tri-GP 2.x/3.x CM to Synchronize Time . . . . . . . . . . . . . . . . . . 513 Using a Trident or Tri-GP 3.x CIM to Synchronize Time . . . . . . . . . . . . . . . . . . . . . 518 Using Trident or Tri-GP System and Module Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . 522 Printing the Trident or Tri-GP Module Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523 Chapter 5 Tricon Communication with TriStation 1131 525 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526 TriStation 1131 Communication Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526 Configuring the TriStation PC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527 Installing a NIC Card in a TriStation PC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527 Installing the TCP/IP Protocol on a TriStation PC . . . . . . . . . . . . . . . . . . . . . . . . . . . 528 Connecting to the Tricon Controller via a Serial Connection . . . . . . . . . . . . . . . . . . . . . . . 529 When to Use the Tricon Serial Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530 TriStation 1131 Developer’s Guide, 4.14.0 x Contents Connecting a Tricon Serial Port to a TriStation PC . . . . . . . . . . . . . . . . . . . . . . . . . . 531 Configuring the TriStation 1131 Serial Connection . . . . . . . . . . . . . . . . . . . . . . . . . . 532 Connecting to the Tricon Controller via a Network Connection . . . . . . . . . . . . . . . . . . . . 533 Directly Connecting an ACM or NCM Network Port to a TriStation PC . . . . . . . 534 Connecting a TCM Network Port to a TriStation PC Using a Router or Hub . . . . 535 Connecting a UCM Network Port to a TriStation PC Using a Router or Hub . . . . 536 Connecting a Tricon Network Port Using a Media Converter . . . . . . . . . . . . . . . . . 537 Configuring the TriStation 1131 Network Connection . . . . . . . . . . . . . . . . . . . . . . . 539 Specifying the Tricon Default Connection Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541 Controlling Access to the TCM or UCM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542 What Are Resources? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542 How Is Access Controlled? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543 What Are Access Levels? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543 Configuring the Access Control List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546 Configuring Tricon Controller Printing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549 Effect of Printing on Scan Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549 Connecting a Tricon EICM Port to a Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550 Connecting a TCM or UCM to Printing Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552 Connecting a TCM or UCM to Printing Devices Using a Hub. . . . . . . . . . . . . . . . . 553 Configuring a Tricon TCM or UCM Port for Printing . . . . . . . . . . . . . . . . . . . . . . . . 554 About Function Blocks for Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555 Setting Tricon Controller IP Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556 Using the Default IP Address for TriStation Communication . . . . . . . . . . . . . . . . . 557 Setting a Tricon Controller IP Address Using a RARP Server . . . . . . . . . . . . . . . . . 558 Setting a Tricon Controller IP Address Using an EICM, TCM, or UCM. . . . . . . . . 559 Testing a Network Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 561 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562 TriStation 1131 Communication Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563 Configuring the TriStation PC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564 Installing a NIC Card in a TriStation PC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564 Installing DLC or TCP/IP Protocol on a TriStation PC . . . . . . . . . . . . . . . . . . . . . . . 564 Connecting to the Trident or Tri-GP 2.x/3.x Controller for the First Time . . . . . . . . . . . 567 Connecting to the Trident or Tri-GP Controller via a Serial Connection . . . . . . . . . . . . . 568 When to Use the Trident or Tri-GP Serial Connection. . . . . . . . . . . . . . . . . . . . . . . . 568 Connecting a Trident or Tri-GP 2.x/3.x Serial Port to a TriStation PC . . . . . . . . . . 570 Configuring the TriStation 1131 Serial Connection . . . . . . . . . . . . . . . . . . . . . . . . . . 571 Connecting to the Trident or Tri-GP Controller via a Network Connection . . . . . . . . . . 572 Connecting the Trident 1.x MP to a TriStation PC . . . . . . . . . . . . . . . . . . . . . . . . . . . 573 Connecting the Trident 1.x CM to the TriStation PC . . . . . . . . . . . . . . . . . . . . . . . . . 577 Connecting the Trident or Tri-GP 2.x/3.x Controller to a TriStation PC . . . . . . . . 582 Specifying the Trident or Tri-GP Default Connection Type . . . . . . . . . . . . . . . . . . . . . . . . 589 Controlling Access to the CM or CIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590 TriStation 1131 Developer’s Guide, 4.14.0 Contents xi What Are Communication Module Resources? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590 How Is Access Controlled? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591 What Are Access Levels? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591 Configuring the Access Control List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594 Configuring Trident or Tri-GP Controller Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597 Effect of Printing on Scan Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597 Devices for Trident or Tri-GP Controller Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . 598 Directly Connecting a Trident or Tri-GP CM or CIM to Printing Devices . . . . . . . 599 Connecting a Trident or Tri-GP CM or CIM to Printing Devices Using a Hub . . . 600 Configuring a Trident or Tri-GP CM or CIM for Printing Devices . . . . . . . . . . . . . 601 About Function Blocks for Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604 Setting Trident or Tri-GP Controller IP Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605 Using the Default IP Address for TriStation Communication . . . . . . . . . . . . . . . . . 606 Setting an IP Address Using a RARP Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608 Setting a Trident or Tri-GP Controller IP Address Using an MP Connection . . . . 609 Setting a Trident 1.x Controller IP Address Using a CM Connection . . . . . . . . . . . 610 Specifying a Trident or Tri-GP CM/CIM Default Gateway . . . . . . . . . . . . . . . . . . . 611 Specifying a Trident or Tri-GP CM/CIM for Network Routing . . . . . . . . . . . . . . . 612 Testing a Network Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612 Chapter 7 Implementation 613 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614 Implementation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615 Controlling the Operational Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616 Using the Triconex Emulator for Testing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617 Controller Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618 Preparing to Download to the Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618 Downloading to the Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620 Verifying the Download to the Controller. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623 Monitoring Variables on the Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627 Monitoring the Program Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628 Adding Annotation for Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629 Determining the Minimum Scan Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630 Determining the Scan Surplus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631 Setting the Scan Time for a Downloaded Application. . . . . . . . . . . . . . . . . . . . . . . . 632 Displaying Hardware Allocation Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634 Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635 Steps for Downloading Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636 Planning and Controlling Changes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 637 Commands Required with Application Changes. . . . . . . . . . . . . . . . . . . . . . . . . . . . 638 Disabling Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640 Forcing Points. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644 Using the Download Changes Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646 Using the Download All Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649 TriStation 1131 Developer’s Guide, 4.14.0 xii Contents Appendix A Commands and Properties 651 Appendix B Security Guidelines 869 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 870 Workstation Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 871 TriStation 1131 Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 872 Appendix C Data Types 873 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874 Elementary Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 875 BOOL Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876 DATE Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876 DINT Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877 DT Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877 DWORD Data Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 878 INT Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879 LREAL Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879 REAL Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 881 STRING Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 883 TIME Data Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884 TOD Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885 Generic Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 886 Appendix D TCM Model 4351/4352 Configuration 887 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 888 Configuring Tricon TCM Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 889 Configuring TCM Serial Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891 Configuring TCM Network Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 893 Configuring TCM Peer-To-Peer Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895 Configuring TCM Modbus TCP Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 897 Configuring TCM Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899 Using a Tricon TCM to Synchronize Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 901 Configuring GPS Time Synchronization on the TCM . . . . . . . . . . . . . . . . . . . . . . . . 901 Configuring SNTP Time Synchronization on the TCM. . . . . . . . . . . . . . . . . . . . . . . 903 Configuring Triconex Time Synchronization on the TCM . . . . . . . . . . . . . . . . . . . . 905 Configuring a Tricon TCM Printer Port for Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906 Appendix E Managing Tagnames Using Item Properties 907 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 908 Declaring Tagnames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 909 Assigning an Alias Number, Alias Type, and Physical Address . . . . . . . . . . . . . . . . . . . . 911 Specifying the Engineering Unit Range for a DINT or REAL Point . . . . . . . . . . . . . . . . . 915 Scaling a REAL Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 916 Disabling Scaling of REAL Values for Trident and Tri-GP Tagnames . . . . . . . . . . 917 TriStation 1131 Developer’s Guide, 4.14.0 Contents xiii Specifying Display Options for a Tagname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918 Specifying the Location of a Tagname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919 Creating Multiple Tagnames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920 Changing Multiple Tagnames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921 Renaming a Tagname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922 Deleting a Tagname. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922 Inserting a Column into the Tagnames Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923 Deleting a Column from the Tagnames Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923 Managing Undeclared and Unused Tagnames. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924 Displaying Undeclared and Unused Tagnames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924 Editing Unused Tagnames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925 Deleting Unused Tagnames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 926 Appendix F Reserved Names 927 Names Reserved by TriStation 1131 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928 Names Reserved by SQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936 Appendix G Keyboard Shortcuts 941 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 942 Working with Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 943 Working with Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945 Editing Project Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946 Working with the Controller or Emulator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 948 Miscellaneous Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 949 Working with Sheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951 Shortcuts in the Program Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 953 Index 955 TriStation 1131 Developer’s Guide, 4.14.0 xiv Contents TriStation 1131 Developer’s Guide, 4.14.0 Preface TriStation™ 1131 Developer’s Workbench is a software application for developing, testing, and documenting safety-critical and process-control applications that execute on Triconex® controllers. New Features in TriStation 1131 4.14.0 TriStation 1131 version 4.14.0 is a significant release that includes the following new features: • Improved, easier-to-use interface for configuring tagnames. • Support for Tricon system version 11.2. • In Tricon 11.2 systems with only TCMs installed, the maximum number of tagnames is now approximately 29,000 (previous versions supported a maximum of approximately 13,000 tagnames), with a corresponding increase in bin sizes. • Ability to upgrade a Tricon 10.3, 10.4, or 10.5 system with model 3008 Main Processors, to a Tricon 11.2 system with model 3009 Main Processors, while the system is online. • Ability to automatically save a TriStation 1131 project file (.pt2) at a user-defined time interval. • Improved build and download verification times. • Several other minor fixes and enhancements. Note For more detailed information about the changes made in each TriStation 1131 4.x release, see the Product Release Notice for TriStation 1131 4.x, available on the Global Customer Support website. TriStation 1131 Developer’s Guide, 4.14.0 xvi Preface Summary of Sections • Chapter 1: Project Administration—Describes how to install the TriStation 1131 software, create a project, set up security, and use libraries of functions and function blocks. • Chapter 2: Application Development—Explains how to develop an application. • Chapter 3: Tricon Controller Configuration—Explains how to configure modules installed in a Tricon controller. • Chapter 4: Trident and Tri-GP Controller Configuration—Explains how to configure modules installed in a Trident™ or Tri-GP controller. • Chapter 5: Tricon Communication with TriStation 1131—Describes how to set up communication between a TriStation 1131 PC and a Tricon controller. • Chapter 6: Trident and Tri-GP Communication with TriStation 1131—Describes how to set up communication between a TriStation 1131 PC and a Trident or Tri-GP controller. • Chapter 7: Implementation—Explains how to implement an application on a controller. • Appendix A: Commands and Properties—Describes TriStation 1131 commands, properties, and tools. • Appendix B: Security Guidelines—Provides information on the security concepts and guidelines that are applicable to TriStation 1131. • Appendix C: Data Types—Describes the data types used in applications developed with TriStation 1131. • Appendix D: TCM Model 4351/4352 Configuration—Explains how to configure the model 4351 or 4352 Tricon Communication Module (TCM). • Appendix E: Managing Tagnames Using Item Properties—Describes how to manage tagnames using the Item Properties dialog box. • Appendix F: Reserved Names—Describes the names that are reserved for use by TriStation 1131 and SQL. • Appendix G: Keyboard Shortcuts—Lists the shortcut keys used for performing various tasks in TriStation 1131. Related Documents • TriStation 1131 Libraries Reference • Triconex Emulator User’s Guide • SOE Recorder User’s Guide • Enhanced Diagnostic Monitor User’s Guide • TriStation 1131 + ArchestrA Integration Guide • Tricon, Trident, and Tri-GP Safety Considerations Guides • Communication Guide for Tricon v9-v11 Systems • Communication Guide for Trident Systems TriStation 1131 Developer’s Guide, 4.14.0 Preface xvii • Communication Guide for Tri-GP Systems • Triconex OPC UA Server User’s Guide • Product Release Notices for specific Tricon, Trident, Tri-GP, and TriStation 1131 versions Product and Training Information To obtain information about Triconex products and in-house and on-site training, see the Invensys® website or contact your regional customer center. Website http://www.iom.invensys.com Technical Support Customers in the U.S. and Canada can obtain technical support from the Global Customer Support (GCS) center at the numbers below. International customers should contact their regional support center. Requests for support are prioritized as follows: • Emergency requests are given the highest priority • Requests from participants with a support agreement and customers with purchase order or charge card authorization are given next priority • All other requests are handled on a time-available basis If you require emergency or immediate response and do not have a support agreement, you may incur a charge. Please have a purchase order or credit card available for billing. Telephone Toll-free number 866-746-6477, or Toll number 508-549-2424 (outside U.S.) Fax Toll number 508-549-4999 Website http://support.ips.invensys.com/ (registration required) TriStation 1131 Developer’s Guide, 4.14.0 xviii Preface We Welcome Your Comments To help us improve future versions of Triconex documentation, we want to know about any corrections, clarifications, or further information you would find useful. When you contact us, please include the following information: • The title and version of the guide you are referring to • A brief description of the content you are referring to (for example, step-by-step instructions that are incorrect, information that requires clarification or more details, missing information that you would find helpful) • Your suggestions for correcting or improving the documentation • The version of the Triconex hardware or software you are using • Your name, company name, job title, phone number, and e-mail address Send e-mail to us at: systemstechpubs@schneider-electric.com Please keep in mind that this e-mail address is only for documentation feedback. If you have a technical problem or question, please contact the Global Customer Support (GCS) center. See Technical Support on page xvii for contact information. Or, you can write to us at: Attn: Technical Publications — Triconex Invensys Systems, Inc. 26561 Rancho Parkway South Lake Forest, CA 92630 USA Thank you for your feedback. TriStation 1131 Developer’s Guide, 4.14.0 1 Project Administration Overview 2 Installing TriStation 1131 4 Converting Existing Projects to Version 4.14.0 13 Creating a New Project 22 Working with Projects 30 Specifying Project Options 41 Specifying TriStation 1131 Options 54 Managing User Access 66 Working with Libraries 88 Generating Reports 98 Printing Project Documents 109 Customizing Your Workspace 114 TriStation 1131 Developer’s Guide, 4.14.0 2 Chapter 1 Project Administration Overview This figure shows a typical project cycle and the main steps for setting up a TriStation 1131 project. TriStation 1131 Developer’s Guide, 4.14.0 Overview 3 Project Administration Steps This list includes steps that can be or should be done during project administration. Steps See Install the TriStation1131 software (if needed) • Installing TriStation 1131 on page 4 Create or open an existing project. • Creating a New Project on page 22 • Working with Projects on page 30 • Converting Existing Projects to Version 4.14.0 on page 13 Specify the language to be used as a default. • Specifying Language Options on page 42 Specify whether annotations are automatically included. • Specifying Annotation Options on page 43 Specify monitor colors for displaying variables in the Emulator and controller. • Specifying Monitor Colors for BOOL Values on page 45 Specify sort options for the tagnames table used by the TCM embedded OPC server. (Optional) • Specifying Download Options on page 47 Specify options to be used when you use TriStation 1131. • Specifying TriStation 1131 Options on page 54 Specify FBD, LD, and CEM Editor options, as needed. (Optional) • Specifying FBD Editor Options on page 60 • Specifying LD Editor Options on page 61 • Specifying CEM Editor Options on page 62 Add custom Help files for user-defined libraries, as needed. (Optional) • Adding or Removing Custom Help Files on page 63 Create TriStation 1131 users and configure user access levels. • Managing User Access on page 66 Add libraries from other projects. (Optional) • Adding a Library on page 94 View standard reports; add custom reports. • Generating Reports on page 98 TriStation 1131 Developer’s Guide, 4.14.0 4 Chapter 1 Project Administration Installing TriStation 1131 This section explains how to install and uninstall the TriStation 1131 software, and how to verify that the software is correctly installed. The installation also installs the TS1131 Install Check software. Topics include: • System Requirements on page 4 • Upgrading from Previous Versions of TriStation 1131 on page 5 • Changing a TriStation 1131 4.14.0 Installation on page 6 • Installing the TriStation 1131 Software on page 6 • Customizing the Security Banner Text on page 8 • Uninstalling the TriStation 1131 Software on page 10 • Verifying the TriStation 1131 Installation on page 10 • Using Multiple Instances of TriStation 1131 on page 12 System Requirements The following are the minimum system requirements for TriStation 1131: • PC running the .NET Framework 4.5.1 and one of the following Windows® operating systems: — Windows 7 Professional/Enterprise (32-bit or 64-bit) — Windows Server® 2012 R2 — Windows Server 2008 R2 (64-bit) Note • During the installation process, setup will verify that all prerequisite components are installed. If prerequisite components are missing, you will be prompted to install them. See Installing the TriStation 1131 Software on page 6 for more information. Free hard drive space: — For TriStation 1131 and its prerequisites: 500 MB — For the .NET 4.5.1 Framework: 850 MB (32-bit) or 2 GB (64-bit) — For the SAP Crystal Reports runtime engine: 850 MB • 1 GHz processor with 512 MB RAM • CD-ROM drive • Network adapter card • SVGA monitor running at 1024 x 768 resolution with 32-bit color • DLC protocol installed (for connecting to a Trident 1.x MP only; see Installing DLC or TCP/IP Protocol on a TriStation PC on page 564) TriStation 1131 Developer’s Guide, 4.14.0 Installing TriStation 1131 Note 5 The above operating system and hard disk space requirements are applicable to a Virtual Machine (VM) instance as well. Microsoft® Hyper-V® is the only virtualization technology that has been tested by Invensys, and is supported for use with TriStation 1131. Upgrading from Previous Versions of TriStation 1131 If you are upgrading from a previous version of TriStation 1131, please note the following: • Projects created in previous versions of TriStation 1131 should be backed up using the version of TriStation 1131 they were created in, before opening the project in a later version. Projects backed up using a later version of TriStation 1131 cannot be opened by older versions. For example, a project backed up using version 4.8.0 cannot be opened in TriStation 1131 version 4.4. • If you have previously installed version 2.x, 3.x, or 4.x of the TriStation 1131 software, you do not need to uninstall it before installing 4.14.0. However, only one version of TriStation 1131 can be open at any one time; for example, you cannot have 3.x open at the same time as 4.14.0. • If you have previously installed 4.x of the TriStation 1131 software, you do not need to uninstall it before you install version 4.14.0. You may wish to keep both versions of the TriStation 1131 software installed on your workstation until you have finished converting all your projects to 4.14.0 (see Converting Existing Projects to Version 4.14.0 on page 13). However, uninstalling 4.0 after you have installed 4.14.0 will cause 4.14.0 to no longer work. To correct this, simply uninstall both 4.0 and 4.14.0 and then reinstall 4.14.0. • Additionally, if you installed other Triconex applications (such as SOE Recorder) after you installed TriStation 1131 4.0, uninstalling 4.0 may cause other installed Triconex applications to no longer work. To correct this, simply uninstall and then reinstall the other Triconex applications after you uninstall TriStation 1131 4.0. • Sample TriStation 1131 projects are now found in the following folder on the PC where you install TriStation 1131 4.14.0: C:\ProgramData\Triconex\TriStation 1131 4.14.0\Projects. TriStation 1131 Developer’s Guide, 4.14.0 6 Chapter 1 Project Administration Changing a TriStation 1131 4.14.0 Installation There are two versions of TriStation 1131: • The Tri-GP only version: Supports application development for Tri-GP controllers only. You cannot create applications for use with Tricon or Trident controllers. • The full-featured version: Supports application development for all Triconex controllers—Tricon, Trident, and Tri-GP. If you have previously installed either version of TriStation 1131 4.14.0, and you want to upgrade or downgrade your installation, you do not need to uninstall it before running the TriStation 1131 4.14.0 setup program. During installation, setup will automatically modify the current installation to add or remove features. If you currently have the full-featured version of TriStation 1131 4.14.0 installed, downgrading to the Tri-GP only version means you will lose the ability to work with Tricon or Trident project files. Note If you have installed the Triconex Single Logon service and want to uninstall it, you can modify the TriStation 1131 4.14.0 installation, and clear the check box associated with this service in the installation wizard. Installing the TriStation 1131 Software This procedure explains how to install the TriStation 1131 software. The setup program provided by Triconex installs all the components of the TriStation 1131 Developer’s Workbench on your PC. • The Triconex Emulator 1.5.0 is automatically installed as part of the TriStation 1131 installation. For more information about the Emulator, see Using the Triconex Emulator for Testing on page 617. • If you purchased the optional CEMPLE software, it is installed at the same time. You must have Windows administrator privileges to install TriStation 1131. The TriStation 1131 software must be installed on a local drive. Do NOT install and run TriStation 1131 on a network server. Invensys recommends setting the size of text and other items on your screen to the normal, default value of 100% (in Control Panel > Display) before you begin the installation. If you need to change this setting, you will need to log off of Windows, and then log on again so that the change can take effect. (For more information about this setting, search for “Make the text on your screen larger or smaller” in Windows Help.) Before you start TriStation 1131 installation, make sure you have installed the latest service packs and critical updates for your version of Windows. To look for recent updates, visit the Microsoft Windows Update website. Note In order to be able to view TriStation 1131 reports on a PC running Windows Server 2012 R2, you must manually install the .NET Framework 3.5.1 before you install TriStation 1131. For information about how to install the .NET Framework 3.5.1, see https://technet.microsoft.com/en-us/library/dn482066.aspx. TriStation 1131 Developer’s Guide, 4.14.0 Installing TriStation 1131 7 During the installation process, setup will verify that all prerequisite components are installed. If prerequisite components are missing, you will be prompted to install them. For example, if the .NET Framework 4.5.1 is not already installed, setup will install it for you before installing TriStation 1131. If necessary, setup will also install Windows Installer 4.5 prior to installing the .NET Framework. Depending on your PC’s configuration, Windows Installer and .NET Framework installation can take several minutes, and may require you to restart your PC in order to complete the installation process. If you receive any errors during the .NET Framework installation, contact your system administrator for assistance. During installation, you can choose to install the optional Triconex Single Logon service. This service allows you to avoid having to log on to a TriStation 1131 project again during a specified time period after a project has been closed. For more information about using the Single Logon service, see Using the Triconex Single Logon Service on page 34. Procedure 1 Log on as an administrator or as a user with administrator privileges. 2 Close all open applications. 3 Insert the TriStation 1131 CD in the CD-ROM drive. If the installation starts automatically, go to step 8. Otherwise, go to the next step. 4 From the Start menu, click Settings, and then click Control Panel. 5 Double-click Add New Programs. 6 Click the CD or Floppy button, and then browse to locate the setup.exe file on the CD. 7 Double-click setup.exe to start the installation. 8 Follow the installation wizard instructions. 9 If prompted to install prerequisite components, click Install Prerequisites. Setup will install all the necessary prerequisites. You must install all required prerequisite components before TriStation 1131 setup can continue. For more information about a selected prerequisite, double-click the prerequisite name. It is recommended that you install TriStation 1131 in the default destination folder: C:\Program Files\Triconex\TriStation 1131 4.14.0. Note For systems running 64-bit versions of Windows (Windows 7, Windows Server 2012 R2, or Windows Server 2008 R2), the default folder is: C:\Program files(x86)\Triconex\TriStation 1131 4.14.0. 10 Continue to follow the installation wizard prompts. 11 When prompted to select the features you want to install, choose one or both of the following: • Triconex Single Logon: Enables the single logon feature. This option is not selected by default. For more information on the single logon feature, see Using the Triconex Single Logon Service on page 34. TriStation 1131 Developer’s Guide, 4.14.0 8 Chapter 1 Project Administration • Triconex Report Generator: Installs the Triconex Report Generator software. This option is not selected by default. For more information on using this software, see the Triconex Report Generator User’s Guide. 12 To restart your PC after the installation has finished, click Yes. You are not required to restart your PC before running the TriStation 1131 software, unless the .NET Framework was installed as part of the TriStation 1131 installation. 13 To complete the installation, click Finish. Customizing the Security Banner Text Each time you start TriStation 1131, a security banner appears, advising you of the appropriate use of TriStation 1131. If you are an administrator managing TriStation 1131 installations in your organization, you may want to customize the security banner text to reflect your corporate policy or meet site-specific needs. The security banner text must be customized in each TriStation 1131 installation individually. However, once you modify the security banner text once, you can simply copy and paste the text from one PC to another. An easy way to do this would be to create a temporary text file with the security banner text in it, and place that file on the network, or on a portable flash drive. You can then copy and paste the text from the file. Also, the same security banner text can be used for other Triconex products that use the security banner functionality. For example, if your organization’s security banner text is the same for all Triconex products, you can use the same text for the Enhanced Diagnostic Monitor as you do for TriStation 1131. The security banner text can be changed during TriStation 1131 installation, or at any time after installation using the procedure provided in this section. You must be logged in to Windows as user with administrator privileges to change the security banner text. Procedure 1 Open TriStation 1131. 2 On the Edit menu, click Modify Banner Message. If the Modify Banner Message menu item is not enabled, you are not logged on to Windows with administrator privileges. Note If you are using TriStation 1131 on a PC running Windows 7, you must right-click on the TriStation 1131 icon and select Run as administrator, in TriStation 1131 Developer’s Guide, 4.14.0 Installing TriStation 1131 9 addition to being logged on as a user with administrator privileges, in order to enable the Modify Banner Message menu item. The Modify Banner Message dialog box appears. 3 Edit the security banner text as needed, and then click OK. The security banner text can be a maximum of 2,100 characters. Note You cannot have a blank security banner message; if you delete the existing text, but do not enter new text, the default security banner message (“This system is for use by authorized Safety System personnel only.”) will be displayed. The next time you start TriStation 1131, the customized text will appear in the security banner. Note If you receive an “Unable to save changes to the banner message” error message when you attempt to save the security banner text, you may not have read/write access to the location where the message text is stored. Contact Global Customer Support for assistance. For contact information, see Technical Support on page xvii. TriStation 1131 Developer’s Guide, 4.14.0 10 Chapter 1 Project Administration Uninstalling the TriStation 1131 Software This procedure explains how to uninstall the TriStation 1131 software. Procedure 1 Log on as an administrator or as a user with administrator privileges. 2 From the Start menu, click Settings, and then click Control Panel. 3 Double-click Add/Remove Programs, and select TriStation 1131 4.14.0. 4 Click Change/Remove. Follow the on-screen instructions to confirm the deletion of the selected application and all its components. Note If you saved projects in the default installation directory (see Installing TriStation 1131 on page 4) or the default Projects directory (see Specifying Directory Locations on page 58), the uninstall program does not remove them. 5 Click Yes or Yes to All if the Remove Shared File dialog box asks about removing unused DLLs. 6 Click Finish to complete the uninstallation process. Verifying the TriStation 1131 Installation This procedure explains how to verify the TriStation 1131 software is correctly installed and that associated files are not corrupted. After installing the software and before downloading an application to the controller, you should run the TriStation 1131 Install Check program. The Install Check software is copied to your hard drive when you install the TriStation 1131 software. Note Running the Install Check software is required for safety applications. This software verifies that the installation files are digitally signed and installed without any errors. For more information, see the Safety Considerations Guide for your controller. Procedure 1 From the Start menu, select Programs, Triconex, and then Install Check 4.14.0. Note 2 Before the Install Check program begins to run, it checks if its own executable file (InstallCheck.exe) is digitally signed and is from a valid trusted source. If not, an error message will be displayed. You can either click OK to continue to run the InstallCheck program, or click Cancel to exit. However, Invensys recommends running Install Check only from a digitally signed version of the executable file. Contact Global Customer Support if you need assistance obtaining a digitally signed version of the executable file. Click Run. Install Check verifies that all TriStation 1131 files are digitally signed and correctly installed. When verification is complete, the name, version, and status of each file are displayed in the list. TriStation 1131 Developer’s Guide, 4.14.0 Installing TriStation 1131 3 11 Verify that the program is validated by viewing each item in the list. The status of each file should be “OK”. If there are files that have “Missing”, “Corrupted”, or “Digital Signature Failure” in the Status column, you should re-install TriStation 1131. 4 Click Display Details to view the full path for verified files and expanded error messages for any identified problems. TriStation 1131 Developer’s Guide, 4.14.0 12 Chapter 1 Project Administration Using Multiple Instances of TriStation 1131 You can open multiple instances of TriStation 1131 on the same PC. The maximum number of open instances at any time depends on the version of each TriStation 1131 instance. Regardless of the number of open instances, a maximum of three instances may be connected to the same controller (from different PCs), or to different controllers (from the same PC). You can connect to any Tricon, Trident, or Tri-GP controller. When a project file (.pt2) is open in one instance of TriStation 1131, you cannot open the same file in another instance of TriStation 1131. Connecting Multiple Instances of TriStation 1131 4.14.0 or Later You can open an unlimited number of instances of TriStation 1131 4.14.0 or later on the same PC, but you can connect only three of them to a controller at any one time. Each instance can be connected to a different controller, or all three instances can be connected to the same controller. Additionally, you can open an unlimited number of instances of TriStation 1131 4.14.0 or later on different PCs, and connect any three of those instances to the same controller. Connecting Multiple Instances of Various TriStation 1131 Versions The following rules apply when you want to open or connect various versions of TriStation 1131: • When an instance of TriStation 1131 4.10.1 or earlier is open and an instance of TriStation 1131 4.11.0 or later is open, you cannot connect the TriStation 1131 4.11.0 or later instance to the controller. To connect, you must first close the open instance of TriStation 1131 4.10.1 or earlier, and then attempt to reconnect. • If an instance of TriStation 1131 4.14.0 is connected to a controller, you cannot open an instance of TriStation 1131 4.10.1 or earlier. However, you can open additional instances of TriStation 1131 4.14.0, and connect each of them to the same controller or to a different controller, as long as you do not exceed the three connected instances limit. • If an instance of TriStation 1131 4.11.0 - 4.13.0 is connected to a controller, you cannot connect an instance of TriStation 1131 4.14.0 to a controller. To connect the TriStation 1131 4.14.0 instance to a controller, you must first disconnect the instance of TriStation 1131 4.11.0 - 4.13.0, and then attempt to reconnect. • If an instance of TriStation 1131 4.14.0 is connected to a controller, you cannot connect an instance of TriStation 1131 4.11.0 – 4.13.0 to a controller. To connect the TriStation 1131 4.11.0 – 4.13.0 instance, you must first disconnect the instance of TriStation 1131 4.14.0, and then attempt to reconnect. Note When using multiple instances, you need to ensure that the same node number is not configured in the projects opened in these instances, as duplicate node numbers do not constitute a valid configuration. For example, if node 27 is configured in a project opened in the first instance of TriStation 1131, a project opened in a second instance of TriStation 1131 must not be configured to use node 27. The TriStation 1131 software does not check if the same node number is being used across multiple instances. TriStation 1131 Developer’s Guide, 4.14.0 Converting Existing Projects to Version 4.14.0 13 Converting Existing Projects to Version 4.14.0 The programming model for TriStation 1131 4.x is significantly different from versions 3.x and earlier. The most significant differences are: • There are no program instances • Programs can directly reference tagnames • Programs cannot use VAR_INPUT, VAR_OUTPUT, or VAR_IN_OUT variables This procedure explains how an existing TriStation 1131 project can be automatically converted to 4.14.0. Any project created with 3.x through 4.14.0 can be converted to 4.14.0. However, once a project has been opened in 4.14.0, it can no longer be opened with an earlier version of TriStation 1131. Note All projects are backed up automatically prior to project conversion. The backup file can be opened in the version of TriStation 1131 originally used to create the project. The name and location of the backup file is displayed in the messages window (see Messages Command on page 761) after project conversion is complete. Projects converted to version 4.14.0 are automatically set to use Standard Security. You can change the security setting after project conversion is complete. See Changing the Security Setting on page 70. Projects converted to version 4.14.0 that are configured for use with a Tricon controller do not require a password to connect to the controller. During conversion, the connection password configured in the project, if any, will be removed. However, converted projects configured for use with Trident/Tri-GP controllers will continue to use the connection password. For more information on the connection password, see Setting Tricon Operating Parameters on page 341. Topics include: • Selecting the Target System Version During Project Conversion on page 14 • Converting Version 4.x Tricon Projects on page 16 • Converting Version 4.x Trident or Tri-GP Projects on page 17 • Converting Version 2.x and 3.x Tricon or Trident Projects on page 19 TriStation 1131 Developer’s Guide, 4.14.0 14 Chapter 1 Project Administration Selecting the Target System Version During Project Conversion When converting an existing project, if it is a Tricon project last opened in TriStation 1131 4.1 or earlier, or a Trident project last opened in TriStation 1131 4.4 or earlier, you are asked to select the target system version for the project. The target system version determines which controller features and modules can be configured in a project. If your project is in the Download Changes state prior to conversion, be sure to select the correct target system version during the conversion process. The conversion process is the only time you can set the project’s target system version without having to change the project state to Download All. If the target system version is correctly configured during conversion, the project can remain in the Download Changes state. However, changing the target system version at any time after conversion will require a Download All. If you select an incorrect target system version during project conversion, you must do one of the following to correct the target system version: • Change the project to the Download All state, and then change the target system version (see Configuring the Tricon Target System Version on page 345 or Configuring the Trident or Tri-GP Target System Version on page 443). • Keep the project in the Download Changes state by abandoning the current project and using the project’s backup file to restart the conversion process. Rules for Tricon Project Conversion • If the project’s hardware configuration includes a model 3006 or 3007 Main Processor, you cannot upgrade to a model 3008 or 3009 Main Processor during project conversion. In this case, you must convert the project with Tricon v9 - 3006 Main Processor as the target system version, and then change the target system version after project conversion is complete. This will require a Download All. For more information, see Configuring the Tricon Target System Version on page 345. • A project created in TriStation 1131 4.4 or 4.5 with a mix of High-Density and Enhanced Low-Density chassis cannot be changed to an earlier system version (downgraded) or to a later system version (upgraded).1 Rules for Trident Project Target System Version Conversion • If the project’s hardware configuration includes a Trident 1.0 or 1.1 system, you must upgrade to a Trident 1.2 or later target system version during project conversion. TriStation 1131 4.14.0 cannot be used to create or modify projects for Trident 1.0 or 1.1 systems. In this case, if you want to maintain your project for use with these Trident system versions, do not open the project in TriStation 1131 4.14.0. You must use TriStation 1131 4.4 or earlier with these systems. See the Product Release Notice for TriStation 1131 4.x on the Global Customer Support (GCS) website for detailed compatibility information. 1. This limitation does not apply to projects created in TriStation 1131 4.6 or later. TriStation 1131 Developer’s Guide, 4.14.0 Converting Existing Projects to Version 4.14.0 • 15 If you are upgrading from a Trident 1.x to Trident 2.x target system version during project conversion, the configuration settings for the CM will be reset to their default values during project conversion. Invensys recommends writing down your Trident 1.x CM configuration details (or saving a backup of your project prior to conversion) before changing the target system version, so that you can use them to reconfigure the Trident 2.x CM after project conversion is complete. • If you are upgrading from a Trident 1.x/2.x to Trident 3.x target system version during project conversion, the configuration settings for the CM will be retained. • If time synchronization has been enabled on the Trident CM or MP (as described below), it will be disabled during project conversion if the target system version is changed from 1.x to 2.x, or vice-versa. — On Trident 2.x, time synchronization is enabled if the Enable Trident/Tri-GP Node Time Synchronization check box is selected on the Operating Parameters tab of the MP Setup dialog box. — On Trident 1.x, time synchronization is enabled if either the On NET 1 Enable Time Synchronization or the On NET 2 Enable Time Synchronization properties are selected on the Network tab of the CM Setup dialog box. You will need to re-enable time synchronization after project conversion is complete. See Configuring Trident or Tri-GP Time Synchronization on page 511 for more information. Note Upgrading or downgrading within a major Trident version (for example, from 1.2 to 1.6, or from 2.1 to 2.0) will NOT change your time synchronization settings. Rules for Tri-GP Project Target System Version Conversion • If you are upgrading from a Tri-GP 2.x to Tri-GP 3.x target system version during project conversion, the configuration settings for the CM will be retained. • Upgrading or downgrading within a major Tri-GP version (for example, from 2.1 to 2.2) will NOT change your time synchronization settings. TriStation 1131 Developer’s Guide, 4.14.0 16 Chapter 1 Project Administration Converting Version 4.x Tricon Projects This procedure describes how to convert Tricon projects created in TriStation 1131 versions 4.0– 4.13.0 to TriStation 1131 4.14.0. Note All projects will be backed up automatically during project conversion. The name and location of the backup file will be displayed in the messages window (see Messages Command on page 761) after project conversion is complete. Procedure 1 Open the TriStation 1131 project to be converted. 2 When prompted, click Yes to continue the conversion or No to cancel. 3 Enter your user name and password, and then click Log On. 4 Do one of the following: • If the Select Main Processor dialog box appears (only when converting projects last opened in TriStation 1131 4.1 or earlier), go to step 5. • If the Select Main Processor dialog box does not appear, go to step 7. TriStation 1131 Developer’s Guide, 4.14.0 Converting Existing Projects to Version 4.14.0 5 17 Do one of the following: • If the project’s hardware configuration includes a model 3006 or 3007 Main Processor, the Tricon v9-3006 Main Processor option is selected in the Select Main Processor dialog box. Click OK to continue. • If the project’s hardware configuration includes a model 3008 Main Processor, the model 3008/N/C Main Processor is selected in the Select Main Processor dialog box. From the Target System Version list, select the system version of the Tricon controller that this project will be downloaded to. Use the on-screen descriptions to help you determine the correct version to select, based on your Tricon controller configuration. If you are not sure which Tricon system version to select, use the Enhanced Diagnostic Monitor to verify your Tricon’s system version information. See Determining Your Tricon Controller’s System Version on page 346 for more information. 6 Click OK. 7 When prompted to update the project libraries, do one of the following, depending on your project’s current download state: • If your project is in the Download All state, click Yes to update the libraries, or No to continue the conversion without updating the libraries. • If your project is in the Download Changes state, click No to continue the conversion without updating the libraries. Note If you click No, but you later add the new features included in the updated libraries to your application, you will need to manually update the libraries prior to building and downloading the application. For update instructions, see Updating a Library on page 95. Project conversion is complete when the project file opens in TriStation 1131 and you see the Application Workspace. Converting Version 4.x Trident or Tri-GP Projects This procedure describes how to convert Trident or Tri-GP projects created in TriStation 1131 versions 4.0–4.13.0 to TriStation 1131 4.14.0. Note All projects will be backed up automatically during project conversion. The name and location of the backup file will be displayed in the messages window (see Messages Command on page 761) after project conversion is complete. For Trident and Tri-GP projects only, configuration of the engineering unit range for DINT tagnames was added to TriStation 1131 4.10.0. During project conversion, all existing DINT tagnames will be configured with the following default values: • Minimum Value (Engineering Unit Range): -2147483648 • Maximum Value (Engineering Unit Range): +2147483647 These values apply to Trident or Tri-GP 3.x or later projects only; they will appear in Trident 1.x/2.x or Tri-GP 2.x projects, but have no meaning for those controller versions. TriStation 1131 Developer’s Guide, 4.14.0 18 Chapter 1 Project Administration CAUTION TriStation 1131 4.14.0 does not support Trident versions 1.1 and earlier. If you open a project developed for use with one of these systems, you must upgrade the target system version to Trident 1.2 or later during project conversion. To maintain the project for use with Trident 1.1 or earlier, do NOT open it with TriStation 1131 4.14.0. Procedure 1 Open the TriStation 1131 project to be converted. 2 When prompted, click Yes to continue the conversion or No to cancel. 3 Enter your user name and password, and then click Log On. 4 Do one of the following: 5 • If the Select Main Processor dialog box appears (only when converting projects last opened in TriStation 1131 4.4 or earlier), go to step 6. • If the Select Main Processor dialog box does not appear, go to step 8. Specify these properties in the Select Main Processor dialog box. Property Description Model The Main Processor model installed in the Trident or Tri-GP controller that this project will be downloaded to. Target System Version The system version of the Tridenta or Tri-GP controller that this project will be downloaded to. Use the on-screen descriptions to help you determine the correct version to select, based on your Trident or Tri-GP controller configuration. a. TriStation 1131 4.14.0 does not support Trident versions 1.1 and earlier. For a list of TriStation 1131 versions compatible with your Trident system, see the applicable Trident Product Release Notice (available on the Global Customer Support website). TriStation 1131 Developer’s Guide, 4.14.0 Converting Existing Projects to Version 4.14.0 Note 19 If you are not sure which Trident or Tri-GP system version to select, see Determining Your Trident or Tri-GP Controller’s System Version on page 444. 6 Click OK. 7 When prompted to update the project libraries, do one of the following, depending on your project’s current download state: • If your project is in the Download All state, click Yes to update the libraries, or No to continue the conversion without updating the libraries. • If your project is in the Download Changes state, click No to continue the conversion without updating the libraries. Note If you click No, but you later add the new features included in the updated libraries to your application, you will need to manually update the libraries prior to building and downloading the application. See Updating a Library on page 95 for update instructions. Project conversion is complete when the project file opens in TriStation 1131 and you see the Application Workspace. Converting Version 2.x and 3.x Tricon or Trident Projects This procedure describes how to convert Tricon or Trident projects created in TriStation 1131 3.x or 3.x to TriStation 1131 4.14.0. CAUTION TriStation 1131 4.14.0 does not support Trident versions 1.1 and earlier. If you open a project developed for use with one of these systems, you must upgrade the target system version to Trident 1.2 or later during project conversion. To maintain the project for use with Trident 1.1 or earlier, do NOT open it with TriStation 1131 4.14.0. Procedure 1 Open the TriStation 1131 project to be converted. 2 When prompted, click Yes to continue the conversion or No to cancel. To get information about what is converted, click Help. 3 If you clicked Yes, you must log on to the project as a Level 01 user. TriStation 1131 Developer’s Guide, 4.14.0 20 Chapter 1 Project Administration After you log on, the project is opened and a backup is made using this naming convention: <project name>_<version>_Pre40Cnv.bt2. 4 Do one of the following: • For a Tricon project, click Yes when prompted to convert the project with Tricon 9 3006 Main Processor as the target system version. • For a Trident project: — Click Yes when prompted to update the Trident Hardware Definition File. — Click Yes again when prompted to convert the project with Trident 1.2 or later as the target system version. 5 After completing the conversion, you must perform a Download All (see Using the Download All Command on page 649). The following table identifies the changes made during a 3.x or 3.x project conversion. Table 1 Changes Made During Version 2.x or 3.x Project Conversion Item Description Application Snapshot The conversion removes the snapshot of the application which was saved during the last download. This means you will not be able to compare the current version of the project to the previously downloaded version of the project until after the first download. Application State The state of the application is changed to Download All. Multiple Program Instances If there are multiple instances of a program, each instance is converted to a new program document. The name of each new document is generated by appending _# to the program name, where # is a consecutive number starting at 1. For example, if there were two instances of program TankAlarm, the first instance is named TankAlarm_1, and the second is named TankAlarm_2. Naming Conflicts If renaming a program input or output results in a name conflict with a local variable, the name of the local variable is appended with ?Dup? and a message is written to the message output view. You must rename the local variable before compiling the program. TriStation 1131 Developer’s Guide, 4.14.0 Converting Existing Projects to Version 4.14.0 Table 1 21 Changes Made During Version 2.x or 3.x Project Conversion (continued) Item Description Trident System Variables If a tagname references a Trident system variable, the variable name is appended with ?Sys? and a message is written to the message output view. You must change the names and change the Point Type to memory. One way to do this is to replace the dot (period) in the name with an underscore and then delete the ?Sys? from the end of the name. You must also use the system status function blocks (SYS_*) to set the value of these variables. The best place to do this is in the first network in your program. The reason this must be done is that in this version of TriStation 1131, Trident system status values are only accessible by using the system status function blocks. Variable Changes In FBD, LD, and CEM programs, input and output variable declarations are changed to tagname declarations. In ST programs, all VAR_INPUT, VAR_OUTPUT, and VAR_IN_OUT declarations are changed to VAR_EXTERNAL. TriStation 1131 Developer’s Guide, 4.14.0 22 Chapter 1 Project Administration Creating a New Project This procedure explains how to create a new TriStation 1131 project. When a new project is created, Standard Security is enabled, and a user name and password are automatically created with the highest level of privileges—Level 01 (see Managing User Access on page 66). You are automatically logged on as this default user when the project is created. Note Each project is created for a single controller type (Tricon, Trident, or Tri-GP); you cannot create a single project for use with two or more controller types. Topics include: • The Project Workspace on page 22 • Creating a New Tricon Project on page 23 • Creating a New Trident Project on page 26 • Creating a New Tri-GP Project on page 28 The Project Workspace The Project Workspace includes two reports folders. • The standard reports included with TriStation 1131 are found in the Default Reports folder. See Viewing and Printing a Report on page 99. • Custom reports you create using the Crystal Reports software appear in the User Reports folder. See Adding Custom Reports to a Project on page 100. Other project features are accessed from the menus. For information about how you can change the location of the Project Workspace pane, see Customizing Your Workspace on page 114. TriStation 1131 Developer’s Guide, 4.14.0 Creating a New Project 23 Creating a New Tricon Project This procedure describes how to create a new project for a Tricon controller. Procedure 1 Open TriStation 1131. 2 On the File menu, click New Project. 3 From the Platform (controller) list, select Tricon, Tricon Low Density, or Tricon Enhanced Performance. Note Make sure to select the correct platform at the time of creating a project. After you create a project, you will be able to switch between the “Tricon” and the “Tricon Enhanced Performance” platforms, but you will not be able to switch to other platforms. For more information on switching between platforms, see Replacing a Tricon Main Chassis on page 360. If you want to change your project’s target system version to other Tricon controller versions, you can do so by converting your projects. For more information, see Changing the Tricon Target System Version on page 349. TriStation 1131 Developer’s Guide, 4.14.0 24 Chapter 1 Project Administration 4 Click OK to continue. 5 Navigate to the folder you want to save the project in, enter a file name, and click Save. Note TriStation 1131 projects must always be run from a local drive. Projects may be saved to a network drive for backup purposes, but you must copy the project to your local drive before you open it in TriStation 1131. The project’s file name (including the entire folder path) cannot exceed 235 characters. Also, the first character in the file name must be an alphanumeric character. TriStation 1131 Developer’s Guide, 4.14.0 Creating a New Project 6 25 Specify these properties in the Select Main Processor dialog box. Property Description Model The Main Processor model installed in the Tricona controller that this project will be downloaded to. • For Tricon system versions 9.5.x, 9.51.x, or 9.52.x, select 3006/N, 3007. • For Tricon system versions 9.6–10.x, select 3008/N/Cb. • For Tricon system version 11.x, select 3009. Target System Version The system version of the Tricon controller that this project will be downloaded to. Use the on-screen descriptions to help you determine the correct version to select, based on your Tricon system configuration. a. TriStation 1131 4.14.0 does not support Tricon system versions 9.4.x and earlier. For a list of TriStation 1131 versions compatible with your Tricon system, see the applicable Tricon Product Release Notice (available on the Global Customer Support website). b. The Tricon Enhanced Performance platform does not support the model 3008/N/C Main Processor, regardless of the system version. Note 7 If you are not sure which Main Processor model and Tricon system version to select, use the Enhanced Diagnostic Monitor to verify your Tricon system version information. See Determining Your Tricon Controller’s System Version on page 346 for more information. You should be sure to select the correct target system version, as changing the target system version at a later time will require a Download All. Click OK. Files that are used in TriStation 1131 are copied to the project. After the file creation process finishes, you are automatically logged on to the project using the default user name (MANAGER) and default password (PASSWORD). TriStation 1131 Developer’s Guide, 4.14.0 26 Chapter 1 Project Administration Creating a New Trident Project This procedure describes how to create a new project for a Trident controller. Procedure 1 Open TriStation 1131. 2 On the File menu, click New Project. 3 From the Platform (controller) list, select Trident. 4 Click OK to continue. 5 In the Filename for New Project dialog box, navigate to the folder you want to save the project in, enter a file name, and click Save. Note TriStation 1131 projects must always be run from a local drive. Projects may be saved to a network drive for backup purposes, but you must copy the project to your local drive before you open it in TriStation 1131. The project’s file name (including the entire folder path) cannot exceed 235 characters. Also, the first character in the file name must be an alphanumeric character. TriStation 1131 Developer’s Guide, 4.14.0 Creating a New Project 6 27 Specify these properties in the Select Main Processor dialog box. Property Description Model The Main Processor model installed in the Trident controller that this project will be downloaded to. Target System Version The system version of the Tridenta controller that this project will be downloaded to. Use the on-screen descriptions to help you determine the correct version to select, based on your Trident controller configuration. a. TriStation 1131 4.14.0 does not support Trident system versions 1.1 and earlier. For a list of TriStation 1131 versions compatible with your Trident system, see the applicable Trident Product Release Notice (available on the Global Customer Support website). Note 7 If you are not sure which Main Processor model and Trident system version to select, see Determining Your Trident or Tri-GP Controller’s System Version on page 444. You should be sure to select the correct target system version, as changing the target system version at a later time will require a Download All. Click OK. Files that are used in TriStation 1131 are copied to the project. After the file creation process finishes, you are automatically logged on to the project using the default user name (MANAGER) and default password (PASSWORD). TriStation 1131 Developer’s Guide, 4.14.0 28 Chapter 1 Project Administration Creating a New Tri-GP Project This procedure describes how to create a new project for a Tri-GP controller. Procedure 1 Open TriStation 1131. 2 On the File menu, click New Project. 3 From the Platform (controller) list, select Tri-GP. 4 Click OK to continue. 5 In the Filename for New Project dialog box, navigate to the folder you want to save the project in, enter a file name, and click Save. Note TriStation 1131 projects must always be run from a local drive. Projects may be saved to a network drive for backup purposes, but you must copy the project to your local drive before you open it in TriStation 1131. The project’s file name (including the entire folder path) cannot exceed 235 characters. Also, the first character in the file name must be an alphanumeric character. TriStation 1131 Developer’s Guide, 4.14.0 Creating a New Project 6 Specify these properties in the Select Main Processor dialog box. Property Description Model The Main Processor model installed in the Tri-GP controller that this project will be downloaded to. Target System Version The system version of the Tri-GP controller that this project will be downloaded to. Use the on-screen descriptions to help you determine the correct version to select, based on your TriGP controller configuration. Note 7 29 If you are not sure which Main Processor model and Tri-GP system version to select, see Determining Your Trident or Tri-GP Controller’s System Version on page 444. You should be sure to select the correct target system version, as changing the target system version at a later time will require a Download All. Click OK. Files that are used in TriStation 1131 are copied to the project. After the file creation process finishes, you are automatically logged on to the project using the default user name (MANAGER) and default password (PASSWORD). TriStation 1131 Developer’s Guide, 4.14.0 30 Chapter 1 Project Administration Working with Projects This section explains how to open and log on to an existing project, add audit comments and a description, view project version information and save an existing project. Topics include: • Logging On to an Existing Project on page 30 • Using the Triconex Single Logon Service on page 34 • Using the TriStation 1131 Project Launcher Utility on page 35 • Adding a Project Description on page 37 • Adding Audit Comments on page 38 • Displaying Version Numbers of Projects and Documents on page 39 Logging On to an Existing Project Only one project can be opened at a time. TriStation 1131 projects must always be run from a local drive. A project that has been saved to a network drive must be copied to your local drive before you open it. When a project file (.pt2) is open in one instance of TriStation 1131, you cannot open the same file in another instance of TriStation 1131. Note When you open a project by double-clicking the file in Windows Explorer, the Project Launcher utility automatically opens the file using the appropriate version of TriStation 1131. For more information, see Using the TriStation 1131 Project Launcher Utility on page 35. Depending on the current security setting, you may need to log on using your Windows user name and password. • If Standard Security is enabled, there is no limit on the number of times you can attempt to enter your user name and password. • If Enhanced Security is enabled, the number of times you can attempt to enter your user name and password is determined by your Windows domain setting. For example, if your Windows domain setting is limited to three logon attempts, after three unsuccessful attempts to log on to the project, your user account will be locked out. If this occurs, ask your network administrator to reset your Windows account. Note If an existing TriStation 1131 project was created by a user with restricted or administrator-level rights in Windows, other users may be unable to open that project. Windows security file access rules apply to all TriStation 1131 project files. You must have read/write access to a TriStation 1131 project, and the folder it is located in, to be able to open the project. If you are unable to open a TriStation 1131 project created by another user, contact your network or system administrator for assistance with changing the access rights for the selected project file and/or file location. TriStation 1131 Developer’s Guide, 4.14.0 Working with Projects 31 Topics include: • Logging On for the First Time When Enhanced Security Is Enabled on page 31 • Logging On When Standard Security Is Enabled on page 31 • Logging On When Enhanced Security Is Enabled on page 32 • Troubleshooting Logon Problems on page 33 Logging On for the First Time When Enhanced Security Is Enabled If you are a new user, the first time you log on to a project when Enhanced Security is enabled, you may need to log on twice: • First, you need to enter your Windows user name and password, to authenticate against the Windows domain. • If Windows authentication is successful, you then need to enter your Windows user name and TriStation 1131 password (NOT your Windows password), to authenticate against the project’s user list. If both authentications are successful, all subsequent logons will require you to enter only your Windows user name and password to access the project. Logging On When Standard Security Is Enabled When Standard Security is enabled, you must use your TriStation 1131 user name and password to log on. Procedure 1 Open TriStation 1131 and on the File menu, click Open Project. 2 Select the folder to look in, click the project to be opened, and then click Open. Note If a more recent autosaved version of the project is available, you will be prompted to open the autosaved version. If you choose to open it, the name of the project file will be appended with a date stamp, and the extension will be TriStation 1131 Developer’s Guide, 4.14.0 32 Chapter 1 Project Administration changed to .bk2. The autosaved version will be renamed with the project file name, with the extension .pt2, and then opened. An autosaved version of your project file may be available only if you have enabled the Automatic Project File Save option. For more information, see Specifying General Options on page 55. 3 Enter a user name and password. The default user name is MANAGER. The default password is PASSWORD. 4 Click Log On. The project opens. Logging On When Enhanced Security Is Enabled When Enhanced Security is enabled, you must use your Windows user name and password to log on. Your user information will be authenticated against Windows Active Directory, as well as the project’s user list. If you are having problems logging on using your Windows user information, see Troubleshooting Logon Problems on page 33. Procedure 1 Open TriStation 1131 and on the File menu, click Open Project. 2 Select the folder to look in, click the project to be opened, and then click Open. The Windows logon dialog box appears. Note If a more recent autosaved version of the project is available, you will be prompted to open the autosaved version. If you choose to open it, the name of the project file will be appended with a date stamp, and the extension will be changed to .bk2. The autosaved version will be renamed with the project file name, with the extension .pt2, and then opened. An autosaved version of your project file may be available only if you have enabled the Automatic Project File Save option. For more information, see Specifying General Options on page 55. 3 Enter your Windows user name (including domain, if necessary) and password, and click OK. TriStation 1131 Developer’s Guide, 4.14.0 Working with Projects 33 Troubleshooting Logon Problems The following are common problems you may encounter when trying to log on to a TriStation 1131 project. Problem Solution The following error message appears: This message appears when Enhanced Security is enabled, and you clicked OK in the Logon dialog box without entering your Windows user name and/or password. “The parameter is incorrect.” The following error message appears: “Logon failure: unknown user name or bad password.” When you click OK in the error message box, the Logon dialog box will appear again. Be sure not to leave the user name and/or password field blank. This message appears when Enhanced Security is enabled, and you do one of the following in the logon dialog box: • Enter an incorrect Windows user name that has not been added to the project’s user list. • Enter an incorrect password. In this case, TriStation 1131 is unable to authenticate your user information with Windows. When you click OK in the error message box, the logon dialog box will appear again. Verify that you are trying to log on with the correct Windows user name and password. User names and passwords are case-sensitive. Verify that the CAPS LOCK key is not on when you enter your user information. The following error message appears: “You are not authorized to open this project because your user name was not found in the project’s user list.” This message appears when Enhanced Security is enabled, and you enter a Windows user name that has not been added to the project’s user list for the project you are trying to open. When you click OK in the error message box, the logon dialog box will appear again. Verify that you are trying to log on with the correct Windows user name and password. User names and passwords are case-sensitive. Verify that the CAPS LOCK key is not on when you enter your user information. The following error message appears: This message appears when Enhanced Security is enabled and you are trying to log on using a Windows “Guest” account. “Logon failure: the user has not been granted the requested logon type at this computer.” Windows “Guest” accounts are used to provide access to a computer when you do not have a Windows user account on that computer. In order for you to be able to log on to a TriStation 1131 project with a “Guest” account, ask your network or system administrator to do the following: • Remove the “Guest” user from the Windows Local Security Policy “Deny access to this computer from the network” list. • Enable the “Accounts: Guest account status” option in the Windows Local Security Policy security options list. TriStation 1131 Developer’s Guide, 4.14.0 34 Chapter 1 Project Administration Using the Triconex Single Logon Service The Triconex Single Logon service enables you to log back on to a TriStation 1131 project without re-entering your username and password, if your logon attempt is within 10 minutes of closing the project. This feature is valid for only 10 minutes after a project is closed. If you open the project again after this 10-minute period has passed, you will need to re-enter your username and password to log back on. Each time a project is closed, the 10-minute period starts again. For example, assume you close a project at 12:05. You have until 12:15 to open the project without logging on again. Eight minutes later, at 12:13, you open it to make a minor change. When you close the project again at 12:18, the 10-minute time period starts over, and you can open the project without logging on again until 12:28. Triconex Single Logon is a secure service that uses RSA cryptography to access user credentials, and applies to projects using both Enhanced Security and Standard Security. When you log on to a project, the date and time of your last logon is displayed in the Project Logon dialog box, as shown below. Note When a project is opened within the 10-minute time period, the Single Logon service uses the credentials of the last user to log on to the project. If you open a project that was previously closed by another user within the 10-minute period, you will be logged on as the previous user. To log on as a different user, you must wait until the 10-minute period has passed, or use the “Log On As New User” command on the File menu. Enabling Single Logon Single Logon is enabled only if you installed the Triconex Single Logon service during TriStation 1131 installation. For more information on installing this service, see Installing the TriStation 1131 Software on page 6. If you want to disable the single logon capability for security reasons, you can stop the Triconex Single Logon service from the Windows Task Manager. If you want to uninstall the Triconex Single Logon service, you can modify the TriStation 1131 4.14.0 installation by clearing the check box associated with this service in the installation wizard. Whenever the Single Logon service is installed, started, or stopped, Windows stores a log of these events in the Windows System Events Log. You should periodically review these logs to ensure there has been no unauthorized access to the service. For more information on event logs, see Viewing User Access Logs on page 84. TriStation 1131 Developer’s Guide, 4.14.0 Working with Projects 35 Using the TriStation 1131 Project Launcher Utility The TriStation 1131 Project Launcher utility enables you to automatically open the appropriate version of TriStation 1131, when you open a TriStation 1131 project file (.pt2) in Windows Explorer. For more information on opening an existing project, see Logging On to an Existing Project on page 30. When you double-click a project file in Windows Explorer, the Project Launcher utility first checks the project file to identify the TriStation 1131 version the project file was last saved with, and then opens the file using that version of TriStation 1131. It supports only project files created using TriStation 1131 4.x or later. Note Because the Project Launcher utility applies only to TriStation 1131 versions 4.14.0 and later, the last installed version MUST be TriStation 1131 4.14.0. If necessary, make sure you install previous versions of TriStation 1131 before installing TriStation 1131 4.14.0. Installing a previous version of TriStation 1131 after you have installed TriStation 1131 4.14.0 will cause the Project Launcher utility to no longer work. To correct this, simply uninstall and then reinstall TriStation 1131 4.14.0. You can also upgrade a project file from TriStation 1131 4.x to a later version using the Project Launcher utility, if those TriStation 1131 versions are already installed on the target PC. The TriStation1131 Project Launcher utility is automatically installed with TriStation 1131 4.14.0 or later. Because the TriStation 1131 Project Launcher utility is designed to run in the background, you will only be prompted for action when the project needs to be upgraded to a later version of TriStation 1131. Otherwise, the project file is opened using the appropriate version of TriStation 1131. Note To take advantage of the Project Launcher utility functionality if you right-click a project file to open it from Windows Explorer, you must select Open with > Ts2Selector. Upgrading a Project File In the following situations, you need to upgrade your project file to a newer version of TriStation 1131: • The project file you are opening was last saved using TriStation 1131 3.x or earlier. • The project file you are opening was last saved using TriStation 1131 4.x, but that version of TriStation 1131 is not installed on the PC. Upgrading a TriStation 1131 3.x Project File If the project file was last saved using TriStation 1131 3.x, you cannot open it by double-clicking the file in Windows Explorer. The following message appears: TriStation 1131 Developer’s Guide, 4.14.0 36 Chapter 1 Project Administration You must upgrade the file to TriStation 1131 4.x by doing the following: 1 Open the version of TriStation 1131 you want to upgrade the project to (for example, TriStation 1131 4.14.0). 2 From the File menu, click Open Project. 3 Follow the instructions in Converting Existing Projects to Version 4.14.0 on page 13. Upgrading a TriStation 1131 4.x Project File If the project file was last saved using TriStation 1131 4.x, but that version of TriStation 1131 is not installed on the PC, the following dialog box appears: To upgrade the project, do the following: 1 Select the version of TriStation 1131 you want to upgrade the project to. 2 Click Open. 3 When prompted to open the project using the selected version, click Yes. 4 Follow the instructions in Converting Existing Projects to Version 4.14.0 on page 13. TriStation 1131 Developer’s Guide, 4.14.0 Working with Projects 37 Adding a Project Description This procedure explains how to add a description to a TriStation 1131 project (.pt2). The Project Description dialog box displays information about the project, including the version of the project being developed and the version of the project downloaded to the controller, which may be different. It also displays information about the status of the project file —whether the project was modified, built, or downloaded successfully. For more information on the description of each project status, see Project File Status on page 792. CAUTION Do not use the Windows file properties dialog box to maintain descriptive information about your project. Changing or adding information to the Summary tab in the Windows File Properties dialog box for a project file will prevent TriStation 1131 from opening the file. There is no way to recover a project file that has been changed in this way. Procedure 1 On the Project menu, click Project Description. 2 Enter a description of any length for the project. 3 Click OK to save. TriStation 1131 Developer’s Guide, 4.14.0 38 Chapter 1 Project Administration Adding Audit Comments This procedure explains how to add comments when you change a program, function, or function block. These comments provide an audit trail which can be viewed in reports. Note You can also add audit trail comments when compiling or saving a program, and building an application. See Building or Rebuilding an Application on page 327. Procedure 1 Close a program, function, or function block that was changed. The following dialog box appears, allowing you to describe the changes before the element is saved. 2 Enter a comment and click OK. TriStation 1131 Developer’s Guide, 4.14.0 Working with Projects 39 Displaying Version Numbers of Projects and Documents This procedure explains what version numbers are and how they can be viewed. Version numbers are used with the project under development (current version), the downloaded application (downloaded version), and project elements. Version numbers include a major (first), minor (second), and EmulatorCount (third) number, each separated by a period. For example, in version 3.7.12, the major version is 3, the minor version is 7, and the EmulatorCount version is 12. Differences in the Project’s Downloaded Version The project’s downloaded version is different for the Emulator and the controller. • The controller downloaded project version is the last version of the project file (.pt2) downloaded to the controller. The version is provided in the format major.minor (for example, in version 3.7, the major version is 3 and the minor version is 7). • The Emulator downloaded project version is the last version of the project file (.pt2) downloaded to the Emulator. The version is provided in the format major.minor.EmulatorCount (for example, in version 3.7.12, the major version is 3, the minor version is 7, and the EmulatorCount is 12). — The major.minor version is the same as the last controller downloaded project version. — The EmulatorCount value is incremented sequentially after either a Download All or a Download Changes to the Emulator. Note The complete list of downloaded version changes can be viewed in the Project History dialog box. See View Project History Command on page 865. Procedure for Projects 1 On the Project menu, click Project Description. TriStation 1131 Developer’s Guide, 4.14.0 40 Chapter 1 Project Administration 2 View these properties in the Project Description dialog box. Property Description Current Version The version of the project which is under development. Downloaded Version The version of the project (application) which was last downloaded to the controller or the Emulator. Use the View Project History Command on page 865 to see the complete list of downloaded version changes. 3 Click OK to close the dialog box. Procedure for Documents 1 Expand the Application Workspace (see The Application Workspace on page 126), and right-click a document. 2 On the shortcut menu that appears, click Properties. The Document Properties dialog box appears. 3 On the Summary tab, view the Name property. The version of the document is located at the end of the name. For example, if the document name is displayed as LightEmUp - v1.26, the version number is 1.26. 4 Click OK to close the dialog box. TriStation 1131 Developer’s Guide, 4.14.0 Specifying Project Options 41 Specifying Project Options Project Options are settings that specify the language, annotation, monitor, download, and Emulator settings used when new project elements are created. When you create new elements in a project, default settings are used unless you specify different settings. For example, the Default Language property is set to Function Block Diagram, which means that a new function is automatically created in FBD language unless you specify another language. You can change the default settings when you begin a new project or at any time during project development. The settings only affect new elements. Topics include: • Specifying Language Options on page 42 • Specifying Annotation Options on page 43 • Specifying Monitor Colors for BOOL Values on page 45 • Specifying Forced Points Options on page 46 • Specifying Download Options on page 47 • Specifying Emulator Options on page 50 TriStation 1131 Developer’s Guide, 4.14.0 42 Chapter 1 Project Administration Specifying Language Options This procedure explains how to specify the language and element types used to create new programs, functions, and function blocks. Procedure 1 On the Project menu, click Project Options, and then click the Language tab. 2 Specify these properties on the Language tab. 3 Property Action Default Language Specify the type of programming language to use when creating a program, function, function block, or data type. The default is Function Block Diagram. Enabled Features Select the check box for each feature (programs, functions, function blocks, data types, and multiple programs) that can be created in the project. The default is selected for all features. Click OK to save the settings. TriStation 1131 Developer’s Guide, 4.14.0 Specifying Project Options 43 Specifying Annotation Options Annotations can be used to display descriptive text about a constant, tagname, or variable, including information specified in system and user-modifiable macros. This procedure explains how to specify whether annotations are automatically included when comments and variables are created and whether the value is shown when an application is monitored. You can also specify text or macros to be included in annotations. Procedure 1 On the Project menu, click Project Options, and then click the Annotations tab. 2 Specify these properties on the Annotations tab. Property Action Annotation on by Default Select the check box to have annotation boxes automatically added to variables used with a program, function, or function block. The default is cleared. Monitor Value on by Default Select the check box to have the value of the variable displayed when the program or function block is executed. The default is cleared. Alignment Specify how to align the text in an annotation or comment. The default is Left. Border Specify the type of border to include with an annotation or comment. The default is Single. TriStation 1131 Developer’s Guide, 4.14.0 44 Chapter 1 Project Administration Property Action Text Size Specify the point size for text used in the project. The default settings are: A (6 points), B (8 points), C (10 points), and D (10 points.) Default Macros or Text Specify the default macro or text to be included with a program or function variable. The program variable defaults are: Tag Refs: %PGM_TAGNAME Locals: %PGM_LOCAL The function and function block variable defaults are: Input: %FB_INPUT Output: %FB_OUTPUT Local: %FB_LOCAL I/O: %FB_IO See Using Macros with Annotations and Comments on page 270 for more information. 3 Click OK to save the settings. TriStation 1131 Developer’s Guide, 4.14.0 Specifying Project Options 45 Specifying Monitor Colors for BOOL Values This procedure explains how to specify what colors are displayed for BOOL True and False values when the application is run on the controller or Emulator. This feature allows you to change the colors to meet an industry or corporate standard. Procedure 1 On the Project menu, click Project Options, and then click the Monitor Colors tab. 2 Specify these properties on the Monitor Colors tab. Property Action General Monitor Colors Select the color for True and False for BOOL variables and wires. The default for True is red; False is green. CEM Monitor Colors Select the color for True and False for cause, effect, and intersection cells in a CEM (cause and effect matrix). The default for True is red; False is white. 3 Click OK to save the settings. TriStation 1131 Developer’s Guide, 4.14.0 46 Chapter 1 Project Administration Specifying Forced Points Options This procedure explains how to specify if you want to be prompted to enter an optional comment when enabling, disabling, or forcing points on the controller or Emulator. Comments appear in the Project History log. For more information about disabling or forcing points, see Disabling Points on page 640 and Forcing Points on page 644. Procedure 1 On the Project menu, click Project Options, and then click the Forced Points tab. 2 Specify if you want to be asked to enter a comment when performing the following actions: • Enabling a point • Disabling a point • Forcing a point to a specific value Select the check box if you want to be asked; clear the check box if you do not want to be asked. All check boxes are selected by default (you will be asked for a comment). 3 Click OK to save the settings. TriStation 1131 Developer’s Guide, 4.14.0 Specifying Project Options 47 Specifying Download Options Depending on how your system is configured, there are three options related to downloading an application: • Specifying the Tagnames Table Sort Order on page 47 • Specifying Automatic Download Verification on page 48 • Specifying Automatic Copying of the Project File to the Controller on page 49 Specifying the Tagnames Table Sort Order This procedure explains how to specify download options for the tagnames table downloaded to the TCM’s embedded OPC server (models 4353 and 4354 only). If a model 4353 or 4354 TCM is configured and installed in the Tricon controller, a table with information about the tagnames and system variables configured in the project is downloaded to the TCM’s embedded OPC server during a Download All or Download Changes operation. • During a Download All operation, the table is downloaded even if no changes have been made to the table. • During a Download Changes operation, the table is downloaded only if there have been changes to the table since the last download, including a change to the sort order. Tagname information from this table is used to help you configure your third-party OPC client to monitor Tricon system variables and tagnames. The sort order controls how the information is displayed in the OPC client. • Sort the table alphabetically to view tagnames in a single, non-hierarchical list, organized in alphabetical order, regardless of their group assignments. This sort order is useful for small projects without a lot of tagnames. • Sort the table by group to view tagnames in an hierarchical list, where tagnames are organized according to the groups they are assigned to. This sort order is useful for large projects with many tagnames. Note Because the tagnames table is used only for ease of OPC client configuration and is not needed during normal Tricon system operation, your choice of sort order will not have any impact on TCM performance. The tagnames table is applicable only for the Tricon controller, and not for a Trident controller. For more information about the TCM’s embedded OPC server and configuring your OPC client to access Tricon tagnames and system variables, see the Communication Guide for Tricon v9-v11 Systems. TriStation 1131 Developer’s Guide, 4.14.0 48 Chapter 1 Project Administration Procedure 1 On the Project menu, click Project Options, and then click the Download tab. 2 Select the sort order for the table: • Sort by Tagname (alphabetical view) • Sort by Group (hierarchical view) The default is Sort by Tagname. 3 Click OK to save the change. Specifying Automatic Download Verification Once you have downloaded your application to the controller, you may want to verify that the program elements on the controller are the same as those in the TriStation 1131 project. You can perform this download verification manually, or you can enable automatic download verification, so that verification occurs after every Download All or Download Changes operation. Notes For more information about what happens during a download verification, and instructions for performing a manual download verification, see Verifying the Download to the Controller on page 623. If you configured your project settings to allow automatic copying of the project file after a download operation, download verification will occur only after the copy operation is complete. For more information about automatically copying a project file, see Specifying Automatic Copying of the Project File to the Controller on page 49. TriStation 1131 Developer’s Guide, 4.14.0 Specifying Project Options 49 Procedure 1 On the Project menu, click Project Options, and then click the Download tab. 2 Select the Download Verification check box. 3 Click OK to save the change. Specifying Automatic Copying of the Project File to the Controller Once you have downloaded your application to the controller, you can create a backup of your project file by copying it to the controller. You can perform the copy operation manually, or you can choose to automatically copy the file immediately after a Download All or Download Changes operation. For more information on manually copying the project file, see Copying a Project File to the Controller on page 328. Note This option is available only when the target system version is Tricon 11.1 or later. Procedure 1 On the Project menu, click Project Options, and then click the Download tab. 2 Select the Automatically copy the project file to the controller after download check box. 3 Click OK to save the change. TriStation 1131 Developer’s Guide, 4.14.0 50 Chapter 1 Project Administration Specifying Emulator Options This procedure explains how to specify Emulator project options in TriStation 1131. You can change the default settings when you begin a new project or at any time during project development. Emulator project options should be set prior to starting the Emulator. Options changed while the Emulator is running will not take effect until the Emulator is stopped and restarted. Emulator project options are saved on a per-project basis, and do not need to be reconfigured each time you start the Emulator. For more information about the Emulator, see the Triconex Emulator User’s Guide, or the Emulator Help (available from the TriStation 1131 Help menu). Procedure 1 On the Project menu, click Project Options, and then click the Emulator tab. 2 Specify these properties on the Emulator tab. TriStation 1131 Developer’s Guide, 4.14.0 Specifying Project Options Property Action Close Active Instance on Disconnect Select if you want the active Emulator instance to close when TriStation 1131 disconnects from the Emulator. 51 When this option is selected, the active Emulator instance (the instance that TriStation 1131 is currently connected to) is automatically closed when TriStation 1131 disconnects from the Emulator. This is the same as the “Single Instance” option in previous versions of TriStation 1131. If this option is not selected, all Emulator instances, including the active instance, remain open when TriStation 1131 disconnects from the Emulator. This allows more than one instance of the Emulator to be running at the same time. In this case, Emulator instances must be closed manually. This is the same as the “Multiple Instances” option in previous versions of TriStation 1131. The default is selected (only one instance of the Emulator can be running). See the Triconex Emulator User’s Guide for more information. Emulator Timeout Select the timeout value for the connection to the Emulator. During a Download All or Download Changes operation on the Emulator, the processing time required for applications with a very large number of variables (symbols) may exceed the default Emulator timeout value of 4 seconds. If you receive a “download aborted” message when downloading an application to the Emulator, disconnect from the Emulator, increase the Emulator timeout value, reconnect to the Emulator, and then try downloading again. Note: In most cases, you should not have to change this value. The default timeout value should be adequate for the majority of applications. The valid range is from 0 to 65,535 seconds. The default is 4 seconds. TriStation 1131 Developer’s Guide, 4.14.0 52 Chapter 1 Project Administration Property Action Emulator File Generation Select the files you want generated each time you download the application to the Emulator. • Select the BT2 check box if you want a backup project file (.bt2) generated (not recommended). • Select the SOE check box if you want an SOE definition file (.soe or .soex) generated. If you want to be able to test your SOE configuration with the Emulator, you must select this option. For more information about the SOE definition file, see the Triconex SOE Recorder User’s Guide. If selected, the backup project file and/or SOE definition file are generated in the same directory where the TriStation 1131 project is located. The default setting is for the files to not be generated. Note: These files will look just like the backup project files and SOE definition files generated by TriStation 1131 when you download an application to the controller. You will not be able to distinguish between files generated by a download to the Emulator, and files generated by a download to the controller. You may want to make a note of the date and time each time you download the application to the Emulator, so you can compare that timestamp to the date/time of the generated files. Communication Modules (CMs) for Peer-to-Peera Optional. Required only if you want to test Peer-to-Peer communication using the Emulator. Select the communication module you want to get Peer-to-Peer configuration information from and then select the network that the communication module you selected is connected to. The default is NET 1. Note: If no communication modules are listed, you have not configured any communication modules for Peer-to-Peer communication in your project. The Peer-to-Peer configuration from the selected communication module will be used by the Emulator so that you can test your Peerto-Peer functionality using emulated nodes. Only one Peer-to-Peer configuration can be used by the Emulator. If redundant communication modules are installed in a single logical slot, you must select the physical communication module (LEFT or RIGHT) with the configuration you want to use. The default is LEFT. See the Triconex Emulator User’s Guide for more information about using Peer-to-Peer communication with the Emulator. TriStation 1131 Developer’s Guide, 4.14.0 Specifying Project Options Property Action Communication Modules (CMs) for Modbusa Optional. Required only if you want to test Modbus communication using the Emulator. 53 Select the communication module you want to get Modbus configuration information from and then select the network that the CM you selected is connected to. The default is NET 1. Note: If no communication modules are listed, you have not configured any communication modules for Modbus communication in your project. The Modbus configuration from the selected communication module will be used by the Emulator so that you can test your Modbus functionality using emulated nodes. Only one Modbus configuration can be used by the Emulator. If redundant communication modules are installed in a single logical slot, you must select the physical communication module (LEFT or RIGHT) with the configuration you want to use. The default is LEFT. See the Triconex Emulator User’s Guide for more information about using Modbus communication with the Emulator. a. In this dialog box, “CMs” applies to all types of communication modules, including the TCM, UCM, CM, and CIM. 3 Click OK to apply your changes and save the settings. TriStation 1131 Developer’s Guide, 4.14.0 54 Chapter 1 Project Administration Specifying TriStation 1131 Options TriStation 1131 options include properties that affect the TriStation 1131 interface. All the properties included in the Options dialog box have default settings that specify how features are initially configured. For example, the Wire Tool property can be specified for right-handed or left-handed use. You can change these settings at any time during project development. The settings you configure are saved for your user ID only. Topics include: • Specifying General Options on page 55 • Specifying Directory Locations on page 58 • Specifying Drawing Colors on page 59 • Specifying FBD Editor Options on page 60 • Specifying LD Editor Options on page 61 • Specifying CEM Editor Options on page 62 TriStation 1131 Developer’s Guide, 4.14.0 Specifying TriStation 1131 Options 55 Specifying General Options You can choose to automatically save your TriStation 1131 project file at regular intervals. This enables you to recover the most recent version of the project file, in cases when a project file becomes corrupted, or when you could not manually save it when exiting TriStation 1131 (for example, in the event of a system crash). An auto-save file is stored in the same location as your project file, with “(autosaved)” appended to the name of the file. An autosave file does not have a filename extension. This option applies to ALL instances of TriStation 1131 on a single PC. For more information, see Using the Auto Save Option with Multiple Instances of TriStation 1131 on page 57. Note If you successfully save a project file prior to exiting TriStation 1131, the autosaved version is deleted. When you open a project file that has a more recent autosaved version, you will be prompted to open the autosaved version. If you choose to open it, the name of the project file will be appended with a date stamp, and the extension will be changed to .bk2. The autosaved version will be renamed with the project file name, with the extension .pt2. The current status of the auto save option is visible in the Status Bar at the bottom of the TriStation 1131 window. Auto Save Indicator This procedure explains how to enable automatic saving of a project file. TriStation 1131 Developer’s Guide, 4.14.0 56 Chapter 1 Project Administration Procedure 1 On the Tools menu, click TriStation 1131 Options, and then click the General tab. 2 Specify these properties on the General tab. Property Action Enable Auto Save Select the check box to automatically save the project file. The default is selected. Time Specify the interval at which the project file will be automatically saved. The default is 10 minutes, meaning an autosave file will be created or updated every 10 minutes. The valid range is from 1 to 60 minutes. Note: While a project file is being saved, you will momentarily be unable to perform any task in TriStation 1131. DO NOT click anywhere in the TriStation 1131 window while the file is being saved. The time needed to save a file depends on the size of the file. If you choose to save at shorter time intervals, you may experience frequent interruptions. Therefore, it is recommended that you retain the default setting, or choose a time interval greater than 10 minutes. 3 Click OK to save the settings. TriStation 1131 Developer’s Guide, 4.14.0 Specifying TriStation 1131 Options 57 Using the Auto Save Option with Multiple Instances of TriStation 1131 Because the auto save option applies to ALL instances of TriStation 1131 on a single PC, another instance can override a previously selected auto save option setting. In this case, the following warning message appears: If you see this message, do one of the following: • To apply the Enable Auto Save check box selection shown in the dialog box to this instance, click OK. • To keep the current setting in this instance, as indicated in the Status Bar, click Cancel. Example For example, assume you have two open instances of TriStation 1131: Instance A and Instance B. In Instance A, you select the Enable Auto Save check box, and select a time interval of 15 minutes, so that the auto save option is turned on. AUTOSAVE ON (15) appears in the status bar of Instance A. When you switch to Instance B, the auto save option remains off, until you do the following: 1 On the Tools menu, click TriStation 1131 Options, and then click the General tab. The auto save setting shown in the dialog box reflects the setting that was selected in Instance A. The current auto save setting for Instance B is shown in the status bar. The warning message appears in the dialog box, letting you know the setting was changed in the other instance. 2 Click OK to accept the setting that was selected in Instance A. AUTOSAVE ON (15) now appears in the status bar of Instance B. TriStation 1131 Developer’s Guide, 4.14.0 58 Chapter 1 Project Administration Then, while you are working in Instance B, you decide to turn off the auto save option by clearing the Enable Auto Save check box. The auto save option is now turned off in Instance B, and AUTOSAVE OFF appears in the status bar. Now, when you go back to Instance A, the auto save option is still turned on, as indicated by AUTOSAVE ON (15) appearing in the status bar. To apply the setting from Instance B to Instance A, open the TriStation 1131 Options dialog box, where the Enable Auto Save check box is cleared and the warning message appears, and then click OK. AUTOSAVE OFF will now appear in the status bar of Instance A. Specifying Directory Locations This procedure explains how to specify the locations for project, library, and report files. Procedure 1 On the Tools menu, click TriStation 1131 Options, and then click the Directories tab. 2 Specify these properties on the Directories tab. Property Action Project Files Enter the path. The default is: C:\ProgramData\Triconex\TriStation 1131 4.14.0\Projects. Data Files Enter the path. The default is: C:\ProgramData\Triconex\TriStation 1131 4.14.0\Data. Temporary Files Enter the path. The default is: C:\ProgramData\Triconex\TriStation 1131 4.14.0\Temp. Use Defaults Click the Use Defaults button to return the settings to the default paths. Note 3 TriStation 1131 projects must always be run from a local drive. You should not enter directory paths that point to a location on your network. Click OK to save the settings. TriStation 1131 Developer’s Guide, 4.14.0 Specifying TriStation 1131 Options 59 Specifying Drawing Colors This procedure explains how to specify the colors used for items in the programming editors. The default drawing colors are based on the Windows color scheme selected in Control Panel. Procedure 1 On the Tools menu, click TriStation 1131 Options, and then click the Drawing Colors tab. 2 Specify these properties on the Drawing Colors tab. 3 Property Action Drawing Item Select an item to be shown in a color. Change Colors Command Click to display a color palette from which to choose a color for the selected drawing item. Default Colors Command Click to change the colors of all items to the default colors. Click OK to save the settings. TriStation 1131 Developer’s Guide, 4.14.0 60 Chapter 1 Project Administration Specifying FBD Editor Options This procedure explains how to specify Function Block Diagram (FBD) Editor settings that are used throughout the project unless changed on a specific FBD function. You can also change the Double Space and EN/ENO properties for a specific function. Procedure 1 On the Tools menu, click TriStation 1131 Options, and then click the FBD Editor tab. 2 Specify these properties on the FBD Editor tab. 3 Property Action Double Space Function (Block) Terminals by Default Select the check box to automatically have the spacing doubled between terminals (inputs and outputs) on the function block, which creates additional space for annotation. The default is cleared. Enable EN/ENO Terminals on Functions by Default Select the check box to automatically enable EN/ENO terminals on functions. The default is cleared. Left-Handed Wire Tool Select the check box to enable the wire tool for lefthanded use. The default is cleared. Click OK to save the settings. TriStation 1131 Developer’s Guide, 4.14.0 Specifying TriStation 1131 Options 61 Specifying LD Editor Options This procedure explains how to specify Ladder Diagram (LD) editor settings that are used throughout the project unless changed on a specific LD function. You can also change the Double Space property for a specific function. Procedure 1 On the Tools menu, click TriStation 1131 Options, and then click the LD Editor tab. 2 Specify these properties on the LD Editor tab. 3 Property Action Double Space Function (Block) Terminals by Default Select the check box to automatically have the spacing doubled between terminals (input and output parameters) on the function block, which adds space for annotation. The default is cleared. Compiler Warning When Right Power Rail is Missing Select the check box to display a compiler warning if the right (power) rail is missing from a Ladder Diagram function. The default is cleared. Left-Handed Link Tool Select the check box to enable the link tool for lefthanded use. The default is cleared. Click OK to save the settings. TriStation 1131 Developer’s Guide, 4.14.0 62 Chapter 1 Project Administration Specifying CEM Editor Options This procedure explains how to set the options used as initial settings for all the CEM (cause and effect matrix) programs in a project. After a program is created, you can modify these settings on a program-by-program basis. Procedure 1 On the Project menu, click TriStation 1131 Options, and then click the CEM Editor tab. 2 Specify these properties on the CEM Editor tab. 3 Property Action Cause Header Functions On by Default Select the check box to automatically add input and function columns. The default is cleared. Effect Header Functions On by Default Select the check box to automatically add output and function columns. The default is cleared. Intersection Functions On by Default Select the check box to automatically add function columns. The default is cleared. Default Number of Cause Rows Enter the number of rows to include in a new matrix. The default is 22. Default Number of Effect Columns Enter the number of columns to include in a new matrix. The default is 25. Click OK to save the settings. TriStation 1131 Developer’s Guide, 4.14.0 Adding or Removing Custom Help Files 63 Adding or Removing Custom Help Files TriStation 1131 allows you to add a maximum of 32 customized HTML Help files (.chm) to the TriStation 1131 Help menu. Customized Help files allow users to reference specialized information related to application development, without having to leave TriStation 1131. Some ways you can use this feature include: • If you have added your own custom libraries to TriStation 1131, this feature allows you to provide customized Help for these libraries. • If you have specific sets of instructions for creating a safety or control application in your organization, this feature allows you to provide a customized Help file with that information. You are responsible for the creation of the Help files you want to add to the TriStation 1131 Help menu. Help files must be in the compiled HTML Help format (.chm). WebHelp, DotNet Help, WinHelp, or other types of Help files cannot be added. For more information about creating HTML Help, please see the Microsoft® website at www.microsoft.com. The Triconex Emulator Help file (TCXEMX.chm) has already been added to the Help menu as a custom Help file. Invensys recommends not removing this Help file from the list. Note You must be logged into Windows as an administrator, or a user with administrator privileges, in order to add or remove custom Help files. If you do not have administrator privileges, see your network administrator for assistance. Topics include: • Adding a Custom Help File on page 64 • Viewing Custom Help Files on page 64 • Removing a Custom Help File on page 65 TriStation 1131 Developer’s Guide, 4.14.0 64 Chapter 1 Project Administration Adding a Custom Help File This procedure describes how to add a custom Help file to the TriStation 1131 Help menu. Procedure 1 On the Help menu, click Options. The Add or Remove Custom Help File dialog box appears. 2 Click Browse to locate and select the Help file you want to add. Help files must be in the compiled HTML Help format (.chm). 3 Click Add File. The Help file is added to the TriStation 1131 Help menu. Viewing Custom Help Files Once you have added your custom Help file(s) to TriStation 1131, you can view them from within TriStation 1131 by selecting them from the Help menu. Note • The file names of the custom Help files are displayed in the Help menu. For example, if your custom Help file is Custom.chm, it will appear in the Help menu as CUSTOM. On the Help menu, click the name of your custom Help file. The Help file opens in the HTML Help viewer window. TriStation 1131 Developer’s Guide, 4.14.0 Custom Help Files Adding or Removing Custom Help Files 65 Removing a Custom Help File This procedure describes how to remove a custom Help file from the TriStation 1131 Help menu. Procedure 1 On the Help menu, click Options. The Add or Remove Custom Help File dialog box appears. 2 In the list of custom Help files, select the file(s) you want to remove. 3 Click Remove File(s). The selected Help files are removed from the list of installed files, and will no longer appear in the TriStation 1131 Help menu. TriStation 1131 Developer’s Guide, 4.14.0 66 Chapter 1 Project Administration Managing User Access This section explains how to provide user access to controller and TriStation 1131 operations. It also discusses security considerations for controlling and protecting access to TriStation 1131 projects. Each new TriStation 1131 project is created with two default accounts: • A default user name (MANAGER) and password (PASSWORD). • A default recovery account, with user name TCNX_FD. For more information about this account, see Managing the Recovery Account on page 78. Before you begin creating and modifying user accounts, be sure to read the information provided in Security Considerations for User Access Control on page 67. When developing a cyber security plan, including access control to your project, you should assess the security threats to your system within the context of the overall plant architecture, any applicable standards, and your corporate practices. As a result of this security risk assessment, if you feel that a higher level of security is needed to mitigate security threats, you should follow the recommendations provided in Security Considerations for User Access Control on page 67. Topics include: • Security Considerations for User Access Control on page 67 • Changing the Security Setting on page 70 • Managing Users on page 73 • Adding and Modifying User Access on page 75 • Managing the Recovery Account on page 78 • Changing the Security Level for Privileges on page 81 • Changing Security Level Names on page 83 • Viewing User Access Logs on page 84 TriStation 1131 Developer’s Guide, 4.14.0 Managing User Access 67 Security Considerations for User Access Control Multiple levels of access control help prevent unauthorized access to TriStation 1131. The overall level of security for your project depends on your user access control strategy. Options you should consider as part of your strategy are described in the following table. Table 2 User Access Control Strategy Options Access Control Option Description Security setting The security setting defines the type of authentication used to identify users upon logon. Choose the security setting that is right for your implementation: • Standard Security uses a simple user name/password scheme. This is the default setting. • Enhanced Security adds a stronger layer of protection against unauthorized access by requiring Windows domain user authentication. Invensys recommends that you use the Enhanced Security setting to protect your TriStation 1131 safety application from unauthorized access. • For more information, see Changing the Security Setting on page 70. Default MANAGER account All TriStation 1131 projects are created with the default MANAGER account, and its associated default password (PASSWORD). Once you have created a project, you should immediately add at least two level 01 users with all the same permissions as the MANAGER account (including the ability to add/modify users, and change the security setting), but with a unique user name and password. Once you have created these new level 01 users, log out of the project, and log back in using one of the new user accounts. Then, delete the default MANAGER account. Leaving the default MANAGER account active in your project means that anyone who knows the default account information (which is easily available via the online Help system or this documentation) will be able to open your project and make changes to your configured controllers. Note: If your project is currently in Standard security mode, you should create at least two level 01 users with the same permissions as the MANAGER account before switching to Enhanced Security mode. Default recovery account (TCNX_FD) When you create a new project, or upgrade an existing project to TriStation 1131 4.14.0, a level 01 user named TCNX_FD is automatically created and added to the user list. This recovery account allows you to open the project if all other users associated with the project forget their password or are no longer with your organization. You have the option to permanently delete this account, and its associated default password, from your project. Deleting this account contributes to the highest level of user access control for the project, but also requires you to ensure you always have access to the password for at least two level 01 user accounts. For more information, see Managing the Recovery Account on page 78. TriStation 1131 Developer’s Guide, 4.14.0 68 Chapter 1 Project Administration Table 2 User Access Control Strategy Options (continued) Access Control Option Description Level 01 user accounts Invensys recommends that you limit the number of level 01 user accounts you add to your project. Level 01 users have the most control over project elements, and a level 01 user with malicious intent could cause serious damage to your project or your online system. Limiting the number of users with level 01 access can help prevent unauthorized changes. Multiple user accounts To ensure unauthorized users do not access the project, you should create a user account for each person who will be working with the project before application development begins, and not allow multiple users to access the project using the default level 01 user information. User security levels User security levels define what operations a user can perform while using TriStation 1131. Access is based on the security level assigned to the user, from the highest level (01) to the lowest level (10). Each level of security includes default settings for the operation privileges allowed for that level. For example, the Manager level (03) includes privileges for operations associated with managing a TriStation 1131 project. Only users assigned to levels 01, 02, or 03 can access the security controls for controller and TriStation 1131 operations. For more information, see Changing the Security Level for Privileges on page 81. Note: If you have a TCM (except models 4351 and 4352) or a UCM, a Trident 2.x CM, or a Tri-GP CM installed in your system, access to the controller via TriStation 1131 can also be managed via the optional access control list. See Controlling Access to the TCM or UCM on page 542 or Controlling Access to the CM or CIM on page 590. Document-level and operating parameters restrictions Access to a project can be further restricted by settings on documents and operating parameters. Windows security file access rules If a TriStation 1131 project was created by a user with restricted or administrator-level rights in Windows, other users may be unable to access that project. Windows security file access rules apply to all TriStation 1131 project files. Your network or system administrator can assist with changing the access rights for the selected project file and/or file location. If you are trying to edit a user document created by another user, and are unable to do so even when you have the correct user level and access privileges, check the document’s access property. If it is locked, you must ask the user who created the document to change the access property. See Restricting Access to a Document on page 140. TriStation 1131 Developer’s Guide, 4.14.0 Managing User Access Table 2 69 User Access Control Strategy Options (continued) Access Control Option Description Single Logon Service When Single Logon is enabled, you can log on to a TriStation 1131 project without re-entering your user name and password, if your logon attempt is within 10 minutes of closing the project. As this feature allows you to bypass your logon credentials for a period of 10 minutes, you must ensure that the usage of this feature is monitored and is in accordance with your organization’s cyber security plan. Single Logon is enabled only when you install the Triconex Single Logon service during TriStation 1131 installation. After installation, if you choose to disable Single Logon for security reasons, you can stop the service from the Windows Task Manager. You can uninstall the service (so that it cannot be re-enabled) by modifying the TriStation 1131 installation. When Single Logon is enabled, ensure your PC is locked when not in use, to prevent unauthorized access to your project. User access logs When Enhanced Security is enabled, TriStation 1131 keeps a log of all user logon attempts, whether they are successful or not. You should periodically review these logs for unauthorized usage, as defined by your organization’s cyber security plan. You can view this log to determine if an unauthorized user is attempting to log on to TriStation 1131 projects. You can also use this log as a troubleshooting tool when helping a user who is having logon problems. Windows keeps a log of events associated with the Triconex Single Logon service (whenever it is installed, started, or stopped). You should periodically review these logs to ensure there has been no unauthorized access to the service. For more information, see Viewing User Access Logs on page 84. TriStation 1131 Developer’s Guide, 4.14.0 70 Chapter 1 Project Administration Changing the Security Setting TriStation 1131 uses one of two application-level security settings: Standard or Enhanced. You should choose the security setting you want to use before you begin creating user accounts. You must be a level 01 user to change the security setting. The security setting defines the type of authentication used to identify users upon logon to a project: • Standard Security: When selected, a user name and password is required to open the TriStation 1131 project. No other user authentication is required. This is the default setting. If you used a version of TriStation 1131 previous to version 4.7.0, this security setting is the same as the user name / password logon used in previous versions. • Enhanced Security: When selected, Windows and TriStation 1131 user authentications are required to log on. The user name for each TriStation 1131 user must be the same as the user’s Windows user name. Invensys recommends that you use the Enhanced Security setting to protect your TriStation 1131 safety application from unauthorized access. CAUTION If you change the security setting from Standard to Enhanced, make sure that at least two level 01 users have a valid Windows user name before closing the project. Failure to do so will prevent you from opening the project again and/or changing the security setting back to Standard. Each TriStation 1131 project has its own security setting. Each time you change the security setting for a project, the change is captured in the project history (see View Project History Command on page 865). Note If you need to send a project file that uses Enhanced Security to Global Customer Support for troubleshooting purposes, you must do the following: • Make a copy of the project file. • In the copy file, change the security setting to Standard. • Send the copy file (with Standard Security enabled) to Customer Support. Leaving your project file set to use Enhanced Security may prevent support personnel from being able to open the project file. This procedure describes how to change the security setting for a project. TriStation 1131 Developer’s Guide, 4.14.0 Managing User Access 71 Procedure 1 On the Project menu, click Security. The Security dialog box appears. 2 On the Security Setting tab, select the setting you want to use: Standard Security or Enhanced Security. Note 3 4 If both options are unavailable, you are not a level 01 user. You must be a level 01 user to change the security setting. Click OK, and then do one of the following: • If you downgraded the security setting from Enhanced to Standard, this procedure is complete. Go to Managing Users on page 73 to edit users as needed. • If you upgraded the security setting from Standard to Enhanced, go to the next step. When prompted, enter your Windows user name and password, and then click OK. TriStation 1131 Developer’s Guide, 4.14.0 72 Chapter 1 Project Administration 5 6 Do one of the following: • If your Windows user name was previously added to the project user list, and TriStation 1131 was able to successfully authenticate your Windows user name and password, this procedure is complete. Go to Managing Users on page 73 to edit users as needed. • If this is the first time you have upgraded the security setting from Standard to Enhanced, and TriStation 1131 was able to successfully authenticate your Windows user name and password, the Add User dialog box appears so you can add yourself as a Windows user to the project user list. Go to the next step. Specify these properties in the Add User dialog box. Property Action Full Name Enter or change the user’s full name (for example, John Smith). Description Enter or change the description for the user (for example, their job title or function). User Name You cannot change the user name, because it must be the same as the user’s Windows user name. Password Enter the user’s password. This is NOT the same as the user’s Windows password. You should select a different password, unique to the user’s TriStation 1131 account. See Recommended Rules for Passwords on page 77 for minimum requirements. If you forget the password for your project, contact Global Customer Support for assistance. For contact information, see Technical Support on page xvii. 7 Verify Password Enter the new password again for verification. Security Level You cannot change the security level. Enhanced Security requires at least one level 01 Windows user. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Managing User Access 73 Managing Users This procedure explains how to manage users, which includes creating, modifying, and deleting TriStation 1131 users. Only users assigned to security levels 01, 02, or 03 can access the Security dialog box and view user access settings. Only users who are assigned the TriStation 1131 Operations > Security: Add/Modify Users privilege can see users in the user list, and only users who are at the same level or below will appear in the list. If you do not have this privilege assigned to your account, the users list will appear blank. For example, if you are a level 03 user with the Add/Modify Users privilege, you will see only level 03–level 10 users in the list. Level 01 and level 02 users will not appear in the list. Using the Print All command, you can print a Project Users report, which lists all the users that you have permission to see in the project’s user list. See Printing Project Documents on page 109. Invensys recommends that level 01 users should periodically (or whenever organizational changes occur) review the list of authorized user accounts, and their access levels, and adjust each user’s access levels as needed per your organization’s cyber security plan. Note If Enhanced Security is enabled, a quick way to prevent a user from accessing TriStation 1131 is to add their Windows user account to the Windows Local Security Policy “Deny access to this computer from the network” list. Procedure 1 On the Project menu, click Security, and then click the Users tab. TriStation 1131 Developer’s Guide, 4.14.0 74 Chapter 1 Project Administration 2 Perform one of these actions on the Users tab. Command Action New To create a new user, click New. For further instructions, see Adding and Modifying User Access on page 75. Modify To modify a user, select a user in the list, and then click Modify. See Adding and Modifying User Access on page 75 for further instructions. Delete To delete a user, select a user in the list, and then click Delete. The default level 01 user (MANAGER) can be deleted only if another level 01 user has already been created. If Enhanced Security has ever been enabled (even if it is not the current security setting), you cannot delete the last level 01 Windows user. Note 3 Unless you have level 01 access, you cannot add, modify, or delete users who have the same or higher security level as yourself. Thus, if you have level 03 access, you cannot add, modify, or delete users with level 03, 02, or 01 access. If you have level 02 access, you cannot add, modify, or delete users with level 02 or 01 access. If you have security level 01 access, you can add, modify, or delete other level 01 users, but you cannot delete yourself. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Managing User Access 75 Adding and Modifying User Access This procedure explains how to add or modify access properties for a TriStation 1131 user. Note When Enhanced Security is enabled, the first time a newly-added user logs in, they need to log on twice for authentication purposes. See Logging On for the First Time When Enhanced Security Is Enabled on page 31 for more information. Procedure 1 On the Project menu, click Security, and then click the Users tab. • To add a user, click Add. • To modify a user, click the user name, and then click Modify. TriStation 1131 Developer’s Guide, 4.14.0 76 Chapter 1 Project Administration 2 Specify these properties in the Add or Modify User dialog box. Property Action Full Name Enter or change the name for the user. Description Enter or change the description for the user. Logon Name Enter or change the name to be used to log on to the project. • If you are using Standard Security, user names can have a maximum of 16 alphanumeric characters; spaces and special characters are not allowed. • If you are using Enhanced Security, the user name must be the same as the user’s Windows user name, including domain information, if necessary. • If Enhanced Security is enabled, you cannot change the user name, because it must be the same as the user’s Windows user name. Note: If you change an existing user’s logon name, you will also need to enter a new password for the user, or re-enter the user’s existing password. Password Enter or change the logon password. If you are using Enhanced Security, this is not the same as the user’s Windows password. You should select a different password, unique to the user’s TriStation 1131 account. See Recommended Rules for Passwords on page 77 for minimum requirements. Verify Password Enter the new or changed password again to ensure the password is what you intended. Security Level Select the security level for this user. Level 01 is the highest; level 10 is the lowest. If the user whose information you are modifying is the only level 01 Windows user, you cannot change the security level. Enhanced Security requires at least one level 01 Windows user. To change this user’s level, assign another Windows user to level 01, and then try changing this user’s level again. CAUTION 3 TCNX_BD is a reserved word, and cannot be used as a logon name. If a user account with this logon name is created, it will be deleted the next time you open the project. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Managing User Access 77 Recommended Rules for Passwords Invensys recommends configuring your Windows domain authentication settings to support the following minimum requirements for passwords: • Be a minimum of six (6) characters. • Consist of a combination of alpha, numeric, and special characters. Special characters include the following: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~ • Include at least one number. • Include at least one letter. • Include at least one lower-case letter AND one upper-case letter. • Include at least one special character. • Be changed at least annually, or more frequently based on risk. These rules will NOT be validated by TriStation 1131 when you enter or change the user’s password, so it is up to you to ensure user passwords meet these requirements. If Enhanced Security is enabled, Windows passwords will be used. As a result, these password rules should be enforced at the Windows domain / Active Directory level. See your network administrator for more information about how to enforce requirements for Windows passwords. Note When Enhanced Security is enabled, all TriStation 1131 passwords are protected from unauthorized read or copy access because they are stored and protected by Windows security mechanisms. However, when Standard Security setting is enabled, this level of password protection is not provided. If you forget the password for your project, contact Global Customer Support for assistance. For contact information, see Technical Support on page xvii. TriStation 1131 Developer’s Guide, 4.14.0 78 Chapter 1 Project Administration Managing the Recovery Account When you create a new project, or upgrade an existing project to TriStation 1131 4.14.0, a level 01 user named TCNX_FD is automatically created and added to the user list. This recovery account allows you to open the project if all other users associated with the project forget their password or are no longer with your organization. Once logged on, you can then create additional level 01 users for the project. The recovery account is visible in the user list only if you are currently logged in as a user that has been assigned the TriStation 1131 Operations > Security: Add/Modify Users privilege. The default recovery account password should not be changed. If you change the recovery account password, the next time you close and open the project, the password will revert to the default password. Note In TriStation 1131 4.14.0, there are no “hidden” default accounts associated with a project. Only users with accounts that appear in the users list may open the project. Topics include: • Using the Recovery Account to Log On on page 79 • Deleting the Recovery Account on page 80 TriStation 1131 Developer’s Guide, 4.14.0 Managing User Access 79 Using the Recovery Account to Log On If you need to use the recovery account to log on to your project, you must contact Customer Support for assistance. Note You cannot log on to a project using the TCNX_FD account if the project is using the Enhanced Security setting. See Changing the Security Setting on page 70 for more information about Enhanced Security. Procedure 1 Open the project you want to log on to using the recovery account. 2 In the Project Log On dialog box, enter TCNX_FD as the user name. 3 Using one of the methods described in Technical Support on page xvii, contact Customer Support to obtain the following: • The password for the recovery account. • A unique ticket ID number that will allow you to access the project. You must provide Customer Support with the current session ID number, located in the Project Log On dialog box, in order to obtain a ticket ID number. Session ID number 4 Enter the recovery account password, and then click Log On to log on to your project as the TCNX_FD user. The Enter Ticket dialog box appears. 5 Enter the ticket ID number you were given by Customer Support, and click OK. The project opens. Note If the ticket ID is incorrectly entered three times in a row, the session ID will change, and you will need to contact Customer Support again to obtain a new ticket ID. TriStation 1131 Developer’s Guide, 4.14.0 80 Chapter 1 Project Administration Deleting the Recovery Account You have the option to permanently delete the TCNX_FD recovery account, and its associated default password, from your project. Deleting this account contributes to the highest level of user access control for the project, but also requires you to ensure you always have access to the password for at least two level 01 user accounts. To delete the recovery account, you must be logged in to the project as a level 01, level 02, or level 03 user that has been assigned the TriStation 1131 Operations > Security: Add/Modify Users privilege. For more information about user privileges, see Changing the Security Level for Privileges on page 81. CAUTION Before you remove the recovery account, make sure you have permanent access to the password for at least two level 01 user accounts. Failure to do so may prevent you from being able to open the project, or have access to all user permissions. Note that unless you have level 01 access, you cannot add, modify, or delete users who have the same or higher security level as yourself. If you are unable to access your project, and it is using Standard Security, you can contact Customer Support for assistance. However, if you are using Enhanced Security, Customer Support is unable to help you access your project if all passwords are forgotten. Note If you delete the recovery account, you can recreate the recovery account using TCNX_FD as the user name, but you will still need to contact Customer Support to obtain a session ID-based ticket to log on as the TCNX_FD user. Additionally, the next time you close and open the project, the password you entered when recreating the account will be replaced with the default TCNX_FD password. Procedure 1 On the Project menu, click Security, and then click the Users tab. 2 Select the TCNX_FD user in the list, and then click Delete. TCNX_FD can be deleted only if another level 01 user already exists. Note 3 Unless you have the Security: Add/Modify Users privilege, you cannot delete the TCNX_FD recovery account. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Managing User Access 81 Changing the Security Level for Privileges This procedure explains how to change the security level required for privileges to controller and TriStation 1131 operations. By default, each operation is assigned a security level, from the highest level (01), to the lowest level (10). Each security level includes a set of privileges for that level, which also includes the privileges for lower levels. For example, if the operation is set to level 04, users with level 01, 02, and 03 privileges also have access to the operation. Only users with level 01, 02, or 03 access can change security level privileges. Note In Tricon systems with a TCM or UCM installed, and all Trident/Tri-GP 2.x and later systems, access to the controller via the TriStation protocol can also be managed via the optional access control list.2 For example, even if a user has the correct security level privileges to perform a Download All command, if they do not have Read/Write TriStation access through the TCM, UCM, CM, or CIM, they will be unable to perform the Download All command. For more information, see Controlling Access to the TCM or UCM on page 542 or Controlling Access to the CM or CIM on page 590. Using the Print All command, you can print a Project Security Levels report, which lists the security levels currently assigned to each operation. See Printing Project Documents on page 109. Procedure 1 2. On the Project menu, click Security, and then click the Privileges tab. Except TCM models 4351 and 4352, which do not have the access control list feature. TriStation 1131 Developer’s Guide, 4.14.0 82 Chapter 1 Project Administration 2 Specify these properties on the Privileges tab. Property Action Operation Type Select Controller Operations or TriStation 1131 Operations, depending on the operations you want to specify. Operations Click the operation, and then select the check box for the level of security to be assigned to the operation. • Press Shift and click to select multiple contiguous items. • Press Ctrl and click to select multiple non-contiguous items. 3 Note Click OK to save your changes. Because they cannot access the Privileges tab, users with security levels 04–10 cannot perform the following tasks: Security: Add/modify users, Security: Change level descriptions, Security: Change level privileges. Additionally, you cannot remove privileges from your own security level. For example, if you are a level 03 user, you cannot remove privileges from security level 03. TriStation 1131 Developer’s Guide, 4.14.0 Managing User Access 83 Changing Security Level Names This procedure explains how to change the names associated with security levels. If you change a name on this tab, it is reflected on the other security tabs. Changing the name does not affect the security level assignments. Only users with level 01, 02, or 03 access can change security level names. Procedure 1 On the Project menu, click Security, and then click the Level Names tab. 2 Enter the name to associate with each security level. The default names are as follows: 3 Level Name Level Name 01 Corporate Manager 06 Maintenance Manager 02 Site Manager 07 Maintenance Engineer 03 Project Manager 08 Operations Manager 04 Project Engineer 09 Operator 05 Project Programmer 10 Level 10 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 84 Chapter 1 Project Administration Viewing User Access Logs When Enhanced Security is enabled, TriStation 1131 keeps a log of all user logon attempts, whether they are successful or not. When the Triconex Single Logon service is installed, Windows keeps a log of the events associated with the service. Note For more information about the Enhanced Security option, see Changing the Security Setting on page 70. For more information about the Triconex Single Logon service, see Using the Triconex Single Logon Service on page 34. The Windows System Events Log stores the following information about user logon and logoff attempts and the status of the Triconex Single Logon service: • Successful logon using Windows user name and password • Logon failure due to an incorrect Windows user name and/or password • Logon attempt cancelled by the user • Logon failure due to the user forgetting to enter their Windows user name and/or password (this is referred to as an “incorrect parameter” error) • Successful logoff (when the user closes the TriStation 1131 project) • Successful installation of the Triconex Single Logon service • Attempts to stop or restart the Single Logon service • Errors when the Single Logon service is enabled You can view this log to determine if an unauthorized user is attempting to log on to TriStation 1131 projects, or is enabling or disabling the Single Logon service. You can also use this log as a troubleshooting tool when helping a user who is having logon problems. Note If you are logged on to Windows using a “Guest” account, you will be unable to view the Windows System Events Log. For more information, see Microsoft Knowledge Base Article 842209 (http://support.microsoft.com/kb/842209). Topics in this section include: • Viewing the User Access Log in Windows Event Viewer on page 85 • Saving the User Access Log to a File on page 86 • Changing Event Logging Options on page 86 • Clearing the User Access Log on page 87 TriStation 1131 Developer’s Guide, 4.14.0 Managing User Access 85 Viewing the User Access Log in Windows Event Viewer This procedure describes how to view TriStation 1131 user access information in the Windows System Events Log using the Windows Event Viewer. You must be logged on to Windows as an administrator to perform this procedure. Procedure 1 On the Start menu, click Control Panel, and then double-click Administrative Tools. 2 Double-click the Event Viewer icon. The Windows Event Viewer opens. 3 In the console tree, click Application. Event information appears in the details pane. 4 In the details pane, click the Source column header to sort the events by application. 5 Look for TriStation 1131 as the source type. 6 To view detailed information about a specific event, double-click the event. TriStation 1131 Developer’s Guide, 4.14.0 86 Chapter 1 Project Administration Saving the User Access Log to a File This procedure describes how to save the user access event information to a file. You must be logged on to Windows as an administrator to perform this procedure. When you save a log file, the entire log is saved, regardless of filtering options. You cannot save a log file with just the events related to TriStation 1131. Also, the sort order is not retained when logs are saved. Procedure 1 In the Windows Event Viewer, display the event log with the user access information that you want to save to a file. 2 On the Action menu, click Save Log File As. 3 In File name, enter a name for the archived log file. 4 In Save as type, select a file format, and then click Save. • If you archive a log in log-file format, you can reopen it in Event Viewer. Logs saved as event log files (.evt) retain the binary data for each event recorded. • If you archive a log in text (.txt) or comma-delimited (.csv) format, you can reopen the log in other programs, such as word processing or spreadsheet programs. Logs saved in text or comma-delimited format do not retain the binary data. Changing Event Logging Options Using the Windows Event Viewer, you can set the maximum size of the log and specify whether events are overwritten or stored for a certain period of time. The default logging policy is that if a log is full, the oldest events are deleted to make room for new events. Invensys recommends that you change this setting to ensure that user logon event information is not lost. This procedure describes how to change event logging options using the Windows Event Viewer. You must be logged on to Windows as an administrator to perform this procedure. Procedure 1 On the Start menu, click Control Panel, and then double-click Administrative Tools. 2 Double-click the Event Viewer icon. The Windows Event Viewer opens. 3 In the console tree, right-click Application. The Application Properties dialog box appears. TriStation 1131 Developer’s Guide, 4.14.0 Managing User Access 4 5 87 Do one or both of the following: • To increase the maximum size of the event log file, enter the desired value (in KB) in the Maximum log size field. • Select Do not overwrite events (clear log file manually). Click OK to save your changes. Clearing the User Access Log When the Windows System Events Log reaches its maximum size, you will see the following error message in TriStation 1131: The event log file is full. You must manually clear all events from the event log file before new entries can be added. This procedure describes how to clear the event log file so that you can continue collecting user logon event information. You must be logged on to Windows as an administrator to perform this procedure. Note Clearing the log file will clear ALL application event information, not just events related to TriStation 1131. Invensys highly recommends saving the file prior to clearing it. Procedure 1 On the Start menu, click Control Panel, and then double-click Administrative Tools. 2 Double-click the Event Viewer icon. The Windows Event Viewer opens. 3 In the console tree, right-click Application, and then select Clear all events. 4 When prompted to save the log before clearing it, click Yes. 5 Select the location where you want to save the file to, and click Save. The file is saved to your selected location, and the current log file is cleared. TriStation 1131 Developer’s Guide, 4.14.0 88 Chapter 1 Project Administration Working with Libraries Libraries are collections of project elements (programs, functions, and data types) that can be used in a project. This section describes how to create a library that can be added to other projects, and how to manage libraries that can include TriStation 1131 and user-created project elements. Note Libraries created in TriStation 1131 4.0 and later can be imported to projects developed in TriStation 1131 4.14.0. These standard libraries are included with TriStation 1131: • TCXLIB: Triconex library for Tricon, Trident, and Tri-GP controllers • STDLIB: Industry-standard library for Tricon, Trident, and Tri-GP controllers • TR1LIB and TX1LIB: Libraries for Tricon controllers • TRDLIB: Library for Trident and Tri-GP controllers • ALARMS: Library for process alarms. Required if you want to use OPC UA with the CIM. The updated ALARMS library released with TriStation 1131 4.10.0 (version 1.111) is significantly different from earlier versions of the library. It can only be used with TriStation 4.10.0 and later. If you are using earlier versions of the ALARMS library, Invensys recommends you remove that library from your project and replace it with ALARMS 1.111. When you upgrade the ALARMS library to 1.111 or later, you must update the alarm function blocks in your project to use the new and changed parameters. You will be unable to build your application until you have updated your project accordingly. • ALARMS3: Updated library for process alarms. Required for Triconex controllers that are used with Safety View Alarm and Bypass Management (ABM) 1.1.0 and later. The ALARMS3 library, first released with TriStation 1131 4.12.0, can be used with TriStation 1131 4.0 and later. You can add this library to your project when your project is in the Download Changes state. If you upgrade the existing ALARMS library to the ALARMS3 library, you can replace any existing alarm function blocks in your project with the alarm function blocks from the ALARMS3 library. Note The ALARMS and ALARMS3 libraries are not automatically included with TriStation 1131 sample projects or newly created projects. You must add one of these libraries to a project manually. You can add both these libraries to the same project, if required. For instructions, see Adding a Library on page 94. The standard libraries can be found in the default Data directory: C:\ProgramData\Triconex\TriStation 1131 4.14.0\Data. For more information about the libraries automatically included with a TriStation 1131 project, see the TriStation 1131 Libraries Reference. TriStation 1131 Developer’s Guide, 4.14.0 Working with Libraries 89 Information about the version numbers of libraries included with each TriStation 1131 release can be found in the Product Release Notice for TriStation 1131 4.x, available on the Global Customer Support website. Topics include: • Creating a Library of Project Elements on page 89 • Managing Libraries on page 93 • Adding a Library on page 94 • Updating a Library on page 95 • Deleting a Library on page 96 • Verifying a Library Version on page 97 Creating a Library of Project Elements This procedure explains how to create a library of project elements (programs, functions, function blocks, and data types) that can be imported to another TriStation 1131 project. The library specification (.lsp) and export library (.lt2) files are created in the imported libraries directory. To identify or change this library, see Specifying Directory Locations on page 58. The default location is: C:\ProgramData\Triconex\TriStation 1131 4.14.0\Data. Procedure 1 Open the TriStation 1131 project that contains the elements you want to copy. 2 Expand the Application tree, right-click User Documents, and then click Create Library. TriStation 1131 Developer’s Guide, 4.14.0 90 Chapter 1 Project Administration 3 Do either of these: • To create a new library, click Create New Library Specification, click Next, and skip to step 5. • To add elements to an existing library, click Use Existing Library Specification, and then click Next. 4 Navigate to the library directory, and click the library file you want to add elements to. 5 In the list on the left, click the document that you want to include, and then click the angle brackets ( >> ) to move the element to the right side. To select several documents at the same time, press Ctrl, and click each document. To select all the documents, press Ctrl and Shift, and click the top and bottom documents. TriStation 1131 Developer’s Guide, 4.14.0 Working with Libraries 91 6 When you are finished selecting the elements to be included in the library, click Next. 7 Add information about the library, including a name, description, and major and minor version number. You can also specify whether the source code can be viewed or restricted from other users. If you want to save the library to a path other than the default directory, browse to select the path where you want to save the new library files. TriStation 1131 Developer’s Guide, 4.14.0 92 Chapter 1 Project Administration 8 Click Next to continue. 9 Do either of these: 10 • To save the files as a library, click Save the specification and create the Library. If you create a library, a library.lsp file and a library.lt2 file are created (where library is the name you selected in step 7). • To save the specification, but not create the library, click Just save the specification. You might want to do this if you are planning to create a project library, but are not finished with the documents in the project. If you save just the specification, a library.lsp file is created. You can open this file and create the library file based on the specifications at a later time. Click Finish. TriStation 1131 Developer’s Guide, 4.14.0 Working with Libraries 93 Managing Libraries This procedure explains how to manage libraries. TriStation 1131 automatically includes IEC libraries with functions, function blocks, and data types that can be copied and sometimes modified for a project. You can also add libraries of project elements that were created in other TriStation 1131 projects. Note Using the Print All command, you can print reports listing all the functions and function blocks included in each library (Library Documents: Report), as well as a report listing all the currently installed libraries and their version numbers (Shared Libraries). See Printing Project Documents on page 109. Procedure 1 Expand the Application tree, right-click Library Documents, and click Manage. 2 Perform one of these actions in the Manage dialog box. Command Action Add Click to add a new library. For further instructions, see Adding a Library on page 94. Update Click to update an existing library. For further instructions, see Updating a Library on page 95. Delete Click to delete an existing library. For further instructions, see Deleting a Library on page 96. Verify Version Command Click to verify the most current version of the selected library is loaded. For further instructions, see Verifying a Library Version on page 97. TriStation 1131 Developer’s Guide, 4.14.0 94 Chapter 1 Project Administration Adding a Library This procedure explains how to add libraries to a TriStation 1131 project. This allows you to update libraries provided by Invensys, and add libraries of project elements from other TriStation 1131 projects. Note When the project is in the Download Changes state, a library can be added only if it does not impact function blocks that have already been downloaded to the controller. If any of the elements in the library being added are incompatible with elements that have already been downloaded to the controller, you must change the project state to Download All in order to add the library. Procedure 1 Expand the Application tree, rightclick Library Documents, click Manage, and then click Add. 2 If the library you want to add is located in a path other than the default directory, browse to select the path where the library you want to add is located. 3 Click the library to add, and then click OK. 4 Click Yes on the Query screen. The library is added to the project, and is displayed in the list. If Your Library Has a Function Block with a VAR_IN_OUT Parameter During the library import process, TriStation 1131 checks your library file for the presence of function blocks using a Boolean VAR_IN_OUT parameter. A warning message appears if at least one such function block is detected, giving you the option to cancel the library import process. Before completing the library import, you should contact your library vendor for information about the version of TriStation 1131 that was used to compile and export the library. • If TriStation 1131 3.1.3 or earlier was used to compile the function block and then export the library, when the library is imported into TriStation 1131 4.x, a trap will occur when the function block is used in a program with the “control” flag set. • If TriStation 1131 4.0 or later was used to compile the function block and export the library, the library is fully compatible with TriStation 1131 4.x, and you may continue with the library import process. Note Because VAR_IN_OUT is not allowed in a program with the “safety” flag set, this problem will not occur in a safety program if you use the flags properly, regardless of the version of TriStation 1131 used to compile and export the library. If TriStation 1131 3.1.3 or earlier was used to compile and export the library, and you choose to continue importing the library, you can prevent a trap from occurring in your application by TriStation 1131 Developer’s Guide, 4.14.0 Working with Libraries 95 substituting a VAR_INPUT and VAR_OUTPUT for each VAR_IN_OUT parameter in the affected function block(s). In this case, once you have imported the library and built the project, you may also want to use the TriStation 1131 Project Analysis utility (TS2Analysis.exe) to verify that you have removed all VAR_IN_OUT parameters from the affected function blocks. See Product Alert Notice #10, available on the Global Customer Support website, for more information, including detailed instructions for obtaining and using the Project Analysis Utility. Updating a Library This procedure explains how to update TriStation 1131 libraries for your project. When you request an update, TriStation 1131 compares the library in the project with the most current installed library and displays a message indicating the versions of each. You can then update the library or cancel the operation. Libraries can be updated only if they are located in the default Data directory: C:\ProgramData\Triconex\TriStation 1131 4.14.0\Data. When the project is in the Download Changes state, a library can be updated only if it does not change function blocks that have already been downloaded to the controller. If any of the elements in the library being updated have already been downloaded to the controller, you must change the project state to Download All in order to update the library. Please note the following regarding updating the TRDLIB, TR1LIB, or TX1LIB libraries: • • If the project is in the Download Changes state, these libraries can only be updated if the library version is equal to or later than the version listed in the following table: Library Version for Update in DLC State TRDLIB 1.171 or later TR1LIB 1.89 or later TX1LIB 1.62 or later If the library version is earlier than those listed above, the library can only be updated if the project is in the Download All state. TriStation 1131 Developer’s Guide, 4.14.0 96 Chapter 1 Project Administration Procedure 1 Expand the Application tree, right-click Library Documents, and then click Manage. 2 Select the library to be updated, and then click Update. 3 Click Yes to continue the update process. Click No to cancel. Deleting a Library This procedure explains how to delete a library from a TriStation 1131 project. Note When the project is in the Download Changes state, a library can be deleted only if it does not contain function blocks that have already been downloaded to the controller. If any of the elements in the library being deleted have already been downloaded to the controller, you must change the project state to Download All in order to delete the library. Procedure 1 Expand the Application tree, right-click Library Documents, and then click Manage. 2 Select the library to be deleted, and then click Delete. 3 When prompted, click Yes to confirm deletion of the library. Click No to cancel. TriStation 1131 Developer’s Guide, 4.14.0 Working with Libraries 97 Verifying a Library Version This procedure explains how to determine the version of TriStation 1131 libraries used in your project. Note Only libraries that are located in the default library directory can be verified. If a library is not located in the default directory, an error message will appear, stating that the library is unregistered. For more information about the default directory, see Specifying Directory Locations on page 58. Procedure 1 Expand the Application tree, right-click Library Documents, and then click Manage. 2 Click the library to be verified, and then click Verify Version. A message appears, identifying the library, version, and whether the project library is the same as the installed library. 3 Click OK to close the message box. TriStation 1131 Developer’s Guide, 4.14.0 98 Chapter 1 Project Administration Generating Reports This section describes how to view and print standard TriStation 1131 reports. You can also export reports to a variety of formats, which can be saved to disk or sent to an e-mail address. Standard reports are displayed through the Crystal Reports viewer, which is installed with the TriStation 1131 software. Custom reports must be created using the SAP® Crystal Reports® software, which can be purchased separately. Topics include: • Updating the Report Database on page 98 • Viewing and Printing a Report on page 99 • Adding Custom Reports to a Project on page 100 • Exporting Reports on page 101 • Report Database Information on page 102 Updating the Report Database This procedure explains how to update the report database. This copies project information to a database used for generating reports. You should update the report database after making changes to a project, and after installing or updating the TriStation 1131 software. Procedure 1 Open the Project Workspace (see The Project Workspace on page 22), and right-click the Default Reports or User Reports folder. 2 Click Update Reports Database. The status of the updated operation can be viewed in the status bar at the bottom of the TriStation 1131 window. TriStation 1131 Developer’s Guide, 4.14.0 Generating Reports 99 Viewing and Printing a Report This procedure explains how to view and print a report. Before you view a report, you should update the report database if changes have been made to the project or if the report database was not updated after installing the TriStation 1131 software. Procedure 1 Open the Project Workspace and then double-click a report. The report appears in a new report viewer window. Notes If the report database was not updated after the TriStation 1131 software was installed, a “File Not Found” message will appear. Update the reports database (see Updating the Report Database on page 98) and then try viewing the report again. To view reports on a PC running the Windows Server 2012 R2 operating system, you must have the .NET Framework 3.5.1 installed. If you receive an error message when you attempt to view reports, you must first uninstall TriStation 1131, install the .NET Framework 3.5.1, and then reinstall TriStation 1131. For more information, see Installing the TriStation 1131 Software on page 6. 2 Perform any of the following tasks in the report viewer window. TriStation 1131 Developer’s Guide, 4.14.0 100 Chapter 1 Project Administration Command Action Export Report Command Click to export the report data to a file. For further instructions, see Exporting Reports on page 101. Print Report Command Click to print the report being viewed. Refresh Command Click to refresh the display, which re-loads project data to the report. If project information has changed, update the report database, and then click Refresh to have the updated data displayed in the report. Copy Command Select the text you want to copy from the report and click to copy it to the clipboard. Find Text Command Click to search for text in the report. Zoom Type or select a percentage to change the size of the report view. Adding Custom Reports to a Project This procedure explains how to add a custom report created in the Crystal Reports software to a TriStation 1131 project. Only reports generated in the Crystal Reports software can be used in TriStation 1131; this software must be purchased separately. Procedure 1 In the Crystal Reports software, create a report and save it in a file with the extension .rpt. 2 Put the .rpt file in the Data Files directory. For more information on directory locations, see Specifying Directory Locations on page 58. The next time you open the project, the report will be included in the User Reports list. If the report is added while the project is open, you must close and re-open the project to view the report in the list. TriStation 1131 Developer’s Guide, 4.14.0 Generating Reports 101 Exporting Reports This procedure explains how to export report data in TriStation 1131. You can export reports to a variety of file formats, and can save the exported data to a disk. Procedure 1 Open the Project Workspace and then double-click the report you want to export. The report appears in a new report viewer window. 2 On the report viewer toolbar, click the Export Report button 3 In File name, enter a name for the report. 4 In Save as type, select the format you want to export the report to, and then click Save. Formats include: . • Crystal Reports • Microsoft Excel Workbook Data-Only • PDF • Microsoft Word (97-2003) • Character-separated values (CSV) • Microsoft Excel (97-2003) -Editable • Microsoft Excel (97-2003) • Rich Text Format (RTF) • Microsoft Excel (97-2003) Data-Only • XML A confirmation message appears once the export is completed. TriStation 1131 Developer’s Guide, 4.14.0 102 Chapter 1 Project Administration Report Database Information This section provides information on the dBASE IV relational databases that are used when the Crystal Report Engine generates a report in TriStation 1131. In addition to the standard reports, you can create custom reports that can be used in TriStation 1131. You must purchase the Crystal Reports software in order to create custom reports. After a project is opened, the databases are automatically updated with information from the project when you print the first report. You can also update the databases by right-clicking the Default Reports or User Reports folder and clicking Update Reports Database. Databases include: • System Definition: Chassis Types (TRHWDCHS.dbf) on page 102 • System Definition: Module Types (TRHWDMOD.dbf) on page 103 • Configuration: Program (TRPRGINS.dbf) on page 103 • Configuration: Instance Variable Connections (TRINSVAR.dbf) on page 103 • Configuration: Tagnames (TRGLBVAR.dbf) on page 103 • Configuration: Operating Parameters (TRSYSOPS.dbf) on page 104 • Configuration: Implementation (TRIMPPAR.dbf) on page 104 • Configuration: SOE Block Definition (TRSOEBLK.dbf) on page 105 • Configuration: SOE Block Variables (TRSOEVAR.dbf) on page 105 • Configuration: Module Configuration (TRMODCFG.dbf) on page 105 • Configuration: Memory Allocation (TRMALLOC.dbf) on page 105 • Security: Users (SECUSERS.dbf) on page 106 • Security: Levels (SECLVLS.dbf) on page 106 • Security: Operations (SECOPRS.dbf) on page 106 • Project: Information (PRINFO.dbf) on page 106 • Project: Shared Libraries (PRLIBS.dbf) on page 107 • Project: Elements (PRELEMS.dbf) on page 107 • Project: POU Variables (PRPOUVAR.dbf) on page 108 • Project: POU Cross-Reference (PRPOUXRF.dbf) on page 108 • Project: Audit History (PRHIST.dbf) on page 108 The TRHWDCHS file contains information about the chassis types used in the system. Table 3 System Definition: Chassis Types (TRHWDCHS.dbf) Field Name Field Type Description CHASTYPE (key) Number Chassis type numerical identifier CHASDESC String Chassis description The TRHWDMOD file contains information about the modules used in the system. TriStation 1131 Developer’s Guide, 4.14.0 Generating Reports Table 4 103 System Definition: Module Types (TRHWDMOD.dbf) Field Name Field Type Description MODTYPE (key) Number Triconex module identifier MODDESC String Module description MODMODEL String Module marketing model number The TRPRGINS file contains information about the programs in the project. Table 5 Configuration: Program (TRPRGINS.dbf) Field Name Field Type Description PROGNAME String Program name SEQUENCE Number Execution sequence number The TRINSVAR file contains information about the variable connections in the program. Table 6 Configuration: Instance Variable Connections (TRINSVAR.dbf) Field Name Field Type Description INSTNAME (key) String Program execution name. This is the same as the program name. VARPATH String Program variable path PROGNAME String Program name VARNAME String Program variable name. This is the same as the tagname. TAGNAME String Tagname VAROUTPUT Strings W if written by instance; otherwise blank The TRGLBVAR file contains information about the tagnames (global variables) in the project. Table 7 Configuration: Tagnames (TRGLBVAR.dbf) Field Name Field Type Description TAGNAME (key) String Tagname GROUP1 String Group 1 name GROUP2 String Group 2 name DESCRIP String Tagname description LOCATION String Tagname location (same format as in configuration) MODBUS String Modbus alias number DATATYP String Data type: BOOL, DINT, REAL, and so on. DATACLASS String Data class: memory, input, or output. TYPECLASS String Point memory address. TriStation 1131 Developer’s Guide, 4.14.0 104 Chapter 1 Project Administration Table 7 Configuration: Tagnames (TRGLBVAR.dbf) (continued) Field Name Field Type Description APPLICATN String Tagname application type (safety or control) SHARED String Tagname shared for read state (Yes or No) RETENTIVE Boolean Retain value indicator INITVALUE String Initial value of tagname DECPL Number Decimal places for REAL tagname MINSPAN Number Lower limit for REAL number in Engineering Units MAXSPAN Number Upper limit for REAL number in Engineering Units SYSTEMTAG Boolean Is a system variable MULTIWRIT Boolean Multiple writes enabled The TRSYSOPS file contains information about the operating parameter settings in the project. Table 8 Configuration: Operating Parameters (TRSYSOPS.dbf) Field Name Field Type Description CNFGVERS String Configuration version number NETNODE Number NCM node number (switch setting) NETALIAS String Network IP alias name SCANRATE Number Scan rate (in milliseconds) PSWDREQD Boolean Password required for download DSBLSTOP Boolean Tricon Keyswitch STOP disabled DSBLMBWR Boolean Disable Modbus writes to outputs DSBLRCHG Boolean Disable remote changes DSBLPNTS Boolean Permit disabling points The TRIMPPAR file contains information about the implementation settings (scan rate, Peer-toPeer sends/receives) in the project. Table 9 Configuration: Implementation (TRIMPPAR.dbf) Field Name Field Type Description PARKEY (key) Number Parameter ID number PARNAME String Parameter name PARDESC String Parameter description The TRSOEBLK file contains information about the SOE block definitions in the project. TriStation 1131 Developer’s Guide, 4.14.0 Generating Reports Table 10 105 Configuration: SOE Block Definition (TRSOEBLK.dbf) Field Name Field Type Description SOEBLKNUM (key) Number SOE block number SOEBLKTTL String SOE block title SOEBUFSIZ Number Event buffer size SOEBLKTYP String SOE block type The TRSOEVAR file contains information about the SOE tagnames used in the project. Table 11 Configuration: SOE Block Variables (TRSOEVAR.dbf) Field Name Field Type Description SOEBLKNUM (key) Number SOE block number TAGNAME String Tagname TRUENAME String Name of TRUE state FALSENAME Strings Name of FALSE state TRUECLR String Color of TRUE state FALSECLR String Color of FALSE state The TRMODCFG file contains information about the module configuration used in the project. Table 12 Configuration: Module Configuration (TRMODCFG.dbf) Field Name Field Type Description CHASNUM (key) Number Chassis number (1-n) CHASTYPE Number Chassis type numerical identifier SLOTNUM Number Module type numerical identifier MODTYPE Number Module type numerical identifier The TRMALLOC file contains information about how memory is allocated. Table 13 Configuration: Memory Allocation (TRMALLOC.dbf) Field Name Field Type Description DATADESC String Brief (coded) description of memory section MAXPTS Number Maximum number of points for this type ALLOCPTS Number Allocated points of this type FCASTPNTS Number Forecasted points of this type after the next download CURRPTS Number Currently used points of this type TriStation 1131 Developer’s Guide, 4.14.0 106 Chapter 1 Project Administration The SECUSERS file contains information about the users authorized access to the project. Table 14 Security: Users (SECUSERS.dbf) Field Name Field Type Description LOGINNAME (key) String User’s log on name USERNAME String User’s full name DESCRIP String User description PRIVLEVEL Number User’s privilege level The SECLVLS file contains information about the user’s access (privilege) level in the project. Table 15 Security: Levels (SECLVLS.dbf) Field Name Field Type Description PRIVLEVEL (key) Number User’s privilege level DESCRIP String User description The SECOPRS file contains information about the level of access required to use TriStation 1131 and controller operations. Table 16 Security: Operations (SECOPRS.dbf) Field Name Field Type Description CATEGORY String Operation category name DESCRIP String User description PRIVLEVEL Number Minimum privilege level required The PRINFO file contains information that is used when reports are printed. Table 17 Project: Information (PRINFO.dbf) Field Name Field Type Description PRJNAME String Project name DESCRIP String Project description VERSION String Project version number COINFO1 String Company information 1 COINFO2 String Company information 2 COINFO3 String Company information 3 DBDATE Date Date the report database was updated DBTIME String Time the report database was updated TriStation 1131 Developer’s Guide, 4.14.0 Generating Reports 107 The PRLIBS file contains information about the libraries included in the project. Table 18 Project: Shared Libraries (PRLIBS.dbf) Field Name Field Type Description LIBNAME (key) String Library name DESCRIP String Library description VERSION String Library version number The PRELEMS file contains information about the elements (programs, functions, function blocks, and data types) in the project. Table 19 Project: Elements (PRELEMS.dbf) Field Name Field Type Description ELEMNAME (key) String Element name VERSION String Element version number CATEGORY String Element category DESCRIP String Element description ELEMTYPE String Element type: function, function block, and so on. LANGUAGE String Language type: Function Block Diagram, Ladder Diagram, and so on. OWNER String Element owner name USERDEFINE Boolean User defined indicator LIBRARY Boolean Library indicator LIBNAME 8 characters Library name LOCKED Boolean Element locked indicator READONLY Boolean Element read-only indicator DRWGTITLE String Drawing title DRWGNUM Strings Drawing number DRWGREV String Drawing revision DRWGCBY String Created by user name DRWGCDATE Date Created date DRWGCTIME String Created time DRWGMBY String Modified by user name DRWGMDATE Date Modified date DRWGMTIME String Modified time DRWGAB String Approved by name DRWGADT String Approved date TriStation 1131 Developer’s Guide, 4.14.0 108 Chapter 1 Project Administration Table 19 Project: Elements (PRELEMS.dbf) (continued) Field Name Field Type Description APPLICATN String Element application type (safety or control) The PRPOUVAR file contains information about the POUs (program organizational units), which include programs, functions, and function blocks. Table 20 Project: POU Variables (PRPOUVAR.dbf) Field Name Field Type Description VARPATH String POU variable path POUNAME (key) String POU name VARNAME ((key) String POU variable name DESCRIP String Element description DATATYPE String Data type: BOOL, DINT, REAL, and so on. DATACLASS String Data class: local, input, output, and so on. INITVALUE String Initial value of the POU variable The PRPOUXRF file contains information about where variables are located in the project. Table 21 Project: POU Cross-Reference (PRPOUXRF.dbf) Field Name Field Type Description VARPATH (key) String Program variable path which indicates where the variable is used SEQNO Number Record sequence number 0–n SHTCOORD String Sheet coordinates of variable on SHTNUM The PRHIST file contains information about the project history. Table 22 Project: Audit History (PRHIST.dbf) Field Name Field Type Description EVENTID String ID of the event USERNAME String User’s full name ELEMNAME String Name of element that was changed COMMENT String Comment on change DATE Date Date of change TIME String Time of change ACTION String Action performed (including version number) TriStation 1131 Developer’s Guide, 4.14.0 Printing Project Documents 109 Printing Project Documents This section describes how to print project documents, including programs, functions, libraries, module configurations, project history, and more. The Print All command allows you to print multiple documents at one time. You have the ability to select which documents you want to print. Topics in this section include: • Printable Project Documents on page 109 • Printing Individual Documents on page 112 • Printing Multiple Documents on page 113 Printable Project Documents The following types of project documents and/or information can be printed: Table 23 Printable Project Documents Item Description Disabled Points Prints a report listing the currently disabled points in the application running on the Controller or the Emulator. Includes the tagname, location, the user who disabled the point, and more. Function Prints a logic sheet with the graphical representation of each function in the project. Each function is printed on a separate sheet. Function Blocks Prints a logic sheet with the graphical representation of each function block in the project. Each function block is printed on a separate sheet. Hardware Module Configuration Prints a report listing the controller hardware (MPs, CMs, I/O modules) currently configured in the project. I/O Points Utilization Prints a report listing all I/O modules (both allocated and spare) that have been configured in the project. Modules are organized by model number and I/O type. Includes the model number, name, total points, used points, and free points for each module. Instance Variable Connections Prints a report listing the variables used in your project, organized by instance. Library Documents: Functions Prints the structured text for each function in the libraries used by the project. Depending on the libraries being used, this report can be very large (more than 150 pages). TriStation 1131 Developer’s Guide, 4.14.0 110 Chapter 1 Project Administration Table 23 Printable Project Documents (continued) Item Description Library Documents: Report Prints a report listing the functions and function blocks in each of the libraries used by the project. Includes the name, description, category, version and more for each function and function block, organized by library. Module Configuration Settings Prints a report listing the current configuration settings for each applicable module in the project’s hardware configuration. Only modules that require configuration in TriStation 1131 are included in this report. For example, TCM and EPI module configuration details are included, but the SDO module is not, as it does not require configuration in TriStation 1131. Operating Parameters Prints the current setting of each item on the Operating Parameters screen. See Setting Tricon Operating Parameters on page 341 or Setting Trident or Tri-GP Operating Parameters on page 439 for details about these settings. POU Variables Prints a report listing all the variables defined in the project’s programs, functions, or function blocks. Includes each variable’s data type, initial value, and more. POU Cross-Reference Prints a report listing all the variables currently being used in the project, with a coordinate describing where they can be found on a program sheet. Programs Prints each program in the current project. Depending on the program type, either the structured text, or function block diagram sheet will be printed. Each program is printed on a separate sheet. Program Variable Listing Prints a report listing all the variables defined in each program in the project. Includes each variable’s data type, initial value, and more. Organized by program name. Project History by Element Prints a report extracted from the project’s audit trail (see View Project History Command on page 865). Includes information about user access and modification of the project, organized by the element changed (project, library, etc). Project History by Time Similar to the Project History by Element document described above, except this report is organized by time instead of by the element changed. Most recent events are at the top of the list. TriStation 1131 Developer’s Guide, 4.14.0 Printing Project Documents 111 Table 23 Printable Project Documents (continued) Item Description Project Implementation Prints a report listing the current configuration for each item in the Implementation Tree (see The Implementation Tree on page 127). Includes the Program Execution List, SOE block configuration, and scan time settings. Project Memory Allocation Prints a report listing the current memory allocation for the project, including points used, points allocated, and maximum points. Project Security Levels Prints a report listing each the security level currently assigned to each TriStation and controller operation for the project. See Changing the Security Level for Privileges on page 81 for more information. Project Users Prints a report listing each of the users that have been added to the project’s user list. Includes each user’s full name, user name, and security level. Only users that the currently logged-in user is allowed to view will appear in the report. For more information about user account visibility, see Managing Users on page 73. Shared Libraries Prints a report listing the libraries that have been added to the project, including their current version numbers. SOE Block Variables Prints a report listing the tagnames that have been assigned to SOE blocks. Tagnames: Complete Listing Prints a report listing all the tagnames that have been defined in the project. Includes both used and unused tagnames. Tagnames: Modbus Aliases Prints a report listing Modbus alias information for each tagname in the project. Organized by alias number. Tagnames: Where Used Prints a report listing the tagnames that have been used in a program in the project. Organized by the name of the tagname. Includes the name of the program the tagname is used in, and its sheet coordinates (when applicable). TriStation Communication Parameters Prints the current setting of each item on the TriStation Communication screen. See Chapter 5, Tricon Communication with TriStation 1131 or Chapter 6, Trident and Tri-GP Communication with TriStation 1131 for details about these settings. TriStation 1131 Developer’s Guide, 4.14.0 112 Chapter 1 Project Administration Table 23 Printable Project Documents (continued) Item Description User Documents Prints a report listing all the user documents in the project. User documents are programs, functions, function blocks, and data types that you created. Note If you have a PDF printer driver (such as Adobe® Acrobat® or PrimoPDF®) installed on your PC, you can choose to print these documents to a PDF file instead of a printer. This may be useful if you need to provide information to Customer Support when troubleshooting a problem, or any time you need to save or transfer this information electronically. Contact your system administrator if you need assistance with installing a PDF printer driver on your PC. Printing Individual Documents This procedure describes how to print individual documents. Only logic sheets, function blocks, and reports displayed in the current window can be printed individually. Note If the Print command is not enabled for the document you want to print, you may be able to print it by selecting the document from the Print All Options list. See Printing Multiple Documents on page 113. Procedure 1 Open the logic sheet, function block, or report you want to print. 2 On the File menu, select Print. The Print dialog box appears. 3 Select the desired properties for your printer (number of copies, page orientation, etc), and then click OK. The document currently being viewed is printed. TriStation 1131 Developer’s Guide, 4.14.0 Printing Project Documents 113 Printing Multiple Documents This procedure describes how to print multiple documents at the same time. Procedure 1 Open the Project Workspace (see The Project Workspace on page 22). 2 On the File menu, select Print All. The Print All Options dialog box appears. 3 Select the check boxes for the documents you want to print. See Printable Project Documents on page 109 for a description of each document in the list. To quickly clear the check boxes for all the documents in the list, and make it easier to select only those documents you want to print, clear the Select All check box. 4 Click OK. The Print dialog box appears. 5 Select the printer you want to use, and the desired settings (number of copies, page orientation, etc), and then click OK. The selected documents are printed. Note If any of the selected documents do not have content to be printed (for example, if you selected the Functions document, but no functions have been defined in the project), a message will appear in the messages window (see Messages Command on page 761). TriStation 1131 Developer’s Guide, 4.14.0 114 Chapter 1 Project Administration Customizing Your Workspace The TriStation 1131 workspace can be easily customized to suit your needs. The following are some of the ways you can change the workspace configuration: • Showing or Hiding a Window Pane on page 116 • Docking Window Panes on page 118 • Moving and Resizing Window Panes on page 121 Note Changes you make to customize your workspace apply to your current session only. If you close and re-open TriStation 1131, your changes will not be saved. TriStation 1131 Window Program Workspace Messages Pane Workspace Pane Figure 1 TriStation 1131 Workspace TriStation 1131 Developer’s Guide, 4.14.0 Customizing Your Workspace 115 This table describes the window panes in the TriStation 1131 window that can be displayed, hidden, or moved: Window Pane Description The Workspace Pane The Workspace Pane includes the following tabs: • Application (For more information, see The Application Workspace on page 126.) • Controller (For more information, see The Tricon Controller Workspace on page 339, and The Trident and Tri-GP Controller Workspace on page 437.) • Project (For more information, see The Project Workspace on page 22.) By default, these tabs appear on the left side of the TriStation 1131 window. Any active window in the Messages Pane can also be tabbed to the bottom of the Workspace Pane. For more information, see Docking Window Panes on page 118. The Program Workspace The Program Workspace enables you to create program elements in the application. By default, it appears in the top area of the TriStation 1131 window. The Messages Pane The Messages Pane allows you to review the results of any validation operation performed on your project file. The Tagname Editor also appears in this pane. It includes the following tabs: • Application • Controller • Find Results • Compare Results • Tagname (For more information, see Getting to Know the Tagname Editor on page 200.) Note The Application and Controller tabs in the Messages Pane are different from the tabs with the same names in the Workspace Pane. Any active window in the Workspace Pane can also be tabbed to the bottom of the Messages Pane. For more information, see Docking Window Panes on page 118. TriStation 1131 Developer’s Guide, 4.14.0 116 Chapter 1 Project Administration Showing or Hiding a Window Pane The Workspace Pane, Program Workspace, and Messages Pane, including their tabs, can be shown or hidden within the TriStation 1131 window, as desired. Showing or Hiding the Workspace Pane The Workspace Pane appears when you create or open a TriStation 1131 project. • To show the Workspace Pane with all three tabs (Application, Controller, and Project) at once, click Workspace on the View menu. You can also click the button in the toolbar. These toggle commands can also be used to close the Workspace Pane. • To display only a single tab in the Workspace Pane, click Workspace Panes on the View menu, and then click the desired tab name. This is a toggle command, also used to close the tab. • To close or hide one or more tabs in the Workspace Pane, click active tab(s). on the title bar of the Showing or Hiding the Program Workspace The Program Workspace appears when you create one or more programs in your TriStation 1131 application. • To display the Program Workspace, double-click a program element (a program, function, function block, data type, or certificate) or Implementation in the Application tab. • To close or hide one or more tabs in the Program Workspace, click the active tab(s). on the title bar of Showing or Hiding the Messages Pane The Messages Pane appears when you create or open a TriStation 1131 project. • To display the Messages Pane with all five tabs (Application, Controller, Find Results, Compare Results, and Tagname) at once, click Workspace on the View menu, or click the button in the toolbar. • To display only a single tab in the Messages Pane, click Messages Panes on the View menu, and then click the desired tab name. • To close the Messages Pane, click TriStation 1131 Developer’s Guide, 4.14.0 on the title bar of the active tab. Customizing Your Workspace 117 Using Auto Hide The Auto Hide feature allows you to temporarily hide the Workspace or Messages Panes so that you have more area to work with the active elements in the Program Workspace. To hide the Workspace Pane or the Messages Pane, click the Auto Hide button on the title bar. The Workspace Pane is tabbed to the left side of the TriStation 1131 window, and the Messages Pane is tabbed to the bottom of the TriStation 1131 window, providing more area to view the elements in the Program Workspace. Workspace Pane tabbed when Auto Hide button is clicked Messages Pane tabbed when Auto Hide button is clicked To display a tab that is hidden, click the Auto Hide button Note again. When you click the Auto Hide button on a specific tab in the Workspace or Messages Pane, the other tabs within the Workspace or Messages Panes are also hidden. TriStation 1131 Developer’s Guide, 4.14.0 118 Chapter 1 Project Administration Docking Window Panes Docking a window means to attach it to an edge of the Program Workspace or the TriStation 1131 window. This allows you to drag and drop it to specific areas within the interface. When you dock the window, it is automatically resized to fit the area. The other windows in the area, if any, are also resized. When you drag the window pane towards any of these areas, a compass (comprising four arrows and a center) appears in the center of the area. A root compass (comprising four arrows) also appears over the four outer edges of the area. Blue shading appears to indicate the area where the pane will be docked. Window Docking Examples The following example scenarios describe how to dock the Messages Pane in various locations. If you want to dock the Messages Pane to the left edge of the Program Workspace, drag the pane, and then click the left arrow of the compass, as shown in the following figure. Compass (top arrow) Root Compass (left arrow) TriStation 1131 Developer’s Guide, 4.14.0 Left arrow of the compass docks to the left edge (shaded area) of the Program Workspace Customizing Your Workspace 119 To dock the Messages Pane to the left edge of the TriStation 1131 window, drag the pane, and then click the left arrow of the root compass, as shown in the following figure. Left arrow of the root compass docks to the left edge (shaded area) of the Program Workspace TriStation 1131 Developer’s Guide, 4.14.0 120 Chapter 1 Project Administration To dock the Messages Pane to the center of the Workspace Pane, drag it, and then click the center button of the compass, as shown in the following figure. Note The center button appears only within the Workspace or Messages Panes. Center button of the compass docks to the center of the pane where it is dragged to The following figure shows the Messages Pane docked to the center of the Workspace Pane. Tabs from both the Workspace Pane and the Messages Pane TriStation 1131 Developer’s Guide, 4.14.0 Customizing Your Workspace 121 Moving and Resizing Window Panes All the window panes can be moved and/or resized within the TriStation 1131 window. You can move these to any location that is convenient for you. To… Do This… Move a window pane Click the title bar of the window pane and then drag it to the desired area. Do not point to any of the arrows of the compass or the root compass. Restore a window pane to its previous location Double-click the title bar of the window pane. Resize a window pane Click and drag the edges of the window pane to the desired size. Restore a window pane to its default size Double-click the title bar of the window pane. TriStation 1131 Developer’s Guide, 4.14.0 122 Chapter 1 Project Administration TriStation 1131 Developer’s Guide, 4.14.0 2 Application Development Overview 124 Application Development Steps 125 Application Elements 126 User Documents 135 Function Block Diagram and Ladder Diagram Development 142 Structured Text Development 155 Cause Effect Matrix Development 167 Variables and Constants 189 Tagnames 198 Alarms 229 Importing and Exporting Tagnames 245 Annotations and Comments 264 Modbus Applications 273 Peer-to-Peer Applications 284 SOE Development 290 Tricon Application Access 299 Trident and Tri-GP Application Access 304 Secure Communication 310 Building an Application 323 TriStation 1131 Developer’s Guide, 4.14.0 124 Chapter 2 Application Development Overview This figure shows the main steps for developing a TriStation 1131 application. An application can be developed and tested on the Emulator before downloading the application to a controller. Set Up the Project Develop the Application - C reate programs and functions - Restrict access to application elements - Restrict access to application points - Declare tagnames Test with the Emulator Fix Errors Yes Errors? No C onfigure the C ontroller Set Up TriStation C ommunication Implement on the C ontroller TriStation 1131 Developer’s Guide, 4.14.0 - Build and test application Application Development Steps 125 Application Development Steps This list includes the steps that can or should be performed during application development. Step See Plan the application. • Safety and Control Applications on page 130 Create programs and functions. • User Documents on page 135 • Function Block Diagram and Ladder Diagram Development on page 142 • Structured Text Development on page 155 • Cause Effect Matrix Development on page 167 Add annotations and comments. • Annotations and Comments on page 264 Determine access to a document. • Restricting Access to a Document on page 140 Determine access to points. • Tricon Application Access on page 299 • Trident and Tri-GP Application Access on page 304 Create variables and constants. • Declaring Variables on page 189 • Creating Constants on page 196 Declare tagnames. • Tagnames on page 198 Configure process alarms. • Alarms on page 229 Import or export tagnames. • Importing and Exporting Tagnames on page 245 Assign Modbus aliases. • Modbus Applications on page 273 Add Peer-to-Peer features. • Peer-to-Peer Applications on page 284 Compile project programs and functions. • Compiling a Program on page 325 Build the application. • Building an Application on page 323 Enable secure communication. • Secure Communication on page 310 TriStation 1131 Developer’s Guide, 4.14.0 126 Chapter 2 Application Development Application Elements This section describes the elements of an application and the steps in application development. Topics include: • The Application Workspace on page 126 • The Declaration Tree on page 127 • The Implementation Tree on page 127 • Parts of an Application on page 128 • Safety and Control Applications on page 130 • Programming Languages on page 131 The Application Workspace Application development takes place in the Application Workspace. The folders in this tree include the user programs, functions, function blocks, data types, tagnames, certificates and implementation settings needed for the application. The tree also includes the TriStation 1131 library of functions, function blocks, and data types that can be used in the project. For information about how you can change the location of the Application Workspace pane, see Customizing Your Workspace on page 114. TriStation 1131 Developer’s Guide, 4.14.0 Application Elements 127 The Declaration Tree The Declaration Tree lists the declarations for the currently opened program, function, or function block. Declaration Tree The Implementation Tree The Implementation Tree lists the elements that can be specified for the application, including the Execution List (list of programs and scan time), SOE Configuration, and Peer-To-Peer Configuration. Implementation Tree TriStation 1131 Developer’s Guide, 4.14.0 128 Chapter 2 Application Development Parts of an Application The major elements in an application are programs, functions, function blocks, tagnames, variables, implementation information, and controller configuration. Application An application includes application elements and configuration information that is built (compiled) into executable code and downloaded and run on a Triconex controller. The maximum number of programs in an application is 250. Program Organizational Units (POUs) A program organizational unit is a program, function, or function block. The maximum number of POUs in an application being downloaded to the Emulator is 3,001 (this limitation does not apply to programs being downloaded to the controller). However, this limit includes internal system POUs, so the actual number of POUs available for inclusion in an emulated application is dependent on the control program implementation. Programs A program is an executable element that includes one or more functions and function blocks. A program can invoke functions and function blocks but cannot invoke another program. A program is initiated from the Execution List. The maximum number of user-defined variables that can be used in a program is 2,000, which includes local variables and tagnames, but not VAR_TEMP variables. Functions and Function Blocks A function is an executable element that returns exactly one result. The values in a function exist only while the function is executing. A function block is an executable element that returns one or more values and retains the values derived during one evaluation for use in the next evaluation. For function blocks, a set of input values may not yield the same output values. The maximum number of variables that can be used in a function or function block is 400, which includes input, output, input/output, and local variables, but not VAR_TEMP variables. TriStation 1131 Libraries TriStation 1131 includes libraries of functions, function blocks, and data types that are automatically included with each project. For information on specific functions, function blocks, and data types, see the TriStation 1131 Libraries Reference. TriStation 1131 Developer’s Guide, 4.14.0 Application Elements 129 User-Defined Functions In user-defined functions, if no value is assigned to the function output, the return value is the default initial value. If there is not a statement that assigns a value to the function output, a compiler error occurs. No error or warning is issued if an assignment to the function output is in a conditional statement and is not executed. Tagnames A tagname identifies input, output, and memory points that are accessible to all programs in the application. In IEC terminology, tagnames are called global variables. The maximum number of user-defined variables and tagnames in a program is 2,000. Variables A variable is a named area in memory that stores a value or string assigned to that variable. Table 24 Variable Types and Uses Variable Type Used With Input Functions and function blocks In/Out Function blocks Output Functions and function blocks Local Functions, function blocks, and programs Tagname Programs VAR_TEMP Currently available only in ST programs and function blocks Data Types A data type identifies the type of data used in tagnames and variables. TriStation 1131 uses both elementary and generic data types. For more information, see Appendix C, Data Types. • Elementary types are defined by IEC 61131-3 and include: BOOL, DATE, DINT, DT, DWORD, INT, LREAL, REAL, STRING, TIME, and TOD. TriStation 1131 also supports the derivation of structured, array, and enumerated data types. • Generic data types are used to organize elementary data types that have similar properties and can be used with IEC 61131-3 standard functions that support overloaded inputs and outputs. Generic data type names use the prefix ANY. Controller Configuration The controller configuration specifies the communication characteristics for memory, module configuration, and other hardware-related settings. When the application is built, this information is required. For more information, see Chapter 3, Tricon Controller Configuration and Chapter 4, Trident and Tri-GP Controller Configuration. TriStation 1131 Developer’s Guide, 4.14.0 130 Chapter 2 Application Development Implementation Information Implementation information includes the Execution List, Scan Time, SOE, and Peer-to-Peer setup. Safety and Control Applications An application can include safety programs only, control programs only, or a combination of safety and control programs. Safety applications are the most restrictive type because they are designed to take a process to a safe state when predetermined conditions are violated. All elements of the application (programs, functions, function blocks, and tagnames) must be approved or specified for safety. Control applications are designed to control a process and can use control, or safety and control functions and function blocks. The tagnames must be specified as control tagnames. This table describes how programs, functions, function blocks, and tagnames can be used in safety and control applications. Table 25 Safety and Control Usage Application Elements Use Programs Safety programs cannot use control functions, function blocks, or tagnames. Control programs cannot use safety tagnames. Functions and Function Blocks Can be safety and control, or control. Tagnames Can be safety or control. If Shared Read is selected, a safety program can read a control tagname and vice-versa. Library functions and function blocks are designated as approved for use in safety and control or control applications. These designations cannot be changed. TriStation 1131 Developer’s Guide, 4.14.0 Application Elements 131 Programming Languages TriStation 1131 supports multiple programming languages for developing, testing, and documenting applications that run on a Triconex controller. TriStation 1131 supports these programming languages: • Function Block Diagram Language (FBD) • Ladder Diagram Language (LD) • Structured Text Language (ST) • CEMPLE (Cause and Effect Matrix Programming Language Editor) The Function Block Diagram, Ladder Diagram, and Structured Text languages comply with the IEC 61131-3 International Standard on Programming Languages for Programmable Controllers. CEMPLE is an optional language that can be purchased separately from Invensys. Function Block Diagram Language Function Block Diagram (FBD) language is a graphical language that corresponds to circuit diagrams. The elements used in this language appear as blocks wired together to form circuits. The wires can communicate binary and other types of data between FBD elements. In FBD, a group of elements visibly interconnected by wires is known as a network. An FBD diagram can contain one or more networks. Figure 2 Sample FBD Network TriStation 1131 Developer’s Guide, 4.14.0 132 Chapter 2 Application Development Ladder Diagram Language Ladder Diagram (LD) language is a graphical language that uses a standard set of symbols to represent relay logic. The basic elements are coils and contacts which are connected by links. Links are different from the wires used in FBD because they transfer only binary data between LD symbols, which follow the power flow characteristics of relay logic. Function blocks and function elements which have at least one binary input and output can be used in LD diagrams. Figure 3 Sample Ladder Diagram TriStation 1131 Developer’s Guide, 4.14.0 Application Elements 133 Structured Text Language Structured Text (ST) language is a general purpose, high-level programming language, similar to PASCAL or C. Structured Text is particularly useful for complex arithmetic calculations, and can be used to implement complicated procedures that are not easily expressed in graphical languages such as FBD or LD. ST allows you to create Boolean and arithmetic expressions as well as structured programming constructs such as conditional statements (IF...THEN...ELSE). Functions and function blocks can be invoked in ST. Figure 4 Sample Structured Text Code TriStation 1131 Developer’s Guide, 4.14.0 134 Chapter 2 Application Development CEMPLE (Cause and Effect Matrix Programming Language Editor) CEMPLE™, which stands for Cause and Effect Matrix Programming Language Editor, is a Triconex language based on cause and effect matrix methodology, which is commonly used in the process control industry. A cause and effect matrix is frequently used for applications such as fire and gas systems for which the programming logic is simple, but the volume of inputs and outputs that need to be controlled is high. A matrix is readily understood by a broad range of plant personnel from process control engineers to maintenance operators. CEMPLE allows you to associate a problem in a process with one or more actions that must be taken to correct the problem. The problem is known as a cause and the action is known as an effect. In a typical matrix, a cause is represented by a row in the matrix and an effect is represented by a column. An X in the intersection of a cause row and an effect column establishes a relationship between the cause and the effect. Figure 5 Sample CEMPLE Matrix TriStation 1131 Developer’s Guide, 4.14.0 User Documents 135 User Documents This section describes the how to create and specify user documents, which include programs, functions, function blocks, and data types. Topics include: • Creating a User Document on page 135 • Copying User or Library Documents on page 136 • Specifying Document Summary Information on page 138 • Specifying Document Attributes on page 139 • Restricting Access to a Document on page 140 • Changing a Document Owner on page 141 Note If you are trying to edit a user document created by another user, and are unable to do so even when you have the correct user level and access privileges, check the document’s access property. If it is locked, you must ask the user who created the document to change the access property. See Restricting Access to a Document on page 140. Creating a User Document This procedure explains how to create a user document. A user document can be a program, function, function block, or data type. Procedure 1 Expand the Application tree, right-click the User Documents folder, and then click New Document. TriStation 1131 Developer’s Guide, 4.14.0 136 Chapter 2 Application Development 2 3 Specify these properties in the New Document dialog box. Property Action Name Enter a descriptive name for the document. Document Type Click the type of document to create. The default is Program. Language Click the language type to use. The default is Function Block Diagram. Application Type Click the type of application the document is to be used in. The default is Control. Click OK. The document is opened in the specified programming language. Copying User or Library Documents You can make copies of user documents you have created, as well as library documents. This can help you reduce development time by using an existing document as the basis for a new document. Note Using the Print All command, you can print a report listing all the user documents you have created in a project (User Documents). See Printing Project Documents on page 109. Topics include: • Copying a User Document on page 136 • Copying a Library Document on page 137 Copying a User Document This procedure explains how to copy a user document. Procedure 1 Expand the Application tree, right-click the document to be copied, and click Copy. If the document is open in TriStation 1131, the Copy command will be unavailable. Close the document and then repeat step 1. 2 On the Edit menu, click Paste. TriStation 1131 Developer’s Guide, 4.14.0 User Documents 3 137 Enter the name for the new document, and click OK. Copying a Library Document This procedure explains how to make a copy of an existing library document. Only functions and data types can be copied; function blocks cannot be copied. Procedure 1 Expand the Application tree, open the Library Documents folder and locate the function or data type you want to copy. 2 Right-click on the function or data type, and select Copy. If the document is open in TriStation 1131, the Copy command will be unavailable. Close the document and then repeat steps 1 and 2. 3 In the Application tree, right-click the User Documents folder and select Paste. 4 Enter a name for the copied document, and then click OK. The new function or data type is now located in the appropriate folder in the User Documents folder. TriStation 1131 Developer’s Guide, 4.14.0 138 Chapter 2 Application Development Specifying Document Summary Information This procedure explains how to specify summary information for a document. Procedure 1 Expand the Application tree, right-click a document (program, function, function block, or data type) and click Properties. 2 Specify these properties on the Summary tab. 3 Property Action Name Displays the name of the document and version number. Internal ID Displays an internal number used to identify the document. Owned by Displays the name of the owner. To change, click Change Owner. Created Displays the date and time the document was created. Modified Displays the date and time the document was last modified. Compiled Displays the date and time the document was last compiled. Category Enter a name to be used to categorize the document. Documents can be organized and displayed by categories. Description Enter a description for the document. Document Access Select the type of access to allow for this document. The default is Read/Write. See Restricting Access to a Document on page 140. Change Owner Command Click the Change Owner button to change the owner of the document. See Changing a Document Owner on page 141. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 User Documents 139 Specifying Document Attributes This procedure explains how to specify document attributes, which include the type of application the document can be used in, and whether the document can be used in a CEM program. Procedure 1 Expand the Application tree, right-click a document (program, function, function block, or data type), and click Properties. 2 Click the Attributes tab. 3 Specify these properties on the Attributes tab. Property Action Application Type Specify whether this document can be used in Safety, Control, or Safety and Control applications. The default is Control. See Safety and Control Applications on page 130. Cause Effect Matrix Support Select the check box for each type that is supported. Specify the number of inputs and outputs, if needed. Only available for functions and function blocks. See Enabling User-Defined Functions and ApplicationDefined States on page 177. Enable Color Monitoring Select the check box if you want a color displayed for BOOL inputs and outputs when the application is run on the controller or Emulator. Only available for programs written in FBD, LD, or CEM. See Specifying Monitor Colors for BOOL Values on page 45. 4 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 140 Chapter 2 Application Development Restricting Access to a Document This procedure explains how to restrict access to a document by setting the Access property. The most restrictive setting is for Read, which means anyone with a lesser security level than yours cannot change it. The least restrictive setting is for Read/Write, which means all users can read and change the document. You can also Lock the document to prevent editing by unauthorized users. To change the setting for this property, you must have a User Security level that includes Change Access Attributes. For more information, see Managing User Access on page 66. Procedure 1 Expand the Application tree, right-click a document (program, function, function block, or data type), and click Properties. Document Access property 2 On the Summary tab, select the access type for this document. The default value is Read/Write. 3 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 User Documents 141 Changing a Document Owner This procedure explains how to change the owner of a document, which determines whether other users can change the element. Normally, the owner of a document is the user who created it. To change the setting for this property, your user security level must: • Include the Elements: Change Access Attributes privilege • Be the same or greater than the security level of the user you want to assign as owner For more information about user security levels, see Managing User Access on page 66. Procedure 1 Expand the Application tree, right-click a document (program, function, function block, or data type), and click Properties. 2 On the Summary tab, click Change Owner. 3 In the Users dialog box, select the user who is to become owner of this element. 4 Click OK. The Owned By property in the Document Properties dialog box displays the name of the new owner. TriStation 1131 Developer’s Guide, 4.14.0 142 Chapter 2 Application Development Function Block Diagram and Ladder Diagram Development This section explains how to use Function Block Diagram (FBD) and Ladder Diagram (LD) languages to develop programs, functions, and function blocks. Topics include: • Using the FBD Editor on page 143 • Using the LD Editor on page 144 • Function and Function Block Graphics on page 145 • Working with Logic Sheets on page 146 • Selecting Library Elements on page 150 • Specifying Function Properties on page 151 • Specifying Function Block Properties on page 152 • Specifying Function Block Application Usage on page 153 • Using a Space Saver Function Block on page 154 TriStation 1131 Developer’s Guide, 4.14.0 Function Block Diagram and Ladder Diagram Development 143 Using the FBD Editor The Function Block Diagram (FBD) editor allows you to develop programs and functions by using a graphical language that corresponds to circuit diagrams. Toolbar commands are described in detail in Appendix A, Commands and Properties. 1 Declaration Tree 6 Insert Module Command 11 Comment Tool 16 Zoom To Fit Command 2 Selection Tools 7 Insert Input Variable Command 12 Horizontal Network Divider Command 17 Previous Sheet Command 3 Function Block Command 8 Tagname 13 Vertical Network Divider Command 18 Sheet Manager 4 Local Variable 9 Constant 14 Auto Name Command 19 Next Sheet 5 Input Variable 10 Wire Tool Command 15 Zoom Command 1 Figure 6 Note 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 Function Block Diagram Editor Elements For information on using keyboard and mouse shortcuts in the FBD editor, see Appendix G, Keyboard Shortcuts. TriStation 1131 Developer’s Guide, 4.14.0 144 Chapter 2 Application Development Using the LD Editor The Ladder Diagram (LD) editor allows you to develop programs and functions by using a graphical language that corresponds to relay logic. Toolbar commands are described in detail in Appendix A, Commands and Properties. 1 Declaration Tree 7 Input 13 Link Command 19 Zoom To Fit Command 2 Selection Tools 8 Local Variable 14 Comment Tool 20 Previous Sheet Command 3 Function Block Command 9 Insert Module Command 15 Horizontal Network Divider Command 21 Sheet Manager 4 Contact Command 10 Insert Input Variable Command 16 Vertical Network Divider Command 22 Next Sheet 5 Coil Tool Command 11 Tagname 17 Auto Name Command 6 Right Power Rail Command 12 Constant 18 Zoom Command 1 Figure 7 Note 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 Ladder Diagram Editor Elements For information on using keyboard and mouse shortcuts in the LD editor, see Appendix G, Keyboard Shortcuts. TriStation 1131 Developer’s Guide, 4.14.0 Function Block Diagram and Ladder Diagram Development 145 Function and Function Block Graphics In FBD and LD languages, each function and function block is graphically represented on the logic sheet. For more information on specific functions and function blocks, see the TriStation 1131 Libraries Reference. Function Output terminal Input terminals Evaluation order in program Instance name for the function block Function Block Names of input terminals Input terminals Type name (CSCHED) Output terminal names Output terminals Evaluation order in program Figure 8 Function and Function Block Elements Table 26 Function Block Graphic Elements Item Description Instance name Identifies the specific implementation of a function block type. For function blocks only. Names of terminals Identify the input and output parameters used with the function block. Terminals Locations where variables are attached. Evaluation order Identifies the order in which the function is executed in the program. Type name Identifies the function block type. TriStation 1131 Developer’s Guide, 4.14.0 146 Chapter 2 Application Development Working with Logic Sheets Logic sheets are the workspace for developing programs, functions, and function blocks. Four sheet sizes are available; there is no limit to the number of sheets you can have in a program or function. This section describes how to select, manage, and edit logic sheets. Topics include: • Selecting a Sheet Template on page 146 • Managing Logic Sheets on page 147 • Editing the Sheet Title on page 148 • Printing Logic Sheets on page 149 Selecting a Sheet Template This procedure explains how to select a sheet template. The sheet template defines the size of the logic sheets used in the selected program, function, or function block. Procedure 1 Expand the Application tree, and then create or open a program, function, or function block. 2 On the Sheets menu, click Select Sheet Template. 3 Select the template you want to use for logic sheets. Sheet Template Description SheetTemplate A 8.5” x 11” SheetTemplate B 11” x 17” (default) SheetTemplate C 17” x 22” SheetTemplate D 22” x 34” TriStation 1131 Developer’s Guide, 4.14.0 Function Block Diagram and Ladder Diagram Development Note 4 147 Logic sheets are oriented in the landscape (horizontal) direction. If you want your logic sheets to be in the portrait (vertical) orientation, be sure to select the _Portrait version of the desired sheet template. Click OK to save your selection and apply the new sheet size to the open program, function, or function block. The new sheet size will also apply to any new programs, functions, or function blocks you create. Managing Logic Sheets This procedure explains how to append, insert, and delete logic sheets in a program, function, or function block. Procedure 1 Expand the Application tree, and then create or open a program, function, or function block. 2 On the FBD or LD Editor toolbar, click the Sheets Manager button 3 Do any of the following: . • To add a new sheet after an existing sheet, select the existing sheet, and then click Append. In the Enter Sheet Title box, enter the new sheet title and then click OK. • To add a new sheet before an existing sheet, select the existing sheet, and then click Insert. In the Enter Sheet Title box, enter the new sheet title and then click OK. • To delete one or more sheets, select the sheet(s) you want to remove and then click Delete. To select multiple contiguous sheets, press Shift and click the first and the last sheet in the range you want to select. To select multiple non-contiguous sheets, press Ctrl and click each sheet. You are asked to confirm the deletion of the sheet(s). • To change an existing sheet’s title, select the sheet whose title you want to change, and then click Title. In the Enter Sheet Title box, enter the new sheet title and then click OK. TriStation 1131 Developer’s Guide, 4.14.0 148 Chapter 2 Application Development • To move a sheet up or down in the execution order within a program, select the sheet, and then click Move Up or Move Down. You can reorder only one sheet at a time. CAUTION • Since the execution order of the sheets changes after adding, deleting, or reordering them, before compiling, you must validate the program to ensure no errors were introduced as a result of these changes. To view a specific sheet, select the sheet and then click Go To. 4 Click OK to save your changes. 5 When prompted to confirm that a Download Changes operation will be required as a result of your changes, click OK. When you add, delete, or reorder a sheet, network connections within the program are also reordered. Therefore, you must recompile the program and perform a Download Changes operation after you make any of these changes in the Sheets Manager. Editing the Sheet Title This procedure explains how to change the title of the current sheet. The sheet title is displayed in the title block, the window caption bar, and the Window Menu list. It does not affect the logic on the sheet. Procedure 1 Expand the Application tree, and then create or open a program, function, or function block. 2 Use the Previous Sheet and/or Next Sheet buttons on the FBD or LD Editor toolbar to display the sheet whose title you want to change. 3 On the Sheets menu, click Edit Sheet Title. 4 Enter the sheet title and then click OK. Note To change the sheet title for multiple sheets without displaying each individual sheet, use the Sheets Manager dialog box. See Managing Logic Sheets on page 147. TriStation 1131 Developer’s Guide, 4.14.0 Function Block Diagram and Ladder Diagram Development 149 Printing Logic Sheets This procedure explains how to print one or more logic sheets in a project. You can print logic sheets individually, or you can print all logic sheets in a project at once. Printing Individual Logic Sheets 1 Expand the Application tree, and then create or open a program, function, or function block. 2 Use the Previous Sheet and/or Next Sheet to display the sheet you want to print. 3 On the File menu, select Print. The Print dialog box appears. 4 Select the desired properties for your printer (number of copies, page orientation, etc), and then click OK. buttons on the FBD or LD Editor toolbar Printing Multiple Logic Sheets 1 Open the Project Workspace (see The Project Workspace on page 22). 2 On the File menu, select Print All. The Print All Options dialog box appears. 3 Select the check boxes for the following documents: • Functions • Function Blocks • Programs TriStation 1131 Developer’s Guide, 4.14.0 150 Chapter 2 Application Development Note To quickly clear the check boxes for all the documents in the list, and make it easier to select only those documents you want to print, clear the Select All check box. 4 Click OK. The Print dialog box appears. 5 Select the printer you want to use, and the desired settings (number of copies, page orientation, etc), and then click OK. Selecting Library Elements This procedure explains how to select a library element to include in a program or function. TriStation 1131 includes libraries of functions, function blocks, and data types that can be used in a project. Many of these elements include the source code, which can be copied to a program or function. Procedure 1 Expand the Application tree, and then create or open a program. 2 On the FBD or LD Editor toolbar, click the Select Function (Block) Tool Element button . 3 Select the function or function block to be inserted, and then click OK. 4 Click on the logic sheet to place the element. To insert another function or function block of the same type, click the Function (Block) Tool , and then click on the logic sheet to place the element. To select a different function or function block, repeat steps 2–4. TriStation 1131 Developer’s Guide, 4.14.0 Function Block Diagram and Ladder Diagram Development Note 151 You can easily create your own function by making a copy of an existing library function, and then modifying it to suit your needs. See Copying a Library Document on page 137. Specifying Function Properties This procedure explains how to specify properties for functions. Procedure 1 Expand the Application tree and open a program or function. 2 Double-click the graphic of the function whose properties you want to define. 3 Specify these properties on the Function tab. Property Action Number of Inputs If the Number of Inputs fields is enabled, the function is extensible, which means the number of inputs can be changed. To add inputs, enter the number of inputs and click Apply. Invert Input If an input is inverted, the value is changed to the opposite value (True to False, or False to True) when the function is executed. Only available for BOOL inputs. To invert the value for a specific BOOL value, select the input and then select the Invert Input check box. Invert Output If an output is inverted, the value is changed to the opposite value (True to False, or False to True) when the function is executed. Only available for BOOL outputs. To invert the value for the output, select the Invert Output check box. Width Click + or – to increase or decrease the width of the selected function graphic on the logic sheet. EN/ENO To include an input and output parameter that detects errors in FBD and LD logic, select the EN/ENO check box. Required in functions and function blocks used in LD programs. TriStation 1131 Developer’s Guide, 4.14.0 152 Chapter 2 Application Development 4 Property Action Double Space Select the check box to have space in the function graphic on the logic sheet doubled between the inputs and outputs. Click OK to save your changes. Specifying Function Block Properties This procedure explains how to specify properties for function blocks. Function blocks must have at least one BOOL input and one BOOL output. All input, output, and local variables in a function block persist from one execution of a function block to the next execution. Consequently, the same function block invoked with the same inputs may not return the same outputs. Any function block previously declared can be used in the declaration of another function block or program. The scope of an instance of a function block is local to the function block or program that declares the instance. Procedure 1 Expand the Application tree and open a program or function block. 2 Double-click the graphic of the function block whose properties you want to define. 3 Specify these properties on the Function Block tab. Property Action Instance Name Enter a name for this specific implementation of the function block. Invert Input/Output If an input or output is inverted, the value is changed to the opposite value (True to False, or False to True) when the function is executed. Only available for BOOL inputs. To invert the value for a specific BOOL value, select the input or output and then select the Invert Input/Output check box. Width TriStation 1131 Developer’s Guide, 4.14.0 Click + or – to increase or decrease the width of the selected function block graphic on the logic sheet. Function Block Diagram and Ladder Diagram Development 4 Property Action EN/ENO Only available with functions. Double Space Select the check box to have space in the function block graphic on the logic sheet doubled between the inputs and outputs. The default is cleared. 153 Click OK to save your changes. Specifying Function Block Application Usage This procedure explains how to specify the Usage property for function blocks, which determines how the function block is used in a program. You can specify the usage for userdefined function blocks, but you cannot change the settings for TriStation 1131 library function blocks. Procedure 1 Expand the Application tree and expand the User Documents folder. 2 Right-click a function block, click Properties, and then click the Usage tab. 3 Specify one of these settings on the Usage tab. TriStation 1131 Developer’s Guide, 4.14.0 154 Chapter 2 Application Development Setting Action Space Saver Use when a single instance can be executed more than once per scan to reduce memory usage and increase performance. For more information on specific requirements for using a function block as a space saver, see Using a Space Saver Function Block on page 154. 4 Exactly Once Use when each instance should be executed exactly once per scan. Only Once Use when each instance should be executed only once per scan, but does not need to be executed every scan. Internal State Use when a single instance can be executed more than once per scan. Click OK to save your selection. Using a Space Saver Function Block This procedure explains how to use a function block as a space saver. The Space Saver setting means a single instance can be executed more than once per scan to reduce memory usage and increase performance. For user-defined function blocks, you can specify this setting. For Triconex Library function blocks, the setting cannot be changed. • Declare only one instance of the function block and use that same instance throughout your program. On a function block diagram, just use the same instance name repeatedly. • To prevent mistakes, connect a value to every function block input. If you forget to connect an input, then you must search for a previous execution of the function block to see the input value because the function block remembers the input value from one execution to the next if the input is not connected. • Do not use the function block instance more than once in a network—the result is a WG0014 warning because the diagram could be ambiguous. TriStation 1131 Developer’s Guide, 4.14.0 Structured Text Development 155 Structured Text Development This section explains how to use Structured Text (ST) language to write a program, function, function block, or data type. Structured Text is a high level language that has been specifically developed for industrial control applications. For more information, see Programming Industrial Control Systems Using IEC 1131-3, by R.W. Lewis, London: Short Run Press Ltd., 1998 (ISBN: 0852969503). Topics include: • Using the ST Editor on page 156 • Using Expressions on page 157 • Defining an Enumeration Data Type on page 158 • Defining an Array Data Type on page 159 • Defining a Structured Data Type on page 160 • Declaring a VAR CONSTANT on page 160 • Declaring a VAR_TEMP on page 161 • Declaring a VAR_EXTERNAL on page 162 • Declaring Local Variables in ST on page 163 • Declaring Input and Output Variables in ST on page 163 • Using For Loop and Exit Statements on page 164 • Using a CASE Statement on page 165 • VAR_IN_OUT Function Parameters on page 166 TriStation 1131 Developer’s Guide, 4.14.0 156 Chapter 2 Application Development Using the ST Editor The Structured Text (ST) editor allows you to develop programs and functions by writing code. This figure shows the logic sheet and commands. Toolbar commands are described in detail in Appendix A, Commands and Properties. 1 Read Only Command 3 Replace Command 5 Larger Font (Font Size) 7 Type Over Command 2 Find Text Command 4 Line Numbers 6 Smaller Font (Font Size) 8 Auto Indent Command 1 2 3 Figure 9 4 5 6 7 8 Structured Text Editor Elements The ST compiler allows you to insert tabs, spaces, and comments between keywords and identifiers wherever a space is required. Each statement must be terminated with a semi-colon (;) separator. Comments must be preceded by (* and followed by *), as shown in this example: (* this is a comment *) Note You can easily add code to your ST program by copying and pasting code from existing library or user documents. To do so, while viewing the code you want to copy, select the code, right-click on it, and select Copy. Then, return to your ST program, right-click where you want to add the code, and select Paste. For information on using keyboard and mouse shortcuts in the ST editor, see Appendix G, Keyboard Shortcuts. TriStation 1131 Developer’s Guide, 4.14.0 Structured Text Development 157 Using Expressions An expression is a sequence of variable or constant operands and operators that compute a value. For example, an expression to calculate the total area of two rectangles could be written as follows: (RectA_width * RectA_height) + (RectB_width * RectB_height) Operands and Operators An operand is an element with which an operation is performed. An operand can be a variable (for example, X. ALARM1, VALVE_OPEN) or a literal constant (for example, 1234, 1.35, 16#FFFF). For each expression, the operands must be the same type. For example, you cannot add a BOOL operand to an INT operand. An operator performs a specific action on one or more operands to compute a value. For example, the multiplication operator (*) is used to compute the product of two or more operands: MyValue * 100 Order of Evaluation Expressions are evaluated in a specific order, depending on the precedence of the operators and/or sub-expressions. Parentheses are used to isolate sub-parts of an expression and prioritize expression evaluation. Expressions within parentheses have the highest precedence and are always evaluated first. Other operators are subsequently evaluated based on their precedence. When operators have equal precedence, they are evaluated from left to right. The following table lists the Arithmetic and Boolean operators, and their order of evaluation or precedence: Table 27 Operation Symbol Precedence Operation Symbol Precedence Parenthesization (Expression) 1 (Highest) Function Evaluation Identifier (Argument List) 2 Example: LN(A) MAX(X,Y), etc. Exponentiation ** 3 Negation - 4 Complement NOT 4 Multiply * 5 Divide / 5 Modulo MOD 5 Add + 6 Subtract - 6 TriStation 1131 Developer’s Guide, 4.14.0 158 Chapter 2 Application Development Table 27 Operation Symbol Precedence (continued) Operation Symbol Precedence Comparison <, >, <=, >= 7 Equality = 8 Inequality <> 8 Boolean AND AND 9 Boolean Exclusive OR XOR 10 Boolean OR OR 11 (Lowest) Defining an Enumeration Data Type An enumerated data type is a data type that allows different states of a value to be given different names. Note Once an enumerated data type has been successfully compiled, you can assign it as a data type for local variables. See Declaring Variables on page 189 for more information. Syntax Example TYPE ENUM_COLORS: (YELLOW, RED, GREEN); END_TYPE In this example, the value of a variable of type ENUM_COLORS is YELLOW, RED, or GREEN. Any other value is an error. The default initial value is YELLOW. The order for comparison increases from left to right. Example PROGRAM ST_Enumerations VAR MY_COLORS : ENUM_COLORS := GREEN; END_VAR if (MY_COLORS = GREEN)then MY_COLORS := RED; elsif (MY_COLORS = RED)then MY_COLORS := YELLOW; elsif (MY_COLORS = YELLOW)then MY_COLORS :=GREEN; end_if; (* The following statement causes an error *) (* MY_COLORS := 6; *) END_PROGRAM TriStation 1131 Developer’s Guide, 4.14.0 Structured Text Development 159 Defining an Array Data Type An array is a group of data objects with identical attributes, which is sometimes referred to as multi-element variables. • Arrays can have one or two levels, and be up to 32 KB maximum. • The maximum number of array elements is 256,000. • An array index must be in the range of -2,147,483,648 to +2,147,483,647. Note Once an array has been successfully compiled, you can assign it as a data type for local variables. See Declaring Variables on page 189 for more information. Syntax Example TYPE ARRAY_DINTS : ARRAY[1..6,1..20] OF DINT; END_TYPE Example For each array, the default initial value is the one defined for the array type. In this example, array type A has 10 elements of type INT. TYPE A: ARRAY [0 .. 9] OF INT ; END_TYPE Example In this example, a variable declaration specifies a variable V of type A. VAR V : A ; END_VAR This means the array elements are referenced by the expressions: V[0], V[1], . . , V[9] The default initial values are 0 (zero). Example An index can be an expression of type ANY_INT, for example, V [I + 1]. For an array with more than one dimension, the sub-range is replaced with a comma-separated list of sub-ranges, and the array index is replaced with a comma-separated list of array indexes. TriStation 1131 Developer’s Guide, 4.14.0 160 Chapter 2 Application Development Defining a Structured Data Type A structured data type is derived by defining a structure from existing data types by using elements of other specified types, which are accessed by their specified names. A structure can have a maximum of 400 elements. Note Once structure has been successfully compiled, you can assign it as a data type for local variables. See Declaring Variables on page 189 for more information. Syntax Example TYPE STRUCT_SENSOR : STRUCT INPUT:DINT; STATUS:BOOL; HIGH_LIMIT:REAL; ALARM_COUNT:INT; END_STRUCT; END_TYPE Each structured declaration consists of an element name followed by a colon, followed by a type specification. The default initial value of each structured element is the one defined for the structured type. In this example, the structured type called STRUCT_SENSOR has four structure elements: element INPUT of type DINT, element STATUS of type BOOL, element HIGH_LIMIT of type REAL, and element ALARM_COUNT of type INT. If a variable declaration specifies a variable V of type STRUCT_SENSOR (VAR V : STRUCT_SENSOR ; END_VAR), then the four structure elements are referenced by the expressions V. INPUT, V.STATUS, and so on. The default initial values are 0, False (0), 0.0, and 0. Declaring a VAR CONSTANT A VAR CONSTANT is a named constant, which is appropriate for safety applications because the value cannot be changed in a program. Syntax Example VAR CONSTANT StartUp_Speed: REAL : 12.3; Gear_Ratio:INT : 12; END_VAR Program Example PROGRAM ST_Constants VAR CONSTANT MILLISECS_IN_SEC : DINT := 1000; END_VAR VAR TIMER_MILLISECS, TIMER_SECS : DINT; GET_CALENDAR : TR_CALENDAR; TriStation 1131 Developer’s Guide, 4.14.0 Structured Text Development 161 END_VAR GET_CALENDAR(CI := TRUE); TIMER_SECS := GET_CALENDAR.SECOND; TIMER_MILLISECS := TIMER_SECS * MILLISECS_IN_SEC; (* The following statement causes an error because MILLISECS_IN_SEC *is a VAR CONSTANT*) (* MILLISECS_IN_SEC := 999; *) END_PROGRAM Declaring a VAR_TEMP A VAR_TEMP is a variable which is appropriate for safety applications because the variables are placed in a temporary memory area (not local memory) which is cleared when the program, function, or function block terminates. A VAR_TEMP variable provides no persistence. During each scan, it is automatically initialized to zero at the start of the program, function, or function block. Syntax Example VAR_TEMP RESULT : REAL; END_VAR; Function Block Example FUNCTION_BLOCK ST_VarTemp VAR_TEMP (* These 4 bytes will not be counted as LOCAL variables *) TEMP_SUM : REAL; IS_ROUNDUP : BOOL; END_VAR VAR_INPUT INP_1, INP_2, INP_3: REAL ; FORCE_ROUNDUP: BOOL ; END_VAR VAR_OUTPUT OUT_SUM : DINT ; OUT_BOOL : BOOL ; END_VAR VAR LOC_ROUNDUP : BOOL := FALSE; END_VAR TEMP_SUM := INP_1 + INP_2 + INP_3; IS_ROUNDUP := (LOC_ROUNDUP OR FORCE_ROUNDUP); if (IS_ROUNDUP) then TriStation 1131 Developer’s Guide, 4.14.0 162 Chapter 2 Application Development TEMP_SUM := CEIL(TEMP_SUM); LOC_ROUNDUP := FALSE; else TEMP_SUM := FLOOR(TEMP_SUM); LOC_ROUNDUP := TRUE; end_if; OUT_SUM := REAL_TO_DINT(TEMP_SUM); OUT_BOOL := IS_ROUNDUP; END_FUNCTION_BLOCK Declaring a VAR_EXTERNAL A VAR_EXTERNAL (also known as a global variable) allows access to tagnames (also known as tagname declarations in TriStation 1131). It is used for all program inputs and outputs. Syntax Example VAR_EXTERNAL TagName_1, Tagname_5, Tagname_9 : BOOL; END_VAR Program Example PROGRAM ST_VarExternal VAR_EXTERNAL TagName_1, Tagname_5, Tagname_9 : BOOL; END_VAR if (Tagname_1) then Tagname_1 := FALSE; else Tagname_1 := TRUE; end_if; if (Tagname_5) then Tagname_5 := FALSE; else Tagname_5 := TRUE; end_if; if (Tagname_9) then Tagname_9 := FALSE; else Tagname_9 := TRUE; end_if; END_PROGRAM TriStation 1131 Developer’s Guide, 4.14.0 Structured Text Development 163 Declaring Local Variables in ST A local variable is declared within function blocks using the VAR..END_VAR construct. Local variables in a program or function block are initialized with initial values (the default is zero) at startup. Function block instances are actually local variables and are declared as such. Syntax Example VAR UpCount : INT:= 100; (* Declares initial value to be 100 *) Reset : BOOL; (* Declares Boolean variable Reset *) UpCounter : CTU; (* Declares instance of CTU function block*) END_VAR Declaring Input and Output Variables in ST Function block input and output variables are declared using the VAR_INPUT ... END_VAR and VAR_OUTPUT ... END_VAR constructs. All input variables must be declared before any output variables can be declared. Note The VAR_INPUT ... END_VAR and VAR_OUTPUT ... END_VAR constructs cannot be used in programs. Programs must use VAR_EXTERNAL for input and output variables. Function Block Example FUNCTION_BLOCK AVERAGE (* Variable Declarations *) VAR_INPUT RESET : BOOL ; (* 1 = reset, 0 = calculate *) CURRENT_VALUE : DINT ;(* Current Value from UPDOWN *) END_VAR VAR_OUTPUT STATUS : BOOL ; (* State => 1 = resetting, 0 = calculating *) XOUT : DINT ; (* Avg Output = Current_Value Divided by MAX_COUNT *) END_VAR (* Your execution statements here *) END_FUNCTION_BLOCK TriStation 1131 Developer’s Guide, 4.14.0 164 Chapter 2 Application Development Using For Loop and Exit Statements The ForLoop and Exit statements allow a set of statements to be repeated depending on the value of an iteration variable. Program Example PROGRAM ST_ForLoop VAR MY_ARRAY : ARRAY_DINTS; COUNT : DINT; IDX_1, IDX_2 : INT; END_VAR for IDX_1 := 1 to 6 do for IDX_2 := 1 to 20 do MY_ARRAY[IDX_1,IDX_2] := COUNT; (* This statement causes an error because IDX_1 is being used * as the counter for the ForLoop structure *) (* IDX_1 := 20; *) end_for; if (COUNT = 100) then exit; end_if; end_for; COUNT := COUNT + 1; END_PROGRAM TriStation 1131 Developer’s Guide, 4.14.0 Structured Text Development 165 Using a CASE Statement The CASE statement allows a selected statement to be executed depending on the value of an expression that returns an integer result. Only numerical values can be used for the reference items in the CASE statement. If variables are used, TriStation 1131 rejects the code. Allows up to 5,000 selection statements. Program Example PROGRAM ST_Case VAR SETTING : DINT := 0; SPEED :REAL := 0.0; END_VAR if (SETTING > 10) then SETTING := 0; end_if; SETTING := SETTING + 1; (*Select a SPEED based on the value of SETTING *) case SETTING of 1: SPEED := 5.0; 2: SPEED := 7.5; 3,4,5:SPEED := 12.0; 6: SPEED := 15.0; 7,8:SPEED := 18.0; 9: SPEED := 21.0; 10:SPEED := 25.0; else SPEED := 0.0; end_case; END_PROGRAM TriStation 1131 Developer’s Guide, 4.14.0 166 Chapter 2 Application Development VAR_IN_OUT Function Parameters The VAR_IN_OUT function parameters allow more than one input and more than one output in a function block. CAUTION You should not use the VAR_IN_OUT variable in a safety application. Safety standards (such as IEC 61508) recommend limiting the use of pointers in safety applications; VAR_IN_OUT is used as a pointer in TriStation 1131. To automatically check for the use of VAR_IN_OUT in your safety application, set the Application Type to Safety for the programs included in the application (for more information, see Application Type on page 662). Syntax Example VAR_IN_OUT INOUT_1, INOUT_2, INOUT_3 : DINT ; END_VAR Function Example FUNCTION ST_VarInOut : BOOL VAR_IN_OUT INOUT_1, INOUT_2, INOUT_3 : DINT ; END_VAR if (INOUT_1 > 64000) then INOUT_1 := 0; end_if; INOUT_1 := INOUT_1 + 1; if (INOUT_2 > 64000) then INOUT_2 := 0; end_if; INOUT_2 := INOUT_2 + 2; if (INOUT_3 > 64000) then INOUT_3 := 0; end_if; INOUT_3 := INOUT_3 + 3; ST_VarInOut := TRUE; END_FUNCTION TriStation 1131 Developer’s Guide, 4.14.0 Cause Effect Matrix Development 167 Cause Effect Matrix Development This section explains how to use the Cause Effect Matrix (CEM) language to create a program based on a cause and effect matrix. Topics include: • CEMPLE Overview on page 168 • Using the CEM Editor on page 170 • Setting up a CEM Program on page 173 • Using User-Defined Functions and Application-Defined States on page 176 • Specifying Local Variables, Tagnames, and Constants in a CEM Program on page 178 • Working with Cells, Rows, and Columns in a CEM Program on page 179 • Editing the Title Block on page 187 • Managing Views on page 188 TriStation 1131 Developer’s Guide, 4.14.0 168 Chapter 2 Application Development CEMPLE Overview CEMPLE is an optional TriStation 1131 language editor that automates the process of creating a program based on a cause and effect matrix. Cause and effect matrix is a methodology that is commonly used in the process control industry to define alarms, emergency shutdown strategies, and mitigation actions. A matrix created in CEM language can be as basic or complex as your situation requires. In a basic matrix, causes are identified as True or False inputs related to one or more effects through the intersections between them. The state of a cause (True or False) determines the state of the related effect. If more than one cause is related to an effect, the state of the effect is based on how the matrix is evaluated. You can specify the matrix evaluation as a de-energize-to-trip (fail-safe) or energize-to-trip system. In a typical de-energize-to-trip system, if one of the inputs changes to False, the related outputs also change to False. In an energize-to-trip system, the reverse is true; if one of the inputs changes to True, the related outputs also change to True. For more complex processes, CEM language allows you to add functions or function blocks to causes, intersections, and effects. This feature can be used for many purposes; for example, to accept non-Boolean input and convert to Boolean output, to set timers before evaluating the input, and to pass additional input variables to output variables. CEM language includes these features: • Ability to specify up to 99 causes, 99 effects, and 1,000 intersections • Ability to invoke functions and function blocks to evaluate cause, intersection, and effect states • Choice of de-energize-to-trip or energize-to-trip matrix evaluation • Automatic conversion of matrix to Function Block Diagram language • Customized view monitoring of active causes, intersections, and effects • Multiple levels of undo and redo editing Matrix Planning Planning includes determining the causes (problems) to be monitored, and determining how the matrix is to be evaluated. Restrictions and Limitations • No more than 99 causes, 99 effects, and 1,000 intersections. • Variables with a variable type of In/Out (VAR_IN_OUT) are not allowed in CEM programs, function blocks that are invoked by matrix programs, or any safety program or function block. Matrix Evaluation Options When planning a matrix, you must determine how the matrix is evaluated when it includes multiple causes and effects. If the matrix is based on an energize-to-trip system, such as a fire suppression system, an OR evaluation is typically used because the normal state of inputs is TriStation 1131 Developer’s Guide, 4.14.0 Cause Effect Matrix Development 169 False. If one of the inputs changes to True, the related outputs also change to True. The default setting is OR. If the matrix is based on a de-energize-to-trip (fail-safe) system, an AND evaluation is typically used because the normal state of inputs is True. If one of the inputs changes to False, the related outputs also change to False. This is why it is typically used with systems that are designed to be fail-safe. How a Matrix is Evaluated When a matrix is executed, the states of causes, effects, and intersections are evaluated in a specific order. The states of causes, intersections, and effects are saved in internal variables. An internal Move function moves the cause state to the intersection state, and then to the effect state. The order of evaluation is shown and described in this figure. 3. For each column from the left to the right, an effect state is determined based on the intersection state and the function associated with the effect. 2. For each intersection from the bottom to the top, a state is determined based on the cause state and intersection function. For typical AND evaluations, all cause states must be True for the intersection state to be True and one False state makes the output False. For typical OR evaluations, all cause states must be False for the intersection state to be False and one True state makes the output True. 1. For each cause from the top row to the bottom, a state is determined based on the inputs and function associated with the cause. Figure 10 CEMPLE Matrix Evaluation Steps TriStation 1131 Developer’s Guide, 4.14.0 170 Chapter 2 Application Development Using the CEM Editor The CEM editor allows you to create a TriStation 1131 program based on a cause and effect matrix. The editor includes the following areas: • Matrix: Identifies causes, effects, and the intersections between them. Can also include inputs, outputs, functions, and function blocks related to causes, effects, and intersections. • FBD Network: Displays the Function Block Diagram (FBD) related to the cause, effect, or intersection that you select in a matrix. It also allows you to specify properties and to invert the values of variables. • Variable Detail Table: Displays the inputs and outputs of an FBD network that are generated when a cause, effect, or intersection is selected. It also allows you to specify variable type and data type. This figure depicts the areas in the CEM Editor. Matrix rows and columns Variable Detail Table Figure 11 Note FBD Network CEM Editor Elements For information on using keyboard and mouse shortcuts in the CEM editor, see Appendix G, Keyboard Shortcuts. TriStation 1131 Developer’s Guide, 4.14.0 Cause Effect Matrix Development 171 Matrix The matrix area of the CEM editor includes the rows, columns, and intersections of a matrix. In a basic matrix that does not use functions, causes can be directly related to effects through intersections. In a more complex matrix, such as this figure, functions can be included for causes, effects, and intersections. When functions are included, the inputs and outputs of those functions can be specified in the matrix. Effect items Intersections Cause items Figure 12 CEMPLE Matrix Elements FBD Network The FBD Network area of the CEM editor displays the Function Block Diagram (FBD) related to the cause, effect, or intersection that you select in the matrix. The FBD network uses internal Boolean variables to save and move results to associated cells so that causes and effects can be evaluated. When you create a cause, intersection, or effect, an internal variable is automatically created for each. The CEM editor uses internal variables to store and move results between cells. Although you cannot directly access the internal variables, you can create variables and copy the values to those variables. You can also specify properties and invert values of variables. If you select a cause, effect, or intersection that does not contain a function, or if you make multiple selections, the FBD network cannot display appropriate information. TriStation 1131 Developer’s Guide, 4.14.0 172 Chapter 2 Application Development FBD Network area Figure 13 FBD Network Area in CEM Editor Variable Detail Table The Variable Detail Table area of the CEM editor displays the inputs and outputs of an FBD Network that are generated when a cause, effect, or intersection is selected. This figure shows the names, variable types, and data types related to the function block. Figure 14 Variable Detail Table in CEM Editor TriStation 1131 Developer’s Guide, 4.14.0 Cause Effect Matrix Development 173 Setting up a CEM Program The following sections describe how to set default options that apply to CEM programs. Topics include: • Specifying CEM Editor Options on page 173 • Specifying CEM Element Options on page 174 • Specifying Monitor Colors and Names on page 175 Specifying CEM Editor Options This procedure explains how to set the options used as initial settings for all the CEM (cause and effect matrix) programs in a project. After a program is created, you can modify these settings on a program-by-program basis. Procedure 1 On the Tools menu, click TriStation 1131 Options, and then click the CEM Editor tab. 2 Specify these properties on the CEM Editor tab. Property Action Cause Header Functions On by Default Select the check box to have input and function columns added. The default is cleared. Effect Header Functions On by Default Select the check box to have output and function columns added. The default is cleared. Intersection Functions On by Default Select the check box to have function columns added. The default is cleared. TriStation 1131 Developer’s Guide, 4.14.0 174 Chapter 2 Application Development 3 Property Action Default Number of Cause Rows Enter the number of rows to include in a new matrix. The default is 22. Default Number of Effect Columns Enter the number of columns to include in a new matrix. The default is 25. Click OK to save the settings. Specifying CEM Element Options This procedure explains how to specify whether functions are used in a specific CEM program, and how the matrix is evaluated. Procedure 1 Expand the Application tree, double-click a program, click the Document menu, and then click Options. 2 Specify these properties in the CEM Element Options dialog box. Property Action Enable Cause Header Functions Select the check box to add an input and function column to the cause header. The default is selected. Enable Effect Header Functions Select the check box to add an output and function column to the effect header. The default is selected. Enable Intersection Functions Select the check box to add a function column to the intersection. The default is selected. TriStation 1131 Developer’s Guide, 4.14.0 Cause Effect Matrix Development 3 Property Action Enable Floating Text in Intersection Cells Select the check box to allow the name of the function or function block to be displayed in a neighboring cell if that cell is empty. This is useful when the name of the function or function block is long. The default is cleared. Evaluation Options Specify how the matrix is to be evaluated when it includes multiple intersections between a cause and effect. The default is OR. 175 Click OK to save the settings. Specifying Monitor Colors and Names This procedure explains how to specify the colors that are displayed for True and False BOOL values when an application is monitored on the Controller and Emulator Panels. Procedure 1 On the Project menu, click Project Options, and then click the Monitor Colors tab. 2 Under CEM Editor Options, select the color for True and False for cause, effect, and intersection cells in a CEM (cause and effect matrix). The default for True is red; False is white. 3 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 176 Chapter 2 Application Development Using User-Defined Functions and Application-Defined States This section describes how user-defined functions and application-defined states can be used in a CEM program. User-Defined Functions User-defined functions must be enabled before they can be used in a CEM program. (Invensyssupplied functions and function blocks do not have to be enabled.) When you enable a function, it is validated to ensure it can be used in that part of the matrix. For example, a function used in an intersection must have a Boolean primary input and Boolean primary output. If not enabled, the function is not available for selection. Application States User-defined functions can include a variable that stores application states and that is evaluated in the same way as the cause, intersection, and effect internal variables. This means you can include application information that is evaluated with an AND or OR operation when the matrix is run. Application state inputs and outputs must be a DWORD data type, which is a 32-bit string. This figure shows an example of using a variable to store the application state. For the cause function block, the second output is the application state. For the intersection function block, the second input and output of the function is the application state. For the effect function block, the second input and output of the function is the application state. Figure 15 Using a Variable to Store Application State TriStation 1131 Developer’s Guide, 4.14.0 Cause Effect Matrix Development 177 Enabling User-Defined Functions and Application-Defined States This procedure explains how to enable user-defined functions and application-defined states for a specific matrix. If a user-defined function is not enabled, it cannot be used in a matrix. Procedure 1 Expand the Application tree, right-click the user-defined function, click Properties, and then click the Attributes tab. 2 Specify these properties on the Attributes tab. Property Action Application Type Click either Control or Safety and Control. Supports Use in Cause Rows with... Inputs Select the check box to enable the function for use in cause rows, and then select the required number of inputs. The default is cleared. Supports Use in Effect Columns With... Outputs Select the check box to enable the function for use in effect columns, and then select the required number of outputs. The default is cleared. Supports Use in Intersections Select the check box to enable the function for use in intersections. The default is cleared. Supports Application Defined States Select the check box to enable the function to add a variable to store the application defined state. The default is cleared. 3 Click OK to save the settings. 4 In the Application tree, double-click the function to open it on a logic sheet. 5 On the Document menu, click Compile. The compile process determines whether the function can be used. TriStation 1131 Developer’s Guide, 4.14.0 178 Chapter 2 Application Development Specifying Local Variables, Tagnames, and Constants in a CEM Program This procedure explains how to specify local variables, tagnames, and constants in a CEM program. When functions are used with causes or effects, the inputs and outputs to the functions must be specified as variables or constants. In/Out variables (VAR_IN_OUT) are not allowed in CEM programs, function blocks that are invoked by CEM programs, or any safety program or function block. Procedure 1 Expand the Application tree, expand User Documents, and double-click a CEM program. 2 Select or type the name in the Input or Output columns, or in the Var/Const column in the Variable Detail Table. Specifying Properties in the Variable Detail Table This procedure explains how to modify properties in the Variable Detail Table, which is located in the lower left part of the CEM program. Procedure 1 Expand the Application tree, and open a CEM program. 2 Specify these properties in the Variable Detail Table. Property Action Var/Const Enter a variable or constant name. Var Type Select Local or Tagname. Data Type Select a data type. Description Enter a description for the variable or constant. If the changes are valid, the declaration is changed. If not, a message displays explaining why the declaration was not changed. TriStation 1131 Developer’s Guide, 4.14.0 Cause Effect Matrix Development 179 Working with Cells, Rows, and Columns in a CEM Program The following sections describe how to work with the cells, rows, and columns that make up a CEM program matrix. Topics include: • Selecting and Editing Cells in a CEM Program on page 179 • Displaying and Sizing Cells from the Matrix on page 180 • Inserting and Deleting Rows or Columns on page 181 • Sizing and Hiding Columns on page 184 • Sizing and Hiding Rows on page 185 • Sizing and Hiding the Comment Column on page 186 Selecting and Editing Cells in a CEM Program This table and figure explain how to select one or more cells in a CEM program. To ... Do This ... Select a single cell Click anywhere in the cell. Select contiguous (adjacent) cells Click the first cell, hold down the shift key, and click the last cell in the area. Select discontiguous (non-adjacent) cells Click a cell, hold down the Ctrl key, and click the rows or column. Click here to select all effects Click here to select all causes Click here to select all intersections Click here to select one effect Click here to select all intersections in a column Click here to select one cause Click here to select all intersections in a row Figure 16 Selecting CEMPLE Matrix Cells TriStation 1131 Developer’s Guide, 4.14.0 180 Chapter 2 Application Development This table explains how to edit cells in a matrix. To ... Do This ... Enter edit mode Click directly over the text in an editable cell. Complete a cell entry Press the tab key or Enter to complete a cell entry and move the cursor to the next cell to the right. Move to the next cell Press the tab key or Enter to move the cursor to the next cell to the right. Delete the contents of a cell or group of cells Select a cell or group of cells (but do not place in edit mode) and press the delete key. Displaying and Sizing Cells from the Matrix This table describes how to change the display and size of cells in a matrix. You can also make changes by using commands on the View menu. These actions do not affect the matrix evaluation. To drag or double-click a cell boundary, you must use the double-arrow cursor, which is only active in the gray cells of a matrix. To ... Do This ... Change width of column Drag the column boundary left or right. Restore size of column Drag the column boundary to the left so that the column is almost hidden, then release the button. Change height of row Drag the row boundary up or down. Restore default size of row Drag the row boundary upward until the row is almost hidden, then release the button. Hide a column Drag the column boundary to the left until it meets the nearest boundary. For an effect column, double-click the thickened column boundary. Unhide a column For a cause column, double-click the boundary between the currently displayed columns and the hidden column. Hide a row Drag the row boundary upward until it meets the nearest boundary. Unhide a row Double-click the thickened row boundary. TriStation 1131 Developer’s Guide, 4.14.0 Cause Effect Matrix Development 181 Inserting and Deleting Rows or Columns The following procedures explain how to insert or delete rows or columns in a CEM program. CAUTION Doing either of the following will cause the function block instance(s) in the remaining rows or columns to be renamed: • Adding or deleting a row above one or more rows containing a function block • Adding or deleting a column to the left of one or more columns containing a function block . When a Download Changes operation is then performed, the renamed function block output(s) will be re-initialized (set to zero). Inserting Columns This procedure explains how to insert columns in a CEM program. Procedure 1 Expand the Application tree, open a CEM program, and do either of these: • Click the Insert Columns button toolbar on the • Click the Edit menu, and then click Insert Columns 2 Enter the number of columns to insert. 3 Select the column and click Before or After to specify where the column is to be inserted. 4 If you do not want the column to be displayed, clear the Make visible on all managed views check box. 5 Click OK. The new column is inserted in the location you specified. TriStation 1131 Developer’s Guide, 4.14.0 182 Chapter 2 Application Development Inserting Rows This procedure explains how to insert rows in a CEM program. Procedure 1 Expand the Application tree, open a CEM program, and do either of these: • Click the Insert Rows button on the toolbar • Click the Edit menu, and then click Insert Rows 2 Enter the number of rows to insert. 3 Select the row and click Before or After to specify where the row is to be inserted. 4 If you do not want the column to be displayed, clear the Make visible on all managed views check box. 5 Click OK. The new row is inserted in the location you specified. Deleting Columns This procedure explains how to delete columns in a CEM program. Column numbers are identified at the top of the column as shown in this figure. Column numbers are located here. Figure 17 CEMPLE Matrix Column Numbers Procedure 1 2 Expand the Application tree, open a CEM program, and do either of these: • Click the Delete Columns button toolbar on the • Click the Edit menu, and then click Delete Columns Enter the number of columns to delete and the starting column number. The selected column (E01 in this example), and the x columns to the right of the selected column will be deleted, where x is the number of columns to delete. 3 Confirm your selections, and then click OK. The selected columns are deleted. TriStation 1131 Developer’s Guide, 4.14.0 Cause Effect Matrix Development 183 Deleting Rows This procedure explains how to delete rows in a CEM program. Row numbers are identified to the left of the row as shown in this figure. Row numbers are located here. Figure 18 CEMPLE Matrix Row Numbers Procedure 1 2 Expand the Application tree, open a CEM program, and do either of these: • Click the Delete Rows button on the toolbar • Click the Edit menu, and then click Delete Rows Enter the number of rows to delete and the starting row number. The selected row (C01 in this example), and the x columns below the selected row will be deleted, where x is the number of rows to delete. 3 Confirm your selections, and then click OK. The selected rows are deleted. TriStation 1131 Developer’s Guide, 4.14.0 184 Chapter 2 Application Development Sizing and Hiding Columns This procedure explains how to size and hide columns in a CEM program. Procedure 1 2 3 Expand the Application tree, open a CEM program, and do either of these: • Click the Size/Hide Columns button on the toolbar • Click the View menu, and then click Size/Hide, and then Columns Specify these properties in the Size/Hide Columns dialog box. Property Action Number of columns to adjust Enter the number of columns you want to resize. Adjust starting from column Select the starting column. New size Select and then enter the new size for the column. Size to Content Select to automatically size the column to its content. Restore Default Sizes Select to restore the column to the default size. Hide or Unhide Select Hide or Unhide. If hidden, the column is not displayed, but it is used in the matrix evaluation. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Cause Effect Matrix Development 185 Sizing and Hiding Rows This procedure explains how to size and hide rows in a CEM program. Procedure 1 2 3 Expand the Application tree, open a CEM program, and do either of these: • Click the Size/Hide Rows button on the toolbar • Click the View menu, and then click Size/Hide, and then Rows Specify these properties in the Size/Hide Rows dialog box. Property Action Number of rows to adjust Enter the number of rows you want to resize. Adjust starting from row Select the starting row. New size Select and then enter the new size for the row. Restore Default Sizes Select to restore the row to the default size. Hide or Unhide Select Hide or Unhide. If hidden, the row is not displayed, but it is used in the matrix evaluation. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 186 Chapter 2 Application Development Sizing and Hiding the Comment Column This procedure explains how to size and hide the comment column in a CEM program. Procedure 1 Expand the Application tree and open a CEM program. From the View menu, click Size/Hide, and then Comment Column. 2 Specify one of these properties in the Size/Hide Comment Column dialog box. 3 Property Action Restore Default Size Select to restore the comment column to its default size. New size Select and then enter the new size for the column. Hide or Unhide Select Hide or Unhide. If hidden, the column is not displayed. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Cause Effect Matrix Development 187 Editing the Title Block This procedure explains how to edit information in the title block, which is included when the CEM program is printed. Procedure 1 Expand the Application tree, open a CEM program, click the Sheets menu, and then click Edit Sheet Title. 2 Enter text to describe the matrix. 3 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 188 Chapter 2 Application Development Managing Views This procedure explains how to save, load, and remove views of CEM programs. A view is a display of a selected portion of the matrix. You can create a view by hiding or showing columns and rows on the matrix, either by using menu commands or by dragging columns and rows on the matrix. Saving the view allows you to load it at anytime. Procedure 1 Expand the Application tree and open a CEM program. 2 Change the view by showing or hiding columns and rows. Use commands on the View menu or drag columns and rows on the matrix. 3 On the View menu, click Manage Views. 4 Perform one or more of these actions in the View Manager dialog box. Command Action Load Select a view and click Load to have it displayed. Save Click to save the currently displayed view. Remove Select a view and click Remove to delete the view from the list. Restore All Defaults Click to restore the current view to show all causes and effects. Close Click to save your changes and close the View Manager dialog box. Cancel Click to close the View Manager dialog box without saving your changes. TriStation 1131 Developer’s Guide, 4.14.0 Variables and Constants 189 Variables and Constants This section explains how to create variables and constants in FBD, LD, and CEM languages. For information on tagnames (global variables), see Tagnames on page 198. The maximum number of user-defined tagnames and variables in a program is 2,000. Note Using the Print All command, you can print a report listing all the variables currently defined in your project (Program Variable Listing). See Printing Project Documents on page 109. Topics include: • Declaring Variables on page 189 • Specifying Variable Properties on page 190 • Specifying Variable Annotation Properties on page 192 • Naming Multiple Variables on page 193 • Changing Multiple Variables on page 194 • Viewing the Number of Variables and Tagnames in a Program on page 195 • Creating Constants on page 196 • Specifying Constant Annotation Properties on page 197 Declaring Variables This procedure explains how to declare input, output, in/out, and local variables in FBD, LD, and CEM languages. Variables store values and must be declared in order to be used in a program or function. Note You can use arrays, structures, and enumerations that you have defined in structured text by declaring them as user-defined data types in local variables. The compiler will automatically check your function blocks to determine if user-defined data types were correctly used; errors will result in “mismatched data type” warnings at compile time. Procedure 1 Create a variable by doing either of the following: • On the toolbar, click the icon for the variable, and then click on the logic sheet (FBD or LD only). • On the program or function Declarations tree, right-click the folder for the type of variable to be declared, and click New Declaration. TriStation 1131 Developer’s Guide, 4.14.0 190 Chapter 2 Application Development The Item Properties dialog box for the variable appears. 2 Specify these properties on the Declaration tab. Property Action Name Enter a name for the variable. Use only alphanumeric characters and underscores. No symbols or spaces are allowed. Data Type Select a data type. Required. If the variable is dragged to a function terminal, the data type is automatically set to the correct type for the function. User-defined data types—such as arrays, structures, and enumerations that you have defined in structured text—can also be selected as data types in local variable declarations. However, you must successfully compile your user-defined data type before it will appear in the Data Type list. Initial Value Specify a value to be used on the first scan. Must agree with the Data Type. Not applicable if you have selected a user-defined data type. Description Enter a description for the variable. (Optional) Var Type Select the type of variable. Required. • For programs, can be Local only. • For functions, can be Input, Output, In/Out, or Local. Specifying Variable Properties This procedure explains how to specify properties for variables. Properties affect the selected occurrence of the variable. For example, when you add an annotation to a variable, it affects only the selected variable. Procedure 1 Expand the Application tree and then open a program or function. 2 On the logic sheet, double-click the icon that represents the variable. 3 Specify these properties on the Variable tab. TriStation 1131 Developer’s Guide, 4.14.0 Variables and Constants Property Action Variable Name To change the selected variable to a different variable, select the variable name and click Apply. 191 To create a new variable, enter a new name, and click Apply. To change the name of all the variables with this name, click Declaration and change the name of the variable. Data Type Displays the data type that was set on the Declaration tab. If the variable has not been declared, the Data Type is undefined. 4 Width Click + or – to increase or decrease the width of the variable icon on the logic sheet. Annotate Select the check box to add an annotation to the variable. The default is cleared. See Specifying Variable Annotation Properties on page 192 for more information about annotations. Declarations Command Click to view the Declaration tab for the variable. See Declaring Variables on page 189 for more information. Auto Name Command Click to view the Automatic Naming dialog box. See Naming Multiple Variables on page 193 for more information. Click Apply to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 192 Chapter 2 Application Development Specifying Variable Annotation Properties This procedure explains how to specify text and macros to be included with an annotation. Annotations are available only in FBD and LD programs. Procedure 1 Expand the Application tree and then open a program or function. 2 On the logic sheet, double-click the icon that represents the variable. 3 On the Variable tab, select the Annotate check box and then click the Annotation tab. 4 Specify these properties on the Annotation tab. Property Action Annotation Text Enter text or copy macros to be used in the annotation. To copy a macro, see Using Macros with Annotations and Comments on page 270. Include Monitor Value in Annotation Select this check box to display the value of the variable in the annotation when the element is run on the controller or Emulator. Available only in programs. Macros Command Click to display the list of macros that can be added. To copy a macro, click the macro and press Ctrl+C. Click OK to close the Edit Macro dialog box. To paste the macro in the Annotation tab, press Ctrl+V. 5 Close the Properties dialog box to save your changes to the Annotation tab. TriStation 1131 Developer’s Guide, 4.14.0 Variables and Constants 193 Naming Multiple Variables This procedure explains how to name multiple variables by specifying a format. Variables can be named by row, column, and selection order. The variables must exist before they can be named. Procedure 1 Expand the Application tree and open a program or function logic sheet. On the logic sheet, hold the Shift key. To have variables named based on the selection order, click them in the order in which you want them named. 2 On the Tools, menu, click Auto Name Selected Items. 3 Specify these properties in the Automatic Naming dialog box. Property Action Formatted Name Specify whether to use theater numbering, which uses letters, or normal numbering, which uses numbers. Start Value and Increment Enter the starting value for the first variable and the number to use when incrementing each successive variable. Name Order Select the order in which to name variables. • Rows—Names are applied vertically, from left to right. • Columns—Names are applied horizontally, from top to bottom. • Selection Order—Names are applied based on the order in which they were selected. 4 Click OK to apply the formatted name to the selected variables. TriStation 1131 Developer’s Guide, 4.14.0 194 Chapter 2 Application Development Changing Multiple Variables This procedure explains how to change size and annotation settings for multiple variables on a logic sheet. Note To quickly change just the names of variables on a logic sheet, you can also use the Find/Replace command. See Replace Command on page 801. Procedure 1 On a logic sheet, select the variables you want to change by pressing the Shift key while you click the variables. 2 Double-click one of the selected variables. The Item Properties dialog box appears. 3 Specify these properties on the Variable or Annotation tabs. Property Action Variable Name To change all the selected variables to the same variable name, select or enter the name. To undo this change, press Ctrl+Z. Width Click the + button to increase the width of the variable graphics. Click the – button to decrease the width of the variable graphics. Annotate To add the same annotation to each variable, select the Annotate check box, click the Annotation tab, and then enter or copy the text or macro. Auto Name Command To automatically name the selected variables based on a pattern, click and specify the pattern. See Naming Multiple Variables on page 193. 4 Close the Properties dialog box to save your changes to the Annotation tab. 5 If necessary, undo the changes you just made by pressing Ctrl+Z. Multiple levels of undo are available. TriStation 1131 Developer’s Guide, 4.14.0 Variables and Constants 195 Viewing the Number of Variables and Tagnames in a Program The maximum number of user-defined variables and tagnames in a program is 2,000 (not including undeclared tagnames). If you exceed this limit, you will be unable to build your application. You can view the number of user-defined variables and tagnames in each program when you compile your application. The number of each type of variable (including tagnames) and the total user-defined variable count are displayed in the Messages View during the compile process: Variable Type Name Input VAR_INPUT Output VAR_OUTPUT Input/Output VAR_IN_OUT Local VAR Global (also known as tagname) VAR_EXTERNAL Procedure 1 On the Project menu, click Compile All User Documents. The Messages View automatically opens and displays the status of the compile process, as shown below. Variable count for ST_VarTemp program Variable count for ST_VarExternal program 2 For each program, look for the following statement: Total Var count=x where x is the total number of user-defined variables and tagnames in the program. This number must be 2,000 or less. 3 If you have exceeded the limit in any of the programs included in your application, change your programming to reduce the number of variables and/or tagnames in the program before building the application. TriStation 1131 Developer’s Guide, 4.14.0 196 Chapter 2 Application Development Creating Constants This procedure explains how to create constants in FBD, LD, and CEM languages. A constant is a value that can be used in a program or function. Procedure 1 Expand the Application tree, and open a program or function. 2 On the toolbar, click 3 Specify these properties on the Constant tab. , and then click in the logic sheet. Property Action Value Enter the value for the constant. Data Type Select the data type; must be appropriate for the Value property. Width Click the + button to increase the width of the constant graphic. Click the – button to decrease the width of the constant graphic. 4 Annotate To add an annotation to the constant, select the Annotate check box, click the Annotation tab, and then enter or copy the text or macro. Auto Name Command To automatically name the selected constants based on a pattern, click and specify the pattern. See Naming Multiple Variables on page 193. Click the Apply to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Variables and Constants 197 Specifying Constant Annotation Properties This procedure explains how to specify text and macros to be included with a constant annotation. This can be used only in FBD and LD development. Procedure 1 On a logic sheet, double-click a constant. The Item Properties dialog box appears. 2 On the Constant tab, select the Annotate check box and then click the Annotation tab. 3 Specify these properties on the Annotation tab. Property Action Annotation Text Enter text or copy macros to be used in the annotation. Macros Command Click to copy a macro. See Using Macros with Annotations and Comments on page 270. TriStation 1131 Developer’s Guide, 4.14.0 198 Chapter 2 Application Development Tagnames Tagname is the term commonly used when referring to input points (sensors) and output points (final elements). In TriStation 1131, tagnames are references to physical tagnames (labels) on the connected field devices or to memory points which are locations in the controller memory. In IEC terminology, tagnames are called global variables. For Modbus or DDE communication, tagnames must be assigned an alias number that allows read or read/write access. An alias number is a five-digit or six-digit identifier which defines the data type and location of a point in the controller memory. In Tricon systems, aliases are within either the Legacy range or the Extended range, depending on the system version, and the type of communication modules that are installed. The Legacy and Extended alias ranges correspond to the size of the memory area available in the controller. The Extended alias range supports a larger memory area, and as such, an increased number of tagnames. Both the Legacy and Extended alias ranges allow for both fivedigit and six-digit aliases; however, the available alias ranges differ. For example, if you are assigning an alias for a BOOL Memory Read/Write point, you can assign an alias in any of the following ranges, depending on your controller’s system version and installed communication modules: Alias Type Legacy Range Extended Range 5-Digit Alias 02001–04000 n/a 6-Digit Alias 002001–004000 020001–024096 For more detailed information on the Legacy and Extended alias ranges, see Alias Number on page 657. This table lists the target system versions and communication modules that support Legacy and/or Extended alias ranges: Target System Version Supported Aliases Tricon 11.1 and earlier systems Five-digit or six-digit aliases within the Legacy range only Tricon 11.2 and later systems, with TCMs only (no UCMs or SMMs) Five-digit or six-digit aliases in both the Legacy and Extended ranges Tricon 11.2 and later systems, with UCMs, SMMs, and/or TCMs Five-digit or six-digit aliases within the Legacy range only For Peer-to-Peer, OPC, or TSAA applications, tagnames can be accessed by the tagname—an alias number is not needed. In Tricon 11.2 and later systems with TCMs installed, the maximum number of user-defined tagnames and variables in an application is approximately 29,000. Note To view the total number of tagnames in a program, compile the application and then look for the VAR_EXTERNAL count information in the Messages View. See Viewing the Number of Variables and Tagnames in a Program on page 195 for more information. TriStation 1131 Developer’s Guide, 4.14.0 Tagnames 199 Topics include: • Getting to Know the Tagname Editor on page 200 • Declaring Tagnames on page 203 • Assigning an Alias Number, Alias Type, and Physical Address on page 205 • Specifying the Engineering Unit Range for a DINT or REAL Point on page 211 • Scaling a REAL Point on page 212 • Specifying Display Options for a Tagname on page 213 • Specifying the Location of a Tagname on page 214 • Creating Multiple Tagnames on page 215 • Updating Multiple Tagnames on page 217 • Sorting, Filtering, and Grouping Tagnames on page 220 • Renaming Tagnames on page 224 • Deleting Tagnames on page 224 • Printing Tagnames on page 225 • Managing Undeclared and Unused Tagnames on page 226 Note This section describes how to define and manage tagnames using the Tagname Editor. If you prefer to use the Item Properties dialog box instead of the Tagname Editor, see Appendix E, Managing Tagnames Using Item Properties. TriStation 1131 Developer’s Guide, 4.14.0 200 Chapter 2 Application Development Getting to Know the Tagname Editor The Tagname Editor provides a consolidated view of all the tagnames in your application. It displays tagnames and their properties in a tabular format, which makes creating and managing tagnames easy and convenient. To view the Tagname Editor, do one of the following: • Click the Tagname tab that appears at the bottom of the Messages pane, below the program workspace. • On the View menu, select Message Panes, and then select Tagname. The Tagname Editor is divided into four major areas, as shown in this figure: Property Tabs Property Sheet Editor Tagnames Sheet Tagname Commands Group Figure 19 Tagname Editor Areas This table describes each of the areas in the Tagname Editor. Tagname Editor Area Description Tagnames Sheet Displays tagnames and their properties across rows and columns. Using this sheet, you can: • Create, edit, and delete tagnames, individually or several at one time. • Copy and paste tagname data across rows. • Group and sort tagnames by columns. • Filter tagnames by criteria that you specify. Property Tabs Each property tab allows you to manage a specific set of tagname properties. Or, click the All tab to view all available tagname properties on a single tab. Note: The IO Module tab is reserved for future use. TriStation 1131 Developer’s Guide, 4.14.0 Tagnames Tagname Editor Area Description Property Sheet Editor Provides an alternative method for defining tagname properties. You can view the properties grouped according to property tabs, or alphabetically. You can also search for specific properties. Tagname Commands Group Contains a group of buttons and check boxes that enable you to perform key tasks such as creating, filtering, and printing tagnames. 201 Docking and Resizing the Tagname Editor The Tagname Editor is a dockable window. This allows you to drag and drop it to specific areas within: • The Program Workspace • The Workspace Pane (comprising the Application, Controller, and Project tabs) • The TriStation 1131 main window When you dock the Tagname Editor, it is automatically resized to fit the area. The other windows in the area, if any, are also resized. When you drag the Tagname Editor towards any of these areas, a compass (comprising four arrows and a center) appears in the center of the area. A root compass (comprising four arrows) also appears over the four outer edges of the area, as shown in the following figure. To dock the Tagname Editor in the desired area, point to the arrow in the direction you want to dock, and then release the mouse button. Program Workspace Workspace Pane Root compass (top arrow) Compass (bottom arrow) TriStation 1131 Developer’s Guide, 4.14.0 202 Chapter 2 Application Development Note If the area to which you wish to dock the Tagname Editor is small, one or more arrows of the root compass do not appear. The Tagname Editor is also a floating window, which allows you to move it to any part of the TriStation 1131 window, without having to dock it. When you move the Tagname Editor, it is not resized. Table 28 Move, Resize, and Auto-Hide Features To... Do This... Move the Tagname Editor to a desired area of the TriStation 1131 interface (undock the Tagname Editor) Click the title bar of the window pane, and then drag it to the desired area. Do not point to any of the arrows of the compass or the root compass. Restore the Tagname Editor to its previous location Double-click the Tagname Editor window title bar. Resize the Tagname Editor Click and drag the edges of the Tagname Editor window to the desired size. Hide the Tagname Editor Click the Auto Hide button the Tagname Editor window. Display the Tagname Editor, after it has been hidden Move the mouse pointer over the Tagname tab. When the Tagname Editor appears, click the Auto Hide button again. Always display the Tagname Editor, even when you switch from TriStation 1131 to another application Undock the Tagname Editor, click the button in the Tagname Commands Group, and then click Bring to Topmost. To undo this setting, click the button again, and then click Reset. TriStation 1131 Developer’s Guide, 4.14.0 in the top right corner of Tagnames 203 Declaring Tagnames This procedure explains how to declare tagnames for points. Tagnames describe the type of point (input, output, or memory) and the properties associated with the point. You can declare tagnames before or after writing programs. Tagnames must be declared before downloading the application to the controller. Declared tagnames are added to the controller’s symbol table. For Trident and Tri-GP controllers, the maximum symbol table size is 1 MB. If the symbol table exceeds 1 MB, you may be unable to download the application to the controller via the Download All or Download Changes commands. There is no way to know if the symbol table exceeds the 1 MB limit until you attempt to download the application to the controller. If the download is rejected, the symbol table is too large. To reduce the size of the symbol table, Invensys recommends the following: • Reduce the number of characters in tagname descriptions. • Shorten the names of tagname groups (Group 1 and Group 2 properties). • Shorten the names of the Area, Equipment, and SIF properties on the tagname Location tab (see Specifying the Location of a Tagname on page 214). • Reduce the number of unique tagname groups (Group1 and Group2 properties). • Reduce the number of unique Area, Equipment, and SIF locations. Note Once you have downloaded your project to the controller, making changes to existing tagnames or adding new tagnames prior to the next download will cause the project’s minor version number to be increased by one. See Displaying Version Numbers of Projects and Documents on page 39 for more information about project version numbers. When you make changes to a tagname via the Item Properties dialog box, the changes are updated in the Tagname Editor as well. Similarly, when you edit a tagname in the Tagname Editor, the tagname’s Item Properties are automatically updated. For more information on creating or editing tagnames using the Item Properties dialog box, see Appendix E, Managing Tagnames Using Item Properties. Procedure 1 Open the Tagname Editor, and click the Add New Tagname button Commands Group. in the Tagname A new row appears, with a system-generated name for the tagname. Note The location of the new row depends on the sort order of columns in the Tagname Editor. If the columns are not sorted, the new row appears at the end of the list of existing tagnames. For information on sorting columns, see Sorting, Filtering, and Grouping Tagnames on page 220. TriStation 1131 Developer’s Guide, 4.14.0 204 Chapter 2 Application Development New tagname 2 To edit the name, double-click the Tagname box. The name must be 31 characters or less. Note 3 4 When a row is editable, an edit icon appears in the row header. Click each box to specify these properties on the Declaration tab. Property Action Data Type Select a data type. The default is BOOL. Group 1 and Group 2 Enter the names of the groups this tagname belongs to. Description Enter a description for the tagname. Initial Value Enter the value to be used for the tagname when the system starts up. Application Type Specify whether the tagname is to be used in a Safety or Control application. The default is Control. Shared Read Select the check box to allow a different Application Type to read the tagname. The default is cleared. Retentive Select the check box to have the value of the tagname retained if a power failure occurs. The default is cleared. Alarm Click the Settings button to configure an alarm for the tagname. For detailed instructions, see Alarms on page 229. To save your changes, click the next row, or click the Commit Change button Tagname Commands Group. in the To cancel your changes, right-click the row that you edited, and click Undo. After you define a tagname, you can easily move it from the Tagname Editor to the FBD Editor, the Controller Panel, or the Emulator Panel using a drag-and-drop operation. To do so, click the button next to the tagname, and then drag it towards the desired location. TriStation 1131 Developer’s Guide, 4.14.0 Tagnames 205 Assigning an Alias Number, Alias Type, and Physical Address This section includes procedures for assigning information to a tagname, including assigning an alias number and physical address to input or output points, and assigning an alias number and alias type to memory points. For input and output points, the I/O hardware configuration must be completed before a physical address or alias number can be assigned. For more information, see Configuring Tricon Hardware on page 358 or Configuring Trident and Tri-GP Hardware on page 455. Note Once you have downloaded your project to the controller, making one or more changes to existing tagnames prior to the next download will cause the project’s minor version number to be increased by one. See Displaying Version Numbers of Projects and Documents on page 39 for more information about project version numbers. Important Information About Alias Numbers Under certain circumstances, TriStation 1131 will assign zero (0) or a default (system-specified) alias number for a selected tagname: • If you select Default alias, but there are no available alias numbers in the range for the selected tagname type. • If you select Legacy User Alias or Extended User Alias (applicable only for Tricon projects), but do not enter an alias number, TriStation 1131 will automatically: — Assign 0 as the alias number for Trident or Tri-GP projects. — Assign a default alias number for Tricon projects. Note • For more information on the Tricon system versions that support Legacy and/or Extended aliases, see Tagnames on page 198. For Trident or Tri-GP projects, if you select No alias for an aliased memory point (Alias Type is Read Aliased or Read/Write Aliased), TriStation 1131 will automatically assign 0 as the alias number. Alias numbers allow a DCS or external applications to access a tagname’s value via the Modbus protocol. However, if a tagname has been assigned the alias number 0, its value will be inaccessible. You should verify that none of your tagnames have been assigned the alias number 0 before you build your application. To do so: 1 Open the Tagname Editor, and click the Point Assignment tab. 2 View the numbers in the Legacy User Alias and Extended User Alias columns to be sure none of the tagnames have 0 assigned as the alias number. 3 If you find any tagnames with an alias number of zero (0), follow the instructions in Updating Multiple Tagnames on page 217 to assign new alias numbers to those tagnames. TriStation 1131 Developer’s Guide, 4.14.0 206 Chapter 2 Application Development Procedure for Input and Output Points This procedure describes how to assign an alias number, alias type, and physical address for an input or output point. Procedure 1 Open the Tagname Editor. 2 Click the Point Assignment tab, and locate the required tagname. 3 Click the Point Type list, and then specify whether the point type is Input or Output. 4 To allow the point to be written to multiple times from programs in the application, click the Enable Multiple Writes box, and then select the check box. 5 Enter a physical address by doing either of these: • In the Location box, enter the number representing the Physical Address (for example: 01.06.05), then go to step 8. • Click the Browse button in the Location box to select an address from a list of related modules, then go to step 6. Note 6 If an address is already assigned to a tagname, you cannot assign it to another tagname. On the Browse Available Points dialog box, select the module, and then click the point to be assigned. Notes In the Browse Available Points dialog box, if you select the model 3807 BPAO module, you will see four output points and eight input points in the list of available points. The first four input points provide coil diagnostic voltage measurements across the load. However, the second four input points (points 5-8) are reserved for future use, and should not be assigned aliases. If you configure the unused points, the application will receive an input value of zero for those points. TriStation 1131 Developer’s Guide, 4.14.0 Tagnames 7 207 Click OK to return to the Point Assignment tab. The selected address is displayed in the Physical Address box. 8 Specify the alias number properties in the following boxes: Property Action Alias Number Selection For Tricon, this is disabled, as the default alias number is used. Legacy User Alias (for Trident and Tri-GP only) Specify an alias number within the range applicable to the target system version. For information on alias ranges, see Alias Number on page 657. For Trident and Tri-GP, the alias number can be user-specified (within the range), system-specified based on a default range, or not aliased. Enabled only if you selected Legacy User Alias in the Alias Number Selection list. See the note in Assigning Alias Numbers to Tagnames on page 274 for additional information. Note Under certain circumstances, TriStation 1131 will automatically assign 0 as the alias number. See Important Information About Alias Numbers on page 205 for detailed information. TriStation 1131 Developer’s Guide, 4.14.0 208 Chapter 2 Application Development 9 To assign the tagname to specific SOE blocks, click the Settings button in the SOE Blocks column. Note You can also assign SOE blocks to tagnames using the SOE Configuration screen. For more information, see Assigning Tagnames to SOE Blocks on page 296. If you have the SOE Configuration screen open while assigning SOE blocks for a new tagname in the Tagname Editor, you will be prompted to save the Implementation list. Click Yes to proceed. The SOE Blocks dialog box appears. 10 Select the block number check box. If the number is disabled, it means the block has not been defined, or the block has been defined as a Redundant block. You cannot manually assign tagnames to Redundant blocks. For information about defining SOE blocks, see Defining SOE Block Properties on page 291. 11 Continue to assign tagnames to blocks as needed. Note After assigning all the tagnames, save the project so the tagnames are available when specifying a trip variable. For more information, see Assigning Tagnames to SOE Blocks on page 296. 12 Click OK to return to the Point Assignment tab. 13 To save your changes, click the next row, or click the Commit Change button To cancel your changes, right-click the row that you edited, and click Undo. TriStation 1131 Developer’s Guide, 4.14.0 . Tagnames 209 Procedure for Memory Points This procedure describes how to assign an alias number, alias type, and physical address for a memory point. Procedure 1 Open the Tagname Editor. 2 Click the Point Assignment tab, and locate the required tagname. 3 Click each box to specify these properties. Property Action Point Type Make sure that the point type is Memory. Alias Type To allow a memory point to be accessed from a remote device, select Read or Read/Write. The default is Unaliased. Enable Multiple Writes Select the check box to allow the point to be written to multiple times from programs in the application. Alias Number Selection Enter the alias number assignment. The alias number can be user-specified (within the range), or system-specified based on a default range. The default is Default alias. See the note in Assigning Alias Numbers to Tagnames on page 274 for additional information. Legacy User Alias Specify an alias number within the five-digit range. For information on alias ranges, see Alias Number on page 657. Enabled only if you selected Legacy User Alias in the Alias Number Selection list. Note The six-digit equivalent of the Legacy alias is displayed in the Extended User Alias box, which is not editable. See Table 52: Legacy Range Alias Number Information on page 657 for the mapping between five-digit and six-digit aliases. TriStation 1131 Developer’s Guide, 4.14.0 210 Chapter 2 Application Development Property Action Extended User Alias Specify an alias number within the six-digit Extended range. Applies only to Tricon 11.2 and later systems with only TCMs installed (but not UCMs or SMMs). For information on alias ranges, see Alias Number on page 657. Enabled only if you selected Extended User Alias in the Alias Number Selection list. Note 4 You can also specify a six-digit alias number within the Legacy range. The five-digit equivalent is displayed in the Legacy User Alias box, which is not editable. See Table 52: Legacy Range Alias Number Information on page 657 for the mapping between five-digit and six-digit aliases. To save your changes, click the next row, or click the Commit Change button . To cancel your changes, right-click the row that you edited, and click Undo. WARNING If a memory variable’s Point Type, Alias Type, or Alias Number is changed, performing a Download Changes operation will re-initialize the variable to its configured initial value, or 0 if no initial value is defined. Invensys recommends using the Download All command if these types of changes are made. TriStation 1131 Developer’s Guide, 4.14.0 Tagnames 211 Specifying the Engineering Unit Range for a DINT or REAL Point This procedure explains how to configure the engineering unit range for a DINT or REAL point in Trident or Tri-GP controllers. If you are using the OPC UA communication protocol, you must specify the valid minimum and maximum values. Any value outside of the specified range will cause the OPC UA server to clamp its value to the specified range and report a status code of “Uncertain_EngineeringUnitsExceeded”. Note This procedure applies to DINT and REAL tagnames in Trident or Tri-GP 3.x or later projects only. These properties appear on the Scaling tab in Trident 1.x/2.x or Tri-GP 2.x projects, but have no meaning for those controller versions. Procedure 1 Open the Tagname Editor. 2 Click the Scaling tab, and locate the required tagname. 3 Click each box to specify the following properties for a DINT tagname: Property Action Minimum Value (Engineering Unit Range) Enter the minimum value for the engineering unit range; must be less than the maximum value. The default is -2147483648. Maximum Value (Engineering Unit Range) Enter the maximum value for the engineering unit range; must be more than the minimum value. The default is 2147483647. Note 4 For REAL tagnames, the properties and default values are the same as those used for Modbus scaling. See Scaling a REAL Point on page 212 for more detailed information. To save your changes, click the next row, or click the Commit Change button . To cancel your changes, right-click the row that you edited, and click Undo. TriStation 1131 Developer’s Guide, 4.14.0 212 Chapter 2 Application Development Scaling a REAL Point This procedure explains how to scale a point, which allows the value of a REAL point to be scaled to an integer so it can be transmitted through Modbus communication protocol. The integer is derived from a formula that includes values specified on the Scaling tab and values for the Modbus minimum and maximum range on the Tricon TCM, UCM, and EICM, and Trident/Tri-GP MP and CM Setup screens. For information on the formula, see How REAL Numbers are Scaled to Integers on page 278. Procedure 1 Open the Tagname Editor. 2 Click the Scaling tab, and locate the required tagname. 3 Click each box to specify the following properties. Property Action Minimum Value (Min Span) Enter the minimum value to be used to scale the REAL number to an integer; must be less than the maximum value. The default is -32768.0. Maximum Value (Max Span) Enter the maximum value to be used to scale the REAL number to an integer; must be more than the minimum value. The default is 32767.0. Precision Enter the number of decimal points to be used. The default is 1. Disable Scaling (Trident and Tri-GP only) To allow scaling of REAL numbers to integers, do not select this check box. The default is cleared. Note 4 Scaling cannot be disabled on the Tricon system. For Trident/Tri-GP 3.x and later projects, the Minimum and Maximum Values defined here are also used to specify the engineering unit range for OPC UA. See Specifying the Engineering Unit Range for a DINT or REAL Point on page 211 for more detailed information. To save your changes, click the next row, or click the Commit Change button To cancel your changes, right-click the row that you edited, and click Undo. TriStation 1131 Developer’s Guide, 4.14.0 . Tagnames 213 Specifying Display Options for a Tagname This procedure explains how to specify monitor display options used when the tagname is displayed in SOE Recorder. The display options can help an operator identify alarm conditions at a glance. For more information, see the Triconex SOE Recorder User’s Guide. Procedure 1 Open the Tagname Editor. 2 Click the Display tab, and locate the required tagname. 3 To specify the name and color to be displayed for True and False tagname states: 4 • Enter the state names in the respective boxes. The default names are TRUE and FALSE. Each name must be 31 characters or less. • Click the corresponding color boxes to view the default colors, red for TRUE and green for FALSE. To change the color, select a color from the list. To save your changes, click the next row, or click the Commit Change button . To cancel your changes, right-click the row that you edited, and click Undo. TriStation 1131 Developer’s Guide, 4.14.0 214 Chapter 2 Application Development Specifying the Location of a Tagname This procedure explains how to specify the location of a tagname in your plant. This is required if you have configured process alarms in your application (see Alarms on page 229), so that the alarm monitoring application can accurately represent the location of an alarm. Before you can specify the location, you must have defined the Areas, Equipment, and Safety Instrumented Functions (SIFs) in your plant configuration. See Managing Area, Equipment, and SIF Lists on page 241. Procedure 1 Open the Tagname Editor. 2 Click the Location tab, and locate the required tagname. 3 Click each box to specify these properties. 4 Property Action Area Select the Area where the tagname is located. Equipment Select the line of equipment the tagname belongs to. Only Equipment that has been added to the selected Area is available. SIF Select the SIF the tagname is located in. Only SIFs that have been added to the selected Equipment are available. To save your changes, click the next row, or click the Commit Change button To cancel your changes, right-click the row that you edited, and click Undo. TriStation 1131 Developer’s Guide, 4.14.0 . Tagnames 215 Creating Multiple Tagnames You can create multiple tagnames by either specifying a naming pattern, or by copying existing tagname values. Procedure for Using a Naming Pattern 1 Open the Tagname Editor, and click the Add New Tagnames button Commands Group. in the Tagname The New Tagnames dialog box appears. 2 Specify these properties in the New Tagnames dialog box. Property Action Formatted Name Specify whether to use theater numbering, which uses letters, or normal numbering, which uses numbers. Note: Keep any text in this field (such as “Input” in the example above) to 25 characters or less, to ensure you do not exceed the 31-character limit on tagname names. 3 Start Value and Increment Enter the starting value for the first tagname and the number to use when incrementing each successive tagname. How Many Enter the number of tagnames you want to create. Click OK to create the tagnames. TriStation 1131 Developer’s Guide, 4.14.0 216 Chapter 2 Application Development Procedure for Copying Existing Tagnames 1 Open the Tagname Editor. 2 Click a row header to select the tagname values you wish to copy. • Press Shift and click to select multiple contiguous rows. • Press Ctrl and click to select multiple non-contiguous rows. 3 Right-click the selected rows, and click Copy Row(s). 4 Right-click any row, and click Add New Row(s) & Paste. All tagname values, except the following, are copied to the new rows: — Tagname — Point Type (the default is Memory) — Location — Physical Address — Legacy User Alias — Extended User Alias — SOE Blocks Settings — Alarm Settings Since the names must be unique, the new names are appended with an underscore and a number, starting at 1 and incremented by 1. The rest of the tagname properties are copied as is. If the existing rows are sorted, the new rows are inserted according to the existing sort order. If the existing rows are not sorted, the new rows appear at the end of the list. TriStation 1131 Developer’s Guide, 4.14.0 Tagnames 217 Updating Multiple Tagnames You can update multiple tagnames at once by copying values from other tagnames in the Tagname Editor, or by copying values from a Microsoft Excel file. You can also use the fill down option. The procedures in this section apply to all tagnames, including undeclared and unused tagnames. Topics include: • Copying Values from Existing Tagnames on page 217 • Copying Values from an Excel File on page 218 • Using the Fill Down Option on page 218 Note Once you have downloaded your project to the controller, making one or more changes to existing tagnames prior to the next download will cause the project’s minor version number to be increased by one. See Displaying Version Numbers of Projects and Documents on page 39 for more information about project version numbers. Copying Values from Existing Tagnames While this procedure can be used to update multiple tagname properties at once, it does not update the following properties: • Tagname • Physical Address • SOE Blocks Settings • Point Type • Legacy User Alias • Alarm Settings • Location • Extended User Alias To make changes to these properties, you must edit them individually using the tabular view, or by using the Property Sheet Editor. For information on the Property Sheet Editor, see Using the Property Sheet Editor on page 228. Procedure 1 Open the Tagname Editor. 2 Click a row header to select the tagname values you wish to copy. • Press Shift and click to select multiple contiguous rows. • Press Ctrl and click to select multiple non-contiguous rows. 3 Right-click the selected rows, and click Copy Row(s). 4 Select the destination rows that you want to update, right-click, and then click Paste Rows. Note Ensure that the number of selected destination rows is the same as the number of copied rows. If the number is not the same, you may update an insufficient number of rows, or update additional rows that you do not wish to update. TriStation 1131 Developer’s Guide, 4.14.0 218 Chapter 2 Application Development Copying Values from an Excel File Before you copy tagname values from an Excel file, create the values in the file based on the following guidelines: • The first row must have column headers, and these must exactly match the headers in the Tagname Editor. — It is not mandatory to include all column headers. — The sequence of column headers need not match the sequence in the Tagname Editor. • Fill the subsequent rows with valid values. — The name must exactly match the Tagname value for the update to be successful. — Do not include values for the SOE Block Settings and Alarm Settings properties, as these cannot be updated using this method. It is easier to copy values from an Excel file and paste them into the Tagname Editor, if you have the Tagname Editor window pinned to topmost. For more information, see Bring to Topmost Command on page 668. Procedure 1 Copy the rows, including the column header row, from the Excel file. 2 Open the Tagname Editor. 3 Select the destination rows that you want to update, right-click, and then click Paste Rows. The tagname properties, except SOE Blocks Settings and Alarm Settings, are updated. Only those destination rows whose names match the tagnames in the Excel file are updated. Using the Fill Down Option This option allows you to use specific tagname values from a selected range, and apply them to the other tagnames in the range. Note You cannot use this option to update the SOE Block Settings and Alarm Settings properties. Procedure 1 Open the Tagname Editor. 2 Select a range of values that you want to fill down in one or more columns, as shown in the figure below. • To select a contiguous set of values, click a value, hold the Shift key, and click the last value. • To select a non-contiguous set of values, hold the Ctrl key, and click each value. TriStation 1131 Developer’s Guide, 4.14.0 Tagnames Note 219 It is useful to sort the columns before you perform this task, so that the tagnames that you want to update are arranged in a contiguous order. For example, if you want to apply the Alias Type and Enable Multiple Writes values of a BOOL tagname to other BOOL tagnames, you can sort them by the Data Type column, and then select a contiguous range. For more information on sorting, see Sorting Tagnames on page 220. Values updated in selected columns, based on the first values in each column 3 Right-click the selection, and then click Fill Down. The first value in each selected column is copied to the other values in the selected column. When non-contiguous columns are selected, only the selected columns are updated. Properties such as Location or Legacy User Alias are updated with a series of systemgenerated values based on the first selected value, to ensure each of these values are unique. Note If the results of the fill down operation are different from what you expect, you can undo this operation. To do so, right-click a cell, and then click Undo. The updated values will be changed back to their original values. TriStation 1131 Developer’s Guide, 4.14.0 220 Chapter 2 Application Development Sorting, Filtering, and Grouping Tagnames This section explains how to sort, filter, and group tagnames in the Tagname Editor. Sorting Tagnames You can sort tagnames based on the ascending or descending order of a column. To do so, click the column header. An up arrow on a column header indicates an ascending sort order, and a down arrow indicates a descending sort order. For example, to sort tagnames by the ascending order of their names, click the Tagname column header. To remove a sort order, click the column header until the arrows disappear. You can sort tagnames on only a single column across any tab. The order of rows sorted on a tab is maintained across all tabs. Filtering Tagnames If you wish to view a specific set of tagnames in the Tagname Editor, you can do so by filtering them based on a set of criteria. This is helpful if the list of tagnames is long, and you do not want to scroll through the Tagname Editor to locate tagnames. For example, if you wish to view only those tagnames of data type BOOL, you can specify this as a filter criteria. When you filter tagnames, only the display list in the Tagname Editor changes. Tagnames that do not meet the filter criteria are hidden, but not removed. When you clear the filter, the complete list of tagnames available in your application is displayed. Procedure 1 Open the Tagname Editor. 2 Do one of the following: • To view tagnames that are used in the program currently open in the Program Workspace, click the Filter by Used in Current View button Commands Group. • To view tagnames that are not used by any program in the application, click the Filter by Unused Anywhere button • in the Tagname in the Tagname Commands Group. To view tagnames that are not declared (created, but not named), click the Show Undeclared button in the Tagname Commands Group. Notes To remove a filter, click the corresponding button again. The Used in Current View filter cannot be combined with the Unused or Undeclared filters. • 3 To filter tagnames based on specific values within a column, go to step 3. Click the filter icon on a coumn header. The filter screen appears. TriStation 1131 Developer’s Guide, 4.14.0 Tagnames 4 221 Do one of the following: • To filter rows based on specific column values, select the desired values in the Select All area, as shown in the following figure. • To filter rows based on specific criteria, select the desired operator, and specify the value that must compare against the operator, as shown in the following figure. For example, to view tagnames whose Legacy User Alias values are greater than 40251, select the Is greater than operator, and specify 40251 in the box below it. You can also specify multiple criteria by using the conditions And or Or. For example, to view tagnames whose Legacy User Alias values are in the range 40251 to 40551, use the Is greater than and Is lesser than operators, specify the ranges in the respective boxes, and select the And condition. Filter by specific column values Operator Value to compare with Condition to specify multiple criteria 5 Click Filter to view the list of filtered tagnames. To remove the filter(s) and view all tagnames, click Clear Filter. TriStation 1131 Developer’s Guide, 4.14.0 222 Chapter 2 Application Development Grouping Tagnames You can also view tagnames by grouping them according to specific column headers. For example, if you want to view only tagnames of type BOOL, you can group them according to the Data Type property. You can also create subgroups within a group to create additional views within the existing view. When you group tagnames, only the display list in the Tagname Editor changes. Tagnames that do not meet the grouping criteria are hidden, but not removed. When you clear the grouping, the complete list of tagnames available in your application is displayed. Procedure 1 Open the Tagname Editor. 2 Drag the desired column header to the grouping panel located above the column headers. For example, in the following figure, the tagnames are grouped based on the Data Type property. Grouping Panel Collapsible Groups Click to expand a group The grouped column values are displayed in a collapsible format. 3 To view the list of tagnames under each group, click the down arrow group. 4 To create subgroups within a group, drag another column header to the grouping panel. next to the For example, in the following figure, tagnames of each data type are further grouped according to their point types. DINT tagnames are shown in an expanded view, with INPUT point types grouped together, followed by MEMORY point types. TriStation 1131 Developer’s Guide, 4.14.0 Tagnames 223 Expanded group and subgroups To clear the grouped views, click the grouping panel. button next to the column header(s) in the Copying Tagnames from the Tagname Editor Tagnames can be copied from the Tagname Editor to a spreadsheet (.xls) or text file (.txt). Note Only entire rows can be copied, not values from specific cells. Procedure 1 Open the Tagname Editor. 2 Click a row header to select the rows you want to copy. 3 • Press Shift and click to select multiple contiguous rows. • Press Ctrl and click to select multiple non-contiguous rows. • Click any cell and press Ctrl + A to select all rows. Right-click the selected rows, and then click Copy Row(s). Note 4 When you copy a row on a tab, the row values across all other tabs are also copied. Paste the data in the target document. The column headers in the Tagname Editor are automatically included with the copied data. TriStation 1131 Developer’s Guide, 4.14.0 224 Chapter 2 Application Development Renaming Tagnames This procedure explains how to rename tagnames. Note Once you have downloaded your project to the controller, making one or more changes to existing tagnames prior to the next download will cause the project’s minor version number to be increased by one. See Displaying Version Numbers of Projects and Documents on page 39 for more information about project version numbers. Procedure 1 Open the Tagname Editor. 2 To edit the name, double-click the Tagname box, and then enter a new name. The name must be 31 characters or less. If the name is already assigned to another tagname, a message appears, and you must enter another name. Deleting Tagnames This procedure explains how to delete tagnames. Because you cannot recover deleted tagnames, you may want to review the list of unused tagnames, to be sure you want to delete them, before performing this procedure. See Managing Undeclared and Unused Tagnames on page 226. Notes You can delete unused tagnames, but you cannot delete undeclared tagnames. For more information on unused and undeclared tagnames, see Managing Undeclared and Unused Tagnames on page 226. Once you have downloaded your project to the controller, deleting one or more tagnames prior to the next download will cause the project’s minor version number to be increased by one. See Displaying Version Numbers of Projects and Documents on page 39 for more information about project version numbers. Procedure 1 Open the Tagname Editor. 2 Select the row headers corresponding to the tagnames that you want to delete. • To select multiple contiguous rows, press Shift and click the first and last row header in the range you want to select. • To select multiple non-contiguous rows, press Ctrl and click each row header. Note 3 If you want to delete unused tagnames, filter the tagnames list to view them. For more information, see Filtering Tagnames on page 220. Right-click the selected row, and then click Delete Rows. If the tagname is already in use, a message warns you that deleting the tagname may result in unresolved tagnames. To restore the deleted tagnames, right-click on a row, and click Undo. TriStation 1131 Developer’s Guide, 4.14.0 Tagnames 225 Printing Tagnames You can print all tagname properties, except the Alarm Settings and SOE Block Settings properties. Properties can be printed for each individual tab, or across all tabs. State Name colors print as hexadecimal codes, and check box values print as TRUE (checked) or FALSE (unchecked). Grouped or sorted tagnames print in the same grouped format or sort order displayed in the Tagname Editor at the time of printing. If tagnames are filtered, only the filtered list displayed in the Tagname Editor is printed. To print all tagnames, clear the filters before printing. For more information, see Sorting, Filtering, and Grouping Tagnames on page 220. Note You can also use the Print All command to print various reports listing the tagnames declared and used in your project. See Printing Project Documents on page 109. Procedure 1 Open the Tagname Editor. 2 Click the tab whose tagname properties you want to print. To print all tagname properties, click the All tab. 3 Click the button in the Tagname Commands Group. The Print Preview dialog box appears. 4 Select the desired orientation and paper size, and click Print. TriStation 1131 Developer’s Guide, 4.14.0 226 Chapter 2 Application Development Managing Undeclared and Unused Tagnames This section explains how to manage undeclared and unused tagnames. Topics include: • What Are Undeclared Tagnames? on page 226 • What Are Unused Tagnames? on page 227 What Are Undeclared Tagnames? Undeclared tagnames are tagnames (also referred to as points) that have been created but not named. They have the following characteristics: • They are not yet associated with any global tagnames. • They are not listed under Tagname Declarations in the Application Workspace. • They have a Tag name attribute of {not yet named}. Think of undeclared tagnames as the number of “free” points that are available for use in your application. You control the total number of undeclared tagnames via the amount of memory you have allocated for points. See Allocating Memory for Tricon Points on page 343 or Allocating Memory for Trident or Tri-GP Points on page 442. Each time you declare a new tagname (whether it is used in a program or not), the total number of undeclared tagnames decreases by one. Example In this example, memory has been allocated to allow for 640 unaliased memory BOOL points, as shown in the Memory Allocation Item Properties dialog box. • Of these points, 8 have been used and 9 have been forecast (declared). The 9 declared points will appear in the Tagname Declarations tree. • One point will also appear in the Unused Tagnames list, because while 9 points have been declared, only 8 have been added to a program (see What Are Unused Tagnames? on page 227). • 631 points appear in the Undeclared Tagnames list, because while they have been allocated, they have not yet been declared (640 allocated - 9 declared = 631 undeclared). TriStation 1131 Developer’s Guide, 4.14.0 Tagnames • Note 227 Thus, you can declare 631 more unaliased memory BOOL points, based on the current memory allocation. Remember, you can increase or decrease the number of available points by changing the amount of memory allocated for points. Undeclared tagnames are not counted against the 2,000 tagnames per program limit. See Viewing the Number of Variables and Tagnames in a Program on page 195 for more information. What Are Unused Tagnames? Unused tagnames are tagnames that have been declared, but have not yet been used in a program. Unused tagnames: • Are already associated with global tagnames using the procedures outlined in Declaring Tagnames on page 203. Tagnames with invalid attributes imported from external sources will remain unassociated with any global tagnames until they are renamed using the procedures outlined in Renaming Tagnames on page 224. • Are listed under Tagname Declarations in the Application Workspace. • Have not yet been used in any program, function, or function block in the project. For additional information on working with undeclared and unused tagnames, see these topics: • Filtering Tagnames on page 220 for instructions on viewing the list of undeclared and unused tagnames. • Renaming Tagnames on page 224 for instructions on editing undeclared and unused tagnames. • Deleting Tagnames on page 224 for instructions on deleting unused tagnames. TriStation 1131 Developer’s Guide, 4.14.0 228 Chapter 2 Application Development Using the Property Sheet Editor In addition to using the Tagname Editor’s tabular view, you can use the Property Sheet Editor to manage tagname properties. To view the Property Sheet Editor, click Show/Hide Property Sheet of the Tagname Editor window. in the top right corner To view the properties for a specific tagname, click the tagname in the tabular view. The following figure and table describe the areas of the Property Sheet Editor, and how to create and edit tagnames. Group Button (highlight indicates the current view) Search Box Sort Button Property Grid Expandable Property Tabs To ... Do This ... Group the properties according to the property tabs Click the Group Search for a specific property Type the name of the property in the Search box. View all tagnames properties in alphabetical order. Click the Sort Close the Property Sheet Editor. Click the Note button. button. button. After you enter or edit a value in a property box, the changes are saved automatically when you click in another property box. TriStation 1131 Developer’s Guide, 4.14.0 Alarms 229 Alarms Alarms are audible and/or visible indicators that warn a plant operator about conditions that may cause a process to go into an abnormal or unsafe state (for example, when a tank level is too high or a motor overheats). Alarms are typically configured to trigger when a process value exceeds a defined limit, alerting the operator that corrective action is required to correct the condition and return the process to the normal state. TriStation 1131 supports the following types of alarms: • Trip: An alarm that is generated when the monitored piece of equipment experiences an abnormal fault (such as a motor shutting down due to an overload condition). • Level: An alarm that is triggered when the monitored value exceeds pre-defined limits. There are two limits for the above-normal operating range (high-high and high) and two limits for the below-limit operating range (low-low and low). • Deviation: An alarm that occurs when the monitored value exceeds or falls below (plus or minus) a certain range, based on a setpoint value. • Rate of Change (ROC): An alarm that is generated when a monitored value is changing too quickly. Alarms can be configured for each of the following types of tagnames: Data Type Point Type Valid Alarm Types BOOL Memory or Input Trip DINT Memory, Aliased Level, Deviation, ROC REAL Memory, Aliased Level, Deviation, ROC Alarms can be configured using either the TriStation 1131 interface (via the Tag Configuration dialog box, as described in the following sections), or programmatically, using alarm function blocks. Notes Alarm function blocks are included in the ALARMS library (Alarms.lt2) and ALARMS3 library (Alarms3.lt2). These libraries are not automatically included with TriStation 1131 sample projects or newly created projects. You must add one of these libraries to a project manually. You can add both these libraries to the same project, if required. For instructions, see Adding a Library on page 94. See the TriStation 1131 Libraries Reference for more detailed information about the alarm function blocks. You can configure alarms using the TriStation 1131 interface only if you plan to use the ALARMS library in your project. If you plan to use the ALARMS3 library, you must configure alarms programmatically, using the ALARMS3 function blocks. If you configure a tagname with an alarm, you must also specify the location of the tagname in your plant, so that the alarm monitoring application can accurately represent the location of the alarm. See Specifying the Location of a Tagname on page 214 for more information. TriStation 1131 Developer’s Guide, 4.14.0 230 Chapter 2 Application Development Once you have configured alarms for tagnames using the ALARMS library, a process alarms program is automatically generated and added to the Implementation list when you build your application. This read-only structured text program associates the appropriate alarm function blocks with the tagnames configured with alarms. See About the Process Alarms Program on page 325 for more information. An alarm function block in the ALARMS library uses approximately 800 bytes of memory, and each tagname configured for an alarm attribute takes up about 4 bytes. So, if 30 attributes are configured per alarm, the total memory occupied would be 920 bytes, including the alarm function block. If too many alarms are configured, TriStation 1131 will be unable to compile your application due to insufficient memory. So, when using the ALARMS library, Invensys suggests configuring a maximum of 100 alarms per application. Note Each alarm has approximately 30 attributes, each of which can be associated with an individual tagname. Thus, while Invensys recommends a maximum of 100 “alarms”, this translates to a maximum of 3000 alarm attributes, each of which can be associated with an individual tagname. For information on viewing the amount of memory used by your control program, see Allocating Memory for Tricon Points on page 343 and Allocating Memory for Trident or Tri-GP Points on page 442. When you run your application on the controller, you can view the status of the configured alarms using your standard alarm management software, such as Triconex Safety View Alarm and Bypass Management (ABM). See your Invensys sales representative for more information about Safety View ABM and how you can use it to monitor alarms in your plant. Topics include: • Configuring Alarm Attributes on page 231 • Configuring a Level, Deviation, or ROC Alarm on page 233 • Configuring a Trip Alarm on page 237 • Managing Area, Equipment, and SIF Lists on page 241 • Effect of Process Alarms on Scan Time on page 244 TriStation 1131 Developer’s Guide, 4.14.0 Alarms 231 Configuring Alarm Attributes Each alarm type has a set of attributes to be configured. While the attributes themselves differ depending on the type of alarm you are configuring, the method for configuring the attributes is the same. Leaving an alarm attribute blank results in the following default values: • For BOOL attributes, the default value is FALSE. • For all other attributes, the default value is 0. While most attributes can accept either a constant (fixed) value or a tagname, some attributes can accept only one or the other: Attributes Requiring a Constant Value Attributes Requiring a Tagname Time Delay First Out Active Low Low Active Alarm Function Block Alarm Status Low Active High High Active High Active If you enter an incorrect value for any of the above attributes, the attribute’s field will turn red to indicate that an invalid value was entered. Procedure 1 Open the Tagname Editor, and locate the tagname that you want to specify alarm settings for. 2 On the Declaration tab, click Settings in the Alarm column. Settings button The Tag Configuration dialog box appears. TriStation 1131 Developer’s Guide, 4.14.0 232 Chapter 2 Application Development Note You can configure alarms using this method only if you plan to use the ALARMS library in your project. If you plan to use the ALARMS3 library, you must configure alarms programmatically. Additionally, the Settings button is available only if the ALARMS library has been added to your project. 3 Click the tab for the type of alarm you want to configure (Trip, Level Alarm, Deviation Alarm, or Rate of Change Alarm). 4 For each attribute, do one of the following: • Enter a constant (fixed) value, where appropriate. • Select a tagname, where appropriate. Use either of the following methods to select the tagname to assign to an attribute: — Click the Browse button for the attribute to open the Select Tagname dialog box, and then specify these properties: Property Action Search Filter the list of available tagnames by entering one or more characters, or search for a specific tagname’s name. Point Type Filter the list of tagnames by point type by selecting one of the following: Memory, Input, Output, or All. Available Tagnames Select the tagname you want to assign to the attribute from the list of tagnames. Tagnames in the list match the filter criteria you selected and are of the correct data type for the selected attribute. — Drag-and-drop a tagname from the Tagnames Declaration folder in the Application tree. Only declared tagnames that have a data type that matches that of the alarm’s tagname can be assigned to alarm attributes. If you select a tagname that does not meet this criteria, the attribute’s field will turn red to indicate an invalid tagname has been selected. 5 Click OK to return to the Tag Configuration dialog box. TriStation 1131 Developer’s Guide, 4.14.0 Alarms 233 Configuring a Level, Deviation, or ROC Alarm A level, deviation, or ROC alarm can be configured for an aliased memory DINT or REAL tagname. The alarm attributes you configure here are automatically connected to the corresponding input in the appropriate alarm function block when the process alarms program is created (see About the Process Alarms Program on page 325). If desired, you can configure more than one alarm type for each tagname. For example, you can configure both a level alarm and a ROC alarm for the same tagname. In this example, the level alarm can be used to trigger the filling of a tank when a low limit is reached, but a high rate of change alarm can indicate a problem with the tank. Note This procedure applies only to tagnames being configured for use with ALARMS library function blocks. This procedure cannot be used to configure tagnames for use with ALARMS3 library function blocks. Procedure 1 Open the Tagname Editor, and locate the tagname that you want to specify alarm settings for. 2 On the Declaration tab, click Settings in the Alarm column. The Tag Configuration dialog box appears. 3 Click the tab corresponding to the type of alarm you want to configure: Level Alarm, Deviation Alarm, or Rate of Change Alarm. 4 Specify the following properties. See Configuring Alarm Attributes on page 231 for instructions on how to configure these properties. TriStation 1131 Developer’s Guide, 4.14.0 234 Chapter 2 Application Development Property Description Enable Alarm Select the check box to enable an alarm for this tagname. If this check box is cleared, an alarm will not be added to the process alarms program, and no alarm will be configured. Limits Specify the Low Low, Low, High, and High High process condition limits for this alarm. Severity Specify the Low Low, Low, High, and High High severities for this alarm. Severities are defined in the OPC UA communications protocol. Alarm Function Block Name of the alarm function block associated with this alarm. A default name is created automatically by TriStation 1131 using the name of the tagname you are configuring the alarm for, and the alarm type. For example, if your tagname is named “PV_1047”, the function block name for a level alarm will be generated as “PV_1047_LvlAlm”. You can change this name, as long as the name does not exceed 31 characters. Bypass Request Specifies whether or not a client can request a bypass for this alarm. Must be TRUE, FALSE, or a BOOL tagname. Unbypass Request Specifies whether or not a client can request an unbypass for this alarm. Must be TRUE, FALSE, or a BOOL tagname. Bypass Specifies if the alarm is bypassed. Must be TRUE, FALSE, or a BOOL tagname. Disable Request Specifies whether or not a client can disable the alarm. Must be TRUE, FALSE, or a BOOL tagname. Shift Change Request Specifies whether or not shift change functionality is enabled for this alarm. A “shift change” is the start of a new shift, when there is a change in operator(s). When enabled, alarms that were acknowledged before the shift change will need to be acknowledged again by the new operator(s). Must be TRUE, FALSE, or a BOOL tagname. Automatic Reset Configures the alarm sequence as follows: • If Automatic Reset = FALSE and Alarm Ringback = FALSE, then the manual reset sequence is initiated. • If Automatic Reset = FALSE and Alarm Ringback = TRUE, then the ringback sequence is initiated. • If Automatic Reset = TRUE, then the automatic reset sequence is initiated, regardless of the Alarm Ringback status. Resets the alarm automatically when an alarm goes inactive. Must be TRUE, FALSE, or a BOOL tagname. TriStation 1131 Developer’s Guide, 4.14.0 Alarms Property Description Alarm Ringback Configures the alarm sequence as follows: 235 • If Alarm Ringback = FALSE and Automatic Reset = FALSE, then the manual reset sequence is initiated. • If Alarm Ringback = TRUE and Automatic Reset = FALSE, then the ringback sequence is initiated. • If Automatic Reset = TRUE, then the automatic reset sequence is initiated, regardless of the Alarm Ringback input status. When ringback is enabled, if an alarm is triggered but then returns to normal without being acknowledged, it enters the ringback state. The ringback state requires a manual reset of the alarm to return the state to normal. Must be TRUE, FALSE, or a BOOL tagname. Command In An integer that indicates an acknowledge or manual reset command from the operator, as follows: • 6 = Acknowledge (causes a transition from state Alarm to Acknowledged) • 12 = Manual reset (causes a transition to state Normal if the process condition is normal) • Other = Do nothing Command ID Specifies which function block will execute the command specified by Command In. • The function block whose ID is the same as Command ID is the selected function block. • Function blocks whose ID are not the same as Command ID will ignore the command. Command Accepted Specifies whether a command has been accepted by the alarm function block. • If true, a command was accepted. • If false, no command was accepted. Must be TRUE, FALSE, or a BOOL tagname. ID Specifies the unique identifier for this alarm function block. • The function block whose ID is the same as Command ID will execute the command specified by Command In. • Function blocks whose ID are not the same as Command ID will ignore the command. Must be an integer. Deadband Specifies the difference between the alarm limit and the input value before an alarm goes inactive. Used for hysteresis. For example, if the high limit is set to 100, and the deadband is 10, the alarm will go active at 100, and inactive at 90. If the low limit is set to 100, the alarm will go active at 100, and inactive at 110. Must be an integer. TriStation 1131 Developer’s Guide, 4.14.0 236 Chapter 2 Application Development Property Description First Out Specifies the first alarm (in a specified set of alarms) that goes active.All alarm function blocks in a first-out group share the same tagname. • If 0 (zero), none of the alarms in the group have transitioned from normal to active. • If non-zero, the first-out alarm is the alarm with ID equal to the first-out tagname. Must be an integer. Setpoint For deviation alarms only. Specifies the value from which the deviation alarm will be generated. Must be an integer. Time Delay Specifies the amount of time (in seconds) before an alarm will go ACTIVE after detection of a process condition change from normal to abnormal. The default is 0 seconds. For example, if you enter 10 as the time delay length, the condition triggering the alarm must be active for 10 seconds before the alarm will be generated. Source ID Specifies the unique ID for communication via the OPC UA protocol interface. Assigned automatically when the process alarms program is generated. If you are not using OPC UA, you must set this value to 0 (zero), which disables communication between the alarm function block and the OPC UA Server (no events are sent). Active Specifies the alarm state. Must be TRUE, FALSE, or a BOOL tagname. • If true, the alarm state is Active or Acknowledged. • If false, the alarm state is Disabled, Normal, or Ringback. 5 Low Active If true, the alarm condition is Low Low. Low Low Active If true, the alarm condition is Low Low or Low. High Active If true, the alarm condition is High High or High. High High Active If true, the alarm condition is High High. Alarm Status Specifies the current alarm state, alarm condition, and process condition. For more information about this parameter, see the TriStation 1131 Libraries Reference. Click Apply to save your changes. To cancel your changes and restore the original settings, click Restore before clicking Apply. Note 6 To configure another alarm for this tagname, click the tab corresponding to the type of alarm you want to configure, and then repeat steps 4 and 5. When you have finished configuring alarms for this tagname, click Close. TriStation 1131 Developer’s Guide, 4.14.0 Alarms 237 Configuring a Trip Alarm A trip alarm can be configured for an aliased BOOL tagname with a point type of Memory or Input. The alarm attributes you configure here are automatically connected to the corresponding input in the appropriate alarm function block when you create the process alarms program (see About the Process Alarms Program on page 325). Note This procedure applies only to tagnames being configured for use with ALARMS library function blocks. This procedure cannot be used to configure tagnames for use with ALARMS3 library function blocks. Procedure 1 Open the Tagname Editor, and locate the tagname that you want to specify alarm settings for. 2 On the Declaration tab, click Settings in the Alarm column. The Tag Configuration dialog box appears. 3 Specify the following properties. See Configuring Alarm Attributes on page 231 for instructions on how to configure these properties. Property Description Enable Alarm Select the check box to enable an alarm for this tagname. If this check box is cleared, an alarm will not be added to the process alarms program, and no alarm will be configured. TriStation 1131 Developer’s Guide, 4.14.0 238 Chapter 2 Application Development Property Description Alarm Function Block Name of the alarm function block associated with this alarm. A default name is created automatically by TriStation 1131 using the name of the tagname you are configuring the alarm for, and the alarm type. For example, if your tagname is named “PV_1047”, the function block name for a trip alarm will be generated as “PV_1047_TRIPAlm”. You can change this name, as long as the name does not exceed 31 characters. Bypass Request Specifies whether or not a client can request a bypass for this alarm. Must be TRUE, FALSE, or a BOOL tagname. Unbypass Request Specifies whether or not a client can request an unbypass for this alarm. Must be TRUE, FALSE, or a BOOL tagname. Bypass Specifies if the alarm is bypassed. Must be TRUE, FALSE, or a BOOL tagname. Disable Request Specifies whether or not a client can disable the alarm. Must be TRUE, FALSE, or a BOOL tagname. Shift Change Request Specifies whether or not shift change functionality is enabled for this alarm. A “shift change” is the start of a new shift, when there is a change in operator(s). When enabled, alarms that were acknowledged before the shift change will need to be acknowledged again by the new operator(s). Must be TRUE, FALSE, or a BOOL tagname. Automatic Reset Configures the alarm sequence as follows: • If Automatic Reset = FALSE and Alarm Ringback = FALSE, then the manual reset sequence is initiated. • If Automatic Reset = FALSE and Alarm Ringback = TRUE, then the ringback sequence is initiated. • If Automatic Reset = TRUE, then the automatic reset sequence is initiated, regardless of the Alarm Ringback status. Resets the alarm automatically when an alarm goes inactive. Must be TRUE, FALSE, or a BOOL tagname. Alarm Ringback Configures the alarm sequence as follows: • If Alarm Ringback = FALSE and Automatic Reset = FALSE, then the manual reset sequence is initiated. • If Alarm Ringback = TRUE and Automatic Reset = FALSE, then the ringback sequence is initiated. • If Automatic Reset = TRUE, then the automatic reset sequence is initiated, regardless of the Alarm Ringback input status. When ringback is enabled, if an alarm is triggered but then returns to normal without being acknowledged, it enters the ringback state. The ringback state requires a manual reset of the alarm to return the state to normal. Must be TRUE, FALSE, or a BOOL tagname. TriStation 1131 Developer’s Guide, 4.14.0 Alarms Property Description Command In An integer that indicates an acknowledge or manual reset command from the operator, as follows: 239 • 6 = Acknowledge (causes a transition from state Alarm to Acknowledged) • 12 = Manual reset (causes a transition to state Normal if the process condition is normal) • Other = Do nothing Command ID Specifies which function block will execute the command specified by Command In. • The function block whose ID is the same as Command ID is the selected function block. • Function blocks whose ID are not the same as Command ID will ignore the command. Command Accepted Specifies whether a command has been accepted by the alarm function block. • If true, a command was accepted. • If false, no command was accepted. Must be TRUE, FALSE, or a BOOL tagname. ID Specifies the unique identifier for this alarm function block. • The function block whose ID is the same as Command ID will execute the command specified by Command In. • Function blocks whose ID are not the same as Command ID will ignore the command. Must be an integer. First Out Specifies the first alarm (in a specified set of alarms) that goes active.All alarm function blocks in a first-out group share the same tagname. • If 0 (zero), none of the alarms in the group have transitioned from normal to active. • If non-zero, the first-out alarm is the alarm with ID equal to the first-out tagname. Must be an integer. Trip Level Specifies which level (True or False) results in a trip alarm. • The process condition is abnormal if Source = Trip Level. • The process condition is normal when Source ≠ Trip Level. Must be TRUE, FALSE, or a BOOL tagname. Trip Severity Specifies the severity number for the trip alarm. Severities are defined in the OPC UA communications protocol. Must be an integer. TriStation 1131 Developer’s Guide, 4.14.0 240 Chapter 2 Application Development Property Description Time Delay Specifies the amount of time (in seconds) before an alarm will go ACTIVE after detection of a process condition change from normal to abnormal. The default is 0 seconds. For example, if you enter 10 as the time delay length, the condition triggering the alarm must be active for 10 seconds before the alarm will be generated. Source ID Specifies the unique ID for communication via the OPC UA protocol interface. Assigned automatically when the process alarms program is generated. If you are not using OPC UA, you must set this value to 0 (zero), which disables communication between the alarm function block and the OPC UA Server (no events are sent). Active Specifies the alarm state. Must be TRUE, FALSE, or a BOOL tagname. • If true, the alarm state is Active or Acknowledged. • If false, the alarm state is Disabled, Normal, or Ringback. Alarm Status 4 Specifies the current alarm state, alarm condition, and process condition. For more information about this parameter, see the TriStation 1131 Libraries Reference. Click Apply to save your changes. To cancel your changes and restore the original settings, click Restore before clicking Apply. 5 Click Close to close the Tag Configuration dialog box. TriStation 1131 Developer’s Guide, 4.14.0 Alarms 241 Managing Area, Equipment, and SIF Lists Areas, Equipment, and Safety Instrumented Functions (SIFs) identify the physical location of equipment and alarms in your plant.Specifying the location of the tagname configured with an alarm is required so that the alarm monitoring application can accurately represent the location of the alarm. Before you can assign these locations to specific tagnames, you must build the lists of these locations to match your actual plant configuration. • An Area is a collection of devices, controllers, and the communication networks connecting those devices and controllers within a plant. • Equipment is a specific line of equipment within an Area. One Area can have multiple lines of equipment within it. • A SIF is a specific safety function within a line of equipment. There can multiple SIFs in a single line of equipment. Once you have created the Area, Equipment, and SIF lists, the entries in the lists will be available for selection on the tagname’s Item Properties > Locations tab and on the Location tab of the Tagname Editor. See Specifying the Location of a Tagname on page 214 for more information. Note If the tagname Item Properties dialog box is open while you are making changes to the Area, Equipment, and SIF list, you must close the Item Properties dialog box and open it again to update the available items in the drop-down lists on the Location tab. Adding Areas, Equipment, and SIFs When adding Areas, Equipment, and SIFs, keep in mind the following: • Once you have added items to the list, you cannot rearrange the order in which they appear in the tree. However, items are sorted by alphabetical/numerical order when they appear in the drop-down lists on the tagname’s Item Properties > Locations tab. • If you enter Equipment without first creating a new Area or selecting an existing Area, TriStation 1131 will automatically create the default Area (Area1) and add the Equipment to that Area. You can rename the default Area if desired. • If you enter a SIF without first creating new Equipment or selecting existing Equipment, TriStation 1131 will automatically create the default Equipment (Equipment1) and add the SIF to that Equipment. You can rename the default Equipment if desired. • You can add an Area without adding Equipment to it. You can also add Equipment without adding SIFs to it. TriStation 1131 Developer’s Guide, 4.14.0 242 Chapter 2 Application Development Procedure 1 On the Project menu, click Manage Area, Equipment and SIF List. 2 Do one of the following: • To add an Area, Equipment, and SIF all at once, specify these properties. Property Action Area Enter the name of the Area you want to add. Equipment Enter the name of the line of equipment you want to add. SIF Enter the name of the SIF you want to add. • To add Equipment to an existing Area, select the Area in the tree, and then enter the name of the line of equipment you want to add. • To add a SIF to an existing line of equipment, select the Equipment in the tree, and then enter the name of the SIF you want to add. 3 Click Add. 4 Repeat step 2 as needed until you have added all the required Areas, Equipment, and SIFs. 5 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Alarms 243 Renaming an Area, Equipment, or SIF You can rename an existing Area, Equipment, or SIF at any time. CAUTION If there are already tagnames using the Area, Equipment, or SIF you are renaming, you will be prompted to confirm the change before it is saved. Changing the name will delete ALL location information—not just the item you are renaming—for ALL affected tagnames. To avoid this global change, click No when prompted to continue with the change. Procedure 1 On the Project menu, click Manage Area, Equipment and SIF List. 2 In the tree, select the item you want to rename. 3 Click the same item again to allow the name to be edited. 4 Press TAB to save the new name. 5 Click OK to save your changes. Deleting an Area, Equipment, or SIF You can delete an existing Area, Equipment, or SIF at any time. However, please note the following: • Deleting an Area also deletes ALL Equipment and SIFs contained within it. • Deleting a line of Equipment also deletes all SIFs contained within it. CAUTION If there are already tagnames using the Area, Equipment, or SIF you are deleting, you will be prompted to confirm the change before it is saved. Deleting one item will clear ALL location information—not just the item you are deleting—for ALL affected tagnames. To avoid this global change, click No when prompted to continue with the change. Procedure 1 On the Project menu, click Manage Area, Equipment and SIF List. 2 In the tree, select the item you want to delete. 3 Click Delete. 4 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 244 Chapter 2 Application Development Effect of Process Alarms on Scan Time Processing alarms has an effect on scan time. For every alarm generated during a scan, the controller takes approximately an additional 0.2 milliseconds for that scan. For example, 10 simultaneous alarms in one scan would add 2 milliseconds to that single scan time. The reported scan time (and scan surplus) is an average of the last 100 scans. When you set the scan time in TriStation 1131, make sure it includes adequate time for process alarm generation. If the scan time is not long enough, the generation of multiple simultaneous alarms could result in scan-time overruns. It is possible for an application to report a positive scan surplus, but to have a scan overrun (a negative scan surplus) when simultaneous process alarms are generated in a single scan. The following examples show how scan overruns can occur when process alarms are generated. Example 1 In this example, assume that 50 alarms are generated during every tenth scan. • Scan time without alarms = 100ms on Scans 1 through 9 • Scan time with alarms = 110ms on Scan 10, calculated as follows: (50*0.2) + 100ms. The 50 alarms adds 10 milliseconds to the scan time because each alarm adds an additional 0.2 milliseconds to the scan time. The average scan time in this case is reported as 101 milliseconds. If the scan time is set to 105 milliseconds, the application will report a positive scan surplus of 4 milliseconds. However, there will be a scan overrun every tenth scan, when the process alarms are generated. Example 2 In this example, assume that 20 alarms are generated during every other scan. • Scan time without alarms = 100ms on Scans 1, 3, 5, 7, 9 • Scan time with alarms = 104ms on Scans 2, 4, 6, 8, 10; calculated as follows: (20*0.2) + 100ms. The 20 alarms adds 4 milliseconds to the scan time because each alarm adds an additional 0.2 milliseconds to the scan time. The average scan time in this case is reported as 102 milliseconds. If the scan time is set to 104 milliseconds, a scan overrun will never occur. However, if the scan time is set to 102ms, there will be a scan overrun every other scan, when the process alarms are generated. TriStation 1131 Developer’s Guide, 4.14.0 Importing and Exporting Tagnames 245 Importing and Exporting Tagnames This section explains how to import and export tagnames using a file with point information. Topics include: • Exporting Tagname Properties on page 245 • Format of an Exported Tagname File on page 246 • Preparing an Excel File for Import on page 251 • File Format Requirements for Tagname Import on page 252 • Import Options and Validation Criteria on page 259 • Importing Tagname Properties on page 260 Exporting Tagname Properties This procedure explains how to export tagname properties to a file. File formats you can export to include: • dBASE™ (dbf) • Microsoft Access® (mdb) • Microsoft Excel® (xls) • Comma delimited text file (txt or csv) • Matrikon OPC XML Data file (xml) If you have configured alarms for tagnames, you can choose to export tagname properties with or without alarm attributes. For more information about configuring alarms, see Alarms on page 229. You can also choose to export either Legacy or Extended alias numbers assigned to tagnames. Notes When you export tagnames with Legacy alias numbers, all tagnames with a 5-digit alias are exported. This includes tagnames with Legacy alias numbers, as well as tagnames with 5-digit equivalents for Extended alias numbers (if available). When you export tagnames with Extended alias numbers, all tagnames with a 6-digit alias are exported. This includes tagnames with Extended alias numbers, as well as tagnames with 6-digit equivalents for Legacy alias numbers. For more information about Legacy and Extended alias numbers, see Alias Number on page 657. Procedure 1 Expand the Application tree, and right-click the Tagname Declarations folder. 2 Do one of the following: • To export tagname properties that include Legacy alias numbers and alarm attributes, click Export with Legacy Aliases & Alarm Attributes. • To export tagname properties that include Extended alias numbers and alarm attributes, click Export with Extended Aliases & Alarm Attributes. TriStation 1131 Developer’s Guide, 4.14.0 246 Chapter 2 Application Development • To export tagname properties that include Legacy alias numbers (but without alarm attributes), click Export with Legacy Aliases. • To export tagname properties that include Extended alias numbers (but without alarm attributes), click Export with Extended Aliases. 3 Select the location, file name, and file type to save the tagname information. 4 Click Export. If you enter a file name longer than eight characters, you are warned that you may need to rename the file if you want to import it to a TriStation 1131 project. Note Some names cannot be used as file names when exporting tagnames to Microsoft Excel files. For a list of these names, see Names Reserved by SQL on page 936. Format of an Exported Tagname File The format of an exported file depends on the export option you select. An exported file that includes Legacy or Extended alias numbers (without alarm attributes) has these properties. Table 29 Exported Tagname File Format Point Property Description TAGNAME The tagname for the point. Must be 31 characters or less to be a valid IEC 61131-3 identifier. DESCRIP The description for the point. GROUP1 The Group1 description. GROUP2 The Group2 description ALIASTYPE The alias type for the point: U = Unaliased R = Read-only aliased W = Read/Write aliased TriStation 1131 Developer’s Guide, 4.14.0 Importing and Exporting Tagnames Table 29 247 Exported Tagname File Format (continued) Point Property Description ALIASNUM The alias number for the point. • For Tricon: —If you exported Legacy alias numbers, from 0 to 42000. —If you exported Extended alias numbers, from 0 to 422048. For more information about the Legacy and Extended alias ranges, see Alias Number on page 657. • For Trident and Tri-GP, from 0 to 49999. DATATYPE The data type: D = Discrete (BOOL) I = Integer (DINT) R = Real (REAL) POINTTYPE The point type: I = Input O = Output M = Memory INITVALUE The initial value: For BOOL, True or False For DINT, an integer value For REAL, a real value RETENTIVE Retentive flag: if R, the value is retained if a power outage shuts down the controller. N = Non-retentive R = Retentive IOP IOP number (1) (Trident or Tri-GP) SLOT Slot number (1 - 63) (Trident or Tri-GP) POINT Point number (1 - 32) (Trident or Tri-GP) CHASSIS Chassis number (0 - 15) (Tricon) SLOT Slot number (0-8) (Tricon) POINT Point number (0 - 64) (Tricon) MINSPAN The lower limit for REAL in Engineering Units; the default is –32767.00. The range is –3.402823466e+38 to +3.402823466e+38. Must be less than the MAX SPAN value. MAXSPAN Upper limit for REAL in Engineering Units; the default is 32767.00. The range is –3.402823466e+38 to +3.402823466e+38. Must be greater than the MAX SPAN value. DECPL Decimal places for displaying Real variables. (Corresponds to the Precision property and Min/Max Accuracy field in the Import Wizard.) TriStation 1131 Developer’s Guide, 4.14.0 248 Chapter 2 Application Development Table 29 Exported Tagname File Format (continued) Point Property Description APPLICATN Application flag: C = Control S = Safety SHARED Shared for Read flag: Y = Yes, N = No TRUESTATE Text. For example, True or Zero. FALSESTATE Text. For example, False or Zero. TRUECOLOR Black, Red, Green, Blue, Cyan, Yellow, Pink, and White are allowed. FALSECOLOR Black, Red, Green, Blue, Cyan, Yellow, Pink, and White are allowed. SCALING Scaling flag: if S, real numbers are scaled. N = Non-scaling S = Scaling For more information, see Disable Scaling on page 700. MULTIWRITE Multiple writes enabled flag: Y = Yes, N = No AREA If configured for an alarm, the name of the Area the point is assigned to. EQUIP If configured for an alarm, the name of the LoE the point is assigned to. SIF If configured for an alarm, the name of the SIF the point is assigned to. IOMODULETYPE Reserved for future use. IOPOINTOPTION Reserved for future use. R1 Reserved for future use. R2 Reserved for future use. R3 Reserved for future use. R4 Reserved for future use. TRSTATE Reserved for future use. MINTRTIME Reserved for future use. SOEDEADTIME Reserved for future use. SHORTEDTHLD Reserved for future use. OPENTHLD Reserved for future use. CLAMPENGVAL Reserved for future use. FLDFAULTMON Reserved for future use. MINRAWVAL Reserved for future use. MAXRAWVAL Reserved for future use. MINENGVAL Reserved for future use. MAXENGVAL Reserved for future use. TriStation 1131 Developer’s Guide, 4.14.0 Importing and Exporting Tagnames Table 29 249 Exported Tagname File Format (continued) Point Property Description UNIT Reserved for future use. HARTENABLE Reserved for future use. HARTMONCFGCHG Reserved for future use. HARTMONDEVHLTH Reserved for future use. HARTLOCKCFG Reserved for future use. If you chose to include alarm attribute properties, the exported file also includes the columns described in Table 30: Exported Tagname File Format: Alarm Attributes on page 250. For each attribute, add one of the following prefixes to determine what alarm type the attribute applies to: • LVL = Level Alarm • ROC = Rate of Change Alarm • DEV = Deviation Alarm • TRP = Trip Alarm For example, the ALMENB attribute applies to all alarm types, so the exported file includes all the following columns: • LVLALMENB = Alarm enabled (T or F) for a Level Alarm • DEVALMENB = Alarm enabled (T or F) for a Deviation Alarm • ROCALMENB = Alarm enabled (T or F) for a Rate of Change Alarm • TRPALMENB = Alarm enabled (T or F) for a Trip Alarm Note Only values for configured attributes are exported (for example, if a level alarm has not been configured for the tagname, the level alarm attributes will be blank). Configured attributes are exported regardless of whether or not an alarm is currently enabled. TriStation 1131 Developer’s Guide, 4.14.0 250 Chapter 2 Application Development Table 30 Exported Tagname File Format: Alarm Attributes Point Property Description Applicable Alarm Types LOLOALM Low Low Limit value LVL, DEV, ROC LOWALM Low Limit value LVL, DEV, ROC HIALM High Limit value LVL, DEV, ROC HIHIALM High High Limit value LVL, DEV, ROC LOLSVTY Low Low Severity value LVL, DEV, ROC LOSVTY Low Severity value LVL, DEV, ROC HISVTY High Severity value LVL, DEV, ROC HIHSVTY High High Severity value LVL, DEV, ROC AUTRST Automatic Reset LVL, DEV, ROC, TRP BYPREQ Bypass Request LVL, DEV, ROC DSBLREQ Disable Request LVL, DEV, ROC, TRP RNGBCK Ringback LVL, DEV, ROC, TRP DEADBND Deadband LVL, DEV, ROC TIMDLY Time Delay LVL, DEV, ROC, TRP ALMSTAT Alarm Status LVL, DEV, ROC, TRP ALMENB Alarm enabled, True or False LVL, DEV, ROC, TRP ALMFB Alarm function block name LVL, DEV, ROC, TRP UNBYPREQ Unbypass Request LVL, DEV, ROC BYP Bypass LVL, DEV, ROC, TRP SHIFTREQ Shift Change Request LVL, DEV, ROC, TRP CMDIN Command In LVL, DEV, ROC, TRP CMDIDIN Command ID LVL, DEV, ROC, TRP CMDACPTIN Command Accepted LVL, DEV, ROC, TRP CMDIDCFG ID LVL, DEV, ROC, TRP FIRSTOUT First Out LVL, DEV, ROC, TRP SRCIDCFG Source ID LVL, DEV, ROC, TRP ACTIVE Active LVL, DEV, ROC, TRP LLACTIVE Low Low Active LVL, DEV, ROC LACTIVE Low Active LVL, DEV, ROC HACTIVE High Active LVL, DEV, ROC HHACTIVE High High Active LVL, DEV, ROC ALMSTPT Setpoint DEV TriStation 1131 Developer’s Guide, 4.14.0 Importing and Exporting Tagnames Table 30 251 Exported Tagname File Format: Alarm Attributes (continued) Point Property Description Applicable Alarm Types NMLSTAT Trip Level TRP SVRTY Trip Severity TRP BYPSREQ Bypass Request TRP DSBLREQ Disable Request TRP Preparing an Excel File for Import This procedure explains how to prepare a Microsoft Excel file if you created the file from scratch or renamed a previously exported file. This procedure does not have to be performed if you exported tagnames to an Excel file, modified the contents, but did not change the file name. Procedure 1 Open an Excel file that contains tagname data. 2 Ensure the data is formatted as follows: • All cells must have the Format setting as Text. • The Tagname, Data Type, and Point Type cells are required. • The values in these cells must be numeric and must begin with a single quotation mark (’): Alias Number, Initial Value, Chassis, Slot, Point, Min Span, Max Span, and Display Precision. 3 Select the range of data cells to be included by selecting the headings and cells. Do not select empty records. 4 On the Insert menu, click Name, then Define. 5 In the Define Name dialog box, enter the new name (in this example, NewTagnames) in the text box, and then click Add. 6 Select the names to delete (in this example, tagnames), click Delete, and then click OK. Ensure the Refers to range reference at the bottom of the screen includes information. If it is blank, repeat step 3 through step 6. TriStation 1131 Developer’s Guide, 4.14.0 252 Chapter 2 Application Development 7 To verify the table name was created, click the Name Box list box. Name Box All the records (columns and rows) should be highlighted. If not, repeat steps 4 and 5. 8 Save the file. The file is ready to be imported. File Format Requirements for Tagname Import This section describes the requirements for database or text files with tagnames to be imported into a TriStation 1131 project. Note You cannot delete existing tagname information by importing a database or text file with blank fields where the existing data resides. Importing a file only updates or creates tagname data. Blank fields for existing tagnames are ignored, so that any existing information will remain as-is. Blank fields may be imported for new tagnames only; see the following table for instructions. However, you can create a “blank” field for an existing tagname by typing spaces to replace the existing data. The field will then appear blank. After the import is complete, you can remove the spaces from the field to create a true blank field by editing the tagname’s properties; see Renaming Tagnames on page 224. Table 31 General File Requirements Item Database File Text File Filename Must be 8 characters or less. Must be 8 characters or less. Table or Lines Each row must contain columns mapped to these point properties: Must have a consistent format; the same number of fields in each line. • Tag Name • Data Type • Point Type Each line must contain fields mapped to these point properties: • Tag Name • Data Type • Point Type TriStation 1131 Developer’s Guide, 4.14.0 Importing and Exporting Tagnames Table 31 253 General File Requirements (continued) Item Database File Text File Columns or Fields Can include more columns than the number of fields to be imported, but no more than one column can be mapped to each point property. Column headings can be any name. Must be delimited by commas with no spaces before or after. Blank numeric fields and blank string fields are allowed for new tagnames only (in .DBF or .XLS files). Can include more than 22 fields, but only 22 fields can be mapped. Blank fields (for new tagnames only) must be represented as follows: • For a blank numeric field, use two commas with no spaces between. • For a blank string field, use two quotation marks with no spaces between. Table 32 Import Data Requirements Point Property Description TAGNAME The tagname for the point. Must be 31 characters or less to be a valid IEC 61131-3 identifier. Can be any string of letters, digits, and underscores provided that the first character is not a digit and there are not two or more underscore characters together. DESCRIP The description for the point; cannot be more than 131 characters. GROUP1 The Group1 description; cannot be more than 63 characters. GROUP2 The Group2 description; cannot be more than 63 characters. ALIASTYPE The alias type for the point: U = Unaliased R = Read-Only aliased W = Read/Write aliased ALIASNUM The alias number for the point. • For Tricon: —If you exported Legacy alias numbers, from 0 to 42000. —If you exported Extended alias numbers, from 0 to 422048. For more information about the Legacy and Extended alias ranges, see Alias Number on page 657. • For Trident or Tri-GP, from 0 to 49999. Note: When a Default alias number is imported, it is changed to a User alias number upon import, because once an alias number is assigned, it can only be changed by you, the user. This property can only be updated for existing tagnames in Trident or Tri-GP projects. For existing tagnames in Tricon projects, this property cannot be updated. TriStation 1131 Developer’s Guide, 4.14.0 254 Chapter 2 Application Development Table 32 Import Data Requirements (continued) Point Property Description DATATYPE The data type: D = Discrete (BOOL) I = Integer (DINT) R = Real (REAL) POINTTYPE The point type: I = Input O = Output M = Memory INITVALUE The initial value: For BOOL, True or False For DINT, an integer value For REAL, a real value RETENTIVE Retentive flag: if R, the value is retained if a power outage shuts down the controller. N = Non-retentive R = Retentive IOP IOP number (1) (Trident or Tri-GP) SLOT Slot number (1 - 63) (Trident or Tri-GP) POINT Point number (1 - 32) (Trident or Tri-GP) CHASSIS Chassis number (0 - 15) (Tricon) SLOT Slot number (0 - 8) (Tricon) POINT Point number (0 - 64) (Tricon) MINSPAN The lower limit for REAL in Engineering Units; the default is –32767.00. The range is –3.402823466e+38 to +3.402823466e+38. Must be less than the MAX SPAN value. MAXSPAN Upper limit for REAL in Engineering Units; the default is 32767.00. The range is –3.402823466e+38 to +3.402823466e+38. Must be greater than the MAX SPAN value. DECPL Decimal places to display MIN SPAN and MAX SPAN properties. Limited to 125 digits. REAL values are set to 1. BOOL and DINT values are set to 0. APPLICATN Application flag: C = Control S = Safety SHARED Shared for Read flag: Y = Yes, N = No TriStation 1131 Developer’s Guide, 4.14.0 Importing and Exporting Tagnames Table 32 255 Import Data Requirements (continued) Point Property Description TRUESTATE Text. For example, True or Zero. FALSESTATE Text. For example, False or Zero. TRUECOLOR Black, Red, Green, Blue, Cyan, Yellow, Pink, and White are allowed. FALSECOLOR Black, Red, Green, Blue, Cyan, Yellow, Pink, and White are allowed. SCALING Scaling flag: if S, real numbers are scaled. N = Non-scaling S = Scaling For more information, see Disable Scaling on page 700. MULTIWRITE Multiple writes enabled flag: Y = Yes, N = No AREA If configured for an alarm, the name of the area the point is assigned to. Cannot be more than 31 characters. EQUIP If configured for an alarm, the name of the LoE the point is assigned to. Cannot be more than 31 characters. SIF If configured for an alarm, the name of the SIF the point is assigned to. Cannot be more than 31 characters. Alarm Attributes All alarm attributes must be 31 characters or less. If a tagname is assigned to an attribute, it must be of the appropriate data type for the selected attribute, and it must already exist either in the project, or in the import file. For more information on each attribute, see Table 33: Import Data Requirements: Alarm Attributes on page 256. IOMODULETYPE Reserved for future use. IOPOINTOPTION Reserved for future use. R1 Reserved for future use. R2 Reserved for future use. R3 Reserved for future use. R4 Reserved for future use. TRSTATE Reserved for future use. MINTRTIME Reserved for future use. SOEDEADTIME Reserved for future use. SHORTEDTHLD Reserved for future use. OPENTHLD Reserved for future use. CLAMPENGVAL Reserved for future use. FLDFAULTMON Reserved for future use. MINRAWVAL Reserved for future use. MAXRAWVAL Reserved for future use. TriStation 1131 Developer’s Guide, 4.14.0 256 Chapter 2 Application Development Table 32 Import Data Requirements (continued) Point Property Description MINENGVAL Reserved for future use. MAXENGVAL Reserved for future use. UNIT Reserved for future use. HARTENABLE Reserved for future use. HARTMONCFGCHG Reserved for future use. HARTMONDEVHLTH Reserved for future use. HARTLOCKCFG Reserved for future use. Table 33 Import Data Requirements: Alarm Attributes Point Property Description LOLOALM Can be a literal value or a tagname. If tagname, data type must be DINT or REAL. LOWALM Can be a literal value or a tagname. If tagname, data type must be DINT or REAL. HIALM Can be a literal value or a tagname. If tagname, data type must be DINT or REAL. HIHIALM Can be a literal value or a tagname. If tagname, data type must be DINT or REAL. LOLSVTY Can be a literal value or a tagname. If tagname, data type must be DINT. LOSVTY Can be a literal value or a tagname. If tagname, data type must be DINT. HISVTY Can be a literal value or a tagname. If tagname, data type must be DINT. HIHSVTY Can be a literal value or a tagname. If tagname, data type must be DINT. AUTRST Can be a literal value or a tagname. • If literal value, must be TRUE, FALSE, 0, or 1. • If tagname, data type must be BOOL. BYPREQ Can be a literal value or a tagname. • If literal value, must be TRUE, FALSE, 0, or 1. • If tagname, data type must be BOOL. DSBLREQ Can be a literal value or a tagname. • If literal value, must be TRUE, FALSE, 0, or 1. • If tagname, data type must be BOOL. RNGBCK Can be a literal value or a tagname. • If literal value, must be TRUE, FALSE, 0, or 1. • If tagname, data type must be BOOL. DEADBND Can be a literal value or a tagname. If tagname, data type must be DINT or REAL. TriStation 1131 Developer’s Guide, 4.14.0 Importing and Exporting Tagnames Table 33 257 Import Data Requirements: Alarm Attributes (continued) Point Property Description TIMDLY Must be a literal value in the TIME format. ALMSTAT Must be a tagname with data type DINT. ALMENB Must be a literal value: TRUE, FALSE, 0, or 1. ALMFB Name of the alarm function block; created by import process. Default is <Tagname>_<AlarmType>. For example, if tagname is Tag1, and alarm type is Level, the generated function block name is Tag1_LvlAlm. If tagname is greater than 23 characters, the name is truncated to 23 characters. UNBYPREQ Can be a literal value or a tagname. • If literal value, must be TRUE, FALSE, 0, or 1. • If tagname, data type must be BOOL. BYP Can be a literal value or a tagname. • If literal value, must be TRUE, FALSE, 0, or 1. • If tagname, data type must be BOOL. SHIFTREQ Can be a literal value or a tagname. • If literal value, must be TRUE, FALSE, 0, or 1. • If tagname, data type must be BOOL. CMDIN Can be a literal value or a tagname. If tagname, data type must be DINT. CMDIDIN Can be a literal value or a tagname. If tagname, data type must be DINT. CMDACPTIN Must be a tagname with data type BOOL. CMDIDCFG Can be a literal value or a tagname. If tagname, data type must be DINT. FIRSTOUT Must be a tagname with data type DINT. SRCIDCFG Must be a literal value. ACTIVE Must be a tagname with data type BOOL. LLACTIVE Must be a tagname with data type BOOL. LACTIVE Must be a tagname with data type BOOL. HACTIVE Must be a tagname with data type BOOL. HHACTIVE Must be a tagname with data type BOOL. ALMSTPT (Deviation alarms only) Can be a literal value or a tagname. If tagname, data type must be DINT or REAL. NMLSTAT (Trip alarms only) Can be a literal value or a tagname. • If literal value, must be TRUE, FALSE, 0, or 1. • If tagname, data type must be BOOL. SVRTY (Trip alarms only) Can be a literal value or a tagname. If tagname, data type must be DINT. TriStation 1131 Developer’s Guide, 4.14.0 258 Chapter 2 Application Development Table 33 Import Data Requirements: Alarm Attributes (continued) Point Property Description BYPSREQ (Trip alarms only) Can be a literal value or a tagname. • If literal value, must be TRUE, FALSE, 0, or 1. • If tagname, data type must be BOOL. DSBLREQ (Trip alarms only) Can be a literal value or a tagname. • If literal value, must be TRUE, FALSE, 0, or 1. • If tagname, data type must be BOOL. TriStation 1131 Developer’s Guide, 4.14.0 Importing and Exporting Tagnames 259 Import Options and Validation Criteria When importing tagname information from a database or file, you can specify whether to update, add, or update and add new tagnames. Adding New Points If the imported tagname includes a tagname, tagname type (BOOL, DINT, or REAL), tagname class (input, output, or memory), and alias type (R for Read, W for read/write, or U for no alias), the tagname is imported. If the tagname matches an existing tagname or is invalid in any way, a message is displayed alerting you of the problem or error when the import operation is complete, but the tagname is still imported. Updating Existing Points If the imported tagname matches a tagname, tagname type (BOOL, DINT, or REAL), and tagname class (input, output, or memory), the tagname is updated. All fields can be updated for an existing tagname, except for the following: • TAGNAME (see below) • ALIAS TYPE • DATATYPE • POINTTYPE • CHASSIS • IOP • SLOT • POINT • SCALING • DISPLAY PRECISION If an updated value is invalid in any way, a message is displayed alerting you of the error when the import operation is complete, but the attribute is still changed to the new value. You cannot change the assigned location of a tagname in the controller via the import process. Updating the TAGNAME field for an existing tagname will create a new tagname. The existing tagname will be retained. For example, if you update the TAGNAME field for the tagname Counter1 by changing it to Counter10, after the import process is complete, you will have two tagnames: Counter1 AND Counter10. TriStation 1131 Developer’s Guide, 4.14.0 260 Chapter 2 Application Development Importing Tagname Properties This procedure explains how to import tagname properties from a file. Note When tagnames stored in a Microsoft Excel file or text file are imported into TriStation 1131, the Tagname Editor is automatically updated. Procedure 1 Expand the Application tree, right-click Tagname Declarations, and click Import. Note 2 The project you are importing tagnames into must be in the Download All state. If the project is not in the Download All state, the Import menu option is disabled. Use the Change State to Download All Command on page 672 to change the project state before continuing this procedure. Select one or both of the following check boxes if you want to import the following additional attributes: • To import alarm attribute properties, select Include Alarm Attributes. (For a list of alarm attributes, see Table 33: Import Data Requirements: Alarm Attributes on page 256.) • To import tagnames that have six-digit aliases, select Include Extended Aliases. Available for Tricon 11.2 and later systems only. TriStation 1131 Developer’s Guide, 4.14.0 Importing and Exporting Tagnames 3 261 Click Select Import Data File and go to the folder that contains the file. If the file is not displayed, you may need to change the type of file to match the extension used in the file to be imported. 4 Click the file name and click Select. Click Next to continue. 5 On the Link Data Fields screen, match the source fields to the tagname properties by clicking a field in the list on the left, and a tagname property in the list on the right, and then clicking Link. The following required tagname properties must be linked before continuing: 6 • Data Type • Point Type • Tag Name Once fields and properties are linked, click Next. TriStation 1131 Developer’s Guide, 4.14.0 262 Chapter 2 Application Development 7 On the Select Import Options screen, select options as needed. 8 Click Next to continue. 9 Read the Review Your Request screen. Click Finish to continue, or Back to make changes. TriStation 1131 Developer’s Guide, 4.14.0 Importing and Exporting Tagnames 10 263 Review the status of the records on the Data Import Validation Result screen. • If there are errors, close the screen, edit the data, and then go back to step 1 to import the file again. • If you selected the Validate option on the Select Import Options screen and there are no errors, click Commit Records to import the data. This action cannot be undone. This table describes the status of the imported records. Status Description Ignored The import record is mapped to an existing point that has the same properties, so the import record is being ignored. Added A new record is being added to the configuration. Error The import record has been rejected due to one or more errors. Updated The import record is updating properties of an existing point. TriStation 1131 Developer’s Guide, 4.14.0 264 Chapter 2 Application Development Annotations and Comments This section describes how to use annotations and comments in an FBD or LD program or function. Topics include: • Adding Annotations on page 264 • Specifying Annotation Properties on page 266 • Adding a Comment on page 267 • Specifying Comment Style on page 268 • Picking and Dropping Elements for Comments on page 269 • Editing Comment Fields on page 270 • Using Macros with Annotations and Comments on page 270 • Editing Macro Text on page 272 Adding Annotations This procedure explains how to add an annotation to a constant, tagname, or variable. Annotations can be used to display descriptive text, including information specified in system and user-modifiable macros. You can also display the value of a variable during program execution in the Emulator or controller. To have annotations automatically included for all new elements, see Specifying Annotation Options on page 43 and Using Macros with Annotations and Comments on page 270. Procedure 1 Expand the Application tree, and open an FBD or LD program or function. 2 Double-click the graphic for a constant, tagname, or variable. The Item Properties dialog box appears. 3 Select the Annotate check box. For constants, the check box is on the Constant tab. For tagname references and variables, the check box is on the Variable tab. 4 Click the Annotation tab. TriStation 1131 Developer’s Guide, 4.14.0 Annotations and Comments 5 To add text, enter the text in the annotation area. 6 To add a macro: 7 265 • Click Macros. The Edit Macros dialog box appears. • Select a macro to be added. To change the value of a macro identified by a pencil icon, double-click the macro, enter the value, and click OK. • With the macro selected, press Ctrl+C to copy the macro. • Click OK to close the Edit Macros dialog box. • Click in the annotation area, and press Ctrl+V to paste the macro. For variables, select the Include Monitor Value in Annotation check box to display the value of the variable in the Controller or Emulator Panel. TriStation 1131 Developer’s Guide, 4.14.0 266 Chapter 2 Application Development Specifying Annotation Properties This procedure explains how to specify text and macros to be included with an annotation. Procedure 1 Expand the Application tree, and open an FBD or LD program or function. 2 On the logic sheet, double-click an annotation. The Item Properties dialog box appears, with the Annotation tab selected. 3 Specify these properties on the Annotation tab. Property Action Annotation Text Enter the text and/or macros to be used in the annotation. Include Monitor Value in Annotation Select the check box to display the value of the variable in the annotation when the element is run on the controller or Emulator. Macros Command Click to add macros to the annotation. See Using Macros with Annotations and Comments on page 270. TriStation 1131 Developer’s Guide, 4.14.0 Annotations and Comments 267 Adding a Comment This procedure explains how to add comment text in FBD and LD programs. Comments are used to add information about operations performed by a program, function, or function block. There is no limitation on the number of comment boxes per program or their placement on a logic sheet. If you draw a comment box around a project element it is ignored when you compile the element. Procedure 1 Expand the Application tree, and open an FBD or LD program or function. 2 On the toolbar, click the icon for comments 3 On the logic sheet, click and drag to create the comment box. 4 Double-click the comment box to display the Comment properties. 5 Specify these properties on the Comment tab. . Property Action Comment Text Enter the text to be included as a comment. Can include text and macros. Alignment Select how to align the text. The default is left. Text Size Select the point size for the text; from 3 to 24 points. Border Select whether to include a border around an annotation or comment box.The default is single. Macros Command Click to view macros that can be included with the comment text. To copy, click the macro and press Ctrl + C. To paste, return to the Comment tab and press Ctrl + V. TriStation 1131 Developer’s Guide, 4.14.0 268 Chapter 2 Application Development Specifying Comment Style This procedure explains how to specify style features used with comments. Procedure 1 Expand the Application tree, and open an FBD or LD program or function. 2 Double-click a comment, and then click the Style tab. 3 Specify these properties on the Style tab. Property Action Expand Macros Select this check box to display the value of the macro when the application is run on the Emulator or controller. For example, if expanded, the macro %DATE_CREATED displays the month, day, and year when the project was created. The default is cleared. Enable Macro Editing Select this check box to list the user-modifiable macros on the Edit Fields tab, which allows you to edit the value for the macro. The default is cleared. Move Behind Logic Elements Select this check box to move the selected comment box behind a logic element. This affects the appearance of the logic sheet only; it does not affect the execution of the logic element. Move the comment box to the desired position before selecting this option. Once this option is selected, the comment box cannot be moved. To move the comment box after this option has been selected, double-click the comment box to access the Properties dialog box, and then clear this option. The default is cleared. TriStation 1131 Developer’s Guide, 4.14.0 Annotations and Comments 269 Picking and Dropping Elements for Comments This procedure explains how to pick up and drop elements from a comment box. Elements in comment boxes are ignored when you compile the program. You can also remove captured elements from a comment by selecting the comment and dropping the elements back onto the logic sheet. This is useful for isolating logic during testing or troubleshooting. Note To use the Pickup and Drop commands, the Move Behind Logic Elements option cannot be selected. For more information about this option, see Specifying Comment Style on page 268. Procedure 1 Expand the Application tree, and open an FBD or LD program or function. 2 Double-click a comment, and then click the Pickup/Drop tab. 3 Specify these commands on the Pickup/Drop tab. Command Action Pickup Command To pick up elements to include in the comment, click and drag the comment box so it entirely covers the elements to be captured. Double-click the comment, click the Pickup/Drop tab, and then click Pickup. Drop Command To remove elements from the comment, double-click the comment box, click the Pickup/Drop tab, then click Drop. TriStation 1131 Developer’s Guide, 4.14.0 270 Chapter 2 Application Development Editing Comment Fields This procedure explains how to modify the comment text if the comment includes a macro that can be edited and the macro is enabled for editing. Procedure 1 Expand the Application tree, and open an FBD or LD program or function. 2 Double-click a comment, and then click the Edit Fields tab. 3 Select a field and then click Modify. 4 Change the text used for the macro. 5 Click OK to save the change. Using Macros with Annotations and Comments This procedure explains how to use macros in an annotation or comment. Macros are placeholders for text or information supplied by the system or by you. The value is displayed when the element is run on the controller or Emulator. Macros can be used only in FBD and LD development. There are two types of macros: • System macros are values supplied by the system and cannot be changed. For example, the %CREATED_ BY macro includes the user ID of the person who created the element. You cannot change values for these macros. • User-modifiable macros, identified by a pencil icon , are values you can specify. For example, the %APPROVED_NAME macro can include any name you enter. CAUTION When you change the value of a macro, you change it for ALL annotations and comments in the project that use the macro. TriStation 1131 Developer’s Guide, 4.14.0 Annotations and Comments 271 Procedure 1 Expand the Application tree, and open an FBD or LD program or function. 2 Do either of these: • For a comment, double-click the comment, and click the Macros button. • Double-click a variable or tagname reference. Click the Annotation tab, then click the Macros button. 3 If needed, select the check boxes for project, document, or sheet to view the macros available for those elements. 4 Do any of the following: • To change the value of a user-modifiable macro, identified by a pencil icon select the macro, click Modify and then make the change. • To copy a macro to an annotation or comment, select the macro and copy it by pressing Ctrl+C. , 5 Click OK to close the Edit Macros dialog box. You are returned to the Item Properties dialog box. 6 To add the copied macro to the annotation or comment, click inside the text area and paste the macro by pressing Ctrl+V. TriStation 1131 Developer’s Guide, 4.14.0 272 Chapter 2 Application Development Editing Macro Text This procedure explains how to edit text associated with a macro. You can include text and macros that supply information from the system. Procedure 1 Expand the Application tree, and open an FBD or LD program or function. 2 Double-click a comment, constant, tagname, or variable. The Item Properties dialog box appears. 3 Click the Edit Fields tab, select the field to be changed, and then click Modify. 4 Enter the text to be used when the macro is displayed. 5 Click OK to save. TriStation 1131 Developer’s Guide, 4.14.0 Modbus Applications 273 Modbus Applications This section describes information related to developing a Modbus application. Modbus is an industry-standard master/slave communication protocol that is traditionally used for energy management, transfer line control, pipeline monitoring, and other industrial processes. For more information on using Modbus functionality in your application, see the Communication Guide for your controller. Tricon Functionality A Tricon controller with an EICM, TCM, or UCM can operate as a Modbus master, slave, or both. A DCS typically acts as the master, while the Tricon controller acts as a slave. The master can also be an operator workstation or other device that is programmed to support Modbus devices. The Tricon controller has serial ports on the EICM, and network and serial ports on the TCM and UCM that provide options for communication with Modbus devices. Each serial port can operate in a point-to-point configuration with a single Modbus device, or in a multi-point configuration with several Modbus devices connected to a serial link. Trident and Tri-GP Functionality The Trident and Tri-GP controllers have serial ports on the CM, CIM, and MP that provide options for communication with a Modbus devices. Each CM, CIM, and MP port can operate in a point-to-point configuration with a single Modbus device. In addition, each CM and CIM port can operate in a multi-point configuration with several Modbus devices connected to a serial link. Topics include: • Assigning Alias Numbers to Tagnames on page 274 • How Tricon Transmits REAL Values With Special Alias Numbers on page 276 • Tricon Special Alias Numbers on page 277 • How REAL Numbers are Scaled to Integers on page 278 • Scaling REAL Values to Integers on page 280 • How Trident and Tri-GP REAL Values are Transmitted Without Scaling on page 282 • Disabling Scaling of REAL Values for Trident and Tri-GP Tagnames on page 283 TriStation 1131 Developer’s Guide, 4.14.0 274 Chapter 2 Application Development Assigning Alias Numbers to Tagnames This procedure explains how to assign an alias number for input, output, and memory points. For more information on alias numbers, see Alias Number on page 657. Note Using the Print All command, you can print a report listing Modbus alias information for each tagname in the project (Tagnames: Modbus Aliases). See Printing Project Documents on page 109. Procedure 1 Open the Tagname Editor. 2 Click the Point Assignment tab, and locate the required tagname. 3 Click each box to specify these properties. Property Action Alias Type For memory points, specify either Read or Read/Write. (Input and output points can only be of type Read.) Enable Multiple Writes Select the check box to allow the point to be written to multiple times in a scan. The default is cleared. Alias Number Selection Enter the alias number assignment. The alias number can be user-specified (within the range), or systemspecified based on a default range. The default is Default alias. See Important Information About Alias Numbers on page 205 for additional information about assigning alias numbers. Legacy User Alias Specify an alias number within the five-digit range. For information on alias ranges, see Alias Number on page 657. Enabled only if you selected Legacy User Alias in the Alias Number Selection list. Note TriStation 1131 Developer’s Guide, 4.14.0 The six-digit equivalent of the Legacy alias is displayed in the Extended User Alias box, which is not editable. See Table 52: Legacy Range Alias Number Information on page 657 for the mapping between five-digit and six-digit aliases. Modbus Applications Property Action Extended User Alias Specify an alias number within the six-digit Extended range. Applies only to Tricon 11.2 and later systems with only TCMs installed (but not UCMs or SMMs). For information on alias ranges, see Alias Number on page 657. 275 Enabled only if you selected Extended User Alias in the Alias Number Selection list. Note Location You can also specify a six-digit alias number within the Legacy range. The five-digit equivalent is displayed in the Legacy User Alias box, which is not editable. See Table 52: Legacy Range Alias Number Information on page 657 for the mapping between five-digit and six-digit aliases. For input and output points, the physical address must be specified before an alias number can be assigned. Enter the number representing the Physical Address, or click the Browse button . In the Browse Available Points dialog box, select the module, and then click the point to be assigned. For more information, see the note in Procedure for Input and Output Points on page 206. Note When you select Default alias as the alias number for memory point tagnames, these aliases can be automatically re-assigned under certain circumstances. For example, if another tagname using the Default alias setting is deleted, the next time you build the application, TriStation 1131 will re-use the alias number of the deleted tagname. You can avoid this behavior by always using the User alias setting to define your own alias numbers and keep control of assigned aliases. 4 To save your changes, click the next row, or click the Commit Change button . To cancel your changes, right-click the row that you edited, and click Undo. TriStation 1131 Developer’s Guide, 4.14.0 276 Chapter 2 Application Development How Tricon Transmits REAL Values With Special Alias Numbers This section explains how the Tricon controller transmits REAL values for tagnames by using special alias numbers which map one 32-bit REAL value into two 16-bit Modbus integers. One Modbus integer is mapped to the 16 most significant bits and the other Modbus integer is mapped to the 16 least significant bits in the REAL number. The Modbus master can also read and write values by using a scaled value in an alias number. Reading REAL Values This figure shows a Modbus master reading a REAL value from two consecutive special aliases which correspond to a REAL alias. The Tricon controller splits the 32-bit REAL value into two 16-bit integers and places them in the special aliases to be read by the Modbus master. Figure 20 Modbus Master Reading REAL Values from the Tricon Controller Writing REAL Values This figure shows a Modbus master writing a REAL value to the Tricon controller by transmitting two 16-bit integer values to two consecutive special aliases. The controller concatenates the two 16-bit integers to form a 32-bit REAL value. Figure 21 Modbus Master Writing REAL Values to the Tricon Controller TriStation 1131 Developer’s Guide, 4.14.0 Modbus Applications 277 Tricon Special Alias Numbers This table lists the special alias numbers for Tricon controllers, used for read and write operations with REAL tagnames. For TCMs and UCMs, the First 16-bits and the Second 16-bits columns refer to either the most significant or least significant bits respectively, depending on how the communication module is configured. Table 34 Special Alias Numbers for Tricon Controllers Tricon 11.2 and Later (With TCMs Only) Tricon 11.2 and Earlier Aliases Variable Type Input REAL, Read Only Memory REAL, Read Only Memory REAL, Read/Write Special Aliases (5 Digits) First 16-bits Second 16-bits 32001 34001 34002 32002 34003 34004 . . . . . . . . . 32120 34239 34240 33001 35001 33002 Aliases First 16-bits Second 16-bits - or - 44001 44002 - or - 44003 Special Aliases (6 Digits) First 16-bits Second 16-bits 330001 340001 340002 44004 330002 340003 340004 . . . . . . . . . . . . . . . - or - 44239 44240 338192 356383 356384 35002 - or - 45001 45002 325001 357000 357001 35003 35004 - or - 45003 45004 325002 357002 357003 . . . . . . . . . . . . . . . . . . . . . . . . 34000 36999 37000 46999 47000 329096 365191 365192 41001 42001 42002 — — 420001 430001 430002 41002 42003 42004 — — 420002 430003 430004 . . . . . . . . . . . . . . . . . . 42000 43999 44000 424096 438191 438192 . . . . . . - or - — — TriStation 1131 Developer’s Guide, 4.14.0 278 Chapter 2 Application Development How REAL Numbers are Scaled to Integers This section explains how 32-bit REAL scaled numbers are transmitted in Modbus protocol, which uses 16-bit integers. If a REAL value is scaled, these operations occur: • When a Modbus master writes a 16-bit integer to a Triconex slave, the controller scales the integer to a 32-bit REAL number before using it in the TriStation 1131 application. • When a Modbus master reads a 32-bit REAL variable from a Triconex slave, the controller scales the REAL variable to a 16-bit integer before transmitting it. Scaled REAL numbers use a formula that includes the value of the tagname, the Minimum Value (Min Span) and Maximum Value (Max Span) for the tagname, and the Modbus minimum (Modbus Min) and maximum (Modbus Max) range set for the Modbus Range property. Scaling Integer Values to REAL Values This figure shows how a Modbus master writes an integer value to the Triconex controller, where it is scaled to a REAL value. Figure 22 How Triconex Controller Scales a Integer Value to a REAL Value Scaling an integer to a REAL value uses this formula: (MaxSpan – MinSpan) Real Value = ------------------------------------------------------------------------- × (Modbus Value – Modbus Min) + Minspan (Modbus Max – Modbus Min) This figure shows how scaling is done. Values above the Max Span or below the Min Span are clamped to the respective limit. The same principle applies to values outside the Modbus range. TriStation 1131 Developer’s Guide, 4.14.0 Modbus Applications Figure 23 279 Scaling an Integer Value to a REAL Value To avoid division by zero, do not set Modbus Max equal to Modbus Min—the REAL value result is undefined. For the Trident, Tri-GP, or Tricon 9.6 and later controllers, the result is one of the floating point standard special numbers: NAN (not a number: -1.#IND) or infinity (1.#INF). Scaling REAL Values to Integer Values This figure shows how a Modbus master reads a REAL value which has been scaled to an integer. Figure 24 How the Modbus Master Reads a REAL Value Scaled to an Integer Value Scaling a REAL value to an integer value uses this formula: (Modbus Max – Modbus Min) Modbus Value = ------------------------------------------------------------------------- × (Real Value – MinSpan) + ModbusMin (Maxspan – MinSpan) This figure shows how scaling is done. Values above the Max Span or below the Min Span are clamped to the respective limit. The same principle applies to values outside the Modbus range. TriStation 1131 Developer’s Guide, 4.14.0 280 Chapter 2 Application Development Figure 25 Scaling a REAL Value to an Integer Value To avoid division by zero, do not set Max Span equal to Min Span—the resulting Modbus value is undefined. Typically, for a Triconex controller, the result is -1. Scaling REAL Values to Integers This procedure explains how to scale a REAL value to an integer. Scaling may be needed to transmit numbers through Modbus protocol, which uses 16-bit integer numbers. Numbers are scaled by using minimum (Min Span) and maximum (Max Span) values for the point and minimum and maximum values for the Modbus Range. Procedure 1 Open the Tagname Editor. 2 Click the Scaling tab, and locate the required tagname. TriStation 1131 Developer’s Guide, 4.14.0 Modbus Applications 3 4 281 Click each box to specify the following properties. Property Action Minimum Value (Min Span) Enter the minimum value to be used to scale the REAL number to an integer; must be less than the maximum value. The default is -32768.0. Maximum Value (Max Span) Enter the maximum value to be used to scale the REAL number to an integer; must be more than the minimum value. The default is 32767.0. Precision Enter the number of decimal points to be used. The default is 1. Disable Scaling (Trident and Tri-GP only) To allow scaling of REAL numbers to integers, do not select this check box. The default is cleared. Scaling cannot be disabled on the Tricon system. To save your changes, click the next row, or click the Commit Change button . To cancel your changes, right-click the row that you edited, and click Undo. 5 In the Setup dialog box for the communication module, specify the Modbus minimum and maximum range. See the following sections for detailed instructions: • Configuring Tricon EICM Ports on page 375 • Configuring TCM Serial Ports on page 381 • Configuring UCM Serial Ports on page 405 • Configuring Trident 1.x MP Network Ports on page 458 • Configuring Trident 1.x CM Serial Ports on page 472 • Configuring Trident or Tri-GP 2.x/3.x CM Serial Ports on page 476 • Configuring Trident or Tri-GP 3.x CIM Serial Ports on page 493 TriStation 1131 Developer’s Guide, 4.14.0 282 Chapter 2 Application Development How Trident and Tri-GP REAL Values are Transmitted Without Scaling This section explains how 32-bit REAL unscaled numbers are transmitted in Modbus protocol, which uses 16-bit integers. This applies only to Trident and Tri-GP controllers. If a REAL value is not scaled, these operations occur: • A Modbus master reads the least significant 16 bits of a 32-bit number which is derived from the integer and decimal parts of a 32-bit REAL value. • A Modbus master writes a REAL value as two consecutive 16-bit integer aliases which the Trident or Tri-GP controller concatenates to form a 32-bit REAL value. • A Modbus slave sends the least significant 16 bits of a 32-bit number. This figure shows the standard format for REAL values, which adheres to the IEE Standard for Binary Floating-Point Arithmetic. For more information, see IEE Std 754-1985. Figure 26 Standard Format for REAL Values TriStation 1131 Developer’s Guide, 4.14.0 Modbus Applications 283 Disabling Scaling of REAL Values for Trident and Tri-GP Tagnames This procedure explains how to disable scaling on a specific REAL tagname. Scaling cannot be disabled for Tricon. The default setting is to use scaling. Procedure 1 Open the Tagname Editor, and locate the REAL tagname you want to disable scaling for. 2 Click the Scaling tab. 3 Select the Disable Scaling check box to ensure the point is not scaled. The default is cleared. 4 To save your changes, click the next row, or click the Commit Change button . To cancel your changes, right-click the row that you edited, and click Undo. TriStation 1131 Developer’s Guide, 4.14.0 284 Chapter 2 Application Development Peer-to-Peer Applications This section explains how to use Standard and Enhanced Peer-to-Peer communication to allow Triconex controllers to send and receive information from each other. Peer-to-Peer communication is performed through Send and Receive function blocks included in the application. Enhanced Peer-to-Peer communication is more robust than Standard Peer-to-Peer communication, with significant performance enhancements and added security through the use of a safer Cyclic Redundancy Check (CRC) algorithm and redundant messaging. Also, while Standard Peer-to-Peer communication only allows for one outstanding send message, Enhanced Peer-to-Peer communication allows for up to three outstanding send messages, resulting in improved overall performance. Enhanced Peer-to-Peer communication is compatible only with Tricon 11.1.x and later TCMs, and the Trident/Tri-GP 3.x CIM, and is not backward compatible with Tricon 11.0.x and earlier TCMs or the CM. The TCM and CIM can support both Standard and Enhanced Peer-to-Peer function blocks. Note You can use both Standard and Enhanced Peer-to-Peer function blocks in the same application. However, Enhanced Peer-to-Peer function blocks can only communicate with other Enhanced Peer-to-Peer function blocks. For example, you cannot pair an Enhanced Send function block with a Standard Receive function block. This table lists the maximum number of Send and Receive Peer-to-Peer (Standard and Enhanced) function blocks that can be configured per controller type. Table 35 Maximum Number of Peer-to-Peer Function Blocks per Controller Typea Maximum Number of Standard Peer-to-Peer Function Blocks Maximum Number of Enhanced Peer-to-Peer Function Blocks Total Number of Peer-to-Peer (Standard plus Enhanced) Function Blocks Allowed Send Function Blocks Receive Function Blocks Send Function Blocks Receive Function Blocks Send Function Blocks Receive Function Blocks Tricon 11.1.x and later 50 50 256 256 256 256 Tricon 11.0.x and earlier 50 50 Not supported Not supported 50 50 Trident and Tri-GP 3.x 99 99 100 100 100 100 Trident 2.x and earlier 50 50 Not supported Not supported 50 50 Tri-GP 2.x 50 50 Not supported Not supported 50 50 Controller Type a. The values specified in this table also refer to the range of the context IDs that can be assigned to supported function blocks. You must be sure to not assign context IDs that exceed the maximum number of supported function blocks for your controller type. TriStation 1131 Developer’s Guide, 4.14.0 Peer-to-Peer Applications Note 285 When you change the target system version from Tricon 11.1.x to Tricon 11.0.x or earlier, the maximum number of Send and Receive function blocks will be automatically changed to 100 in TriStation 1131, if the number configured in the project is greater than 100. For more information on manually changing this number, see Allocating Peer-toPeer Memory on page 288. You will also need to modify your TriStation 1131 project file to include a maximum of only 50 Peer-to-Peer Standard Send and Receive function blocks, and remove any Enhanced Peer-to-Peer function blocks. For information on the Send and Receive function blocks used for Peer-to-Peer communication, see the TriStation 1131 Libraries Reference. For more information about using Peer-to-Peer communication, see the Communication Guide for your controller. Also, if you have one of the following communication modules installed, see: • Tricon TCM: Configuring TCM Peer-To-Peer Ports on page 388 • Tricon UCM: Configuring UCM Peer-To-Peer Ports on page 410 • Trident 2.x/3.x or Tri-GP CM: Configuring Trident or Tri-GP 2.x/3.x CM Peer-To-Peer Ports on page 481 • Trident 3.x or Tri-GP 3.x CIM: Configuring Trident or Tri-GP 3.x CIM Peer-To-Peer Ports on page 498 Topics include: • Peer-to-Peer Data Transfer Time on page 286 • Estimating the Peer-to-Peer Data Transfer Time on page 286 • Allocating Peer-to-Peer Memory on page 288 TriStation 1131 Developer’s Guide, 4.14.0 286 Chapter 2 Application Development Peer-to-Peer Data Transfer Time In a Peer-to-Peer application, data transfer time includes the time required to initiate a send operation, send the message over the network, and have the message read by the receiving node. Additional time (at least two scans) is required for a sending node to get an acknowledgment from the MPs that the message has been acted on. These time periods are a function of the following parameters of the sending and receiving controllers: • Scan time • Configuration size • Number of bytes for aliased variables • Number of Send function blocks, Receive function blocks, printing function blocks, and Modbus master function blocks • Number of controllers on the Peer-to-Peer network Send function blocks require multiple scans to transfer data from the sending controller to the receiving controller. The number of send operations initiated in a scan is limited to five. The number of pending send operations is limited to 10. A typical data transfer time (based on a typical scan time) is 1 to 2 seconds, and the time-out limit for a Peer-to-Peer send (including three retries) is 5 seconds. Consequently, the processtolerance time of the receiving controller must be greater than 5 seconds. Process-tolerance time is the maximum length of time that can elapse before your control algorithms fail to operate correctly. If these limitations are not acceptable, further analysis of your process is required. Estimating the Peer-to-Peer Data Transfer Time This procedure explains how to estimate the Peer-to-Peer data transfer time between a pair of Triconex controllers. The more memory allocated for aliased points, the slower the transfer time. Procedure 1 On the sending controller, expand the Controller tree, and double-click Configuration. On the Configuration tree, click Memory Allocation. 2 Find the bytes allocated for BOOL, DINT, and REAL points: 3 • On the Configuration tree, click Memory Points, Input Points, or Output Points. Double-click the graphic for the point type. • Add the number of bytes allocated for all BOOL input, output, and aliased memory points. Enter the number in step 1 of the following worksheet. Do the same for DINT and REAL points and enter the results in step 1. On the receiving controller, get the BOOL, DINT, and REAL points and enter the numbers in step 3. Follow the instructions on the following worksheet to estimate the transfer time. TriStation 1131 Developer’s Guide, 4.14.0 Peer-to-Peer Applications Steps 1. Enter the number of bytes for each point type on the sending controller and divide or multiply as indicated. Add the results. Point Type Allocated Bytes Operation BOOL _________ ÷8= _________ DINT _________ x4= _________ REAL _________ x4= _________ Total bytes of aliased points TBS = Result _________ 2. Multiply the total bytes sending (TBS) from step 1 by 0.005 TS = _________ 3. Enter the number of bytes for each point type on the receiving controller and divide or multiply as indicated. Add the results. BOOL _________ ÷8= _________ DINT _________ x4= _________ REAL _________ x4= _________ Total bytes of aliased points TBR = 4. Multiply the total bytes receiving (TBR) from step 3 by 0.005 TR = 5. Get the scan time of the sending node in milliseconds by viewing the Scan Time in the Execution List. SS = 6. Get the scan time of the receiving node in milliseconds by viewing the Scan Period in the Execution List. SR = _________ _________ _________ _________ 7. Multiply the sum of TS and SS by 2. _________ 8. Multiply the sum of TR and SR by 2. _________ 9. Add the results of step 7 and 8 to get the data transfer time DT= 10. Do one of the following: 287 _________ _________ • If the number of pending send requests in the application is greater than 10, divide the number of send requests by 10. Round the answer up to the next integer value (for example, 12/10 = 2 and 27/10 = 3). • If the number of pending send requests in the application is less than 10, enter 1 in the Result column. 11. Multiply the results of steps 9 and 10 to get the adjusted data transfer time. Adjusted DT= _________ 12. Compare the adjusted DT to the process-tolerance time to determine if it is acceptable. TriStation 1131 Developer’s Guide, 4.14.0 288 Chapter 2 Application Development Allocating Peer-to-Peer Memory This procedure explains how to allocate memory for Standard and Enhanced Peer-to-Peer functions, which is based on the maximum number of Send and Receive numbers you specify. To save memory and minimize scan time, you should use the lowest possible numbers. Note When you build the application, TriStation 1131 calculates how many Peer-to-Peer Sends and Receives are being used. During the Download All operation, TriStation 1131 adds 20% to this calculation to determine the number of Sends and Receives to be configured. (For example, if 10 Sends and 10 Receives are being used, TriStation 1131 will configure 12 Sends and 12 Receives.) If you anticipate that additional Sends and Receives will be needed in the future, you may want to increase the maximum value before downloading to the controller, to avoid having to perform another Download All operation at a later date. The maximum number does not have to be the same for Sends and Receives. For example, a TriStation 1131 application might need to send messages to three applications, but need to receive messages from only one application. The maximum number of Sends and Receives allowed is dependent upon the controller type being used. For a detailed description, see Table 35: Maximum Number of Peer-to-Peer Function Blocks per Controller Type on page 284. In Tricon 11.1 and earlier systems, a change in Peer-to-Peer allocation requires a Download All (see Using the Download All Command on page 649). In Tricon 11.2 and later systems, you can make changes to Peer-to-Peer allocation while your project is in the Download Changes state. However, to do so, you MUST first complete any changes that you previously made to the SOE configuration or memory allocation for I/O points, by performing a Download Changes operation after each of these changes. If these changes are pending, the Peer-to-Peer allocation properties will be unavailable. For more information on the Download Changes state, see Using the Download Changes Command on page 646. Procedure 1 Expand the Application tree, double-click Implementation, and then click Peer-to-Peer Configuration. 2 Set these properties by clicking the up and down arrows. TriStation 1131 Developer’s Guide, 4.14.0 Peer-to-Peer Applications • Maximum Number of Peer-to-Peer Sends • Maximum Number of Peer-to-Peer Receives Note 3 289 In Tricon 11.2 and later systems, when your project is in the Download Changes state, you can only increase these values from the last downloaded values. If you want to decrease the values, you must change the project state to Download All. See Change State to Download All Command on page 672 for important information about the impact of changing the project state. If you want to change the settings for an application running on the controller, you must build the application, an then do one of the following: • For a Tricon 11.1 and earlier system, perform a Download All operation. • For a Tricon 11.2 and later system, perform a Download Changes operation. TriStation 1131 Developer’s Guide, 4.14.0 290 Chapter 2 Application Development SOE Development This section explains how to enable sequence of events collection in a project. Events can be retrieved from a Triconex controller by using the Triconex SOE Recorder software, or by using a third-party OPC client to subscribe to the TCM’s or CIM’s embedded OPC server. For more information, see the Triconex SOE Recorder User’s Guide and the Communication Guide for your controller. Topics include: • Displaying the SOE Configuration on page 290 • Defining SOE Block Properties on page 291 • Assigning Tagnames to SOE Blocks on page 296 • Specifying a Trip Variable on page 298 Displaying the SOE Configuration This procedure explains how to view the SOE Configuration screen, which displays the SOE blocks that have been configured. Procedure 1 Expand the Application tree, double-click Implementation, and click SOE Configuration. 2 Do any of the following: • To sort by SOE block number or tagname, click on the corresponding list header. • To search for a tagname in the list, on the Edit menu, select Find, and then enter the name (or partial name) of the tagname you want to find. TriStation 1131 Developer’s Guide, 4.14.0 SOE Development 291 — When you click Find First, the first tagname whose name matches the text you entered is selected in the list. Click Find Next to find the next matching tagname. — Wildcard searches are not supported. • To copy the SOE configuration information to the clipboard, select the tagnames you want to copy, and then click Copy on the Edit menu. — To select multiple tagnames, hold down CTRL (for a non-contiguous selection) or SHIFT (for a contiguous selection) while you click each tagname. — To select all tagnames, on the Edit menu, click Select All. — Copied SOE configuration information can be pasted into any word processing or spreadsheet application using the Paste command in the target application. • To print reports with SOE configuration information (Project Implementation and SOE Block Variables), use the Print All command. See Printing Project Documents on page 109. • To change the SOE block properties, see Defining SOE Block Properties on page 291. Defining SOE Block Properties This procedure explains how to define the properties of an SOE block, which is required if you are using sequence of events in an application. Defining SOE block properties is related to the general task of controller configuration and can be completed at the same time. You can define SOE blocks to provide continuous event information to external devices on a network, or you can define them for limited operation when your controller is not on a network. The following table lists the types of SOE blocks that can be defined for each type of sequence of events recorder: If You’re Using This Sequence of Events Recorder: Triconex SOE Recorder Use These Types of SOE Blocks: • First Out • History • External • OPC Foxboro® I/A Series® DCS • External Foxboro Evo System • External Honeywell™ TDC 3000 DCS • Modified External TriStation 1131 Developer’s Guide, 4.14.0 292 Chapter 2 Application Development CAUTION When a Foxboro I/A Series DCS or Foxboro Evo System retrieves events via an ACM, only one block can be configured, and it must be defined as an External Block Type. Each external block can be accessed by only one sequence of events utility. For example, if the Foxboro Control Core Services workstation is retrieving events from an External SOE block, SOE Recorder cannot also retrieve events from that same block. See the Triconex SOE Recorder User’s Guide for instructions on specifying the blocks SOE Recorder can retrieve events from. Important Information About Changing the SOE Configuration in the Download Changes State In Tricon 11.2 and later sytems, you can make the following SOE configuration changes while your project is in the Download Changes state: • Adding new blocks or unassigning blocks • Changing the SOE block name • Changing the SOE block type • Changing the SOE buffer size • Changing the SOE block collection type However, to do so, you MUST first complete any changes that you previously made to the memory allocation for I/O points or Peer-to-Peer configuration, by performing a Download Changes operation after each of these changes. If you want to change the SOE configuration without completing these changes, you must change the project state to Download All. See Change State to Download All Command on page 672 for important information about the impact of changing the project state. CAUTION When your TriStation 1131 project is in the Download Changes state, performing any of the following actions will clear the events in the buffer of ALL configured SOE blocks: • making changes to the buffer size for any SOE block • adding a new SOE block • changing the block type for an existing SOE block to Unassigned For more information about how events are cleared from the buffer, see the Triconex SOE Recorder User’s Guide. In Tricon 11.1 and earlier systems, you cannot change the SOE configuration while the project is in the Download Changes state. If the project is currently in the Download Changes state, when you click Apply, you will be prompted to change the project state to Download All. If you do not change the project state to Download All, you cannot make changes to the SOE configuration. TriStation 1131 Developer’s Guide, 4.14.0 SOE Development 293 A Note About Using OPC to Collect SOE Events If you are using one of the following communication modules, an OPC server is embedded, and can be used to obtain SOE events: • If you have a model 4353 or 4354 TCM, you can use a third-party OPC client to obtain Tricon SOE events through a subscription to the TCM’s embedded OPC Alarms & Events server. • If you have a model 3211 or 3211S2 CIM, you can use a third-party OPC client to obtain Trident or Tri-GP SOE events through a subscription to the CIM’s embedded OPC UA server. When an OPC client is subscribed, all change of state events (transitions) for tagnames assigned to the block you have defined for this purpose will be sent to the OPC client as simple events. However, if an OPC client is not connected, the events collected by the SOE block will be continually cleared by the communication module’s embedded OPC server. If you choose to use the communication module’s embedded OPC server to obtain events from a controller, you cannot also use SOE Recorder to retrieve events from the same SOE block. When using the TCM’s OPC server, an SOE block used for OPC must be configured with a block type of EXTERNAL. For more information about configuring the TCM’s OPC server, see Configuring TCM Protocols (Tricon 10.3 and Later Only) on page 396. When using the CIM’s OPC UA server: • The SOE block used to retrieve events from the OPC UA client (defined as the SOE Block Number in the CIM configuration) must be configured with a block type of EXTERNAL. • The SOE block used to retrieve process alarm events (defined as the Alarms SOE Block Number in the CIM configuration) must be configured with a block type of OPC. For more information about configuring the CIM’s OPC server, see Configuring the Trident or Tri-GP 3.x CIM OPC UA Server on page 506. Procedure 1 Click the Application tree, and double-click Implementation. 2 Expand the SOE Configuration tree, and double-click a block number. TriStation 1131 Developer’s Guide, 4.14.0 294 Chapter 2 Application Development 3 Specify these settings on the SOE Block Definition tab. Property Action SOE Block Type Select one of the following block types: • External: Used when an external device, such as a DCS or a PC running SOE Recorder, is continually retrieving events. • First Out: Used to retrieve events that started a trip. • History: Used to monitor current events. • Modified External: Used for event retrieval with the SMM. • OPC: Used for process alarms event retrieval from an OPC UA client. For use with the CIM only. Blocks 1 through 14 can use any combination of History, First Out, External, and OPC block types. Blocks 15 and 16 can use only the Modified External block type. The default is unassigned. Note SOE Block Name When your TriStation 1131 project is in the Download Changes state, changing the block type to Unassigned will clear the events in the buffer of ALL configured SOE blocks. Enter a title for the block. If you do not enter a block name, a default name will be assigned automatically. The default is “soe_block_n,” where n is the block number. SOE Buffer Size The buffer stores the event entries, each containing a 8-byte time stamp and one or more 8-byte data entries. Enter the number of events to be stored in this block. The maximum number is 20,000 events (320,000 bytes); the default is 0. The maximum buffer size across all blocks is 60,000 events (1 MB). For information on estimating the SOE buffer size, see Estimating the Memory Available for SOE Blocks below. Note SOE Block Collection Type When your TriStation 1131 project is in the Download Changes state, making changes to the buffer size for any SOE block will clear the events in the buffer of ALL configured SOE blocks. Select the event collection behavior type for the block. • Select Automatic if you want the block’s events to be automatically collected by an instance of SOE Recorder running in Primary, Redundant, or Custom mode. • Select Manual if you want the block’s events to be collected by an external DCS or an instance of SOE Recorder running in Custom mode. The default is Automatic. TriStation 1131 Developer’s Guide, 4.14.0 SOE Development Property Action SOE Block Collection Mode Select the collection mode for the block. 295 • Select Primary if you want the block’s events to be collected by an instance of SOE Recorder running in Primary mode or an instance of SOE Recorder running in Custom mode when the blocks are selected for collection. • Select Redundant if you want the block to be a copy of an existing Primary block, and then select the Primary block you want this block to be a copy of. The tagnames assigned to the selected Primary block will automatically be assigned to the Redundant block; you cannot manually assign tagnames to a Redundant block. The default is Primary. Note: SOE Recorder 4.2.0 or later is required if you want to use Redundant or Custom mode. See the corresponding Triconex SOE Recorder User’s Guide for more information. 4 Click Apply to save your changes. 5 Repeat steps 2 and 3 for all the blocks to be configured. Note For more detailed information about the Automatic and Manual block collection types, and the SOE Recorder block collection modes (Primary, Redundant, or Custom), please see the Triconex SOE Recorder User’s Guide (for 4.2.0 or later). Estimating the Memory Available for SOE Blocks The maximum buffer size you can define for one SOE block is 20,000 events (320,000 bytes). The maximum size allowed across all blocks is 60,000 events (1 megabyte). This procedure explains how to determine the amount of free memory available for defining the buffer size of SOE blocks in your TriStation 1131 project. Procedure 1 Use the Download All or Download Changes command to download your project to the controller and run it. For detailed instructions, see Using the Download All Command on page 649. 2 Open the Enhanced Diagnostic Monitor and view the System Overview window to find the amount of free memory in the controller. For detailed instructions, see the Enhanced Diagnostic Monitor User's Guide. 3 Determine how much memory you want to reserve for future modifications to your project. Note Make sure the free memory is greater than or equal to the reserved memory. TriStation 1131 Developer’s Guide, 4.14.0 296 Chapter 2 Application Development 4 Calculate the amount of memory available for SOE blocks by subtracting the reserved memory (step 3) from the free memory (step 2). 5 To calculate the maximum number of events, divide the available memory by 16. 6 Define the buffer size of your SOE blocks based on these calculations. Assigning Tagnames to SOE Blocks If you are using sequence of events in an application, you must assign tagnames to an SOE block. This procedure explains how to do this using the SOE Configuration screen. As an alternative, you can also use the Tagname Editor, as described in Procedure for Input and Output Points on page 206. Tagnames must be aliased memory and/or input tagnames of type BOOL: • Discrete physical input points • Discrete memory read-only aliased variables, or • Discrete memory read/write aliased variables Discrete output points cannot be assigned to an SOE block. Tagname states can be displayed with names and colors that you define. You can designate one tagname in a TriStation 1131 application as the trip variable that notifies the operator when a trip occurs. Tagnames can be assigned only to blocks configured as Primary blocks. A block configured as Redundant is automatically assigned the same tagnames as its associated Primary block. See the Triconex SOE Recorder User’s Guide (4.2.0 or later) for more detailed information. Note For Tricon, if you define a block for use with the Advanced Communication Module (ACM), the Foxboro I/A Series or Foxboro Evo System assigns the tagnames. The only additional configuration you can do is to specify a type of External and a buffer size. Before you can assign tagnames, you must define SOE block properties (see Defining SOE Block Properties on page 291). TriStation 1131 Developer’s Guide, 4.14.0 SOE Development 297 Procedure 1 Open the Application tree, and double-click Implementation. 2 Click the SOE Configuration branch. The tagnames and block assignments, if any, are listed in a pane to the right of the tree. 3 To assign a tagname to one or more SOE Blocks, double-click the row for the tagname. The Item Properties dialog box appears. 4 To assign the tagname to specific blocks, select the block number check box. If the number is disabled, it means the block has not been defined, or the block has been defined as a Redundant block. You cannot manually assign tagnames to Redundant blocks. Note If you add tagnames after opening the SOE Configuration screen, you must close and re-open the SOE Configuration screen to have the new tagnames displayed. 5 Close the Item Properties dialog box. 6 Continue to assign tagnames to blocks as needed. 7 After assigning all the tagnames, save the project so the tagnames are available when specifying a trip variable. TriStation 1131 Developer’s Guide, 4.14.0 298 Chapter 2 Application Development Specifying a Trip Variable This procedure explains how to designate a trip variable, which is optional if you are using sequence of events in an application. In an application used for safety shutdown, a trip variable is an aliased tagname whose state transition causes SOE Recorder to automatically create a trip snapshot. An application can have only one trip variable, but it can apply to all blocks. If an application requires several variables related to trip conditions, these variables must be evaluated in combination to determine the final state of the trip variable. You must define at least one SOE block and assign a tagname to the block (see Defining SOE Block Properties on page 291 and Assigning Tagnames to SOE Blocks on page 296). Procedure 1 Open the Application tree, and double-click Implementation. 2 Double-click SOE Configuration. The Item Properties dialog box appears. 3 Specify these settings on the SOE Trip Variable tab. Property Action Trip Tagname The tagname that designates whether a trip has occurred. Select the tagname from the list of tagnames, and then select a Trip State of True or False. Only tagnames that are aliased BOOL data types are available. Trip State Select the value on which to begin collecting events: True or False. Time After Trip Select the number of minutes to collect events after a trip. The minimum time is 2 minutes; the maximum time is 10 minutes. The default is 2 minutes. Time Before Trip Select the number of minutes to collect events before a trip. The minimum time is 2 minutes; the maximum time is 10 minutes. The default is 2 minutes. TriStation 1131 Developer’s Guide, 4.14.0 Tricon Application Access 299 Tricon Application Access This section explains how to restrict connection access to a Tricon controller and how to restrict or allow write access to output and memory points in the downloaded application. Topics include: • Restricting Access to a Tricon Controller on page 299 • What Affects Tricon Write Access from External Devices on page 300 • Restricting Write Access to Tricon Points on page 302 • Allowing Write Access to Tricon Points on page 303 Restricting Access to a Tricon Controller This procedure explains how to restrict access to a Tricon controller from a TriStation PC. If access is restricted, only users with access privileges can disable points or download changes to the controller. Note You can also use the optional TCM or UCM access control list1 to restrict access to the Tricon on a per-client basis. See Controlling Access to the TCM or UCM on page 542. Procedure 1. 1 Expand the Controller tree, and double-click Configuration. 2 On the Configuration tree, click Operating Parameters. 3 Specify these properties on the Operating Parameters screen. Property Action Disable Stop on Keyswitch Select the check box to prevent the keyswitch from halting the application if it is turned to Stop. The default is cleared. Except models 4351 and 4352, which do not have the access control list feature. TriStation 1131 Developer’s Guide, 4.14.0 300 Chapter 2 Application Development Property Action Disable Remote Changes to Outputs Clear the check box to allow remote devices to write to output points. The default is selected. Allow Disabling of Points Select the check box to allow the TriStation PC to disable points while the application is running on the controller. The default is cleared. This property can be changed only when your project is in the Download All state. Once you have changed this property (by selecting or clearing the check box), you must perform a Download All to apply your changes to the controller. TriStation 1131 will automatically rebuild the application before it is downloaded. The settings you selected are used when the application is built. What Affects Tricon Write Access from External Devices This section describes the system properties, communication properties, and function blocks that affect read and write access to memory and output points on a Tricon controller. These types of read and write access are possible: • Input, output, and memory points can be read by any external device that can communicate with a Tricon controller. • Write access to input points is not allowed from any external device. • Write access to a output or memory point is allowed or restricted based on the system, communication, application, and point settings. • Write access to an output point via the TCM’s embedded OPC server is not allowed. This table describes write access to Tricon points from external devices. Table 36 Tricon Write Access Property or Feature Description Tricon keyswitch A system setting that determines write access to output and memory points unless overruled by the GATENB function block in the application. • Restricts write access when set to the Run position. • Allows write access when set to the Remote or Program position. GATENB A Tricon function block that programmatically allows write access to a specified range of aliased memory points when the keyswitch is in the Run position. The alias range configured for the GATENB function block must be less than or equal to the number of allocated read/write aliased memory points for each data type (DINT, BOOL, REAL). TriStation 1131 Developer’s Guide, 4.14.0 Tricon Application Access Table 36 301 Tricon Write Access (continued) Property or Feature Description GATDIS A Tricon function block that programmatically restricts remote write access for all ranges of aliased memory points that were previously enabled by GATENB. Disable Remote Changes to Outputs A system setting on the Operating Parameters screen that determines write access to output points. When selected, external devices cannot write to output points, no matter what other settings are made. Privilege A Tricon ACM and NCM setting that determines whether network devices using DDE, OPC, or TSAA communication have write access to output points and read/write aliased memory points. • For Tricon ACM, the default is Read. • For Tricon NCM, the default is Read/Write. • All other communication modules do not have this property. Port Write Enableda A Tricon TCM/UCM setting that determines whether TriStation, TSAA, or Modbus have write access to the selected port. The default value is cleared, meaning the port is read-only. All other communication modules do not have this property. TCM/UCM Access Control Listb An optional Tricon TCM/UCM feature that gives you the ability to control which clients can access TCM/UCM resources, the protocols they can use, and the level of access each client has. See Controlling Access to the TCM or UCM on page 542. Prohibit Writes A Tricon SMM module setting that determines whether Honeywell devices have write access to output points and read/write aliased memory points. The default is cleared, which means write access is allowed. Point Assignment A tagname setting that determines whether the output and memory point is assigned a Read or Read/Write alias number. • For output points, all alias numbers are Read/Write. • For memory points, alias numbers can be Read or Read/Write. a. This setting is not available on model 4351B, 4352B, 4353 and 4354 TCMs. b. Except models 4351 and 4352, which do not have the access control list feature. CAUTION By default, TSAA clients using a TCM interface (in Tricon 10.3 and later systems) and TSAA clients using a UCM interface (in Tricon 11.x and later systems) have write access to the NET 1 and NET 2 ports. Depending on your configuration, this may create a security issue. Please note that this default behavior is opposite of that on TCMs in Tricon 10.2 and earlier systems. To disable write access by TSAA clients, you must enable and configure the TCM/UCM access control list. See Controlling Access to the TCM or UCM on page 542. TriStation 1131 Developer’s Guide, 4.14.0 302 Chapter 2 Application Development Restricting Write Access to Tricon Points This procedure explains how to restrict external devices from writing to output or memory points. Input, output, and memory points can be read by any external device that can communicate with the Tricon controller. Input points cannot be written to. When the Tricon keyswitch is turned to Run, external devices cannot write to points unless the GATEB function block is used programmatically to allow write access to a range of aliased memory points. Procedure 1 Expand the Controller tree, and double-click Configuration. 2 On the Configuration tree, click Operating Parameters. 3 Ensure the Disable Remote Changes to Outputs check box is selected. The default is selected. TriStation 1131 Developer’s Guide, 4.14.0 Tricon Application Access 303 Allowing Write Access to Tricon Points This procedure explains how to allow external devices to write to memory and output points. Input points can be read, but cannot be written to. External devices must use supported communication protocols (Modbus, TSAA, OPC, and DDE) to communicate with the controller. Note External OPC clients cannot write to output points, even if the Disable Remote Changes to Outputs property is cleared. Procedure 1 Expand the Controller tree, and double-click Configuration. 2 On the Configuration tree, click Operating Parameters. 3 Clear the Disable Remote Changes to Outputs check box. The default is selected. 4 Do one of the following: 5 2. • If the external devices are communicating through an ACM or NCM, ensure the Privilege property for the module is set to Read/Write. See Privilege on page 790. The default for Tricon ACM is Read; for Tricon NCM the default is Read/Write. • If the external devices are communicating through a TCM or UCM, ensure the Port Write Enabled property for the selected port and protocol is selected, or that the TCM2 or UCM access control list is configured to allow read/write access for the selected client using the appropriate protocol. See Port Write Enabled on page 786 or Controlling Access to the TCM or UCM on page 542. Ensure the output or memory point is assigned a Read/Write alias number. See Assigning an Alias Number, Alias Type, and Physical Address on page 205. Except TCM models 4351 and 4352, which do not have the access control list feature. TriStation 1131 Developer’s Guide, 4.14.0 304 Chapter 2 Application Development Trident and Tri-GP Application Access This section explains how to restrict connection access to a Trident or Tri-GP controller and how to restrict or allow write access to output and memory points in the downloaded application. Topics include: • Restricting Access to a Trident or Tri-GP Controller on page 304 • What Affects Trident and Tri-GP Write Access from External Devices on page 306 • Restricting Write Access to Trident or Tri-GP Points on page 308 • Allowing Write Access to Trident or Tri-GP Points on page 309 Restricting Access to a Trident or Tri-GP Controller This procedure explains how to restrict access to a Trident or Tri-GP controller from a TriStation PC. If access is restricted, only users with access privileges can disable points or download changes to the controller. Note You can also use the optional 2.x/3.x CM or 3.x CIM access control list to restrict access to the Trident or Tri-GP controller on a per-client basis. See Controlling Access to the CM or CIM on page 590. Procedure 1 Expand the Controller tree, and double-click Configuration. 2 On the Configuration tree, open the Hardware Allocation node, and then double-click the MP. The Item Properties dialog box appears. 3 Click Setup. The MP Setup dialog box appears. TriStation 1131 Developer’s Guide, 4.14.0 Trident and Tri-GP Application Access 4 305 Specify these properties on the Operating Parameters tab. Property Action Password Required for Connection Select the check box to restrict access by requiring a password when connecting to the controller. The default is cleared. Password Enter the password required to access the controller. The default is PASSWORD. Disable Remote Changes to Outputs Clear the check box to allow remote devices to write to output points. The default is selected. Allow Disabling of Points Select the check box to allow the TriStation PC to disable points while the application is running on the controller. The default is cleared. This property can be changed only when your project is in the Download All state. Once you have changed this property (by selecting or clearing the check box), you must perform a Download All to apply your changes to the controller. TriStation 1131 will automatically rebuild the application before it is downloaded. The settings you selected are used when the application is built. TriStation 1131 Developer’s Guide, 4.14.0 306 Chapter 2 Application Development What Affects Trident and Tri-GP Write Access from External Devices This section describes the system properties, communication properties, and function blocks that affect read and write access to memory and output points on a Trident or Tri-GP controller. These types of read and write access are possible: • Input, output, and memory points can be read by any external device that can communicate with a Trident or Tri-GP controller. • Write access to input points is not allowed from any external device. • Write access to a output or memory point is allowed or restricted based on the system, communication, application, and point settings. This table describes write access to Trident or Tri-GP points from external devices. Table 37 Trident and Tri-GP Write Access Property or Feature Description Disable Remote Changes to Outputs A system setting on the MP Operating Parameters tab that determines write access to output points. When selected, external devices cannot write to output points, no matter what other settings are made. SYS_SET_REMOTE_WRT_ENBL A Trident/Tri-GP function block that programmatically allows or restricts write access to output or memory read/write aliased points when used in an application. To allow write access, the Disable Remote Changes to Outputs property cannot be selected. Privilege (Trident 1.x only) A CM module setting that determines whether network devices using DDE, OPC, or TSAA communication have write access to output points and read/write aliased memory points. • The default is Read/Write. • This setting does not affect Modbus access. CM/CIM Access Control List (Trident 2.x/3.x and Tri-GP) An optional CM/CIM feature that gives you the ability to control which clients can access CM/CIM resources, the protocols they can use, and the level of access each client has. See Controlling Access to the CM or CIM on page 590. Point Type A tagname setting that determines whether the output and memory point is assigned a Read or Read/Write alias number. • For output points, all alias numbers are Read/Write. • For memory points, alias numbers can be Read or Read/Write. TriStation 1131 Developer’s Guide, 4.14.0 Trident and Tri-GP Application Access CAUTION 307 By default, TSAA clients have write access to the NET 1 and NET 2 ports on the following communication modules: • Trident 2.x/3.x CM • Tri-GP 2.x/3.x CM • Trident/Tri-GP 3.x CIM Depending on your configuration, this may create a security issue. To disable write access by TSAA clients, you must enable and configure the access control list. See Controlling Access to the CM or CIM on page 590. TriStation 1131 Developer’s Guide, 4.14.0 308 Chapter 2 Application Development Restricting Write Access to Trident or Tri-GP Points This procedure explains how to restrict external devices from writing to memory and output points. Input, output, and memory points can be read by any external device that can communicate with the Triconex controller. Input points cannot be written to. The SYS_SET_REMOTE_WRT_ENBL function block can be used programmatically to override the Disable Remote Changes to Outputs setting and allow write access to a range of aliased output or memory points. Procedure 1 On the Configuration tree, open the Hardware Allocation node, and then double-click the MP. The Item Properties dialog box appears. 2 Click Setup. The MP Setup dialog box appears. 3 On the Operating Parameters tab, ensure the Disable Remote Changes to Outputs check box is selected. TriStation 1131 Developer’s Guide, 4.14.0 Trident and Tri-GP Application Access 309 Allowing Write Access to Trident or Tri-GP Points This procedure explains how to allow external devices to write to memory and output points. Input points can be read, but cannot be written to. External devices must use supported communication protocols (Modbus, TSAA, OPC, and DDE) to communicate with the controller. Note External OPC clients cannot write to output points, even if the Disable Remote Changes to Outputs property is cleared, or the SYS_SET_REMOTE_WRT_ENBL function block is used. Procedure 1 On the Configuration tree, open the Hardware Allocation node, and then double-click the MP. The Item Properties dialog box appears. 2 Click Setup. The MP Setup dialog box appears. 3 Do one of the following: • If the external devices are communicating through an Open Network port on the Trident 1.x CM, ensure the Privilege property on the Network tab is set to Read/Write. See Configuring Trident 1.x MP Network Ports on page 458. The default is Read/Write. • If the external devices are communicating through one of the following communication modules, ensure that the access control list is configured to allow read/write access for the selected client using the appropriate protocol. — Trident 2.x/3.x CM — Tri-GP 2.x/3.x CM — Trident/Tri-GP 3.x CIM See Controlling Access to the CM or CIM on page 590. 4 Ensure the output or memory point is assigned a Read/Write alias number. See Assigning an Alias Number, Alias Type, and Physical Address on page 205. TriStation 1131 Developer’s Guide, 4.14.0 310 Chapter 2 Application Development Secure Communication The information in this section applies only to Trident/Tri-GP 3.0 and later controllers with a CIM installed. TriStation 1131 gives you the option to securely connect to Trident and Tri-GP 3.x controllers with a CIM installed. When you are securely connected to a controller, communication between the TriStation PC and the controller is encrypted using a digital certificate and a Secure Sockets Layer (SSL) connection. Secure communication can also be enabled for clients who are connecting to the CIM’s OPC UA server, and for clients using the TriStation protocol to connect to the CIM (such as the Enhanced Diagnostic Monitor). Secure communication is enabled on a per-project basis. When deciding whether or not to use secure communication, you should assess the security threats to your system within the context of the overall plant architecture, any applicable standards, and your corporate practices. As a result of this security risk assessment, if you feel that a higher level of security is needed to mitigate security threats, you should enable and use secure communication. To enable secure communication, you need to add certificates, and their associated private keys, to your project. These certificates are then downloaded to the CIM when you download your application to the controller. Topics in this section include: • What Is a Certificate? on page 311 • Using the Default Certificates on page 312 • Generating a Certificate on page 313 • Importing a Certificate on page 315 • Managing Private Keys on page 316 • Viewing Detailed Information About a Certificate on page 318 • Deleting a Certificate on page 319 • Configuring a Secure Connection with the Controller on page 320 TriStation 1131 Developer’s Guide, 4.14.0 Secure Communication 311 What Is a Certificate? A digital certificate is an electronic credential that ensures the identity of the certificate owner via a pair of electronic keys (public and private) that are used to encrypt and sign information digitally. Messages are encrypted with one key (public or private) and then decrypted with the other key. How Does TriStation 1131 Use Certificates? Two categories of certificates can be used in TriStation 1131: • OPC: These certificates are to be used for secure communication using the OPC protocol. You can configure at most one certificate to be used by the CIM’s embedded OPC UA server, and many certificates to be used by multiple OPC trusted clients. • TriStation: These certificates are to be used for secure communication using the TriStation protocol. You can configure at most one certificate to be used by the TriStation server (the CIM), and many certificates to be used by clients connecting to the CIM via the TriStation protocol. TriStation 1131 supports the X.509 digital certificate standard, and allows only certificates that are in the Privacy Enhanced Mail (PEM) format or the Distinguished Encoding Rules (DER) format to be added to a project. Chain of trust is not supported by the CIM’s OPC UA server or TriStation 1131. This allows certificates to be self-signed, and does not require the use of a Certification Authority (CA) to generate certificates for use in TriStation 1131. TriStation 1131 and the CIM’s OPC UA server do not check for a certificate’s valid start date; they only verify the expiration date. In other words, if a certificate is not valid until 6 weeks in the future, the certificate can still be used for secure communication. If the OPC UA server certificate is expired, the OPC UA server will not start until a valid certificate is downloaded to the controller. Note For additional information about managing and using certificates for OPC communication, see the Triconex OPC UA Server User’s Guide. TriStation 1131 automatically generates a project private key to encrypt the certificates and private keys that are added to your project. Your user password is used to encrypt the project private key. When secure communication is enabled for the connection between TriStation 1131 and a controller, TriStation 1131 uses a certificate and the SSL secure transmission protocol to connect to the controller. Use of secure communication provides the following benefits: • Verifies the identity of the TriStation PC and the controller through the exchange and validation of the certificate. • Encrypts information exchanged between the TriStation PC and the controller on a secure channel. • Ensures the integrity of the contents of messages that are exchanged between the TriStation PC and the controller, by ensuring the messages have not been altered during transmission. TriStation 1131 Developer’s Guide, 4.14.0 312 Chapter 2 Application Development Certificate revocation lists (CRLs) are not supported. If a certificate should no longer be used for secure communication, you must remove it from your TriStation 1131 project, and then download the updated application to the controller. For more information, see Deleting a Certificate on page 319. For important information about security considerations when using certificates for secure communication, see the Planning and Installation Guide for your controller. Using the Default Certificates When you installed TriStation 1131, a number of default certificates were also installed. Using these default certificates is an easy way for you to get started with using secure communication in your application. The default certificates are as follows: • ExampleClientCertificate.pem • ExampleClientCertificateKey.pem • ExampleServerCertificate.pem • ExampleServerCertificateKey.pem • ExampleUaServerCertificate.der • ExampleUaServerCertificateKey.pem Note The ExampleUaServerCertificate (and its corresponding private key) can only be imported into the OPC folder, for use with OPC UA. The client and server certificates cannot be used with OPC UA. The default certificates are installed in the location: C:\ProgramData\Triconex\TriStation 1131 4.14.0\Data. Invensys recommends using the default certificates for testing and/or training purposes only, and not in a production environment. Before you download your application to a controller for use in a production environment, you should: • Generate your own, personalized certificates. See Generating a Certificate on page 313. • Import your personalized certificates into your project. See Importing a Certificate on page 315. • Delete the default certificates from your project. See Deleting a Certificate on page 319. CAUTION Using the default certificates in a production environment poses a security risk, because anyone with a copy of TriStation 1131 can connect to a controller using the default certificates. TriStation 1131 Developer’s Guide, 4.14.0 Secure Communication 313 Generating a Certificate TriStation 1131 includes a separate utility for generating X.509 client and server certificates (and their corresponding RSA private keys) in the necessary PEM format. The utility also generates an OPC UA server certificate (and its corresponding private key) in the DER format. These are self-signed certificates designed for testing and internal use. Note If you are already using digital certificates in your organization, Invensys recommends using your organization’s standard methods for creating digital certificates. After you enter various attributes for your certificates, the Generate Certificates utility creates the following certificates and private keys: • ts1131_client.pem • ts1131_clientkey.pem • ts1131_server.pem • ts1131_serverkey.pem • opc_ua_server.der • opc_ua_serverkey.pem The above certificates and private keys are placed in the TriStation 1131 default Data directory: C:\ProgramData\Triconex\TriStation 1131 4.14.0\Data. Procedure 1 From the Start menu, select All Programs > Triconex > Generate Certificates 4.14.0. The following command prompt window appears. 2 Enter the number of days you want to certificate to be valid for, and then press Enter. For example, if you want the certificate to expire after 2 months, enter 60. Note 3 Ensure that the length of time the certificate is valid for causes the certificate to expire prior to December 31, 2037. Expiration dates after this date are not supported. Type the 2-digit ISO abbreviation for your country, and then press Enter. For example, the 2-digit abbreviation for the United States is US. The complete list of country codes can be found here: http://www.iso.org/iso/country_codes/iso_3166_code_lists/country_names_and_co de_elements.htm 4 Type the full name of your state or province, and then press Enter. TriStation 1131 Developer’s Guide, 4.14.0 314 Chapter 2 Application Development 5 Type the name of your locality or city, and then press Enter. 6 Type the name of your organization, and then press Enter. This is typically the name of your company. 7 Type the name of your organizational unit, such as your division or department, and then press Enter. 8 Type your name (first and last), and then press Enter. 9 Type your full email address (such as you@domain.com), and then press Enter. The utility automatically generates the client certificate and private key. The following then appears in the window. 10 Repeat steps 2—9 to enter the same information for the OPC UA server certificate and private key. The utility automatically generates the OPC UA server certificate and private key. The following then appears in the window. 11 Repeat steps 2—9 to enter the same information for the server certificate and private key. The utility automatically generates the server certificate and private key, and then closes. TriStation 1131 Developer’s Guide, 4.14.0 Secure Communication 315 Importing a Certificate To use secure communication, you must add certificates to your project. Multiple client certificates may be added, but only one server certificate can be imported for each of the following: • OPC > Server • TriStation > Server Certificates cannot have the same file name, even if you are importing them into different folders. Certificates names are not case-sensitive. For example, MyCertificate.pem is the same as mycertificate.pem. To import a certificate, you must have a User Security level that includes Add/Delete Security Certificates. For more information, see Managing User Access on page 66. CAUTION If you are preparing your application for use in a production environment, be sure you do not import the default certificates. Using the default certificates in a production environment poses a security risk, because anyone with a copy of TriStation 1131 can connect to a controller using the default certificates. For more information, see Using the Default Certificates on page 312. Procedure 1 Expand the Application tree, and then expand the Certificates folder. 2 Right-click one of the following folders, depending on the type of certificate you want to add. 3 • OPC: Select the Server or Trusted sub-folder. The Trusted folder is for OPC client certificates. • TriStation: Select the Server or Client sub-folder. Click Import. The Import Certificate dialog box appears. Note 4 The Import option is unavailable if a certificate already exists in a folder that does not allow multiple certificates. To add another certificate to these folders, you must delete the existing certificate first. Locate the certificate file (.pem or .der) you want to import, and then click Open. TriStation 1131 Developer’s Guide, 4.14.0 316 Chapter 2 Application Development 5 When prompted to confirm importing the selected certificate, verify the certificate’s details are correct, and then click Yes to continue. 6 Go to Associating a Private Key with a Certificate on page 316 to associate a private key with the certificate. Managing Private Keys You must associate a private key with a certificate in order for it to be used for secure communication. You can replace a private key or remove a private key from a certificate at any time. Topics include: • Associating a Private Key with a Certificate on page 316 • Replacing a Certificate’s Private Key on page 317 • Removing a Certificate’s Private Key on page 317 Associating a Private Key with a Certificate Associating a private key with a certificate allows it to be used for secure communication. Procedure 1 Expand the Application tree, and then expand the Certificates folder. 2 Right-click the certificate you want to associate with a private key, and then click Associated Private Key. The Associate Private Key dialog box appears. 3 Locate the certificate file (.pem) you want to associate as a private key, and then click Open. Note An error message will appear if you select a private key that does not match the selected certificate. A certificate will work only with the private key that the certificate was generated from. If the private key does not match the certificate, the certificate will be considered invalid, and you will be unable to use it for secure communication. A key appears on the certificate’s icon key associated with it. TriStation 1131 Developer’s Guide, 4.14.0 , denoting that the certificate has a private Secure Communication 317 Replacing a Certificate’s Private Key If necessary, you can replace the private key associated with a certificate. You only need to do this if you previously associated an invalid private key with a certificate. Procedure 1 Expand the Application tree, and then expand the Certificates folder. 2 Right-click the certificate whose private key you want to replace, and then click Replace Private Key. The Replace Private Key dialog box appears. 3 Locate the certificate file (.pem) you want to associate as a private key, and then click Open. The previously associated private key is replaced with the private key you just selected. Removing a Certificate’s Private Key If necessary, you can remove the private key associated with a certificate. Removing the private key will render the certificate invalid, and you will be unable to use it for secure communication. Procedure 1 Expand the Application tree, and then expand the Certificates folder. 2 Right-click the certificate whose private key you want to remove, and then click Remove Associated Private Key. The private key is removed, and the key disappears from the certificate’s icon. TriStation 1131 Developer’s Guide, 4.14.0 318 Chapter 2 Application Development Viewing Detailed Information About a Certificate You can view detailed information about a certificate such as the serial number, issuer, expiration date, and more. Procedure 1 Expand the Application tree, and then expand the Certificates folder. 2 Right-click the certificate whose details you want to view, and then click View Details. The Certificate Properties dialog box appears. 3 Click the Details tab to view detailed information about the certificate. 4 When you have finished reviewing the certificate details, click OK to close the dialog box. TriStation 1131 Developer’s Guide, 4.14.0 Secure Communication 319 Deleting a Certificate If you no longer want to make a certificate available for secure communication, you should delete it from your project. The next time you download your application to the controller, the certificate will be removed from the CIM. Clients who attempt to connect to the CIM using the deleted certificate will be denied access. If you delete an OPC Server certificate, once you download the change to the controller, all active sessions currently connected to the CIM’s OPC UA server will be closed. To delete a certificate, you must have a User Security level that includes Add/Delete Security Certificates. For more information, see Managing User Access on page 66. Procedure 1 Expand the Application tree, and then expand the Certificates folder. 2 Right-click the certificate you want to delete, and then click Delete. 3 When asked to confirm the deletion, click OK. The certificate is removed from the Certificates folder. 4 Perform a download operation to remove the certificate from the CIM. See Downloading to the Controller on page 620 for more information about how to download your application to the controller. TriStation 1131 Developer’s Guide, 4.14.0 320 Chapter 2 Application Development Configuring a Secure Connection with the Controller This procedure describes how to configure a secure connection between TriStation 1131 and a Trident 3.x or Tri-GP 3.x controller. Once secure communication is enabled, the TriStation client certificate and private key are loaded from the certificate store when you connect to the controller, and are used to establish a secure communication channel between the TriStation PC and the CIM using the SSL protocol. CAUTION Once you enable secure communication by selecting the Use Secure Communication check box, you must ensure that you have imported both client and server certificates for TriStation, and associated the appropriate private keys with both certificates. If there are problems with the certificates and/or private keys, you could accidentally lock yourself out of a network connection to the Trident or Tri-GP controller after you first download the application with secure communication enabled. You will be unable to connect to the controller again after your download, preventing you from making further changes to the application running on the controller, including changes to the certificates and/or private keys. If this happens, you can use the serial connection to connect to the Trident or Tri-GP controller. You can then disable secure communication or fix any certificate problems via a Download Changes operation. See Connecting to the Trident or Tri-GP Controller via a Serial Connection on page 568. Note While configuring secure communication for a controller, you may encounter errors relating to certificates that have expired. For assistance with troubleshooting such errors, contact Global Customer Support (see Technical Support on page xvii). Procedure 1 On the Configuration tree, open the Hardware Allocation node, and then double-click the MP. The Item Properties dialog box appears. 2 Click Setup. The MP Setup dialog box appears. TriStation 1131 Developer’s Guide, 4.14.0 Secure Communication 3 321 Specify these properties on the Operating Parameters tab. Property Action Use Secure Communication Select the check box to enable secure communication between the Trident or Tri-GP 3.x controller and TriStation 1131. Note: When this option is selected, the default connection type will automatically use secure communication to connect to the controller. However, you still have the option to not use secure communication for a specific connection; see Preparing to Download to the Controller on page 618 for more information. Applicable to Trident/Tri-GP 3.x systems with a CIM installed only. The default is cleared (secure communication is not enabled). Allow Expired Certificate Select the check box if you want to allow secure connections to Trident or Tri-GP 3.x controllers even if the TriStation server and/or client certificate is expired. If a certificate expires, and this option is not selected, you will be unable to connect to the controller via a network connection. In this case, you will have to connect via a serial connection, or perform a Download All operation to download a new certificate. Applicable only to TriStation or Enhanced Diagnostic Monitor connections to Trident/Tri-GP 3.x systems with a CIM installed. Does not apply to OPC UA client/server certificates. The default is cleared. TriStation 1131 Developer’s Guide, 4.14.0 322 Chapter 2 Application Development Property Action Generate Alarm When a Certificate Expires Select the check box if you want to be alerted when a certificate used for secure communication expires. When selected, the fault LEDs on the MPs will turn ON when a certificate has expired, or is close to expiring. An alarm event will also appear in the Enhanced Diagnostic Monitor. Applicable to Trident/Tri-GP 3.x systems with a CIM installed only. The default is cleared. Number of Days Before an Alarm Is Generated If you choose to be warned when a certificate expires, you also need to select how many days prior to expiration the warning occurs. You can enter from 0 to 255 days. If you enter 0, a warning will occur immediately upon certificate expiration. The default is 1 day. For example, if you want to be warned one week before a certificate is due to expire, enter 7. Applicable to Trident/Tri-GP 3.x systems with a CIM installed only. 4 Click OK to save. Note For information about the other properties in the Operating Parameters dialog box, see Setting Trident or Tri-GP Operating Parameters on page 439. 5 Expand the Application tree, and then expand the Certificates > TriStation > Client folder. 6 Right-click the certificate, and click Select for Secure Communication. A check mark appears on the certificate’s icon, denoting that the certificate is enabled for secure communication between the TriStation PC and the controller. Client certificate enabled for secure communication TriStation 1131 Developer’s Guide, 4.14.0 Building an Application 323 Building an Application This section includes information on how to build an application, which must be done before testing. If you try to download an application before building it, TriStation 1131 tries to build it and then download it. If the build has errors, the download does not continue. Topics include: • Specifying the Program Order and Scan Time on page 323 • Compiling a Program on page 325 • About the Process Alarms Program on page 325 • Building or Rebuilding an Application on page 327 • Backing Up a Project File to the Controller on page 328 • About the Application’s Initialization Table on page 333 Specifying the Program Order and Scan Time This procedure explains how to specify the programs and order of execution in the application. You can also set the scan time of the application, which determines the number of milliseconds that is taken to execute the application once. The maximum number of programs in an application is 250. Note Using the Print All command, you can print a report that includes the Program Execution List (Program Implementation). See Printing Project Documents on page 109. Procedure 1 On the Application tree, double-click Implementation. 2 On the Implementation tree, double-click Execution List. TriStation 1131 Developer’s Guide, 4.14.0 324 Chapter 2 Application Development 3 Specify these properties on the Execution List screen. Property or Button Action Scan Time Enter the number of milliseconds anticipated for the scan. This requested scan time must be equal to or greater than the minimum scan time (based on the I/O modules configured in the project). For information on determining the minimum scan time, see Determining the Minimum Scan Time on page 630. The actual scan time is determined after the application is downloaded and run on the controller. The default is 200 milliseconds. Note: For information about how process alarms can impact scan time, see Effect of Process Alarms on Scan Time on page 244. New (insert) button Click to add a program to the list. Delete button Click to delete the selected program from the list. When prompted to confirm the deletion of the program from the list, make sure to read the information provided in the warning note below before clicking OK to confirm the deletion. Move Up button Select a program and then click to move a program up in the execution order. Move Down button Select a program and then click to move a program down in the execution order. Browse button To add or change a program, double-click a program, then enter the name, or click the Browse button to select a name from the available programs. WARNING Deleting a program from the execution list, performing a download operation (Download All or Download Changes) to the controller, and then adding the deleted program back to the execution list at a later time will cause a new instance of the program to be downloaded and initialized when you perform another download. For example, assume that you delete Program12 from the execution list, and then perform a Download Changes to the controller. If you add Program12 back to the execution list again, and then perform another Download Changes to the controller, a new instance of Program12 will be downloaded and initialized. TriStation 1131 Developer’s Guide, 4.14.0 Building an Application 325 Compiling a Program This procedure explains how to manually compile a program, which can be done before building an application. Programs are automatically compiled when you build an application. Procedure 1 On the Project menu, click Compile All User Documents. 2 When the Comments for Audit Trail dialog box appears, enter a comment to describe the changes you made to the program since the last compile, and then click OK. The Message View automatically opens and displays the status of the compile process. 3 If there are errors, fix them before building the application. About the Process Alarms Program If you have configured tagnames with process alarms in your application using the ALARMS library, the “ProcessAlarms_Auto_Gen_” program is automatically generated and added to the Implementation list when you build your application. Note If the program already exists, rebuilding the application deletes the existing program, and replaces it with a new program reflecting the changes you made to the alarm configuration. If no changes were made to the existing alarm configuration, the program is not regenerated. This read-only structured text program cannot be modified in any way. The maximum number of alarms that can be included in the program ranges from 100 to 300, depending on how you configured your alarms. If every alarm attribute is connected to a tagname, the maximum number of alarms that can be configured is 100. Invensys recommends configuring no more than 100 alarms per program to avoid encountering memory errors during compilation. When you build the application after configuring one or more tagnames with alarms, the following occurs: • The “ProcessAlarms_Auto_Gen_” program is created and added to the Implementation list. • The tagnames configured with alarms are associated with the corresponding alarm function blocks. When you build the application, TriStation 1131 will look for changes to the alarm configuration. If changes are found (for example, an alarm has been deleted, or an existing alarm changed), the process alarms program will be updated automatically, and a message alerting you that the program was regenerated will appear in the Message View. TriStation 1131 Developer’s Guide, 4.14.0 326 Chapter 2 Application Development Note If you remove all process alarms from the tagnames in your application, and then build the application, the process alarms program will be automatically deleted from the Implementation list and the Programs list. However, if the process alarm program is open in the Programs list while you are building the application, it will be removed from the Implementation list, but remain in the Programs list. You can either manually remove it from the Programs list yourself, or close the program and then wait until the next time you build the application, at which time it will be automatically removed from the Programs list. Manually Generating the Process Alarms Program If necessary, you can manually generate the “ProcessAlarms_Auto_Gen_” program without rebuilding your application. Procedure 1 Verify that you have configured tagnames with process alarms in your application. 2 On the Project menu, click Create or Update the Process Alarms Program. If TriStation 1131 finds tagnames with configured alarms in your project, the “ProcessAlarms_Auto_Gen_” program is created (or updated) and added to the Implementation list. Note If the Alarm Settings > Tag Configuration dialog box was open, TriStation 1131 will automatically close it before creating the program. TriStation 1131 Developer’s Guide, 4.14.0 Building an Application 327 Building or Rebuilding an Application This procedure explains how to use the Build Application command or Rebuild Application command to build an application. If the programs in the application have not been compiled, the Build Application command compiles them and then attempts to build the application. Errors and warnings are displayed in the Message View. Errors must be resolved before an application can be downloaded, but warnings do not affect online execution. Typically, warnings refer to unused points in an application. Note When building an application, the number of program variables cannot exceed 64,001. If you receive an error message that this limit has been exceeded, you must reduce the number of program variables before you can build your application. The easiest way to reduce the number of program variables is to turn off color monitoring in your program(s). See Specifying Document Attributes on page 139. Procedure 1 On the Project menu, click Build Application or Rebuild Application. 2 When the Comments for Audit Trail dialog box appears, enter a comment to describe the changes you made to the application since the last build, and then click OK. The build process begins. 3 Check the Message View to view the status of the build, and to check for errors. If there are no errors, the build is successful. 4 If there are errors, click each error message to locate the location of the error. 5 Correct the errors, compile the affected user documents, and then build or rebuild the application. Note When you build a CEM program, intermediate FBD and ST code is generated. This code is useful for understanding and debugging the CEM program. To view the intermediate code, from the Document menu, select View Intermediate FBD or View Intermediate ST. TriStation 1131 Developer’s Guide, 4.14.0 328 Chapter 2 Application Development Backing Up a Project File to the Controller Copying a project file to a controller provides an additional means of backing up your project file to a secure location other than the TriStation PC. After you have copied a project file to a controller, you can later retrieve it from the controller and save it to a TriStation PC. Invensys strongly recommends that you also maintain separate backups of the project file in other secure locations. Note Only Tricon systems 11.1 and later, with TCMs installed, support this feature. The SHA-1 hash algorithm is used to check the integrity of the project file during a copy operation. Before the copy operation occurs, the algorithm generates an SHA-1 key on the PC where the file is located. After the copy operation is completed, it generates another SHA-1 key on the controller the file is copied to. If the key generated on the PC matches the key generated on the controller, it indicates that the file has been copied successfully, with no data loss. The same validation is also performed during a retrieval operation. To use the copy and retrieval features, the TriStation PC must be connected to the controller via a network connection. For more information, see Connecting to the Tricon Controller via a Network Connection on page 533. Additionally, when copying a project file, the controller must be in Triple Modular Redundant (TMR) mode, with all three Main Processors online. Note Before attempting a copy or retrieval operation, ensure that no other TriStation PC is connected to the controller. This section explains how to copy a project file to the controller, retrieve the file from the controller, and view information about the project file copied to the controller. Copying a Project File to the Controller The copy operation is different from a Download All or Download Changes operation. While a file copied to the controller can be retrieved from the controller and saved back to a TriStation PC, an application downloaded to the controller cannot be saved back to a TriStation PC. You can copy a project file only after the application is downloaded to the controller. If you make changes to the project file after a copy operation, you must perform a Download All or Download Changes operation before you attempt to copy the modified file again. You can perform the copy operation after every Download All or Download Changes operation either manually, or by configuring your project settings to allow automatic copying of the project file. To configure your project settings, see Specifying Automatic Copying of the Project File to the Controller on page 49. After a download operation has been completed, you must wait up to several minutes (in some cases, up to an hour) before attempting to manually copy the project file to the controller. This waiting period can vary depending upon the size of the application and the controller’s scan time. Larger files and longer scan times will increase this waiting period. To determine when the download operation is complete, view the event log in the Enhanced Diagnostic Monitor. Once the “Application Write to Flash Completed” event appears, the download operation is complete, and you can safely initiate the copy operation. TriStation 1131 Developer’s Guide, 4.14.0 Building an Application Note 329 To copy a project file to a controller, you must be logged on as a user with Download All and/or Download Changes privileges. For more information, see Adding and Modifying User Access on page 75. When you perform a copy operation, the previous version of the file that was stored on the controller will be overwritten. The status of a copy operation, including failures and cancellations, can be viewed in the Project History dialog box. See View Project History Command on page 865. The maximum size of a project file that can be copied is 50 MB. This procedure explains how to manually copy a project file to the controller. Procedure 1 If a project file is already stored on the controller, verify that you have a backup of that file located on the TriStation PC (or elsewhere on your network). During the copy operation, an existing file stored on the controller will be deleted. You should ensure you have a backup of that file in case an error occurs during the copy operation. 2 3 Do one of the following: • If the application in the project file you want to copy has already been downloaded to the controller, open the project, and then connect to the controller. • If the application in the project file you want to copy has not yet been downloaded to the controller, open the project, and then download the application to the controller, as described in Downloading to the Controller on page 620. After downloading the application, wait several minutes (in some cases, up to an hour) before proceeding to the next step, while the controller finalizes the download operation. To determine when the download operation is complete, view the event log in the Enhanced Diagnostic Monitor. Once the “Application Write to Flash Completed” event appears, the download operation is complete, and you can safely initiate the copy operation. On the Commands menu, click Copy Project File (.PT2) to Controller. Note 4 If you attempt to copy a project file to a Tricon 11.0 or earlier controller, or to a Tricon 11.1 controller with a communication module that does not support file storage, the copy operation is cancelled, and error code 200 appears in the Messages pane. If prompted, click OK to overwrite the existing version of the project file on the controller. A progress bar appears, displaying the time required to complete the copy operation. After the timer reaches 0, you may have to wait up to 1-2 minutes for the copy operation to complete. Note 5 When the copy operation begins, the file previously stored on the controller is deleted. The deletion will be completed even if you cancel the copy operation. If the file is copied successfully, a message box appears. Click OK to complete the copy operation. TriStation 1131 Developer’s Guide, 4.14.0 330 Chapter 2 Application Development If the SHA-1 key values on the PC and controller do not match, a message appears, indicating data loss or corruption during the copy operation. In such a case, attempt the copy operation again. Note If the file name contains more than 127 characters, it is truncated after the copy operation is complete. The extension (.pt2) is also removed from the file name. However, the extension will be restored after a retrieval operation. Retrieving a Project File from the Controller You can retrieve a project file that has been copied to a controller, and save it to your TriStation PC. Retrieving a project file from the controller does not remove it from the controller. You can retrieve a project file stored on the controller in one of two ways: • Using the Commands menu: Available when a project file is open and connected to a controller. The open project file can be different from the one you want to retrieve from the controller. • Using the Tools menu: Available when no project file is open. You cannot retrieve a project file stored on the controller if: • The project file is open, but not connected to a controller. • Another TriStation PC is currently connected to the controller. Notes A project file retrieved from the controller may not match the version downloaded to the controller, if an updated version of the application was downloaded to the controller after the project file was copied to the controller. If you have just inserted or reset a Main Processor module, you may receive an error message while attempting to retrieve a project file from the controller. In this case, you must wait for the MP to complete its re-education process. To determine when re-education is complete, view the event log in the Enhanced Diagnostic Monitor. Once the “Application Write to Flash Completed” and “PT2 Re-education Complete” events appear, re-education is complete, and you can safely initiate the retrieval operation. Procedure 1 Do one of the following: • If a project file is connected to a controller, click Retrieve Project File (.PT2) from Controller on the Commands menu, and go to step 3. • If no project file is open, click Retrieve Project File (.PT2) from Controller on the Tools menu, and go to step 2. Note If you attempt to retrieve a project file from a Tricon 11.0 or earlier controller, or from a Tricon 11.1 controller with a communication module that does not support file storage, the retrieval operation is cancelled, and error code 200 appears in the Messages pane. TriStation 1131 Developer’s Guide, 4.14.0 Building an Application 2 331 Specify the following properties: Property Action Platform Select Tricon. IP Address Enter the IP address of the controller where the project file is stored. UDP Port Enter the UDP port number for the controller. The valid range is 1 - 65535. The default is 1502. Node Number Enter the node number for the controller. The default is 1. Enhanced Protocol Select only if you are connecting to a Tricon 11.2 or later controller. The default is selected. 3 Click OK to continue. 4 When a message appears, displaying details about the project file currently saved on the controller, click OK to continue. A progress bar appears, displaying the time required to complete the retrieval operation. After the timer reaches 0, you may have to wait up to 1-2 minutes for the retrieval operation to complete. 5 Navigate to the folder you want to save the file in, enter a file name, and click Save. 6 To close the currently open project file, if any, and open the file that you retrieved from the controller, click Yes when prompted. TriStation 1131 Developer’s Guide, 4.14.0 332 Chapter 2 Application Development Viewing Information About a File Copied to the Controller You can view information about a project file stored on the controller, or retrieved from the controller, at any time. You can view details such as the name of the file, the date and time it was last saved, the SHA-1 key generated for the file, and so on. To view information about a project file stored on the controller, do one of the following: • If a project is not open, click Get Info About Project File (.PT2) on Controller on the Tools menu. Specify the IP address and UDP port (in the range 1 - 65535) of the controller where the project file is stored, and then click OK. • If a project is currently connected to the controller, click Get Info About Project File (.PT2) on Controller on the Commands menu. Note The project connected to the controller can be different from the project file stored on the controller. If a project is open, but not connected to a controller, you cannot view details about a project file stored on the controller. Note If you have just inserted or reset a Main Processor module, you may receive an error message while attempting to view information about a project file on the controller. In this case, you must wait for the MP to complete its re-education process. To determine when re-education is complete, view the event log in the Enhanced Diagnostic Monitor. Once the “Application Write to Flash Completed” and “PT2 Re-education Complete” events appear, re-education is complete, and you will be able to view information about the project file on the controller. TriStation 1131 Developer’s Guide, 4.14.0 Building an Application 333 About the Application’s Initialization Table Each application has an initialization table, which tells the controller’s operating system which data variables need to be set to a non-zero value prior to the application starting to run (such as initialized variables, or those marked as retentive). For example, if you declared a variable (in structured text) as: VAR I1 : DINT := 5; END_VAR the initialization table would have an entry telling the controller’s operating system to set I1 to 5 prior to running the application. For Tricon 11.1 and earlier, Trident, and Tri-GP applications, if there are too many entries in the initialization table, you may be able to download the application to the Emulator, but you will be unable to download it to the controller due to an initialization table overflow error (Error Code PD0004). You will not encounter an initialization table overflow error for Tricon 11.2 and later applications when using the Enhanced protocol to connect to the controller, because there is no limit on the initialization table size for these controllers. However, you will encounter this error when using the Legacy protocol to connect, regardless of the Tricon controller version. For more information on the protocols to use while connecting to a controller, see the Connect Command on page 682. Note For Tricon 11.1 and earlier, Trident, and Tri-GP applications, when you delete a variable, an additional temporary entry is made in the initialization table to set the variable to zero during the next Download Changes operation. As a result, deleting too many variables at once can result in initialization table overflow due to the temporary entries created to set the deleted variables to zero. Additionally, if there are too many retentive variables in the initialization table, you will be unable to build the application (Error Code PC0153). The maximum number of retentive variables depends upon the controller or Main Processor configured in your application. Controller/MP Type Maximum Number of Retentive Variables Tricon 11.2 and later (Model 3009 MP) 2,048 Tricon 11.1 and earlier (Model 3008 and 3009 MPs) 1,896 Tricon 9.5 (Model 3006 MP) No limit, as long as the initialization table does not overflow Trident or Tri-GP 2,000 This section describes how to view and understand the size of the application’s initialization table, and what to do to correct an initialization table overflow problem. Topics include: • Viewing and Understanding Initialization Table Size Information on page 334 • Solving an Initialization Table Overflow Problem on page 335 TriStation 1131 Developer’s Guide, 4.14.0 334 Chapter 2 Application Development Viewing and Understanding Initialization Table Size Information Each time you download your project (see Preparing to Download to the Controller on page 618), information about the total number of initialized or retentive variables, and the number of bytes used in the initialization table, is provided in the Message View at the end of the download process. The maximum size of the initialization table is 64K (65,535 bytes)3. The size of the initialization table is calculated as follows: • Each variable carries a overhead of 8 bytes. • Each BOOL variable uses an additional 1 byte. • Each DINT or REAL variable uses an additional 4 bytes. • Each TIME variable uses an additional 8 bytes. The following sample calculation shows how the values for each variable are used to determine the total size of the initialization table. Example Initialization Table Calculation Assume your project has the following variables, which have been initialized or marked as retentive: • 279 BOOLs • 64 REALs • 401 DINTs • 10 TIME The total number of variables is 754 (279 + 401 + 64 + 10 = 754). 3. For Tricon 11.1 and earlier, Trident, and Tri-GP controllers only. For Tricon 11.2 and later controllers, there is no limit to the size of the initialization table. TriStation 1131 Developer’s Guide, 4.14.0 Building an Application 335 Variable Type Number of Variables Overhead (# variables x 8) Bytes Per Type Bytes Used (# variables x bytes per type) Total Bytes Used (overhead + bytes used) BOOL 279 2,232 1 279 2,511 DINT 401 3,208 4 1,604 4,812 REAL 64 512 4 256 768 TIME 10 80 8 80 160 Totals: 754 6,032 n/a 2219 8,251 6,032 (overhead) + 2,219 (bytes used) = 8,251 In this example, there are a total of 8,251 bytes in the initialization table. Because this is less than the 65,535 limit, you will be able to download the application without encountering an overflow error. Solving an Initialization Table Overflow Problem You will be unable to download the application to the controller if the size of the initialization table is greater than 65,535 bytes. The following are recommendations for reducing the size of the initialization table: • Reduce the number of initial values. • Change variables from retentive to non-retentive. • Create a program that only runs on the first scan to initialize variables. TriStation 1131 Developer’s Guide, 4.14.0 336 Chapter 2 Application Development TriStation 1131 Developer’s Guide, 4.14.0 3 Tricon Controller Configuration Overview 338 Setting Tricon Operating Parameters 341 Allocating Memory for Tricon Points 343 Configuring the Tricon Target System Version 345 Performing an Online Upgrade to Model 3009 MPs 357 Configuring Tricon Hardware 358 Configuring Tricon Communication Modules 372 Configuring Tricon Time Synchronization 422 Printing the Tricon Module Configuration 434 TriStation 1131 Developer’s Guide, 4.14.0 338 Chapter 3 Tricon Controller Configuration Overview This figure shows the main steps for configuring the Tricon controller and their typical order in the project cycle. The controller must be configured before an application can be downloaded and implemented on a controller. Set Up the Project Develop the Application Test with the Emulator Fix Errors Yes Errors? No - Set operating parameters C onfigure the C ontroller - Allocate memory and configure hardware - C onfigure communication to external devices - Set up Time Synchronization (optional) Set Up TriStation C ommunication Implement on the C ontroller Tricon Controller Configuration Steps This list includes the steps that can or should be done during controller configuration. Controller configuration must be completed before an application is downloaded to the Tricon. Description See Set the operating parameters. Setting Tricon Operating Parameters on page 341 Allocate memory and hardware. Allocating Memory for Tricon Points on page 343 Configure hardware. Configuring Tricon Hardware on page 358 Configure communication to external devices. Configuring Tricon Communication Modules on page 372 Set up time synchronization. Configuring Tricon Time Synchronization on page 422 TriStation 1131 Developer’s Guide, 4.14.0 Overview 339 The Tricon Controller Workspace This section describes the Controller Workspace, which is where you specify the configuration for the project. Topics include: • The Tricon Controller Tree on page 339 • The Tricon Configuration Tree on page 339 • The Tricon Controller and Emulator Panels on page 340 For information about how you can change the location of the Controller Workspace pane, see Customizing Your Workspace on page 114. The Tricon Controller Tree The Tricon Controller tree includes the elements (operating parameters, communication settings, memory allocation, and hardware allocation) that can be configured. The tree also includes the Controller and Emulator Panels used to emulate and run an application. The Tricon Configuration Tree The Tricon Configuration tree includes operating parameters, communication, memory allocation, and hardware allocation. TriStation 1131 Developer’s Guide, 4.14.0 340 Chapter 3 Tricon Controller Configuration The Tricon Controller and Emulator Panels The Controller and Emulator Panels display programs running in emulation or in the controller. Controller and Emulator tree TriStation 1131 Developer’s Guide, 4.14.0 Setting Tricon Operating Parameters 341 Setting Tricon Operating Parameters This procedure explains how to specify Tricon operating parameters, which are settings that affect the general operation of the controller, including settings to restrict access to the controller from a TriStation PC and from remote devices. Note The Target System Version displayed on the Operating Parameters screen is the target system version currently configured in the project. This value is not obtained from a connected controller. To view the actual system version of your Tricon system, use the Enhanced Diagnostic Monitor. For more information, see Determining Your Tricon Controller’s System Version on page 346. Procedure 1 Expand the Controller tree, double-click Configuration, and then click Operating Parameters. 2 Specify these properties on the Operating Parameters screen. Property Action Disable Stop on Keyswitch Select the check box to prevent the STOP keyswitch from halting the application running on the controller. The default is cleared. Disable Remote Changes to Outputs Select the check box to prevent external devices, such as a DCS, from writing to output tagnames in the TriStation 1131 application. The default is selected. TriStation 1131 Developer’s Guide, 4.14.0 342 Chapter 3 Tricon Controller Configuration Property Action Allow Disabling of Points Select the check box to allow points to be disabled from TriStation 1131. See Disabling Points on page 640 for more information. The default is cleared. This property can be changed only when your project is in the Download All state. If you change this property (by selecting or clearing the check box), you must perform a Download All to apply your changes to the controller. TriStation 1131 will automatically rebuild the application before it is downloaded. Enable Tricon Node Time Synchronization Note Select the check box to allow the controller to participate in time synchronization across the Peer-to-Peer network as a master node or a slave node (see Configuring Tricon Time Synchronization on page 422). Using the Print All command, you can print a report listing the current Operating Parameters settings. See Printing Project Documents on page 109. TriStation 1131 Developer’s Guide, 4.14.0 Allocating Memory for Tricon Points 343 Allocating Memory for Tricon Points This procedure explains how to change the amount of memory used for input, output, and memory points (tagnames) in the application. Initially, the amount of memory for input and output points is determined by the number and type of I/O modules configured in the TriStation 1131 project. The amount of memory for memory points is set when a TriStation 1131 project is created. You can change these allocations at any time before building and downloading the application. CAUTION In Tricon 11.1 and earlier systems, after an application has been downloaded to the controller or Emulator, changes to memory allocation require a Download All (see Using the Download All Command on page 649). In Tricon 11.2 and later systems, you can increase memory allocation for only I/O points while your project is in the Download Changes state. However, to do so, you MUST first complete the changes that you previously made to the SOE or Peer-to-Peer configuration, by performing a Download Changes operation after each of these changes. If these changes are pending, you will not be able to increase memory allocation for I/O points in the Download Changes state. For more information on the Download Changes state, see Using the Download Changes Command on page 646. To decrease memory allocation for I/O points, or change the memory allocation for memory points or application data, you must perform a Download All. See What Are Undeclared Tagnames? on page 226 for more information about memory allocation for points. Procedure 1 Expand the Controller tree, double-click Configuration, and then expand Memory Allocation. 2 Double-click the type of point you want to change. TriStation 1131 Developer’s Guide, 4.14.0 344 Chapter 3 Tricon Controller Configuration 3 Move the slider up or down to change the memory allocated for the selected point. The following memory allocation types are available to choose from: • Maximum: The maximum amount of memory available to be allocated to this point type. • Allocated: The amount of memory currently allocated to this point type. • Forecast: The amount of memory estimated to be used for this point type after the next download operation. • Used: The amount of memory currently being used for this point type. Performing a download operation will change this value. Note 4 Note In Tricon 11.2 and later systems, while your project is in the Download Changes state, you can only increase the memory allocation for I/O points from the value that was last downloaded to the controller. If you want to decrease the memory allocation for I/O points, or change the memory allocation for memory points or application data, you must change the project state to Download All. See Change State to Download All Command on page 672 for important information about the impact of changing the project state. Repeat for all points to be changed. Using the Print All command, you can print a report listing the current memory allocation settings. See Printing Project Documents on page 109. TriStation 1131 Developer’s Guide, 4.14.0 Configuring the Tricon Target System Version 345 Configuring the Tricon Target System Version This procedure explains how to change the target system version in your project. The target system version determines which Tricon system’s features and modules can be configured in a project. You originally set the target system version when you created a new project, or when you converted an existing project to TriStation 1131 4.14.0. If you change the system version of your Tricon controller (for example, you upgrade your system from 10.1 to 10.3), you must logically configure the change in the TriStation 1131 project. This change requires a Download All. When you change the target system version, TriStation 1131 saves the configuration and attaches the Tricon library that supports the installed MPs. Before committing to the target system version change, you are allowed to back up your project. Note You cannot be connected to the controller while you are changing the target system version. Configuring the target system version is a three-step process: • Determine the system version of the Tricon the project will be downloaded to. • Validate the target system version change to review the changes that will be made to the project before committing to the change. • Change the target system version in the project. Topics include: • Determining Your Tricon Controller’s System Version on page 346 • Validating a Tricon Target System Version Change on page 347 • Changing the Tricon Target System Version on page 349 • Results of a Tricon Target System Version Change on page 353 TriStation 1131 Developer’s Guide, 4.14.0 346 Chapter 3 Tricon Controller Configuration Determining Your Tricon Controller’s System Version Before changing the target system version in your TriStation 1131 project, you should determine the system version of the Tricon controller you will be downloading the project to. You need to know the following: • The model number of the Main Processor modules installed in the Tricon controller (3006, 3006N, 3007, 3008, 3008N, 3008C, or 3009) • The Tricon controller’s system version (for example, 9.6, 10.1, 10.3, 11.1, 11.2, etc.) The easiest way to find this information is to connect to the Tricon controller using the Enhanced Diagnostic Monitor. Note If you are unable to connect to the Tricon controller, or you do not have the Enhanced Diagnostic Monitor, you can also refer to your sales order paperwork, which should specify the Main Processor model installed in your controller, as well as the system version. The target system version currently configured in the project is displayed on the Operating Parameters screen and at the top of the Select Main Processor dialog box. Procedure (Using the Enhanced Diagnostic Monitor) 1 Open the Enhanced Diagnostic Monitor (for more detailed instructions, see the Enhanced Diagnostic Monitor User's Guide). 2 Connect to the node (controller) whose system version you want to find. 3 In the System Overview tree, click System Overview. The System Overview window appears. Tricon System Version 4 View the system version information, located at the top of the System Overview window. TriStation 1131 Developer’s Guide, 4.14.0 Configuring the Tricon Target System Version 347 Validating a Tricon Target System Version Change Before committing to a target system version change, you should validate the change to determine what effect it will have on your project. Validation allows you to plan ahead for the changes that will occur when you switch from one target system version to another. For detailed information about the changes that occur when switching from one target system version to another, see the Target System Version Change Matrix on page 354. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the chassis whose target system version you want to change, and then click Replace MPs. 3 Specify these properties in the Replace Main Processor dialog box. Property Description Model The Main Processor model installed in the Tricona controller that this project will be downloaded to. • For Tricon system versions 9.5.x, 9.51.x, or 9.52.x, select 3006/N, 3007. • For Tricon system versions 9.6–10.x, select 3008/N/Cb. • For Tricon system version 11.x, select 3009. Target System Version The system version of the Tricon controller that this project will be downloaded to. Use the on-screen descriptions to help you determine the correct version to select, based on your Tricon controller configuration. a. TriStation 1131 4.14.0 does not support Tricon system versions 9.4.x and earlier. For a list of TriStation 1131 versions compatible with your Tricon system, see the applicable Tricon Product Release Notice (available on the Global Customer Support website). b. The model 3008/N/C Main Processor is not supported in projects using the Tricon Enhanced Performance platform. TriStation 1131 Developer’s Guide, 4.14.0 348 Chapter 3 Tricon Controller Configuration Note If you are not sure which Main Processor model and Tricon system version to select, use the Enhanced Diagnostic Monitor to verify your Tricon system version information. See Determining Your Tricon Controller’s System Version on page 346 for more information. 4 Select the Validate Only check box. 5 Click OK. TriStation 1131 analyzes your project settings and current controller configuration to determine the modifications that will be made to the project if you change to the selected target system version. 6 In the Messages pane, review the results of the validation to determine if you want to commit to the target system version change. TriStation 1131 Developer’s Guide, 4.14.0 Configuring the Tricon Target System Version 349 Changing the Tricon Target System Version The target system version determines which Tricon system features and modules can be configured in a project. You selected the target system version for your project when you created it, or when you converted the project from a previous version of TriStation 1131. Note If the project’s hardware configuration includes a model 3006 or 3007 Main Processor, you will not be able to upgrade to a model 3008 or 3009 Main Processor during project conversion. In this case, you must first convert the project with Tricon v9 - 3006 Main Processor as the target system version; then change the target system version after the project conversion is complete. For information on converting your project, see Converting Version 4.x Tricon Projects on page 16. If you have upgraded your Tricon controller to a newer version, you also need to change the target system version in your TriStation 1131 project. Changing the target system version requires a Download All. You cannot change the project’s target system version while the project is in the Download Changes state. You cannot be connected to the controller while changing the target system version. Note You cannot change (upgrade or downgrade) the target system version for a project that meets all of the following criteria: • Was originally created in TriStation 1131 4.4 or 4.5. • Includes a mix of High-Density and Enhanced Low-Density chassis. Topics include: • Target System Version Change Rules on page 349 • If You Have a TCM Configured in Your TriStation 1131 Project on page 350 • If You Have Peer-to-Peer Communication Configured in Your TriStation 1131 Project on page 350 • Changing the Target System Version on page 351 Target System Version Change Rules When changing the target system version, you can: • Upgrade from a model 3006 or 3007 Main Processor to a model 3008 or 3009 Main Processor. • Downgrade from a model 3009 Main Processor to a model 3008 Main Processor. • Upgrade or downgrade the version number of the Tricon system (for example, upgrade from 9.8 to 10.0, or downgrade from 10.2 to 10.0). When changing the target system version, you cannot: • Downgrade from a model 3008 or 3009 Main Processor to a model 3006 or 3007 Main Processor. • Downgrade a project created in TriStation 1131 4.6 with a mix of High-Density and Enhanced Low-Density chassis to a target system version of 10.2.x or earlier. TriStation 1131 Developer’s Guide, 4.14.0 350 Chapter 3 Tricon Controller Configuration If You Have a TCM Configured in Your TriStation 1131 Project If you have a model 4351A/B, 4352A/B, or 4353/4354 TCM configured in your project, you may want to export the TCM configuration prior to changing the target system version, to save your configuration settings for future use. See Exporting the TCM Configuration to a File on page 400. If you have a model 4351A/4352A TCM configured in your Tricon 10.2 or 10.3 project, please make note of the following: • If you are upgrading from Tricon 10.2 to 10.3, the TCM will be removed during project conversion. — Once project conversion is complete, you can add the 4351A/4352A module back to your project. — If you exported the existing TCM configuration in the 10.2 project prior to project conversion, you can then import the configuration file in your 10.3 project. — If you did NOT export the existing TCM configuration in the 10.2 project prior to project conversion, you must reconfigure the module from scratch, using the instructions provided in Configuring Tricon TCM Ports on page 379. • If you are downgrading from Tricon 10.3 to 10.2, the TCM will be removed during project conversion. — Once project conversion is complete, you can add the 4351A/4352A module back to your project. — You must reconfigure the module from scratch, using the instructions provided in Configuring Tricon TCM Ports on page 379. You cannot import a TCM configuration file that was exported from the 4351A/4352A module originally configured in the 10.3 project. If you are downgrading from a Tricon 11.1.x or later system, and have more than 31 nodes configured in the TCM, the configuration information for nodes 32-254 will be lost. Ensure that you have backed up your project file before changing the target system version. If You Have Peer-to-Peer Communication Configured in Your TriStation 1131 Project If you are downgrading from a Tricon 11.1.x or later system, and have more than a maximum of 100 Peer-to-Peer (Standard and Enhanced) Send and Receive function blocks configured in TriStation 1131, the number of Sends and Receives will be automatically changed to 100. For more information on manually changing this number, see Allocating Peer-to-Peer Memory on page 288. You will also need to modify your TriStation 1131 project file to include a maximum of only 50 Standard Peer-to-Peer Send and Receive function blocks, and remove any Enhanced Peer-toPeer function blocks. For more information, see Table 35 Maximum Number of Peer-to-Peer Function Blocks per Controller Type (page 284). TriStation 1131 Developer’s Guide, 4.14.0 Configuring the Tricon Target System Version 351 Changing the Target System Version Before committing to a target system version change, you should validate the change to determine what effect it will have on your project. See Validating a Tricon Target System Version Change on page 347. Procedure 1 Verify that you are not connected to the controller. 2 If needed, change the project state to Download All. • On the Commands menu, click Change State to Download All. • In the Change Project State to Download All dialog box, click Change State. 3 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 4 Double-click the chassis whose system version you want to change, and then click Replace MPs. Note 5 If the Replace MPs button is unavailable, the project is in the Download Changes state. Go back to step 2 to change the project state before continuing. Specify these properties in the Replace Main Processor dialog box. TriStation 1131 Developer’s Guide, 4.14.0 352 Chapter 3 Tricon Controller Configuration Property Description Model The Main Processor model installed in the Tricona controller that this project will be downloaded to. • For Tricon system versions 9.5.x, 9.51.x, or 9.52.x, select 3006/N, 3007. • For Tricon system versions 9.6–10.x, select 3008/N/Cb. • For Tricon system version 11.x, select 3009. Notes: If the project is currently configured for a model 3008 or 3009 MP, you cannot downgrade to a model 3006 or 3007 MP. If you must create a project for a 3006 or 3007 MP, you need to create a new project, or re-convert the project using a backup of the project created in an earlier version of TriStation 1131. For more information, see Converting Existing Projects to Version 4.14.0 on page 13, or Creating a New Project on page 22. If you are downgrading from a Tricon 11.1.x or later system, ensure that the node number configured in the project is between 1 to 31. If the node number is greater than 31, you must change the node number before you downgrade the target system version. For more information about changing the node number, see Configuring the TriStation 1131 Network Connection on page 539. Target System Version The system version of the Tricon controller that this project will be downloaded to. Use the on-screen descriptions to help you determine the correct version to select, based on your Tricon controller configuration. a. TriStation 1131 4.14.0 does not support Tricon system versions 9.4.x and earlier. For a list of TriStation 1131 versions compatible with your Tricon system, see the applicable Tricon Product Release Notice (available on the Global Customer Support website). b. The model 3008/N/C Main Processor is not supported in projects using the Tricon Enhanced Performance platform. Note If you are not sure which Main Processor model and Tricon system version to select, use the Enhanced Diagnostic Monitor to verify your Tricon system version information. See Determining Your Tricon Controller’s System Version on page 346 for more information. 6 Click OK. 7 When asked to confirm your selection, click Yes to continue. 8 When asked to backup your project before changing the target system version, do one of the following: • (Recommended) Click Yes and then specify the folder to save the backup file to. Use the suggested name, or specify a new one. The file extension (.bt2) does not have to be included in the name. • Click No to continue without creating a backup file. TriStation 1131 Developer’s Guide, 4.14.0 Configuring the Tricon Target System Version 353 TriStation 1131 reconfigures your project to the selected target system version. All current configuration settings are maintained; however, any parameters that did not exist in the previous version are set to their default values. 9 In the Messages pane, review the results of the target system version change. For more information, see the Target System Version Change Matrix on page 354. 10 To finish the process, you must build the application and download it to the controller. Results of a Tricon Target System Version Change The following table describes the changes that are made to your project when changing from one target system version to another. To use the Target System Version Change Matrix: 1 Find the column for your current system version on the top. 2 Then move down to locate the row (on the left) for the system version you want to change your project to. The box where your selected column and row meet describes the changes that will be made to your project if you change to the new target system version. TriStation 1131 Developer’s Guide, 4.14.0 354 Target System Version Change Matrix NEW VERSION 3006 MP 9.5.x, 9.51.x, or 9.52.x 3008 MP 9.6.x 9.9.x 3008 MP 10.0.x 3008 MP 10.2.x 3008 MP 10.3.x 3008 MP 10.4.x 10.5.x 3009 MP 11.0.x 3009 MP 11.1.x 11.2.x Note: A target system version change (upgrade or downgrade) requires that the project state be changed to Download All, with one exception—when you are converting a project created in a version of TriStation 1131 prior to 4.6. During project conversion, projects created with a previous version of TriStation 1131 will remain in the Download Changes state regardless of a target system version change. For more information, see Converting Existing Projects to Version 4.14.0 on page 13. 3006 MP 9.5.x 9.51.x 9.52.x NOT ALLOWED UPGRADE 3008 MP 9.6.x 9.9.x UPGRADE • Add support for model 4351, 4352 TCMs UPGRADE • Add support for model 4351, 4352 TCMs UPGRADE • Add support for model 4351A and 4352A TCMs UPGRADE • Add support for model 4351A and 4352A TCMs NOT ALLOWED NOT ALLOWED NOT ALLOWED NOT ALLOWED NOT ALLOWED NOT ALLOWED NOT ALLOWED DOWNGRADE • Remove TCMs (all models) DOWNGRADE • Remove TCMs (all models) DOWNGRADE • Remove TCMs (all models) • Remove model 3720, 3721, 3625 I/O modules DOWNGRADE • Remove TCMs (all models) • Remove model 3720, 3721, 3625 I/O modules DOWNGRADE • Remove TCMs (all models) • Remove model 3720, 3721, 3625, 3807 I/O modules NOT ALLOWED NOT ALLOWED DOWNGRADE • Remove model 4351A, 4352A TCMs • Add support for model 4351, 4352 TCMs DOWNGRADE • Remove model 4351A, 4352A TCMs • Remove model 3720, 3721, 3625 I/O modules • Add support for model 4351, 4352 TCMs DOWNGRADE • Remove model 4351A, 4351B, 4352A, 4352B, 4353, 4354 TCMs • Remove model 3720, 3721, 3625 I/O modules • Add support for model 4351, 4352 TCMs DOWNGRADE • Remove model 4351A, 4351B, 4352A, 4352B, 4353, 4354 TCMs • Remove model 3720, 3721, 3625, 3807 I/O modules • Add support for model 4351, 4352 TCMs NOT ALLOWED NOT ALLOWED DOWNGRADE • Remove model 3720, 3721, 3625 I/O modules DOWNGRADE • Remove model 4351B, 4352B, 4353, 4354 TCMs • Remove model 3720, 3721, 3625 I/O modules DOWNGRADE • Remove model 4351B, 4352B, 4353, 4354 TCMs • Remove model 3720, 3721, 3625, 3807 I/O modules NOT ALLOWED NOT ALLOWED 3008 MP 10.0.x 3008 MP 10.1.x 3008 MP 10.1.x UPGRADE • Add support for model 4351A and 4352A TCMs • Remove model 4351 and 4352 TCMs Tricon Controller Configuration ORIGINAL VERSION Chapter 3 TriStation 1131 Developer’s Guide, 4.14.0 Table 38 Table 38 Target System Version Change Matrix (continued) ORIGINAL VERSION 3008 MP 10.2.x 3008 MP 10.3.x 3008 MP 9.6.x 9.9.x UPGRADE • Add support for model 4351A, 4352A TCMs • Add support for model 3720, 3721, 3625 I/O modules 3008 MP 10.0.x 3008 MP 10.1.x 3008 MP 10.2.x UPGRADE • Add support for model 4351A, 4352A TCMs • Add support for model 3720, 3721, 3625 I/O modules UPGRADE • Add support for model 4351A, 4352A TCMs • Add support for model 3720, 3721, 3625 I/O modules • Remove model 4351 and 4352 TCMs UPGRADE • Add support for model 3720, 3721, 3625 I/O modules • Upgrade configuration options for model 4351A, 4352A TCMs UPGRADE • Add support for model 4351A, 4351B, 4352A, 4352B, 4353, 4354, TCMs • Add support for model 3720, 3721, 3625 I/O modules UPGRADE • Add support for model 4351A, 4351B, 4352A, 4352B, 4353, 4354, TCMs • Add support for model 3720, 3721, 3625 I/O modules UPGRADE • Add support for model 4351A, 4351B, 4352A, 4352B, 4353, 4354, TCMs • Add support for model 3720, 3721, 3625 I/O modules • Remove model 4351, 4352 TCMs UPGRADE • Add support for model 4351B, 4352B, 4353 and 4354 TCMs • Add support for model 3720, 3721, 3625 I/O modules UPGRADE • Add support for model 4351B, 4352B, 4353 and 4354 TCMs • Remove model 4351A and 4352A TCMsb UPGRADE • Add support for model 4351A, 4351B, 4352A, 4352B, 4353, 4354, TCMs • Add support for model 3720, 3721, 3625, 3807 I/O modules UPGRADE • Add support for model 4351A, 4351B, 4352A, 4352B, 4353, 4354, TCMs • Add support for model 3720, 3721, 3625, 3807 I/O modules UPGRADE • Add support for model 4351A, 4351B, 4352A, 4352B, 4353, 4354, TCMs • Add support for model 3720, 3721, 3625, 3807 I/O modules • Remove model 4351, 4352 TCMs UPGRADE • Add support for model 4351B, 4352B, 4353 and 4354 TCMs • Add support for model 3720, 3721, 3625, 3807 I/O modules UPGRADE • Add support for model 4351B, 4352B, 4353 and 4354 TCMs • Add support for model 3807 I/O module • Remove model 4351A and 4352A TCMs 3008 MP 10.3.x 3008 MP 10.4.x 10.5.x DOWNGRADE • Remove model 4351B, 4352B, 4353, 4354 TCMs • Remove model 4351A and 4352A TCMsa UPGRADE • Add support for model 3807 I/O module 3009 MP 11.0.x 3009 MP 11.1.x 11.2.x DOWNGRADE • Remove model 4351B, 4352B, 4353, 4354 TCMs • Remove support for model 3807 I/O module NOT ALLOWED NOT ALLOWED DOWNGRADE • Remove support for model 3807 I/O module DOWNGRADE • Remove support for model 3807 I/O module • Remove UCM DOWNGRADE • Remove UCM • Add support for model 4353 and 4354 TCMs DOWNGRADE • Remove UCM DOWNGRADE • Remove UCM • Add support for model 4353 and 4354 TCMs Configuring the Tricon Target System Version 355 TriStation 1131 Developer’s Guide, 4.14.0 3008 MP 10.4.x 10.5.x 3006 MP 9.5.x, 9.51.x, or 9.52.x 356 Target System Version Change Matrix (continued) 3009 MP 11.0.xc 3009 MP 11.1.x 11.2.x 3006 MP 9.5.x, 9.51.x, or 9.52.x 3008 MP 9.6.x 9.9.x UPGRADE • Add support for model 4351A, 4351B, 4352A, 4352B, 4353, 4354, TCMs • Add support for model 3720, 3721, 3625, 3807 I/O modules • Add support for UCM UPGRADE • Add support for model 4351A, 4351B, 4352A, 4352B, TCMs • Add support for model 3720, 3721, 3625, 3807 I/O modules • Add support for UCM 3008 MP 10.4.x 10.5.x 3008 MP 10.0.x 3008 MP 10.1.x 3008 MP 10.2.x 3008 MP 10.3.x UPGRADE • Add support for model 4351A, 4351B, 4352A, 4352B, 4353, 4354, TCMs • Add support for model 3720, 3721, 3625, 3807 I/O modules • Add support for UCM UPGRADE • Add support for model 4351A, 4351B, 4352A, 4352B, 4353, 4354, TCMs • Add support for model 3720, 3721, 3625, 3807 I/O modules • Remove model 4351 • Add support for UCM UPGRADE • Add support for model 4351B, 4352B, 4353 and 4354 TCMs • Add support for model 3720, 3721, 3625, 3807 I/O modules • Add support for UCM UPGRADE • Add support for model 4351B, 4352B, 4353 and 4354 TCMs • Add support for model 3807 I/O module • Remove model 4351A and 4352A TCMs • Add support for UCM UPGRADE • Add support for model 3807 I/O module • Add support for UCM UPGRADE • Add support for UCM UPGRADE • Add support for model 4351A, 4351B, 4352A, 4352B, TCMs • Add support for model 3720, 3721, 3625, 3807 I/O modules • Add support for UCM UPGRADE • Add support for model 4351A, 4351B, 4352A, 4352B, TCMs • Add support for model 3720, 3721, 3625, 3807 I/O modules • Remove model 4351 TCM • Add support for UCM UPGRADE • Add support for model 4351B, and 4352B TCMs • Add support for model 3720, 3721, 3625, 3807 I/O modules • Add support for UCM UPGRADE • Add support for model 4351B and 4352B TCMs • Add support for model 3807 I/O module • Remove model 4351A and 4352A TCMs • Add support for UCM UPGRADE • Add support for model 3807 I/O module • Add support for UCM • Remove model 4353 and 4354 TCMs UPGRADE • Add support for UCM • Remove model 4353 and 4354 TCMs 3009 MP 11.0.x 3009 MP 11.1.x 11.2.x DOWNGRADE • Add support for model 4353 and 4354 TCMs UPGRADE • Add support for UCM • Remove model 4353 and 4354 TCMs a. When downgrading a Tricon 10.3 project to Tricon 10.2, if a model 4351A or 4352A TCM was installed and configured in the 10.3 project, it will be removed during project conversion. Once the project conversion is complete, you can add the 4351A/4352A TCM to the project again, and reconfigure it for use with the Tricon 10.2 system. See If You Have a TCM Configured in Your TriStation 1131 Project on page 350 for more information. b. When upgrading a Tricon 10.2 project to Tricon 10.3, if a model 4351A or 4352A TCM was installed and configured in the 10.2 project, it will be removed during project conversion. Once the project conversion is complete, you can add the 4351A/4352A TCM to the project again, and reconfigure it for use with the Tricon 10.3 system. See If You Have a TCM Configured in Your TriStation 1131 Project on page 350 for more information. c. When upgrading to a Tricon 11.x project with a model 3009 MP, the UCM is supported only if the installed main chassis is EP_MAIN. Tricon Controller Configuration ORIGINAL VERSION Chapter 3 TriStation 1131 Developer’s Guide, 4.14.0 Table 38 Performing an Online Upgrade to Model 3009 MPs 357 Performing an Online Upgrade to Model 3009 MPs Performing an online upgrade enables you to safely upgrade your system while it is online, without having to shut down your plant. You can upgrade a Tricon 10.3, 10.4, or 10.5 system, with model 3008 Main Processors installed, to a Tricon 11.2 system with model 3009 Main Processors, while your system is online. Before performing an online upgrade, your project and Tricon system must meet a number of prerequisites, which are detailed in Technical Application Note 51 on the Global Customer Support (GCS) website. The following two commands enable you to perform the online upgrade: • Check Configuration Before Online Upgrade Command: Enables you to confirm that your project meets all the prerequisites and is ready for the online upgrade process. • Online Upgrade Wizard Command: Enables you to start and complete the online upgrade process. For detailed instructions on performing the online upgrade, precautions to be taken while performing the upgrade, and additional information, see Technical Application Note 51 on the Global Customer Support (GCS) website. TriStation 1131 Developer’s Guide, 4.14.0 358 Chapter 3 Tricon Controller Configuration Configuring Tricon Hardware This section explains how to configure the hardware for a Tricon controller. Topics include: • Adding a Tricon Chassis on page 358 • Replacing a Tricon Main Chassis on page 360 • Deleting a Tricon Chassis on page 361 • Determining Tricon Chassis Power Usage on page 362 • Inserting and Removing Tricon Modules on page 363 • Configuring a Tricon AI Single-Ended or Differential Module on page 365 • Configuring a Tricon DO Module on page 367 • Configuring a Tricon PI Module on page 369 • Adding a Tricon Thermocouple Module on page 370 For information on configuring communication modules, see Configuring Tricon Communication Modules on page 372. Adding a Tricon Chassis This procedure explains how to add a Tricon chassis to the controller configuration. Each controller configuration must include one of the following Main Chassis: • HD_MAIN (High-Density Chassis) • LD_MAIN (Low-Density Chassis) • EP_MAIN (Enhanced Performance Chassis, available only with Tricon 11.x systems) Additional chassis in a configuration are Expansion Chassis (HD_EXP, LD_EXP, or E_LD_EXP), or Remote Chassis (HD_RXM or LD_RXM). The following rules apply to configuring different chassis types in a single system: • An Enhanced Low-Density Expansion Chassis (E_LD_EXP) may be configured in a system with any of the following Main Chassis: — An Enhanced Performance Main Chassis (Tricon 11.x systems only) — A High-Density or Low-Density Main Chassis (Tricon 10.3 and later systems only) • A Low-Density Expansion Chassis (LD_EXP) or Low-Density Remote Chassis (LD_RXM) can be configured in a system with any of the following Main Chassis: — High-Density Main Chassis — Enhanced Performance Main Chassis • A High-Density Expansion Chassis (HD_EXP) or Remote Chassis (HD_RXM) cannot be configured in a system with a Low-Density Main Chassis. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Hardware 359 See Configuring the Tricon Target System Version on page 345 for the target system version upgrade/downgrade rules that apply to configurations with mixed chassis types. In Tricon 11.0.x and earlier systems, you can add an Expansion or Remote chassis only when your project is in the Download All state. In Tricon 11.1.x and later systems, you can add an Expansion or Remote chassis when your project is in the Download Changes or Download All state. Tricon Chassis Numbering In Tricon systems, the Main Chassis is also referred to as Chassis 1. Expansion or Remote Chassis are referred to as Chassis 2, 3, and so on. When you add a chassis, the chassis is automatically assigned a number in sequence from 2 to 15. You cannot change this number. Procedure 1 Expand the Controller tree, double-click Configuration, and then click Hardware Allocation. 2 Right-click Hardware Allocation, and then click Add Chassis. The Add Chassis dialog box appears. Note In Tricon 11.0.x and earlier systems, this command is disabled when your project is in the Download Changes state. 3 Select the type of chassis you want to add. 4 Click OK to add the selected chassis to the configuration. TriStation 1131 Developer’s Guide, 4.14.0 360 Chapter 3 Tricon Controller Configuration Replacing a Tricon Main Chassis This procedure explains how to replace a Tricon High-Density Main Chassis (HD_MAIN) with a Tricon Enhanced Performance Main Chassis (EP_MAIN) and vice-versa, in Tricon 11.x and later systems. Only projects with a system configuration that includes a Tricon HD_MAIN chassis, and a target system version of 9.6.x or later, can be upgraded to the EP_MAIN chassis. When replacing an EP_MAIN chassis with a HD_MAIN chassis, ensure that any other Remote or Expansion chassis configured in the project is compatible with the target system version associated with the HD_MAIN chassis. For more detailed compatibility information, please see the Product Release Notice for your Tricon system version. When replacing a HD_MAIN chassis with an EP_MAIN chassis, ensure that the Main Processor models present in the chassis are supported by the EP_MAIN chassis. As the EP_MAIN chassis supports only model 3009 Main Processors, remove any incompatible models before you begin the chassis replacement. Also, ensure that you move I/O modules, if any, in slot 2 of the HD_MAIN chassis to other slots before the chassis replacement, as only communication modules can be installed in slot 2 of the EP_Main chassis. Chassis replacement is not allowed between the Tricon Low-Density Main Chassis (LD_MAIN) and HD_MAIN/EP_MAIN chassis, or between any other Remote or Expansion chassis. Chassis replacement can only be performed in the Download All state. Procedure 1 Expand the Controller tree, double-click Configuration, and then expand the Hardware Allocation node. 2 Do one of the following: • Right-click the chassis you want to replace, and then click Replace Chassis. • Double-click the Hardware Allocation node to open the Item Properties dialog box, and then click Replace Chassis. Note Before you replace the HD_MAIN chassis with an EP_MAIN chassis, replace the model 3006, 3007, or 3008 Main Processor, if any, with a model 3009 Main Processor. If you do not, you will be prompted to replace the Main Processor before you proceed with the chassis replacement. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Hardware 3 361 When prompted to confirm the chassis replacement, click OK. The Controller and Emulator panels are closed. 4 When asked to backup your project before changing the chassis, do one of the following: • (Recommended) Click Yes and then specify the folder to save the backup file to. Use the suggested name, or specify a new one. The file extension (.bt2) does not have to be included in the name. • Click No to continue without creating a backup file. The chassis replacement is completed, and any configuration changes that occurred during chassis replacement are displayed in the Messages pane. Deleting a Tricon Chassis The following rules apply when deleting a chassis: • In Tricon 11.1.x and later systems, you can delete an Expansion or Remote chassis that was added in the Download Changes state, as long as the project configuration has not yet been downloaded to the controller. Note If you added an Expansion or Remote chassis in the Download Changes state, and then downloaded it to the controller, you can remove it only when your project is in the Download All state. • In Tricon 11.0.x and earlier systems, you cannot delete a chassis when your project is in the Download Changes state. • In Tricon systems, you can delete only the last chassis in a configuration. If you have only one chassis in a configuration, it cannot be deleted. For example, if you have four chassis in your configuration, and you want to delete chassis 2, you must first delete chassis 3 and 4 before you can delete chassis 2. You cannot delete the Main Chassis. CAUTION Deleting a chassis removes all of the information associated with it, including configured modules, from your project. You cannot undo the delete operation. Be absolutely sure you want to delete the chassis before continuing. If you have tagnames assigned to points on I/O modules, you must reassign the tagnames before deleting the chassis. Failure to do so will result in unresolved tagnames. Procedure 1 Expand the Controller tree, double-click Configuration, and then click Hardware Allocation. 2 Right-click the chassis that you want delete, and then click Delete Chassis. TriStation 1131 Developer’s Guide, 4.14.0 362 Chapter 3 Tricon Controller Configuration Determining Tricon Chassis Power Usage This procedure explains how to display the amount of power used by a Tricon chassis. For more information, see the Planning and Installation Guide for Tricon v9-v11 Systems. Procedure 1 Expand the Controller tree, double-click Configuration, and then click Hardware Allocation. The Chassis Power Usage screen shows information about the logic power used by each chassis. • Total Power Supply: Shows the maximum logic power that the chassis can support. • Total Power Used: Shows how much logic power is being used by the current configuration of modules in a chassis. • Available: Shows the amount of available (unused) logic power. 2 If the Available power is negative, delete one or more modules from the chassis and add them to another chassis in the configuration. 3 Recheck the power usage for the chassis to ensure the logic power is acceptable. If acceptable, the physical installation must be changed to match the logical configuration in TriStation 1131. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Hardware 363 Inserting and Removing Tricon Modules This procedure explains how to add and remove modules to/from a Tricon configuration. To add a module, the used memory must be less than the allocated memory, and the remaining available memory must be sufficient to accommodate all the points in the module. For example, if the allocated memory is 500 points and the used memory is 450 points, the available memory is 50 points. So, if you want to add a module that requires 64 points, the allocated memory must be increased accordingly to make the available memory sufficient. In the Download All state, when the available memory is not sufficient, the allocated memory is automatically increased, allowing you to add the module. You can also manually increase the allocated memory. For more information on viewing or increasing the allocated memory, see Allocating Memory for Tricon Points on page 343. In the Download Changes state, you can add a module depending on the following conditions: • When sufficient memory is available, you can add a module. This applies to all Tricon system versions. • When sufficient memory is not available: — In Tricon 11.2 and later systems, memory allocation is automatically increased, allowing you to add the module. However, if there are pending changes to SOE or Peer-to-Peer configuration, the memory allocation cannot be automatically increased. To continue to add the module, you must first perform a Download Changes operation to commit the pending SOE or Peer-to-Peer configuration changes. For more information, see Allocating Memory for Tricon Points on page 343. — In Tricon 11.1 and earlier systems, you cannot add the module, as you cannot increase the memory allocation in the Download Changes state. You must change the state to Download All to be able to add the module. You can remove a module when your project is in the Download All or Download Changes state. However, in the Download Changes state, you can remove the module only if it is not yet downloaded to the controller. If it is already downloaded to the controller, it can be removed only when your project is in the Download All state. If your project is in the Download All state, you can move I/O and communication modules in the Hardware Allocation tree via a drag-and-drop operation. Modules may be moved within the chassis, or from one chassis to another. If tagnames have been assigned to a module that is installed in the target slot, those tagnames are deleted when a new module is moved to that slot. If tagnames have been assigned to a module that is moved, the point address of the tagnames is also updated. If the module being moved and the target slot are incompatible, an error message will appear, stating that the drag-and-drop operation cannot be performed. For information about the modules that are compatible with your system, see the Planning and Installation Guide for Tricon v9-v11 Systems. TriStation 1131 Developer’s Guide, 4.14.0 364 Chapter 3 Tricon Controller Configuration Procedure for Adding a Module 1 Expand the Controller tree, double-click Configuration, and then expand the Hardware Allocation node. 2 Expand the node for the chassis you want to add a module to. 3 Do one of the following: 4 • Right-click the chassis, and then click Insert Module. • Double-click the chassis to open the Item Properties dialog box, click an empty slot, and then click Insert. In the Insert Module dialog box, select the type of module you want to add, and then click OK. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Hardware 365 Procedure for Removing a Module 1 Expand the Controller tree, double-click Configuration, and then expand the Hardware Allocation node. 2 Expand the node for the chassis you want to remove a module from. 3 Do one of the following: • Right-click the module you want to remove from the configuration, and then click Remove Module. • Double-click the chassis to open the Item Properties dialog box, click the module to be removed from the configuration, and then click Remove. This cannot be undone. Configuring a Tricon AI Single-Ended or Differential Module This procedure explains how to configure a Tricon Analog Input Single-Ended (model 3720) or Differential (model 3721) module. For both modules, the resolution type and field power monitoring status can be specified. For the Differential module, the input type can also be specified. WARNING Changing the resolution type on model 3720 and 3721 AI modules will cause all input points on the module to change. A change from high to low resolution (or vice-versa) results in a value change by a factor of four. Changing field power monitoring from On to Off (or vice-versa) will have a similar effect, causing all input points on the module to temporarily change to 0 for 1-2 scans. You must modify your application to take these changes into account. During a Download Changes operation, the implementation of the logic change will occur before the implementation of the change on the modules. This may result in a mismatch between what the application expects and the actual value from the module. All points should be bypassed during a resolution or field power monitoring change to prevent any unintended application problems. The model 3720 and 3721 AI modules are compatible only with Tricon 10.2 and later systems. Procedure 1 Expand the Controller tree, double-click Configuration, and then expand the Hardware Allocation node. 2 Expand the node for the chassis where the module is installed. 3 Do one of the following: • Right-click the slot where the module is installed, and then click Setup Module. • Double-click the slot to open the Item Properties dialog box, and then click Setup. TriStation 1131 Developer’s Guide, 4.14.0 366 Chapter 3 Tricon Controller Configuration The Single Ended AI Setup or Differential AI Setup dialog box appears. 4 Specify these properties in the AI Setup dialog box. Property Action Resolution Type Select the resolution to be used for the point. Available with SingleEnded and Differential AI modules. • Standard Resolution: Data resolution is 12 bits, which is 4095 counts at the maximum range of 5 volts. For a Differential AI module, Standard Resolution cannot be selected if Bipolar Input is selected. • High Resolution: Data resolution is 14 bits, which is 16383 counts at the maximum range of 5 volts. The default is Standard Resolution. Differential AI Input Type Select the input type for the point. Only available with the Differential AI module. • Unipolar Input: 0 to 5 volts (with 6% over-range). • Bipolar Input: -5 to 5 volts (with 6% under-range and over-range). Available only if High Resolution is selected. The default is Unipolar Input. Field Power Monitoring Select whether the module should monitor field power at the termination panel. When field power monitoring is On, the module will report when field power at the term panel goes in or out of range. Applicable only if you are using a term panel that passes field power to the module. The default is Off. If you are not using a term panel that passes field power to the module, you must select Off. If you select On, and the term panel does not support field power monitoring, you will see Field Power faults on the module. For more information about external term panels, see the Field Terminations Guide for Tricon v9-v11 Systems. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Hardware 5 367 Click OK to save your changes. Configuring a Tricon DO Module This procedure explains how to configure a Tricon Digital Output (model 3625) module, which allows you to specify how each point is configured. The model 3625 DO module is compatible only with Tricon 10.2 and later systems. Procedure 1 Expand the Controller tree, double-click Configuration, and then expand the Hardware Allocation node. 2 Expand the node for the chassis where the module is installed. 3 Do one of the following: • Right-click the slot where the module is installed, and then click Setup Module. • Double-click the slot to open the Item Properties dialog box, and then click Setup. The DO Setup dialog box appears. 4 Select the tagname to be configured, and then specify these properties in the DO Setup dialog box. TriStation 1131 Developer’s Guide, 4.14.0 368 Chapter 3 Tricon Controller Configuration Property Action DO Point Options Select the option to be used for the DO point. • Not Used: Provides the same fault detection as for NonSupervised points, except reporting of benign field fault conditions is suppressed. Points configured as Not Used will be energized if the application commands them on. • Non-Supervised: Provides detection of all internal faults and limited external faults associated with the field device or wiring. • Supervised: Provides detection of all internal faults and detection of all external faults associated with field device or wiring. The default is Non-Supervised. Shorted Threshold Enter the number of ohms below which values are alarmed as a shorted load. Typical threshold values are 10 to 48 ohms. The available range is 0 to 65,535. The default is 10. Only available if the points are supervised. Open Threshold Enter the number of ohms above which values are alarmed as an open load. Typical threshold values are 480 to 3,200 ohms. The available range is 0 to 65,535. The default is 2,400. Only available if the points are supervised. 5 Continue to select tagnames and specify settings as needed. 6 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Hardware 369 Configuring a Tricon PI Module This procedure explains how to configure a Tricon Pulse Input or Enhanced Pulse Input module, which are used for speed and RPM inputs. Each point can be independently configured. Procedure 1 Expand the Controller tree, double-click Configuration, and then expand the Hardware Allocation node. 2 Expand the node for the chassis where the module is installed. 3 Do one of the following: • Right-click the slot where the module is installed, and then click Setup Module. • Double-click the slot to open the Item Properties dialog box, and then click Setup. The Pulse Input Setup screen appears. 4 Select the tagname to be configured, and then specify these properties in the Pulse Input Setup dialog box. Property Action Rate Type Select the type of rate applied to pulse input signals: Speed or RPM. Maximum RPM Enter the revolutions per minute for the pulse input device; used with RPM. Maximum Speed Enter the speed for the pulse input device; used with Speed rate type. Pulses Per Revolution Enter the number of pulses per revolution of the measuring shaft; used with RPM rate type. TriStation 1131 Developer’s Guide, 4.14.0 370 Chapter 3 Tricon Controller Configuration Property Action Scale Factor Enter the scaling value to convert pulse input signals into engineering units. For: • Pulses per second, set to 0.016667. • Pulses per minute, set to 1.0 (default). • Pulses per hour, set to 60.0 5 Continue to select tagnames and specify settings as needed. 6 Click OK to save your changes. Adding a Tricon Thermocouple Module This procedure explains how to specify the type of Tricon thermocouple module, which must match the module that is installed in the system. Because these modules come in a variety of configurations, select carefully. For more information, see the Planning and Installation Guide for Tricon v9-v11 Systems. The conditions under which a Tricon thermocouple module can be added or removed are the same as for other Tricon modules. For detailed information on these conditions, see Inserting and Removing Tricon Modules on page 363. Procedure 1 Expand the Controller tree, click Configuration, and expand Hardware Allocation. 2 Expand the chassis where the module is installed, double-click the thermocouple module slot, and then click Insert. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Hardware 3 371 From the module list, select the type of thermocouple module installed in the Tricon, as indicated by these properties. Property Description Model 3706/A/AN or 3708/E/EN Type E, J, K, T Specifies the thermocouple type installed. For 3706, J, K, or T. For 3708, E, J, K, or T. Degree conversion dgC is converted to Celsius. dgF is converted to Fahrenheit. UpS (upscale) DnS (downscale) Specifies value returned if voltage is out-of-range, or burnout occurs. • Upscale returns +32,767. • Downscale returns –32,767. For model 3708E only. Points For model 3706, 32 points. For model 3708, 16 points. 4 Click the type of module installed in the controller, and click OK. There are no other properties to specify. TriStation 1131 Developer’s Guide, 4.14.0 372 Chapter 3 Tricon Controller Configuration Configuring Tricon Communication Modules This section explains how to configure Tricon communication modules for communication with external devices. Note In addition to configuring ports on the communication module(s), you also need to configure the Tricon’s network and/or serial connection to the TriStation PC, in order to connect to the Tricon and download your application. For more information, see Chapter 5, Tricon Communication with TriStation 1131. Topics include: • Configuring Tricon ACM Ports on page 372 • Configuring Tricon HIM Ports on page 374 • Configuring Tricon EICM Ports on page 375 • Configuring Tricon NCM Ports on page 376 • Configuring Tricon SMM Ports on page 378 • Configuring Tricon TCM Ports on page 379 • Configuring Tricon UCM Ports on page 403 Configuring Tricon ACM Ports This procedure explains how to configure ports on a Tricon ACM, which supports these connections: • On NET 1, a network connection to a Foxboro Intelligent Automation (I/A) Series DCS or Foxboro Evo System • On NET 1, time synchronization with a Foxboro I/A Series DCS or Foxboro Evo System • On NET 2, a network connection to a TriStation PC or other network devices • On NET 2, time synchronization with the Tricon master node You can install primary and redundant ACMs in either chassis 1 or chassis 2. Note If you have both an ACM and a TCM installed in your Tricon, Invensys does not recommend using NET 2 on the ACM for network connections. Instead, use NET 1 or NET 2 on the TCM for network connections and/or time synchronization, and NET 1 on the ACM for connection to the Foxboro I/A Series DCS or Foxboro Evo System. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the ACM slot, and then click Setup. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Communication Modules 3 4 373 For a NET 1 connection, specify these properties on the ACM Setup screen. Property Action SOE Block Collection Mode If using SOE, specify the block number. Privilege Specify Read/Write to allow external devices to read and write points. The default is Read. Redundant Mode Select the check box to specify that a redundant ACM is installed. Time Synchronization Select On NET 1 enable time synchronization with external source to allow time synchronization with the Foxboro I/A Series DCS or Foxboro Evo System. For a NET 2 connection, specify these properties on the ACM Setup screen. Property Action Redundant Mode Select the check box to specify that a redundant module is installed. Used/Not Used Select Used to specify the slots that have an installed ACM. To enable the right slot, select the Redundant Mode check box (above). Privilege Specify Read/Write to allow external devices to read and write points. The default is Read. TriStation 1131 Developer’s Guide, 4.14.0 374 Chapter 3 Tricon Controller Configuration Property Action IP Address If using a default IP address, leave blank. If not, enter the IP address that identifies the controller on the network. This must be the same IP address as entered on the TriStation Communication screen (see Configuring the TriStation 1131 Network Connection on page 539). 5 IP Subnet Mask If the controller is on a subnet, enter the subnet address. Default Gateway IP Address If needed, enter an IP address to be used as the default for a gateway. Time Synchronization Select NET 2 to enable time synchronization with the Tricon Master controller. Click OK to save your changes. Configuring Tricon HIM Ports This procedure explains how to configure ports on a Tricon HIM, which supports a connection between a Tricon controller and a Honeywell control system. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. Double-click the HIM slot, and then click Setup. 2 Specify these properties on the HIM Setup screen. 3 Property Action Base Address Enter a number between 5 and 31 to specify the block address for the HIM based on the Data Hiway memory map. The default is 5. Number of Extended Block Enter a number which identifies a pair of HIM blocks consisting of a base block and a secondary block (which is offset from the 6-bit block address by 32). The default is 4. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Communication Modules 375 Configuring Tricon EICM Ports This procedure explains how to configure ports on a Tricon EICM, which supports these serial connections: • To a TriStation PC using TriStation 1131 protocol • To an external device using Modbus protocol (master, slave, and master/slave) • To a Centronics printer You can install an EICM in either chassis 1 or the first expansion chassis. An EICM cannot be installed in the same system as a TCM. For more information about module compatibility, see the Planning and Installation Guide for Tricon v9-v11 Systems. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the EICM slot, and then click Setup. 3 Specify these properties in the EICM Setup dialog box. Property Action Port Selection For TriStation 1131 or Modbus communication, select ports 1–4 or 6–9. For a printer connection, select ports 5 or 10. Protocol For TriStation 1131, select TriStation. For Modbus, select the specific Modbus protocol. Modbus Slave Address Enter the number of the slave address, which can be 1–247. Only available with Modbus slave and Modbus slave/master protocols. TriStation 1131 Developer’s Guide, 4.14.0 376 Chapter 3 Tricon Controller Configuration Property Action Baud Rate Select the rate, which must be the same as other slaves on the network. The default is 9600. The total rate for all four ports must be less than or equal to 57,600. Data Bits Set as needed; must be the same as other Modbus slaves. • Modbus slave can use 7 or 8 bits. • Modbus master and master/slave must use 8 bits. 4 Stop Bits Select either 1 Bit or 2 Bits to specify whether to send 1 or 2 bits to indicate that the transmission of a byte of data is complete. Parity Must use the same setting as other Modbus slaves. Handshake If set to Hardware, see Setting Signal Delays for Tricon EICM on page 823. Modbus (Minimum and Maximum) Range Set minimum between 0 and 32767; maximum between 1 and 32767. Rows and Columns Type the number of characters for the printer; only available with port 5 and 10. Rows can be 0–255; columns can be 0–255. SOE Block Collection Mode The SOE block name. Reserved for future use. Click OK to save your changes. Configuring Tricon NCM Ports This procedure explains how to configure ports on a Tricon NCM, which supports these connections: • On NET 1, a network connection to other Triconex controllers using the Peer-to-Peer protocol and Triconex Time Synchronization • On NET 2, a network connection to a TriStation PC or other external devices • Serial connection between a Tricon NCM/G module and a Global Positioning System (GPS) interface You can install a primary and redundant module in one logical slot. An NCM cannot be installed in the same system as a TCM. For more information about module compatibility, see the Planning and Installation Guide for Tricon v9-v11 Systems. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Communication Modules 377 Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the NCM slot, and then click Setup. 3 Specify these properties in the NCM Setup dialog box. 4 Property Action Installed/Not Installed Select to indicate which slots have modules installed. Available for the right slot only when the module is installed in a redundant (non-COM) slot. Privilege Select Read or Read/Write. IP Address Enter the IP address for the NCM. Global Positioning System Installed Select the check box to synchronize time with a GPS. The default is cleared. Time Synchronization Select the check box to synchronize time with the Tricon master node. The default is cleared. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 378 Chapter 3 Tricon Controller Configuration Configuring Tricon SMM Ports This procedure explains how to configure ports on a Tricon Safety Manager Module (SMM), which supports a connection between a Tricon controller and a Honeywell Universal Control Network (UCN). Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the SMM slot, and then click Setup. 3 Specify these properties in the SMM Setup dialog box. 4 Property Action UCN Node Number Enter the UCN node number. SOE Block Enter 15 or 16, which are Modified External blocks reserved for the SMM. Prohibit Writes Select the check box to prevent Honeywell workstations from writing to memory and output points. The default is cleared. Enable UCN Test Mode Should only be selected if requested by Honeywell factory test personnel. The default is cleared. Time Synchronization Select the check box to enable time synchronization with the UCN. The default is cleared. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Communication Modules 379 Configuring Tricon TCM Ports Note The information and procedures in this section do not apply to model 4351 and 4352 TCMs. If you have one of these TCMs installed in your system, please see Appendix D, TCM Model 4351/4352 Configuration. A single Tricon 10.x or 11.x system1 supports a maximum of four TCMs, which must reside in two logical slots located in chassis 1 or chassis 2 only. You cannot install model 4351/4352 TCMs in a system that also has model 4351A/B, 4352A/B, or 4353/4354 TCMs installed, even if they are installed in different chassis. Additionally, different TCM models cannot be mixed in the same logical slot. Exceptions to this rule are the 4351A/B and 4352A/B modules, where A and B modules with the same model number can be installed in the same slot. See the Planning and Installation Guide for Tricon v9-v11 Systems for detailed TCM installation guidelines. The following table lists the protocols supported by TCM models 4351A/B and 4353 (Copper), and 4352A/B and 4354 (Fiber) on network and serial ports. Table 39 Proctocols Supported by TCMs Protocol or Standard Network Ports (Models 4351A/B and 4352A/B) Network Ports (Models 4353 and 4354) Serial Ports (All Models) TriStation NET 1, NET 2 NET 1, NET 2 Port 4 TSAA (UDP/IP) NET 1, NET 2 NET 1 —a TSAA with IP Multicast (UDP/IP) NET 1, NET 2 NET 1 — Peer-to-Peer (UDP/IP) NET 1, NET 2 NET 1 — NET 1 NET 1 — Embedded OPC Server (Data Access and Alarms & Events) — NET 2 — Modbus Slave (ASCII or RTU) — — Any port Modbus Master (RTU) — — Any port NET 1, NET 2 NET 1 — HART — — — GPS Time Synchronization — — Port 1 Triconex Time Synchronization via DLC NET 1 NET 1 — Triconex Time Synchronization via UDP/IP NET 1, NET 2 NET 1 — Peer-to-Peer (DLC) Modbus Master or Slave (TCP) 1. TCMs can be installed only in Tricon 10.x or 11.x systems. They cannot be installed in Tricon 9.x or earlier systems. For more detailed compatibility information, please see the Product Release Notice for your Tricon system version. TriStation 1131 Developer’s Guide, 4.14.0 380 Chapter 3 Tricon Controller Configuration Table 39 Proctocols Supported by TCMs (continued) Protocol or Standard Network Ports (Models 4351A/B and 4352A/B) Network Ports (Models 4353 and 4354) Serial Ports (All Models) SNTP Triconex Time Synchronization NET 1, NET 2 NET 1, NET 2 — Network Printing using Jet Direct NET 1, NET 2 NET 1 — a. — means the protocol is not available on this port. Note Invensys recommends configuring a serial connection to the TCM first, because it is less complex and easier to successfully connect to the TCM through the serial port. Once you have successfully connected to the TCM and downloaded the initial configuration to the Tricon, you can go back and configure the more complex network connection without worrying about losing the ability to communicate with the controller altogether. To configure specific types of ports, see these topics: • Configuring TCM Serial Ports on page 381 • Configuring TCM Network Ports on page 383 • Configuring TCM Peer-To-Peer Ports on page 388 • Configuring TCM Modbus TCP Ports on page 393 • Configuring TCM Routing on page 395 • Configuring TCM Protocols (Tricon 10.3 and Later Only) on page 396 For additional information on configuring the TCM, see these topics: • Configuring Tricon Time Synchronization on page 422 for instructions on configuring the TCM to synchronize time. • Controlling Access to the TCM or UCM on page 542 for instructions on controlling access to the TCM on a per-client level. • Configuring a Tricon TCM or UCM Port for Printing on page 554 for instructions on configuring the TCM for use with a printer. Exporting and Importing a TCM Configuration Once you have configured a TCM, you can export its configuration to an XML file. This file can then be used to quickly configure other TCMs by importing the saved configuration settings. For detailed instructions, see Exporting the TCM Configuration to a File on page 400. You can also export only the TCM Peer-to-Peer configuration to a .txt or .csv file. For detailed instructions, see Exporting a TCM Peer-to-Peer Configuration on page 390. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Communication Modules 381 Changing TCM Models Once TCM ports have been configured, but prior to downloading the configuration to the controller, you can change the existing TCM model to a different model TCM without losing your port settings. See Inserting and Removing Tricon Modules on page 363. Only the following model changes will retain your port settings: • 4351A to 4352A • 4351B to 4352B • 4353 to 4354 • 4352A to 4351A • 4352B to 4351B • 4354 to 4353 Any other TCM model changes will result in all port settings being reset to their default values. However, once the configuration has been downloaded to the controller, you cannot change the TCM model installed in the Tricon without downloading a new configuration. Configuring TCM Serial Ports This procedure explains how to configure serial ports on a Tricon TCM. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the TCM is installed and then click Setup. The TCM Setup dialog box appears. 3 Click the Serial Ports tab. TriStation 1131 Developer’s Guide, 4.14.0 382 Chapter 3 Tricon Controller Configuration 4 Specify these properties. Property Action Port Selection Click the port to be configured. Ports can be configured only for a slot with an installed module. Port Write Enabled Available only if Modbus Slave (ASCII or RTU) is selected as the communication protocol. Select this check box if you want to allow Modbus writes to this slave port. The default is cleared (the port is read-only). Protocol Select the communication protocol for the port: • All ports can use Modbus Master, Modbus Slave ASCII, Modbus Slave RTU. • Only port 1 can use GPS. This port is automatically configured for GPS when you enable time synchronization. See Using a Tricon TCM or UCM to Synchronize Time on page 427. • Only port 4 can use TriStation. Modbus Slave Address If you selected Modbus Slave RTU or ASCII, enter the number of the Modbus slave device (1-247). The default is 1. Baud Rate Enter the communication rate for the port. The default is 9600. Data Bits Select 8 or 7 bits. The default is 8. Available only with Modbus Slave ASCII. Stop Bits Select 1 or 2 bits. The default is 1 bit. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Communication Modules 5 Property Action Parity Select the type of parity for the port. The default is Odd. Transceiver Mode Select RS-485 or RS-232. The default is RS232. On port 4 when TriStation is selected as the protocol, RS-485 is not available. Handshake Select None or Hardware; the default is None. Termination Options Select the type of termination used with cables. Only available with RS-485 Transceiver Mode. The default is None. FP Ordering Select the order to be used with floating point numbers. Determines whether the most significant bits in a 32-bit address are the first 16 (high) or the last 16 (low). The default is Low 16 Bits First. Modbus (Minimum and Maximum) Range Enter the minimum and maximum values to be used for the Modbus data range. The default minimum is 0. The default maximum is 32,767. Master Logical Port Enter the port number (1-32) that the TCM will use in Modbus Master functions to access the port. Only available for Modbus Master. 383 Click OK to save your changes. Configuring TCM Network Ports This procedure explains how to configure network ports on a Tricon TCM. Network port configuration options differ depending on the target system version configured for the project. Use the procedure that applies to your Tricon system version: • Procedure for Tricon 10.1 or 10.2 (Models 4351A/4352A) on page 383 • Procedure for Tricon 10.3 and Later (Models 4351A/B, 4352A/B, and 4353/4354) on page 386 For more information about the target system version, see Configuring the Tricon Target System Version on page 345. Procedure for Tricon 10.1 or 10.2 (Models 4351A/4352A) 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the TCM is installed and then click Setup. The TCM/A Setup dialog box appears. TriStation 1131 Developer’s Guide, 4.14.0 384 Chapter 3 Tricon Controller Configuration 3 Specify these properties on the Network tab. Property Action Slot Selection Select the physical slot where the TCM you want to configure is installed. • If the TCM you are configuring is installed in the COM slot, you must select the left slot. • If the TCM is installed in any other available logical slot, you can select either the Left or right slot. Each logical slot can hold two TCMs—one in the left physical slot, and one in the right physical slot. A TCM can be configured in the right slot only if a TCM in the left slot has already been configured.a See the Planning and Installation Guide for Tricon v9-v11 Systems for more information about slot locations. Not Installed, Installed Click Installed to enable configuration of the module. Clicking Not Installed resets all options to their default state and makes them unavailable for configuration. The default is Not Installed. Transceiver Mode Select the communication mode. For more detailed information about supported modes per TCM model, see Transceiver Mode on page 846. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Communication Modules Property Action IP Address Enter the IP Address for the port. The addresses for NET 1 and NET 2 do not need to be unique. 385 The default values are: • NET 1: 192.168.0.x • NET 2: 192.168.1.x where x is the node number. The highest and lowest IP addresses in a subnet (addresses where the last number is 0 or 255, such as 192.168.55) are reserved for broadcast messaging and cannot be used as a valid IP address. IP Subnet Mask If needed, enter the IP address for the subnet. The default is 255.255.255.0. Default Gateway IP Address If needed, enter the IP address for the default gateway. The default is 0.0.0.0. Typically, this is the IP address of the network router. The default gateway address must be part of the subnet. TriStation Port Number Enter the UDP port to use for the TriStation connection. The default is 1502. See UDP Base Port Number on page 854 for additional information. TSAA Port Number Enter the UDP port to use for TSAA connections, including DDE Server, SOE Recorder, and OPC Server. The default is 1500. See UDP Base Port Number on page 854 for additional information. Port Write Enabled Select this check box if you want to allow TSAA writes to this port. Applies to all TSAA connections on this port. The default is cleared (the port is read-only). a. If you have configured TCMs in both the left and right slots, and you then uninstall the TCM in the left slot, you will no longer be able to change the configuration of the TCM installed in the right slot. You must re-install a TCM in the left slot before you can modify the configuration of the TCM in the right slot. 4 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 386 Chapter 3 Tricon Controller Configuration Procedure for Tricon 10.3 and Later (Models 4351A/B, 4352A/B, and 4353/4354) 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the TCM is installed and then click Setup. The TCM/OPC or TCM/B Setup dialog box appears. 3 Specify these properties on the Network tab. Property Action Slot Selection Select the physical slot where the TCM you want to configure is installed. • If the TCM you are configuring is installed in the COM slot, you must select the left slot. • If the TCM is installed in any other available logical slot, you can select either the Left or right slot. Each logical slot can hold two TCMs—one in the left physical slot, and one in the right physical slot. A TCM can be configured in the right slot only if a TCM in the left slot has already been configured.a See the Planning and Installation Guide for Tricon v9-v11 Systems for more information about slot locations. Not Installed, Installed TriStation 1131 Developer’s Guide, 4.14.0 Click Installed to enable configuration of the module. Clicking Not Installed resets all options to their default state and makes them unavailable for configuration. The default is Not Installed. Configuring Tricon Communication Modules Property Action Transceiver Mode Select the communication mode. 387 For more detailed information about supported modes per TCM model, see Transceiver Mode on page 846. Note: If you have a model 4353 TCM, you cannot select 10 Mbps as the communication mode on NET 2. Connections to the TCM’s embedded OPC server can be made only at 100 Mbps. IP Address Enter the IP Address for the port. The addresses for NET 1 and NET 2 do not need to be unique. The default values are: • NET 1: 192.168.0.x • NET 2: 192.168.1.x where x is the node number. The highest and lowest IP addresses in a subnet (addresses where the last number is 0 or 255, such as 192.168.55) are reserved for broadcast messaging and cannot be used as a valid IP address. IP Subnet Mask If needed, enter the IP address for the subnet. The default is 255.255.255.0. Default Gateway IP Address If needed, enter the IP address for the default gateway. The default is 0.0.0.0. Typically, this is the IP address of the network router. The default gateway address must be part of the subnet. a. If you have configured TCMs in both the left and right slots, and you then uninstall the TCM in the left slot, you will no longer be able to change the configuration of the TCM installed in the right slot. You must re-install a TCM in the left slot before you can modify the configuration of the TCM in the right slot. 4 To configure the TCM for operation behind a firewall, click Show Advanced Options and then specify the properties shown in the table below for NET 1 and NET 2. Setting these properties restricts the ports that the TCM can use for TCP connections to the specified range. This allows the TCM to operate behind a firewall that has implemented port restrictions. For most networks, the default settings should be sufficient. Invensys recommends that only advanced users change these settings. TriStation 1131 Developer’s Guide, 4.14.0 388 Chapter 3 Tricon Controller Configuration Note If these settings are misconfigured, Modbus TCP and OPC will be unable to connect. If this occurs, reset the values to the default settings to fix the problem and re-enable Modbus TCP and OPC. If you need to use this feature, please contact Technical Support for assistance with configuring these settings. Property Action Lowest TCP Port Number Enter the lowest TCP port number to use for an outgoing connection from the TCM. Can be from 1024 to 65535. The default value is 49152. Applicable to Modbus/TCP and OPC ports. Highest TCP Port Number Enter the highest TCP port number to use for an outgoing connection from the TCM. Can be from 1024 to 65535. The default value is 65535. Applicable to Modbus/TCP and OPC ports. 5 Click OK to save your changes. Configuring TCM Peer-To-Peer Ports This procedure explains how to configure the IP addresses for controllers communicating on a Peer-to-Peer network through a Tricon TCM. In Tricon 11.1.x and later TCMs, you can configure up to 254 Peer-to-Peer nodes. In Tricon 11.0.x and earlier TCMs, you can configure up to 31 Peer-to-Peer nodes. Supported node numbers for Peer-to-Peer communication differ depending on whether you are using Standard or Enhanced Peer-to-Peer, as described in the following table: Table 40 Supported Node Numbers for Peer-to-Peer Communication System Version Standard Peer-to-Peer Enhanced Peer-to-Peer Tricon 9.x — 11.0.x 1-31 Not supported Tricon 11.1.x and later 1-64 1-254 Note Because NET 2 is reserved for OPC communication, the Peer-to-Peer protocol is not available on NET 2 for model 4353 and 4354 TCMs. Peer-to-Peer communication can be configured on NET 1 only for these TCMs. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the TCM is installed and then click Setup. The TCM Setup dialog box appears. 3 Click the Peer-to-Peer tab. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Communication Modules 389 4 Under Slot Selection, select the module (slot) you want to configure Peer-to-Peer ports for. 5 Select a node (controller), and specify these properties. Property Action Destination UDP Port Enter the UDP port number for each controller to be communicated with on the Peer-to-Peer network. This must be the same number that the controller uses as its UDP Base Port Number. The default is 1503. You should not need to change this setting unless the TCM is located behind a firewall, or you want to use a custom UDP port number. Network Click the network port that the TCM uses to communicate with the selected Peer-to-Peer node. The default is NET 1. NET 2 is not available for model 4353 and 4354 TCMs. IP Address 6 Enter the IP address for the controller. Click Update to save the new settings for the selected node. If you forget to click Update before selecting another node, your settings will be lost. 7 Repeat steps 4 through 6 for each node to be included in the network. Note If necessary, click Reset All to reset all node settings for the selected slot to their default, unconfigured state. TriStation 1131 Developer’s Guide, 4.14.0 390 Chapter 3 Tricon Controller Configuration 8 Once all nodes have been configured, specify these properties (applicable to all nodes on the Peer-to-Peer network). Property Action UDP Base Port Number For each network port, enter the UDP base port number for the controller. Enter 0 to disable Peer-to-Peer over UDP/IP on the network. The maximum value is 65534. The default is 1503 on NET 1, and 0 on NET 2 (meaning Peer-to-Peer is disabled on NET 2). UDP port numbers do not need to be unique, as long as the IP address for each port is unique. See UDP Base Port Number on page 854 for reserved values. Available only for NET 1 on model 4353 and 4354 TCMs. Enable Communication with Tricon V8 and V9 Peer-to-Peer Systems on NET 1 Select the check box to enable communication with Tricon version 8 and 9 systems (nodes 1 - 31 only) on the NET 1 port. The default is cleared. Available only for a module installed in the left slot. Cannot be used with the Enhanced Peer-to-Peer function blocks. 9 Click OK to save your changes. Exporting a TCM Peer-to-Peer Configuration Once TCM Peer-to-Peer configuration is complete, you may want to export it to a file. This allows you to create a backup of your configuration settings, and also edit the settings later, if required. You can then re-import the settings to other TCMs, saving time and effort, and ensuring that all TCMs in a system have the same configuration. Technical Support may also ask for an exported Peer-to-Peer configuration file to assist in troubleshooting TCM problems. Note An exported TCM Peer-to-Peer configuration file can be saved in the comma-delimited values (.csv) format, which can be edited outside of TriStation 1131 using common spreadsheet applications, such as Microsoft Excel. An exported TCM Peer-to-Peer configuration file can also be imported into a UCM and vice-versa. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the TCM is installed and then click Setup. The TCM Setup dialog box appears. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Communication Modules 3 Click the Peer-to-Peer tab. 4 Click Export P2P Configuration. 391 If the TCM configuration has been changed, but not saved, you are asked if you want to include the unsaved changes in the exported file. 5 Navigate to the folder you want to save the exported configuration file in, enter a file name, and click Save. Note By default, the file is saved in a plain text (.txt) format. You can also save the file in the .csv format by selecting the CSV Files option from the Save as type dropdown list. TriStation 1131 Developer’s Guide, 4.14.0 392 Chapter 3 Tricon Controller Configuration Importing the TCM Peer-to-Peer Configuration From a File If you have already configured Peer-to-Peer nodes for a TCM, and exported the configuration to a file, you can import the saved configuration to another TCM or UCM. If a configuration item exists in the exported file, but is not applicable to the TCM it is being imported to, that item will be ignored. For example, if the number of nodes configured in the exported file is 254, but the TCM the file is being imported to supports only 31 nodes, the Peerto-Peer configuration information for nodes 32-254 will be ignored. If a configuration item exists in the TCM, but has missing or incorrect values in the file being imported, the default value will be used. For example, if your TCM supports 254 nodes, but only nodes 1-31 are configured in the imported file, the IP addresses for nodes 32-254 will be set to the default value, 0.0.0.0. These values will then need to be manually configured. In all cases, once the import is complete, you should review the TCM configuration to ensure that all settings have been correctly configured for your implementation. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the TCM is installed and then click Setup. The TCM Setup dialog box appears. 3 Click the Peer-to-Peer tab. 4 Click Import P2P Configuration. If the TCM configuration has been changed, but not yet saved, you are asked if you want to overwrite the existing configuration, including the unsaved changes, with the imported settings. 5 Navigate to the folder where the exported configuration file is located, and click Open. The Peer-to-Peer configuration settings are imported from the selected file. 6 Verify that all settings have been correctly configured in the Peer-to-Peer tab. 7 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Communication Modules 393 Configuring TCM Modbus TCP Ports This procedure explains how to configure Modbus TCP ports on a Tricon TCM, which enables Modbus communication through network ports. For model 4351A/B and 4352A/B TCMs, 16 ports are available for Modbus TCP communication. For model 4353 and 4354 TCMs, four ports are available on NET 1 only. Note Because NET 2 is reserved for OPC communication, Modbus TCP is not available on NET 2 for model 4353 and 4354 TCMs. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the TCM is installed and then click Setup. The TCM Setup dialog box appears. 3 Click the Modbus TCP tab. 4 Under Slot Selection, select the module (slot) you want to configure Modbus TCP ports for. 5 Select a port and specify these properties. TriStation 1131 Developer’s Guide, 4.14.0 394 Chapter 3 Tricon Controller Configuration Property Action Protocol Select the communication protocol for the port. Options include Modbus TCP Master and Modbus TCP Slave Net. Port Write Enabled Available only if Modbus TCP Slave is selected as the communication protocol. Select this check box if you want to allow Modbus writes to this slave port. The default is cleared (the port is read-only). Master Logical Port Enter the number of the Modbus Master node (1-32). Available only with Modbus TCP Master protocol. Must be unique for each TCM installed in a system. TCP Port Number Enter the number for the TCP port. The default is 502. Network Click the network that the selected port is connected to. For models 4351A/B and 4352A/B, the default is NET 2. For models 4353 and 4354, the default is NET 1 (NET 2 is not available for these TCMs). IP Address If the port uses Modbus Master protocol, enter the IP address of the slave node. If the port uses Modbus Slave protocol, enter either of these: • To accept communication from any Modbus Master, leave the IP address as 0.0.0.0. • To accept communication only from a defined Modbus Master, enter the specific master IP address. 6 FP Ordering Select the ordering to use for floating point numbers. The default is Low 16 Bits First. Modbus (Minimum and Maximum) Range Enter the minimum and maximum for the Modbus data range. Available only with Modbus TCP Slave Net. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Communication Modules 395 Configuring TCM Routing This procedure explains how to configure routing on a Tricon TCM. Up to 10 different routes can be configured for each network; each slot (module) has two networks (NET 1 and NET 2). Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the TCM is installed and then click Setup. The TCM Setup dialog box appears. 3 Click the Routing tab. 4 Select the module (slot) you want to configure routing for. 5 Select the network (NET 1 or NET 2) you want to configure routing for. 6 Select a destination route and then specify these properties. Property Action Destination Gateway IP Address Enter the IP address which is used if the controller is not on the same subnet as other devices. TriStation 1131 Developer’s Guide, 4.14.0 396 Chapter 3 Tricon Controller Configuration 7 Property Action Destination IP Subnet Mask Enter the IP address of the subnet mask. Destination Gateway IP Address Enter the IP address of the gateway to which the controller is connected. The gateway address must always be on NET 1 or NET 2. Click Update Destination to apply the settings. Note 8 If the gateway address is on NET 2, then the subnet mask must be the same as the NET 2 subnet mask defined on the Network tab. If the gateway address is on NET 1, then the subnet mask must be the same as the NET 1 subnet mask defined on the Network tab. See Configuring TCM Network Ports on page 383. If necessary, click Reset All to change all destination settings for the selected slot to their default, unconfigured state. Click OK to save your changes. Configuring TCM Protocols (Tricon 10.3 and Later Only) This procedure explains how to configure the TSAA, TriStation, and OPC protocols used for TCM communication in Tricon 10.3 and later systems. The OPC protocol is available only with model 4353 and 4354 TCMs, and is supported on NET 2 only. Additionally, because NET 2 is reserved for OPC communication, the TSAA protocol is not available on NET 2 for model 4353 and 4354 TCMs. Notes Model 4353 and 4354 TCMs are not supported in Tricon 11.1 and later systems. See the Product Release Notice for Tricon 11.1.x on the Global Customer Support (GCS) website for detailed compatibility information. The Protocols tab in the TCM Setup dialog box appears only when the target system version is configured for Tricon 10.3 or later. For Tricon 10.1 and 10.2, the TSAA and TriStation protocols are configured on the Network tab (see Configuring TCM Network Ports on page 383). Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the TCM is installed and then click Setup. The TCM/OPC or TCM/B Setup dialog box appears. 3 Click the Protocols tab. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Communication Modules 4 Select the module (slot) you want to configure protocols for. 5 Specify these properties for the protocol(s) you will be using with the TCM. Protocol Property Action TriStation TriStation Port Number Enter the UDP port to use for TriStation connections on NET 1 and NET 2. The default for both ports is 1502. 397 Cannot be the same as the Management or TSAA port numbers. See UDP Base Port Number on page 854 for additional information. Management Management Port Number Enter the UDP port to use for the Enhanced Diagnostic Monitor’s connection to TCM communication status information on NET 1 and NET 2. The default for both ports is 1510. This must be the same value as the Management UDP Port Number property in the Enhanced Diagnostic Monitor’s Network Configuration dialog box. Cannot be the same as the TriStation or TSAA port numbers. For more information, see the Enhanced Diagnostic Monitor User’s Guide. TriStation 1131 Developer’s Guide, 4.14.0 398 Chapter 3 Tricon Controller Configuration Protocol Property Action TSAA TSAA Port Number Enter the UDP port to use for TSAA connections, including DDE Server and SOE Recorder, on NET 1 and NET 2. The default for both ports is 1500. Available only for NET 1 on model 4353 and 4354 TCMs. Cannot be the same as the TriStation or Management port numbers. A value of 0 indicates that TSAA communication is disabled on that port. See UDP Base Port Number on page 854 for additional information. Multicast IP Address Enter the IP address that TSAA multicasts should be sent to. The default is 0.0.0.0 (IP multicasting is disabled). Available only for NET 1 on model 4353 and 4354 TCMs. Bin data and/or SOE data available messages will be sent to the specified address, so that all members of the group will receive the data. Note: To use TSAA multicasting, your network hardware (such as routers) must also support multicasting. See your Network Administrator or IT department for more information. TSAA (cont’d) Multicast Update Rate Enter the update rate, in milliseconds, for TSAA IP multicasting. Can be from 250 to 2,000. The default value is 1000. Available only for NET 1 on model 4353 and 4354 TCMs. Bin data and/or SOE data available messages will be sent to the multicast IP address at the specified update rate (for example, by default, bin data will be multicast every 1,000ms). TSAA Version Select the version of the TSAA protocol used for muticasting. The version that you select must be supported by all TSAA clients in the multicasting group. The default is Legacy. Note If a TSAA client subscribed to your multicasting group does not support the Enhanced protocol, you will not be able to use this protocol. However, if you need to use the Enhanced protocol, you can create separate multicast groups, one with clients that support only the Legacy protocol on NET 1 and another with clients that support the Enhanced protocol on NET 2. Available only in Tricon 11.2 and later systems, with TCM models 4351 or 4352 installed. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Communication Modules Protocol Property Action OPC A&E SOE SOE Block Number Enter the SOE block number used when events are retrieved by an OPC client. Can be from 0 to 14. The default value is 0 (not configured). Must be unique for each TCM installed in a system. 399 Available with TCM models 4353 and 4354 only. SOE Severity Enter the severity (priority) level for SOE events (state changes obtained from the SOE block). Can be from 1 to 1,000. The default value is 500. Available with TCM models 4353 and 4354 only. OPC A&E System Events Info Severity Severity levels identify the urgency of an event. Enter a number to represent the severity level for informational system events. Can be from 1 (lowest) to 1,000 (highest). Enter 0 if you do not want the TCM to send notifications of informational system events to OPC clients. The default value is 100. Minor Severity Enter a number to represent the severity level for minor system events. Can be from 1 (lowest) to 1,000 (highest). Enter 0 if you do not want the TCM to send notifications of minor system events to OPC clients. The default value is 300. Major Severity Enter a number to represent the severity level for major system events. Can be from 1 (lowest) to 1000 (highest). Enter 0 if you do not want the TCM to send notifications of major system events to OPC clients. The default value is 500. Fatal Severity Enter a number to represent the severity level for fatal system events. Can be from 1 (lowest) to 1000 (highest). Enter 0 if you do not want the TCM to send notifications of fatal system events to OPC clients. The default value is 700. 6 Disable All Click to prevent the TCM from sending system event notifications to OPC clients. Sets the severity levels for all system event types to 0. Reset All Click to reset all OPC severity levels to their default values. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 400 Chapter 3 Tricon Controller Configuration CAUTION By default, TSAA clients using a TCM interface (in Tricon 10.3 and later systems) and TSAA clients using a UCM interface (in Tricon 11.x and later systems) have write access to the NET 1 and NET 2 ports. Depending on your configuration, this may create a security issue. Please note that this default behavior is opposite of that on TCMs in Tricon 10.2 and earlier systems. To disable write access by TSAA clients, you must enable and configure the TCM/UCM access control list. See Controlling Access to the TCM or UCM on page 542. Exporting the TCM Configuration to a File Once TCM configuration is complete, you may want to export it to an XML file. Not only does this provide a backup of your configuration settings, it also allows you to import the settings to other TCMs, saving time and effort, and ensuring that all TCMs in a system have the same configuration. Technical Support may also ask for an exported configuration file to assist in troubleshooting TCM problems. Note An exported TCM configuration file cannot be modified outside of TriStation 1131. If the XML file is changed after export, you will be unable to import it into TriStation 1131. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the TCM is installed and then click Setup. The TCM Setup dialog box appears. 3 Click Export. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Communication Modules 401 If the TCM configuration has been changed, but not saved, you are asked if you want to include the unsaved changes in the exported file. 4 Navigate to the folder you want to save the exported configuration file in, enter a file name, and click Save. Note A TCM configuration file exported from a model 4351A/4352A TCM installed in a Tricon 10.3 or later system cannot be imported to the same model TCM installed in a Tricon 10.2 or earlier system. Importing the TCM Configuration From a File If you have already configured a TCM, and exported the configuration to a file, you can import the saved configuration to another TCM. If a configuration item exists in the exported file, but is not applicable to the TCM it is being imported to, that item will be ignored. For example, if OPC configuration information is included in the exported file, but the TCM the file is being imported to does not support OPC, all OPC settings will be ignored. If a configuration item exists in the TCM, but not in the file being imported, the default value will be used. For example, if the TCM supports OPC, but OPC configuration items are not included in the exported file, all OPC settings will be set to the default values. These values will need to be manually configured. In all cases, once the import is complete, you should review the TCM configuration to ensure that all settings have been correctly configured for your implementation. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the TCM is installed and then click Setup. The TCM Setup dialog box appears. 3 Click Import. If the TCM configuration has been changed, but not yet saved, you are asked if you want to overwrite the existing configuration, including the unsaved changes, with the imported settings. TriStation 1131 Developer’s Guide, 4.14.0 402 Chapter 3 Tricon Controller Configuration 4 Navigate to the folder where the exported configuration file is located, and click Open. TCM configuration settings are imported from the selected file. 5 Click each tab of the TCM Setup dialog box to review and verify that all settings have been correctly configured. 6 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Communication Modules 403 Configuring Tricon UCM Ports A single Tricon 11.x system2 supports a maximum of two UCMs, which must reside in logical slot 2 (physical slots COM2L, COM2R) of the Tricon Enhanced Performance chassis. Note In a Tricon Enhanced Performance Chassis, the model 4610 UCM can only be installed in the COM2 slot. See the Planning and Installation Guide for Tricon v9-v11 Systems for detailed UCM installation guidelines. The UCM has two serial ports, four fiber-optic Ethernet network ports, one time synchronization port, and one debug port (for Invensys use). Of the four fiber-optic Ethernet network ports, two ports are reserved for NET 1/NET 2 connectivity and two ports for Mesh network connectivity. The following table lists the protocols supported by the model 4610 UCM on network and serial ports. Table 41 Protocols Supported by the UCM Protocol or Standarda Network Ports Serial Ports (All Models) TriStation NET 1, NET 2 Port 2 TSAA (UDP/IP) NET 1, NET 2 —b TSAA with IP Multicast (UDP/IP) NET 1, NET 2 — Peer-to-Peer (UDP/IP) NET 1, NET 2 — Modbus Slave (ASCII or RTU) — Any port Modbus Master (RTU) — Any port Modbus Master or Slave (TCP) NET 1, NET 2 — Triconex Time Synchronization via UDP/IP NET 1, NET 2 — Triconex Peer-to-Peer Time Synchronization (Master or Slave) NET 1, NET 2 — 2. Model 4610 UCMs can be installed only in Tricon 11.x systems that use the model 8120E Tricon Enhanced Performance chassis and model 3009 Main Processor. UCMs cannot be installed in Tricon system versions earlier than 11.x. For more detailed compatibility information, please see the Product Release Notice for your Tricon system version. TriStation 1131 Developer’s Guide, 4.14.0 404 Chapter 3 Tricon Controller Configuration Table 41 Protocols Supported by the UCM (continued) Protocol or Standarda Network Ports Serial Ports (All Models) SNTP Triconex Time Synchronization NET 1, NET 2 — Network Printing using Jet Direct NET 1, NET 2 — a. Protocols not listed here are not supported by the UCM. b. — means the protocol is not available on this port. Note Invensys recommends configuring a serial connection to the UCM first, because it is less complex and easier to successfully connect to the UCM through the serial port. Once you have successfully connected to the UCM and downloaded the initial configuration to the Tricon, you can go back and configure the more complex network connection without worrying about losing the ability to communicate with the controller altogether. To configure specific types of ports, see these topics: • Configuring UCM Serial Ports on page 405 • Configuring UCM Network Ports on page 407 • Configuring UCM Peer-To-Peer Ports on page 410 • Configuring UCM Modbus TCP Ports on page 414 • Configuring UCM Routing on page 416 • Configuring UCM Protocols on page 417 For additional information on configuring the UCM, see these topics: • Configuring Tricon Time Synchronization on page 422 for instructions on configuring the UCM to synchronize time. • Controlling Access to the TCM or UCM on page 542 for instructions on controlling access to the UCM on a per-client level. • Configuring a Tricon TCM or UCM Port for Printing on page 554 for instructions on configuring the UCM for use with a printer. Exporting and Importing a UCM Configuration Once you have configured a UCM, you can export its configuration to an XML file. This file can then be used to quickly configure other UCMs by importing the saved configuration settings. For detailed instructions, see Exporting the UCM Configuration to a File on page 420 and Importing the UCM Configuration From a File on page 421. You can also export only the UCM Peer-to-Peer configuration to a .txt or .csv file. For detailed instructions, see Exporting a UCM Peer-to-Peer Configuration on page 412. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Communication Modules 405 Configuring UCM Serial Ports This procedure explains how to configure serial ports on a Tricon UCM. The UCM supports two serial ports, port 1 and port 2. Each serial port can be configured as a Modbus master or slave. Serial port 1 supports the Modbus interface and serial port 2 supports either the Modbus or the TriStation interface. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the UCM is installed and then click Setup. The UCM Setup dialog box appears. 3 Click the Serial Ports tab. TriStation 1131 Developer’s Guide, 4.14.0 406 Chapter 3 Tricon Controller Configuration 4 Specify these properties. Property Action Port Selection Click the port to be configured. Ports can be configured only for a slot with an installed module. Port Write Enabled Available only if Modbus Slave (ASCII or RTU) is selected as the communication protocol. Select this check box if you want to allow Modbus writes to this slave port. The default is cleared (the port is read-only). Protocol Select the communication protocol for the port: • All ports can use Modbus Master, Modbus Slave ASCII, Modbus Slave RTU. • Only port 2 can use TriStation. 5 Modbus Slave Address If you selected Modbus Slave RTU or ASCII, enter the number of the Modbus slave device (1-247). The default is 1. Baud Rate Enter the communication rate for the port. The default is 9600. Data Bits Select 8 or 7 bits. The default is 8. Available only with Modbus Slave ASCII. Stop Bits Select 1 or 2 bits. The default is 1 bit. Parity Select the type of parity for the port. The default is Odd. Transceiver Mode Select RS-485 or RS-232. The default is RS232. On port 2 when TriStation is selected as the protocol, RS-485 is not available. Handshake Select None or Hardware; the default is None. Termination Options Select the type of termination used with cables. Only available with RS-485 Transceiver Mode. The default is None. FP Ordering Select the order to be used with floating point numbers. Determines whether the most significant bits in a 32-bit address are the first 16 (high) or the last 16 (low). The default is Low 16 Bits First. Modbus (Minimum and Maximum) Range Enter the minimum and maximum values to be used for the Modbus data range. The default minimum is 0. The default maximum is 32,767. Master Logical Port Enter the port number (1-32) that the UCM will use in Modbus Master functions to access the port. Only available for Modbus Master. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Communication Modules 407 Configuring UCM Network Ports A single UCM contains four fiber-optic Ethernet network ports—two ports for NET 1 / NET 2 connectivity, labeled as NET 1 and NET 2 on the UCM front panel, and two ports for Mesh network connectivity, labeled as Control Network A and Control Network B. See the Planning and Installation Guide for Tricon v9-v11 Systems for more information on the UCM network ports. This procedure explains how to configure the NET 1 / NET 2 ports on a Tricon UCM. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the UCM is installed and then click Setup. The UCM Setup dialog box appears. TriStation 1131 Developer’s Guide, 4.14.0 408 Chapter 3 Tricon Controller Configuration 3 Specify these properties on the Network tab. Property Action Slot Selection Select the physical slot where the UCM you want to configure is installed (in logical slot 2). You can select either the left or right slot. Slot 2 can hold two UCMs—one in the left physical slot (COM2L), and one in the right physical slot (COM2R). A UCM can be configured in the right slot only if a UCM in the left slot has already been configured.a See the Planning and Installation Guide for Tricon v9-v11 Systems for more information about slot locations. Not Installed, Installed Click Installed to enable configuration of the module. Clicking Not Installed resets all options to their default state and makes them unavailable for configuration. The default is Not Installed. Transceiver Mode The UCM can connect only at 100 Mbps Full Duplex. No other options are available. IP Address Enter the IP Address for the port. The addresses for NET 1 and NET 2 do not need to be unique. The default values are: • NET 1: 192.168.0.x • NET 2: 192.168.1.x where x is the node number. The highest and lowest IP addresses in a subnet (addresses where the last number is 0 or 255, such as 192.168.55) are reserved for broadcast messaging and cannot be used as a valid IP address. IP Subnet Mask If needed, enter the IP address for the subnet. The default is 255.255.255.0. Default Gateway IP Address If needed, enter the IP address for the default gateway. The default is 0.0.0.0. Typically, this is the IP address of the network router. The default gateway address must be part of the subnet. a. If you have configured UCMs in both the left and right slots, and you then uninstall the UCM in the left slot, you will no longer be able to change the configuration of the UCM installed in the right slot. You must re-install a UCM in the left slot before you can modify the configuration of the UCM in the right slot. 4 To configure the UCM for operation behind a firewall, click Show Advanced Options and then specify the properties shown in the table below for NET 1 and NET 2. Setting these properties restricts the ports that the UCM can use for TCP connections to the specified range. This allows the UCM to operate behind a firewall that has implemented port restrictions. For most networks, the default settings should be sufficient. Invensys recommends that only advanced users change these settings. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Communication Modules Note 409 If these settings are misconfigured, Modbus TCP will be unable to connect. If this occurs, reset the values to the default settings to fix the problem and re-enable Modbus TCP. If you need to use this feature, please contact Technical Support for assistance with configuring these settings. Property Action Lowest TCP Port Number Enter the lowest TCP port number to use for an outgoing connection from the UCM. Can be from 1024 to 65535. The default value is 49152. Applicable to Modbus/TCP and OPC ports. Highest TCP Port Number Enter the highest TCP port number to use for an outgoing connection from the UCM. Can be from 1024 to 65535. The default value is 65535. Applicable to the Modbus/TCP port. 5 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 410 Chapter 3 Tricon Controller Configuration Configuring UCM Peer-To-Peer Ports This procedure explains how to configure the IP addresses for controllers communicating on a Peer-to-Peer network through a Tricon UCM. Peer-to-Peer communication (over UDP/IP) can be configured on the NET 1 or NET 2 ports for a Tricon UCM. You can configure up to 31 Peer-to-Peer nodes. The UCM supports Standard Peer-to-Peer only. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the UCM is installed and then click Setup. The UCM Setup dialog box appears. 3 Click the Peer-to-Peer tab. 4 Under Slot Selection, select the module (slot) you want to configure Peer-to-Peer ports for. 5 Select a node (controller), and specify these properties. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Communication Modules Property Action Destination UDP Port Enter the UDP port number for each controller to be communicated with on the Peer-to-Peer network. This must be the same number that the controller uses as its UDP Base Port Number. 411 The default is 1503. You should not need to change this setting unless the UCM is located behind a firewall, or you want to use a custom UDP port number. 6 Network Click the network port that the UCM uses to communicate with the selected Peer-to-Peer node. The default is NET 1. IP Address Enter the IP address for the controller. Click Update to save the new settings for the selected node. If you forget to click Update before selecting another node, your settings will be lost. 7 Repeat steps 4 through 6 for each node to be included in the network. Note 8 If necessary, click Reset All to reset all node settings for the selected slot to their default, unconfigured state. Once all nodes have been configured, specify these properties (applicable to all nodes on the Peer-to-Peer network). Property Action UDP Base Port Number For each network port, enter the UDP base port number for the controller. Enter 0 to disable Peer-to-Peer over UDP/IP on the network. The maximum value is 65534. The default is 1503 on both NET 1 and NET 2 (meaning Peer-to-Peer is enabled on both ports). UDP port numbers do not need to be unique, as long as the IP address for each port is unique. See UDP Base Port Number on page 854 for reserved values. Enable Communication with Tricon V8 and V9 Peer-to-Peer Systems on NET 1 9 Select the check box to enable communication with Tricon system version 8 and 9 systems on the NET 1 port. The default is cleared. Available only for a module installed in the left slot. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 412 Chapter 3 Tricon Controller Configuration Exporting a UCM Peer-to-Peer Configuration Once UCM Peer-to-Peer configuration is complete, you may want to export it to a file. This allows you to create a backup of your configuration settings, and also edit the settings later, if required. You can then re-import the settings to other UCMs, saving time and effort, and ensuring that all UCMs in a system have the same configuration. Technical Support may also ask for an exported Peer-to-Peer configuration file to assist in troubleshooting UCM problems. Note An exported UCM Peer-to-Peer configuration file can be saved in the comma-delimited values (.csv) format, which can be edited outside of TriStation 1131 using common spreadsheet applications, such as Microsoft Excel. An exported UCM Peer-to-Peer configuration file can also be imported into a TCM and vice-versa. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the UCM is installed and then click Setup. The UCM Setup dialog box appears. 3 Click the Peer-to-Peer tab. 4 Click Export P2P Configuration. If the UCM configuration has been changed, but not saved, you are asked if you want to include the unsaved changes in the exported file. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Communication Modules 5 413 Navigate to the folder you want to save the exported configuration file in, enter a file name, and click Save. Note By default, the file is saved in a plain text (.txt) format. You can also save the file in the .csv format by selecting the CSV Files option from the Save as type dropdown list. Importing the UCM Peer-to-Peer Configuration From a File If you have already configured Peer-to-Peer nodes for a UCM, and exported the configuration to a file, you can import the saved configuration to another TCM or UCM. If a configuration item exists in the exported file, but is not applicable to the UCM it is being imported to, that item will be ignored. For example, if a configuration file created for a TCM with 254 nodes is imported into a UCM, the Peer-to-Peer configuration information for nodes 32-254 will be ignored. If a configuration item in the imported file has missing or incorrect values, the default values will be used. For example, if the imported configuration file has a missing value for the IP address of a node, the IP address for that node will be set to the default value, 0.0.0.0. This value will then need to be manually configured. In all cases, once the import is complete, you should review the UCM configuration to ensure that all settings have been correctly configured for your implementation. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the UCM is installed and then click Setup. The UCM Setup dialog box appears. 3 Click the Peer-to-Peer tab. 4 Click Import P2P Configuration. If the UCM configuration has been changed, but not yet saved, you are asked if you want to overwrite the existing configuration, including the unsaved changes, with the imported settings. 5 Navigate to the folder where the exported configuration file is located, and click Open. The Peer-to-Peer configuration settings are imported from the selected file. 6 Verify that all settings have been correctly configured in the Peer-to-Peer tab. 7 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 414 Chapter 3 Tricon Controller Configuration Configuring UCM Modbus TCP Ports This procedure explains how to configure Modbus TCP ports on a Tricon UCM, which enables Modbus communication through network ports. For the Tricon UCM, 16 ports are available for Modbus TCP communication on either the NET 1 or NET 2 port. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the UCM is installed and then click Setup. The UCM Setup dialog box appears. 3 Click the Modbus TCP tab. 4 Under Slot Selection, select the module (slot) you want to configure Modbus TCP ports for. 5 Select a port and specify these properties. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Communication Modules Property Action Protocol Select the communication protocol for the port. Options include Modbus TCP Master and Modbus TCP Slave Net. Port Write Enabled Available only if Modbus TCP Slave is selected as the communication protocol. Select this check box if you want to allow Modbus writes to this slave port. The default is cleared (the port is read-only). Master Logical Port Enter the number of the Modbus Master node (1-32). Available only with Modbus TCP Master protocol. Must be unique for each UCM installed in a system. TCP Port Number Enter the number for the TCP port. The default is 502. Network Click the network that the selected port is connected to. IP Address If the port uses Modbus Master protocol, enter the IP address of the slave node. 415 If the port uses Modbus Slave protocol, enter either of these: • To accept communication from any Modbus Master, leave the IP address as 0.0.0.0. • To accept communication only from a defined Modbus Master, enter the specific master IP address. 6 FP Ordering Select the ordering to use for floating point numbers. The default is Low 16 Bits First. Modbus (Minimum and Maximum) Range Enter the minimum and maximum for the Modbus data range. Available only with Modbus TCP Slave Net. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 416 Chapter 3 Tricon Controller Configuration Configuring UCM Routing This procedure explains how to configure routing on a Tricon UCM. Up to 10 different routes can be configured for each network; each slot (module) has two networks (NET 1 and NET 2). Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the UCM is installed and then click Setup. The UCM Setup dialog box appears. 3 Click the Routing tab. 4 Select the module (slot) you want to configure routing for. 5 Select the network (NET 1 or NET 2) you want to configure routing for. 6 Select a destination route and then specify these properties. Property Action Destination Gateway IP Address Enter the IP address which is used if the controller is not on the same subnet as other devices. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Communication Modules 7 Property Action Destination IP Subnet Mask Enter the IP address of the subnet mask. Destination Gateway IP Address Enter the IP address of the gateway to which the controller is connected. The gateway address must always be on NET 1 or NET 2. If the gateway address is on NET 2, then the subnet mask must be the same as the NET 2 subnet mask defined on the Network tab. If the gateway address is on NET 1, then the subnet mask must be the same as the NET 1 subnet mask defined on the Network tab. See Configuring UCM Network Ports on page 407. Click Update Destination to apply the settings. Note 8 417 If necessary, click Reset All to change all destination settings for the selected slot to their default, unconfigured state. Click OK to save your changes. Configuring UCM Protocols This procedure explains how to configure the TSAA and TriStation protocols used for a Tricon UCM. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the UCM is installed and then click Setup. The UCM Setup dialog box appears. 3 Click the Protocols tab. TriStation 1131 Developer’s Guide, 4.14.0 418 Chapter 3 Tricon Controller Configuration 4 Select the module (slot) you want to configure protocols for. 5 Specify these properties for the protocol(s) you will be using with the UCM. Protocol Property Action TriStation TriStation Port Number Enter the UDP port to use for TriStation connections on NET 1 and NET 2. The default for both ports is 1502. Cannot be the same as the Management or TSAA port numbers. See UDP Base Port Number on page 854 for additional information. Management Management Port Number Enter the UDP port to use for the Enhanced Diagnostic Monitor’s connection to the UCM’s communication status information on NET 1 and NET 2. The default for both ports is 1510. This must be the same value as the Management UDP Port Number property in the Enhanced Diagnostic Monitor’s Network Configuration dialog box. Cannot be the same as the TriStation or TSAA port numbers. For more information, see the Enhanced Diagnostic Monitor User’s Guide. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Communication Modules Protocol Property Action TSAA TSAA Port Number Enter the UDP port to use for TSAA connections, including DDE Server and SOE Recorder, on NET 1 and NET 2. The default for both ports is 1500. 419 Cannot be the same as the TriStation or Management port numbers. A value of 0 indicates that TSAA communication is disabled on that port. See UDP Base Port Number on page 854 for additional information. Multicast IP Address Enter the IP address that TSAA multicasts should be sent to. The default is 0.0.0.0 (IP multicasting is disabled). Bin data and/or SOE data available messages will be sent to the specified address, so that all members of the group will receive the data. Note: To use TSAA multicasting, your network hardware (such as routers) must also support multicasting. See your Network Administrator or IT department for more information. Multicast Update Rate Enter the update rate, in milliseconds, for TSAA IP multicasting. Can be from 250 to 2,000. The default value is 1000. Bin data and/or SOE data available messages will be sent to the multicast IP address at the specified update rate (for example, by default, bin data will be multicast every 1,000ms). 6 Click OK to save your changes. CAUTION By default, TSAA clients using a TCM interface (in Tricon 10.3 and later systems) and TSAA clients using a UCM interface (in Tricon 11.x and later systems) have write access to the NET 1 and NET 2 ports. Depending on your configuration, this may create a security issue. Please note that this default behavior is opposite of that on TCMs in Tricon 10.2 and earlier systems. To disable write access by TSAA clients, you must enable and configure the TCM/UCM access control list. See Controlling Access to the TCM or UCM on page 542. TriStation 1131 Developer’s Guide, 4.14.0 420 Chapter 3 Tricon Controller Configuration Exporting the UCM Configuration to a File Once the UCM configuration is complete, you may want to export it to an XML file. Not only does this provide a backup of your configuration settings, it also allows you to import the settings to other UCMs, saving time and effort, and ensuring that all UCMs in a system have the same configuration. Technical Support may also ask for an exported configuration file to assist in troubleshooting UCM problems. Note An exported UCM configuration file cannot be modified outside of TriStation 1131. If the XML file is changed after export, you will be unable to import it into TriStation 1131. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the UCM is installed and then click Setup. The UCM Setup dialog box appears. 3 Click Export. If the UCM configuration has been changed, but not saved, you are asked if you want to include the unsaved changes in the exported file. 4 Navigate to the folder you want to save the exported configuration file in, enter a file name, and click Save. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Communication Modules 421 Importing the UCM Configuration From a File If you have already configured a UCM, and exported the configuration to a file, you can import the saved configuration to another UCM. Once the import is complete, you should review the UCM configuration to ensure that all settings have been correctly configured for your implementation. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the UCM is installed and then click Setup. The UCM Setup dialog box appears. 3 Click Import. If the UCM configuration has been changed, but not yet saved, you are asked if you want to overwrite the existing configuration, including the unsaved changes, with the imported settings. 4 Navigate to the folder where the exported configuration file is located, and click Open. The UCM configuration settings are imported from the selected file. 5 Click each tab of the UCM Setup dialog box to review and verify that all settings have been correctly configured. 6 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 422 Chapter 3 Tricon Controller Configuration Configuring Tricon Time Synchronization This section explains how to use the Time Synchronization communication protocol with Tricon controllers. Time synchronization enables a network of Triconex controllers to synchronize time with each other or with external devices, such as a DCS or the Global Positioning System. Topics include: • About Tricon Time Synchronization on page 422 • Using a Tricon ACM to Synchronize Time on page 423 • Using a Tricon NCM to Synchronize Time on page 424 • Using a Tricon NCM/G to Synchronize Time on page 425 • Using a Tricon SMM to Synchronize Time on page 426 • Using a Tricon TCM or UCM to Synchronize Time on page 427 About Tricon Time Synchronization This table summarizes the ways Tricon controller time can be synchronized to an external device or to the Tricon master node in a Peer-to-Peer network. Table 42 Tricon Time Synchronization Module ACM Time Synchronization Options • To a Foxboro I/A Series DCS or Foxboro Evo System. • To the Tricon master node in a Peer-to-Peer network. ACM or NCM • To an OPC client. For more information, see the Communication Guide for Tricon v9-v11 Systems. • By writing aliased data to the TIMESET or TIMEADJ function blocks in a TriStation 1131 application. For assistance with the specialized programming that is required, contact Technical Support. • To the Tricon master node in a Peer-to-Peer network. NCMG • To the GPS (Global Positioning System). • To the Tricon master node in a Peer-to-Peer network. SMM • To the Honeywell Universal Control Network (UCN). TCM • To the GPS (Global Positioning System). • To SNTP. • To the Tricon master node in a Peer-to-Peer network (Triconex Time Synchronization). UCM • To SNTP. • To the Tricon master node in a Peer-to-Peer network (Triconex Time Synchronization). TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Time Synchronization 423 Using a Tricon ACM to Synchronize Time This procedure explains how to use a Tricon ACM to enable time synchronization based on: • The Foxboro I/A Series or Foxboro Evo System nodebus system time • The Tricon master node in a Peer-to-Peer network Procedure 1 Expand the Configuration tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the ACM slot, and then click Setup. 3 Specify these properties on the ACM Setup screen. Property Action Privilege For synchronization on NET 2, specify Read/Write. The default is Read. Time Synchronization • Select On NET 1 enable time synchronization with external source to allow time synchronization with a Foxboro I/A DCS or Foxboro Evo System. • Select NET 2 to enable time synchronization with the Tricon Master node (controller). 4 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 424 Chapter 3 Tricon Controller Configuration Using a Tricon NCM to Synchronize Time This procedure explains how to use a Tricon NCM to enable time synchronization with the Tricon master node in a Peer-to-Peer network. Procedure 1 Expand the Configuration tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the NCM slot, and then click Setup. 3 Select the On NET 1 enable time synchronization with Tricon Master Node check box. 4 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Time Synchronization 425 Using a Tricon NCM/G to Synchronize Time This procedure explains how to use a Tricon NCM/G to enable time synchronization through the Global Positioning System (GPS) by using the Trimble Acutime Gold Smart GPS Antenna. If the Tricon NCMG is in a Peer-to-Peer network, it can be used as the master node for time synchronization of the controllers on the network. For information on installing the kit, see Application Note 43: Connecting the Trimble® Acutime™ Gold GPS Smart Antenna to Tricon Controller, available on the Global Customer Support (GCS) website. CAUTION To ensure the accuracy of GPS time adjustments, the Tricon clock must be set to within 10 minutes of the correct local time. Procedure 1 Expand the Configuration tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the NCM/G slot, and then click Setup. 3 Specify these properties on the NCM Setup screen. Property Action Global Positioning System Installed Select this check box to enable time synchronization through the GPS. If selected, other controllers can also be synchronized to the Tricon master controller. Time Synchronization 4 For a network of Triconex controllers, select the On NET 1 enable time synchronization with the Tricon Master Node check box. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 426 Chapter 3 Tricon Controller Configuration Using a Tricon SMM to Synchronize Time This procedure explains how to configure a Tricon SMM module to synchronize time based on the Honeywell Universal Control Network (UCN). For more information, see the SMM User’s Guide. Procedure 1 Expand the Configuration tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the SMM slot, and then click Setup. 3 Select the Enable time synchronization with external source check box. 4 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Time Synchronization 427 Using a Tricon TCM or UCM to Synchronize Time The information in this section explains how to enable time synchronization on a TCM or UCM. Time synchronization can be enabled on the TCM using the following protocols: • GPS • SNTP • Triconex Time Synchronization via DLC (NET 1 only) or UDP/IP (NET 1 or NET 23) on a Peer-to-Peer network Time synchronization can be enabled on the UCM using the following protocols: • SNTP • Triconex Time Synchronization via UDP/IP (NET 1 or NET 2) on a Peer-to-Peer network In a redundant network of Triconex controllers that each have two TCMs/UCMs installed, you can implement redundant time synchronization by configuring time synchronization for both modules (left and right slots) on the TCM/UCM. Time synchronization can be enabled only for a single logical slot. When a TCM is installed in the COM slot, you configure time synchronization only for the left slot (there is no redundancy when installed in the COM slot). Note The information and procedures in this section do not apply to model 4351 and 4352 TCMs. If you have one of these older model TCMs installed in your system, please see Appendix D, TCM Model 4351/4352 Configuration. Topics include: • Configuring GPS Time Synchronization on the TCM on page 427 • Configuring SNTP Time Synchronization on the TCM or UCM on page 429 • Configuring Triconex Time Synchronization on the TCM or UCM on page 431 Configuring GPS Time Synchronization on the TCM This procedure explains how to configure a TCM to enable time synchronization through the Global Positioning System (GPS) by using the Trimble Acutime Gold Smart GPS Antenna. For information on installing the kit, see Triconex Application Note #43, available on the Global Customer Support (GCS) website. CAUTION To ensure the accuracy of GPS time adjustments, the Tricon clock must be set to within 10 minutes of the correct local time. If the TCM is in a Peer-to-Peer network, it can also be used as the master node for time synchronization of other controllers on the network. In this configuration, the master node TCM synchronizes time with the GPS, and any slave nodes on the Peer-to-Peer network synchronize their time with the master TCM. In this way, all nodes on the Peer-to-Peer network are synchronized with GPS time. 3. NET 2 is not available for Triconex Time Synchronization with model 4353 and 4354 TCMs. TriStation 1131 Developer’s Guide, 4.14.0 428 Chapter 3 Tricon Controller Configuration If the TCM is acting as a slave node on a Peer-to-Peer network, it cannot be configured for GPS time synchronization. Slave nodes synchronize their time only to the master node on the Peerto-Peer network, and reject all other time change requests. GPS time synchronization uses serial port 1 on the TCM. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the TCM is installed and then click Setup. The TCM Setup dialog box appears. 3 Click the Time Sync tab. 4 Under Slot Selection, click Left Slot. You must configure the module in the left slot first. 5 Under Time Synchronization Configuration, select GPS. If you previously configured port 1 to use a Modbus protocol, selecting GPS will reset port 1 to use the GPS protocol. See Configuring TCM Serial Ports on page 381 for more information. 6 (Optional) If you have a redundant TCM installed in the right slot, under Slot Selection, click Right Slot, and then select GPS Redundant. Note 7 The module in the right slot can be configured only if it has been installed (see Configuring TCM Network Ports on page 383) and if the module in the left slot has already been configured for GPS time synchronization. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Time Synchronization 429 Enabling the TCM or UCM as a Master Node for Triconex Time Synchronization (Optional) If you also want the TCM or UCM to be able to act as a master node for time synchronization of other controllers on a Peer-to-Peer network (using Triconex Time Synchronization) do the following: 1 In the Configuration tree, click Operating Parameters (see Setting Tricon Operating Parameters on page 341). 2 Select the Enable Tricon Node Time Synchronization check box. Configuring SNTP Time Synchronization on the TCM or UCM This procedure explains how to configure TCM or UCM time synchronization to an SNTP server. If the TCM/UCM is in a Peer-to-Peer network, it can also be used as the master node for time synchronization of other controllers on the network. In this configuration, the master node TCM/UCM synchronizes time with the SNTP server, and any slave nodes on the Peer-to-Peer network synchronize their time with the master TCM/UCM. In this way, all nodes on the Peerto-Peer network are synchronized with SNTP time. If the TCM/UCM is acting as a slave node on a Peer-to-Peer network, it cannot be configured for SNTP time synchronization. Slave nodes synchronize their time only to the master node on the Peer-to-Peer network, and reject all other time change requests. Note SNTP time synchronization is less accurate than GPS time synchronization. Because the SNTP server resides on a PC, network load issues or PC performance can result in delays in processing time update requests from the Tricon system. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the TCM/UCM is installed and then click Setup. The TCM/UCM Setup dialog box appears. 3 Click the Time Sync tab. TriStation 1131 Developer’s Guide, 4.14.0 430 Chapter 3 Tricon Controller Configuration 4 Under Slot Selection, click Left Slot. You must configure the module in the left slot first. 5 Select these properties. 6 Property Action Time Synchronization Configuration Select SNTP. The default is None. SNTP Master Network Click the network the SNTP server is located on. SNTP Master IP Address Enter the IP address of the SNTP server to synchronize time with. (Optional) If you have a redundant TCM/UCM installed in the right slot, under Slot Selection, click Right Slot, and then select these properties. Property Action Time Synchronization Configuration Select SNTP Redundant. SNTP Master Network Click the network the SNTP server is located on. This can be different than the master network selected for the left slot. SNTP Master IP Address Enter the IP address of the SNTP server to synchronize time with. Note 7 The module in the right slot can be configured only if it has been installed (see Configuring TCM Network Ports on page 383 and Configuring UCM Network Ports on page 407) and if the module in the left slot has already been configured for SNTP time synchronization. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Time Synchronization 431 Enabling the TCM or UCM as a Master Node for Triconex Time Synchronization (Optional) If you also want the TCM/UCM to be able to act as a master node for time synchronization of other controllers on a Peer-to-Peer network (using Triconex Time Synchronization), do the following: 1 In the Configuration tree, click Operating Parameters (see Setting Tricon Operating Parameters on page 341). 2 Select the Enable Tricon Node Time Synchronization check box. Configuring Triconex Time Synchronization on the TCM or UCM In a Peer-to-Peer network, Triconex Time Synchronization can be used to synchronize time across controllers on a network. The controller with the lowest node number serves as the master node. The master node can also synchronize its time with a GPS (available with the TCM only) or an SNTP server (available with the TCM and UCM). In this configuration, the master node synchronizes time with the GPS or SNTP server, and any slave nodes on the Peer-to-Peer network synchronize their time with the master node. In this way, all nodes on the Peer-to-Peer network are synchronized with GPS or SNTP time. CAUTION To ensure accurate time synchronization over a Peer-to-Peer network, ensure that the master node and all receiving nodes are on the same subnet. For example, if the master node is on subnet 255.0.0.0 and a receiving node is on subnet 255.255.0.0, there can be significant time differences between the two nodes. Configuring a Master Node This procedure describes how to configure the TCM or UCM as a master node on the Peer-toPeer network when GPS or SNTP time synchronization is not being used. If you want the master node to synchronize to a GPS or SNTP server, use the procedures in the these sections: • Configuring GPS Time Synchronization on the TCM on page 427 • Configuring SNTP Time Synchronization on the TCM or UCM on page 429 Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the TCM/UCM is installed and then click Setup. The TCM/UCM Setup dialog box appears. 3 Click the Time Sync tab. 4 Under Time Synchronization Configuration, select None. 5 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 432 Chapter 3 Tricon Controller Configuration 6 In the Configuration tree, click Operating Parameters (see Setting Tricon Operating Parameters on page 341). 7 Select the Enable Tricon Node Time Synchronization check box. This allows the controller to participate as a master node in time synchronization across the Peer-to-Peer network. Configuring a Slave Node This procedure describes how to configure the TCM or UCM as a slave node on the Peer-to-Peer network. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the TCM/UCM is installed and then click Setup. The TCM/UCM Setup dialog box appears. 3 Click the Time Sync tab. 4 Under Slot Selection, click Left Slot. You must configure the module in the left slot first. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Time Synchronization 5 433 Specify these properties. Property Action Time Synchronization Configuration Select Peer-to-Peer. The default is None. Peer-to-Peer Master Network Click the network you want to enable Triconex Time Synchronization for. The default is NET 2.This property applies to the modules installed in both the left and right slots simultaneously. Note If you have a redundant TCM/UCM installed in the right slot, Time Synchronization Configuration is automatically set to Peer-to-Peer and cannot be changed. 6 Click OK to save your changes. 7 In the Configuration tree, click Operating Parameters (see Setting Tricon Operating Parameters on page 341). 8 Select the Enable Tricon Node Time Synchronization check box. This allows the controller to participate as a slave node in time synchronization across the Peer-to-Peer network. TriStation 1131 Developer’s Guide, 4.14.0 434 Chapter 3 Tricon Controller Configuration Printing the Tricon Module Configuration Once Tricon controller configuration is complete, you may want to print the module configuration information. Not only does this provide a backup of your configuration settings, it also can assist Technical Support when troubleshooting configuration problems. Procedure 1 Open the Project Workspace (see The Project Workspace on page 22). 2 On the File menu, select Print All. The Print All Options dialog box appears. 3 Select the check boxes for the following documents: • Hardware Module Configuration—Prints a report listing the controller hardware (MPs, CMs, I/O modules) currently configured in the project. • Module Configuration Settings—Prints a report listing the current configuration settings for each applicable module in the project’s hardware configuration. Only modules that require configuration in TriStation 1131 are included in this report. For example, TCM and EPI module configuration details are included, but the AI/DI module is not, as it does not require configuration in TriStation 1131. Note To quickly clear the check boxes for all the documents in the list, and make it easier to select only those documents you want to print, clear the Select All check box. 4 Click OK. The Print dialog box appears. 5 Select the printer you want to use, and the desired settings (number of copies, page orientation, etc), and then click OK. TriStation 1131 Developer’s Guide, 4.14.0 4 Trident and Tri-GP Controller Configuration Overview 436 Setting Trident or Tri-GP Operating Parameters 439 Allocating Memory for Trident or Tri-GP Points 442 Configuring the Trident or Tri-GP Target System Version 443 Configuring Trident and Tri-GP Hardware 455 Configuring Trident or Tri-GP Communication Modules 470 Configuring Trident or Tri-GP Time Synchronization 511 Using Trident or Tri-GP System and Module Attributes 522 Printing the Trident or Tri-GP Module Configuration 523 TriStation 1131 Developer’s Guide, 4.14.0 436 Chapter 4 Trident and Tri-GP Controller Configuration Overview This figure shows the main steps for configuring the Trident or Tri-GP controller, and their typical order in the project cycle. The controller must be configured before an application can be downloaded and implemented on a controller. Set Up the Project Develop the Application Test with the Emulator Fix Errors Yes Errors? No - Set operating parameters C onfigure the C ontroller - Allocate memory and configure hardware - C onfigure communication to external devices - Set up Time Synchronization (optional) Set Up TriStation C ommunication Implement on the C ontroller Trident and Tri-GP Controller Configuration Steps This list includes the steps that can or should be done during Trident or Tri-GP controller configuration. Controller configuration must be completed before an application is downloaded to the controller. Description See Set the operating parameters. Setting Trident or Tri-GP Operating Parameters on page 439 Allocate memory and hardware. Allocating Memory for Trident or Tri-GP Points on page 442 Configure hardware. Configuring Trident and Tri-GP Hardware on page 455 Configure communication to external devices. Configuring Trident or Tri-GP Communication Modules on page 470 Set up time synchronization. Configuring Trident or Tri-GP Time Synchronization on page 511 TriStation 1131 Developer’s Guide, 4.14.0 Overview 437 The Trident and Tri-GP Controller Workspace This section explains the Controller Workspace, which is where you specify the configuration for the project. Topics include: • The Trident and Tri-GP Controller Trees on page 437 • The Trident and Tri-GP Configuration Trees on page 437 • The Trident and Tri-GP Controller and Emulator Panels on page 438 For information about how you can change the location of the Controller Workspace pane, see Customizing Your Workspace on page 114. The Trident and Tri-GP Controller Trees The Trident and Tri-GP Controller trees include the elements (operating parameters, communication settings, memory allocation, and hardware allocation) that can be configured. The tree also includes the Controller and Emulator Panels used to emulate and run an application. The Trident Controller tree is shown at right. The Trident and Tri-GP Configuration Trees The Trident and Tri-GP Configuration trees include operating parameters, communication, memory allocation, hardware allocation, and Status Attributes. TriStation 1131 Developer’s Guide, 4.14.0 438 Chapter 4 Trident and Tri-GP Controller Configuration The Trident and Tri-GP Controller and Emulator Panels The Trident and Tri-GP Controller and Emulator Panels display programs running in emulation or in the controller. Controller and Emulator tree TriStation 1131 Developer’s Guide, 4.14.0 Setting Trident or Tri-GP Operating Parameters 439 Setting Trident or Tri-GP Operating Parameters This procedure explains how to specify Trident or Tri-GP operating parameters, which are settings that affect the general operation of the controller, including settings to restrict access to the controller from a TriStation PC and from remote devices. Note Using the Print All command, you can print a report listing the current Operating Parameters settings. See Printing Project Documents on page 109. You can view Trident or Tri-GP operating parameters by clicking Operating Parameters on the Trident or Tri-GP Configuration tree. However, you cannot make changes to the operating parameters from that screen. You must access the Operating Parameters tab on the MP Setup dialog box (as described below) to set or change operating parameters. Note The target system version displayed on the Operating Parameters screen is the target system version currently configured in the project. This value is not obtained from a connected controller. To view the actual system version of your Trident or Tri-GP system, see Determining Your Trident or Tri-GP Controller’s System Version on page 444. Procedure 1 On the Configuration tree, open the Hardware Allocation node, and then double-click the MP. The Item Properties dialog box appears. 2 Click Setup. The MP Setup dialog box appears. 3 Specify these properties on the Operating Parameters tab. TriStation 1131 Developer’s Guide, 4.14.0 440 Chapter 4 Trident and Tri-GP Controller Configuration Property Action Password Required for Connection Select the check box to restrict access by requiring a password when connecting to the controller. The default is cleared. Password Enter the password required to access the controller. The default is PASSWORD. Restart on Power Up Select the check box to have the application restarted after a power failure. The default is cleared. Disable Remote Changes to Outputs Clear the check box to allow remote devices to write to output points. The default is selected. Allow Disabling of Points Select the check box to allow points to be disabled from TriStation 1131. The default is cleared. This property can be changed only when your project is in the Download All state. If you change this property (by selecting or clearing the check box), you must perform a Download All to apply your changes to the controller. TriStation 1131 will automatically rebuild the application before it is downloaded. Enable Trident/Tri-GP Node Time Synchronization (Trident 2.x/3.x or Tri-GP only) Select the check box to allow the controller to participate in time synchronization across the Peer-to-Peer network as a master node or a slave node (see Configuring Triconex Time Synchronization on the Trident or Tri-GP 2.x/3.x CM on page 516). Use Local Time Clear the check box if you do not want to use local time. The default is selected. Prevent Restart Following Fatal Error (Trident 2.x/3.x or Tri-GP only) Select the check box to prevent the MPs from restarting automatically after a fatal error occurs. Applicable to Trident 2.x/3.x and Tri-GP systems only. The default is selected, and cannot be changed. By default, when a Trident or Tri-GP MP detects a fatal error condition, it will automatically restart, and when possible, reeducate from the other active MPs. This allows the system to overcome temporary problems without user intervention. When this property is selected, if the MP detects a fatal error, it will shut down without a restart attempt, requiring user intervention to restart the MP. This will cause the controller to go to either DUAL or SINGLE mode. In all cases, if an MP attempts to automatically restart more than three times in 30 minutes, all future restart attempts will be disabled, to prevent the MP from continually restarting. If all three MPs shut down, user intervention will be required to restart the system. Applicable to Trident 2.x/3.x and Tri-GP systems only. The default is cleared. Note: The default restart behavior described above applies to Trident 1.x systems, but cannot be changed. TriStation 1131 Developer’s Guide, 4.14.0 Setting Trident or Tri-GP Operating Parameters Property Action Use Secure Communication Select the check box if you want to enable secure communication between the Trident or Tri-GP 3.x controller and TriStation 1131. 441 Note: When this option is selected, the default connection type will automatically use secure communication to connect to the controller. However, you still have the option to not use secure communication for a specific connection; see Preparing to Download to the Controller on page 618 for more information. See Secure Communication on page 310 for more information about configuring and using secure communication. Applicable to Trident/Tri-GP 3.x systems with a CIM installed only. The default is cleared (secure communication is not enabled). Allow Expired Certificate Select the check box if you want to allow secure connections to Trident or Tri-GP 3.x controllers even if the TriStation 1131 server and/or client certificate is expired. If a certificate expires, and this option is not selected, you will be unable to connect to the controller via a network connection. In this case, you will have to connect via a serial connection, or perform a Download All operation to download a new certificate. Applicable only to TriStation 1131 or Enhanced Diagnostic Monitor connections to Trident/Tri-GP 3.x systems with a CIM installed. Does not apply to OPC UA client/server certificates. The default is cleared. Generate Alarm When a Certificate Expires Select the check box if you want to be alerted when a certificate used for secure communication expires. When selected, the fault LEDs on the MPs will turn ON when a certificate has expired, or is close to expiring. An alarm event will also appear in the Enhanced Diagnostic Monitor. Applicable to Trident/Tri-GP 3.x systems with a CIM installed only. The default is cleared. Number of Days Before an Alarm Is Generated If you choose to be warned when a certificate expires, you also need to select how many days should pass after expiration before the warning occurs. You can enter from 0 to 255 days. If you enter 0, a warning will occur immediately upon certificate expiration. The default is 1 day. Applicable to Trident/Tri-GP 3.x systems with a CIM installed only. 4 Click OK to save. TriStation 1131 Developer’s Guide, 4.14.0 442 Chapter 4 Trident and Tri-GP Controller Configuration Allocating Memory for Trident or Tri-GP Points This procedure explains how to change the amount of memory used for input, output, and memory points (tagnames) in the application. Initially, the amount of memory for input and output points is determined by the number and type of I/O modules configured in the TriStation 1131 project. The amount of memory for memory points is set when a TriStation 1131 project is created. You can change these allocations at any time before building and downloading the application. CAUTION After an application has been downloaded to the controller or Emulator, changes to memory allocation require a Download All (see Using the Download All Command on page 649). See What Are Undeclared Tagnames? on page 226 for more information about memory allocation for points. Procedure 1 Expand the Controller tree, double-click Configuration, and then expand Memory Allocation. 2 Double-click the type of point you want to change. 3 Move the slider up or down to change the memory allocated for the selected point. The following memory allocation types are available to choose from: 4 Note • Maximum: The maximum amount of memory available to be allocated to this point type. • Allocated: The amount of memory currently allocated to this point type. • Forecast: The amount of memory estimated to be used for this point type after the next download operation. • Used: The amount of memory currently being used for this point type. Performing a download operation will change this value. Repeat for all points to be changed. Using the Print All command, you can print a report listing the current memory allocation settings. See Printing Project Documents on page 109. TriStation 1131 Developer’s Guide, 4.14.0 Configuring the Trident or Tri-GP Target System Version 443 Configuring the Trident or Tri-GP Target System Version This procedure explains how to change the target system version in your project. The target system version determines which Trident or Tri-GP controller features and modules can be configured in a project. You originally set the target system version when you created a new project, or when you converted an existing project to TriStation 1131 4.6 or later. If you change the system version of your Trident controller (for example, you upgrade your Trident system from 1.4 to 2.0), you must logically configure the change in the TriStation 1131 project. This change requires a Download All. Before committing to the target system version change, you are allowed to back up your project. Configuring the target system version is a three-step process: • Determine the system version of the Trident or Tri-GP controller the project will be downloaded to. • Validate the target system version change to review the changes that will be made to the project before committing to the change. • Change the target system version in the project. Topics include: • Determining Your Trident or Tri-GP Controller’s System Version on page 444 • Validating a Trident or Tri-GP Target System Version Change on page 446 • Changing the Trident or Tri-GP Target System Version on page 448 • Results of a Trident or Tri-GP Target System Version Change on page 451 TriStation 1131 Developer’s Guide, 4.14.0 444 Chapter 4 Trident and Tri-GP Controller Configuration Determining Your Trident or Tri-GP Controller’s System Version Before changing the target system version in your TriStation 1131 project, you should determine the system version of the Trident or Tri-GP controller you will be downloading the project to. You need to know the following: • The model number of the Main Processor modules installed in the Trident or Tri-GP (3101 or 3101S2) • The Trident or Tri-GP system version (for example, 1.5, 2.0, etc.) The target system version currently configured in the project is displayed on the Operating Parameters screen and at the top of the Select Main Processor dialog box. Procedure 1 Do one of the following: • If any of the following scenarios are true, go to step 2: — You know you have a Trident 1.x system. — You are unable to connect to the Trident or Tri-GP controller. — For a Trident controller, you do not have the Enhanced Diagnostic Monitor 2.2 or later. The Trident target system version is not available in Enhanced Diagnostic Monitor 2.1 and earlier. — For a Tri-GP controller, you do not have the Enhanced Diagnostic Monitor 2.5.0 or later. The Tri-GP target system version is not available in Enhanced Diagnostic Monitor 2.4.0 and earlier. • If the above scenarios do not apply to your situation, go to step 3. 2 Refer to your sales order paperwork, which should specify your Trident or Tri-GP controller’s system version. You do not need to continue with this procedure. 3 Open the Enhanced Diagnostic Monitor (for more detailed instructions, see the Enhanced Diagnostic Monitor User's Guide). 4 Connect to the node (controller) whose system version you want to find. 5 In the System Overview tree, click System Overview. The System Overview window appears. TriStation 1131 Developer’s Guide, 4.14.0 Configuring the Trident or Tri-GP Target System Version 445 Trident System Version 6 View the system version information, located at the top of the System Overview window. Note System version information is not available for Trident 1.x controllers. This property will display 0 when you are connected to a Trident 1.x controller. TriStation 1131 Developer’s Guide, 4.14.0 446 Chapter 4 Trident and Tri-GP Controller Configuration Validating a Trident or Tri-GP Target System Version Change Before committing to a target system version change, you should validate the change to determine what effect it will have on your project. Validation allows you to plan ahead for the changes that will occur when you switch from one target system version to another. For detailed information about the changes that occur when switching from one target system version to another, see the Results of a Trident or Tri-GP Target System Version Change on page 451. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the IOP whose target system version you want to change, and then click Replace MP. TriStation 1131 Developer’s Guide, 4.14.0 Configuring the Trident or Tri-GP Target System Version 3 447 Specify these properties in the Replace Main Processor dialog box. Property Description Model The Main Processor model installed in the Trident or Tri-GP controller that this project will be downloaded to. Target System Version The system version of the Tridenta or Tri-GP controller that this project will be downloaded to. Use the on-screen descriptions to help you determine the correct version to select, based on your Trident or Tri-GP controller configuration. a. TriStation 1131 4.14.0 does not support Trident controller versions 1.1 and earlier. For a list of TriStation 1131 versions compatible with your Trident controller, see the applicable Trident Product Release Notice (available on the Global Customer Support website). Note If you are not sure which Trident or Tri-GP system version to select, use the Enhanced Diagnostic Monitor or your sales paperwork to verify your controller’s system version information. See Determining Your Trident or Tri-GP Controller’s System Version on page 444 for more information. 4 Select the Validate Only check box. 5 Click OK. TriStation 1131 analyzes your project settings and current controller configuration to determine the modifications that will be made to the project if you change to the selected target system version. 6 In the Messages pane, review the results of the validation to determine if you want to commit to the target system version change. TriStation 1131 Developer’s Guide, 4.14.0 448 Chapter 4 Trident and Tri-GP Controller Configuration Changing the Trident or Tri-GP Target System Version The target system version determines which Trident or Tri-GP controller features and modules can be configured in a project. You selected the target system version for your project when you created it, or when you converted the project from a previous version of TriStation 1131. If you have upgraded your Trident or Tri-GP system to a newer version, you also need to change the target system version in your TriStation 1131 project. When changing the target system version, you can upgrade or downgrade the version number of the Trident or Tri-GP system (for example, upgrade from 1.5 to 2.0, or downgrade from 1.5 to 1.3). Changing the target system version requires a Download All. You cannot change the project’s target system version while the project is in the Download Changes state. You cannot be connected to the controller while you are changing the target system version. If time synchronization has been enabled on the Trident CM or MP (as described below), it will be disabled during a target system version change from 1.x to 2.x, or vice-versa. • On the Trident 2.x controller, time synchronization is enabled if the Enable Trident/Tri-GP Node Time Synchronization check box is selected on the Operating Parameters tab of the MP Setup dialog box. Note • In TriStation 1131 4.14.0, the Enable Trident/Tri-GP Node Time Synchronization check box is always selected, and cannot be changed. Time synchronization will always be enabled. On the Trident 1.x controller, time synchronization is enabled if either the On NET 1 Enable Time Synchronization or the On NET 2 Enable Time Synchronization properties are selected on the Network tab of the CM Setup dialog box. You will need to re-enable time synchronization after the target system version change is complete. See Configuring Trident or Tri-GP Time Synchronization on page 511 for more information. Upgrading or downgrading within a major Trident controller version (for example, from 1.2 to 1.6) will NOT change your time synchronization settings. CAUTION If you are upgrading from Trident 1.x to Trident 2.x, the configuration settings for the CM will be reset to their default values during the target system version change. Invensys recommends writing down your Trident 1.x CM onfiguration details before changing the target system version, so that you can use them to reconfigure the Trident 2.x CM after the target system version change is complete. Before committing to a target system version change, you should validate the change to determine what effect it will have on your project. See Validating a Trident or Tri-GP Target System Version Change on page 446. TriStation 1131 Developer’s Guide, 4.14.0 Configuring the Trident or Tri-GP Target System Version 449 Procedure 1 Verify that you are not connected to the controller. 2 If needed, change the project state to Download All. • On the Commands menu, click Change State to Download All. • In the Change Project State to Download All dialog box, click Change State. 3 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 4 Double-click the IOP whose system version you want to change, and then click Replace MP. Note If the Replace MP button is unavailable, the project is in the Download Changes state. Go back to step 2 to change the project state before continuing. TriStation 1131 Developer’s Guide, 4.14.0 450 Chapter 4 Trident and Tri-GP Controller Configuration 5 Specify these properties in the Replace Main Processor dialog box. Property Description Model The Main Processor model installed in the Trident or Tri-GP controller that this project will be downloaded to. Target System Version The system version of the Tridenta or Tri-GP controller that this project will be downloaded to. Use the on-screen descriptions to help you determine the correct version to select, based on your Trident or Tri-GP configuration. a. TriStation 1131 4.14.0 does not support Trident controller versions 1.1 and earlier. For a list of TriStation 1131 versions compatible with your Trident controller, see the applicable Trident Product Release Notice (available on the Global Customer Support website). Note If you are not sure which Trident or Tri-GP system version to select, use the Enhanced Diagnostic Monitor to verify your system version information. See Determining Your Trident or Tri-GP Controller’s System Version on page 444 for more information. 6 Click OK. 7 When asked to confirm your selection, click Yes to continue. 8 When asked to backup your project before changing the target system version, do one of the following: • (Recommended) Click Yes and then specify the folder to save the backup file to. Use the suggested name, or specify a new one. The file extension (.bt2) does not have to be included in the name. • Click No to continue without creating a backup file. TriStation 1131 reconfigures your project to the selected target system version. All current configuration settings are maintained; however, any parameters that did not exist in the previous version are set to their default values. 9 In the Messages pane, review the results of the target system version change. For more information, see Results of a Trident or Tri-GP Target System Version Change on page 451. 10 To finish the process, you must build the application and download it to the controller. TriStation 1131 Developer’s Guide, 4.14.0 Configuring the Trident or Tri-GP Target System Version 451 Results of a Trident or Tri-GP Target System Version Change The following tables describe the changes that are made to your project when changing from one target system version to another: • Trident Target System Version Change Matrix on page 452 • Tri-GP Target System Version Change Matrix on page 454 To use the Trident or Tri-GP Target System Version Change Matrix: 1 Find the column for your current system version on the top. 2 Then move down to locate the row (on the left) for the system version you want to change your project to. The box where your selected column and row meet describes the changes that will be made to your project if you change to the new target system version. TriStation 1131 Developer’s Guide, 4.14.0 452 Trident Target System Version Change Matrix ORIGINAL VERSION 1.5.x or 1.6.x 1.5.x or 1.6.x 2.0.x 2.1.x or 2.2.x 3.0.x Note: A target system version change (upgrade or downgrade) requires that the project state be changed to Download All, with one exception—when you are converting a project created in a version of TriStation 1131 prior to 4.6. During project conversion, projects created with a previous version of TriStation 1131 will remain in the Download Changes state regardless of a target system version change. For more information, see Converting Existing Projects to Version 4.14.0 on page 13. 1.0 or 1.1 1.2, 1.3.x, or 1.4.x 1.2, 1.3.x, or 1.4.x NOT ALLOWED UPGRADE • Add support for model 3381 PI module. • Add support for model 3481 AO module. • Add support for model 3482 AI module. • Add support for model 3201 CM. UPGRADE • Add support for model 3381 PI module. • Add support for model 3481 AO module. • Add support for model 3482 AI module. • Add support for model 3361 AI /DI module. • Add support for model 3201 CM. UPGRADE • Add support for model 3361 AI /DI module. NOT ALLOWED NOT ALLOWED NOT ALLOWED NOT ALLOWED DOWNGRADE • Remove model 3361 AI /DI module. DOWNGRADE • Remove model 3361 AI /DI module. • Remove support for enhanced model 3201 CM. DOWNGRADE • Remove model 3361 AI /DI module. • Add support for model 3381 PI module. • Remove model 3382 EPI module. • Remove model 3411 SDO module. • Remove model 3311 HRDI module. • Remove support for enhanced model 3201 CM. DOWNGRADE • Remove model 3361 AI /DI module. • Add support for model 3381 PI module. • Remove model 3382 EPI module. • Remove model 3411 SDO module. • Remove model 3311 HRDI module. • Remove support for enhanced model 3201 CM. • Remove model 3211 CIM. DOWNGRADE • Remove support for enhanced model 3201 CM. DOWNGRADE • Remove model 3382 EPI module. • Add support for model 3381 PI module. • Remove model 3411 SDO module. • Remove model 3311 HRDI module. • Remove support for enhanced model 3201 CM. DOWNGRADE • Remove model 3382 EPI module. • Add support for model 3381 PI module. • Remove model 3411 SDO module. • Remove model 3311 HRDI module. • Remove support for enhanced model 3201 CM. • Remove model 3211 CIM. Trident and Tri-GP Controller Configuration NEW VERSION 1.0 or 1.1 Chapter 4 TriStation 1131 Developer’s Guide, 4.14.0 Table 43 Table 43 Trident Target System Version Change Matrix (continued) ORIGINAL VERSION 1.0 or 1.1 1.2, 1.3.x, or 1.4.x 1.5.x or 1.6.x 2.0.x 2.1.x or 2.2.x 3.0.x DOWNGRADE • Remove model 3382 EPI module. • Add support for model 3381 PI module. • Remove model 3411 SDO module. • Remove model 3311 HRDI module. DOWNGRADE • Remove model 3382 EPI module. • Add support for model 3381 PI module. • Remove model 3411 SDO module. • Remove model 3311 HRDI module. • Remove model 3211 CIM. NEW VERSION 2.1.x or 2.2.x UPGRADE • Replace model 3381 PI module with model 3382 EPI module. • Add support for model 3481 AO module. • Add support for model 3482 AI module. • Add support for model 3361 AI /DI module. • Add support for model 3382 EPI module. • Add support for model 3411 SDO module. • Add support for model 3311 HRDI module. • Add support for original and enhanced model 3201 CM. UPGRADE • Replace model 3381 PI module with model 3382 EPI module. • Add support for model 3361 AI /DI module. • Add support for model 3382 EPI module. • Add support for model 3411 SDO module. • Add support for model 3311 HRDI module. • Add support for enhanced model 3201 CM. UPGRADE • Replace model 3381 PI module with model 3382 EPI module. • Add support for model 3382 EPI module. • Add support for model 3411 SDO module. • Add support for model 3311 HRDI module. • Add support for enhanced model 3201 CM. UPGRADE • Replace model 3381 PI module with model 3382 EPI module. • Add support for model 3382 EPI module. • Add support for model 3411 SDO module. • Add support for model 3311 HRDI module. UPGRADE • Add support for model 3381 PI module. • Add support for model 3481 AO module. • Add support for model 3482 AI module. • Add support for model 3361 AI /DI module. • Add support for original and enhanced model 3201 CM. • Add support for model 3211 CIM. UPGRADE • Add support for model 3361 AI /DI module. • Add support for enhanced model 3201 CM. • Add support for model 3211 CIM. UPGRADE • Add support for enhanced model 3201 CM. • Add support for model 3211 CIM. UPGRADE • Replace model 3381 PI module with model 3382 EPI module. • Add support for model 3382 EPI module. • Add support for model 3411 SDO module. • Add support for model 3311 HRDI module. • Add support for model 3211 CIM. 3.0.x DOWNGRADE • Remove model 3211 CIM. UPGRADE • Add support for model 3211 CIM. Configuring the Trident or Tri-GP Target System Version 453 TriStation 1131 Developer’s Guide, 4.14.0 UPGRADE • Add support for model 3361 AI /DI module. • Add support for enhanced model 3201 CM. UPGRADE • Add support for enhanced model 3201 CM. 2.0.x UPGRADE • Add support for model 3381 PI module. • Add support for model 3481 AO module. • Add support for model 3482 AI module. • Add support for model 3361 AI /DI module. • Add support for original and enhanced model 3201 CM. 454 Chapter 4 Table 44 Trident and Tri-GP Controller Configuration Tri-GP Target System Version Change Matrix ORIGINAL VERSION NEW VERSION 2.1.x or 2.2.x Note: A target system version change (upgrade or downgrade) requires that the project state be changed to Download All. 2.1.x or 2.2.x 3.x 3.x DOWNGRADE • Remove model 3211S2 CIM. UPGRADE • Add support for model 3211S2 CIM. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident and Tri-GP Hardware 455 Configuring Trident and Tri-GP Hardware This section explains how to configure the hardware allocation for a Trident or Tri-GP controller. Topics include: • Configuring the Trident or Tri-GP Main Processors (MPs) on page 455 • Inserting a Trident or Tri-GP Module on page 462 • Removing a Trident or Tri-GP Module on page 463 • Configuring a Trident or Tri-GP SDO Module on page 463 • Configuring a Trident or Tri-GP HRDI Module on page 464 • Configuring a Trident or Tri-GP PI or EPI Module on page 467 Note For information on configuring the CM or CIM, see Configuring Trident or Tri-GP Communication Modules on page 470. Configuring the Trident or Tri-GP Main Processors (MPs) This section explains how to configure the Trident or Tri-GP MP properties, network ports, and serial ports. Topics include: • Specifying Trident or Tri-GP MP Module Properties on page 456 • Displaying Trident or Tri-GP MP Attribute Properties on page 457 • Configuring Trident 1.x MP Network Ports on page 458 • Configuring Trident 2.x/3.x or Tri-GP MP Network Ports on page 459 • Configuring Trident or Tri-GP MP Serial Ports on page 460 TriStation 1131 Developer’s Guide, 4.14.0 456 Chapter 4 Trident and Tri-GP Controller Configuration Specifying Trident or Tri-GP MP Module Properties This procedure explains how to view and specify properties on the Trident or Tri-GP MP Module tab. This procedure applies to all Trident and Tri-GP MPs. Procedure 1 On the Controller tree, double-click Configuration. 2 On the Configuration tree, open the Hardware Allocation node, and then double-click an MP. The Item Properties dialog box appears. 3 Specify these properties on the Module tab. 4 Note Property Action Model Select the model used in the physical system. Description Enter a description, if desired. Node Name Displays the node name and number. Scan Time Displays the scan time, if it has been specified. Remote Access to Aliased Tagnames Select to allow TSAA applications (such as Triconex DDE Server) to have remote access only to aliased tagnames. Remote Access to All Tagnames Select to allow TSAA applications (such as Triconex DDE Server) to have remote access to all tagnames, including unaliased tagnames. Click Confirm to save your changes. You cannot specify point properties for a Trident or Tri-GP MP. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident and Tri-GP Hardware 457 Displaying Trident or Tri-GP MP Attribute Properties This procedure explains how to display MP attribute properties (status and control attributes). Procedure 1 On the Controller tree, double-click Configuration. 2 On the Configuration tree, open the Hardware Allocation node, and then double-click an MP. The Item Properties dialog box appears. 3 Click the Attributes tab. These properties are displayed on the Attributes tab. Property Description Tagname The name of the status or control attribute. Data Type The data type. Location The memory location for the attribute. Description The description of the attribute. TriStation 1131 Developer’s Guide, 4.14.0 458 Chapter 4 Trident and Tri-GP Controller Configuration Configuring Trident 1.x MP Network Ports This procedure explains how to configure network ports on a Trident 1.x MP, which supports network connections to a TriStation PC. Each port must be configured separately and can operate independently with different Modbus Masters. Or, they can operate as redundant serial ports, connected to redundant ports of the same Modbus Master. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the MP slot, click Setup, and then click the Network Ports tab. 3 Specify these properties on the Network Ports tab. 4 Property Action Mode Set to TriStation; cannot be changed. Transceiver Port Set to RJ-45; cannot be changed. Transceiver Mode Select half or full duplex depending on the installation. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident and Tri-GP Hardware 459 Configuring Trident 2.x/3.x or Tri-GP MP Network Ports This procedure explains how to configure network ports on a Trident 2.x/3.x or Tri-GP MP, which supports network connections to a TriStation PC. Each port must be configured separately and can operate independently with different Modbus Masters. Or, they can operate as redundant serial ports, connected to redundant ports of the same Modbus Master. Note The first time you connect to the Trident 2.x/3.x or Tri-GP controller to download your application, you must connect either via serial port, or via a network connection to the Left MP, using the default IP address. IP addresses configured for the Middle and Right MP network ports are not valid for the initial connection to the Trident 2.x/3.x or Tri-GP controller. See Connecting to the Trident or Tri-GP 2.x/3.x Controller for the First Time on page 567 for more information. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the MP slot, click Setup, and then click the Network Ports tab. 3 Specify these properties on the Network Ports tab. Property Action Mode Set to TriStation; cannot be changed. Transceiver Port Set to RJ-45; cannot be changed. Transceiver Mode Select half or full duplex depending on the installation. TriStation 1131 Developer’s Guide, 4.14.0 460 Chapter 4 Trident and Tri-GP Controller Configuration Property Action IP Address Specify the IP address of the controller. The default IP address is 192.168.255.n, where n is the node number of the controller. The default IP address is for connection to the Left MP only. 4 Click OK to save your changes. Configuring Trident or Tri-GP MP Serial Ports This procedure explains how to configure serial ports on a Trident or Tri-GP MP, which supports serial connections using Modbus Slave RTU protocol. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the MP slot, click Setup, and then click the Serial Ports tab. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident and Tri-GP Hardware 3 4 461 Specify these properties on the Serial Ports tab. Property Action Port Selection Select the port to be configured. Protocol Only Modbus Slave RTU is available. Modbus Slave Address Enter the slave address of the serial port on the MP Baseplate. Baud Rate Select the rate used in the installation. Data Bits Set at 8 bits; cannot be changed. Stop Bits Select 1 Bit or 2 Bits. Parity Select a parity option. Transceiver Mode Select RS-232 or RS-485, depending on the physical connection. Handshake Set to none; cannot be changed. Wire Type Set to 4 wire; cannot be changed. Modbus (Minimum and Maximum) Range Enter a minimum value (0 is default) and maximum value (32,767 is maximum). Signal Delays Set to 0; cannot be changed. Copy Current Setup to Other Serial Ports Command Click to have the settings for the selected port copied to the other two serial ports on the MP. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 462 Chapter 4 Trident and Tri-GP Controller Configuration Inserting a Trident or Tri-GP Module This procedure explains how to insert a Trident or Tri-GP module in a configuration. If a CM is added to a configuration after the application has been downloaded to the controller, you must use the Download All command to download the change. Note If you already have a model 3301 or 3301S2 DI module installed, you can quickly change it to a model 3311 or 3311S2 HRDI module (and vice-versa) by double-clicking on the module in the configuration pane, selecting the model 3311 or 3311S2 HRDI module from the Model list in the Item Properties dialog box, and then clicking Confirm. This configuration shortcut can also be used when switching between the model 3481/3481S2 and 3482/3482S2 AO modules. Procedure 1 On the Controller tree, double-click Configuration. 2 On the Configuration tree, open the Hardware Allocation node, and then click the MP slot. 3 On the Tools menu, click Insert Module. The Insert Module dialog box appears. 4 Select the type of module you want to add to the configuration, and click OK. The mouse pointer changes to look like this: 5 Click on the configuration pane to add the module to the configuration. Configuration pane Module being added 6 If you added an SDO, HRDI, EPI, PI, CM, or CIM, configure the module using the instructions specific to that module: • Configuring a Trident or Tri-GP SDO Module on page 463 • Configuring a Trident or Tri-GP HRDI Module on page 464 • Configuring a Trident or Tri-GP PI or EPI Module on page 467 • Configuring Trident or Tri-GP Communication Modules on page 470 TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident and Tri-GP Hardware 463 Removing a Trident or Tri-GP Module This procedure explains how to remove a module from a Trident or Tri-GP controller configuration. If a CM or CIM is removed from a configuration after the application has been downloaded to the controller, you must use the Download All command to download the change. Procedure 1 On the Controller tree, double-click Configuration. 2 On the Configuration tree, click Hardware Allocation. 3 On the configuration pane, click the icon that represents the module, and then press the Delete key. Configuring a Trident or Tri-GP SDO Module This procedure explains how to configure a Trident (model 3411) or Tri-GP (model 3411S2) Supervised Digital Output (SDO) module, which provides loop supervision to field devices in fire and gas applications. 16 points are available; each point can be independently configured. The model 3411 SDO module is compatible only with Trident 2.1 and later systems. See the Planning and Installation Guide for Trident v2-v3 Systems for more information. The model 3411S2 SDO module is compatible only with Tri-GP v2.1 and later systems. See the Planning and Installation Guide for Tri-GP v2-v3 Systems for more information. Procedure 1 On the Controller tree, double-click Configuration. 2 On the Configuration tree, expand the Hardware Allocation node, and then expand the MP node the SDO module is installed in. 3 Double-click the SDO module, and then click Setup. TriStation 1131 Developer’s Guide, 4.14.0 464 Chapter 4 Trident and Tri-GP Controller Configuration 4 Select the tagname (point) to be configured, and then select how you want the point to be configured: • If you want to inhibit supervision for the selected point, select the Inhibit Supervision check box This will suppress reporting of supervisory alarms (i.e. open-loads). • If you want the selected point to be supervised, clear the Inhibit Supervision check box. This will provide detection and alarming of supervisory (i.e. open-load) conditions. The default for each point is Supervised (the check box is cleared). WARNING 5 6 Using the SYS_OVD_INHIBIT function block to inhibit OVDs on a point overrides the supervisory configuration and results in loss of supervision of that point. See the TriStation Libraries Reference for more information about the SYS_OVD_INHIBIT function block. Continue to select tagnames and specify settings as needed. • Press Shift and click to select multiple contiguous tagnames. • Press Ctrl and click to select multiple non-contiguous tagnames. Click OK to save your changes. Configuring a Trident or Tri-GP HRDI Module This procedure explains how to configure a Trident (model 3311) or Tri-GP (model 3311S2) High-Resolution Digital Input (HRDI) module, which allows you to enable highly-accurate sequence of events (SOE) recording for point transitions at a resolution of up to 1 msec. A point transition (or event) is the state change of a Boolean variable from True to False or from False to True. The HRDI has 32 points available; each point can be independently configured. Note For more information about using sequence of events in your application, see SOE Development on page 290. The model 3311 HRDI module is compatible only with Trident v2.1 and later systems. See the Planning and Installation Guide for Trident v2-v3 Systems for more information. The model 3311S2 HRDI module is compatible only with Tri-GP v2.1 and later systems. See the Planning and Installation Guide for Tri-GP v2-v3 Systems for more information. Procedure 1 On the Controller tree, double-click Configuration. 2 On the Configuration tree, expand the Hardware Allocation node, and then expand the MP node the HRDI module is installed in. 3 Double-click the HRDI module, and then click Setup. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident and Tri-GP Hardware 4 465 Select the tagname to be configured, and then specify these properties in the HRDI Setup dialog box. Property Action SOE Trigger State Determines if SOE is enabled for the selected point. When SOE is enabled, the HRDI module will time stamp and record point transitions for the selected point. Select the option to be used for the selected point. • Disabled: SOE is not enabled for the point. Point transitions will not be reported. • Rising: SOE is enabled for the point. Point transitions will be reported when the Boolean value changes from False to True (0 to 1). • Falling: SOE is enabled for the point. Point transitions will be reported when the Boolean value changes from True to False (1 to 0). • Rising/Falling: SOE is enabled for the point. Point transitions will be reported for both Rising and Falling changes (False to True, or True to False). The default is Disabled. TriStation 1131 Developer’s Guide, 4.14.0 466 Chapter 4 Trident and Tri-GP Controller Configuration Property Action SOE Trigger Time Defines the number of milliseconds (with an accuracy of 1 msec or less) a signal must be stable before its change in state (transition) causes the reporting of an event. Also known as the debounce period. A longer trigger time results in a longer debounce period, so that pulse widths that fall within the debounce period will not be reported as an event. Enter the trigger time in milliseconds. The available range is 0 to 250 msec. • If any trigger with a pulse width larger than x msec needs to be reported as an event, then enter x-1 msec. For example, to report a pulse width larger than 75, enter 74 as the trigger time (because 75-1=74). • If any trigger with a pulse width smaller than x msec needs to be filtered out (not reported as an event), then enter x+1 msec. For example, to filter out a pulse width smaller than 30, enter 31 as the trigger time (because 30+1=31). The default is 0, meaning there is no debounce period, and: • A trigger with a pulse width larger than 1 msec will always generate an event. • A trigger with a pulse width smaller than 1 msec may or may not generate an event. Only available if SOE has been enabled for the point. SOE Dead Time Defines the length of time after a transition before a subsequent transition will be reported. Once a transition on the selected point has occurred, any subsequent transitions will be reported only after the dead time interval has elapsed. A longer dead time interval is better able to prevent the higherlevel SOE application from being flooded with events, but it also means there is a higher chance of losing subsequent transition events. Enter the amount of dead time in seconds. The available range is 0 to 250 sec, with an accuracy of 10 msec or less. The default is 0, meaning any subsequent transition will generate an event as long as the previous transition on the same point has been collected and cleared. It does not mean that every transition on the same point will generate an event, as a transition on the same point that occurs too soon—before the previous event is cleared—may be missed. Only available if SOE has been enabled for the point. 5 6 Continue to select tagnames and specify settings as needed. • Press Shift and click to select multiple contiguous tagnames. • Press Ctrl and click to select multiple non-contiguous tagnames. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident and Tri-GP Hardware 467 Configuring a Trident or Tri-GP PI or EPI Module This procedure explains how to configure the following Trident or Tri-GP modules: • Model 3381 Trident Pulse Input (PI) module (compatible only with Trident 2.0 and earlier systems) • Model 3382 Trident Enhanced Pulse Input (EPI) module (compatible only with Trident 2.1.x and later systems) • Model 3382S2 Tri-GP Enhanced Pulse Input (EPI) module (compatible only with Tri-GP 2.1.x and later systems) These modules are used for speed and RPM inputs. Six points are available; each point can be independently configured. Acceleration and jerk measurements for each point are available on the EPI module only. Note The number of points for the EPI (model 3382 or 3382S2) module displays as 24 in the Insert Module dialog box (see Inserting a Trident or Tri-GP Module on page 462). This is because each of the six available points provides speed, acceleration, and jerk measurements as separate logical points (for a total of 18 logical points); six additional points are also included in the total, but are reserved for future use. A maximum of five EPI modules can be configured in a Trident 2.1 or later, or Tri-GP, project. For information about system configuration restrictions and validated I/O module configurations in earlier Trident system versions, please see the Product Release Notice for your Trident system version. If you have a PI module installed in a Trident 2.0 or earlier project, please note the following: • Upgrading the target system version for your project to Trident 2.1 or later will automatically upgrade the PI module to an EPI module. • The existing PI module point configuration is retained for the EPI module during a target system version upgrade to Trident 2.1 or later. • TriStation 1131 will not allow you to upgrade the project’s target system version to Trident 2.1 or later if more than five PI modules are installed in the project. You must remove the excess PI modules from your project prior to starting a target system version change. See Configuring the Trident or Tri-GP Target System Version on page 443 for more information about changing the target system version. • If you have more than five PI modules installed in your Trident 2.0 or earlier system, you will need to physically remove the excess modules from the Trident chassis, rewire the PI points that were connected to those modules, and reprogram your application accordingly. All of these tasks should be completed prior to upgrading to Trident 2.1. • Because the EPI module requires a greater memory allocation than the PI module, the automatic upgrade from a PI module to an EPI module may not be successful in cases where not enough memory is available to be allocated to the EPI module(s). TriStation 1131 Developer’s Guide, 4.14.0 468 Chapter 4 Trident and Tri-GP Controller Configuration Procedure 1 On the Controller tree, double-click Configuration. 2 On the Configuration tree, expand the Hardware Allocation node, and then expand the MP node the PI or EPI module is installed in. 3 Double-click the PI or EPI module, and then click Setup. 4 Select the tagname (point) to be configured, and then specify these properties in the PI Setup dialog box. Property Action Field Power Select Field Power Present if the installed system has field power connected to the Pulse Input Baseplate. The default is Field Power Absent. Min Field Enter the minimum range for field power in volts. The default is 0 volts. Available only when Field Power Present is selected. Max Field Enter the maximum range for field power in volts. The default is 33 volts. Available only when Field Power Present is selected. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident and Tri-GP Hardware Property Action Rate Type Select Speed or RPM to specify the type of rate applied to pulse input signals. 469 • Speed: Used for pulses measured in seconds, minutes, or hours. • RPM: Used for pulses measured in the number of revolutions per minute of the shaft that connects a gear to the rotating equipment. Not available if an Acceleration or Jerk point is selected (EPI module only). Triggering Mode Select Rising Edge or Falling Edge depending on the installation. Not available if an Acceleration or Jerk point is selected (EPI module only). Number of Gear Teeth Enter the number of gear teeth that are counted in each revolution. The Rate Type property must be specified as RPM to enable this property. Not available if an Acceleration or Jerk point is selected (EPI module only). Scale Factor Specifies how to convert pulse input signals into engineering units. For: • Pulses per second, set to 0.016667. • Pulses per minute, set to 1.0 (default). • Pulses per hour, set to 60.0 Not available if an Acceleration or Jerk point is selected (EPI module only). 5 6 Continue to select tagnames and specify settings as needed. • Press Shift and click to select multiple contiguous tagnames. • Press Ctrl and click to select multiple non-contiguous tagnames. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 470 Chapter 4 Trident and Tri-GP Controller Configuration Configuring Trident or Tri-GP Communication Modules This section explains how to configure Trident or Tri-GP communication modules (CM or CIM) for communication with external devices. Notes The CM can be configured in Trident 1.2 and later systems only; earlier Trident systems do not support the use of communication modules. Throughout the following sections, where ‘1.x’ is used, it refers only to Trident 1.2 and later systems. In addition to configuring ports on the communication module(s), you also need to configure the Trident or Tri-GP controller’s network and/or serial connection to the TriStation PC, in order connect to the controller and download your application. For more information, see Chapter 6, Trident and Tri-GP Communication with TriStation 1131. Topics include: • Configuring the Trident 1.x Communication Module on page 470 • Configuring the Trident or Tri-GP 2.x/3.x Communication Module on page 474 • Configuring the Trident or Tri-GP 3.x Communications Integration Module on page 491 See Configuring Trident or Tri-GP Controller Printing on page 597 for instructions on configuring a Trident or Tri-GP communication module for use with a printer. Configuring the Trident 1.x Communication Module These procedures explain how to configure the network and serial ports on a CM installed in a Trident 1.x system. Topics include: • Configuring Trident 1.x CM Network Ports on page 470 • Configuring Trident 1.x CM Serial Ports on page 472 • Configuring Trident 1.x CM Routing on page 473 Configuring Trident 1.x CM Network Ports This procedure explains how to configure network ports on a Trident 1.x CM, which supports these connections: • To a TriStation PC • To a Peer-to-Peer network of Triconex controllers • To an external device or network TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Communication Modules 471 Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CM, click Setup, and then click the Network tab. 3 Specify these properties on the Network tab. Property Action Slot Selection Select the slot to be configured. Mode Select Open Network or Peer-to-Peer for either NET 1 or NET 2. You cannot use the same mode on both ports. 4 Privilege Select Read to restrict access from external devices. Not available with Peer-to-Peer. The default is Read/Write. Transceiver Port Select the type of port used. Transceiver Mode Select the mode used. Not available with Peer-to-Peer. IP Address Enter the IP address of the controller. Not available with Peerto-Peer. IP Subnet Mask Enter the subnet mask, if needed. Not available with Peer-toPeer. Default Gateway IP Address Enter the default gateway, if needed. Not available with Peerto-Peer. Time Synchronization Select to enable time synchronization on NET 1 or NET 2. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 472 Chapter 4 Trident and Tri-GP Controller Configuration Configuring Trident 1.x CM Serial Ports This procedure explains how to configure serial ports on a Trident 1.x CM, which supports connections using Modbus slave, master, and master/slave protocols. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CM slot, click Setup, and then click the Serial Ports tab. 3 Specify these properties on the Serial Ports tab. Property Action Port Selection Select the port to be configured. Protocol Select the protocol to use. Modbus Station Enter the slave address of the serial port on the MP Baseplate. Not used with Master protocol. See Modbus Slave Address on page 764. Baud Rate Select the rate used in the installation. Data Bits Select 7 or 8 bits; only available with slave ASCII protocol. Set to 8 bits for all other protocols. Stop Bits Select 1 Bit or 2 Bits. Parity Select the parity option. Transceiver Mode Select RS-232 or RS-485, depending on the physical connection. Handshake Select Hardware to use signal delays to determine if the connection is valid. Wire Type Select 2 or 4 wire, depending on the installation. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Communication Modules 4 Property Action Modbus (Minimum and Maximum) Range Enter a minimum value (0 is default) and maximum value (32,767 is maximum). Only available with Modbus. Signal Delays Enter the number of milliseconds to adjust timing of the data transmission. 473 Click OK to save your changes. Configuring Trident 1.x CM Routing This procedure explains how to configure routing information for network communication on a Trident 1.x CM. This procedure is optional, depending on your network configuration. For more information, see your network administrator. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CM slot, click Setup, and then click the Routing tab. 3 Specify these properties on the Routing tab. Property Action Slot Selection Select the slot to configure. Destination Gateway IP Address Enter the destination address. Destination IP Subnet Mask Enter the address for the subnet mask. Default Gateway IP Address Enter the address for the gateway. 4 Repeat for each route required on your network. 5 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 474 Chapter 4 Trident and Tri-GP Controller Configuration Configuring the Trident or Tri-GP 2.x/3.x Communication Module These procedures explain how to configure an enhanced CM installed in the following systems: • Trident 2.x or 3.x • Tri-GP 2.x or 3.x Note To configure a CM installed in a Trident 1.x system, see Configuring the Trident 1.x Communication Module on page 470. To configure a CIM installed in a Trident/Tri-GP 3.x system, see Configuring the Trident or Tri-GP 3.x Communications Integration Module on page 491. A single Trident or Tri-GP 2.x/3.x controller supports a maximum of two CMs on one CM baseplate. For detailed CM installation guidelines, see the Planning and Installation Guide for your controller. The following table lists the protocols supported by both the enhanced Trident CM (model 3201) and Tri-GP CM (model 3201S2) on network and serial ports. Protocol or Standard Network Ports Serial Ports TriStation NET 1, NET 2 Port 3 only TSAA (UDP/IP) NET 1, NET 2 TSAA with IP Multicast (UDP/IP) NET 1, NET 2 — Peer-to-Peer (UDP/IP) NET 1, NET 2 — Peer-to-Peer (DLC) NET 1, NET 2 — Modbus Slave (ASCII or RTU) — Any port Modbus Master (RTU) — Any port NET 1, NET 2 — NET 1 — Triconex Time Synchronization via UDP/IP NET 1, NET 2 — SNTP Triconex Time Synchronization NET 1, NET 2 — Network Printing using Jet Direct NET 1, NET 2 — Modbus Master or Slave (TCP) Triconex Time Synchronization via DLC —a a. — means the protocol is not available on this port. Note While the preferred means for connecting the TriStation PC to the Trident or Tri-GP controller is via a network connection, Invensys recommends configuring a serial connection to the CM first, because it is less complex and easier to successfully connect to the CM through the serial port. Once you have successfully connected to the CM and downloaded the initial configuration to the Trident, you can go back and configure the more complex network connection, without worrying about losing the ability to communicate with the controller altogether. See Connecting to the Trident or Tri-GP 2.x/3.x Controller for the First Time on page 567 for more information. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Communication Modules 475 To configure specific types of CM ports, see these topics: • Configuring Trident or Tri-GP 2.x/3.x CM Serial Ports on page 476 • Configuring Trident or Tri-GP 2.x/3.x CM Network Ports on page 478 • Configuring Trident or Tri-GP 2.x/3.x CM Peer-To-Peer Ports on page 481 • Configuring Trident or Tri-GP 2.x/3.x CM Modbus TCP Ports on page 483 • Configuring Trident or Tri-GP 2.x/3.x CM Routing on page 485 • Configuring Trident or Tri-GP 2.x/3.x CM Protocols on page 487 For additional information on configuring the CM, see these topics: • Using a Trident or Tri-GP 2.x/3.x CM to Synchronize Time on page 513 for instructions on configuring the CM to synchronize time. • Controlling Access to the CM or CIM on page 590 for instructions on controlling access to the CM on a per-client level. • Configuring Trident or Tri-GP Controller Printing on page 597 for instructions on configuring the CM for use with a printer. Exporting and Importing a Trident or Tri-GP 2.x/3.x CM Configuration Once you have configured a Trident or Tri-GP 2.x/3.x CM, you can export its configuration to an XML file. This file can then be used to quickly configure other Trident or Tri-GP 2.x/3.x CMs by importing the saved configuration settings. For detailed instructions, see Exporting the Trident or Tri-GP 2.x/3.x CM Configuration to a File on page 489 and Importing the Trident or Tri-GP 2.x/3.x CM Configuration From a File on page 490. TriStation 1131 Developer’s Guide, 4.14.0 476 Chapter 4 Trident and Tri-GP Controller Configuration Configuring Trident or Tri-GP 2.x/3.x CM Serial Ports This procedure explains how to configure serial ports on a Trident or Tri-GP 2.x/3.x CM. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CM, and then click Setup. The CM Setup dialog box appears. 3 Click the Serial Ports tab. 4 Specify these properties. Property Action Port Selection Click the port to be configured. Ports can be configured only for a slot with an installed module. Protocol Select the communication protocol for the port: • All ports can use Modbus Master, Modbus Slave ASCII, or Modbus Slave RTU. • Only port 3 can use TriStation. Port Write Enabled Available only if Modbus Slave (ASCII or RTU) is selected as the communication protocol. Select this check box if you want to allow Modbus writes to this slave port. The default is cleared (the port is read-only). Modbus Slave Address If you selected Modbus Slave RTU or ASCII, enter the number of the Modbus slave device (1-247). The default is 1. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Communication Modules Property Action Baud Rate Enter the communication rate for the port. The default is 9600. 477 For a TriStation connection, the default is 115200 and cannot be changed. Data Bits Select 8 or 7 bits. The default is 8. Available only with Modbus Slave ASCII. Stop Bits Select 1 or 2 bits. The default is 1 bit. Parity Select the type of parity for the port. The default is Odd. Transceiver Mode Select RS-485 or RS-232. The default is RS-232. On port 3 when TriStation is selected as the protocol, RS-485 is not available. Handshake Select None or Hardware; the default is None. FP Ordering Select the order to be used with floating point numbers. Determines whether the most significant bits in a 32-bit address are the first 16 (high) or the last 16 (low). The default is Low 16 Bits First. Note: If you select Modbus Master as the communication protocol, this property is automatically set to High 16 Bits First and cannot be changed. 5 Modbus (Minimum and Maximum) Range Enter the minimum and maximum values to be used for the Modbus data range. The default minimum is 0. The default maximum is 32,767. Master Logical Port Enter the port number that the CM will use in Modbus Master functions to access the port (1-15). Only available for Modbus Master. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 478 Chapter 4 Trident and Tri-GP Controller Configuration Configuring Trident or Tri-GP 2.x/3.x CM Network Ports This procedure explains how to configure network ports on a Trident or Tri-GP 2.x/3.x CM. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CM, and then click Setup. The CM Setup dialog box appears. 3 Specify these properties on the Network tab. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Communication Modules Property Action Slot Selection Select the physical slot where the CM you want to configure is installed, Left Slot or Right Slot. 479 The CM baseplate can hold two CMs—one in the left physical slot, and one in the right physical slot. A CM can be configured in the right slot only if a CM in the left slot has already been configured. For more information about slot locations, see the Planning and Installation Guide for your controller. Note: If you have configured CMs in both the left and right slots, and you then uninstall the CM in the left slot, you will no longer be able to change the configuration of the CM installed in the right slot. You must re-install a CM in the left slot before you can modify the configuration of the CM in the right slot. Not Installed, Installed Click Installed to enable configuration of the module. Clicking Not Installed resets all options to their default state and makes them unavailable for configuration. The default is Not Installed. Transceiver Mode Select the communication mode. For NET 1, the default is 10 Mbps Half Duplex. For NET 2, the default is Auto-Negotiate. For more detailed information about supported modes per TCM model, see Transceiver Mode on page 846. IP Address Enter the IP Address for the port. The addresses for NET 1 and NET 2 do not need to be unique. The default values are 0.0.0.0. Note: Your own IP addresses cannot be used for connecting to the controller until your application—with the IP address configuration—has been downloaded to the controller at least once, using the Download All command. See Connecting to the Trident or Tri-GP 2.x/3.x Controller for the First Time on page 567 for more information. The highest and lowest IP addresses in a subnet (addresses where the last number is 0 or 255, such as 192.168.55) are reserved for broadcast messaging and cannot be used as a valid IP address. IP Subnet Mask If needed, enter the IP address for the subnet. The default is 255.255.255.0. Default Gateway IP Address If needed, enter the IP address for the default gateway. The default is 0.0.0.0. Typically, this is the IP address of the network router. The default gateway address must be part of the subnet. TriStation 1131 Developer’s Guide, 4.14.0 480 Chapter 4 Trident and Tri-GP Controller Configuration 4 To configure the CM for operation behind a firewall, click Show Advanced Options and then specify the properties in the following table for NET 1 and NET 2. Setting these properties restricts the ports that the CM can use for TCP connections to the specified range. This allows the CM to operate behind a firewall that has implemented port restrictions. For most networks, the default settings should be sufficient. Invensys recommends that only advanced users change these settings. Note If these settings are misconfigured, Modbus TCP will be unable to connect. If this occurs, reset the values to the default settings to fix the problem and re-enable Modbus TCP. If you need to use this feature, please contact Global Customer Support for assistance with configuring these settings. Property Action Lowest TCP Port Number Enter the lowest TCP port number to use for an outgoing connection from the CM. Can be from 1024 to 65535. The default value is 49152. Applicable to Modbus/TCP ports. Highest TCP Port Number Enter the highest TCP port number to use for an outgoing connection from the CM. Can be from 1024 to 65535. The default value is 65535. Applicable to Modbus/TCP ports. 5 Note Click OK to save your changes. Changes to CM IP addresses are not in effect until the existing connection is closed and a new connection is opened. Once a connection is opened, it remains open until you close it, even if the IP address is changed via a download changes operation. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Communication Modules 481 Configuring Trident or Tri-GP 2.x/3.x CM Peer-To-Peer Ports This procedure explains how to configure the IP addresses for controllers communicating on a Peer-to-Peer network through a CM. You can configure up to 63 Peer-to-Peer nodes. The CM supports Standard Peer-to-Peer only. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CM, and then click Setup. The CM Setup dialog box appears. 3 Click the Peer-to-Peer tab. 4 Under Slot Selection, select the module (slot) you want to configure Peer-to-Peer ports for. 5 Select a node (controller), and specify these properties. Property Action Destination UDP Port Enter the UDP port number for each controller to be communicated with on the Peer-to-Peer network. This must be the same number that the controller uses as its UDP Base Port Number. The default is 1503. You should not need to change this setting unless the CM is located behind a firewall, or you want to use a custom UDP port number. TriStation 1131 Developer’s Guide, 4.14.0 482 Chapter 4 Trident and Tri-GP Controller Configuration 6 Property Action Network Click the network port that the CM uses to communicate with the selected Peer-to-Peer node. The default is NET 1. IP Address Enter the IP address for the controller. Click Update to save the new settings for the selected node. If you forget to click Update before selecting another node, your settings will be lost. 7 Repeat steps 4 through 6 for each node to be included in the network. Note 8 If necessary, click Reset All to reset all node settings for the selected slot to their default, unconfigured state. Once all nodes have been configured, specify these properties (applicable to all nodes on the Peer-to-Peer network). Property Action UDP Base Port Number For each network port, enter the UDP base port number for the controller. Enter 0 to disable Peer-to-Peer over UDP/IP on the network. The maximum value is 65534. The default is 1503 on both NET 1 and NET 2 (meaning Peerto-Peer is enabled on both ports). UDP port numbers do not need to be unique, as long as the IP address for each port is unique. See UDP Base Port Number on page 854 for reserved values. Enable Communication with Tricon V8, Tricon V9, and Trident v2. Peer-to-Peer Systems Select the port—NET 1 or NET 2—on which you want to enable Peer-to-Peer communication with Tricon version 8 and 9 systems, and/or Trident version 1 systems. The default is None. Available only for a module installed in the left slot. 9 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Communication Modules 483 Configuring Trident or Tri-GP 2.x/3.x CM Modbus TCP Ports This procedure explains how to configure Modbus TCP ports on a CM, which enables Modbus communication through network ports. Four ports are available for Modbus TCP communication. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CM, and then click Setup. The CM Setup dialog box appears. 3 Click the Modbus TCP tab. 4 Under Slot Selection, select the module (slot) you want to configure Modbus TCP ports for. 5 Select a port and specify these properties. Property Action Protocol Select the communication protocol for the port. Options include Modbus TCP Master and Modbus TCP Slave Net. Port Write Enabled Available only if Modbus TCP Slave is selected as the communication protocol. Select this check box if you want to allow Modbus writes to this slave port. The default is cleared (the port is read-only). TriStation 1131 Developer’s Guide, 4.14.0 484 Chapter 4 Trident and Tri-GP Controller Configuration Property Action Master Logical Port Enter the number of the Modbus Master node (1-15). Available only with Modbus TCP Master protocol. Must be unique for each CM installed in a system. TCP Port Number Enter the number for the TCP port. The default is 502. Network Click the network that the selected port is connected to. The default is NET 2. IP Address If the port uses Modbus Master protocol, enter the IP address of the slave node. If the port uses Modbus Slave protocol, enter either of these: • To accept communication from any Modbus Master, leave the IP address as 0.0.0.0. • To accept communication only from a defined Modbus Master, enter the specific master IP address. FP Ordering Select the order to be used with floating point numbers. Determines whether the most significant bits in a 32-bit address are the first 16 (high) or the last 16 (low). The default is Low 16 Bits First. Note: If you select Modbus TCP Master as the communication protocol, this property is automatically set to High 16 Bits First and cannot be changed. Modbus (Minimum and Maximum) Range Enter the minimum and maximum values to be used for the Modbus data range. The default minimum is 0. The default maximum is 32,767. Available only with Modbus TCP Slave Net. 6 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Communication Modules 485 Configuring Trident or Tri-GP 2.x/3.x CM Routing This procedure explains how to configure routing on a CM. Up to 10 different routes can be configured for each network; each slot (module) has two networks (NET 1 and NET 2). Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CM, and then click Setup. The CM Setup dialog box appears. 3 Click the Routing tab. 4 Select the module (slot) you want to configure routing for. 5 Select the network (NET 1 or NET 2) you want to configure routing for. 6 Select a destination route and then specify these properties. Property Action Destination Gateway IP Address Enter the IP address which is used if the controller is not on the same subnet as other devices. TriStation 1131 Developer’s Guide, 4.14.0 486 Chapter 4 Trident and Tri-GP Controller Configuration 7 Property Action Destination IP Subnet Mask Enter the IP address of the subnet mask. Default Gateway IP Address Enter the IP address of the gateway to which the controller is connected. The gateway address must always be on NET 1 or NET 2. Click Update Destination to apply the settings. Note 8 If the gateway address is on NET 2, then the subnet mask must be the same as the NET 2 subnet mask defined on the Network tab. If the gateway address is on NET 1, then the subnet mask must be the same as the NET 1 subnet mask defined on the Network tab. See Configuring Trident or Tri-GP 2.x/3.x CM Network Ports on page 478. If necessary, click Reset All to change all destination settings for the selected slot to their default, unconfigured state. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Communication Modules 487 Configuring Trident or Tri-GP 2.x/3.x CM Protocols This procedure explains how to configure the TSAA and TriStation protocols used for CM communication. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CM, and then click Setup. The CM Setup dialog box appears. 3 Click the Protocols tab. 4 Select the module (slot) you want to configure protocols for. 5 Specify these properties for the protocol(s) you will be using with the CM. Protocol Property Action TriStation TriStation Port Number Enter the UDP port to use for TriStation connections on NET 1 and NET 2. The default for both ports is 1502. Cannot be the same as the Management or TSAA port numbers. See UDP Base Port Number on page 854 for additional information. TriStation 1131 Developer’s Guide, 4.14.0 488 Chapter 4 Trident and Tri-GP Controller Configuration Protocol Property Action Management Management Port Number Enter the UDP port to use for the Enhanced Diagnostic Monitor’s connection to CM communication status information on NET 1 and NET 2. The default for both ports is 1510. This must be the same value as the Management UDP Port Number property in the Enhanced Diagnostic Monitor’s Network Configuration dialog box. Cannot be the same as the TriStation or TSAA port numbers. For more information, see the Enhanced Diagnostic Monitor User’s Guide. TSAA TSAA Port Number Enter the UDP port to use for TSAA connections, including DDE Server and SOE Recorder, on NET 1 and NET 2. The default for both ports is 1500. Cannot be the same as the TriStation or Management port numbers. A value of 0 indicates that TSAA communication is disabled on that port. See UDP Base Port Number on page 854 for additional information. TSAA Multicast IP Address Enter the IP address that TSAA multicasts should be sent to. The default is 0.0.0.0 (IP multicasting is disabled). Bin data and/or SOE data available messages will be sent to the specified address, so that all members of the group will receive the data. Note: To use TSAA multicasting, your network hardware (such as routers) must also support multicasting. See your Network Administrator or IT department for more information. Multicast Update Rate Enter the update rate, in milliseconds, for TSAA IP multicasting. Can be from 250 to 2,000. The default value is 1,000. Bin data and/or SOE data available messages will be sent to the multicast IP address at the specified update rate (for example, by default, bin data will be multicast every 1,000ms). 6 Click OK to save your changes. CAUTION By default, TSAA clients have write access to the NET 1 and NET 2 ports on the Trident or Tri-GP 2.x/3.x CM. Depending on your configuration, this may create a security issue. To disable write access by TSAA clients, you must enable and configure the CM access control list. See Controlling Access to the CM or CIM on page 590. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Communication Modules 489 Exporting the Trident or Tri-GP 2.x/3.x CM Configuration to a File Once CM configuration is complete, you may want to export it to an XML file. Not only does this provide a backup of your configuration settings, it also allows you to import the settings to other Trident or Tri-GP 2.x/3.x CMs, saving time and effort, and ensuring that all CMs in a system have the same configuration. Technical Support may also ask for an exported configuration file to assist in troubleshooting CM problems. Note An exported CM configuration file cannot be modified outside of TriStation 1131. If the XML file is changed after export, you will be unable to import it into TriStation 1131. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CM, and then click Setup. The CM Setup dialog box appears. Export Button 3 Click Export. If the CM configuration has been changed, but not saved, you are asked if you want to include the unsaved changes in the exported file. 4 Note Navigate to the folder you want to save the exported configuration file in, enter a file name, and click Save. A CM configuration file exported from a CM installed in a Trident or Tri-GP 2.x/3.x system cannot be imported to a CM installed in a Trident 1.x system. TriStation 1131 Developer’s Guide, 4.14.0 490 Chapter 4 Trident and Tri-GP Controller Configuration Importing the Trident or Tri-GP 2.x/3.x CM Configuration From a File If you have already configured a Trident or Tri-GP 2.x/3.x CM, and exported the configuration to a file, you can import the saved configuration to another Trident or Tri-GP 2.x/3.x CM. Once the import is complete, you should review the CM configuration to ensure that all settings have been correctly configured for your implementation. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CM, and then click Setup. The CM Setup dialog box appears. 3 Click Import. If the CM configuration has been changed, but not yet saved, you are asked if you want to overwrite the existing configuration, including the unsaved changes, with the imported settings. 4 Navigate to the folder where the exported configuration file is located, and click Open. CM configuration settings are imported from the selected file. 5 Click each tab of the CM Setup dialog box to review and verify that all settings have been correctly configured. 6 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Communication Modules 491 Configuring the Trident or Tri-GP 3.x Communications Integration Module These procedures explain how to configure a CIM installed in a Trident or Tri-GP 3.x system. A single Trident or Tri-GP 3.x controller supports a maximum of two CIMs on one CIM baseplate. For detailed CIM installation guidelines, see the Planning and Installation Guide for your controller. The following table lists the protocols supported by both the Trident CIM (model 3211) and Tri-GP CIM (model 3211S2) on network and serial ports. Protocol or Standard Network Ports Serial Ports TriStation NET 1, NET 2 Port 3 only TSAA (UDP/IP) NET 1, NET 2 —a TSAA with IP Multicast (UDP/IP) NET 1, NET 2 — Peer-to-Peer (UDP/IP) NET 1, NET 2 — Embedded OPC UA Server NET 1, NET 2 — Modbus Slave (ASCII or RTU) — Any port Modbus Master (RTU) — Any port Modbus Master or Slave (TCP) NET 1, NET 2 — Triconex Time Synchronization via UDP/IP NET 1, NET 2 — SNTP Triconex Time Synchronization NET 1, NET 2 — Network Printing using Jet Direct NET 1, NET 2 — a. — means the protocol is not available on this port. Note While the preferred means for connecting the TriStation PC to the Trident or Tri-GP controller is via a network connection, Invensys recommends configuring a serial connection to the CIM first, because it is less complex and easier to successfully connect to the CIM through the serial port. Once you have successfully connected to the CIM and downloaded the initial configuration to the controller, you can go back and configure the more complex network connection, without worrying about losing the ability to communicate with the controller altogether. See Connecting to the Trident or Tri-GP 2.x/3.x Controller for the First Time on page 567 for more information. TriStation 1131 Developer’s Guide, 4.14.0 492 Chapter 4 Trident and Tri-GP Controller Configuration To configure specific types of CIM ports, see these topics: • Configuring Trident or Tri-GP 3.x CIM Serial Ports on page 493 • Configuring Trident or Tri-GP 3.x CIM Network Ports on page 495 • Configuring Trident or Tri-GP 3.x CIM Peer-To-Peer Ports on page 498 • Configuring Trident or Tri-GP 3.x CIM Modbus TCP Ports on page 500 • Configuring Trident or Tri-GP 3.x CIM Routing on page 502 • Configuring Trident or Tri-GP 3.x CIM Protocols on page 504 • Configuring the Trident or Tri-GP 3.x CIM OPC UA Server on page 506 For additional information on configuring the CIM, see these topics: • Using a Trident or Tri-GP 3.x CIM to Synchronize Time on page 518 for instructions on configuring the CIM to synchronize time. • Controlling Access to the CM or CIM on page 590 for instructions on controlling access to the CIM on a per-client level. • Configuring Trident or Tri-GP Controller Printing on page 597 for instructions on configuring the CM for use with a printer. Exporting and Importing a Trident or Tri-GP 3.x CIM Configuration Once you have configured a Trident or Tri-GP 3.x CIM, you can export its configuration to an XML file. This file can then be used to quickly configure other CIMs by importing the saved configuration settings. For detailed instructions, see Exporting the Trident or Tri-GP 3.x CIM Configuration to a File on page 509 and Importing the Trident or Tri-GP 3.x CIM Configuration From a File on page 510. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Communication Modules 493 Configuring Trident or Tri-GP 3.x CIM Serial Ports This procedure explains how to configure serial ports on a Trident or Tri-GP 3.x CIM. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CIM, and then click Setup. The CIM Setup dialog box appears. 3 Click the Serial Ports tab. 4 Specify these properties. Property Action Port Selection Click the port to be configured. Ports can be configured only for a slot with an installed module. Protocol Select the communication protocol for the port: • All ports can use Modbus Master, Modbus Slave ASCII, or Modbus Slave RTU. • Only port 3 can use TriStation. TriStation 1131 Developer’s Guide, 4.14.0 494 Chapter 4 Trident and Tri-GP Controller Configuration Property Action Port Write Enabled Available only if Modbus Slave (ASCII or RTU) is selected as the communication protocol. Select this check box if you want to allow Modbus writes to this slave port. The default is cleared (the port is read-only). Modbus Slave Address If you selected Modbus Slave RTU or ASCII, enter the number of the Modbus slave device (1-247). The default is 1. Baud Rate Enter the communication rate for the port. The default is 9600. For a TriStation connection, the default is 115200 and cannot be changed. Data Bits Select 8 or 7 bits. The default is 8. Available only with Modbus Slave ASCII. Stop Bits Select 1 or 2 bits. The default is 1 bit. Parity Select the type of parity for the port. The default is Odd. Transceiver Mode Select RS-485 or RS-232. The default is RS-232. On port 3 when TriStation is selected as the protocol, RS-485 is not available. Handshake Select None or Hardware; the default is None. Termination Options Select the type of termination used with cables. Only available with RS-485 Transceiver Mode. The default is None. FP Ordering Select the order to be used with floating point numbers. Determines whether the most significant bits in a 32-bit address are the first 16 (high) or the last 16 (low). The default is Low 16 Bits First. Note: If you select Modbus Master as the communication protocol, this property is automatically set to High 16 Bits First and cannot be changed. 5 Modbus (Minimum and Maximum) Range Enter the minimum and maximum values to be used for the Modbus data range. The default minimum is 0. The default maximum is 32,767. Master Logical Port Enter the port number that the CIM will use in Modbus Master functions to access the port (1-15). Only available for Modbus Master. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Communication Modules 495 Configuring Trident or Tri-GP 3.x CIM Network Ports This procedure explains how to configure network ports on a Trident or Tri-GP 3.x CIM. CAUTION Changing any of the following properties, and then performing a download operation, will cause the CIM’s OPC UA server to temporarily cease communication and restart:: • The CIM’s IP address (CIM Setup > Network tab) • The CIM’s subnet mask (CIM Setup > Network tab) • The network port the OPC UA server is configured to use (CIM Setup > OPC tab) • The OPC UA server’s TCP Port Number (CIM Setup > OPC tab) • The OPC UA server’s Alarms SOE Block Number (CIM Setup > OPC tab) Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CIM, and then click Setup. The CIM Setup dialog box appears. TriStation 1131 Developer’s Guide, 4.14.0 496 Chapter 4 Trident and Tri-GP Controller Configuration 3 Specify these properties on the Network tab. Property Action Slot Selection Select the physical slot where the CIM you want to configure is installed, Left Slot or Right Slot. The CIM baseplate can hold two CIMs—one in the left physical slot, and one in the right physical slot. A CIM can be configured in the right slot only if a CIM in the left slot has already been configured. For more information about slot locations, see the Planning and Installation Guide for your controller. Note: If you have configured CIMs in both the left and right slots, and you then uninstall the CIM in the left slot, you will no longer be able to change the configuration of the CIM installed in the right slot. You must re-install a CIM in the left slot before you can modify the configuration of the CIM in the right slot. Not Installed, Installed Click Installed to enable configuration of the module. Clicking Not Installed resets all options to their default state and makes them unavailable for configuration. The default is Not Installed. Transceiver Mode Select the communication mode. For NET 1 and NET 2, the default is Auto-Negotiate. For more detailed information about supported modes per TCM model, see Transceiver Mode on page 846. IP Address Enter the IP Address for the port. The addresses for NET 1 and NET 2 do not need to be unique. The default values are 0.0.0.0. Note: Your own IP addresses cannot be used for connecting to the controller until your application—with the IP address configuration—has been downloaded to the controller at least once, using the Download All command. See Connecting to the Trident or Tri-GP 2.x/3.x Controller for the First Time on page 567 for more information. The highest and lowest IP addresses in a subnet (addresses where the last number is 0 or 255, such as 192.168.55) are reserved for broadcast messaging and cannot be used as a valid IP address. IP Subnet Mask If needed, enter the IP address for the subnet. The default is 255.255.255.0. Default Gateway IP Address If needed, enter the IP address for the default gateway. The default is 0.0.0.0. Typically, this is the IP address of the network router. The default gateway address must be part of the subnet. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Communication Modules 4 497 To configure the CIM for operation behind a firewall, specify the properties in the following table for NET 1 and NET 2. Property Action Lowest TCP Port Number Enter the lowest TCP port number to use for an outgoing connection from the CIM. Can be from 1024 to 65535. The default value is 49152. Applicable to Modbus/TCP ports. Highest TCP Port Number Enter the highest TCP port number to use for an outgoing connection from the CIM. Can be from 1024 to 65535. The default value is 65535. Applicable to Modbus/TCP ports. Setting these properties restricts the ports that the CIM can use for TCP connections to the specified range. This allows the CIM to operate behind a firewall that has implemented port restrictions. For most networks, the default settings should be sufficient. Invensys recommends that only advanced users change these settings. Note 5 Note If these settings are misconfigured, Modbus TCP will be unable to connect. If this occurs, reset the values to the default settings to fix the problem and re-enable Modbus TCP. If you need to use this feature, please contact Global Customer Support for assistance with configuring these settings. Click OK to save your changes. Changes to CIM IP addresses are not in effect until the existing connection is closed and a new connection is opened. Once a connection is opened, it remains open until you close it, even if the IP address is changed via a download changes operation. TriStation 1131 Developer’s Guide, 4.14.0 498 Chapter 4 Trident and Tri-GP Controller Configuration Configuring Trident or Tri-GP 3.x CIM Peer-To-Peer Ports This procedure explains how to configure the IP addresses for controllers communicating on a Peer-to-Peer network through a CIM. You can configure up to 63 Peer-to-Peer nodes. The CIM supports both Standard and Enhanced Peer-to-Peer. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CIM, and then click Setup. The CIM Setup dialog box appears. 3 Click the Peer-to-Peer tab. 4 Under Slot Selection, select the module (slot) you want to configure Peer-to-Peer ports for. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Communication Modules 5 499 Select a node (controller), and specify these properties. Property Action Destination UDP Port Enter the UDP port number for each controller to be communicated with on the Peer-to-Peer network. This must be the same number that the controller uses as its UDP Base Port Number. The default is 1503. You should not need to change this setting unless the CIM is located behind a firewall, or you want to use a custom UDP port number. 6 Network Click the network port that the CIM uses to communicate with the selected Peer-to-Peer node. The default is NET 1. IP Address Enter the IP address for the controller. Click Update to save the new settings for the selected node. If you forget to click Update before selecting another node, your settings will be lost. 7 Repeat steps 4 through 6 for each node to be included in the network. Note 8 If necessary, click Reset All to reset all node settings for the selected slot to their default, unconfigured state. Once all nodes have been configured, specify this property (applicable to all nodes on the Peer-to-Peer network). Property Action UDP Base Port Number For each network port, enter the UDP base port number for the controller. Enter 0 to disable Peer-to-Peer over UDP/IP on the network. The maximum value is 65534. The default is 1503 on both NET 1 and NET 2 (meaning Peerto-Peer is enabled on both ports). UDP port numbers do not need to be unique, as long as the IP address for each port is unique. See UDP Base Port Number on page 854 for reserved values. 9 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 500 Chapter 4 Trident and Tri-GP Controller Configuration Configuring Trident or Tri-GP 3.x CIM Modbus TCP Ports This procedure explains how to configure Modbus TCP ports on a CIM, which enables Modbus communication through network ports. Sixteen ports are available for Modbus TCP communication. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CM, and then click Setup. The CIM Setup dialog box appears. 3 Click the Modbus TCP tab. 4 Under Slot Selection, select the module (slot) you want to configure Modbus TCP ports for. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Communication Modules 5 501 Select a port and specify these properties. Property Action Protocol Select the communication protocol for the port. Options include Modbus TCP Master and Modbus TCP Slave Net. Port Write Enabled Available only if Modbus TCP Slave is selected as the communication protocol. Select this check box if you want to allow Modbus writes to this slave port. The default is cleared (the port is read-only). Master Logical Port Enter the number of the Modbus Master node (1-15). Available only with Modbus TCP Master protocol. Must be unique for each CIM installed in a system. TCP Port Number Enter the number for the TCP port. The default is 502. Network Click the network that the selected port is connected to. The default is NET 2. IP Address If the port uses Modbus Master protocol, enter the IP address of the slave node. If the port uses Modbus Slave protocol, enter either of these: • To accept communication from any Modbus Master, leave the IP address as 0.0.0.0. • To accept communication only from a defined Modbus Master, enter the specific master IP address. FP Ordering Select the order to be used with floating point numbers. Determines whether the most significant bits in a 32-bit address are the first 16 (high) or the last 16 (low). The default is Low 16 Bits First. Note: If you select Modbus TCP Master as the communication protocol, this property is automatically set to High 16 Bits First and cannot be changed. Modbus (Minimum and Maximum) Range Enter the minimum and maximum values to be used for the Modbus data range. The default minimum is 0. The default maximum is 32,767. Available only with Modbus TCP Slave Net. 6 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 502 Chapter 4 Trident and Tri-GP Controller Configuration Configuring Trident or Tri-GP 3.x CIM Routing This procedure explains how to configure routing on a CIM. Up to 10 different routes can be configured for each network; each slot (module) has two networks (NET 1 and NET 2). Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CIM, and then click Setup. The CIM Setup dialog box appears. 3 Click the Routing tab. 4 Select the module (slot) you want to configure routing for. 5 Select the network (NET 1 or NET 2) you want to configure routing for. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Communication Modules 6 7 Select a destination route and then specify these properties. Property Action Destination Gateway IP Address Enter the IP address which is used if the controller is not on the same subnet as other devices. Destination IP Subnet Mask Enter the IP address of the subnet mask. Default Gateway IP Address Enter the IP address of the gateway to which the controller is connected. The gateway address must always be on NET 1 or NET 2. If the gateway address is on NET 2, then the subnet mask must be the same as the NET 2 subnet mask defined on the Network tab. If the gateway address is on NET 1, then the subnet mask must be the same as the NET 1 subnet mask defined on the Network tab. See Configuring Trident or Tri-GP 3.x CIM Network Ports on page 495. Click Update Destination to apply the settings. Note 8 503 If necessary, click Reset All to change all destination settings for the selected slot to their default, unconfigured state. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 504 Chapter 4 Trident and Tri-GP Controller Configuration Configuring Trident or Tri-GP 3.x CIM Protocols This procedure explains how to configure the TSAA and TriStation protocols used for CIM communication. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CIM, and then click Setup. The CIM Setup dialog box appears. 3 Click the Protocols tab. 4 Select the module (slot) you want to configure protocols for. 5 Specify these properties for the protocol(s) you will be using with the CIM. Protocol Property Action TriStation TriStation Port Number Enter the UDP port to use for TriStation connections on NET 1 and NET 2. The default for both ports is 1502. Cannot be the same as the Management or TSAA port numbers. See UDP Base Port Number on page 854 for additional information. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Communication Modules Protocol Property Action TSAA TSAA Port Number Enter the UDP port to use for TSAA connections, including DDE Server and SOE Recorder, on NET 1 and NET 2. The default for both ports is 1500. 505 Cannot be the same as the TriStation or Management port numbers. A value of 0 indicates that TSAA communication is disabled on that port. See UDP Base Port Number on page 854 for additional information. TSAA Multicast IP Address Enter the IP address that TSAA multicasts should be sent to. The default is 0.0.0.0 (IP multicasting is disabled). Bin data and/or SOE data available messages will be sent to the specified address, so that all members of the group will receive the data. Note: To use TSAA multicasting, your network hardware (such as routers) must also support multicasting. See your Network Administrator or IT department for more information. Multicast Update Rate Enter the update rate, in milliseconds, for TSAA IP multicasting. Can be from 250 to 2,000. The default value is 1,000. Bin data and/or SOE data available messages will be sent to the multicast IP address at the specified update rate (for example, by default, bin data will be multicast every 1,000ms). 6 Click OK to save your changes. CAUTION By default, TSAA clients have write access to the NET 1 and NET 2 ports on the CIM. Depending on your configuration, this may create a security issue. To disable write access by TSAA clients, you must enable and configure the CIM access control list. See Controlling Access to the CM or CIM on page 590. TriStation 1131 Developer’s Guide, 4.14.0 506 Chapter 4 Trident and Tri-GP Controller Configuration Configuring the Trident or Tri-GP 3.x CIM OPC UA Server This procedure explains how to configure the CIM’s OPC UA server. CAUTION Changing any of the following properties, and then performing a download operation, will cause the CIM’s OPC UA server to temporarily cease communication and restart: • The CIM’s IP address (CIM Setup > Network tab) • The CIM’s subnet mask (CIM Setup > Network tab) • The network port the OPC UA server is configured to use (CIM Setup > OPC tab) • The OPC UA server’s TCP Port Number (CIM Setup > OPC tab) • The OPC UA server’s Alarms SOE Block Number (CIM Setup > OPC tab) Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CIM, and then click Setup. The CIM Setup dialog box appears. 3 Click the OPC tab. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Communication Modules 4 Select the module (slot) you want to configure the OPC UA server for. 5 Specify these properties. Section Property Action OPC Allow Unsecured Session Select this check box if you want to allow OPC UA clients to connect to the CIM OPC UA server without a certificate (an unsecured session). If this check box is not selected, OPC UA clients will be allowed to connect only with a certificate (a secured session). 507 The default is cleared (only secured sessions are allowed). Enable Communication with CIM SOE Network Click the network port that the CIM uses to communicate with OPC UA clients. The default is None (OPC UA communication is disabled). TCP Port Number Enter the TCP port to use for OPC UA connections on NET 1 or NET 2. The default for both ports is 4840. SOE Block Number Enter the SOE block number used when events are retrieved by an OPC UA client. Can be from 0 to 14. The default value is 0 (not configured). Must be unique for each CIM installed in a system. The SOE block number entered here must have a block type of EXTERNAL (see A Note About Using OPC to Collect SOE Events on page 293). Alarms SOE Block Number Enter the SOE block number used when alarm events are retrieved by an OPC UA client. Can be from 0 to 14. The default value is 0 (alarms are not configured). Must be unique for each CIM installed in a system. The SOE block number entered here must have a block type of OPC (see A Note About Using OPC to Collect SOE Events on page 293). Note: If you have alarms configured in your application (see Alarms on page 229) you must enter an SOE block number. You cannot use the default value of 0. SOE Severity Enter the severity (priority) level for SOE events (state changes obtained from the SOE block). Can be from 1 to 1,000. The default value is 500. TriStation 1131 Developer’s Guide, 4.14.0 508 Chapter 4 Trident and Tri-GP Controller Configuration Section Property Action System Events Severity Info Severity Severity levels identify the urgency of an event. Enter a number to represent the severity level for informational system events. Can be from 1 (lowest) to 1,000 (highest). Enter 0 if you do not want the CIM to send notifications of informational system events to OPC UA clients. The default value is 100. Minor Severity Enter a number to represent the severity level for minor system events. Can be from 1 (lowest) to 1,000 (highest). Enter 0 if you do not want the CIM to send notifications of minor system events to OPC UA clients. The default value is 300. Major Severity Enter a number to represent the severity level for major system events. Can be from 1 (lowest) to 1000 (highest). Enter 0 if you do not want the CIM to send notifications of major system events to OPC UA clients. The default value is 500. Fatal Severity Enter a number to represent the severity level for fatal system events. Can be from 1 (lowest) to 1000 (highest). Enter 0 if you do not want the CIM to send notifications of fatal system events to OPC UA clients. The default value is 700. Output Voter Severity Enter a number to represent the severity level for output voter events. Can be from 1 (lowest) to 1000 (highest). Enter 0 if you do not want the CIM to send notifications of output voter events to OPC UA clients. The default value is 900. 6 Disable All Click to prevent the CIM from sending system event notifications to OPC UA clients. Sets the severity levels for all system event types to 0. Reset All Click to reset all OPC UA severity levels to their default values. Click OK to save your changes. CAUTION By default, OPC UA clients have write access to the NET 1 and NET 2 ports on the CIM. Depending on your configuration, this may create a security issue. To disable write access by OPC UA clients, you must enable and configure the CIM access control list. See Controlling Access to the CM or CIM on page 590. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Communication Modules 509 Exporting the Trident or Tri-GP 3.x CIM Configuration to a File Once CIM configuration is complete, you may want to export it to an XML file. Not only does this provide a backup of your configuration settings, it also allows you to import the settings to other CIMs, saving time and effort, and ensuring that all CIMs in a system have the same configuration. Technical Support may also ask for an exported configuration file to assist in troubleshooting CIM problems. Note An exported CIM configuration file cannot be modified outside of TriStation 1131. If the XML file is changed after export, you will be unable to import it into TriStation 1131. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CIM, and then click Setup. The CIM Setup dialog box appears. Export Button 3 Click Export. If the CIM configuration has been changed, but not saved, you are asked if you want to include the unsaved changes in the exported file. 4 Navigate to the folder you want to save the exported configuration file in, enter a file name, and click Save. TriStation 1131 Developer’s Guide, 4.14.0 510 Chapter 4 Trident and Tri-GP Controller Configuration Importing the Trident or Tri-GP 3.x CIM Configuration From a File If you have already configured a Trident or Tri-GP 3.x CIM, and exported the configuration to a file, you can import the saved configuration to another CIM. Once the import is complete, you should review the CIM configuration to ensure that all settings have been correctly configured for your implementation. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CIM, and then click Setup. The CIM Setup dialog box appears. 3 Click Import. If the CIM configuration has been changed, but not yet saved, you are asked if you want to overwrite the existing configuration, including the unsaved changes, with the imported settings. 4 Navigate to the folder where the exported configuration file is located, and click Open. CIM configuration settings are imported from the selected file. 5 Click each tab of the CIM Setup dialog box to review and verify that all settings have been correctly configured. 6 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Time Synchronization 511 Configuring Trident or Tri-GP Time Synchronization This section explains how to use the Time Synchronization communication protocol with Trident or Tri-GP controllers. Time synchronization enables a network of Triconex controllers to synchronize time with each other or with external devices, such as a DCS. Topics include: • About Trident and Tri-GP Time Synchronization on page 511 • Using a Trident 1.x CM to Synchronize Time on page 512 • Using a Trident or Tri-GP 2.x/3.x CM to Synchronize Time on page 513 • Using a Trident or Tri-GP 3.x CIM to Synchronize Time on page 518 About Trident and Tri-GP Time Synchronization This table summarizes the ways Trident or Tri-GP controller time can be synchronized to an external device or to the master node in a Peer-to-Peer network. Table 45 Trident and Tri-GP Time Synchronization Module Time Synchronization Feature CM (Trident 1.x) • To an OPC client. For more information, see the Communication Guide for Trident Systems. • By writing aliased data to the TIMESET or TIMEADJ function blocks in a TriStation 1131 application. For assistance with the specialized programming that is required, contact Technical Support. • To the Trident master node in a Peer-to-Peer network. CM (Trident and Tri-GP 2.x/3.x) All of the 1.x CM capabilities, plus: • To SNTP. • To the Tricon, Trident, or Tri-GP master node in a Peer-to-Peer network (Triconex Time Synchronization). CIM (Trident and Tri-GP 3.x) All of the 2.x/3.x CM capabilities. MP By writing aliased data to the TIMESET or TIMEADJ function blocks in a TriStation 1131 application. For assistance with the specialized programming that is required, contact Technical Support. CAUTION To ensure accurate time synchronization over a Peer-to-Peer network, ensure that the master node and all receiving nodes are on the same subnet. For example, if the master node is on subnet 255.0.0.0 and a receiving node is on subnet 255.255.0.0, there can be significant time differences between the two nodes. TriStation 1131 Developer’s Guide, 4.14.0 512 Chapter 4 Trident and Tri-GP Controller Configuration Using a Trident 1.x CM to Synchronize Time This procedure explains how to use a Trident 1.x CM to synchronize Trident controllers to the master node in a Peer-to-Peer network. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CM slot, click Setup, and then click the Network tab. 3 Select one of the following: 4 • On NET 1 Enable Time Synchronization with Trident Master Node • On NET 2 Enable Time Synchronization with Trident Master Node Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Time Synchronization 513 Using a Trident or Tri-GP 2.x/3.x CM to Synchronize Time The information in this section explains how to enable time synchronization on a Trident or Tri-GP 2.x/3.x CM. Time synchronization can be enabled using the following protocols: • SNTP • Triconex Time Synchronization via DLC (NET 1 only) or UDP/IP (NET 1 or NET 2) on a Peer-to-Peer network In a redundant network of Trident or Tri-GP controllers that each have two CMs installed, you can implement redundant time synchronization by configuring time synchronization for both CM modules (both left and right slots). Time synchronization can be enabled only for a single logical slot. Note The information and procedures in this section apply only to Trident or Tri-GP 2.x/3.x CMs. If you are configuring a Trident 1.x CM, please see Using a Trident 1.x CM to Synchronize Time on page 512. If you are configuring a CIM, see Using a Trident or TriGP 3.x CIM to Synchronize Time on page 518. Topics include: • Configuring SNTP Time Synchronization on the Trident or Tri-GP 2.x/3.x CM on page 514 • Configuring Triconex Time Synchronization on the Trident or Tri-GP 2.x/3.x CM on page 516 TriStation 1131 Developer’s Guide, 4.14.0 514 Chapter 4 Trident and Tri-GP Controller Configuration Configuring SNTP Time Synchronization on the Trident or Tri-GP 2.x/3.x CM This procedure explains how to configure Trident or Tri-GP 2.x/3.x CM time synchronization to an SNTP server. If the CM is in a Peer-to-Peer network, it can also be used as the master node for time synchronization of other controllers on the network. In this configuration, the master node CM synchronizes time with the SNTP server, and any slave nodes on the Peer-to-Peer network synchronize their time with the master CM. In this way, all nodes on the Peer-to-Peer network are synchronized with SNTP time. If the CM is acting as a slave node on a Peer-to-Peer network, it cannot be configured for SNTP time synchronization. Slave nodes synchronize their time only to the master node on the Peerto-Peer network, and reject all other time change requests. Note Because the SNTP server resides on a PC, network load issues or PC performance can result in delays in processing time update requests from the controller. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CM, and then click Setup. The CM Setup dialog box appears. 3 Click the Time Sync tab. 4 Under Slot Selection, click Left Slot. You must configure the module in the left slot first. 5 Select these properties. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Time Synchronization 6 Property Action Time Synchronization Configuration Select SNTP. The default is None. SNTP Master Network Click the network the SNTP server is located on. SNTP Master IP Address Enter the IP address of the SNTP server to synchronize time with. (Optional) If you have a redundant CM installed in the right slot, under Slot Selection, click Right Slot, and then select these properties. Property Action Time Synchronization Configuration Select SNTP Redundant. SNTP Master Network Click the network the SNTP server is located on. This can be different than the master network selected for the left slot. SNTP Master IP Address Enter the IP address of the SNTP server to synchronize time with. Note 7 515 The module in the right slot can be configured only if it has been installed (see Configuring Trident or Tri-GP 2.x/3.x CM Network Ports on page 478) and if the module in the left slot has already been configured for SNTP time synchronization. Click OK to save your changes. Enabling the Trident or Tri-GP 2.x/3.x CM as a Master Node for Triconex Time Synchronization (Optional) The CM can also act as a master node for time synchronization of other controllers on a Peer-toPeer network (using Triconex Time Synchronization). Because the Enable Trident/Tri-GP Node Time Synchronization check box is always enabled, no further configuration is needed. TriStation 1131 Developer’s Guide, 4.14.0 516 Chapter 4 Trident and Tri-GP Controller Configuration Configuring Triconex Time Synchronization on the Trident or Tri-GP 2.x/3.x CM In a Peer-to-Peer network, Triconex Time Synchronization can be used to synchronize time across controllers on a network. The controller with the lowest node number serves as the master node. The master node can also synchronize its time with an SNTP server. In this configuration, the master node synchronizes time with the SNTP server, and any slave nodes on the Peer-to-Peer network synchronize their time with the master node. In this way, all nodes on the Peer-to-Peer network are synchronized with SNTP time. Configuring a Master Node This procedure describes how to configure the CM as a master node on the Peer-to-Peer network when SNTP time synchronization is not being used. If you want the master node to synchronize to a SNTP server, use the procedures in Configuring SNTP Time Synchronization on the Trident or Tri-GP 2.x/3.x CM on page 514. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CM, and then click Setup. The CM Setup dialog box appears. 3 Click the Time Sync tab. 4 Under Time Synchronization Configuration, select None. 5 Click OK to save your changes. Configuring a Slave Node This procedure describes how to configure the CM as a slave node on the Peer-to-Peer network. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CM, and then click Setup. The CM Setup dialog box appears. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Time Synchronization 517 3 Click the Time Sync tab. 4 Under Slot Selection, click Left Slot. You must configure the module in the left slot first. 5 Specify these properties. Property Action Time Synchronization Configuration Select Peer-to-Peer. The default is None. Peer-to-Peer Master Network Click the network you want to enable Triconex Time Synchronization for. The default is NET 1.This property applies to the modules installed in both the left and right slots simultaneously. Note 6 If you have a redundant CM installed in the right slot, Time Synchronization Configuration is automatically set to Peer-to-Peer and cannot be changed. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 518 Chapter 4 Trident and Tri-GP Controller Configuration Using a Trident or Tri-GP 3.x CIM to Synchronize Time The information in this section explains how to enable time synchronization on a Trident or Tri-GP 3.x CIM. Time synchronization can be enabled using the following protocols: • SNTP • Triconex Time Synchronization via UDP/IP (NET 1 or NET 2) on a Peer-to-Peer network In a redundant network of Trident or Tri-GP controllers that each have two CIMs installed, you can implement redundant time synchronization by configuring time synchronization for both CIM modules (both left and right slots). Time synchronization can be enabled only for a single logical slot. Topics include: • Configuring SNTP Time Synchronization on the Trident or Tri-GP 3.x CIM on page 518 • Configuring Triconex Time Synchronization on the Trident or Tri-GP 3.x CIM on page 520 Configuring SNTP Time Synchronization on the Trident or Tri-GP 3.x CIM This procedure explains how to configure Trident or Tri-GP 3.x CIM time synchronization to an SNTP server. If the CIM is in a Peer-to-Peer network, it can also be used as the master node for time synchronization of other controllers on the network. In this configuration, the master node CIM synchronizes time with the SNTP server, and any slave nodes on the Peer-to-Peer network synchronize their time with the master CIM. In this way, all nodes on the Peer-to-Peer network are synchronized with SNTP time. If the CIM is acting as a slave node on a Peer-to-Peer network, it cannot be configured for SNTP time synchronization. Slave nodes synchronize their time only to the master node on the Peerto-Peer network, and reject all other time change requests. Note Because the SNTP server resides on a PC, network load issues or PC performance can result in delays in processing time update requests from the controller. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CIM, and then click Setup. The CIM Setup dialog box appears. 3 Click the Time Sync tab. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Time Synchronization 519 4 Under Slot Selection, click Left Slot. You must configure the module in the left slot first. 5 Select these properties. 6 Property Action Time Synchronization Configuration Select SNTP. The default is None. SNTP Master Network Click the network the SNTP server is located on. SNTP Master IP Address Enter the IP address of the SNTP server to synchronize time with. (Optional) If you have a redundant CIM installed in the right slot, under Slot Selection, click Right Slot, and then select these properties. Property Action Time Synchronization Configuration Select SNTP Redundant. SNTP Master Network Click the network the SNTP server is located on. This can be different than the master network selected for the left slot. SNTP Master IP Address Enter the IP address of the SNTP server to synchronize time with. TriStation 1131 Developer’s Guide, 4.14.0 520 Chapter 4 Trident and Tri-GP Controller Configuration Note 7 The module in the right slot can be configured only if it has been installed (see Configuring Trident or Tri-GP 3.x CIM Network Ports on page 495) and if the module in the left slot has already been configured for SNTP time synchronization. Click OK to save your changes. Enabling the Trident or Tri-GP 3.x CIM as a Master Node for Triconex Time Synchronization (Optional) The CIM can also act as a master node for time synchronization of other controllers on a Peerto-Peer network (using Triconex Time Synchronization). Because the Enable Trident/Tri-GP Node Time Synchronization check box is always enabled, no further configuration is needed. Configuring Triconex Time Synchronization on the Trident or Tri-GP 3.x CIM In a Peer-to-Peer network, Triconex Time Synchronization can be used to synchronize time across controllers on a network. The controller with the lowest node number serves as the master node. The master node can also synchronize its time with an SNTP server. In this configuration, the master node synchronizes time with the SNTP server, and any slave nodes on the Peer-to-Peer network synchronize their time with the master node. In this way, all nodes on the Peer-to-Peer network are synchronized with SNTP time. Configuring a Master Node This procedure describes how to configure the CIM as a master node on the Peer-to-Peer network when SNTP time synchronization is not being used. If you want the master node to synchronize to a SNTP server, use the procedures in Configuring SNTP Time Synchronization on the Trident or Tri-GP 3.x CIM on page 518. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CIM, and then click Setup. The CIM Setup dialog box appears. 3 Click the Time Sync tab. 4 Under Time Synchronization Configuration, select None. 5 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Time Synchronization 521 Configuring a Slave Node This procedure describes how to configure the CIM as a slave node on the Peer-to-Peer network. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CIM, and then click Setup. The CIM Setup dialog box appears. 3 Click the Time Sync tab. 4 Under Slot Selection, click Left Slot. You must configure the module in the left slot first. 5 Specify these properties. Property Action Time Synchronization Configuration Select Peer-to-Peer. The default is None. Peer-to-Peer Master Network Click the network you want to enable Triconex Time Synchronization for. The default is NET 2.This property applies to the modules installed in both the left and right slots simultaneously. Note 6 If you have a redundant CIM installed in the right slot, Time Synchronization Configuration is automatically set to Peer-to-Peer and cannot be changed. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 522 Chapter 4 Trident and Tri-GP Controller Configuration Using Trident or Tri-GP System and Module Attributes System and module attributes are variables that can be used to monitor status, and control Trident or Tri-GP controller operations. You can add an alias number so the variable can be read or written to. Note The following MP system attributes are available for Trident/Tri-GP 3.x and later systems only: • Certificate_No_Warnings • Certificate_None_Invalid • Advanced_Security • Access_All_Tagnames • Certificate_Use_If_Expired These attributes show a value of 0 for Trident/Tri-GP 1.x and 2.x systems. Specifying an Alias Number for a Trident or Tri-GP Attribute This procedure explains how to specify an alias number for a system or module attribute, which allows you to read or write to the attribute. Procedure 1 Expand the Controller tree and double-click Configuration. 2 Expand Status Attributes and double-click the attribute to be assigned an alias. 3 Click Get Default, or enter a number for the Modbus Alias and click Confirm Alias. The alias number is assigned to the attribute. TriStation 1131 Developer’s Guide, 4.14.0 Printing the Trident or Tri-GP Module Configuration 523 Printing the Trident or Tri-GP Module Configuration Once Trident or Tri-GP controller configuration is complete, you may want to print the module configuration information. Not only does this provide a backup of your configuration settings, it also can assist Technical Support when troubleshooting configuration problems. Procedure 1 Open the Project Workspace (see The Project Workspace on page 22). 2 On the File menu, select Print All. The Print All Options dialog box appears. 3 Select the check boxes for the following documents: • Hardware Module Configuration—Prints a report listing the controller hardware (MPs, CMs, I/O modules) currently configured in the project. • Module Configuration Settings—Prints a report listing the current configuration settings for each applicable module in the project’s hardware configuration. Only modules that require configuration in TriStation 1131 are included in this report. For example, CM configuration details are included, but the AI module is not, as it does not require configuration in TriStation 1131. Note To quickly clear the check boxes for all the documents in the list, and make it easier to select only those documents you want to print, clear the Select All check box. 4 Click OK. The Print dialog box appears. 5 Select the printer you want to use, and the desired settings (number of copies, page orientation, etc), and then click OK. TriStation 1131 Developer’s Guide, 4.14.0 524 Chapter 4 Trident and Tri-GP Controller Configuration TriStation 1131 Developer’s Guide, 4.14.0 5 Tricon Communication with TriStation 1131 Overview 526 Configuring the TriStation PC 527 Connecting to the Tricon Controller via a Serial Connection 529 Connecting to the Tricon Controller via a Network Connection 533 Specifying the Tricon Default Connection Type 541 Controlling Access to the TCM or UCM 542 Configuring Tricon Controller Printing 549 Setting Tricon Controller IP Addresses 556 TriStation 1131 Developer’s Guide, 4.14.0 526 Chapter 5 Tricon Communication with TriStation 1131 Overview This figure shows the main steps for setting up TriStation 1131 communication and the typical order in the project cycle. Communication setup can be done anytime before implementation. Set Up the Project Develop the Application Test with the Emulator Fix Errors Errors? C onfigure the C ontroller - Establish the physical connection Set Up TriStation C ommunication - C onfigure the connection to the TriStation PC - Set node and IP address of the controller Implement on the C ontroller TriStation 1131 Communication Steps This checklist includes the items that can be or should be performed to set up communication between a TriStation PC and a Tricon controller. Description See Connect to a Tricon EICM Connecting to the Tricon Controller via a Serial Connection on page 529 Connect to a Tricon ACM, NCM, TCM, or UCM • Connecting to the Tricon Controller via a Network Connection on page 533, or • Connecting to the Tricon Controller via a Serial Connection on page 529 Configure user access to the Tricon TCM or UCM Controlling Access to the TCM or UCM on page 542 Set up printing Configuring Tricon Controller Printing on page 549 TriStation 1131 Developer’s Guide, 4.14.0 Configuring the TriStation PC 527 Configuring the TriStation PC This section explains the setup required for a network connection from the TriStation PC. Topics include: • Installing a NIC Card in a TriStation PC on page 527 • Installing the TCP/IP Protocol on a TriStation PC on page 528 Note If you will only be connecting to the Tricon controller via a serial connection, you can skip this section. Please note, however, that the preferred method of connecting the TriStation PC to the Tricon controller is via a network connection. Installing a NIC Card in a TriStation PC This procedure explains how to install a network interface card (NIC) in a TriStation PC to be connected to a Tricon ACM, NCM, TCM, or UCM. Procedure – Tricon TCM 1 Install the network interface card by following the manufacturer’s instructions. Do not change the factory default settings on the NIC card. 2 Do one of the following: • If the network interface card has an RJ-45 connector, you can connect it to the NET 1 or NET 2 port on the TCM (model 4351/4351A/4351B/4353) via a router or hub using a patch cable. • If the network interface card has a MTRJ (fiber) connector, you can connect it to the NET 1 or NET 2 port on the TCM (model 4352/4352A/4352B/4354) via a router or hub using a patch cable. • If the network interface card does not have the appropriate connector for your TCM model, connect the network interface card to a media converter that is connected to the NET 1 or NET 2 port. Note 3 See the Communication Guide for Tricon v9–v11 Systems for more information about the differences between the TCM model 4351/4351A/4351B/4353 (copper) and model 4352/4352A/4352B/4354 (fiber). Run the diagnostics provided with the network interface card according to the manufacturer’s instructions. TriStation 1131 Developer’s Guide, 4.14.0 528 Chapter 5 Tricon Communication with TriStation 1131 Procedure – Tricon UCM 1 Install the network interface card by following the manufacturer’s instructions. Do not change the factory default settings on the NIC card. 2 Do one of the following: 3 • If the network interface card has a MTRJ (fiber) connector, you can connect it to the NET 1 or NET 2 port on the UCM via a router or hub using a patch cable. • If the network interface card does not have the appropriate connector for your UCM, connect the network interface card to a media converter that is connected to the NET 1 or NET 2 port. Run the diagnostics provided with the network interface card according to the manufacturer’s instructions. Procedure – Tricon ACM or NCM 1 Install the network interface card by following the manufacturer’s instructions. Do not change the factory default settings on the NIC card. 2 Do one of the following: 3 • If the network interface card has a BNC connector, connect it directly to the NET 2 port. • If the network interface card does not have a BNC connector, connect the network interface card to a media converter that is connected to the NET 2 port. Run the diagnostics provided with the network interface card according to the manufacturer’s instructions. Installing the TCP/IP Protocol on a TriStation PC This procedure explains how to install the TCP/IP protocol on a TriStation PC. The TCP/IP protocol is required for Tricon ACM, NCM, TCM, and UCM connection. Procedure 1 On the Start menu, click Control Panel, open Network and Internet, and then click Network and Sharing Center. 2 In the Network and Sharing Center, click Manage Network Connections. 3 Right-click the network connection you want to change, and then click Properties. 4 If prompted, enter the administrator’s password or confirm the operation. 5 On the Networking tab, under This connection uses the following items, click Internet Protocol Version 4 (TCP/IPv4), and then click OK. Note Internet Protocol Version 4 (TCP/IPv4) must be installed to allow a TriStation 1131 application to connect to a Tricon controller. Do not install Internet Protocol Version 6 (TCP/IPv6). TriStation 1131 Developer’s Guide, 4.14.0 Connecting to the Tricon Controller via a Serial Connection 529 Connecting to the Tricon Controller via a Serial Connection This section explains how to make a direct (point-to-point) serial connection between a Tricon EICM, TCM, or UCM and a TriStation PC. You can use only one of these communication modules in the same Tricon system. Additionally, the TCM can be used only with a Tricon 10.x controller, and the UCM can be used only with a Tricon 11.x controller using the model 8120E Enhanced Performance Main Chassis1. By default, the EICM and TCM use port 4 for the TriStation connection and the UCM uses port 2. Invensys strongly recommends you use the default setting. If port 4 on the EICM fails, port 1, 2, or 3 can be used by changing settings on the module switch block. If port 4 on the TCM fails, or port 2 on the UCM fails, you can connect to TriStation 1131 using the NET 1 or NET 2 port; see the Communication Guide for Tricon v9–v11 Systems for more information. A maximum of three connections (from a single PC, or from multiple PCs) can be made to a Tricon controller at any one time. For more information, see Using Multiple Instances of TriStation 1131 on page 12. Topics include: 1. • When to Use the Tricon Serial Connection on page 530 • Connecting a Tricon Serial Port to a TriStation PC on page 531 • Configuring the TriStation 1131 Serial Connection on page 532 UCMs can be installed only in Tricon 11.x systems that use the model 8120E Tricon Enhanced Performance chassis and model 3009 Main Processor. UCMs cannot be installed in Tricon system versions earlier than 11.x. For more detailed compatibility information, please see the Product Release Notice for your Tricon system version. TriStation 1131 Developer’s Guide, 4.14.0 530 Chapter 5 Tricon Communication with TriStation 1131 When to Use the Tricon Serial Connection The preferred means for connecting the TriStation PC to the Tricon controller is via a network connection. Invensys recommends connecting the TriStation PC to the EICM, TCM, or UCM via a serial connection only in the following scenarios. Connecting to the Tricon Controller for the First Time The first time you connect to the Tricon controller, Invensys recommends making a serial connection to the EICM, TCM, or UCM, because it is less complex to configure and thus easier to successfully connect to the communication module through the serial port. Once you have successfully connected to the EICM, TCM, or UCM and downloaded the initial configuration to the Tricon controller via the serial connection, you can go back and configure the more complex network connection, without worrying about losing the ability to communicate with the controller altogether. Connecting to the Tricon Controller When the Network Is Down When network communication has been interrupted due to hardware or other problems with the network, the serial connection can be used as a backup means of communicating with the Tricon controller. Once the network problems have been resolved, you should restore the network connection to the Tricon controller. Connecting to the Tricon Controller When the Access Control List Has Been Misconfigured (Tricon 10.x and Later Only) If you misconfigure the Access Control List, you could accidentally lock yourself out of a network connection to the Tricon controller. Once you enable the TCM or UCM client access control by selecting the Enable Access List check box, you must configure at least one client with TriStation Read/Write access before you save the configuration. If this is not done, you will be unable to connect to the Tricon controller again after your next download, preventing you from making further changes to the application running on the controller, including changes to the TCM or UCM access control list. If this happens, you can use the serial connection to connect to the Tricon controller and download changes to the access control list. See Controlling Access to the TCM or UCM on page 542 for more information. TriStation 1131 Developer’s Guide, 4.14.0 Connecting to the Tricon Controller via a Serial Connection 531 Connecting a Tricon Serial Port to a TriStation PC This procedure explains how to connect a Tricon EICM, TCM, or UCM serial port to a TriStation PC. Invensys provides a serial cable that has a 9-pin connector on each end. If the COM port on the PC has a 25-pin connector, you can use a Triconex 25-pin to 9-pin adapter. If you need other parts, you can purchase them from another manufacturer. For more information, see the Communication Guide for Tricon v9–v11 Systems. Procedure 1 Connect one end of the serial cable to a serial port on the EICM/TCM/UCM. This is typically port 4 for the EICM and the TCM, and port 2 for the UCM. 2 Connect the other end of the serial cable to a COM port on the TriStation PC. The COM port is typically numbered COM1, COM2, COM3, or COM4. Figure 27 Connecting a Tricon Serial Port to the TriStation PC TriStation 1131 Developer’s Guide, 4.14.0 532 Chapter 5 Tricon Communication with TriStation 1131 Configuring the TriStation 1131 Serial Connection This procedure explains how to configure the serial connection from the TriStation PC to the Tricon EICM, TCM, or UCM. Procedure 1 Expand the Controller tree, doubleclick Configuration, and then click TriStation Communication. 2 Specify these properties on the TriStation Communication screen. Property Action Serial Connection Select this check box. Node Name Enter the name of the Tricon controller. You can use a default name, or enter your own user-defined name. The default names are TRINODE01 through TRINODE31. TriStation Port Number Enter the UDP port to use for the TriStation connection. The default is 1502. Should be the same number specified on the TCM or UCM Setup Network tab. Serial Port Select the COM port on the TriStation PC to which the serial cable is connected. Baud Rate Specify the data transmission speed. The default is 9600. Available only when a TCM or UCM is installed. Note 3 The data displayed on this screen is used by TriStation 1131 only to connect to a Tricon communication port. The data that you enter will not be downloaded to the Tricon controller. To complete the connection, you must configure a Tricon EICM, TCM, or UCM. See Configuring Tricon Communication Modules on page 372. TriStation 1131 Developer’s Guide, 4.14.0 Connecting to the Tricon Controller via a Network Connection 533 Connecting to the Tricon Controller via a Network Connection This section explains how to make a network connection between an ACM, NCM, TCM, or UCM communication module and a TriStation PC. This can be a direct connection from the communication module to the PC; or a connection through a router, hub, or media converter. A router or hub is not required if you do not need to connect any additional devices besides the communication module and the PC. You cannot use both an NCM and TCM (or NCM and UCM) in the same Tricon system. However, you can use a TCM and UCM in the same Tricon system. For more information on the types of modules supported by different Tricon system versions, see the Planning and Installation Guide for Tricon v9-v11 Systems. To set up the connection, you must: • Install a network interface card and the TCP/IP protocol on the PC. • Set the node number of the controller. • Connect the TriStation PC to a network port on the communication module. • Configure the connection in the TriStation 1131 project. CAUTION The node setting (on the ACM or NCM or the 3008 MP Front Panel) must match the node number specified in the TriStation 1131 project. For instructions on changing the MP node setting, see the Planning and Installation Guide for Tricon v9-v11 Systems. For instructions on installing a network interface card and the TCP/IP protocol on the TriStation PC, see Configuring the TriStation PC on page 527. A maximum of three connections (from a single PC, or from multiple PCs) can be made to a Tricon controller at any one time. For more information, see Using Multiple Instances of TriStation 1131 on page 12. Topics include: • Directly Connecting an ACM or NCM Network Port to a TriStation PC on page 534 • Connecting a TCM Network Port to a TriStation PC Using a Router or Hub on page 535 • Connecting a UCM Network Port to a TriStation PC Using a Router or Hub on page 536 • Connecting a Tricon Network Port Using a Media Converter on page 537 • Configuring the TriStation 1131 Network Connection on page 539 Note If you are connecting the TCM, UCM, or EICM to the TriStation PC via a serial port, see Connecting to the Tricon Controller via a Serial Connection on page 529. TriStation 1131 Developer’s Guide, 4.14.0 534 Chapter 5 Tricon Communication with TriStation 1131 Directly Connecting an ACM or NCM Network Port to a TriStation PC This procedure explains how to directly connect an ACM or NCM to a TriStation PC if the network interface card in the PC has a BNC connector. The connection requires a 10Base-2 coaxial cable. Invensys provides an accessory kit that includes a 10Base-2 coaxial cable, BNC T-connectors, and 50-ohm terminators for unused connectors (see the Communication Guide for Tricon v9-v11 Systems for more information). Procedure 1 To each end of a 10Base-2 cable, attach a BNC T-connector and a terminator. 2 Attach one of the T-connectors to a BNC connector on NET 2 of the communication module. An NCM is used as an example in the following figure. 3 Attach the other T-connector to the BNC connector on the network interface card in the TriStation PC. Tricon Controller Network Adapter Card with BNCConnector M MM P PP A BC N C M 1 BNCConnector on NET2 10Base-2 Coaxial(ThinNet)Cable TriStation PC Figure 28 4 Directly Connecting an ACM or NCM to a TriStation PC Terminate the BNC connectors on all communication modules that are installed in the Tricon controller. To terminate an unused BNC connector, you can attach a T-connector with 50-ohm terminators on each end to produce a 25-ohm parallel resistance. Ask your network administrator for information about other termination methods. TriStation 1131 Developer’s Guide, 4.14.0 Connecting to the Tricon Controller via a Network Connection 535 Connecting a TCM Network Port to a TriStation PC Using a Router or Hub This procedure explains how to connect a TCM to a TriStation PC if the network interface card in the PC has an RJ-45 connector or a MTRJ fiber connector. You must use an Ethernet router or hub between the Tricon and the TriStation PC. The RJ-45 connection requires twisted-pair straight-through cables. The fiber connection requires 62.5/125 um multimode fiber cables. See the Communication Guide for Tricon v9–v11 Systems for more information about the required cables and how some may be purchased from Invensys. Procedure 1 Attach one end of the first cable to the NET 2 port on the TCM. 2 Attach the other end of the first cable to the connector on the Ethernet router or hub. 3 Attach one end of the second cable to the connector on the network interface card in the TriStation PC. 4 Attach the other end of the second cable to the connector on the router or hub. To Ethernet Network Tricon Controller Network Adapter Card with RJ-45 orMTRJ Connector RJ-45 orMTRJ Connector on NET2 M MM P PP A BC 62.5/125 um Multimode Fiber Cable or 10Base-T / 100Base-T Twisted-Pair Cable T C M RJ-45 orMTRJ Connector Figure 29 62.5/125 um Multimode Fiber Cable or 10Base-T / 100Base-T Twisted-Pair Cable Ethernet Router or Hub RJ-45 orMTRJ Connector TriStation PC Connecting a TCM (Copper or Fiber) to a TriStation PC Using a Router or Hub If the correct cable is connected to the TCM and the TCM is installed in a powered Tricon chassis, the green LED indicator turns on. If the LED indicator is not on, there is a problem with the physical cable connection. TriStation 1131 Developer’s Guide, 4.14.0 536 Chapter 5 Tricon Communication with TriStation 1131 Connecting a UCM Network Port to a TriStation PC Using a Router or Hub This procedure explains how to connect a UCM to a TriStation PC if the network interface card in the PC has a MTRJ fiber connector. You must use an Ethernet router or hub between the Tricon controller and the TriStation PC. The fiber connection requires 62.5/125 um multimode fiber cables. See the Communication Guide for Tricon v9–v11 Systems for more information about the required cables and how some may be purchased from Invensys. Procedure 1 Attach one end of the first cable to the NET 2 port on the UCM. 2 Attach the other end of the first cable to the connector on the Ethernet router or hub. 3 Attach one end of the second cable to the connector on the network interface card in the TriStation PC. 4 Attach the other end of the second cable to the connector on the router or hub. To Ethernet Network Tricon Controller Network Adapter Card with MTRJ Connector 62.5/125 um Multimode Fiber Cable 62.5/125 um Multimode Fiber Cable MTRJ Connector MTRJ Connector MTRJ Connector on NET2 Ethernet Router or Hub TriStation PC Figure 30 Connecting a UCM to a TriStation PC Using a Router or Hub If the correct cable is connected to the UCM and the UCM is installed in a powered Tricon chassis, the green LED indicator turns on. If the LED indicator is not on, there is a problem with the physical cable connection. TriStation 1131 Developer’s Guide, 4.14.0 Connecting to the Tricon Controller via a Network Connection 537 Connecting a Tricon Network Port Using a Media Converter This procedure explains how to connect an ACM, NCM, TCM, or UCM to a TriStation PC if the network interface card in the PC requires a media converter because it does not have the appropriate connector. • The connection to an ACM or NCM requires a 10Base-2 cable, a media converter, and another appropriate cable, such as a twisted-pair cable. • The connection to a TCM (model 4352/4352A/4352B/4354 - Fiber) or UCM (model 4610) requires a 62.5/125 um multimode fiber cable, a media converter, and another appropriate cable, such as a twisted-pair cable. Procedure for Connecting an ACM or NCM 1 To each end of a 10Base-2 cable, attach a BNC T-connector and a terminator. 2 Attach one of the T-connectors to a BNC connector on the NET 2 port on the communication module. 3 Attach the other T-connector to a BNC connector on the media converter. For the TriStation PC, you can use a 10Base-T or 100Base-TX twisted-pair cable for faster communication. 4 Attach one end of the twisted-pair cable to an RJ-45 connector on the network interface card in the TriStation PC. 5 Attach the other end of the twisted-pair cable to an RJ-45 connector on the media converter. To Ethernet Network Tricon Controller Network Adapter Card with RJ-45Connector BNCConnector on NET 2 M MM P PP A BC 10Base-2 Coaxial(ThinNet)Cable 10Base-T or 100Base-T Twisted-Pair Cable T C M BNC Connector Media orProtocol Converter RJ-45 Connector TriStation PC Figure 31 Connecting an ACM or NCM to the TriStation PC Using a Media Converter TriStation 1131 Developer’s Guide, 4.14.0 538 Chapter 5 Tricon Communication with TriStation 1131 Procedure for Connecting a TCM (Model 4352/4352A/4352B/4354 - Fiber) 1 Attach one end of the fiber cable to the NET 1 or NET 2 port on the TCM or UCM. 2 Connect one end of the twisted-pair cable to the RJ-45 connector on the network interface card in the TriStation PC. 3 Attach the other end of the twisted-pair cable to an RJ-45 connector on the media converter. 4 Attach the other end of the fiber cable to a MTRJ fiber connector on the media converter. To Ethernet Network Tricon Controller Network Adapter Card with RJ-45Connector MTRJ Connector on NET2 M MM P PP A BC 10Base-T or 100Base-T Twisted-Pair Cable 62.5/125 umMultimode FiberCable T C M MTRJ Connector Media orProtocol Converter RJ-45 Connector TriStation PC Figure 32 Connecting a TCM (Model 4352/4352A/4352B/4354) to the TriStation PC Using a Media Converter If the correct cable is connected to the TCM or UCM and it is installed in a powered Tricon chassis, the green LED indicator turns on. If the LED indicator is not on, there is a problem with the physical cable connection. TriStation 1131 Developer’s Guide, 4.14.0 Connecting to the Tricon Controller via a Network Connection 539 Configuring the TriStation 1131 Network Connection This procedure explains how to configure the Tricon network connection to a TriStation PC. Before beginning this procedure, you must determine which IP address to use for the communication module. Typically, you can get an IP address from your network administrator or Information Technology department. See Setting Tricon Controller IP Addresses on page 556. Procedure 1 In TriStation 1131, expand the Controller tree, and double-click Configuration. 2 On the Configuration tree, click TriStation Communication. 3 Specify these properties on the TriStation Communication screen. Property Action Network Connection Select the Network Connection check box. Node Number • For ACM and NCM, enter the number represented on the rotary switches. • For TCM or UCM, enter the number represented by the Network Node Address setting on the MP front panel. Note For Tricon 11.1.x and later TCMs, enter a number from 1 to 254. For Tricon 11.0.x and earlier TCMs, and Tricon 11.0.x and later UCMs, enter a number from 1 to 31. The node number can be changed only if the project is in the Download All state. Node Name Enter a name containing eight or fewer characters to identify the Tricon controller. IP Address Enter the physical address of the controller on the network. UDP Base Port Number Enter the UDP port to use for the TriStation 1131 connection. The default is 1502. Should be the same number specified on the TCM or UCM Setup Network tab. Available only when a TCM or UCM is installed. TriStation 1131 Developer’s Guide, 4.14.0 540 Chapter 5 Tricon Communication with TriStation 1131 Note 4 The data displayed on this screen is used by TriStation 1131 only to connect to a Tricon communication port. The data that you enter will not be downloaded to the Tricon controller. To complete the connection, you must configure a Tricon ACM, NCM, TCM, or UCM. See Configuring Tricon Communication Modules on page 372. TriStation 1131 Developer’s Guide, 4.14.0 Specifying the Tricon Default Connection Type 541 Specifying the Tricon Default Connection Type This procedure explains how to specify the default connection setting in the Connect To dialog box, which appears when you establish communication between a TriStation PC and the Tricon controller. The connection setting—Network or Serial Connection—is an initial setting and can be changed when you use the Connect Command. Procedure 1 Expand the Configuration tree, double-click Configuration, and then click TriStation Communication. 2 Verify that the Network Connection Setup (for a network connection) or TriStation PC (for a serial connection) properties are correctly configured. See the following for additional information: 3 • Configuring the TriStation 1131 Serial Connection on page 532 • Configuring the TriStation 1131 Network Connection on page 539 Under Default Connection, select one of the following: • Network Connection • Serial Connection The next time you establish communication between the TriStation PC and the Tricon controller, the default connection setting you selected will be used. Note If only one connection type is selected under Selected Connections, the default connection is automatically set based on it, and cannot be changed. TriStation 1131 Developer’s Guide, 4.14.0 542 Chapter 5 Tricon Communication with TriStation 1131 Controlling Access to the TCM or UCM The TCM and UCM give you the ability to control who can access TCM and UCM resources through the module’s network ports, and each user’s level of access. Note Access control is supported on all TCM models except 4351 and 4352. Topics include: • What Are Resources? on page 542 • How Is Access Controlled? on page 543 • What Are Access Levels? on page 543 • Configuring the Access Control List on page 546 What Are Resources? A resource is any service or information provided by the TCM or UCM through the supported communications protocols. Examples of these resources include: • Access to the controller via TriStation 1131 (ability to perform a Download Changes or Download All). • Access to Tricon controller diagnostic information via the Enhanced Diagnostic Monitor. • Access to Tricon tagnames and system variables via OPC Data Access (DA). The OPC protocol is supported only by TCM models 4353 and 4354. • Access to OPC Alarms and Events (A&E) data (TCM models 4353 and 4354 only). Write access to OPC A&E is not currently supported; only read access is provided, to allow the retrieval of events. • Access to information provided in applications such as SOE Recorder or DDE Server that use the TSAA protocol. • Access to any other applications that use the TSAA protocol. CAUTION By default, TSAA clients using a TCM interface (in Tricon 10.3 and later systems) and TSAA clients using a UCM interface (in Tricon 11.x and later systems) have write access to the NET 1 and NET 2 ports. Depending on your configuration, this may create a security issue. Please note that this default behavior is opposite of that on TCMs in Tricon 10.2 and earlier systems. To disable write access by TSAA clients, you must enable and configure the TCM/UCM access control list. TriStation 1131 Developer’s Guide, 4.14.0 Controlling Access to the TCM or UCM 543 How Is Access Controlled? Access is controlled via client IP addresses. You can control access for a single IP address (one client), or for a group of IP addresses (a group of clients). If you want to group clients into a single access list entry, they must be physically separated in a sub-network, and a network address mask must be used to group them in the access list. A network address mask of 255.255.255.255 restricts an access list entry so that it applies only to the specific IP address identified in the entry. A network address mask of 255.255.255.0 applies an access list entry to any client on the same subnet as the IP address identified in the entry. Other network address masks may also be used, depending on your network structure. For example, if you want two clients with IP addresses of 192.168.1.134 and 192.168.1.65 to share the same access permissions, and there are no other clients on the same subnet, you can group them in the access list by setting the IP address for a single entry as 192.168.1.x and the network address mask to 255.255.255.0. For each IP address or group of IP addresses, you can set the access level as well as the protocols and network ports that the client can use to access the TCM and UCM. What Are Access Levels? There are three levels of access: • Deny Access: Prevents all access to resources provided by the TCM or UCM. Connections to the Tricon controller are not allowed. • Read Only: Allows the client to connect to the Tricon controller and view information provided via the TCM or UCM. Does not allow the client to change any settings or perform certain commands. For TCM/OPC, allows an OPC DA client to read tagnames, and allows an OPC A&E client to retrieve events. • Read/Write: Full access. Allows the client to view information provided by the TCM or UCM, change settings, and perform all commands (including Download Changes or Download All for TriStation 1131). For TCM/OPC, allows an OPC DA client to write to tagnames. This access level should only be provided to trusted clients. Access levels are configured by adding entries to the access control list. A maximum of 10 entries can be provided in the access control list. The same access level is applied to all selected protocols in a single access control list entry. If you want to provide different access levels for a selected client depending on which protocol they are using, you will need to create two separate entries in the access control list, one for each protocol. Access levels apply to all users using the PC assigned the IP address entered in the access control list. This means if multiple users are using the same PC, they will all have the same access rights. For example, every user using TriStation 1131 on a PC with a particular IP address would have the same access rights to the TCM or UCM. Individual user access should be controlled via workstation security; the TCM or UCM access is controlled only at the IP address level. TriStation 1131 Developer’s Guide, 4.14.0 544 Chapter 5 Tricon Communication with TriStation 1131 CAUTION Once you enable the TCM or UCM client access control by selecting the Enable Access List check box, you must configure at least one client with TriStation Read/Write access before you can save the configuration. This ensures you will be able to connect to the Tricon controller again after your next download, and allows you to make further changes to the application running on the controller, including changes to the TCM or UCM access control list. If necessary, you can also connect via a TriStation 1131 serial connection to reconfigure the access control list. See Connecting to the Tricon Controller via a Serial Connection on page 529. Note If you are using the TSAA and/or TriStation protocols, you must enable and use access list control to manage read/write access to specific ports. If you are using the serial and/or Modbus TCP protocols, you can also use the Port Write Enabled property to manage read/write access to specific ports. See Port Write Enabled on page 786. Sample Access Control List and Resulting Access Control The following table is a sample access control list, with the access control scenarios that would result if enabled on a model 4353 or 4354 TCM. TriStation 1131 Developer’s Guide, 4.14.0 Table 46 Sample TCM (Model 4353/4354) Access Control List IP Address Subnet Mask Protocol Network Access Level Resulting Access Control Scenario 1 206.216.1.12 255.255.255.0 TriStation NET 2 Read/Write A client with an IP address of 206.216.1.12 (or any client on the same subnet) attempting to access the TCM using the TriStation protocol on NET 2 would be granted Read/Write access. 2 206.216.1.12 255.255.255.0 TSAA NET 1 Read Only A client with an IP address of 206.216.1.12 (or any client on the same subnet) attempting to access the TCM using the TSAA protocol on NET 1 would be granted Read Only access. 3 192.168.1.05 255.255.255.255 TriStation and OPC NET 1 NET 2 Deny Access A client with an IP address of 192.168.1.05 attempting to access the TCM using the TriStation protocol on NET 1 or NET 2, or OPC on NET 2, would be denied access.a 4 192.168.1.09 255.255.255.255 TSAA NET 1 NET 2 Deny Access A client with an IP address of 192.168.1.09 attempting to access the TCM using TSAA on NET 1 or NET 2 would be denied access.b 5 192.168.1.05 255.255.255.0 OPC and TriStation NET 2 Read Only A client with an IP address of 192.168.1.05 (or any client on the same subnet) attempting to access the TCM using OPC or TriStation 1131 on NET 2 would be granted Read Only access. 6 192.168.1.05 255.255.255.0 TriStation NET 2 Read Only A client with an IP address of 192.168.1.05 (or any client on the same subnet) attempting to access the TCM using the TriStation protocol on NET 2 would be granted Read Only access.c 7 192.168.1.09 255.255.255.0 OPC NET 2 Read/Write A client with an IP address of 192.168.1.09 (or any client on the same subnet) attempting to access the TCM using OPC on NET 2 would be granted Read/Write access. 8 0.0.0.0 0.0.0.0 All All Deny Access Access is denied for all IP addresses not included in entries 1–7, using any protocol on NET 1 or NET 2. 9 NULL NULL NULL NULL NULL None a. OPC is supported only on NET 2. As a result, a client attempting to access the TCM using OPC on NET 1 will always be denied. An access control list entry configured with only OPC and NET 1 is an invalid combination that will not have any effect on client access to the TCM via OPC. b. On the model 4353 and 4354 TCM, TSAA is supported only on NET 1. As a result, a client attempting to access the TCM using TSAA on NET 2 will always be denied. An access control list entry configured with only TSAA and NET 2 is an invalid combination that will not have any effect on client access to the TCM via TSAA. c. If a client with the specific IP address of 192.168.1.05 attempts to access the TCM using the TriStation protocol on NET 2, the TCM will deny access. This is because the TCM evaluates the access control list beginning from the top, and continuing through the list until it encounters an entry that applies to the IP address requesting access. In this case, entry 3 specifically denies access to a client with the IP address of 192.168.1.05, so the TCM will deny access and not evaluate the list any further. Controlling Access to the TCM or UCM 545 TriStation 1131 Developer’s Guide, 4.14.0 Entry 546 Chapter 5 Tricon Communication with TriStation 1131 Configuring the Access Control List This section describes how to enable access control on the TCM or UCM and configure the access control list for your selected clients. This does not apply to model 4351 or 4352 TCMs. When configuring the access control list, take care to organize your entries so that the most specific are at the top, and the least specific are at the bottom. The last entry in the list should be used to define the access level for unspecified clients. The TCM or UCM evaluates the access control list from top (Entry 1) to bottom (Entry 10). The first match that the TCM/UCM makes (between the client’s network parameters and those listed in an access control list entry) determines which entry is used to authorize or deny access. If no match is found, the TCM/UCM automatically denies all access. Once you have enabled access control and configured the access control list, you must perform a Download Changes for the access control to take effect. Note After a Download Changes or Download All has been performed so that access control on the TCM/UCM is enabled, all existing connections will remain connected, even if the client’s access has been changed to Read Only or Deny Access. The new access levels will not take effect until the client disconnects and attempts to reconnect. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the TCM/UCM is installed and then click Setup. The TCM/UCM Setup dialog box appears. 3 Click the Access List tab. TriStation 1131 Developer’s Guide, 4.14.0 Controlling Access to the TCM or UCM 4 547 Specify these properties. Property Action Slot Selection Select the slot where the TCM/UCM you want to configure an access control list for is installed. In most cases, you should create identical access control lists for the modules in both slots. Enable Access List Command Click to enable access control for this TCM/UCM. If cleared, access control will be disabled and all users can access TCM/UCM resources. The default is cleared. Client Access List Click on the entry for the client you want to configure or change. Client IP Address Specify the IP address of the client that you want to allow, restrict, or deny access to the TCM/UCM. Can be used in conjunction with the Client IP Subnet Mask property to create groups of IP addresses with the same access levels. Client IP Subnet Mask This property allows you to group IP addresses, so that you can create a single entry in the access control list for all IP addresses on the subnet. If needed, enter the IP address for the subnet. The default is 255.255.255.0, which selects all client IP addresses on the subnet. To select only one client IP address, set the IP address of the subnet to 255.255.255.255. Permission Click the level of access to the TCM/UCM you want to provide for the selected client. If the application includes safety-critical outputs, you should not set this property to Read/Write. Protocol Select the protocol(s) that the selected client can use to access the TCM/UCM. The OPC protocol is supported on NET 2 only, and applies only for model 4353 or 4354 TCMs. Network Select the network(s) on which the selected client can access the TCM/UCM. 5 Click Update Client Entry to save the settings for the selected client. 6 Repeat steps 4 and 5 for each client to be included in the access control list. Note If necessary, click Reset Client Entry to reset the settings for the selected client to the default, unconfigured state. Click Reset All to reset all entries in the access list to the default, unconfigured state. TriStation 1131 Developer’s Guide, 4.14.0 548 Chapter 5 Tricon Communication with TriStation 1131 7 8 If a TCM or UCM is installed in the right slot, do either of the following: • In most cases, you should configure identical access control lists for the modules in both slots. To do so, click Copy Current Setup to Other Slot. • To configure different access control lists for the modules in the right and left slots, repeat steps 4 through 6 for the module installed in the right slot. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Controller Printing 549 Configuring Tricon Controller Printing A Tricon controller can print brief ASCII text messages if a communication port is connected to a printer and the TriStation 1131 application includes standard print function blocks. Print messages are typically used for alarms, status, and maintenance. A sample alarm message might include the name of an analog input point, its time stamp and value, and a statement that the value is out of range. If the Tricon system includes numerous controllers or is connected to a DCS, alarms are typically displayed on an operator workstation. To print from a Tricon controller with an EICM, you must connect an EICM parallel port to a Centronics-compatible printer, configure the port in the TriStation 1131 project, and use print function blocks in the TriStation 1131 application. To print from a Tricon controller with a TCM/UCM, you must connect a TCM/UCM Ethernet port to a print server that is connected to a printer, configure these devices in the TriStation 1131 project, and use print function blocks in the TriStation 1131 application. Topics include: • Effect of Printing on Scan Time on page 549 • Connecting a Tricon EICM Port to a Printer on page 550 • Configuring a Tricon EICM Port for Printing on page 551 • Connecting a TCM or UCM to Printing Devices on page 552 • Connecting a TCM or UCM to Printing Devices Using a Hub on page 553 • Configuring a Tricon TCM or UCM Port for Printing on page 554 • About Function Blocks for Printing on page 555 See the Communication Guide for Tricon v9–v11 Systems for more information about the types of devices that can be used for printing from the Tricon controller. Effect of Printing on Scan Time Each time a message is printed, the print function blocks in the TriStation 1131 application are executed and the scan time increases. Typically, the print function blocks are subject to conditional execution, which means they are not executed every scan. When you set the scan time in TriStation 1131, make sure it includes the execution time for all conditional statements in the application. If the scan time is not long enough, the execution of all conditional statements (when the conditions are True) could result in scan-time overruns. You can minimize this problem by limiting the amount of printer output. An alternative is to use a PC event logger such as the Triconex SOE Recorder. For more information, see the SOE Recorder User’s Guide. TriStation 1131 Developer’s Guide, 4.14.0 550 Chapter 5 Tricon Communication with TriStation 1131 Connecting a Tricon EICM Port to a Printer This procedure explains how to set up a Centronics-compatible printer and connect it directly to a Tricon EICM parallel port. You can use a standard PC printer cable with a maximum cable length of 5 to 6 meters (15 to 20 feet), depending on the quality of the cable Procedure 1 If the printer package has an installation program, copy the program to the TriStation PC. 2 Follow the instructions, and run the diagnostic routine, if available. You do not need the printer driver that may have come with the package. 3 Connect one end of the cable to the printer, and connect the other end to port 5 or 10 on the EICM. (Other EICM ports cannot be used for printing.) 4 Go to the next section to configure the EICM port for printing. Figure 33 Connecting an EICM to a Centronics-Compatible Printer TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Controller Printing 551 Configuring a Tricon EICM Port for Printing This procedure explains how to configure a Tricon EICM port that is connected to a Centronicscompatible printer. Procedure 1 In TriStation 1131, open your project, expand the Controller tree, and double-click Configuration. 2 On the Configuration tree under Hardware Allocation, double-click EICM, and then click Setup. 3 Specify these properties on the EICM Setup screen. 4 Property Action Port Selection Select Port 5 or Port 10. Other ports cannot be used for printing. Protocol Select Printer from the Protocol list. Rows Enter the number of lines (rows) to be displayed on a page. Columns Enter the number of characters per line. Click OK. TriStation 1131 Developer’s Guide, 4.14.0 552 Chapter 5 Tricon Communication with TriStation 1131 Connecting a TCM or UCM to Printing Devices This procedure explains how to directly connect a TCM or UCM to an HP JetDirect-compatible print server and printer. You can use standard communication cables for these connections. Procedure 1 If the print server and printer packages have installation programs, install them on the TriStation PC. 2 Follow the instructions, and run the diagnostic routines if available. You do not need the printer drivers that came with the packages. 3 Record the IP address of the print server. You will need the IP address when configuring the TCM or UCM printer. Connect the printer to the print server, and connect the print server to a TCM or UCM Ethernet port (NET 1 or NET 22). Figure 34 Connecting a Tricon TCM or UCM to a Printer and Print Server 2. TCM models 4351/4351A/4351B, 4352/4352A/4352B, and UCM only. NET 2 is reserved for OPC communication on model 4353 and 4354 TCMs. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Controller Printing 553 Connecting a TCM or UCM to Printing Devices Using a Hub This procedure explains how to connect a TCM or UCM to an HP JetDirect-compatible print server and printer by using a hub. You can use standard communication cables for these connections. You do not need to install the printer drivers that may have come with the print server and printer packages. Procedure 1 If the print server and printer packages have installation programs, install them on the TriStation PC. 2 Follow the instructions that came with the packages, and run the diagnostic routines, if available. 3 Record the IP address of the print server. You will need the IP address when configuring the TCM or UCM printer. 4 Connect the printer to the print server, and connect the print server to a hub. Connect the hub to a TCM or UCM Ethernet port (NET 1 or NET 23). Figure 35 Connecting the Tricon TCM or UCM to a Printer Server and Printer Using a Hub 3. TCM models 4351/4351A/4351B, 4352/4352A/4352B, and UCM only. NET 2 is reserved for OPC communication on model 4353 and 4354 TCMs. TriStation 1131 Developer’s Guide, 4.14.0 554 Chapter 5 Tricon Communication with TriStation 1131 Configuring a Tricon TCM or UCM Port for Printing This procedure explains how to configure a Tricon TCM or UCM port that is connected to a Centronics-compatible printer. You do not need the printer driver that may have come with the printer package. Note Because NET 2 is reserved for OPC communication, you cannot configure this port for printing with model 4353 and 4354 TCMs. The printer port can be configured on NET 1 only for these TCMs.The information and procedures in this section do not apply to model 4351 and 4352 TCMs. If you have one of these TCMs installed in your system, please see Appendix D, TCM Model 4351/4352 Configuration. Procedure 1 In TriStation 1131, open your project, expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the slot where the TCM or UCM is installed and then click Setup. The TCM or UCM Setup dialog box appears. 3 Click the Printer tab. 4 Specify these properties for the module installed in the Left Slot. Property Action Printer Number Enter the number for the printer; can only be 5 or 10. Both slots cannot have the same printer number. The default is 0, meaning a printer is not configured. Tagname Editor > Point Assignment tab Enter the number of characters to be printed on a line. The valid range is 80–132 characters. The default is 80 characters. TCP Port Number Enter the number of the TCP port for the print server. The default is 9100 for an HP printer. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Tricon Controller Printing 555 Property Action Network Click the network that the print server is connected to. For model 4351A/4352A/4351B/4352B TCMs and the UCM, the default is NET 2. For model 4353 and 4354 TCMs, the default is NET 1 (NET 2 is not available for printing on these TCMs). IP Address Enter the IP address of the print server. 5 If a module is also installed in the right slot, repeat step 4 for that module. 6 Click OK. About Function Blocks for Printing A TriStation 1131 application must use print function blocks to send messages to a printer. Each print function block has a PRINTER parameter which specifies the port number where the printer cable is connected. • For a Tricon EICM, TCM, or UCM port, the PRINTER parameter must be 5 for a left EICM, TCM, or UCM port, or 10 for a right EICM, TCM, or UCM port. (Other communication ports cannot be used for printing.) • The PRINTER parameter must be the same number as is defined in TriStation 1131. Each time a message is printed, the print function blocks in the TriStation 1131 application are executed and the scan time increases. This table lists the print function blocks in the Tricon libraries. Print Function Block Purpose PRINT_BOOL Prints a three-character field containing either Off or On. PRINT_CDT Prints the current date and time. PRINT_CRLF Prints a new line (carriage return and line feed). PRINT_CTOD Prints the current time of day. PRINT_DINT Prints a DINT value. PRINT_REAL Prints a REAL value. PRINT_STRING Prints a string of text. PRINTR_FLUSH Clears the print buffer. See the TriStation 1131 Libraries Reference for more detailed information about the print function blocks. TriStation 1131 Developer’s Guide, 4.14.0 556 Chapter 5 Tricon Communication with TriStation 1131 Setting Tricon Controller IP Addresses When communication between a TriStation PC and a Tricon controller occurs over a network, the IP address of the controller must be specified on the communication module. If the controller is not part of a larger network, it may be possible to use the default IP address set when the TriStation 1131 project is downloaded (assuming the correct node number and default IP address are specified in the project). If you cannot use a default address, there are other ways to set an IP address on a network. All begin with asking the network administrator for the intended IP addresses. The easiest way is to use a Reverse ARP (RARP) server that has been programmed in advance with the intended addresses. Other ways include temporary connection of the TriStation PC to a non-Ethernet module during downloading. All the procedures for setting the IP address are based on the assumption that the Tricon controller includes at least one communication module with an Ethernet port connected to a network. To use the procedures, you should know how to: • Connect the Tricon controller to a network • Connect the TriStation PC to the controller • Configure the TriStation 1131 project with the node number of the controller and the IP address For more information, see the Communication Guide for Tricon v9-v11 Systems. Note Typically, Triconex controllers are located on their own subnet which is connected to a larger network such as a DCS. Your network administrator can set up the subnet for compatibility with the Triconex default IP addresses and can program any routers that lie between the DCS and the Triconex subnet with addressing information about the Triconex controllers. Topics include: • Using the Default IP Address for TriStation Communication on page 557 • Setting a Tricon Controller IP Address Using a RARP Server on page 558 • Setting a Tricon Controller IP Address Using an EICM, TCM, or UCM on page 559 • Testing a Network Connection on page 560 TriStation 1131 Developer’s Guide, 4.14.0 Setting Tricon Controller IP Addresses 557 Using the Default IP Address for TriStation Communication This procedure explains how to use the default IP address for network communication between a Tricon controller and a TriStation PC. Procedure 1 Connect the Tricon controller to the network using the NET 2 port on the ACM, NCM, TCM, or UCM. 2 Power up the controller. 3 Connect the TriStation PC to the network, or directly to a NET 2 port on the ACM, NCM, TCM, or UCM. 4 In the TriStation 1131 project, expand the Controller tree, double-click Configuration, and then click TriStation Communication. 5 On the TriStation Communication screen, verify the IP Address is: • 192.168.1.1 (Tricon ACM, NCM, TCM, or UCM) If the controller includes two communication modules, the default address applies to both modules. Note The left and right modules in ACM or NCM slots use the same 48-bit physical MAC address and cannot be connected to the same network. 6 On the Controller tree, click Configuration. 7 Expand Hardware Allocation, click the slot where the communication module is installed, and then click Setup. If a communication module is not installed, insert a communication module, and then click Setup. 8 In the Setup dialog box, enter the same IP address specified on the TriStation Communication screen. 9 If the Tricon controller includes a redundant communication module, enter the same IP address for the other slot. 10 On the Controller tree, click the Controller Panel. From the Commands menu, click Connect. 11 Wait about 40 seconds for the module to reset and become active. When the module is active, the Active indicator is green. 12 On the Commands menu, click Download All to download the TriStation 1131 project to the Tricon controller. 13 On the TriStation PC, from the Start menu, click the MS-DOS Command Prompt. 14 Type the command ping followed by the IP address to be tested. TriStation 1131 Developer’s Guide, 4.14.0 558 Chapter 5 Tricon Communication with TriStation 1131 For example, for an IP address of 206.32.216.43, enter this: ping 206.32.216.43 If the network connection is made, the reply includes the IP address followed by byte and time information. If the connection is not okay, the reply is Request timed out. Note If you receive a Request timed out reply, check your network cable and port connections to verify they are securely connected, verify your configuration settings are correct, and then retry the ping command. Setting a Tricon Controller IP Address Using a RARP Server This procedure explains how to set the IP address of a communication module using a RARP server on the local network. To use this procedure, the network administrator must program the RARP server with the intended IP address for the controller. If this is not possible, use another method to set the IP address. Procedure 1 Give the network administrator the MAC address, which is: 40-00-00-00-00-00 (Tricon) 2 Ask the network administrator for the IP address that is to be used for the Tricon controller. 3 Connect the Tricon controller to the network through a network port on the communication module. 4 Power up the controller. During initialization, the communication module sends a request to the RARP server for an IP address that has been mapped to its own 48-bit MAC address. Note The left and right modules in ACM or NCM slots use the same 48-bit physical MAC address and cannot be connected to the same network. 5 On the TriStation PC, from the Start menu, click the MS-DOS Command Prompt. 6 Enter the command ping followed by the IP address to be tested. For example, for an IP address of 206.32.216.43, enter this: ping 206.32.216.43 If the network connection is made, the reply includes the IP address followed by byte and time information. If the connection is not okay, the reply is Request timed out. Note 7 If you receive a Request timed out reply, check your network cable and port connections to verify they are securely connected, verify your configuration settings are correct, and then retry the ping command. Connect the TriStation PC to the network, or directly to a network port on the communication module. TriStation 1131 Developer’s Guide, 4.14.0 Setting Tricon Controller IP Addresses 559 8 In the TriStation 1131 project, expand the Controller tree, click Configuration, and then click TriStation Communication. 9 On the TriStation Communication screen, specify the Node Number of the controller and the intended IP address. 10 On the Commands menu, click Connect. Wait until the connection is made. 11 On the Commands menu, click Download All to download the TriStation 1131 project to the controller. Setting a Tricon Controller IP Address Using an EICM, TCM, or UCM This procedure explains how to set the IP address of the Tricon controller by initially connecting the TriStation PC to an EICM/TCM/UCM serial port, and downloading the TriStation 1131 project. After the address is set, you can disconnect the TriStation PC from the EICM/TCM/UCM serial port, and reconnect it to a NET 2 port on the ACM/NCM/TCM/UCM. Procedure 1 Ask the network administrator for the IP address to be used for the ACM/NCM/TCM/UCM. 2 Connect the TriStation PC to a serial port on the EICM/TCM/UCM. 3 Connect the controller to the network using the NET 1 or NET 2 port on the TCM or UCM. On the ACM or NCM, use the NET 2 port. 4 In the TriStation 1131 project, configure the following: • The EICM/TCM/UCM serial port and NET 2 Ethernet ports • The node number and node name of the controller • The intended IP address 5 Power up the controller. 6 On the Controller tree, click Controller Panel. 7 On the Command menu, click Connect To. 8 On the Connect To screen, select the Serial Port option and the COM port to which the TriStation 1131 cable is connected. 9 Connect to the Tricon controller and download the TriStation 1131 project. The ACM/NCM/TCM/UCM initializes (resets) and accepts the IP address that you specify in the TriStation 1131 project. 10 On the TriStation PC, from the Start menu, click the MS-DOS Command Prompt. TriStation 1131 Developer’s Guide, 4.14.0 560 Chapter 5 Tricon Communication with TriStation 1131 11 Enter the command ping followed by the IP address to be tested. For example, for an IP address of 206.32.216.43, enter this: ping 206.32.216.43 If the network connection is made, the reply includes the IP address followed by byte and time information. If the connection is not okay, the reply is Request timed out. Note 12 If you receive a Request timed out reply, check your network cable and port connections to verify they are securely connected, verify your configuration settings are correct, and then retry the ping command. If the IP address is set, you can disconnect the TriStation PC from the EICM/TCM/UCM serial port, and connect it to a NET 2 port or to the network. Testing a Network Connection This procedure explains how to test a connection from a Tricon communication module to a network by using the ping command from an MS-DOS command prompt. The test is performed on the TriStation PC. Before doing the test, you must have set the IP address of the communication module on the network. Procedure 1 On the TriStation PC, from the Start menu, click the MS-DOS Command Prompt. 2 Type the command ping followed by the IP address to be tested. For example, for an IP address of 206.32.216.43, enter this: ping 206.32.216.43 If the network connection is made, the reply includes the IP address followed by byte and time information. If the connection is not okay, the reply is Request timed out. TriStation 1131 Developer’s Guide, 4.14.0 6 Trident and Tri-GP Communication with TriStation 1131 Overview 562 Configuring the TriStation PC 564 Connecting to the Trident or Tri-GP 2.x/3.x Controller for the First Time 567 Connecting to the Trident or Tri-GP Controller via a Serial Connection 568 Connecting to the Trident or Tri-GP Controller via a Network Connection 572 Specifying the Trident or Tri-GP Default Connection Type 589 Controlling Access to the CM or CIM 590 Configuring Trident or Tri-GP Controller Printing 597 Setting Trident or Tri-GP Controller IP Addresses 605 TriStation 1131 Developer’s Guide, 4.14.0 562 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 Overview This figure shows the main steps for setting up TriStation 1131 communication and the typical order in the project cycle. Communication setup can be done anytime before implementation. Set Up the Project Develop the Application Test with the Emulator Fix Errors Errors? C onfigure the C ontroller - Establish the physical connection Set Up TriStation C ommunication Implement on the Controller TriStation 1131 Developer’s Guide, 4.14.0 - Configure the connection to the TriStation PC - Set node and IP address of the controller Overview 563 TriStation 1131 Communication Steps This checklist includes the items that can be or should be performed to set up communication between a TriStation PC and a Trident or Tri-GP controller. Description See Connect to a Trident 1.x MP • Connecting the Trident 1.x MP to a TriStation PC on page 573 Connect to a Trident 1.x CM • Connecting the Trident 1.x CM to the TriStation PC on page 577 Connect to a Trident/Tri-GP 2.x CM or MP • Connecting to the Trident or Tri-GP 2.x/3.x Controller for the First Time on page 567 • Connecting the Trident or Tri-GP 2.x/3.x Controller to a TriStation PC on page 582 Connect to a Trident/Tri-GP 3.x CM, CIM, or MP • Connecting to the Trident or Tri-GP 2.x/3.x Controller for the First Time on page 567 • Connecting the Trident or Tri-GP 2.x/3.x Controller to a TriStation PC on page 582 Configure user access to the Trident 2.x or Tri-GP CM • Controlling Access to the CM or CIM on page 590 Configure user access to the Trident or Tri-GP 3.x CIM • Controlling Access to the CM or CIM on page 590 Set up printing • Configuring Trident or Tri-GP Controller Printing on page 597 TriStation 1131 Developer’s Guide, 4.14.0 564 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 Configuring the TriStation PC This section explains the setup required for a network connection from the TriStation PC. Topics include: • Installing a NIC Card in a TriStation PC on page 564 • Installing DLC or TCP/IP Protocol on a TriStation PC on page 564 Note If you will only be connecting to the Trident or Tri-GP controller via a serial connection, you can skip this section. Please note, however, that the preferred method of connecting the TriStation PC to the Trident or Tri-GP controller is via a network connection. Installing a NIC Card in a TriStation PC This procedure explains how to install a network interface card (NIC) in a TriStation PC to be connected to a Trident or Tri-GP MP or CM. Procedure 1 Install the network interface card by following the manufacturer’s instructions. Do not change the factory default settings on the NIC card. 2 Connect the network interface card directly to a CM or MP network port on the Trident or Tri-GP controller, or to an Ethernet hub. 3 Run the diagnostics provided with the network interface card according to the manufacturer’s instructions. Installing DLC or TCP/IP Protocol on a TriStation PC These procedures explain how to install DLC or TCP/IP protocol on a TriStation PC. • The DLC protocol is required only for connecting to a Trident 1.x MP. • The TCP/IP protocol is required for Trident or Tri-GP CM connection. Installing TCP/IP on Windows 7, Windows Server 2012 R2, or Windows Server 2008 R2 1 On the Start menu, click Control Panel, open Network and Internet, and then click Network and Sharing Center. 2 In the Network and Sharing Center, click Manage Network Connections. 3 Right-click the network connection you want to change, and then click Properties. 4 If prompted, enter the administrator’s password or confirm the operation. 5 On the Networking tab, under This connection uses the following items, click Internet Protocol Version 4 (TCP/IPv4), and then click OK. TriStation 1131 Developer’s Guide, 4.14.0 Configuring the TriStation PC Note 565 Internet Protocol Version 4 (TCP/IPv4) must be installed to allow a TriStation 1131 application to connect to a Trident or Tri-GP controller. Do not install Internet Protocol Version 6 (TCP/IPv6). Installing DLC on Windows 7 These procedures explain how to install the DLC protocol on the diagnostic PC. The DLC protocol is required only for connecting to a Trident 1.x MP. Installing the DLC protocol on a Windows 7 (32-bit only) workstation is a 3-step process. The DLC protocol cannot be installed on Windows 64-bit systems. As a result, you cannot connect to a Trident 1.x MP on a Windows 64-bit system. Note If you have already installed the DLC protocol on your workstation, you can configure it to start automatically each time you start your workstation by changing a registry value. Go to HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Services\Dlc, and then change the Start value to 1. Step 1: Obtain the DLC Protocol Installation Program 1 Contact Global Customer Support to obtain the dlc.exe file. (For contact information, see Technical Support on page xvii.) 2 Save the dlc.exe file to your local drive. 3 Double-click the self-extracting dlc.exe file to unzip the five DLC protocol files. Save the files to a location on your local drive that will be easy to remember (for example, C:\DLC). Step 2: Modify the .Inf File 1 Go to the location where you saved the DLC protocol files in step 3 of the previous section. 2 Right-click on NetDLC.inf, and select Open with from the shortcut menu that appears. Then select Notepad from the Open with dialog box and click OK. The .inf file opens in Notepad. 3 Scroll down until you see the following section: 4 Change the value for StartType from 3 to 1. This ensures that the DLC protocol will start automatically each time you start your workstation. 5 Save the file and then exit Notepad. TriStation 1131 Developer’s Guide, 4.14.0 566 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 Step 3: Configure the DLC Protocol Network Connection 1 Go to the location where you saved the DLC protocol files in Step 1: Obtain the DLC Protocol Installation Program. 2 Double-click install.cmd to start the installation script. 3 On the Start menu, click Control Panel, and then double-click Network Connections. 4 Right-click the network connection where you want to install the protocol, then click Properties. 5 On the General tab, click Install. 6 In the Select Network Component Type dialog box, click Protocol, and then click Add. 7 Click the DLC Protocol, and then click OK. 8 Once installation is complete, you can close the Network Connections dialog box. TriStation 1131 Developer’s Guide, 4.14.0 Connecting to the Trident or Tri-GP 2.x/3.x Controller for the First Time 567 Connecting to the Trident or Tri-GP 2.x/3.x Controller for the First Time The first time you connect to the Trident or Tri-GP 2.x/3.x controller, you are limited to the following two connection options: • Serial connection to the communication module (CM or CIM), or • Network connection to the Left MP, using the default IP address only You cannot connect to the controller via a network connection to the CM/CIM or the Right or Middle network ports on the MP until you have completed all of the following tasks: • Configure the CM/CIM and/or MP (Right and Middle ports) network connection in TriStation 1131, including configuring your own IP addresses for the desired network port(s). • Successfully connect to the controller via the first-time connection options described above. • Download your application to the controller using the Download All command. Once your application—with the IP addresses for the other MP and/or CM/CIM network ports correctly configured—has been downloaded to the controller, you can disconnect from the Trident or Tri-GP controller and reconnect using your desired network connection. Note After you have successfully configured your network configuration for the CM/CIM and/or the Right and Middle MP, you can change the default IP address for the Left MP to your desired IP address for future network connections. Connecting Via the Serial Connection (Recommended) Invensys recommends using the serial connection for the initial connection to the Trident 2.x/3.x or Tri-GP controller because it is less complex to configure and thus easier to successfully connect to the CM/CIM through the serial port. Once you have successfully connected to the CM/CIM and downloaded the initial configuration to the Trident or Tri-GP controller via the serial connection, you can go back and configure the more complex network connection, without worrying about losing the ability to communicate with the controller altogether. See Connecting to the Trident or Tri-GP Controller via a Serial Connection on page 568 for more information. Connecting via the Left MP Network Port If you need to use a network connection for the initial connection to the controller, you must connect using the default IP address (192.168.255.n) with the Left MP. Your own IP addresses for other MP and CM/CIM modules cannot be used for connecting to the controller until your application—with the IP addresses for the other MP and/or CM/CIM network ports correctly configured—has been downloaded to the controller at least once, using the Download All command. See Connecting to the Trident or Tri-GP Controller via a Network Connection on page 572 for more information. TriStation 1131 Developer’s Guide, 4.14.0 568 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 Connecting to the Trident or Tri-GP Controller via a Serial Connection This section explains how to make a direct (point-to-point) serial connection between a Trident or Tri-GP 2.x/3.x communication module and a TriStation PC. Note You cannot connect the TriStation PC to the Trident 1.x controller via a serial connection. See Connecting to the Trident or Tri-GP Controller via a Network Connection on page 572 for instructions on connecting the TriStation PC to a Trident 1.x. Port 3 on the CM and CIM is the only serial port that supports TriStation communication. If port 3 on the CM or CIM fails, you can connect to TriStation 1131 using the NET 1 or NET 2 port; see the Communication Guide for Trident v2-v3 Systems for more information. A maximum of three connections (from a single PC, or from multiple PCs) can be made to a Trident or Tri-GP controller at any one time. For more information, see Using Multiple Instances of TriStation 1131 on page 12. Topics include: • When to Use the Trident or Tri-GP Serial Connection on page 568 • Connecting a Trident or Tri-GP 2.x/3.x Serial Port to a TriStation PC on page 570 • Configuring the TriStation 1131 Serial Connection on page 571 When to Use the Trident or Tri-GP Serial Connection The preferred means for connecting the TriStation PC to the Trident or Tri-GP controller is via a network connection. Invensys recommends connecting the TriStation PC to the Trident or Tri-GP controller via a serial connection only in the following scenarios. Connecting to the Trident or Tri-GP Controller for the First Time The first time you connect to the Trident or Tri-GP controller, Invensys recommends making a serial connection to the communication module, because it is less complex to configure and thus easier to successfully connect to the communication module through the serial port. Once you have successfully connected to the communication module and downloaded the initial configuration to the Trident or Tri-GP controller via the serial connection, you can go back and configure the more complex network connection without worrying about losing the ability to communicate with the controller altogether. See Connecting to the Trident or Tri-GP 2.x/3.x Controller for the First Time on page 567 for more information. TriStation 1131 Developer’s Guide, 4.14.0 Connecting to the Trident or Tri-GP Controller via a Serial Connection 569 Connecting to the Trident or Tri-GP Controller When the Network Is Down When network communication has been interrupted due to hardware or other problems with the network, the serial connection can be used as a backup means of communicating with the Trident or Tri-GP controller. Once the network problems have been resolved, you should restore the network connection to the Trident or Tri-GP controller. Connecting to the Trident or Tri-GP Controller When the Access Control List has Been Misconfigured If you misconfigure the access control list, you could accidentally lock yourself out of a network connection to the Trident or Tri-GP controller. Once you enable client access control by selecting the Enable Access List check box, you must configure at least one client with TriStation Read/Write access before you save the configuration. If this is not done, you will be unable to connect to the Trident or Tri-GP controller again after your next download, preventing you from making further changes to the application running on the controller, including changes to the access control list. If this happens, you can use the serial connection to connect to the Trident or Tri-GP controller and download changes to the access control list. See Controlling Access to the CM or CIM on page 590 for more information. TriStation 1131 Developer’s Guide, 4.14.0 570 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 Connecting a Trident or Tri-GP 2.x/3.x Serial Port to a TriStation PC This procedure explains how to connect serial port 3 on the Trident or Tri-GP 2.x/3.x communication module to a TriStation PC. Invensys provides a serial cable that has a 9-pin connector on each end. If the COM port on the PC has a 25-pin connector, you can use a Triconex 25-pin to 9-pin adapter. If you need other parts, you can purchase them from another manufacturer. For more information, see the Communication Guide for Trident v2-v3 Systems. Procedure 1 Connect one end of the serial cable to serial port 3 on the CM or CIM. 2 Connect the other end of the serial cable to a COM port on the TriStation PC. The COM port is typically numbered COM1, COM2, COM3, or COM4. Figure 36 Connecting a Trident or Tri-GP 2.x/3.x CM Serial Port to the TriStation PC TriStation 1131 Developer’s Guide, 4.14.0 Connecting to the Trident or Tri-GP Controller via a Serial Connection 571 Configuring the TriStation 1131 Serial Connection This procedure explains how to configure a Trident or Tri-GP 2.x/3.x communication module serial port that is connected to a TriStation PC. Procedure 1 Expand the Controller tree, double-click Configuration, and then click TriStation Communication. 2 Specify these properties on the TriStation Communication screen. Note The data displayed on this screen is used by TriStation 1131 only to connect to a Trident or Tri-GP communication port. The data that you enter will not be downloaded to the Trident or Tri-GP controller. Property Action Serial Connection (Trident/Tri-GP 2.x and later only) Select this check box. Node Name Enter the name of the Trident or Tri-GP controller. You can use a default name, or enter your own user-defined name. The default names are TRINODE01 through TRINODE63. Serial Port Select the COM port on the TriStation PC to which the serial cable is connected. You cannot change the default baud rate of 115200. 3 On the Configuration tree, expand Hardware Allocation, double-click CM or CIM, and then click Setup. 4 Specify these properties on the Serial Ports tab of the CM or CIM Setup dialog box. 5 Property Action Port Select the port that the TriStation PC is attached to. You must select port 3, as this is the only serial port supported for TriStation 1131 connection. Protocol Select TriStation. Click OK. TriStation 1131 Developer’s Guide, 4.14.0 572 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 Connecting to the Trident or Tri-GP Controller via a Network Connection This section explains how to make a network connection between a Trident or Tri-GP communication module (CM or CIM) or main processor (MP), and a TriStation PC. This can be a direct connection from the Trident or Tri-GP controller to the PC, or a connection through a router, hub, or media converter. A router or hub is not required if you do not need to connect any additional devices besides the Trident or Tri-GP controller and the PC. To set up the connection, you must: • Install a network interface card and the TCP/IP protocol on the PC. • Set the node number of the controller. • Connect the PC to a network port on the communication module or MP. • Configure the connection in the TriStation 1131 project. CAUTION The node setting (on the MP Baseplate) must match the node number specified in the TriStation 1131 project. For instructions on changing the MP node setting, see the Planning and Installation Guide for Trident v2-v3 Systems. For instructions on installing a network interface card and the TCP/IP protocol on the TriStation PC, see Configuring the TriStation PC on page 564. A maximum of three connections (from a single PC, or from multiple PCs) can be made to a Trident or Tri-GP controller at any one time. For more information, see Using Multiple Instances of TriStation 1131 on page 12. Topics include: • Connecting the Trident 1.x MP to a TriStation PC on page 573 • Connecting the Trident 1.x CM to the TriStation PC on page 577 • Connecting the Trident or Tri-GP 2.x/3.x Controller to a TriStation PC on page 582 Note If you are connecting the Trident or Tri-GP 2.x/3.x controller to the TriStation PC via serial port, see Connecting to the Trident or Tri-GP Controller via a Serial Connection on page 568. TriStation 1131 Developer’s Guide, 4.14.0 Connecting to the Trident or Tri-GP Controller via a Network Connection 573 Connecting the Trident 1.x MP to a TriStation PC This section explains how a Trident 1.x MP can be used for a network connection to a TriStation PC using the DLC protocol. This can be a direct connection from the MP to the PC, or a connection through a hub on a network. Communication between the Trident 1.x MP and the TriStation PC requires the DLC protocol to be installed on the PC. For more information, see Configuring the TriStation PC on page 564. Topics include: • Directly Connecting a Trident 1.x MP to a TriStation PC on page 573 • Connecting a Trident 1.x MP to a TriStation PC Using a Hub on page 574 • Configuring the TriStation 1131 Connection on page 575 Note If you are connecting the Trident 1.x controller to the TriStation PC via the CM, see Connecting the Trident 1.x CM to the TriStation PC on page 577. Directly Connecting a Trident 1.x MP to a TriStation PC This procedure explains how to directly connect a TriStation PC to a network port on a Trident 1.x MP Baseplate using a 10Base-T cross-over cable. Procedure 1 Attach one end of the cross-over cable to one of the RJ-45 connectors on the MP Baseplate. This is typically MP A, as shown in the figure. 2 Attach the other end of the cross-over cable to the network interface card in the PC. DSP1 PASS DSP2 – + DSP3 PASS FAULT FAULT ACTIVE ACTIVE MODE MODE DSP4 MODE REM OTE REMOTE REM OTE RUN RUN RUN PROGRAM PROGRAM PROGRAM HALT HALT HALT STATUS STATUS PS1 STATUS PS1 PS2 SYSTEM ALARM PROGRAM ALARM OVER TEMPE RATURE COMMUNI CATIONS IO BUS COMM BUS SERIAL TX RX TX RX TX RX PS1 PS2 SYSTEM ALARM PROGRAM ALARM OVER TEMPE RATURE LOCK PS2 SYSTEM ALARM PROGRAM ALARM OVER TEMPE RATURE LOCK COMMUNI CATIONS IO BUS COMM BUS SERIAL LINK 1 PASS FAULT ACTIVE TX RX TX RX TX RX LOCK COMMUNI CATIONS IO BUS TX RX TX COMM BUS RX SERIAL LINK TX RX LINK TRIS TATION TX TRIS TATION TX TRIS TATION TX RX RX RX MP3101 MP3101 MP3101 TX Figure 37 Connecting the TriStation PC to a Trident 1.x Main Processor TriStation 1131 Developer’s Guide, 4.14.0 574 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 Connecting a Trident 1.x MP to a TriStation PC Using a Hub This procedure explains how to connect a Trident 1.x MP to a TriStation PC using a 10Base-T straight-through cable and a hub. Procedure 1 Attach at least one 10Base-T straight-through cable from an RJ-45 connector on an MP Baseplate to the hub. Note 2 Using more than one cable provides redundancy for the TriStation connection. If you use only one cable during live operation, you have to unplug it and move it to another RJ-45 connector if the original connection fails. Attach the network interface card in the TriStation PC to the hub using another 10Base-T straight-through cable. V SP1 P ASS V SP2 – PASS F A U LT + P ASS FAU L T A CTIVE F A U LT A CTIVE A CTIVE ALARM1 MODE MODE ALARM2 MODE REM O TE REM O TE RUN RUN PROG RAM PROG RAM HA LT HA L T ST ATUS HA LT STA TUS S TATUS PS1 PS1 PS2 PS1 PS2 SY STEM ALARM PS2 SY STEM ALARM SY STEM ALARM PROG R AM ALARM PROG RAM ALARM PROG RAM ALARM OVER TEMPE RATURE OVER TEMPE RA TURE OVER TEMPE RA TURE L OCK C OMMUNI C A TIONS LOCK COMMUNI CA TIONS TX IO BUS COMMUNI RX RX TX RX LINK RX LINK TX TRIS TA TION RX MP3101 TX SERIAL RX TX RX COMM BUS TX SERIAL TRIS TA TION TX TX COMM BUS T X SERIAL C A TIONS IO BUS RX TX RX L OCK TX IO BUS RX COMM BUS 1 REM OTE RUN PROG RAM LINK TRIS TA TION RX MP3101 TX RX MP3101 TX COAX 8X 1X MDI MDIX POWER 16 10BASE-T 9X Figure 38 Connecting the TriStation PC to the Trident 1.x Main Processor Using a Hub TriStation 1131 Developer’s Guide, 4.14.0 Connecting to the Trident or Tri-GP Controller via a Network Connection 575 Configuring the TriStation 1131 Connection This procedure explains how to configure a Trident 1.x MP connection to a TriStation PC. Procedure 1 Expand the Controller tree, and doubleclick Configuration. 2 On the Configuration tree, click TriStation Communication. 3 Specify these properties on the TriStation Communication screen. Property Action Select Connection Select the Main Processor Connection (Trident 1.x only) check box. Node Number Enter the number specified on the address plug on the MP Baseplate. The node number can be changed only if the project is in the Download All state. Node Name Enter a name with eight or fewer characters to identify the Trident controller. Main Processor Setup Select Left, Middle, or Right to specify which MP port is connected to the TriStation PC. NIC Index Enter the index position of the network interface card in the TriStation PC. Note 4 The data displayed on this screen is used by TriStation 1131 only to connect to a Trident communication port. The data that you enter will not be downloaded to the Trident controller. On the Configuration tree, expand Hardware Allocation, and then double-click the Main Processors (MP/IOP1). TriStation 1131 Developer’s Guide, 4.14.0 576 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 5 In the Properties dialog box, click Setup. 6 In the MP Setup dialog box, click the Network Ports tab. 7 For the port that is physically connected to the TriStation PC (Left, Middle, or Right) specify the Transceiver Mode to match the installed hardware. 8 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Connecting to the Trident or Tri-GP Controller via a Network Connection 577 Connecting the Trident 1.x CM to the TriStation PC This section explains how to configure a Trident 1.x CM connection to the TriStation PC. Topics include: • Directly Connecting a Trident 1.x CM to a TriStation PC on page 577 • Connecting a Trident 1.x CM to a TriStation PC Using a Hub on page 578 • Configuring the TriStation 1131 Connection on page 579 Note If you are connecting the Trident 1.x controller to the TriStation PC via the MP, see Connecting the Trident 1.x MP to a TriStation PC on page 573. Directly Connecting a Trident 1.x CM to a TriStation PC This procedure explains how to directly connect a Trident 1.x CM to a TriStation PC using a cross-over cable. For a NET 1 port, you must use a 10Base-T cable. For a NET 2 port, you can use either a 10Base-T or 100Base-TX cable. On the CM baseplate, you can attach the cable to an RJ-45 connector or to a MAU. For information about MAUs, see the Communication Guide for Trident v1 Systems. Procedure 1 Attach one end of a cross-over cable to a NET 1 or NET 2 connector on the CM baseplate, as shown in this example. 2 Attach the other end of the cross-over cable to the network interface card in the TriStation PC. Figure 39 Connecting the TriStation PC Directly to a Trident 1.x CM TriStation 1131 Developer’s Guide, 4.14.0 578 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 Connecting a Trident 1.x CM to a TriStation PC Using a Hub This procedure explains how to connect a Trident 1.x CM to a TriStation PC using a straightthrough cable and a hub. For a NET 1 port, you must use a 10Base-T cable. For a NET 2 port, you can use either a 10Base-T or 100Base-TX cable. On the CM baseplate, you can attach the cable to an RJ-45 connector or to a MAU. For information about MAUs, see the Communication Guide for Trident v1 Systems. Procedure 1 Attach one end of a straight-through cable to a NET 1 or NET 2 connector on the CM baseplate. 2 Attach the other end of the straight-through cable to a network hub, as shown in the example below. 3 Connect the TriStation PC to the hub using another straight-through cable. PASS PASS FAULT FAULT ACTIVE ACTIVE LOCK COMMUNICATIONS SERIAL SERIAL SERIAL LOCK COMMUNICATIONS TX SERIAL RX TX SERIAL RX TX SERIAL RX TX RX LINK RX LINK LINK NET 2 TX NET 2 TX RX CM 3201 1X 8X 16 RX NET 1 TX CM 3201 MDI MDIX TX LINK RX COAX RX NET 1 TX RX POWER TX 10BASE-T 9X Figure 40 Connecting the TriStation PC to a Trident 1.x CM Using a Hub TriStation 1131 Developer’s Guide, 4.14.0 Connecting to the Trident or Tri-GP Controller via a Network Connection 579 Configuring the TriStation 1131 Connection This procedure explains how to configure a Trident 1.x CM connection to a TriStation PC. Before you begin this procedure, you must determine the IP address to use for the CM. If the connection goes through a gateway or a router, you also need IP addresses for those devices. Typically, you can get the necessary IP addresses from your network administrator or Information Technology department. See Setting Trident or Tri-GP Controller IP Addresses on page 605. Procedure 1 Expand the Controller tree, and double-click Configuration. 2 On the Configuration tree, click TriStation Communication. 3 Specify these properties on the TriStation Communication screen. Property Action Select Connection Select the Network Connection check box. Node Number Enter the number specified on the address plug on the MP baseplate. The node number can be changed only if the project is in the Download All state. Node Name Enter a name that contains eight or fewer characters to identify the Trident controller. IP Address Enter the IP address. Note The data displayed on this screen is used by TriStation 1131 only to connect to a Trident communication port. The data that you enter will not be downloaded to the Trident controller. TriStation 1131 Developer’s Guide, 4.14.0 580 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 4 On the Configuration tree, double-click the CM (COM: CM). 5 In the Properties dialog box, click Setup. 6 Specify these properties for the NET 1 or NET 2 port, depending on which is connected to the TriStation PC. Property Action Slot Selection Select Left Slot or Right Slot, depending on which slot contains the module that is connected to the TriStation PC. Mode For the TriStation connection, select Open Network. For each CM on a baseplate, you can select Open Network for either NET 1 or NET 2, but not for both ports. Privilege Select Read or Read/Write to specify access privileges for external devices on the network. A TriStation 1131 application must use the Privilege option in conjunction with the MP.REMOTE_WRT_ENBL control attribute (and possibly other write controls) to enable writes by external devices. Transceiver Port Select RJ-45 or MAU depending on the type of CM baseplate port to which you have physically attached the TriStation cable. TriStation 1131 Developer’s Guide, 4.14.0 Connecting to the Trident or Tri-GP Controller via a Network Connection Property Action Transceiver Mode Select the Auto mode if the TriStation 1131 cable can autonegotiate to either 10 or 100 megabits per second. 581 If your cable operates at only one speed, select the appropriate speed from the list. IP Address If using the default node number, do not change this property (leave blank). If using a different node number, enter the IP address that identifies the controller on the network. This must be the same address you entered in step 2. 7 IP Subnet Mask Get the subnet mask from your network administrator. Default Gateway IP Address If the CM connection to the TriStation PC goes through a default gateway, enter the IP address of the gateway. Time Synchronization Select None. This property does not apply to TriStation communication. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 582 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 Connecting the Trident or Tri-GP 2.x/3.x Controller to a TriStation PC This section explains how to connect the Trident or Tri-GP 2.x/3.x controller to the TriStation PC via a network port on the communication module (CM or CIM) or MP. If you will be using the default IP address for the Trident or Tri-GP controller (192.168.255.<node>), you must connect the controller to the TriStation PC via a network port on the Left MP. The network ports on the Middle MP, Right MP, and CM/CIM do not have default IP addresses; you must configure the IP addresses for these ports based on your network configuration. If you want to be able to retrieve communication status information from the CM/CIM, you must connect the controller to the TriStation PC via a network port on the CM/CIM. Note If the TriStation PC is connected only to the MP, you will not be able to view communication status information in the Enhanced Diagnostic Monitor. See the Enhanced Diagnostic Monitor User’s Guide for more information. CAUTION If you will be connecting to the Trident or Tri-GP 2.x/3.x controller for the very first time via a network connection, you must use the default IP address (192.168.255.<node>), and connect to the controller via the Left MP. See Connecting to the Trident or Tri-GP 2.x/3.x Controller for the First Time on page 567 for more information. Topics include: • Directly Connecting a Trident or Tri-GP 2.x/3.x Network Port to a TriStation PC on page 583 • Connecting a Trident or Tri-GP 2.x/3.x Network Port to a TriStation PC Using a Hub on page 584 • Configuring the TriStation 1131 Network Connection on page 585 TriStation 1131 Developer’s Guide, 4.14.0 Connecting to the Trident or Tri-GP Controller via a Network Connection 583 Directly Connecting a Trident or Tri-GP 2.x/3.x Network Port to a TriStation PC This procedure explains how to directly connect a Trident or Tri-GP 2.x/3.x communication module or MP network port to a TriStation PC using a cross-over cable. • On the CM, for a NET 1 port, you must use a 10Base-T cable. For a NET 2 port, you can use either a 10Base-T or 100Base-TX cable. • On the CIM, for a NET 1 or NET 2 port, you must use a 100Base-TX cable. • On the MP baseplate, for a TriStation port, you must use a 10Base-T cable. Procedure 1 Attach one end of a cross-over cable to a NET 1 or NET 2 connector on the CM baseplate, as shown in this example, or to a TriStation port on the MP baseplate. 2 Attach the other end of the cross-over cable to the network interface card in the TriStation PC. DSP1 PASS DSP2 – + PASS FAULT MODE REMOTE RUN PROGRAM HALT HALT STATUS STATUS PS1 PS1 PS2 PS2 SYSTEM ALARM SYSTEM ALARM PROGRAM ALARM PROGRAM ALARM OVER TEMPE RATURE OVER TEMPE RATURE LOCK COMMUNICATIONS SERIAL TX RX TX RX TX RX TRIS TATION TX PS1 PS2 SYSTEM ALARM PROGRAM ALARM OVER TEMPE RATURE LOCK COMMUNI CATIONS IO BUS COMM BUS SERIAL LINK TX RX TX RX TX RX LOCK COMMUNI CATIONS IO BUS COMM BUS SERIAL LINK TRIS TATION TX RX MP3101 RUN PROGRAM HALT IO BUS REM OTE RUN PROGRAM COMM BUS ACTIVE MODE REM OTE STATUS 1 FAULT ACTIVE MODE DSP4 PASS FAULT ACTIVE DSP3 TX RX LINK TRIS TATION TX RX MP3101 TX RX TX RX RX MP3101 TX Figure 41 Connecting the TriStation PC Directly to a Trident or Tri-GP 2.x/3.x MP (left) or CM (right) Using a Hub TriStation 1131 Developer’s Guide, 4.14.0 584 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 Connecting a Trident or Tri-GP 2.x/3.x Network Port to a TriStation PC Using a Hub This procedure explains how to connect a Trident or Tri-GP 2.x/3.x communication module or MP network port to a TriStation PC using a straight-through cable and a hub. • On the CM, for a NET 1 port, you must use a 10Base-T cable. For a NET 2 port, you can use either a 10Base-T or 100Base-TX cable. • On the CIM, for a NET 1 or NET 2 port, you must use a 100Base-TX cable. • On the MP baseplate, for a TriStation port, you must use a 10Base-T cable. Procedure 1 Attach one end of a straight-through cable to a NET 1 or NET 2 connector on the CM baseplate, or to a TriStation port on the MP baseplate. 2 Attach the other end of the straight-through cable to a network hub, as shown in the example below. 3 Connect the TriStation PC to the hub using another straight-through cable. PASS V SP1 PASS V SP2 – PASS F AU LT + PASS FAULT FAULT ACTIVE ACTIVE PASS FAU L T A CTIVE F AU LT A CTIVE A CTIVE ALARM1 MODE MODE ALARM2 MODE REM O TE REM O TE RUN REM OTE RUN PROG RAM RUN PROG RAM HA LT PROG RAM HA L T ST A TUS HA LT STA TUS STA TUS PS1 PS1 PS2 PS1 PS2 S Y STEM ALARM PS2 SY STEM ALARM SY STEM ALARM PROG R AM ALARM PROG RAM ALARM PROG RAM ALARM OVER TEMPE RA TURE OVER TEMPE RA TURE OVER TEMPE RA TURE LOCK L OCK LOCK COMMUNICATIONS SERIAL C OMMUNI C ATIONS COMMUNI CA TIONS TX IO BUS COMMUNI SERIAL C ATIONS TX IO BUS TX RX COMMUNICATIONS SERIAL SERIAL RX SERIAL TX COMM BUS RX TX COMM BUS T X TX SERIAL TX RX SERIAL TRIS TA TION RX TX LINK TX TRIS TA TION RX 1 MP3101 TX RX TX RX LINK TX NET 1 TX RX RX NET 1 TX RX LINK LINK SERIAL RX LINK RX RX LINK SERIAL TX TX RX TX RX TX RX IO BUS RX COMM BUS LOCK L OCK LINK TRIS TA TION RX MP3101 TX NET 2 TX RX NET 2 TX RX MP3101 CM 3201 RX CM 3201 TX COAX COAX 8X MDI MDIX 16 10BASE-T 9X POWER 1X 8X 1X MDI MDIX POWER 16 10BASE-T 9X Figure 42 Connecting the TriStation PC to a Trident or Tri-GP 2.x/3.x MP (left) or CM (right) Using a Hub TriStation 1131 Developer’s Guide, 4.14.0 Connecting to the Trident or Tri-GP Controller via a Network Connection 585 Configuring the TriStation 1131 Network Connection This procedure explains how to configure a Trident or Tri-GP 2.x/3.x network connection to a TriStation PC. Before you begin this procedure, you must determine the IP address to use for the communication module or MP. If the connection goes through a gateway or a router, you also need IP addresses for those devices. Typically, you can get the necessary IP addresses from your network administrator or Information Technology department. See Setting Trident or Tri-GP Controller IP Addresses on page 605. Procedure 1 Expand the Controller tree, and double-click Configuration. 2 On the Configuration tree, click TriStation Communication. 3 Specify these properties on the TriStation Communication screen. Property Action Select Connection Select the Network Connection check box. Node Number Enter the number specified on the address plug on the MP baseplate. The node number can be changed only if the project is in the Download All state. TriStation 1131 Developer’s Guide, 4.14.0 586 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 Property Action Node Name Enter a name that contains eight or fewer characters to identify the Trident or Tri-GP controller. IP Address Enter the IP address for the CM/CIM or MP network port you will be connecting to. Each node has seven connection options: • Left MP • Middle MP • Right MP • Left CM/CIM - NET 1 • Left CM/CIM - NET 2 • Right CM/CIM - NET 1 • Right CM/CIM - NET 2 The default IP address is 192.168.255.n, where n is the node number of the controller. The default IP address is for connection to the Left MP only. To use the default IP address, click the browse button, and in the dialog box that appears, select the IP address for the node you are configuring. Note: Your own IP addresses for other MP and CM/CIM modules cannot be used for connecting to the controller until the control program—with the IP address configuration—has been downloaded to the controller at least once, using the Download All Command. See Connecting to the Trident or Tri-GP 2.x/3.x Controller for the First Time on page 567 for more information. TriStation UDP Port Number Specify the UDP port to use for the connection to a Trident or Tri-GP 2.x/3.x controller with a CM/CIM installed. The default is 1502. This must be the same value as the TriStation UDP Port Number property in the CM/CIM Setup dialog box. Required only for a connection to a Trident or Tri-GP 2.x/3.x node with a CM/CIM installed. Note 4 The data displayed on this screen is used by TriStation 1131 only to connect to a Trident or Tri-GP communication port. The data that you enter will not be downloaded to the Trident or Tri-GP controller. Do one of the following: • If the TriStation PC is connected to the CM/CIM, go to step 5. • If the TriStation PC is connected to the MP, go to step 8. TriStation 1131 Developer’s Guide, 4.14.0 Connecting to the Trident or Tri-GP Controller via a Network Connection 587 5 On the Configuration tree, expand Hardware Allocation, double-click CM or CIM, and then click Setup. 6 On the Network tab of the CM/CIM Setup dialog box, specify these properties for the NET 1 or NET 2 port, depending on which is connected to the TriStation PC. Property Action Slot Selection Select Left Slot or Right Slot, depending on which slot contains the module that is connected to the TriStation PC. Installed Select this property for all installed modules. IP Address If using a default IP address, leave blank. If not, enter the IP address that identifies the controller on the network. This must be the same IP address entered on the TriStation Communication screen. IP Subnet Mask If using a default IP Subnet Mask, leave blank. Otherwise, get the subnet mask from your network administrator. Default Gateway IP Address If the CM connection to the TriStation PC goes through a default gateway, enter the IP address of the gateway. 7 Go to step 13. 8 On the Configuration tree, expand Hardware Allocation, and then double-click the Main Processors (MP/IOP1). 9 In the Properties dialog box, click Setup. TriStation 1131 Developer’s Guide, 4.14.0 588 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 10 In the MP Setup dialog box, click the Network Ports tab. 11 For the port that is physically connected to the TriStation PC (Left, Middle, or Right) specify the Transceiver Mode to match the installed hardware. 12 Specify the IP address for the port. This must be the same IP address entered on the TriStation Communication screen in step 3. 13 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Specifying the Trident or Tri-GP Default Connection Type 589 Specifying the Trident or Tri-GP Default Connection Type This procedure explains how to specify the default connection setting in the Connect To dialog box, which appears when you establish communication between a TriStation PC and a controller. The connection setting—Network, Serial, or Main Processor Connection—is an initial setting and can be changed when you use the Connect Command. Procedure 1 Expand the Configuration tree, double-click Configuration, and then click TriStation Communication. 2 Verify that the Network Connection Setup (for a network connection), Main Processor Connection Setup (for a MP connection), or TriStation PC (for a serial connection) properties are correctly configured. See the following for additional information: 3 • Connecting to the Trident or Tri-GP Controller via a Serial Connection on page 568 • Connecting to the Trident or Tri-GP Controller via a Network Connection on page 572 Under Default Connection, select one of the following: • Network Connection • Main Processor (for Trident 1.x only) • Serial Connection (for Trident or Tri-GP 2.x/3.x only) The next time you establish communication between the TriStation PC and the Trident or Tri-GP controller, the default connection setting you selected will be used. Note If only one connection type is selected under Select Connections, the default connection is automatically set based on it, and cannot be changed. TriStation 1131 Developer’s Guide, 4.14.0 590 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 Controlling Access to the CM or CIM The CM and CIM both feature an access control list that gives you the ability to control who can access communication module resources through the module’s network ports, and each user’s level of access. The access control list is available only with the following controllers: • Trident and Tri-GP 2.x • Trident and Tri-GP 3.x Note The information in this section does not apply to Trident 1.x systems. Topics include: • What Are Communication Module Resources? on page 590 • How Is Access Controlled? on page 591 • What Are Access Levels? on page 591 • Configuring the Access Control List on page 594 What Are Communication Module Resources? A resource is any service or information provided by the communication module through the supported communications protocols. Examples of these resources include: • Access to the controller via TriStation 1131 (ability to perform a Download Changes or Download All). • Access to Trident or Tri-GP diagnostic information via the Enhanced Diagnostic Monitor. • Access to information provided in applications such as SOE Recorder or DDE Server that use the TSAA protocol. • Access to any other applications that use the TSAA protocol. • Access to the Trident or Tri-GP 3.x controller via OPC UA. CAUTION By default, TSAA clients have write access to the NET 1 and NET 2 ports on Trident or Tri-GP 2.x/3.x communication modules. Depending on your configuration, this may create a security issue. To disable write access by TSAA clients, you must enable and configure the access control list. TriStation 1131 Developer’s Guide, 4.14.0 Controlling Access to the CM or CIM 591 How Is Access Controlled? Access is controlled via client IP addresses. You can control access for a single IP address (one client), or for a group of IP addresses (a group of clients). If you want to group clients into a single access list entry, they must be physically separated in a sub-network, and a network address mask must be used to group them in the access list. A network address mask of 255.255.255.255 restricts an access list entry so that it applies only to the specific IP address identified in the entry. A network address mask of 255.255.255.0 applies an access list entry to any client on the same subnet as the IP address identified in the entry. Other network address masks may also be used, depending on your network structure. For example, if you want two clients with IP addresses of 192.168.1.134 and 192.168.1.65 to share the same access permissions, and there are no other clients on the same subnet, you can group them in the access list by setting the IP address for a single entry as 192.168.1.x and the network address mask to 255.255.255.0. For each IP address or group of IP addresses, you can set the access level, the protocols the client can use to access the communication module, and the network ports the client can use to access the communication module. What Are Access Levels? There are three levels of access: • Deny Access: Prevents all access to resources provided by the communication module. Connections to the Trident are not allowed. • Read Only: Allows client to connect to the Trident or Tri-GP, and view information provided via the communication module. Does not allow the client to change any settings or perform certain commands. • Read/Write: Full access. Allows client to view information provided by the communication module, change settings, and perform all commands (including Download Changes or Download All for TriStation 1131). Access levels are configured by adding entries to the access control list. A maximum of 10 entries can be provided in the access list. The same access level is applied to all selected protocols in a single access control list entry. If you want to provide different access levels for a selected client depending on which protocol they are using, you will need to create two separate entries in the access control list, one for each protocol. Access levels apply to all users using the PC assigned the IP address entered in the access control list. This means if multiple users are using the same PC, they will all have the same access rights. For example, every user using TriStation 1131 on a PC with a particular IP address would have the same access rights to the communication module. Individual user access should be controlled via workstation security; communication module access is controlled only at the IP address level. TriStation 1131 Developer’s Guide, 4.14.0 592 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 CAUTION Once you enable client access control by selecting the Enable Access List check box, you must configure at least one client with TriStation Read/Write access before you can save the configuration. This ensures you will be able to connect to the Trident or Tri-GP again after your next download, and allows you to make further changes to the application running on the controller, including changes to the access control list. If necessary, you can also connect via a TriStation serial connection to reconfigure the access control list. See Connecting to the Trident or Tri-GP Controller via a Serial Connection on page 568. Note If you are using the TSAA and/or TriStation protocols, you must enable and use access list control to manage read/write access to specific ports. If you are using the serial and/or Modbus TCP protocols, you can also use the Port Write Enabled property to manage read/write access to specific ports. See Port Write Enabled on page 786. Sample Access Control List and Resulting Access Control The following table is a sample access control list, with the access control scenarios that would result if enabled on a Trident or Tri-GP 3.x CIM. TriStation 1131 Developer’s Guide, 4.14.0 Table 47 Sample Trident or Tri-GP CIM Access Control List Entry IP Address Subnet Mask Protocol Network Access Level Resulting Access Control Scenario 1 206.216.1.12 255.255.255.0 TriStation NET 2 Read/Write A client with an IP address of 206.216.1.12 (or any client on the same subnet) attempting to access the CIM using the TriStation protocol on NET 2 would be granted Read/Write access. 2 206.216.1.12 255.255.255.0 TSAA NET 1 Read Only A client with an IP address of 206.216.1.12 (or any client on the same subnet) attempting to access the CIM using the TSAA protocol on NET 1 would be granted Read Only access. 3 192.168.1.05 255.255.255.255 TriStation NET 1 NET 2 Deny Access A client with an IP address of 192.168.1.05 attempting to access the CIM using the TriStation protocol on NET 1 or NET 2 would be denied access. 4 192.168.1.09 255.255.255.255 TSAA Deny Access OPC UA NET 1 NET 2 A client with an IP address of 192.168.1.09 attempting to access the CIM using TSAA or OPC UA on NET 1 or NET 2 would be denied access. 192.168.1.05 255.255.255.0 TriStation NET 2 Read Only A client with an IP address of 192.168.1.05 (or any client on the same subnet) attempting to access the CIM using TriStation on NET 2 would be granted Read Only access.a 6 192.168.1.05 255.255.255.0 TSAA NET 2 Read Only A client with an IP address of 192.168.1.05 (or any client on the same subnet) attempting to access the CIM using the TSAA protocol on NET 2 would be granted Read Only access. b 7 192.168.1.09 255.255.255.0 TriStation NET 2 Read/Write A client with an IP address of 192.168.1.09 (or any client on the same subnet) attempting to access the CIM using TriStation, TSAA, or OPC UA on NET 2 would be granted Read/Write access. TSAA 8 0.0.0.0 0.0.0.0 All All Deny Access Access is denied for all IP addresses not included in entries 1–7, using any protocol on NET 1 or NET 2. 9 NULL NULL NULL NULL NULL None a. If a client with the specific IP address of 192.168.1.05 attempts to access the CIM using the TriStation protocol on NET 2, the CIM will deny access. This is because the CIM evaluates the access control list beginning from the top, and continuing through the list until it encounters an entry that applies to the IP address requesting access. In this case, entry 3 specifically denies access to a client with the IP address of 192.168.1.05, so the CIM will deny access and not evaluate the list any further. b. If a client with the specific IP address of 192.168.1.05 attempts to access the CIM using the TSAA protocol on NET 2, the CIM will deny access. In this case, entry 4 specifically denies access to a client with the IP address of 192.168.1.05, so the CIM will deny access and not evaluate the list any further. 593 TriStation 1131 Developer’s Guide, 4.14.0 OPC UA Controlling Access to the CM or CIM 5 594 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 Configuring the Access Control List This section describes how to enable access control on the CM or CIM and configure the access control list for your selected clients. This does not apply to Trident 1.x systems. When configuring the access control list, take care to organize your entries so that the most specific are at the top, and the least specific are at the bottom. The last entry in the list should be used to define the access level for unspecified clients. The communication module evaluates the access control list from top (Entry 1) to bottom (Entry 10). The first match that the communication module makes (between the client’s network parameters and those listed in an access control list entry) determines which entry is used to authorize or deny access. If no match is found, the communication module automatically denies all access. Once you have enabled access control and configured the access control list, you must perform a Download Changes for the access control to take effect. Note After a Download Changes or Download All has been performed so that access control on the communication module is enabled, all existing connections will remain connected, even if the client’s access has been changed to Read Only or Deny Access. The new access levels will not take effect until the client disconnects and attempts to reconnect. Procedure 1 Expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CM or CIM, and then click Setup in the Item Properties dialog box. The CM Setup or CIM Setup dialog box appears. TriStation 1131 Developer’s Guide, 4.14.0 Controlling Access to the CM or CIM 3 Click the Access List tab. 4 Specify these properties. Property Action Slot Selection Select the slot where the module you want to configure an access control list for is installed. 595 In most cases, you should create identical access control lists for the modules in both slots. Enable Access List Command Click to enable access control for this communication module. If cleared, access control will be disabled and all users can access communication module resources. The default is cleared. Client Access List Click on the entry for the client you want to configure or change. Client IP Address Specify the IP address of the client that you want to allow, restrict, or deny access to the communication module. Can be used in conjunction with the Client IP Subnet Mask property to create groups of IP addresses with the same access levels. TriStation 1131 Developer’s Guide, 4.14.0 596 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 Property Action Client IP Subnet Mask This property allows you to group IP addresses, so that you can create a single entry in the access control list for all IP addresses on the subnet. If needed, enter the IP address for the subnet. The default is 255.255.255.0, which selects all client IP addresses on the subnet. To select only one client IP address, set the IP address of the subnet to 255.255.255.255. Permission Click the level of access to the communication module you want to provide for the selected client. If the application includes safety-critical outputs, you should not set this property to Read/Write. Note: Read Only is not supported for OPC UA on the Trident/Tri-GP CIM. Protocol Select the protocol(s) that the selected client can use to access the communication module. Network Select the network(s) on which the selected client can access the communication module. 5 Click Update Client Entry to save the settings for the selected client. 6 Repeat steps 4 and 5 for each client to be included in the access control list. Note 7 8 If necessary, click Reset Client Entry to reset the settings for the selected client to the default, unconfigured state. Click Reset All to reset all entries in the access control list to the default, unconfigured state. If a communication module is installed in the right slot, do one of the following: • In most cases, you should configure identical access control lists for the modules in both slots. To do so, click Copy Current Setup to Other Slot. • To configured different access control lists for the modules in the right and left slots, repeat steps 4 through 6 for the module installed in the right slot. Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Controller Printing 597 Configuring Trident or Tri-GP Controller Printing A Trident or Tri-GP controller can print brief ASCII text messages if a communication port is connected to a printer and the TriStation 1131 application includes standard print function blocks. Print messages are typically used for alarms, status, and maintenance. A sample alarm message might include the name of an analog input point, its time stamp and value, and a statement that the value is out of range. If the Trident or Tri-GP system includes numerous controllers or is connected to a DCS, alarms are typically displayed on an operator workstation. To print from a Trident or Tri-GP controller, you must connect a communication module network port to a print server that is connected to a printer; configure these devices in the TriStation 1131 project; and use print function blocks in the TriStation 1131 application. Topics include: • Effect of Printing on Scan Time on page 597 • Devices for Trident or Tri-GP Controller Printing on page 598 • Directly Connecting a Trident or Tri-GP CM or CIM to Printing Devices on page 599 • Connecting a Trident or Tri-GP CM or CIM to Printing Devices Using a Hub on page 600 • Configuring a Trident or Tri-GP CM or CIM for Printing Devices on page 601About Function Blocks for Printing on page 604 Effect of Printing on Scan Time Each time a message is printed, the print function blocks in the TriStation 1131 application are executed and the scan time increases. Typically, the print function blocks are subject to conditional execution, which means they are not executed every scan. When you set the scan time in TriStation 1131, make sure it includes the execution time for all conditional statements in the application. If the scan time is not long enough, the execution of all conditional statements (when the conditions are True) could result in scan-time overruns. You can minimize this problem by limiting the amount of printer output. An alternative is to use a PC event logger such as the Triconex SOE Recorder. For more information, see the SOE Recorder User’s Guide. TriStation 1131 Developer’s Guide, 4.14.0 598 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 Devices for Trident or Tri-GP Controller Printing At a minimum, the printing devices you can use with a Trident or Tri-GP controller are an HP JetDirect®-compatible print server and a line printer for ASCII text. You can also use a router or a hub. Print Server and Cables A print server that is connected to a Trident or Tri-GP communication module must use the HP JetDirect print protocol and operate at speeds of 10 or 100 megabits per second. Standard communication cables are suitable for this connection. You can purchase communication cables from other manufacturers. You must purchase print servers elsewhere because Invensys does not supply them. Black-box cables and HewlettPackard® print servers are examples of dependable network printing devices. Invensys has tested these Hewlett-Packard print servers and can recommend them. • HP JetDirect Ex Plus • HP JetDirect 500X Series, model J3265A Printers You must select a printer that is compatible with your print server. The Trident or Tri-GP controller prints ASCII text only, which does not include formatting or graphics, so a Centronics-compatible printer is adequate. Laser printers are also suitable. For more information, see the Communication Guide for Trident Systems. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Controller Printing 599 Directly Connecting a Trident or Tri-GP CM or CIM to Printing Devices This procedure explains how to directly connect a Trident or Tri-GP communication module (CM or CIM) to an HP JetDirect-compatible print server and printer. You can use standard communication cables for these connections. Procedure 1 If the print server and printer packages have installation programs, install them on the TriStation PC. 2 Follow the instructions, and run the diagnostic routines if available. You do not need the printer drivers that came with the packages. 3 Connect the printer to the print server, and connect the print server to a CM/CIM Ethernet port (NET 1 or NET 2). Trident or Tri-GP Controller HP JetDirect-Compatible Print Server Centronics-Compatible Printer Standard Printer Cable Ethernet Cross-Over Cable Figure 43 Connecting a Trident or Tri-GP Communication Module to a Printer and Print Server TriStation 1131 Developer’s Guide, 4.14.0 600 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 Connecting a Trident or Tri-GP CM or CIM to Printing Devices Using a Hub This procedure explains how to connect a Trident or Tri-GP communication module (CM or CIM) to an HP JetDirect-compatible print server and printer by using a hub. You can use standard communication cables for these connections. You do not need to install the printer drivers that may have come with the print server and printer packages. Procedure 1 If the print server and printer packages have installation programs, copy the programs to the TriStation PC. 2 Follow the instructions that came with the packages, and run the diagnostic routines, if available. 3 Connect the printer to the print server, and connect the print server to a hub. Connect the hub to a CM/CIM Ethernet port (NET 1 or NET 2). Trident or Tri-GP Controller HP JetDirect-Compatible Print Server Centronics-Compatible Printer Ethernet Cable Standard Printer Cable Ethernet Cable Ethernet Hub COAX 1X 8X MDI MDIX POWER 16 10BASE-T 9X Other Network Connections Figure 44 Connecting the Trident or Tri-GP CM/CIM to a Print Server and Printer Using a Hub TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Controller Printing 601 Configuring a Trident or Tri-GP CM or CIM for Printing Devices These procedures explain how to configure a Trident or Tri-GP CM or CIM port that is connected to a print server and printer. Network port configuration options differ depending on the target system version configured for the project. Use the procedure that applies to your Trident or Tri-GP system version: • Procedure for Trident 1.x Controllers on page 601 • Procedure for Trident or Tri-GP 2.x/3.x Controllers on page 603 For more information about the target system version, see Configuring the Trident or Tri-GP Target System Version on page 443. Procedure for Trident 1.x Controllers 1 Expand the Controller tree, and double-click Configuration. 2 On the Configuration tree, expand Hardware Allocation, double-click CM (COM: CM), and then click Setup. TriStation 1131 Developer’s Guide, 4.14.0 602 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 3 Specify these properties on the CM Setup Network tab. Property Action Slot Selection Select Left Slot or Right Slot depending on where the CM is installed on the baseplate. Mode For the NET 1 or NET 2 port, whichever is connected to the printer, select the Open Network mode. 4 Click the Printer tab. 5 Specify these properties on the CM Setup Printer tab. Property Action Not Configured or Configured Select Configured for the slot in which the CM is installed. Printer Number Enter a number from 1 to 10. This must be the same number that is declared for the PRINTER parameter in print function blocks. Tagname Editor > Point Assignment tab Enter the maximum printable line width for your printer, based on the manufacturer’s specifications. TCP Port Number Enter the TCP/IP Port number that was defined by the manufacturer of the print server. IP Address Enter the 32-bit IP address of the print server on the network. The most typical line widths are 80 characters and 132 characters. If the print server is not on the same subnet as the controller, you must specify the destination address on the Routing tab of the CM Setup dialog box. 6 Click OK to save the configuration. TriStation 1131 Developer’s Guide, 4.14.0 Configuring Trident or Tri-GP Controller Printing 603 Procedure for Trident or Tri-GP 2.x/3.x Controllers 1 In TriStation 1131, open your project, expand the Controller tree, double-click Configuration, and expand Hardware Allocation. 2 Double-click the CM or CIM, and then click Setup in the Item Properties dialog box. The CM Setup or CIM Setup dialog box appears. 3 Click the Printer tab. 4 Specify these properties for the module installed in the Left Slot. Property Action Printer Number Enter the number for the printer; can only be 5 or 10. Both slots cannot have the same printer number. The default is 0, meaning a printer is not configured. This must be the same number that is declared for the PRINTER parameter in print function blocks. Tagname Editor > Point Assignment tab Enter the number of characters to be printed on a line. The valid range is 80–132 characters. The default is 80 characters. TCP Port Number Enter the number of the TCP port for the print server. The default is 9100 for an HP printer. Network Click the network that the print server is connected to. The default is NET 1. IP Address Enter the IP address of the print server. TriStation 1131 Developer’s Guide, 4.14.0 604 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 5 If a module is also installed in the right slot, repeat step 4 for that module. 6 Click OK to save the configuration. About Function Blocks for Printing A TriStation 1131 application must use print function blocks to send messages to a printer. Each print function block has a PRINTER parameter which specifies the port number where the printer cable is connected. • For the Trident 1.x controller, the valid range is 1 through 10. • For the Trident or Tri-GP 2.x/3.x controller, the PRINTER parameter must be 5 or 10. The Left and Right CM/CIM ports cannot have the same PRINTER parameter. • The PRINTER parameter must be the same number as is defined in TriStation 1131. Each time a message is printed, the print function blocks in the TriStation 1131 application are executed and the scan time increases. This table lists the print function blocks in the Trident/Tri-GP library. Print Function Block Purpose PRINT_BOOL Prints a three-character field containing either Off or On. PRINT_CDT Prints the current date and time. PRINT_CRLF Prints a new line (carriage return and line feed). PRINT_CTOD Prints the current time of day. PRINT_DINT Prints a DINT value. PRINT_REAL Prints a REAL value. PRINT_STRING Prints a string of text. PRINTR_FLUSH Clears the print buffer. See the TriStation 1131 Libraries Reference for more detailed information about the print function blocks. TriStation 1131 Developer’s Guide, 4.14.0 Setting Trident or Tri-GP Controller IP Addresses 605 Setting Trident or Tri-GP Controller IP Addresses When communication between a TriStation PC and a Trident or Tri-GP controller occurs over a network, the IP address of the controller must be specified on the communication module. If the controller is not part of a larger network, it may be possible to use the default IP address set when the TriStation 1131 project is downloaded (assuming the correct node number and default IP address are specified in the project). Note The Trident or Tri-GP 2.x/3.x default IP address applies to the Left MP only. See Connecting to the Trident or Tri-GP 2.x/3.x Controller for the First Time on page 567 for more information. If you cannot use a default address, there are other ways to set an IP address on a network. All begin with asking the network administrator for the intended IP addresses. The easiest way is to use a Reverse ARP (RARP) server that has been programmed in advance with the intended addresses. Other ways include temporary connection of the TriStation PC to a non-Ethernet module during downloading. All the procedures for setting the IP address are based on the assumption that the controller includes at least one communication module with an Ethernet port connected to a network. To use the procedures, you should know how to: • Connect the Trident or Tri-GP controller to a network • Connect the TriStation PC to the controller • Configure the TriStation 1131 project with the node number of the controller and the IP address For more information, see the Communication Guide for Trident Systems. Note Typically, Triconex controllers are located on their own subnet which is connected to a larger network such as a DCS. Your network administrator can set up the subnet for compatibility with the Triconex default IP addresses and can program any routers that lie between the DCS and the Triconex subnet with addressing information about the Triconex controllers. Topics include: • Using the Default IP Address for TriStation Communication on page 606 • Setting an IP Address Using a RARP Server on page 608 • Setting a Trident or Tri-GP Controller IP Address Using an MP Connection on page 609 • Setting a Trident 1.x Controller IP Address Using a CM Connection on page 610 • Specifying a Trident or Tri-GP CM/CIM Default Gateway on page 611 • Specifying a Trident or Tri-GP CM/CIM for Network Routing on page 612 • Testing a Network Connection on page 612 TriStation 1131 Developer’s Guide, 4.14.0 606 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 Using the Default IP Address for TriStation Communication This procedure explains how to use the default IP address for network communication between a controller and a TriStation PC. Note If you have a Trident or Tri-GP 2.x/3.x controller, the default IP address applies only to the Left MP network port. See Connecting to the Trident or Tri-GP 2.x/3.x Controller for the First Time on page 567 for more information. Procedure 1 Do one of the following, depending on your Trident or Tri-GP system version: • Connect the Trident 1.x controller to the network using the NET 1 or NET 2 port on the CM. • Connect the Trident or Tri-GP 2.x/3.x controller to the network using the Left MP network port. 2 Power up the controller. 3 Do one of the following, depending on your Trident or Tri-GP system version: • Connect the TriStation PC to the network (all versions) • Connect the TriStation PC directly to an Ethernet port on the CM using a cross-over cable (Trident 1.x) • Connect the TriStation PC to the Left MP network port using a cross-over cable (Trident or Tri-GP 2.x/3.x) 4 In the TriStation 1131 project, expand the Controller tree, double-click Configuration, and then click TriStation Communication. 5 On the TriStation Communication screen, verify the IP Address is: • 192.168.1.1 (Trident 1.x CM NET 1) • 192.168.2.2 (Trident 1.x CM NET 2) • 192.168.255.n, where n is the node number of the controller (Trident or Tri-GP 2.x/3.x Left MP) If the Trident 1.x controller includes two communication modules, the default address applies to both modules. Note The Left CM and Right CM use the same 48-bit physical MAC address and cannot be connected to the same network. 6 On the Controller tree, click Configuration. 7 Expand Hardware Allocation, and then do one of the following: • (Trident 1.x) Click the slot where the communication module is installed, and then click Setup. If a communication module is not installed, insert a communication module, and then click Setup. • (Trident or Tri-GP 2.x/3.x) Double-click the MP, click Setup, and then click the Network Ports tab. TriStation 1131 Developer’s Guide, 4.14.0 Setting Trident or Tri-GP Controller IP Addresses 8 607 In the Setup dialog box, enter the same IP address specified on the TriStation Communication screen. If the Trident 1.x controller includes a redundant communication module, enter the same IP address for the other slot. 9 10 On the Controller tree, click the Controller Panel. From the Commands menu, click Connect. Wait about 40 seconds for the module to reset and become active. When the module is active, the Active indicator is green. 11 On the Commands menu, click Download All to download the TriStation 1131 project to the controller. 12 On the TriStation PC, from the Start menu, click the MS-DOS Command Prompt. 13 Type the command ping followed by the IP address to be tested. For example, for an IP address of 206.32.216.43, enter this: ping 206.32.216.43 If the network connection is made, the reply includes the IP address followed by byte and time information. If the connection is not okay, the reply is Request timed out. Note If you receive a Request timed out reply, check your network cable and port connections to verify they are securely connected, verify your configuration settings are correct, and then retry the ping command. TriStation 1131 Developer’s Guide, 4.14.0 608 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 Setting an IP Address Using a RARP Server This procedure explains how to set the IP address of a communication module using a RARP server on the local network. To use this procedure, the network administrator must program the RARP server with the intended IP address for the controller. If this is not possible, use another method to set the IP address. Procedure 1 Give the network administrator the MAC address, which is: 40-00-00-00-x-03 (where x is the Trident or Tri-GP controller node number). 2 Ask the network administrator for the IP address that is to be used for the controller. 3 Connect the controller to the network through a network port on the communication module. 4 Power up the controller. During initialization, the communication module sends a request to the RARP server for an IP address that has been mapped to its own 48-bit MAC address. Note The Left CM and Right CM use the same 48-bit physical MAC address and cannot be connected to the same network. 5 On the TriStation PC, from the Start menu, click the MS-DOS Command Prompt. 6 Enter the command ping followed by the IP address to be tested. For example, for an IP address of 206.32.216.43, enter this: ping 206.32.216.43 If the network connection is made, the reply includes the IP address followed by byte and time information. If the connection is not okay, the reply is Request timed out. Note If you receive a Request timed out reply, check your network cable and port connections to verify they are securely connected, verify your configuration settings are correct, and then retry the ping command. 7 Connect the TriStation PC to the network, or directly to a network port on the CM or CIM. 8 In the TriStation 1131 project, expand the Controller tree, click Configuration, and then click TriStation Communication. 9 On the TriStation Communication screen, specify the Node Number of the controller and the intended IP address. 10 On the Commands menu, click Connect. Wait until the connection is made. 11 On the Commands menu, click Download All to download the TriStation 1131 project to the controller. TriStation 1131 Developer’s Guide, 4.14.0 Setting Trident or Tri-GP Controller IP Addresses 609 Setting a Trident or Tri-GP Controller IP Address Using an MP Connection This procedure explains how to set the IP address of the Trident or Tri-GP controller by initially connecting the TriStation PC to an MP port and downloading the TriStation 1131 project. After the address is set, you can disconnect the TriStation PC from the MP port, and reconnect it to a network port on the CM or CIM. Note If you have a Trident or Tri-GP 2.x/3.x controller, the default IP address applies only to the Left MP network port. See Connecting to the Trident or Tri-GP 2.x/3.x Controller for the First Time on page 567 for more information. Procedure 1 Ask the network administrator for the IP address to be used for the controller. 2 Connect the TriStation PC to a TriStation port on the MP Baseplate. 3 Connect the controller to the network through a network port on the CM or CIM. 4 In the TriStation 1131 project, configure the following: • The MP and CM/CIM ports • The node name and node number of the controller • The intended IP address 5 Power up the controller. 6 On the Controller tree, click Controller Panel. 7 On the Command menu, click Connect To. 8 On the Connect To screen, click Main Processor Module Port and Left, Middle, or Right for the MP port to which the TriStation 1131 cable is connected. 9 After connecting to the controller, download the TriStation 1131 project. The CM initializes (resets) and accepts the IP address you specified in the TriStation 1131 project. 10 On the TriStation PC, from the Start menu, click the MS-DOS Command Prompt. 11 Enter the command ping followed by the IP address to be tested. For example, for an IP address of 206.32.216.43, enter this: ping 206.32.216.43 If the network connection is made, the reply includes the IP address followed by byte and time information. If the connection is not okay, the reply is Request timed out. 12 If the IP address is set, you can disconnect the TriStation PC from the MP port, and connect it to a network port on the CM/CIM or to the network. TriStation 1131 Developer’s Guide, 4.14.0 610 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 Setting a Trident 1.x Controller IP Address Using a CM Connection This procedure explains how to set the IP address for a Trident 1.x CM by temporarily configuring a default IP address for the CM, and assigning a default IP address to the TriStation PC. Procedure 1 Ask the network administrator for the IP address to be used for the CM. 2 Connect the Trident controller to the network using a network port (NET 1 or NET 2) on the CM. 3 Connect the TriStation PC to a network port on the CM, using a direct or network connection. 4 On the TriStation PC, use Windows procedures to set the IP address of the PC to either of the following: • 192.168.1.x if the PC is physically connected to a NET 1 port, where x is any unused host number. • 192.168.2.x if the PC is physically connected to a NET 2 port, where x is any unused host number. 5 Wait for the TriStation PC to reset. 6 Open the TriStation 1131 project. 7 Expand the Configuration tree, click Configuration, and then click TriStation Communication. 8 Specify the node name, node number, and the default IP address of the controller. 9 Use the Network tab on the CM Setup screen to specify the intended IP address for the Ethernet port that is connected to the network. 10 Power up the Trident controller. 11 On the Controller tree, click Controller Panel. On the Command menu, click Connect To. 12 On the Connect To screen, click the Serial Port option and the COM port to which the TriStation 1131 cable is connected. 13 Verify that Communication Module Port is selected and the default IP address is displayed. 14 Connect to the controller and download the TriStation 1131 project. Wait for the download to complete. After the download is complete, TriStation 1131 displays the message, Connection failed. The default IP address you specified in the node definition is invalid, and the intended IP address of the CM is set. 15 On the TriStation PC, use Windows procedures to set the IP address of the PC to its actual address on the network. 16 On the TriStation PC, from the Start menu, click the MS-DOS Command Prompt. 17 Enter the command ping followed by the IP address to be tested. TriStation 1131 Developer’s Guide, 4.14.0 Setting Trident or Tri-GP Controller IP Addresses 611 For example, for an IP address of 206.32.216.43, enter this: ping 206.32.216.43 If the network connection is made, the reply includes the IP address followed by byte and time information. If the connection is not okay, the reply is Request timed out. 18 In the TriStation 1131 project, change the default IP address to the newly set IP address of the TriStation Communication screen. 19 Use the Controller Panel to reconnect the TriStation 1131 project to the controller. 20 After the IP address is set on the network, you must reconfigure the IP address in the TriStation 1131 project, and assign a valid IP address to the TriStation PC. Specifying a Trident or Tri-GP CM/CIM Default Gateway This procedure explains how to set the address of a default gateway for a controller that must communicate with devices on another network. A default gateway is a router that forwards all messages not addressed to stations within the local subnet. Procedure 1 Expand the Controller tree and double-click Configuration. 2 On the Configuration tree, click Hardware Allocation to display the modules that are configured for this system. 3 Double-click the CM or CIM icon to open the Properties dialog box, and click Setup to display the configuration options for the CM or CIM. 4 On the Network tab, select Left Slot or Right Slot depending on which CM or CIM you are configuring. 5 Do one of the following: • If you have a Trident 1.x controller, for NET 1 or NET 2 (depending on which one is connected the network), select Open Network from the list under Mode. • If you have a Trident or Tri-GP 2.x/3.x controller, go to the next step. 6 In Default Gateway IP Address, enter the IP address of the default gateway that is connected to the local subnet. 7 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 612 Chapter 6 Trident and Tri-GP Communication with TriStation 1131 Specifying a Trident or Tri-GP CM/CIM for Network Routing This procedure explains how to specify routes to destinations outside the local network for controllers that do not have access to a default gateway. Each route must include an IP address for the destination, a subnet mask, and a gateway address. Procedure 1 Expand the Controller tree and double-click Configuration. 2 On the Configuration tree, click Hardware Allocation to display the modules that are configured for this system. 3 Double-click the CM or CIM icon to open the Properties dialog box, and click Setup to display the configuration options for the CM or CIM. 4 Do one of the following: 5 • For a Trident or Tri-GP 2.x/3.x controller, click the Routing tab. For each route you need to specify, enter an IP address in Destination IP Address, Destination IP Subnet Mask, and Destination Gateway IP Address, and then click Update Destination. • For a Trident 1.x controller, click the Routing tab and enter an IP address under Destination Address, Subnet Mask, and Gateway Address for each route that you need to specify. Click OK to save your changes. Testing a Network Connection This procedure explains how to test a connection from a CM or CIM to a network by using the ping command from an MS-DOS command prompt. The test is performed on the TriStation PC. Before doing the test, you must have set the IP address of the communication module on the network. Procedure 1 On the TriStation PC, from the Start menu, click the MS-DOS Command Prompt. 2 Type the command ping followed by the IP address to be tested. For example, for an IP address of 206.32.216.43, enter this: ping 206.32.216.43 If the network connection is made, the reply includes the IP address followed by byte and time information. If the connection is not okay, the reply is Request timed out. TriStation 1131 Developer’s Guide, 4.14.0 7 Implementation Overview 614 Controlling the Operational Mode 616 Using the Triconex Emulator for Testing 617 Controller Testing 618 Maintenance 635 TriStation 1131 Developer’s Guide, 4.14.0 614 Chapter 7 Implementation Overview This figure shows the main steps for implementing an application, which is the last step in a TriStation 1131 project. Set Up the Project Develop the Application Test with the Emulator Fix Errors Yes Errors? No C onfigure the C ontroller Set Up TriStation C ommunication - Test application on emulator Implement on the C ontroller - Test application on offline system - C ommission the application - Maintain the application TriStation 1131 Developer’s Guide, 4.14.0 Overview 615 Implementation Steps This list includes steps for testing and maintaining an application. Step Test on the Emulator See • Using the Triconex Emulator for Testing on page 617 • The Triconex Emulator User’s Guide. Test on the controller • Preparing to Download to the Controller on page 618 • Downloading to the Controller on page 620 • Verifying the Download to the Controller on page 623 • Monitoring Variables on the Controller on page 627 • Monitoring the Program Execution on page 628 • Adding Annotation for Variables on page 629 • Determining the Scan Surplus on page 631 • Setting the Scan Time for a Downloaded Application on page 632 • Displaying Hardware Allocation Exceptions on page 634 Maintain an application • Steps for Downloading Changes on page 636 • Planning and Controlling Changes on page 637 • Commands Required with Application Changes on page 638 • Disabling Points on page 640 • Forcing Points on page 644 • Using the Download Changes Command on page 646 • Using the Download All Command on page 649 TriStation 1131 Developer’s Guide, 4.14.0 616 Chapter 7 Implementation Controlling the Operational Mode This section describes the operational modes available on a controller. Although the functionality is the same for Tricon, Trident, and Tri-GP controllers, the method of executing the mode may be different. This table describes the mode and method. Table 48 Tricon, Trident, and Tri-GP Controller Operational Modes Mode Description Run Controller runs the downloaded application with read-only capability. Attempts to write to program variables by TriStation 1131, Modbus masters, or external devices are rejected; however, an application may call gated access functions to enable external writes during a designated window of time. For more information, see the GATDIS and GATENB function blocks in the TriStation 1131 Libraries Reference. • For Tricon controllers, the keyswitch must be set to RUN and the Run command used. • For Trident and Tri-GP controllers, the Run command must be used and the Set Programming Mode option must be set to Disable Programming Control Operations. Program Controller allows application loading, verification, and write access. Allows Download All and Download Changes commands from TriStation 1131. Also allows writes to program variables by Modbus masters and external devices. • For Tricon controllers, the keyswitch must be set to PROGRAM. • For Trident and Tri-GP controllers, the Set Programming Mode option must be set to Enable Programming and Control Operations. (This is the default setting.) Halt Controller stops running the application and retains the values of tagnames. • For Tricon controllers, the Halt command is used. • For Trident and Tri-GP controllers, the Halt command or the SYS_APP_HALT function can be used. Stop Controller stops reading inputs, forces non-retentive digital and analog outputs to zero, and halts the application. Retentive outputs return to the value they had before the Stop was issued. Stop mode is recommended for installation and service of process-related equipment, but is not required for service of the controller. • For Tricon controllers, the keyswitch must be set to STOP. • For Trident and Tri-GP controllers, the Stop command must be used. Remote Controller runs the downloaded application and allows writes to program variables by TriStation 1131, Modbus masters, and external devices. Download All and Download Changes by TriStation 1131 are not allowed. • For Tricon controllers, the keyswitch must be set to REMOTE. • For Trident and Tri-GP controllers, Remote mode is set programmatically by enabling write access using the SYS_SET_REMOTE_WRT_ENBL function block in a program. TriStation 1131 Developer’s Guide, 4.14.0 Using the Triconex Emulator for Testing 617 Using the Triconex Emulator for Testing The Triconex Emulator software allows you to emulate, execute, and test TriStation 1131 applications without connecting to a Tricon, Trident, or Tri-GP controller. Using the Emulator, you can test your applications in an offline environment, without exposing your online processes to potential application errors. The latest version of the Emulator is installed with TriStation 1131; however, because the Emulator is a separate application from TriStation 1131, you can update it at any time without having to re-install TriStation 1131. You access the Emulator via the Emulator Control Panel in TriStation 1131. Using the Emulator, you can emulate the following Triconex controller modules, communication modes, and TriStation 1131 application features: • Tricon Communication Module (TCM) • Tricon Unified Communication Module (UCM) • Trident or Tri-GP Communication Module (CM) • Trident or Tri-GP Communications Integration Module (CIM) • TSAA protocol communication, including support for DDE and SOE clients, and multicasting (DDE clients only) • Sequence of Events (SOE) blocks, data generation, and response • Modbus TCP Master and Slave communication • Standard and Enhanced Peer-to-Peer communication over UDP • Process alarm function blocks • System status function blocks for MP and I/O modules, including system state transitions • Disabling of points • Download Changes and Download All commands WARNING Do not have the Emulator Control Panel open at the same time as you are connected to a controller. Connecting to both the Emulator and a controller simultaneously could result in commands meant for the Emulator being sent to the controller, or vice-versa. For detailed information and instructions for testing your application using the Triconex Emulator, see the Triconex Emulator User’s Guide, included on the TriStation 1131 CD, or available from the Global Customer Support website. TriStation 1131 Developer’s Guide, 4.14.0 618 Chapter 7 Implementation Controller Testing This section explains how to test on the controller, which is usually done when the controller is physically connected to field instruments either in a test facility that simulates the system (Factory Acceptance Test), or at the site while the control process is offline (Site Acceptance Test). The logical hardware configuration in TriStation 1131 must be completed and must match the physical configuration. Topics include: • Downloading to the Controller on page 620 • Verifying the Download to the Controller on page 623 • Monitoring Variables on the Controller on page 627 • Monitoring the Program Execution on page 628 • Adding Annotation for Variables on page 629 • Determining the Scan Surplus on page 631 • Setting the Scan Time for a Downloaded Application on page 632 • Displaying Hardware Allocation Exceptions on page 634 Preparing to Download to the Controller The Download All command is used to load an application to the controller. Before you begin the download process, please take note of the following: • You can connect up to three instances of TriStation 1131 to the controller, depending on the TriStation 1131 versions that are open. These instances can be open on the same PC or multiple PCs. For more information on version-specific details, see Using Multiple Instances of TriStation 1131 on page 12. While you can connect up to three instances to the same controller at once, you cannot simultaneously download to the controller from all three at once. • The first time you connect to the Trident 2.x/3.x or Tri-GP controller to download your application, you must connect either via a serial connection or via the Left MP, using the default IP address. See Connecting to the Trident or Tri-GP 2.x/3.x Controller for the First Time on page 567 for more information. • If the model number of the MPs configured for the project does not match the model number of the MPs installed in the Tricon controller you are trying to connect to, you will be unable to connect to the controller. The model number of the MPs specified in the project must be the same as the MPs installed in your controller. If necessary, change the MPs configured in the project to match the controller’s MPs. • If the chassis type configured for the project does not match the chassis type of the Tricon controller you are trying to connect to, you will be unable to connect to the controller. The chassis type specified in the project must be the same as the chassis type used by your controller. If necessary, change the chassis configured in the project to match the controller’s chassis; see Replacing a Tricon Main Chassis on page 360. TriStation 1131 Developer’s Guide, 4.14.0 Controller Testing • 619 If the target system version configured for the project does not match the system version of the Tricon, Trident (2.x/3.x only; does not apply to 1.x systems), or Tri-GP controller you are trying to connect to, you will be unable to connect to the controller. The target system version specified in the project must be the same as the system version of your controller. For instructions on changing the target system version in your project, see Configuring the Tricon Target System Version on page 345 or Configuring the Trident or Tri-GP Target System Version on page 443. • Performing a Download All operation will cause the CIM’s OPC UA server to temporarily cease communication and restart. Existing OPC clients will be disconnected, and will need to reconnect to the OPC UA server once the download is complete. • Before downloading, ensure that all I/O modules are configured in the project, and that the requested scan time is set to a value equal to or greater than the minimum scan time to guarantee that the controller provides a deterministic response time. At the time of the download operation, if the scan time is less than the minimum scan time, a message appears, prompting you to change the scan time to a recommended value. You cannot continue the download operation until you change the scan time to the recommended value. For information on the minimum scan time, see Determining the Minimum Scan Time on page 630. For information about viewing the minimum scan time for an application that has already been downloaded, see Setting the Scan Time for a Downloaded Application on page 632. • If a project is configured to use a connection password, and is downloaded to a controller, the password configured in the project is set on the controller. Subsequent connections to the controller are validated against this password. When you download your application to the controller for the first time, you must enter the password set on the controller by a previously downloaded application, if any, and not the password currently configured in your project. For subsequent downloads, you must enter the password configured in your project. You will not be prompted to use a password for connecting to a Tricon controller from TriStation 1131 4.13.0 or later, even if a password was previously set on the controller. When you download your application, the password set on the controller will be removed. TriStation 1131 Developer’s Guide, 4.14.0 620 Chapter 7 Implementation Downloading to the Controller This procedure explains how to use the Download All command to load an application to the controller. A best practice is to rebuild the application before downloading it. This procedure can be used for testing when the controller is connected to simulation field devices or the control process is offline. This procedure can also be used to run the application when the control process is online. Procedure 1 Open the Controller workspace, expand the Configuration tree, and double-click the Controller Panel. 2 On the Commands menu, click Connect . The Connect To dialog box shows the default communication setting. 3 If needed, change the connection type, and then click OK. For more information, see Specifying the Tricon Default Connection Type on page 541 or Specifying the Trident or Tri-GP Default Connection Type on page 589. Note If you enabled secure communication on the Trident or Tri-GP 3.x Operating Parameters screen, the default connection type will automatically use secure communication to connect to the controller if a CIM is installed. If you do not want to use secure communication for this connection, clear the Use Secure Communication check box. See Secure Communication on page 310 for more information. 4 Enter the connection password if required. 5 Do one of the following: • For Tricon controllers, ensure the keyswitch is turned to PROGRAM. This is the factory setting. • For Trident or Tri-GP controllers, ensure the mode is Enable Programming and Control Operations. This is the default setting. (To view this setting, on the TriStation 1131 Developer’s Guide, 4.14.0 Controller Testing 621 Commands menu, click Set Programming Mode, and then click Enable Programming and Control Operations.) 6 On the Commands menu, click Download All . If the scan time is less than the minimum scan time, a message appears, prompting you to change the scan time to a recommended value. You cannot continue the download operation until you have changed the scan time to the recommended value. For information on the minimum scan time, see Determining the Minimum Scan Time on page 630. If you have configured your project settings to automatically copy the project file to the controller after a download operation, a message appears, stating that the project file was successfully copied. Notes If the file was previously copied to the controller, you will be prompted to overwrite it. To view information about the file, click Properties. To proceed with the overwrite, click Yes. The time it takes for the copy operation to begin and the file to be copied to the controller depends upon the size of the application and the controller’s scan time. A copy operation for a large file with a long scan time may take several minutes (in some cases, up to an hour). If you do not want to wait for the copy operation to complete, you can cancel the automatic copy, and then manually copy the project file to the controller at a later time. For more information, see Backing Up a Project File to the Controller on page 328. 7 To start the application, click Run 8 Do one of the following: . • For Tricon controllers, turn the keyswitch to RUN (to start the program on the controller) or to REMOTE (to start the program and allow external devices to write to tagnames or aliases). • For Trident or Tri-GP controllers, set the mode to Run and disable Download commands by doing this: On the Commands menu, click Set Programming Mode, and then click Disable Programming and Control Operations. Changes to the Project Version and State After Downloading to the Controller Downloading to the controller changes the project’s downloaded version and, if a Download All was performed, its download state. Note See the Triconex Emulator User’s Guide for detailed information about the impact of downloading to the Emulator on the project’s version. TriStation 1131 Developer’s Guide, 4.14.0 622 Chapter 7 Implementation Changes to the Project’s Downloaded Version After the download to the controller is complete, the major or minor downloaded version of your project is incremented. (For example, in version 3.7, the major version is 3 and the minor version is 7.) • A Download All operation increments the major version, and resets the minor version to 0. • A Download Changes operation increments the minor version. Project version changes made due to download operations can be viewed in the Project History dialog box. See View Project History Command on page 865. Note Performing a download to the Emulator changes the downloaded version for the Emulator, but not the downloaded version for the controller. A project that has not yet been downloaded to the controller, but has been downloaded to the Emulator, will have a project version of 0.0.x, where x is the EmulatorCount value. Project Version Rules The project’s downloaded version is different for the Emulator and the controller. • The controller downloaded project version is the last version of the project file (.pt2) downloaded to the controller. The version is provided in the format major.minor (for example, in version 3.7, the major version is 3 and the minor version is 7). • The Emulator downloaded project version is the last version of the project file (.pt2) downloaded to the Emulator. The version is provided in the format major.minor.EmulatorCount (for example, in version 3.7.12, the major version is 3, the minor version is 7, and the EmulatorCount is 12). — The major.minor version is the same as the last controller downloaded project version. — The EmulatorCount value is incremented sequentially after either a Download All or a Download Changes to the Emulator. Changes to the Project Download State After a Download All to the controller is complete, the download state of the project is changed to the Download Changes state. Downloading a project to the Emulator changes the project’s downloaded version (by incrementing the EmulatorCount value), but it does not change the project’s download state. The project state displayed in the Status Bar applies only to the controller; it has no impact on the project’s ability to be downloaded to the Emulator. However, the Download Changes command will not be enabled for the Emulator until you have performed a Download All of the project on the Emulator at least once. Thus, it is possible that a project is in the Download All state for the controller, but can still be downloaded to the Emulator using the Download Changes command. TriStation 1131 Developer’s Guide, 4.14.0 Controller Testing 623 When the controller is in the Download Changes state, all rules that pertain to projects in the Download Changes state will apply (see Commands Required with Application Changes on page 638). Note Using the Change State to Download All command will change the download state for both the controller AND the Emulator to Download All. See Change State to Download All Command on page 672. Verifying the Download to the Controller Once you have downloaded your application to the controller, you may want to verify that the program elements on the controller are the same as those in the TriStation 1131 project. If any of the program elements in your application have changed since the last download, you can perform a download verification to identify the changes. You can perform this download verification manually, or you can enable automatic download verification, so that verification occurs after every Download All or Download Changes operation. Notes To enable automatic download verification, see Specifying Automatic Download Verification on page 48. If you configured your project settings to allow automatic copying of a project file after a download operation, download verification will occur only after the copy operation is complete. For more information about automatically copying a project file, see Specifying Automatic Copying of the Project File to the Controller on page 49. Before performing a download verification, you must compile all the programs in your project, and build the application before downloading it to the controller. For more information, see Building an Application on page 323. Download verification can be a useful troubleshooting tool, assisting you in determining if there are errors in specific application POUs. During the download verification process, TriStation 1131 retrieves the program elements from both the controller and the project file, and then performs a binary comparison. Each comparison results in a pass or fail status message. The following items are compared: Table 49 Download Verification Elements Verification Task Program Element Description Reasons for Download Verification Failure Program Implementation List Status Project versions Compares the project version on the controller to the project version in the project file. The application’s project version in the project file has changed since the last download. Control Program Status Control program status Compares the following control program elements: One or more program names or versions have been modified, or you have downloaded the application to a different controller, which caused a change in the download time. • Program version • Program name • Download time TriStation 1131 Developer’s Guide, 4.14.0 624 Chapter 7 Implementation Table 49 Download Verification Elements (continued) Verification Task Program Element Get Conversion Table Conversion table Compares internal application information in the controller’s conversion table to the information in the project file’s conversion table. Allocation for one or more memory points has changed. Get IO Addresses I/O address Compares the I/O point addresses on the controller to those configured in the project file. The physical addresses of one or more I/O points in the project have changed. SOE Information Verification SOE blocks Compares the SOE blocks configured in the controller to those in the project file. The tagnames assigned to one or more SOE blocks have changed, or the SOE buffer size in one or more blocks has changed. Program Verification Programs Compares each program in the project file’s Implementation list to the corresponding application on the controller. Once each individual program is compared, an overall program verification status message appears. One or more programs have been added or removed from the project file’s Implementation list. Get Module Configuration Module configuration Compares the modules configured in the controller to those in the project file’s hardware allocation. One or more I/O modules or communication modules have been added or removed. TriStation 1131 Developer’s Guide, 4.14.0 Description Reasons for Download Verification Failure Controller Testing Table 49 625 Download Verification Elements (continued) Verification Task Program Element Get Symbol Table Symbol table Reasons for Download Verification Failure Description For Tricon projects configured with TCM models 4351/4352, compares symbol table information on the controller to the information in the project file. One or more aliased tagnames in your project have changed. For Tricon projects configured with TCM models 4353/4354, and Trident projects configured with CIM models 3211/3211S2, compares OPC symbol table information on the controller to the information in the project file. Get System Variables Status System variables Compares the configured system variables on the controller to those in the project file. One or more operating parameters or hardware modules in your project have changed. Function Verification Functions Compares the function data on the controller to the functions configured in the project file. One or more functions or function blocks have been added or removed from the programs included in the Implementation list. Certificate Table Verification Certificate table Compares the certificate data on the controller with the certificate data in the project file. Applies only to Trident or Tri-GP 3.x controllers with a CIM installed. One or more certificates have been added or removed from the project file’s secure communication configuration. Procedure 1 Compile all the programs in your project and build the application, as described in Building or Rebuilding an Application on page 327. 2 Connect to the controller and download the application, as described in Preparing to Download to the Controller on page 618. 3 Once the download is complete, remain connected to the controller. 4 On the Commands menu, click Download Verifier. Note The Download Verifier command is available only while you are connected to a controller. TriStation 1131 Developer’s Guide, 4.14.0 626 Chapter 7 Implementation The verification process starts immediately and a progress bar appears. As each program element is verified, a pass/fail message appears in the Message View area. Download verification is complete when an overall “download verification pass/fail” message appears. The download verification results are also automatically displayed in the form of a Download Verification Report, which appears in a new report viewer window. Notes To save the report, click the Export button on the report viewer toolbar. This saves the report in a destination and file format you specify. For a list of supported formats, see Export Report Command on page 724. If you do not save the report, you have to run the download verification process again to view it later. You can also perform other actions in the report viewer window, including printing a report. For more information, see Viewing and Printing a Report on page 99. TriStation 1131 Developer’s Guide, 4.14.0 Controller Testing 627 Monitoring Variables on the Controller This procedure explains how to monitor and enable or disable variables while the application is running on the controller. CAUTION Monitoring and disabling variables should only be done if the controller is not connected to a live system or if maintenance is being performed. Procedure 1 Connect to the controller and download an application, as described in Preparing to Download to the Controller on page 618. 2 Drag the function blocks and variables you want to monitor to the sheet. 3 On the Commands menu, click Run Note or Single Step . When you click Single Step, the application executes for one scan only. As a result, Modbus Master and Peer-to-Peer behavior can be unpredictable when Single Step is applied. 4 To enable or disable a variable, double-click the variable and click Enable or Disable. 5 Continue testing, as needed. Note While monitoring variables on the controller, you may initially see a question mark (?), which gets automatically updated with the variable’s value after completion of the first scan. Additionally, TriStation 1131 updates variable values sequentially in batches, and if the list of variables is large, some values may appear to be slightly out-of-date during any given scan. TriStation 1131 Developer’s Guide, 4.14.0 628 Chapter 7 Implementation Monitoring the Program Execution This procedure explains how to display the program execution, which shows the program executing on the controller. Procedure 1 Connect to the controller and download an application, as described in Preparing to Download to the Controller on page 618. 2 On the controller tree, expand Programs, and click the program you want to test. 3 Click Display Program Document 4 To view the program execution, on the Commands menu, click Run . or Single Step . Note 5 When you click Single Step, the program executes for one scan only. As a result, Modbus Master and Peer-to-Peer behavior can be unpredictable when Single Step is applied. To quit running the program, click Disconnect False Value in Green . True Value in Red Figure 45 Sample Program Running on the Controller Note While monitoring the program execution, you may notice that although you have enabled color monitoring, colors are not appearing for the BOOL inputs and outputs on the logic sheet. This typically occurs when you are monitoring large programs with many tagnames. If TriStation 1131 does not have enough communications bandwidth to display all the data being sent by the controller, color monitoring will be unavailable. TriStation 1131 Developer’s Guide, 4.14.0 Controller Testing 629 Adding Annotation for Variables This procedure explains how to add an annotation to a variable, which allows you to specify information displayed while the program is executing. The annotation can include text and macros. Procedure 1 Connect to the controller and download an application, as described in Preparing to Download to the Controller on page 618. 2 On the Commands menu, click Run 3 If needed, drag variables to be tested onto the sheet. 4 Double-click a variable, and select the Annotate check box on the Variable tab. 5 Click the Annotation tab. 6 Click the Macros button to change the macro identified with the annotation. 7 To copy a macro, click the macro name and press Ctrl+C. To paste the macro, close the Edit Macros dialog box, click in the Annotation area, and press Ctrl+V. You can also enter text with the macros. 8 Continue testing, as needed . TriStation 1131 Developer’s Guide, 4.14.0 630 Chapter 7 Implementation Determining the Minimum Scan Time The minimum scan time is a value that TriStation 1131 calculates based on the hardware configuration defined in your TriStation 1131 project and information obtained from the controller. The minimum scan time is calculated as the greater of the following two values: • Minimum Application Scan Time: The application scan time is the amount of time it takes the controller to execute all the programs in the application running on the controller. This table lists the minimum to maximum application scan time range for each controller type. Controller Type Minimum Application Scan Time (milliseconds)a Maximum Application Scan Time (milliseconds)a Tricon 3006/3007 20 500 Tricon 3008/3009 (Tricon 11.1 and earlier systems) 20 450 Tricon 3008/3009 (Tricon 11.2 and later systems) 10 450 Trident or Tri-GP 10 450 a. Only the Maximum Application Scan Time is displayed in TriStation 1131. The calculated Minimum Scan Time value is also displayed. • Estimated I/O Poll Time: The maximum time needed by the controller to obtain data from input modules. The estimated I/O poll time is displayed in TriStation 1131. It is also displayed on the System Overview window in the Triconex Enhanced Diagnostic Monitor (sold separately). While building an application, or performing a Download All or a Download Changes operation, you must ensure that the requested scan time is always equal to or greater than the minimum scan time. To view the minimum scan time, do one of the following: • If the application is already running on the controller, click Set Scan Time on the Commands menu to view the minimum scan time and estimated I/O poll time. For more information, see Setting the Scan Time for a Downloaded Application on page 632. • If the application is not yet downloaded to the controller, ensure that all I/O modules are configured in the project, and then build the application with a requested scan time of 20. If the minimum scan time is greater than 20, an error message will appear, indicating the minimum scan time value. However, if the minimum scan time is 20 or less, no error is displayed, and 20 is considered as an acceptable value. Be sure to set the requested scan time to at least 20, or the recommended value in the error message, before attempting to build the application again. TriStation 1131 Developer’s Guide, 4.14.0 Controller Testing 631 Determining the Scan Surplus This section explains how to determine the scan surplus, which indicates whether the actual scan time required to execute the application uses less time or more time than the requested scan time in the project. The actual scan time will always be equal to or greater than the requested scan time. • When the actual time is equal to the requested time, the scan surplus is positive. A positive scan surplus means the scan time setting can be decreased, or you can add more programs or Peer-to-Peer nodes to your application. • When the actual time is more than the requested time, the scan surplus is negative, which means the scan time should be increased to ensure that communication errors do not occur. For more information, see Setting the Scan Time for a Downloaded Application on page 632. The calculated scan surplus is an average based on the last 100 scans. The Enhanced Diagnostic Monitor (sold separately) displays information to determine the scan surplus, including the Requested Scan Time, Actual Scan Time, and Scan Surplus for an application. For more information, see the Enhanced Diagnostic Monitor User’s Guide. Positive Scan Surplus A positive scan surplus means the application executes in less time than the requested scan time. For example, if the requested scan time is 150 milliseconds, and the actual scan time is 100 milliseconds, there is a positive scan surplus of 50 milliseconds. • If the surplus is 20 milliseconds or 10 percent of the actual scan time, do nothing. • If the surplus is greater than 20 milliseconds or 10 percent of the actual scan time, decrease the number for the scan time. In this example, the scan time could be set to 130 milliseconds. Note Even when the actual scan time is less than the requested scan time, the Actual Scan Time displayed in the Enhanced Diagnostic Monitor will always appear as the same as the Requested Scan Time. In this case, you should use the value displayed for the Scan Surplus to determine if you can reduce your requested scan time. Negative Scan Surplus A negative scan surplus means the actual scan time is greater than the requested scan time. For example, if the requested scan time is 150 milliseconds, and the actual scan time is 200 milliseconds, there is a negative scan surplus of 50 milliseconds. • If the surplus is negative, increase the number for the requested scan time by the negative amount plus 20 milliseconds. In this example, the scan time should be set to 220 milliseconds. TriStation 1131 Developer’s Guide, 4.14.0 632 Chapter 7 Implementation Scan Surplus and Process Alarms It is possible for an application to report a positive scan surplus, but to have a scan overrun (a negative scan surplus) when simultaneous process alarms are generated in a single scan. This is because the scan surplus is averaged over 100 scans. If many simultaneous alarms are generated during a single scan, then a scan overrun will occur for that scan. However, if alarms do not occur every scan, the average scan surplus may still be positive. For more information about the impact of process alarms on scan time, see Effect of Process Alarms on Scan Time on page 244. Process Safety Time Requirements You should determine the Process Safety Time (PST) required by the application. The PST is the period of time during which the process could shift from a safe operating condition to a dangerous condition. The scan time for an application should be half the PST. For example, a burner management system has a PST of 1 second, which means the scan time should be 500 milliseconds. Setting the Scan Time for a Downloaded Application This procedure explains how to set the scan time for a downloaded application running in the controller. (The Emulator does not provide real-time information on scan time.) This should be done if the scan time set in the project is less than the actual scan time required to run the application. For more information, see Determining the Scan Surplus on page 631. Ensure that the requested scan time is always greater than the minimum scan time to guarantee that the controller provides a deterministic response time. For more information on the minimum scan time, see Determining the Minimum Scan Time on page 630. Note For information about how process alarms can impact the scan time, see Effect of Process Alarms on Scan Time on page 244. If you need a faster scan time than the low end of the range, you must redesign the application or the process. Procedure 1 Connect to the controller and download an application, as described in Preparing to Download to the Controller on page 618. TriStation 1131 Developer’s Guide, 4.14.0 Controller Testing 2 On the Commands menu, click Set Scan Time. This is the Tricon 3009 screen. 3 633 This is the Trident or Tri-GP screen. Specify this property on the Set Scan Time screen. Property Action Enter the scan time in milliseconds Enter the number of milliseconds for the scan time used while the application is running in the controller. The number must be in the minimum to maximum range, and must be equal to or greater than the minimum scan time to guarantee that the controller provides a deterministic response time. • For Tricon 3006/3007, the range is 20 to 500 milliseconds. • For Tricon 3008/3009, the range is 20 to 450 milliseconds. • For Tricon 11.2 and later with 3008/3009, the range is 10 to 450 milliseconds. • For Trident or Tri-GP, the range is 10 to 450 milliseconds. This setting does not affect the requested scan time for the project. To change the requested scan time in the project, you must set the scan time on the Implementation screen. If the scan time that is set is less than the minimum scan time, a message appears, prompting you to change the scan time to a recommended value (the minimum scan time calculated by TriStation 1131). You must change the scan time to the recommended value, as you will be unable to build or download your application if the requested scan time is less than the recommended scan time. 4 Click OK to save your changes. TriStation 1131 Developer’s Guide, 4.14.0 634 Chapter 7 Implementation Displaying Hardware Allocation Exceptions This procedure explains how to display hardware allocation exceptions, which indicate that the hardware configuration in the project does not match the physical hardware configuration. Procedure 1 Connect to the controller and download an application, as described in Preparing to Download to the Controller on page 618. If the logical and physical configurations do not match, the Hardware Allocation Exception dialog box appears. 2 Differences identified with an asterisk must be fixed in the project before the application can be downloaded. Other differences may allow you to download the application. Identifier Description Asterisk (*) A red asterisk identifies a module mismatch, which means the module specified in the hardware configuration for the project is different from the module in the physical system. This error must be fixed by changing the hardware configuration in the project. Empty slot An empty slot error indicates either of these: • The hardware configuration specifies a module that is empty in the controller. • The controller contains a module that is not included in the hardware configuration. The application can be downloaded. TriStation 1131 Developer’s Guide, 4.14.0 Maintenance 635 Maintenance This section explains how to plan and manage changes to an application running on a controller attached to a live system. WARNING Changing a safety-critical application that is running on a controller should be avoided because an error in the application could cause a trip or unpredictable behavior. Topics include: • Steps for Downloading Changes on page 636 • Planning and Controlling Changes on page 637 • Commands Required with Application Changes on page 638 • Disabling Points on page 640 • Forcing Points on page 644 • Using the Download Changes Command on page 646 • Using the Download All Command on page 649 TriStation 1131 Developer’s Guide, 4.14.0 636 Chapter 7 Implementation Steps for Downloading Changes This list includes steps for making changes to an application running on a controller. WARNING • For a safety-critical application running on a live system, you must use extreme caution because a configuration error in the changed application could cause unpredictable behavior or a trip. • If you must make online changes to the controller using the Download Changes command, it is strongly recommended that the controller be in Triple Modular Redundant (TMR) mode. For more information about TMR mode, see the Planning and Installation Guide for Tricon v9-v11 Systems. • When a Download Changes command is issued, the scan time is doubled for one scan immediately following the command. For example, if the normal scan time is 100 ms, the scan following a Download Changes would be 200 ms. Step See Verify the TriStation 1131 software is correctly installed. • Verifying the TriStation 1131 Installation on page 10 Plan for the change. • Planning and Controlling Changes on page 637. Determine whether a Download All or Download Changes is required. • Commands Required with Application Changes on page 638. Review the hardware configuration. If needed, correct the hardware configuration to match the physical configuration. • See the Hardware Module Configuration report. See Generating Reports on page 98. Compare the current project with the last downloaded. • Compare Project to Last Download Command on page 680 Test on the Emulator. • Using the Triconex Emulator for Testing on page 617 Ensure the scan time has a surplus. • Determining the Scan Surplus on page 631 Download the changed application. • Using the Download Changes Command on page 646. • Using the Download All Command on page 649 Backup the project and copy it to another storage medium. TriStation 1131 Developer’s Guide, 4.14.0 • Backup Project Command on page 666 Maintenance 637 Planning and Controlling Changes This section describes recommended procedures for planning and controlling changes to an existing application. All changes to an application should be controlled by a change control board or the equivalent, and should comply with strict control procedures. Recommended Procedure 1 Generate a change request defining all changes to the application and the reasons for the changes, then obtain approval for the changes from the board. 2 Develop a specification for changes, including a test specification, then obtain approval for the specification from the board. 3 Make the appropriate changes to the application, including those related to design, operation, or maintenance documentation. 4 Verify the application in the controller matches the last downloaded application. See Verify Last Download to the Controller Command on page 861. If the applications do not match, contact Invensys support. 5 Print the Hardware Module Configuration report to compare the current configuration with the last one downloaded to the controller. 6 Print all user documents and thoroughly check all changed networks in each document to ensure the changes do not affect other parts of the application. 7 Test the new application on the Emulator and write a test report. 8 Review and audit all changes and the test results with the board. 9 When approved by the board, download the changes to the controller. 10 Save the downloaded application and back up the appropriate files on a CD or other storage medium. 11 Archive two copies of the .pt2 (project) file and all associated documentation. TriStation 1131 Developer’s Guide, 4.14.0 638 Chapter 7 Implementation Commands Required with Application Changes After an application is downloaded to a controller or the Emulator, the state is set to accept changes to the project which are allowed with the Download Changes command. If a change requires the Download All command, it is either disabled or a message advises you to change the state or cancel the change. For example, a program cannot be deleted unless the state is changed to Download All (see Change State to Download All Command on page 672). This table identifies whether a Download All or Download Changes command is required. Table 50 Commands Required with Changes Component Command Required Chassis Download All: Required if a chassis is added, deleted, or the type is changed in Tricon 11.0.x and earlier systems. In Tricon 11.1.x and later systems, required if a chassis type is changed, or a chassis already downloaded to the controller is deleted. Download Changes: Allowed, if a chassis is added in Tricon 11.1.x and later systems. Functions and function blocks Download All: Required if a function or function block is modified or deleted. Download Changes: Allowed if a function or function block is added. IP Address Download Changes: Allowed, but not advised, if the IP address of a communication module is changed. Library elements Download Changes: Allowed, but only if the library (or selected library elements) being added, updated, or deleted does not change function blocks that have already been downloaded to the controller. Download All: Required if the library (or selected library elements) being added, updated, or deleted changes function blocks that have already been downloaded to the controller. Memory allocation Download All: In Tricon 11.1 and earlier systems, required if memory allocation is increased or decreased. In Tricon 11.2 and later systems, required if memory allocation is decreased from the last downloaded value, or memory allocation for memory points or application data is increased. Download Changes: Allowed only in Tricon 11.2 and later systems, if memory allocation for I/O points is increased AND changes to Peer-to-Peer or SOE configuration are not pending. Modules Download All: Required if modules are moved in the configuration. Also required if modules already downloaded to the controller are deleted. Download Changes: Allowed if a module is added and the chassis has empty slots, and there is sufficient memory allocated for the points. Also allowed if modules that have not been downloaded to the controller are deleted. Node Number Download All: Required if the address plug and node number configuration are changed. TriStation 1131 Developer’s Guide, 4.14.0 Maintenance Table 50 639 Commands Required with Changes (continued) Component Command Required Number of Send or Receive function blocks Download All: In Tricon 11.1 and earlier systems, required if the number of send or receive function blocks is increased or decreased. In Tricon 11.2 and later systems, required if the number of send or receive function blocks is decreased from the last downloaded value. Download Changes: Allowed only in Tricon 11.2 and later systems, if the number of send or receive function blocks is increased AND changes to memory allocation for I/O points or SOE configuration are not pending. Operating Parameters Download All: Required if the Allow Disabling of Points property is changed. Download Changes: Allowed if these properties are changed: Disable Remote Changes to Outputs, Password Required for Connection (Trident or Tri-GP only), Restart on Power-Up (Trident or Tri-GP only), Scan Time, and Use Local Time. Programs Download Changes: Allowed if a program is added to an application and there is sufficient memory. Also allowed if a program is deleted from an application. SOE Blocks Download All: In Tricon 11.1 and earlier systems, required if you want to make changes to the SOE configuration. In Tricon 11.2 and later systems, required if you want to make changes to the SOE configuration when changes to memory allocation for I/O points or Peer-to-Peer configuration are also pending. Download Changes: Allowed only in Tricon 11.2 and later systems, if changes to memory allocation for I/O points or Peer-to-Peer configuration are not pending. Tagnames Download Changes: Allowed if tagnames are added, modified, or deleted. Tagnames can also be disconnected or connected to different points, if there is enough memory allocated for the required point types. Points must be enabled. Target System Version Download All: Required if the target system version is changed (upgrade or downgrade), unless you are converting a project created in a version of TriStation 1131 prior to 4.6. Download Changes: Allowed if you are changing the target system version while converting a project created in a version of TriStation 1131 prior to 4.6. Variables Download All: Required if changes to the Data Type or Alias Type require additional memory allocation. In Tricon 11.2 and later systems, required if memory allocation is decreased from the last downloaded value. Download Changes: Allowed if changes to the Data Type does not require additional memory allocation. Points must be enabled. Also allowed if the variable Name, Description, or Initial Value is added or changed. Allowed, but not advised, if changes are made to the Point Type, Alias Type, or Alias Number of a memory variable; these changes will re-initialize the point to its configured initial value, or 0 if no initial value is defined. TriStation 1131 Developer’s Guide, 4.14.0 640 Chapter 7 Implementation Disabling Points This section explains how to disable points (tagnames) on an application running on a controller, which should be used with care. When a point is disabled, inputs from field instruments or the application running on the controller do not change the value of the point. Disabling points is typically used when field instruments need to be replaced or repaired. Once a point is disabled: • If the point is a physical input, field instruments cannot write to it. (The application cannot write to it by definition, once the point is configured as an input.) • If the point is a physical output, the application cannot write to it. • If the point is a memory point, the application cannot write to it. • The value in the point when it was disabled is held. If desired, you can force the point to a specific value (see Forcing Points on page 644). • External hosts (Modbus Masters, etc.) can still write directly into the disabled point if the point is: — A memory read/write aliased tagname and the controller is write-accessible (the keyswitch is in PROGRAM or REMOTE mode, or in RUN mode with gate access). — An output point and the “Disable Remote Changes to Outputs” property on the Operating Parameters screen is not selected. • Changes to the controller’s keyswitch position will not affect the point or re-enable it. CAUTION Note If a disabled point is configured to allow external write access, you must ensure that external hosts do not write to the point and change the point’s value while it is disabled. If this occurs, the point will be updated to the value written by the external host, which may result in undesirable consequences. Disabling points on the controller is completely separate from disabling points on the Emulator. Points that are disabled in the program running on the Emulator will NOT also be disabled in the application that is currently running on (or will be downloaded to) the controller. The following table shows the maximum number of points that can be disabled at any one time, for Tricon controllers: Controller Maximum Number of Disabled Points Tricon 9.x 64 Tricon 10.x and 11.1 256 Tricon 11.2 1,024 There is no maximum to the number of points that can be disabled for Trident or Tri-GP controllers; however, disabled points are not recorded and are cleared after a power cycle. TriStation 1131 Developer’s Guide, 4.14.0 Maintenance 641 When you disable one or more points, the number of disabled points output parameter (POINTS_DISABLED) in the TR_PROGRAM_STATUS (Tricon) or SYS_MP_EXT_STATUS (Trident or Tri-GP) function block is updated. Additionally, the alarm state for disabled points is also changed to TRUE in the TR_SHUTDOWN (Tricon) or SYS_SHUTDOWN (Trident or Tri-GP) function block. See the TriStation 1131 Libraries Reference for more information about these function blocks. The disabling (and subsequent re-enabling) of points is saved to the TriStation 1131 Project History. To view information about when a point was disabled—and who disabled it—from the Project menu, select View Project History. Note Information about disabled points is saved to the Project History only if you specified in the Project Options dialog box that you should be prompted to add comments when enabling or disabling points. For more information, see Specifying Forced Points Options on page 46. In order to disable points from TriStation 1131, the Allow Disabling of Points property must be selected on the Operating Parameters screen. See Setting Tricon Operating Parameters on page 341 or Setting Trident or Tri-GP Operating Parameters on page 439 for more information. WARNING • A project should not contain disabled points unless there is a specific reason for disabling them, such as initial testing or maintenance. . • Disabling points can increase the scan time. • Enabling the Allow Disabling of Points property can increase the scan time, regardless of whether any points are actually disabled. If power to the controller is lost, upon restoration of power and a controller restart, disabled points will behave as follows: Point Type Memory (Discrete, Integer, Real) Value Upon Power Restore and Restart • Non-Retentive Point: Initial value (if initialized) or zero (if not initialized). • Retentive Point: Value that was in the point just before the loss of power. Input (Discrete, Integer, Real) Output (Discrete, Integer) Value that was in the point just before the loss of power. Note: An initial value and the retentive attribute are not applicable to input points. • Non-Retentive Point: Initial value (if initialized) or zero (if not initialized). This value is used until the first calculated value is available. • Retentive Point: Value that was in the point just before the loss of power. This value is used until the first calculated value is available. Note The above behavior also applies to non-disabled points, with the following exception: For a non-disabled input point, the value upon power restore and restart will be zero (0). TriStation 1131 Developer’s Guide, 4.14.0 642 Chapter 7 Implementation Topics include: • Disabling Points on the Controller on page 642 • Viewing Disabled Points on page 642 • Re-enabling Disabled Points on page 643 Disabling Points on the Controller This procedure describes how to disable points in a program running on the controller. Points are automatically re-enabled if you perform a Download All. Disabled points are retained if you perform a Download Changes operation. Procedure 1 Expand the Configuration tree, and click Controller Panel. 2 On the Commands menu, click the Connect command, and enter the connection password if required. Note 3 If the target system version configured for the project does not match the system version of the controller you are trying to connect to, you will be unable to connect to the controller. See Configuring the Tricon Target System Version on page 345 or Configuring the Trident or Tri-GP Target System Version on page 443. Double-click a point to be disabled, and click Disable. Only one point can be disabled at a time. 4 If prompted, enter a comment (using 100 characters or less) that describes why this point was disabled, and then click OK. The comment will be placed in the project history. Note 5 Entering a comment is optional. You will be prompted to enter a comment only if the corresponding option was selected in the Project Options dialog box. See Specifying Forced Points Options on page 46. Repeat steps 3 and 4 until all desired points have been disabled. Viewing Disabled Points You can view a list of all disabled points on the controller, including each point’s tagname, location, and Modbus alias. Individual points in the list can be selected and enabled. The application must be running on the controller in order to view the list of disabled points. Procedure 1 Click Run 2 From the Commands menu, select List Disabled Points. 3 If desired, select the points you want to enable, and then click OK. to execute the application on the controller. TriStation 1131 Developer’s Guide, 4.14.0 Maintenance 643 Re-enabling Disabled Points Note Points that have been disabled can be re-enabled individually or all at once. You can also enable points from the List of Disabled Points dialog box. See Viewing Disabled Points on page 642. To enable points individually: 1 Click Run 2 Double-click the point to be enabled, and click Enable. 3 If prompted, enter a comment (using 100 characters or less) that describes why this point was re-enabled, and then click OK. The comment will be placed in the project history. Note 4 to execute the application on the controller. Entering a comment is optional. You will be prompted to enter a comment only if the corresponding option was selected in the Project Options dialog box. See Specifying Forced Points Options on page 46. Repeat steps 3 and 4 until all desired points have been enabled. To enable all disabled points at once: 1 Click Run 2 From the Commands menu, select Enable All Disabled Points. 3 When asked to confirm the operation, click Yes. to execute the application on the controller. All points that are currently disabled on the controller are re-enabled. TriStation 1131 Developer’s Guide, 4.14.0 644 Chapter 7 Implementation Forcing Points This section explains how to force points (tagnames) on an application running on a controller, which should be used with care. Forcing a point is the act of putting a value into a point that has been disabled. When a point is disabled, inputs from field instruments or the application running on the controller do not change the value of the point. Once you have disabled a point, you can then force the point to a specific value by entering that value in the point’s Tagname Properties dialog box. Note For information about how forced points behave after a power failure/restart, see Disabling Points on page 640. Disabling and forcing points is typically used during maintenance operations, when field instruments need to be replaced or repaired. For example, a digital output point drives a solenoid/valve, which is normally energized during operation. When the solenoid requires maintenance, the digital output point is disabled and then forced to the OFF state. This allows maintenance personnel to safely disconnect the field device and perform the required maintenance function. Points can also be disabled and forced during factory or site acceptance testing (FAT/SAT), when input conditions are set by disabling and forcing the input points because the field devices have not yet been wired and connected to the controller. If a portion of your process is offline, some points may remain in the disabled/forced state for a long period of time. Note Forcing points on the controller is completely separate from forcing points on the Emulator. Points that are forced to a value in the program running on the Emulator will NOT also be forced to the same value in the application that is currently running on (or will be downloaded to) the controller. Forced points are saved to the TriStation 1131 Project History. To view information about when a point was forced, the value it was forced to, and the user who forced the value, from the Project menu, select View Project History. Note Information about disabled points is saved to the Project History only if you specified in the Project Options dialog box that you should be prompted to add comments when enabling or disabling points. For more information, see Specifying Forced Points Options on page 46. This procedure describes how to force points in a program running on the controller. Procedure 1 Disable the point as described in Disabling Points on page 640. 2 Double-click the point to be forced, opening the Item Properties dialog box for the point. 3 In the Set Value field, enter the value you want to force the point to use, and click Confirm. Only one point can be forced at a time. When connected to a Tricon 11.2 or later controller, the forced value of a disabled input point is shown in red, adjacent to its actual point value. TriStation 1131 Developer’s Guide, 4.14.0 Maintenance 4 645 If prompted, enter a comment (using 100 characters or less) that describes why this point was forced, and then click OK. The comment will be placed in the project history. Note Entering a comment is optional. You will be prompted to enter a comment only if the corresponding option was selected in the Project Options dialog box. See Specifying Forced Points Options on page 46. TriStation 1131 Developer’s Guide, 4.14.0 646 Chapter 7 Implementation Using the Download Changes Command The Download Changes command is used to download changes to an application that has already been downloaded and is running on a controller. For information on changes that are allowed with this command, see Download Changes Command on page 706. If You are Adding an I/O Module as Part of a Download Changes Operation Adding an I/O module will have an effect on poll time, which in turn has an effect on the minimum scan time. Be sure to adjust the scan time for the application to account for the change in the minimum scan time after adding an I/O module. For more information about the minimum scan time, see Determining the Minimum Scan Time on page 630. If the application uses the following function blocks, the changed application should include logic to accommodate the behavior. • For Tricon controllers, the IOMAIN and IOBAD parameters of the TR_MP_STATUS function block turn off. • For Trident or Tri-GP controllers, the parameters for the SYS_IO_STATUS, SYS_IOP_STATUS, and SYS_SYSTEM_STATUS function blocks turn off. For more information, see the Tricon, Trident, or Tri-GP Safety Considerations Guide. These warnings should be reviewed before proceeding with the Download Changes operation. WARNING • Changing a safety-critical application that is running on a controller should be avoided because an error in the application could cause a trip or unpredictable behavior. • If you must make online changes to the controller using the Download Changes command, it is strongly recommended that the controller be in Triple Modular Redundant (TMR) mode. For more information about TMR mode, see the Planning and Installation Guide for Tricon v9-v11 Systems. • If the application has a negative Scan Surplus, do not use the Download Changes command because it could cause a trip or unpredictable behavior. • When a Download Changes command is issued, the scan time is doubled for one scan immediately following the command. • If a memory variable’s Point Type, Alias Type, or Alias Number is changed, using the Download Changes command re-initializes the variable to its configured initial value, or 0 if no initial value is defined. • If the IP Address is changed, the Fault indicator on the communication module turns on during the reset, which temporarily compromises the TMR status of the controller. TriStation 1131 Developer’s Guide, 4.14.0 Maintenance WARNING 647 • If an I/O module is added, the TMR status of the controller is temporarily compromised for as much as 8 to 16 scans. For more information, see If You are Adding an I/O Module as Part of a Download Changes Operation below. • If the AI module type for models 3703 or 3704 is changed, the TMR status of the controller is temporarily compromised for as much as 8 to 16 scans. • If the DO module type for models 3611, 3613, 3614, 3615, or 3617 is changed, the TMR status of the controller is temporarily compromised for as much as 8 to 16 scans. • If the resolution type on model 3720 and 3721 AI modules is changed, all input points on the module will change. A change from high to low resolution (or vice-versa) results in a value change by a factor of four. Additionally, if field power monitoring is changed from On to Off (or vice-versa), all input points on the module will temporarily change to 0 for 1-2 scans. See Configuring a Tricon AI Single-Ended or Differential Module on page 365 for more information. • For Trident and Tri-GP controllers, a Download Changes command will be rejected by the controller if the application’s symbol table is greater than 1 MB in size. See Declaring Tagnames on page 203 for more information about reducing the size of the symbol table. • If in doubt about the effect of this command, contact Technical Support. Procedure 1 Expand the Configuration tree, and double-click the Controller Panel. 2 On the Commands menu, click Connect required. , and enter the connection password if Notes If the target system version configured for the project does not match the system version of the controller1 you are trying to connect to, you will be unable to connect to the controller. See Configuring the Tricon Target System Version on page 345 or Configuring the Trident or Tri-GP Target System Version on page 443. If the chassis type configured for the project does not match the chassis type of the Tricon controller you are trying to connect to, you will be unable to connect to the controller. The chassis type specified in the project must be the same as the chassis type used by your controller. If necessary, change the chassis configured in the project to match the controller’s chassis; see Replacing a Tricon Main Chassis on page 360. 3 1. On the Commands menu, click Download Changes . Except for Trident 1.x controllers, which do not use the target system version. TriStation 1131 Developer’s Guide, 4.14.0 648 Chapter 7 Implementation If the scan time is less than the minimum scan time, a message appears, prompting you to change the scan time to a recommended value (the minimum scan time calculated by TriStation 1131). You cannot continue the download operation until you have changed the scan time to the recommended value. For information on the minimum scan time, see Determining the Minimum Scan Time on page 630. The changes are made while the application is running. If the download failed, review the error messages on both the Controller and Application tabs to determine the source of the failure. If you have configured your project settings to automatically copy the project file to the controller after a download operation, a message appears, stating that the project file was successfully copied. Notes If the file was previously copied to the controller, you will be prompted to overwrite it. To view information about the file, click Properties. To proceed with the overwrite, click Yes. The time it takes for the copy operation to begin and the file to be copied to the controller depends upon the size of the application and the controller’s scan time. A copy operation for a large file with a long scan time may take several minutes (in some cases, up to an hour). If you do not want to wait for the copy operation to complete, you can cancel the automatic copy, and then manually copy the project file to the controller at a later time. For more information, see Backing Up a Project File to the Controller on page 328. TriStation 1131 Developer’s Guide, 4.14.0 Maintenance 649 Using the Download All Command This procedure explains how to use the Download All command to download a changed application to a controller. For information on changes that require this command, see Download All Command on page 704. See Changes to the Project Version and State After Downloading to the Controller on page 621 for information on the impact of performing a Download All operation on a controller. Notes If you have configured process alarms in your application (see Alarms on page 229), TriStation 1131 will verify that you have updated the process alarms program before downloading your application. For Trident and Tri-GP controllers, a Download Changes command will be rejected by the controller if the application’s symbol table is greater than 1 MB in size. See Declaring Tagnames on page 203 for more information about reducing the size of the symbol table. WARNING Using the Download All command requires the current application running on the controller to be halted. Procedure 1 Expand the Configuration tree, and double-click the Controller Panel. 2 On the Commands menu, click Connect . Notes If the model number of the MPs configured for the project does not match the model number of the MPs installed in the Tricon controller you are trying to connect to, you will be unable to connect to the controller. The model number of the MPs specified in the project must be the same as the MPs installed in your controller. If necessary, change the MPs configured in the project to match the controller’s MPs. If the chassis type configured for the project does not match the chassis type of the Tricon controller you are trying to connect to, you will be unable to connect to the controller. The chassis type specified in the project must be the same as the chassis type used by your controller. If necessary, change the chassis configured in the project to match the controller’s chassis; see Replacing a Tricon Main Chassis on page 360. If the target system version configured for the project does not match the system version of the controller2 you are trying to connect to, you will be unable to connect to the controller. See Configuring the Tricon Target System Version on page 345 or Configuring the Trident or Tri-GP Target System Version on page 443. 2. 3 If needed, change the connection setting. Click OK. 4 If required, enter the connection password. 5 If needed, change the state to Download All. On the Commands menu, click Change State to Download All. Except for Trident 1.x controllers, which do not use the target system version. TriStation 1131 Developer’s Guide, 4.14.0 650 Chapter 7 Implementation 6 Click Halt to stop the application. 7 For Tricon controllers, turn the keyswitch to PROGRAM. 8 For Trident or Tri-GP controllers, ensure the mode is Enable Programming and Control Operations, by doing this: • 9 On the Commands menu, click Set Programming Mode, and then click Enable Programming and Control Operations. (This is the default setting.) Click Download All . If the scan time is less than the minimum scan time, a message appears, prompting you to change the scan time to a recommended value. You cannot continue the download operation until you have changed the scan time on the Execution List screen to the recommended value. For information on changing the scan time value on the Execution List screen, see Specifying the Program Order and Scan Time on page 323. For information on the minimum scan time, see Determining the Minimum Scan Time on page 630. If the download failed, review the error messages on both the Controller and Application tabs to determine the source of the failure. If you have configured your project settings to automatically copy the project file to the controller after a download operation, a message appears, stating that the project file was successfully copied. Notes If the file was previously copied to the controller, you will be prompted to overwrite it. To view information about the file, click Properties. To proceed with the overwrite, click Yes. The time it takes for the copy operation to begin and the file to be copied to the controller depends upon the size of the application and the controller’s scan time. A copy operation for a large file with a long scan time may take several minutes (in some cases, up to an hour). If you do not want to wait for the copy operation to complete, you can cancel the automatic copy, and then manually copy the project file to the controller at a later time. For more information, see Backing Up a Project File to the Controller on page 328. 10 Click Run 11 For Tricon controllers, turn the keyswitch to RUN. to start the application running on the controller. TriStation 1131 Developer’s Guide, 4.14.0 A Commands and Properties This appendix provides descriptions of TriStation 1131 commands and properties. Active See Alarm Attributes on page 652. Add Chassis Command The Add Chassis command displays a dialog box that allows you to select a Tricon chassis to add to the controller configuration. For more information, see Adding a Tricon Chassis on page 358. Applies To Chassis Location Tricon Controller tree > Configuration > Hardware Allocation > right-click a chassis Add File Command The Add File command adds a custom Help file to the TriStation 1131 Help menu. A maximum of 32 customized HTML Help files (.chm) may be added to the TriStation 1131 Help menu. Applies To Application Location Help menu > Options > Add or Remove Custom Help Files TriStation 1131 Developer’s Guide, 4.14.0 652 Appendix A Commands and Properties Add New Tagname Command The Add New Tagname command allows you to create a tagname in the Tagname Editor. Applies To Tagnames Location Tagname Editor > Tagname Commands Group Add New Tagnames Command The Add New Tagnames command allows you to create multiple tagnames at once in the Tagname Editor. Applies To Tagnames Location Tagname Editor > Tagname Commands Group Add Program to Execution List Command The Add Program to Execution List command places the cursor inside the Program Execution List box, which allows you to enter or select a program to be added to the list. Applies To Application Location Application tree > Implementation > Edit menu Alarm Attributes The Alarm Attributes properties are used to configure process alarms. Each alarm type (Deviation, Level, Rate-of-Change, Trip) has a set of attributes to be configured. The available attributes differ depending on the type of alarm you are configuring. While most attributes can accept either a constant (fixed) value or a tagname, some attributes can accept only one or the other. For more information, see Configuring Alarm Attributes on page 231. The alarm attributes are automatically connected to the corresponding input in the appropriate alarm function block when the process alarms program is created. This table identifies the available alarm attributes, and the alarm types they correspond to. TriStation 1131 Developer’s Guide, 4.14.0 Alarm Attributes Table 51 653 Alarm Attributes Applicable Alarm Types Attribute Description Active Specifies the alarm state. Must be TRUE, FALSE, or a BOOL tagname. LVL, DEV, ROC, TRP Alarm Status Specifies the current alarm state, alarm condition, and process condition. LVL, DEV, ROC, TRP Automatic Reset Configures the alarm sequence as follows: LVL, DEV, ROC, TRP • If Automatic Reset = FALSE and Alarm Ringback = FALSE, then the manual reset sequence is initiated. • If Automatic Reset = FALSE and Alarm Ringback = TRUE, then the ringback sequence is initiated. • If Automatic Reset = TRUE, then the automatic reset sequence is initiated, regardless of the Alarm Ringback status. Resets the alarm automatically when an alarm goes inactive. Must be TRUE, FALSE, or a BOOL tagname. Bypass Specifies if the alarm is bypassed. Must be TRUE, FALSE, or a BOOL tagname. LVL, DEV, ROC, TRP Bypass Request Specifies whether or not a client can request a bypass for this alarm. Must be TRUE, FALSE, or a BOOL tagname. LVL, DEV, ROC, TRP Command Accepted Specifies whether a command has been accepted by the alarm function block. Must be TRUE, FALSE, or a BOOL tagname. LVL, DEV, ROC, TRP Command ID Specifies which function block will execute the command specified by Command In. LVL, DEV, ROC, TRP Command In An integer that indicates an acknowledge or manual reset command from the operator, as follows: LVL, DEV, ROC, TRP • 6 = Acknowledge • 12 = Manual reset • Other = Do nothing Deadband Specifies the difference between the alarm limit and the input value before an alarm goes inactive. Used for hysteresis. LVL, DEV, ROC Disable Request Specifies whether or not a client can disable the alarm. Must be TRUE, FALSE, or a BOOL tagname. LVL, DEV, ROC, TRP First Out Specifies the first alarm (in a specified set of alarms) that goes active. Must be an integer. LVL, DEV, ROC, TRP TriStation 1131 Developer’s Guide, 4.14.0 654 Appendix A Commands and Properties Table 51 Alarm Attributes (continued) Applicable Alarm Types Attribute Description High Active If true, the alarm condition is High High or High. LVL, DEV, ROC High High Active If true, the alarm condition is High High. LVL, DEV, ROC High High Limit High High process condition limit. LVL, DEV, ROC High High Severity High High alarm severity. LVL, DEV, ROC High Limit High process condition limit. LVL, DEV, ROC High Severity High alarm severity. LVL, DEV, ROC ID Specifies the unique identifier for the alarm function block. LVL, DEV, ROC, TRP Low Active If true, the alarm condition is Low. LVL, DEV, ROC Low Limit Low process condition limit. LVL, DEV, ROC Low Low Active If true, the alarm condition is Low Low or Low. LVL, DEV, ROC Low Low Limit Low Low process condition limit. LVL, DEV, ROC Low Low Severity Low Low alarm severity. LVL, DEV, ROC Low Severity Low alarm severity. LVL, DEV, ROC Ringback When ringback is enabled, if an alarm is triggered but then returns to normal without being acknowledged, it enters the ringback state. The ringback state requires a manual reset of the alarm to return the state to normal. LVL, DEV, ROC, TRP Must be TRUE, FALSE, or a BOOL tagname. Setpoint Specifies the value from which the deviation alarm will be generated. Must be an integer. DEV Shift Change Request Specifies whether or not shift change functionality is enabled for this alarm. When enabled, alarms that were acknowledged before a shift change will need to be acknowledged again by the new operator(s). LVL, DEV, ROC, TRP Must be TRUE, FALSE, or a BOOL tagname. Source ID Specifies the unique ID for communication via the OPC UA protocol interface. Assigned automatically when the process alarms program is generated. LVL, DEV, ROC, TRP If you are not using OPC UA, you must set this value to 0 (zero). Time Delay Specifies the amount of time (in seconds) before an alarm will go ACTIVE after detection of a process condition change from normal to abnormal. The default is 0 seconds. TriStation 1131 Developer’s Guide, 4.14.0 LVL, DEV, ROC, TRP Alarm Attributes Table 51 655 Alarm Attributes (continued) Applicable Alarm Types Attribute Description Trip Level Specifies which level (True or False) results in a trip alarm. TRP • The process condition is abnormal if Source = Trip Level. • The process condition is normal when Source ≠ Trip Level. Must be TRUE, FALSE, or a BOOL tagname. Trip Severity Specifies the severity number for the trip alarm. Severities are defined in the OPC UA communications protocol. TRP Must be an integer. Unbypass Request Specifies whether or not a client can request an unbypass for this alarm. Must be TRUE, FALSE, or a BOOL tagname. LVL, DEV, ROC, TRP For more detailed information about these attributes, see Configuring a Level, Deviation, or ROC Alarm on page 233 and Configuring a Trip Alarm on page 237. Applies To Input and memory points; process alarms Locations • • Application tree > Tagname Declarations > Declaration tab > Alarm Settings > Tag Configuration dialog box Tagname Editor > Declaration tab TriStation 1131 Developer’s Guide, 4.14.0 656 Appendix A Commands and Properties Alarm Function Block The Alarm Function Block property specifies the name of the process alarm function block associated with an alarm configured for a tagname. A default name is created automatically by TriStation 1131 using the name of the tagname you are configuring the alarm for, and the alarm type. For example, if your tagname is named “PV_1047”, the function block name for a trip alarm will be generated as “PV_1047_TRIPAlm”. You can change this name, as long as the name does not exceed 31 characters. See also Alarm Attributes on page 652. Applies To Input and memory points; process alarms Location Application tree > Tagname Declarations > Declaration tab > Alarm Settings > Tag Configuration dialog box Alarms SOE Block Number The Alarms SOE Block Number property specifies the block number used when alarm events are retrieved by SOE Recorder or an OPC UA client. For more information on using SOE Recorder, see the Triconex SOE Recorder User’s Guide. For OPC UA configuration, must be unique for each CIM installed in a system. The default value is 0 (alarms are not configured). If you have alarms configured in your application you must enter an SOE block number; you cannot use the default value of 0. Applies only to the model 3211 and 3211S2 CIM. Applies To Sequence of Events (SOE), OPC communication Location Trident or Tri-GP 3.x Controller tree > Configuration > Hardware Allocation > CIM Setup > OPC tab Alarm Settings See Alarm Attributes on page 652. Alarm Status See Alarm Attributes on page 652. TriStation 1131 Developer’s Guide, 4.14.0 Alias Number 657 Alias Number The Alias Number property identifies the range of alias numbers that can be assigned to the point. In Tricon systems, aliases are within either the Legacy range or the Extended range, depending on the system version, and the type of communication modules that are installed. The Legacy and Extended alias ranges correspond to the size of the memory area avai