System Configuration User Guide IGSS Version 11.0

Transcription

1 System Configuration User Guide IGSS Version 11.0

2 The information provided in this documentation contains general descriptions and/or technical characteristics of the performance of the products contained therein. The documentation is not intended as a substitute for and is not to be used for determining suitability or reliability of these products for specific user applications. It is the duty of any such user or integrator to perform the appropriate and complete risk analysis, evaluation and testing of the products with respect to the relevant specific application of use thereof. Neither Schneider Electric nor any of its affiliates or subsidiaries shall be responsible or liable for misuse of the information contained herein, If you have any suggestions for improvements or amendments or have found errors in this publication, please notify us. No part of this document may be reproduced in any form or by any means, electronic or mechanical, including photocopying, without express written permission of Schneider Electric. All pertinent state, regional and local safety regulations must be observed when installing and using this product. For reasons of safety and to help ensure compliance with documented system data, only the manufacturer should perform repairs to components. Failure to use Schneider Electric software or approved software with our hardware products may result in injury, harm or improper operating results. Failure to observe this information can result in injury or equipment damage. 2004, 2011 Schneider Electric, All rights reserved.

3 This document and attachments contain confidential information and is to be treated as Commercial-in-Confidence. Copying or disclosure to a third party is prohibited without prior consent in writing from Schneider Electric.

4 Chapter 1: Welcome to System Configuration 1.1 What is System Configuration? The System Configuration form allows you to: set up the individual stations of the IGSS system (single user, server or operation stations) enable the communication between IGSS and the data collection devices (typically PLCs) in the plant configure the relevant communication drivers Use Using the System Configuration form, you can: Define the station type and name of the individual stations in the system Include up to 16 drivers that can run simultaneously in IGSS Choose the relevant interface(s) for the driver Define the required nodes and subnodes The typical workflow To put System Configuration into a broader perspective, here is an outline of the typical workflow when you set up a multiuser system. 1. Create the new configuration in System Configuration form. 2. In System Configuration form, define the IGSS servers and operator stations. 3. Define the setup parameters for the servers. 4. Define the setup parameters for the operator stations. 5. Include the drivers you want to use and set up the individual nodes (PLCs). 6. Design and install the configuration in Definition module. 7. Start and test the configuration using the IGSS Master and the Supervise module. Key features and benefits For a detailed list of features and benefits, click here.

5 Program components The System Configuration form consists of the following key components: Component Description Location SysConfig.exe Program executable [InstallPath]\Gss\ [MyDriver].dll SysConfig.chm DrvSpec.chm DrvEvent.chm Two DLLs for each [InstallPath]\Gss\ driver supported. The driver DLL and the configuration DLL. For example, 7TAB.DLL and 7TABC.DLL. The Help file for the System Configuration form. The driver-specific Help file with information about the individual drivers and error codes. The Help file which describes how to use event-oriented communication with IGSS. [InstallPath]\Gss\ [Language Code] [InstallPath]\Gss\ [Language Code] [InstallPath]\Gss\ [Language Code] 1.2 Running System Configuration as Administrator In order to update the list of external types in the driver properties in System Configuration form, you must have Administrator rights. Administrator privileges are tied to your Microsoft user rights and if you do not have administrator privileges for your local machine, you will not be able to edit external types. You can run the System Configuration form with Administrator privileges, in the IGSS, click the drop-down arrow in the System Configuration button on the Design and Setup tab and select Run as Administrator.

6 Your administrator privileges for external types editing are terminated when the System Configuration form is closed but you can select the Run as Administrator option again if you need to make more changes. 1.3 The User Interface Main window The main window consists of four elements: The menu bar The toolbar area The tree view The property pages area Click on any part of the figure below for further information.

7 Menus The following menus are available. To get a detailed description of each menu item, click one of the menus below. File menu Edit menu

8 View menu Tools menu Help menu Right-click menu Right-click menus In the tree view pane, a context-sensitive right-click menu is available for adding or removing elements and to expand or collapse the selected branch of the tree view. To see what a menu item does, click its name below. This PC Preset Station New Station New Driver New Node New Subnode) Remove Station, Driver, Node or Subnode Suspend Driver Suspend Device Suspend Node

9 Expand Branch (right-click menu) Collapse Branch (right-click menu) The toolbar To see what a button does, click it in the following illustration.

10 Chapter 1: System Configuration Tab page help 1.4 Reports tab Overview Use the Reports tab of the System Configuration form to: Define which printer to use to print all alarms and log data to. Define the default report headings. Define the report logo to be displayed on all reports created from IGSS. Define the report output type for all reports. Define the settings for delivery of reports. Field and button help Group Name Field/Button Name Description Alarm printer None Select this option to disable sending acknowledged and closed alarms to the printer. The printer to be used is specified in the Print setup form, accessed by clicking the Printer button. This is the default setting for IGSS. Alarm printer Direct Select this option to send acknowledged and closed alarms directly to the printer, circumventing the Windows print management. The printer to be used is specified in the Print setup form, accessed by clicking the Printer button. The To Print check box must be selected in the Edit

11 Group Name Field/Button Name Description Alarm Description form must also be selected for the alarm in question to be sent to the printer. Alarm printer Windows Select this option to send acknowledged and closed alarms to the printer using Windows print management. The printer to be used is specified in the Print setup form, accessed by clicking the Printer button. The To Print check box must be selected in the Edit Alarm Description form must also be selected for the alarm in question to be sent to the printer. Alarm printer Printer button Click this button to open the Print setup form to set up the printer to be used for printing acknowledged and closed alarms. Alarm printer Page Setup button Click this button to open the Page Setup form to define the paper size, orientation and margins of the alarm print. Log printer None Select this option to disable sending each entry in the log as a new line to the printer. The printer to be used is specified in the Print setup form, accessed by clicking the Printer button. This is the default setting for IGSS.

12 Group Name Field/Button Name Description Log printer Direct Select this option to send each entry in the log directly to the printer, circumventing the Windows print management. The printer to be used is specified in the Print setup form, accessed by clicking the Printer button. The Log to Print check box must also be selected in the Data Management Definitions tab of the object properties form for the object in question. Log printer Windows Select this option to send each entry in the log to the printer, using Windows print management. The printer to be used is specified in the Print setup form, accessed by clicking the Printer button. The Log to Print check box must also be selected in the Data Management Definitions tab of the object properties form for the object in question. Log printer Printer button Click this button to open the Print setup form to set up the printer to be used for printing Log files. Log printer Page Setup button Click this button to open the Page Setup form to define the paper size, orientation and margins of the log file print.

13 Group Name Field/Button Name Description Headings 1. Line Define the default first report heading. The report heading will appear in every report run in IGSS. If this field is empty, the default first heading of every report in IGSS will also be empty. You can suppress all default report headings with parameter - SUPHEAD when using command lines to run a report. Headings 2. Line Define the default second report heading. The second heading appears under the first report heading. The second report heading will appear in every report run in IGSS. If this field is empty, the default second heading of every report in IGSS will also be empty. You can suppress all default report headings with parameter - SUPHEAD when using command lines to run a report. Headings Logo file Define the default logo image and the location of the default logo image for the reports. The defined logo image will be used for every report run in IGSS If the logo field is empty, no logo will be inserted in the report when run from IGSS. You can only use the following image types as logos:.gif.jpg

14 Group Name Field/Button Name Description.bmp Headings Show descriptions instead of area Select this check box to replace the area with the object description when running a detailed periodical report. The detailed periodical report contains the following information about the objects displayed: Object name Area of the object Object Atom Object unit If you select the Show descriptions instead of area check box, the Area of the object information will be replaced by the Object Description. Headings Browse button Click this button to browse for the logo image defined in the Logo file field. Periodical report offset Start hour Define the offset start time for periodical reports. The end time will also be adjusted by the same offset. By default, all reports in IGSS start at 00:00:00 hours and end at 00:00:00 hours the next day, measured in 24-hours. The default start time is increased by the number of hours in the Start hour field. If the value in the Start hour field is 10, the start time for all periodical reports in IGSS will be 10:00:00 and the end time will be 10:00:00 the following day.

15 Group Name Field/Button Name Description Output engine Excel Select this option to use Microsoft Excel 2007 or 2010 as the output engine for all reports in IGSS. You must have Microsoft Excel 2007 or 2010 installed on the local machine in order to use this option. If you have not installed Microsoft Excel 2007 or 2010, you must use the HTML option instead. Custom Reports If you are going to create your own reports using IGSS' Custom Reports functionality, you must enable this option as you cannot customize reports without using Microsoft Excel. Output engine HTML Select this option to use HTML as the output engine of all reports in IGSS. The report will open in a new window where you have access to print options. Mail Delivery SMTP server Define the SMTP mail server for sending IGSS reports as a mail attachment. Mail Delivery Senders mail address Define the sender's address when sending IGSS reports as a mail attachment. 1.5 Files tab Overview Use the Files tab of the System Configuration form to: Define how long alarm and log data is to be saved and if the data is to be deleted automatically.

16 Set the initial and maximum sizes of the data base for alarm and log files. Define how long reduced data is to be saved and if the data is to be deleted automatically Set up external Microsoft SQL databases for HDM, Dashboard, Maintenance, Log, Alarm and Audit Trail data. Set up automatic backup parameters, specifying the backup folder and selecting which data is to be backed up. Field and button help Group Name Field Name Description Data size Alarm files Set the number of months the alarm data is to be stored in the database. The minimum value is 1 month and the maximum value is 200 months. Data older than the value in the Alarm files field can be saved to the backup folder if you have specified a backup folder in the Select backup folder field. The relevant files will be moved from the IGSS Report and Project folder to the backup folder. If you have not specified a backup folder, the old alarm data will be deleted. Alarm data is set by default to be deleted automatically when the data exceeds the values in the Alarm files field. Data size Log files Set the number of hours the log file data is to be stored in the database. The minimum value is 1 hour and the maximum value is 100,000 hours.

17 Group Name Field Name Description Data older than the value in the Log files field can be saved to the backup folder before it is deleted if you have specified a backup folder in the Select backup folder field. The relevant files will be moved from the IGSS Report and Project folder to the backup folder. If you have not specified a backup folder, the old log data will be deleted. Log data is set by default to be deleted automatically when the data exceeds the values in the Log files field. Data size BCL files Set the number of days the BCL data is to be stored in the database. This field is pre-defined with 90 days and cannot be edited by the user unless the Auto delete check box is selected. If the Auto delete check box is selected, the BCL data files that are older than the value in the BCL files field are automatically deleted. If you have specified a backup folder in the Select backup folder field, the BCL data files can be saved in the backup folder. The relevant files will be moved from the IGSS Report and Project folder to the backup folder. Data size Auto delete For the Alarm files field

18 Group Name Field Name Description This checkbox is automatically enabled and inaccessible for the Alarm files field. Data size Auto delete For the Log files field This checkbox is automatically enabled and inaccessible for the Log files field. Data size Auto delete For the BCL files field Select this check box to automatically delete reduced data in the database that is older than the value defined in BCL files field. Once you have selected this check box, you can edit the BCL files field and set the number of days the BCL data is to be stored in the database. BCL files are by default not set to be automatically deleted. Data size Initial size Set the initial database size for the Alarm data and the Log data. Data size Current max Displays the size of the largest database file currently on the disk. Use the value in the Current Max field to help define the Initial size field. The values in the Current Max fields are updated by clicking the Find Max. button. In order to reduce fragmentation and optimize disk read speed, place data files in the same area

19 Group Name Field Name Description on the disk. You can use the Find Max button to find the size of the largest file on the disk and use this as a proxy for setting the Initial size field value. Note that the Current Max field does not restrict the size of the Alarm and Log data files and data files can grow beyond the value in the Current Max field, with the only consequence being potentially reduced disk reading speed and increased disk fragmentation. Data size Find Max Click this button to find the size of the largest file on the disk and update the Current Max fields. Reduced data Hourly values Set the number of months the reduced hourly data is to be stored in the database. The minimum value is 0 and the maximum value is months. If you enter "0" in the Hourly values field, the reduced hourly data will not be deleted from the database even if the Auto delete check box is selected. Reduced data Daily values Set the number of years the reduced daily data is to be stored in the database. The minimum value is 0 and the maximum value is years. If you enter "0" in the Hourly values field, the reduced daily data will not be deleted from the database even if the Auto delete check box is selected. Reduced data Auto delete For the Hourly values and the Daily values fields.

20 Group Name Field Name Description Select this check box to automatically delete reduced data in the database that is older than the parameters defined in the Hourly values or Daily values fields. If the Hourly values or Daily values fields are set to "0", then the reduced data will not be deleted, even if the Auto delete check box is selected. External databases SQL Settings button Click this button to open the Microsoft SQL Server Settings form to set up the settings for storing HDM data. Maintenance data SQL Settings button Click this button to open the Microsoft SQL Server Settings form to set up the settings for storing maintenance data. Log data SQL Settings button Click this button to open the Microsoft SQL Server Settings form to set up the settings for storing log data. Log data Alarm log also Select this check box to store all alarm log data to the Microsoft SQL server. For each alarm triggered, three alarm records will be generated in the SQL database: when the initial alarm is registered when the alarm is acknowledged and when the alarm is ended for more information, Alarm log also Audit trail data SQL Settings button Click this button to open the

21 Group Name Field Name Description Microsoft SQL Server Settings form to set up the settings for storing Audit trail data. The Microsoft SQL Server must be correctly set up in order to log Audit trail data. If you have not set up the Microsoft SQL Server correctly, the Audit trail button will not be visible in the IGSS Automatic Backup Select backup folder Displays the selected folder where backup files are be placed. If you have not specified a backup folder (the Select backup folder field is empty) then backup of the selected data will not be conducted. Automatic Backup Browse button Click this button to browse for the location to place backup files. Files to backup Alarm files Select this check box to include alarm data in the backup files. Files to backup Note DB files Select this check box to include object notes in the backup files. Files to backup Log files Select this check box to include log data in the backup files. Files to backup Dashboard files Select this check box to include dashboard files in the backup files. Files to backup BCL files Select this check box to include BCL data in the backup files. Files to backup Maintenance files Select this check box to include maintenance data in the backup files. Files to backup HDM files Select this check box to include HDM data in the backup files.

22 1.6 Access Control tab Overview The Access Control tab allows you to set up various parameters related to access control and user administration. You can do the following tasks: Enable/disable user administration Set up various user administration options Enable and set up the Audit Trail database Set up users who can establish connections to IGSS servers from an AMS or Super Alarm server Field help Group name Field Description Access control Disable access control Clear the check box to enable the access control settings set up in the User Administration module. This is the security module for validating users in the IGSS system. When access control is enabled, users must key in a valid user name and password to perform secure operations, such as starting/stopping the system. This setting is normally not activated during the configuration phase where you want to avoid having to log in and out all the time. Use this option with care. If you forget to enable it, all users can do whatever they want in the system. Monitor mode only Select this setting to restrict the operator station from doing anything but passively monitoring the process on this PC.

23 Save latest user logged in Allow permanent user login Check this box to have the system automatically insert the user name of the latest user who logged into the system. Then the user only needs to type his password. Check this box to enable the Make new user permanent option in the Temporary Login dialog box which appears if the user who is currently logged in does not have the right to perform a certain operation. Instead, another user with the necessary privileges can log in to do the operation. If the above option is checked in the dialog box, the new user is logged in permanently, that is, also after the operation has been performed. Old style login Check this box to use the password protection concept from IGSS, version 8.x 16- bit Windows edition. When enabled, the user is only prompted for a password when he logs in. Normally, logging onto an IGSS system requires both password and user name. If you use this option, you must define your users with a user name but no password in User Administration. When they log in, they are only prompted for a password which is identical to the user name defined. For user login at program startup This setting is only active on an operator station. Select this option to automatically activate the user login dialog box when the user- /operator clicks on the IGSS Starter. The requirement for using this feature is that the User Administration module has been set up with user names and passwords. Audit Trail Keep a record of all user activity in audit trail database Select this check box to save user activity in the Audit Trail database. You select which activities to save in the two columns named Store audit trail and Com-

24 ment required below. Output Store audit trail Comment required Will save all output operations, such as change of setpoint, and sending of digital commands. The user must input a comment for each output operation. Limits Store audit trail Comment required Will save all alarm limit operations The user must input a comment for each operation. Access Store audit trail Comment required Will save all user access operations, such as the user logging in and out of the system. Also, automatic logout of users will be recorded with this option. The user must input a comment for each operation. Notes and ack's Store audit trail Comment required Will save all activities where the user creates an object or user note or acknowledges an alarm. The user must input a comment for each operation. Data management Store audit trail Comment required Will save all data collection and logging activities. The user can start/stop data collection, start/stop logging on specific objects or all objects in the configuration. Those operations will be recorded under Data Man- The user must input a comment for each operation.

25 agement. System Store audit trail Comment required Will save all system operations, such as starting and stopping the system. The user must input a comment for each operation. AMS and Super Alarm server settings Keep audit trail for... (days) List of users Disable Notifier interface Add... Edit... Remove TCP/IP port Default port Type the number of days for which you want to keep the user activity records in the Audit Trail database. Lists the users who are authorized to establish connections to IGSS servers from the Notifier module or Super Alarm. Select this check box to prevent users logging onto the the Notifier server from using its user interface. Click this button to create a new user who will be authorized to establish connection to an IGSS server from the Notifier module or Super Alarm. Allows you to edit the user name and password of the selected user. Removes the selected user from the list. Specify the TCP/IP port which will be used for communicating with the Notifier module or Super Alarm server. This setting should only be changed, if there's a conflict with the default port number. Click this button to insert the default port number which is Applications Tab Overview Use the Applications tab of the System Configuration form to:

26 Set up which user applications (Runtime modules) are to start automatically when the configuration is started. Set up which user applications (Runtime modules) are to start automatically when the configuration is started in back-up mode Set up which applications (Runtime and Design modules) are unavailable. Application is not available Select which applications are not available for the operator in the IGSS Master. Applications that are not available will be removed from the IGSS Master ribbon. Auto-start in normal mode Select which user applications to start automatically when the configuration is started. Only User applications (Runtime modules) can be started automatically. Auto-start in backup mode Select which user applications to start automatically when the configuration is started in backup mode. Only User applications (Runtime modules) can be started in backup mode. The type of IGSS station will determine if the Auto-start in backup mode column is available. IGSS stations that are enabled to start in backup mode (for example a dualized IGSS server or an single-user-backup operator station) will have the Auto-start in backup mode column available.

27 Chapter 1: Setting up IGSS Servers and Operator Stations 1.8 Overview How it works Downloading or uploading the system configuration In a multiuser system, the settings from System Configuration are saved in the configuration database, [MyConfig].mdb. This file is one of the four core configuration files shown in the illustration below. Typically, the IGSS configuration and the system configuration are maintained on the IGSS server. When changes are made to either, they are automatically downloaded to the operator stations in the system. It is also possible, however, to make changes to the configuration or the system configuration on one of the operator stations and then upload those changes to the IGSS server. In that case, the changes are first uploaded to the IGSS server which, in turn, makes sure that all the remaining operation stations are updated. Overview The illustration below gives you an overview of how the system configuration is distributed in a multiuser system.

28 Initial setup explained The following steps outline how you set up a multiuser system the first time. For detailed stepby-step procedures, refer to the "How To" book in the Table of Contents. 1. The configuration is created on the IGSS server. 2. All the stations of the system are defined and set up. From the IGSS Server you can set up the parameters for all the stations in the system. This makes it a lot easier to make the setup of the individual stations consistent. 3. The communication drivers and PLCs are set up. 4. The mimic diagrams are configured on the IGSS server and the IGSS configuration is installed. 5. On each operator station, the following is done:

29 Open the System Configuration program and specify the station type and name. The name must be exactly the same as the one specified on the IGSS Server. Launch the IGSS Starter program. When prompted for the server's address, specify the IP address of the IGSS Server. The IGSS configuration is now downloaded including the file [MyConfig].mdb which includes the entire system configuration. 6. When you subsequently open the System Configuration program on the operator station, the appropriate station name will be highlighted in the tree view. The parameters for the station have also been downloaded from the IGSS Server. 7. The IGSS configuration is now identical on all stations of the system. When changes are made on one of the stations in the system, they are automatically distributed to the other stations of the system. If required, the system can be set up to display a message before changes are downloaded or uploaded. See Also "Connect to another IGSS server from IGSS Master" on page 144 Brief description of station types The following descriptions give an overview of the different station types available in the IGSS system. Setting up of station types is done in the System Configuration module.

30 Station type (name) Server Single User Description The station type configured on the PC to be used as IGSS server in a network where one or more operator stations are also present. The station type chosen in a system with only one PC acting as both operator station and server.

31 Station type (name) Server with A/B switch, Primary Server with A/B switch, Secondary Server 1 in dualized system Server 2 in dualized system Operator Station Description This is a station type used in a redundant system. Selecting this station type sets up the Primary server in the network and this must be later paired with the corresponding Secondary server, which is the hot standby server. The solution is used mainly in cases where data is collected from remote locations with only one communications line into the central server site feeding data to the Primary server. The feeder line can then be switched (software wise or hardware wise) from the Primary to the Secondary server in the network. This switching feature also enables altering the IGSS system on the Secondary server while the Primary server is running. When changes are complete, operator stations are switched to this server, which now becomes the Primary server. The backup server station which is set up with a switch in event of Primary server failure. (See the description above for Server with A/B switch, Primary.) The primary server in a normal, dualized system. Network connections to all the same PLCs as Server 2 in a dualized system. The hot standby server station in a normal, dualized system. Network connections to all the same PLCs as Server 1 in a dualized system. The station type selected to function as a control and monitoring station in the network from which plant personnel carry out their duties. An IGSS server can manage up to 99 operator stations. Operator Station, Single User Backup Under normal operation the station functions as an ordinary operator station as long as there's a connection between it and the IGSS server. If, however, the connection between the server and the operator station fails, then this station automatically restarts as Single User Backup and will go into one of the following modes: Complete backup of the IGSS server: If the station has been configured in the System Configuration module without further underlying resources, then when it starts up in backup mode, it will assume the same function as the first server defined in the station tree. In other words, it will connect to the same nodes as the IGSS server originally was connected to and also fetch data from distributed drivers, if present. Limited backup of IGSS server. To prevent selected PLC

32 Station type (name) Description drivers present on the IGSS server from being activated when the Operator station goes into backup mode, open the System Configuration module, select the driver in question in the tree view on the left, click on the Advanced tab on the right, find the checkbox Single user backup and clear it. Operator Station, Distributed Driver Controlled backup of the IGSS server. If in System Configuration, driver and node resources have been set up for Operator Station, Single User Backup, then these will be activated when the station goes into backup mode. This type of operator station is thus able to activate more or fewer resources than are found on the IGSS server itself. If the backup station is to activate more drivers or nodes than the server, then these resources must be defined on the IGSS server as de-activated resources in order to be available for configuration purposes in the Definition module. The station functions as an operator station and activates driver(s) for the PLC(s) to which it's physically connected. The station collects process data and sends this data on to the IGSS server. The distributed driver solution is typically chosen in cases where PLCs are located at remote locations thus making it impractical to cable the PLC directly to the IGSS server.. Defining the stations in the system Introduction For each station in your IGSS system, you need to define a number of properties. These properties include the IGSS station type and station name. The Station tab When you define a station, the Station tab appears allowing you to choose the relevant station type and define a unique station name. When you choose a station type, the relevant set of properties and options will appear. Multiuser systems

33 In a multiuser system, define all the stations in the system from the IGSS Server. On each operator station, enter the System Configuration program and specify the station name exactly matching the one specified on the server. When the operator station establishes connection to the server, the configuration will be downloaded. IGSS will recognize the station name. If you open the System Configuration program again, this station name will be highlighted. Single user and server setup If you define one of the following station types, a number of setup tabs will appear in the right pane. Click here for further details: Server Single user Server with A/B switch, Primary Server with A/B switch, Secondary Server 1 or 2 in dualized system Operator station setup If you define one of the following operator station types, a limited number of setup tabs will appear. Click here for further details: Operator station Operator station, Distributed Driver (Backup) Operator station, Single User Server Backup Setting up an IGSS server or single user Introduction When you select an IGSS server or single user station in the tree view, a number of setup tabs appear in the right pane. This topic gives you an overview of the functionality. Click here for the step-by-step procedure. Example In this example, the IGSSServer_1 is a server in a dualized IGSS server system.

34 Overview of setup tabs The table below gives you an overview of the setup tabs available for an IGSS server or single user station. For help on the individual item on the tab, click the then click on the item. Station Tab page Description Station type (server, operator station, etc.) and

35 Tab page Description station name. Configuration Files Data management parameters such as scan intervals, base intervals and logging deadband. The lifetime of the key data files (alarm, log and.bcl files) and hour, day and month values for the standard reports. Furthermore, setup of synchronization of data files between a primary server and a dualized server. In the Backup field, a path is keyed in to the backup folder on the hard disk, and when the system is running, IGSS files are automatically backed up to the designated location. Access Control Alarm Supervise & Language Startup Data Collection Reports Key settings for the user administration functionality and setup of users for the Super Alarm program. Customization parameters for the Alarm module, for example, locking of alarm window and icon positions, alarm counter settings, etc. Customization parameters for the Supervise module, for example, locking of size and position of process diagrams and graphs Startup mode and auto start of IGSS runtime modules (Job Scheduler, WinPager, etc.). Parameters for the Data Collection engine: simulation mode, logging of PLC driver communication packets, etc. Setup of the alarm and log printers, report header and logo. See Also "Brief description of station types" on page 29 Setting up an operator station Introduction

36 When you select an operator station in the tree view, a limited number of setup tabs appear in the right pane. This topic gives you an overview of the functionality. Click here for the step-by-step procedure. STEP 1: Define the connection to the IGSS server The first time you open the System Configuration program, it is assumed that you've defined all the stations in the system on the IGSS server. The next step is to identify the current operator station and define the connection to the IGSS server(s). The latter is done on the Server & Backup tab. STEP 2: Download the configuration from the IGSS server Once the connection is defined, download the configuration from the IGSS server. The following core configuration files will be downloaded to the operator station: [MyConfig].elm The main configuration file [MyConfig].dsc The descriptor 1 file (information about the graphical display of objects) [MyConfig].mdb The configuration database (object names, descriptions, alarm texts, the system configuration, etc.) [MyConfig].ocf The OLE Compound File (information about ActiveX, OLE and VBA/Automation) STEP 3: Set up the operator station Open the System Configuration program again. It will now show you all the stations in the system. Select the current operator station and go through the setup tabs outlined below. Example The program allows you to customize the settings, for example, for the Supervise and Alarm programs. Most importantly, you define the connection to the IGSS server on the Server & Backup tab. 1 A descriptor is the graphical display of an object. IGSS includes many types of descriptors including: - Built-in standard symbols - Animated symbols (Symbol Factory library) - Graphics and animation - Drawing symbols - Windows controls - ActiveX controls An IGSS object can be represented with different descriptors on different diagrams.

37 Overview of setup tabs The table below gives you an overview of the setup tabs available for an operator station. For help on the individual item on the tab, click the then click on the item.

38 On this tab Station Server & Backup Startup Supervise & Language Alarm Access Control You define the following Station type and station name. The connection to the IGSS server(s) and backup system options (if you've purchased a Dualized System or Single-User Backup license). Startup mode and auto start of IGSS utility programs (Job Scheduler, WinPager, etc.). Customization parameters for the Supervise program, for example, locking of size and position of process diagrams and graphs. The language is also chosen here. Customization parameters for the Alarm program, for example, locking of alarm window and icon positions, alarm counter settings, etc. Key settings for the user administration functionality and setup of users for the Super Alarm program. For the station types Operator Station, Distributed Driver (Backup) and Operator Station, Single User Server Backup, the driver(s) must be able to run on the operator station. Thus the data collection parameters must be set up for this station. Data Collection Parameters for the Data Collection engine: simulation mode, logging of PLC driver communication packets, etc. See Also "Connect to another IGSS server from IGSS Master" on page 144 Redundancy solutions in IGSS There are two basic types of redundancy solutions available in the IGSS system: Hot standby server (also known as the dualized server) Single-user backup server. These redundancy options are safeguards against lost production output or safety hazards arising from the absence of online surveillance data. Neither solution (Hot standby or Single-User Backup) are included in the standard IGSS license. Each must be purchased separately.

39 Hot standby (or dualized) server As the name implies, this solution protects your system against server failure. By setting up a second, or dualized server, uninterrupted process surveillance and control is assured. The dualized (secondary) server runs parallel to the primary IGSS server. All process data received by the primary server is also received on the dualized server. If the primary IGSS server fails, the secondary IGSS server continues to function as a server, collecting process data and communicating with plant surveillance workstations. There is no loss of data or loss of process control due to the primary IGSS server failure. After recovery, the primary server resumes its normal function. The data collection gap present on the primary IGSS server, which occurred when it was offline, can remedied by merging missing data from the secondary IGSS server to the primary IGSS server. A/B switch This option is only chosen in the following two specific situations. The first is when there is only one transmission line available for communication between the IGSS server and remote PLCs. This might be the case, for example, in a context where the expense of leasing a second transmission line for communicating with outlying PLCs would be prohibitive. The second situation is when the PLCs are unable to communicate effectively with 2 servers simultaneously due to PLC resource limitations of one kind or another.

40 The A/B switch can be implemented as a software solution only, or with a physical hardware switch. In the hardware switch solution, the A/B switch box is installed with one switch position connected to each of the two servers, the primary server and the hot standby server. Additions or modifications to the running configuration can be implemented on the hot standby server by an administrator. When the changes are completed, the administrator switches plant surveillance workstations over to the hot standby server and then uploads the new configuration to the primary server. After the new configuration is in place on the primary server, the administrator once again switches surveillance workstations back to the primary server and the new configuration becomes the newest, valid operations configuration. The A/B switch is placed at the LAN/WAN periphery to control to which server data collection from remote PLCs is to be directed. Workstations are automatically switched to the hot standby server while the new configuration is being uploaded to the primary server, and back again when the new configuration is running on the primary server. These workstations need not be informed of the changes and are switched back and forth between the servers automatically. In the event of Primary server loss, the Secondary server goes into operation automatically and takes over as (new) Primary server. While the original Primary server has been in operation, all its data has automatically been replicated onto the Secondary server. (Implementation of this solution requires the following hardware from, for instance, Black Box: Ganged Switching System, Remote System Gang Controller and an RS-232/V.24 Line Sharer.) In the "soft switch" solution, the primary and the hot standby server are both connected to the PLCs. This solution assumes that the individual PLCs have two connections available to the data communication network. No other hardware is required.

41 For both A/B switch solutions, the appropriate station type for the servers must be correctly selected in the System Configuration program. In this case, AB primary must be selected for the primary IGSS server, and AB secondary must be selected for the hot standby server. Single-user backup server Another type of redundancy is the single-user backup server. This solution is often used in remote locations where process data collection and plant control must continue even in the event of a communications line failure into the IGSS server, or in situations where protection of only selected components in a plant is required. The single-user backup server is set up on an ordinary plant surveillance workstation. In the event of failure of the IGSS server, the workstation then restarts as a single-user backup server and fulfills the functions of both surveillance workstation and server at the same time. The process components to be safeguarded here must, of course, be connected to the single-user backup server in addition to having been connected to the IGSS server. If there is a need to maintain access to historical data when the IGSS server fails and the single-user backup server takes over, then installation of a separate file server which stores historical data is recommended.

42 See Also "What is synchronization of dualized servers?" on page 47 "Synchronization of data at startup" on page Add and Manage Stations Add a new station In a multiuser system, define all the stations and assign the appropriate station type. 1. Select Edit New Station or click the icon in the toolbar. A new station appears in the tree view. You can also add a new station using the New Configuration Wizard. In the File menu select New Configuration Wizard

43 icon in the toolbar. Follow the on-screen instruc- or click the tions. 2. In the Station type drop-down list, select the appropriate type. The number of options available depends on the chosen station type. Click the relevant type below to continue: Important: In a multiuser system all stations must be defined in System Configuration. This is typically done from the IGSS Server. Add a single user or server station Add an operator station Edit station properties 1. In the tree view, select the station whose properties you want to change. 2. Edit the properties, as required. Remove a station 1. In the tree view, select the station you want to remove. 2. Select Edit Remove or click the above icon. Define a Supervise mask You can set a background color and pattern which will be applied as a mask over any diagram in Supervise which is run from the IGSS server or accessed from the IGSS server. If a operator station connects to an IGSS server with a supervise mask enabled, all diagrams will be displayed with the supervise mask. By applying a mask over a configuration, you can provide a visible indication which IGSS server an operator station has connected to, for example if you have a live data environment

44 and an test environment, you can apply a bright red mask on the test environment IGSS server which will indicate to all operator stations that they are connected to a test environment with simulated data and perhaps still under development. The supervise mask consists of a background color and a mask pattern. The mask pattern is defined on the Supervise and Language tab in the System Configuration form The mask background color is defined on the Configuration tab in the System Configuration form. To define the Supervise mask pattern Make sure you are running in Design Mode in the IGSS Master. 1. In the IGSS Master, click Design and Setup tab > System Configuration button to open the System Configurationform. 2. In the System Configuration form, click the Supervise and Language tab > Setup indicator mask button to open the Setup Indication Mask form. 3. In the Indication Mask group, click the pixels to toggle the transparency on or off. If a pixel is toggled to black, the selected background color will be displayed in the pixel. If a pixel is toggled to white, the original background of the Supervise module will be displayed in the pixel. 4. You can see how the selected combinations and concentrations of pixels will look in the Sample field. To define the Supervise mask background color Make sure you are running in Design Mode in the IGSS Master. 1. In the IGSS Master, click Design and Setup tab > System Configuration button to open the System Configuration form. 2. Select the IGSS server in the left hand pane of the System Configuration form (Right-click the server name in the tree and select This PC). 3. In the System Configuration form, click the Configuration tab > Enable check box to enable display of the supervise mask. 4. Select the supervise mask color in the drop-down field to the right of the Enable check box.

45 5. In the System Configuration form, click File > Save Project and exit the System Configuration form. The IGSS configuration will re-start and deploy your changes. The Supervise mask and the IGSS Player mask If you are running IGSS Player functionality, the IGSS Player indicator color will replace of the Supervise Mask during playback. Both mask types (the IGSS Player mask and the Supervise mask) will use the same mask pattern defined in the Setup indicator mask form. The Setup indicator mask form is opened by clicking the Setup indicator mask button on the Supervise and Language tab in the System Configuration form. See Also 1.10 The IGSS Data Server The IGSS Data Server The challenge Throughout the years the volume of data collected and logged by IGSS for graph and reporting purposes has increased dramatically. In larger installations, this means that a simple operation as viewing a graph involves reading several Gigabytes of data. Luckily, the capacity of modern networks have grown almost just as fast as the volume of IGSS LOG data in typical LAN installations. However, in multi-user systems where one or more operator stations are connected to the IGSS Server with a WAN connection, problems may arise. The response time for an IGSS graph in WAN solutions could be way too long. The solution To overcome the above problem, the IGSS Data Server was implemented. The IGSS Data Server optimizes the use of the bandwidth between the IGSS Server and the WAN operator station. These operator stations will see a significant improvement in the response times when opening LOG-based graphs. Activating the IGSS Data Server The IGSS Data Server must be activated on the IGSS Server. It will by default run in the background without any user interface. When an operator station connects to the IGSS Server, it will detect whether the Data Server is running. If so, it will automatically use the Data Server when

46 fetching data for LOG-based graphs. If the Data Server is not activated, data fetching will be done as in earlier versions of IGSS. Auto starting the IGSS Data Server To auto start the Data Server, simply select the Data Server check box on the Startup tab for the IGSS Server. Manually starting the IGSS Data Server You can start the Data Server manually by typing the IGSSdataserver command in the Windows Command Prompt. It shows the following information:

47 Server state (running, stopped) Number of active clients (operator stations) Various data statistics You can run the Data Server in hidden mode. Simply right-click the icon in the upper left corner of the window and select Hide. Port numbers used Port number must be open on the IGSS Server to allow communication with the IGSS Data Server. If you are using a firewall, this port must be open Synchronization of Dualized Servers What is synchronization of dualized servers? If you are running your IGSS installation in a dualized IGSS server environment, each IGSS server is considered to be an independent IGSS server, collecting process data and fully capable of communicating with and controlling process components. Collected process data and server configurations must manually be synchronized between IGSS servers in order to ensure the configurations are identical on the two servers. If the configurations are not identical between the two IGSS servers, data inconsistencies will occur, especially if data synchronization is conducted after an IGSS server outage. Data synchronization If the primary IGSS server fails, process data is still collected by the secondary IGSS server. Communication with and control of process components is conducted through the secondary IGSS server. When the IGSS primary server resumes its normal function, a gap will exist in the process data on the primary IGSS server with the missing data existing on the secondary IGSS server. It is possible to merge the collected process data, but only BCL data can be merged. Alternatively, all process data can be copied to the IGSS server, but this can be time-consuming and the potential for data loss is high. For this reason, it is not recommended to synchronize all data files upon server startup. Data synchronization between two IGSS servers is set up in the System Configuration form > Startup tab > Synchronization of data at startup group Configuration synchronization You can run Server Synchronizer to synchronize the configuration between the two IGSS servers. When using the Server Synchronizer application, the oldest configuration files will be overwritten by the newest configuration files.

48 If you have edited the configuration elements on the primary IGSS server, the IGSS configuration on the secondary IGSS must be updated to ensure the configuration is identical on both IGSS servers. Local alarm acknowledgments and alarm inhibitions on one server also requires synchronization with the other server to ensure identical configurations. Local alarm Acknowledgments and inhibitions Alarm acknowledgments and alarm inhibitions made on local objects and not on PLC components are not part of the IGSS data collection as this data is stored in the local configuration. The local alarm acknowledgments and alarm inhibitions can be synchronized between the two dualized IGSS servers if the Server Synchronizer application is running when the alarm inhibitions and acknowledgments are made. If the Server Synchronizer application is not running, you cannot synchronize local alarm acknowledgments and alarm inhibitions between IGSS servers as this alarm data is now historical data which cannot be synchronized. The Server Synchronization (Sync Server) module The Server Synchronizer application can be used in a dualized IGSS server environment solution, (hot standby server solution) to ensure the configurations on both servers are identical.server Synchronizer can be run on any PC in the network on which the IGSS software has been installed. For example it could be run from one or the other of the two server PCs in the dualized system, from an IGSS operator station or from a dedicated PC, which only run the Server Synchronizer application. Do not run the Server Synchronizer from more than one machine. Doing so will result in synchronization errors for which no warning will be given. The following table describes actions and parameters which only edit and update the configuration on the primary IGSS server and that require the Server Synchronizer to be used to synchronize the configuration between the primary and secondary IGSS servers. These are typically configuration changes, which are not reflected in the PLCs to which the two servers in the dualized system are connected. Parameter Local Objects Local alarm acknowledgments Alarm inhibitions Description IGSS objects not found in the PLCs to which both servers are connected in a dualized system, i.e. objects created "locally" on the one or the other server. Acknowledgment of alarms where the alarm atom is set to local on the Edit Mapping tab under I/O mode. Operator initiated alarm blocking, which always originates "locally" due to operating personnel decision in light of specific situations.

49 In the Definition module you can create a digital object to monitor the states of the two dualized servers. For more info, click here. See Also "The Server Synchronizer Form" on page 49 "Configuring Server Synchronization parameters" on page 51 "Synchronization of data at startup" on page 54 The Server Synchronizer Form Use the Server Synchronizer form to define parameters for synchronization of the IGSS configuration between two dualized IGSS servers as well as to start and stop the synchronization process. Preconditions The IGSS Dualized Server license must be purchased and a secondary IGSS server must be setup and running online to synchronize the configuration between the two servers. Server synchronization can be started from any IGSS station on the network, a server or operator station or even an IGSS installed machine dedicated to only starting the synchronization. Where do I find it? Click the Server Synchronizer button found on the IGSS Master > Design and Setup tab to open the Server Synchronizer form. The Server Synchronization Configuration application will be displayed in the Detailed Status tab on the IGSS Master workspace in Normal Applications group. Field Help Field Name Server A - IP Address / Server name Server B - IP address / Server name Description Enter the IP address of one of the two dualized IGSS servers. The primary IGSS server is often used as Server A. Enter the IP address of one of the two dualized IGSS servers. The secondary IGSS server is often used as Server B.

50 Field Name Description Select this check box to display the following advanced settings: Show Advanced settings Use Slave server Automatically update the oldest Configuration Start minimized Advanced Settings Select this check box to use a Slave IGSS server. When this check box is selected, you must enter the IP address of the IGSS slave server in the field. Use Slave server Status information for the slave server will be displayed in the Slave Configuration status group. A dualized IGSS slave server is a third IGSS server in an dualized environment. AnIGSS slave server can receive process data and configuration updates, but cannot be used for process component control or sending/synchronizing from. Automatically update the oldest Configuration Start Minimized Select this check box to automatically synchronize any changes to the configuration between the two IGSS servers, updating the oldest configuration with the newest configuration. The synchronization process will upload any changes to an IGSS configuration to the other server and will run Check-and-Install procedure on the IGSS server which is synchronized. Select this check box to start the Server Synchronizer form in a minimized state. When running in minimized state, the Server Synchronizer form will be place in the Windows System Tray (The lower right-hand corner of the Windows desktop.) Display Information Only Server B - Sent changes Server A - Sent changes The number of local objects, local alarm acknowledgments and local alarm inhibitions sent from Server A to Server B during configuration synchronization between the IGSS servers. The number of local objects, local alarm acknowledgments and local alarm inhibitions sent from Server B to Server A during configuration synchronization between the IGSS servers.

51 Button Help Button Name Start Synchronizer Stop <- Update Server A Update Serve B -> Description Click this button to start the Server Synchronizer Application. The two IGSS servers must be online and running in order to start synchronizing. Click this button to stop the Server Synchronizer Application. Click this button to update the Server A with the configuration from Server B Click this button to update the Server B with the configuration from Server A See Also "Automatically synchronize configurations between IGSS servers" on page 52 "What is synchronization of dualized servers?" on page 47 "Configuring Server Synchronization parameters" on page 51 Configuring Server Synchronization parameters You can run the Server Synchronization (Sync Server) application to automatically synchronize local alarm acknowledgments and alarm inhibitions between two dualized IGSS servers. The Server Synchronization application can also be used to synchronize changes to the configuration between the two dualized IGSS servers. Server Synchronization will only synchronize objects if the configurations on the two servers are found to be identical. 1. Make sure that the two IGSS servers in the system are online and started. 2. In the IGSS Master > Design and Setup tab, click the Server Synchronization button to open the Server Synchronizer form. 3. In the IP address / Sever name fields, enter the respective IP addresses for Server A and for Server B. 4. Click the Start Synchronizer button to start data synchronization between the two selected IGSS servers. If the configurations on the two IGSS servers are not identical, you must select which server to upload to by clicking the appropriate button (Upload to Server A or Upload to Server B.)

52 5. When the configuration is identical on the two IGSS servers, click the Start Synchronizer button again to start the Server Synchronizer. Example In a dualized IGSS server environment, you want to start synchronization of all future alarm acknowledgments and alarm inhibitions on local objects in the configuration between the two IGSS servers. Both servers are started and are online. The Server Synchronizer form is opened and the IP addresses of the IGSS servers are entered. The Start button is clicked and the message appears telling you that Server A is old (compared to Server B). Before any synchronization can take place, the two configurations must be identical. Since Server A is identified as being old, click the Upload to Server A button to update the configuration on Server A with the configuration from Server B. Once both IGSS servers are identical, you can click the Start button again to start server synchronization and start synchronization of alarm acknowledgments and alarm inhibitions on local objects between the two servers. See also "Automatically synchronize configurations between IGSS servers" on page 52 "What is synchronization of dualized servers?" on page 47 Automatically synchronize configurations between IGSS servers You can set up server synchronization to automatically synchronize any changes to the configuration between the two IGSS servers. The Server Synchronizer will upload any changes to an IGSS configuration to the other server and will run Check-and-Install procedure on the IGSS server which is synchronized to ensure the other server is capable of running the configuration. To enable the Server Synchronizer to automatically synchronize configuration changes between IGSS servers: 1. Make sure that the two IGSS servers in the system are online and started. 2. In the IGSS Master > Design and Setup tab, click the Server Synchronizer button to open the Server Synchronizer form.

53 3. Enter the respective IP addresses for SERVER A and for SERVER B. 4. Select the Show advanced Settings check box to display the advanced server synchronizer settings. 5. Select the Upload new configuration to server automatically check box. 6. Click the Start Synchronizer button to start data synchronization between the two selected IGSS servers. 1. If the configurations on the two IGSS servers are not identical*, you must select which server to upload to by clicking the appropriate button (Upload to Server A or Upload to Server B.) 7. When the configuration is identical on the two IGSS servers, click the Start button again to start the Server Synchronizer. Working on one configuration only If you want to perform maintenance and/or updates on one configuration only, perhaps to test any changes on live data, clear the Automatically update the oldest Configuration check box and close the Server Synchronizer form to stop any server synchronization. Once the configuration changes have been tested and approved, use the Server Synchronizer form to upload the new configuration to the other IGSS server and restart the Server Synchronizer application. See Also "The Server Synchronizer Form" on page 49 "Manually synchronize configurations between IGSS servers" on page 53 Manually synchronize configurations between IGSS servers If you want to start the Server Synchronizer application to automatically synchronize local alarm acknowledgments and alarm inhibitions between two dualized IGSS servers, the configurations on the two IGSS servers must be identical. You can manually synchronize the configurations before starting the Server Synchronizer application - although you do not need to start the Server Synchronizer application in order to synchronize configurations. To manually synchronize configuration changes between two IGSS servers:

54 1. Make sure that the two IGSS servers in the system are online and started. 2. In the IGSS Master > Design and Setup tab, click the Server Synchronizer button to open the Server Synchronizer form. 3. Enter the respective IP addresses for SERVER A and for SERVER B. 4. Click the Start Synchronizer button to start data synchronization between the two selected IGSS servers. 1. If the configurations on the two IGSS servers are not identical, you must select which server to upload to by clicking the appropriate button (Upload to Server A or Upload to Server B.) 5. If you want to the Server Synchronizer application to start, click the Start Synchronizer button again, otherwise you can close the Server Synchronizer form. See Also "The Server Synchronizer Form" on page 49 "Automatically synchronize configurations between IGSS servers" on page 52 Synchronization of data at startup In a dualized IGSS server environment, you can enable data synchronization between the two IGSS server when a server starts. The synchronization parameters must be set up on each IGSS server in the Startup tab of the System Configuration form. In order to enable the data synchronization between IGSS servers, for each server, you must: 1. Specify the report folder of the other IGSS server, entering the path as a UNC path. 2. Select the data synchronization option: Copy all files available or Copy only files for the latest down period. 3. Select the file types to synchronize (Alarm, BCL and/or LOG files). Data synchronization options Copy all files available

55 If you select the Copy all files available data synchronization option, the IGSS configuration on both servers must be identical. If changes are made to the configuration before the two servers are synchronized, data loss may occur. Additionally, data synchronization between the IGSS servers may be time-consuming depending on the number and size of the data files to be synchronized. Copy only files for the latest down period If you select the Copy only files for the latest down period data synchronization option, only BCL files can be synchronized which means the IGSS configurations on both servers do not have to be identical. See Also "What is synchronization of dualized servers?" on page 47 Data synchronization options Copy all files available Copy only files for latest down period Files types to synchronize Alarm files BCL files Log files

56 Chapter 1: Setting up PLC Drivers 1.12 Driver Setup Overview Overview: IGSS drivers Definition An IGSS driver is a control program enabling the system to communicate with the devices (typically PLCs) which control the process. Schneider Electric has developed drivers for a wide range of communication protocols. Use You set up the driver(s) for a given configuration in the System Configuration form. Once defined, you can select the drivers in the Definition module and they will be activated when you start the configuration. How it works Click here to get a graphical overview of how drivers are defined. Types of drivers The supported PLC drivers can be divided into two main groups: PLCs using polled communication PLCs using the SICOS protocol (event-based communication) If your driver is using the SICOS protocol, additional parameters must be specified. The interface(s) and topology supported by the individual drivers differ. The visual presentation in the System Configuration form will thus vary dependent on the driver used. Supported drivers The list of supported drivers is continuously expanded. An up-to-date list is available on the web Site. Click the Product Info > PlC Drivers Supported to open a list of all the PLC drivers currently supported in IGSS as well as other driver details such as hardware and software requirements.

57 Managing drivers Adding a new driver To add a new driver, click Driver dialogue. and select the relevant driver in the Select Communication Tip: Click the column header to sort the items in the list. Editing driver properties When the driver is added, its name appears in the tree view pane and a number of property sheets appear to the right. Three tabs are general to all driver types, whereas SICOS drivers require additional parameters (see below). Click on a tab for details. Special SICOS parameters If you are using a SICOS driver, the General and Time Services tabs appear.

58 Click on a tab for details. Driver Information tab What it shows On this tab, you can view the following information: In this group Driver Information File Versions you see the following The name of the selected driver and its driver ID. The number of nodes and subnodes defined for this driver. The filename and version of the Driver DLL and the Configuration DLL. How it looks The figure below shows the Driver Information tab.

59 Advanced tab What it shows On this tab, you can specify the following: In this group Activation Condition Activation Interval Driver Messages per Channel Segment Length you can specify where the driver is activated. Typically, the driver runs on the server, but if you are using distributed drivers, it can run on the operator station. How often you want to activate the driver. How many messages the driver must be able to handle concurrently. The max. length of a message segment supported by the PLC.

60 How it looks The figure below shows the Advanced tab. External Types tab What it shows On this tab, you can enable or disable the relevant external types (PLC data types) for numerical values and string values. In most cases, the default choices will be relevant, but you can change them, if necessary. The changes made on this tab are global to the selected driver. If the driver is part of another configuration, the changes will also apply here. External types

61 The external type is a central concept in IGSS. When you specify the external type as part of the PLC address, IGSS knows how to interpret the incoming value from the PLC, so that a meaningful value is shown during supervision. For details about the individual external types, click here. The external type is selected as part of the PLC address on the Edit Mapping tab in the Definition program as shown below. The drop-down list contains the external types which are enabled in System Configuration (see figure below). How it looks The figure below shows the External Types tab.

62 Add and Manage Drivers Add a new driver 1. Select Edit New Driver or click the icon above. The Select Communication Driver dialogue appears. To add a new driver, you can also right-click the station name and select New Driver. 2. Double-click the driver you want to add. Sort the list by clicking a column header.

63 Result: The driver name is added to the tree view. If the driver only supports one interface type, it is automatically added. 3. Edit the driver properties, as required. 4. When you have made the necessary changes, click the button below. Add a new interface Edit driver properties 1. In the tree view, select the driver whose properties you want to change. 2. Edit the properties, as required. For details about a property tab, click its name below. Changes made on the External Types tab are global to the selected driver. Suspend a driver In some special situations, you may want to suspend a driver. For example, if the process components connected to its associated PLCs are being serviced, the values received by IGSS will be erroneous. In that case, you can suspend the driver temporarily by following this procedure: 1. Right-click the driver you want to suspend. 2. Select Suspend driver. Result: The driver is now suspended and will not collect data from its associated PLCs until you select this menu item again. A red cross appears in the tree view clearly indicating that the driver is suspended.

64 Remove a driver 1. In the tree view, select the driver you want to remove. 2. Select Edit Remove or click the above icon. A confirmation message appears. 3. Click Yes to remove the driver. You can also right-click the interface and select Remove Driver. Import and Export Driver Settings Import/Export files (*.ixd) All settings defined in System Configuration can be exported and imported. You can - Export driver settings from v2 to an export file (*.ixd) Export driver settings from the current version to an export file (*.ixd) Import driver settings into the current version from either of the two sources above Export IGSS v2 driver settings You can export the driver settings from the active v2 driver profile for the purpose of importing those settings into the current version. This function will read the settings for the active driver profile in the Windows Registry. 1. Select Tools Export IGSS V2 Driver Settings. The Save As dialog box appears. 2. Give the export file a meaningful name, for example, MyDrvSetupv2.idx and click Save.

65 3. To import these settings, open the relevant configuration and select Tools Import IGSS Driver Settings. Export IGSS v8 driver settings You can export the driver settings to a file for the purpose of importing those settings into another configuration. The typical case is when you are configuring the drivers at your own office and want to copy these settings onto the IGSS server at the plant. 1. Select Tools Export IGSS v8 Driver Settings. The Save As dialog box appears. 2. Give the export file a meaningful name, for example, MyDrvSetupv8.idx and click Save. 3. To import these settings, open the relevant configuration in the System Configuration program and select Tools Import IGSS Driver Settings. Import IGSS driver settings You can now import the driver settings saved in an IGSS driver file (*.idx) exported from either v2 or the current version. 1. Open the relevant configuration in the System Configuration program. 2. Select Tools Import IGSS Driver Settings. The Open dialog box appears. 3. Find the relevant IGSS driver file (*.idx). 4. Click Open. The settings are imported Interface Setup Overview Types of interfaces Two main types of interfaces A driver can use one of the two main interface types:

66 Serial connection (COM port, modem or other scheduled connection) Driver-specific interface (proprietary interface card or standard network card) COM port connection If the PLC and the PC are directly connected with a serial cable, select this option on the Connection Type tab and configure the COM port on the Serial Port tab. Modem connection If the PLC and the PC are connected via a modem, select this option on the Connection Type tab and configure the modem, as required. Remember to set the special parameters for remote connections on the Remote tab. Other scheduled connection connection If the PLC and the PC are connected via another type of scheduled connection, select this option on the Connection Type tab. Configure the COM port on the Serial Port tab and remember to set the special parameters for remote connections on the Remote tab. Device-specific interface Some drivers do not support any of the above serial connections, but only connections via device-specific interface cards or standard network cards. When you add such a driver, this icon one or more property sheets are shown. appears in the tree view. Dependent on the interface, Refer to the manufacturer s documentation for further information. Managing interfaces Adding interfaces To add a new interface, right-click the relevant driver and select New Interface in the popup menu or click the above icon.

67 By default, a relevant interface is added, for example, a COM port represented as view. in the tree To change the connection type, simply select another type on the Connection Type tab. Editing interface properties To edit interface properties, select the interface in the tree view, then edit the properties on the tabs displayed. For further information on the individual tabs, click here. Deleting interfaces To delete an interface, select it in the tree view, then click Connection Type tab What it shows When you select a serial connection in the tree view, this tab appears. It allows you to select the connection type as follows: Select this option if the PLC and PC are directly connected via a serial cable. connected via modem. Use the Configure Connection and Configure Modem buttons to configure the modem. connected via a other scheduled connection. How it looks The figure below shows the Connection Type tab.

68 Serial Port tab What it shows When you select a serial connection in the tree view, this tab appears. It allows you to select the relevant COM port and configure it as follows: This dialog box item Select communications port allows you to select the relevant COM port to which the PLC is connected.

69 Serial Port Settings set the communication parameters for the selected COM port, as required. Note: The number of parameters that can be changed depends on the selected driver. How it looks The figure below shows the Serial Port tab.

70 Remote tab What it shows When you select a serial connection in the tree view, this tab appears. It allows you to specify special parameters for remote connections (modem or other scheduled connection): In this group Handling of incoming calls you must specify a PLC address where IGSS can read the logical node number of the PLC. This ensures that the data will be associated with the correct node number in IGSS.

71 Indication of Successful Call Handling a value at a specific PLC address where IGSS can indicate that all data has been successfully scanned (current and historical values). IGSS will disconnect once this value is written to the specified address. How it looks The figure below shows the Remote tab. Driver-specific tabs Introduction

72 If your driver supports only one specific interface, it will be automatically added when you add the driver. One or more property sheets will appear showing the specific parameters you can set. For further information about the individual properties, refer to the manufacturer s documentation. Example: Profibus FMS protocol driver interface The figure below shows the Device Settings tab for the above interface.

73 Add and Manage Interfaces Add a new interface 1. In the tree view, select the driver to which you want to add an interface. If the selected driver only supports one interface type, it is already shown in the tree view. 2. Select Edit New Interface or click the above icon. 3. Click the interface you want to use: Direct connection (COM port) Modem connection Other scheduled connection Driver-specific interface Edit interface properties 1. In the tree view, select the interface whose properties you want to change. 2. Edit the properties, as required. For details about a tab, click its name below. Suspend an interface In some special situations, you may want to suspend an interface of a driver. For example, if you have a dial-up connection and the modem is not currently working or being serviced. You can suspend the interface as follows:

74 1. Right-click the relevant driver. 2. Select Suspend interface. Result: The interface is now suspended and will not collect data from its associated PLCs until you select this menu item again. The interface will be clearly marked with a red cross to indicate the suspended mode. Remove an interface 1. In the tree view, select the interface you want to remove. 2. Select Edit Remove or click the above icon. A confirmation message appears. 3. Click Yes to remove the interface. You can also right-click the interface and select Remove Device Node Setup Overview What is a node in IGSS? Definition A node represents a physical control device in the process (typically a PLC). Each node has a logical node number that is used by IGSS to identify the PLC. When IGSS knows this number, it can associate the correct process values with the corresponding process components (which are connected to the PLC). Example: An IGSS network The figure below shows a simple IGSS network with a server, two operator stations and three PLCs (nodes). Each node has a logical node number that identifies it in the system the IGSS node number.

75 Identifying the node When you define a process component in the Definition program, you must indicate which PLC (node) it is connected to. This is done on the Edit Mapping tab of the object properties dialog box. Open the dialog box by double-clicking the symbol representing the process component. For further details click here. Managing nodes Adding nodes To add a node, right-click the relevant interface in the tree view and select New Node or click the above icon in the toolbar. A default node number is added which you can change on the Node Properties tab.

76 Editing node properties To edit node properties, select the relevant node in the tree view, then edit the properties on the tabs displayed. The number of tabs depend on the driver you use, the interface configuration, etc. The table below shows the tabs displayed for different configurations. Click a tab for further information. Note: Apart from the tabs below, driver-specific tabs may also appear. For this type of interface these tabs appear Direct connection via COM port Scheduled connection (for example, modem or radio link) SICOS driver Deleting nodes To delete a node, select it in the tree view, then click the icon in the toolbar. Node Properties tab What it shows When you select a node in the tree view, this tab appears. The properties displayed are driverspecific, but the following properties are always displayed: This property IGSS node number allows you to specify the logical node number of the PLC. This is the node number you select in Definition when you define a process component (IGSS

77 object). Telegram Retries adjust the number of times you want the driver to retry sending of telegrams to the node. The default setting is 3. How it looks The figure below shows the Node Properties tab for the Siemens AS511 interface driver. Advanced tab - Overview What it shows When you select a node in the tree view, this tab appears (except for SICOS drivers).

78 It includes four subtabs that allow you to send special telegrams to and from the selected node (PLC). Together, these telegrams are called extended services. They include system start, time synchronisation and keep alive telegrams. Note: To use all the extended services, you must enable the mailbox and specify its location and size within the PLC where IGSS can post the special telegrams. How it looks The figure below shows the four tabs. Click on any of them for further information. Advanced - Mailbox tab What it shows When you select a node in the tree view, this subtab appears on the Advanced tab (except for SICOS drivers). The following properties are available: This property Enable mailbox allows you to enable the mailbox. Note: You must enable the mailbox to use all the extended services and to define subnodes. PLC address Mailbox length specify the exact PLC address where the special telegrams (extended services) should be written to. specify the number of words allocated for the special telegrams. The required number of words depends on how many telegrams you use and their data format. In most cases, 20 words will be sufficient. How it looks The figure below shows the Mailbox tab.

79 Advanced - System Events tab What it shows When you select a node in the tree view, this subtab appears on the Advanced tab (except for SICOS drivers). The following properties are available:

80 Note: You must enable the mailbox on the Mailbox tab in order to use system event telegrams. In this group you can Telegram format System Start Notification Alarm Change Notification enable the system start telegram which is sent to the PLC when the IGSS configuration is started (DC). enable the alarm change telegram and specify the min. and max. alarm priorities to be reported. The telegram is sent if the alarm count changes in the running IGSS configuration. For details on the system start telegram, click here. For details on the alarm change telegram, click here. Two preconditions must be met, before the telegram is sent: The alarm priority must be within the specified min. and max. range. The To PLC option must be selected for the alarm text in question. This is done in the Edit Alarm Description dialog box in Definition. How it looks The figure below shows the System Events tab.

81 Advanced - Time Services tab What it shows When you select a node in the tree view, this subtab appears on the Advanced tab (except for SICOS drivers). The following properties are available: In this group you can Telegram format Send/Receive Time Synchronisation Telegrams enable the time synchronisation telegram and choose whether the node is the For details on the time synchronisation telegram, click here.

82 time slave or master. Time Stamp Use UTC 1 for Time Stamps include a time stamp in all telegram headers sent from the PC to the PLC enable the universal time format, UTC or use local time. For details on the time stamp telegram, click here. - How it looks The figure below shows the Time Services tab. 1 Universal Time Coordinated (formerly Greenwich Mean Time), used as the basis for calculating time in most parts of the world. IGSS uses this time format internally in the database. You can switch between UTC and local time by enabling or disabling the "UTC" field in various dialog boxes in the system.

83 Advanced - Keep Alive Services tab What it shows When you select a node in the tree view, this subtab appears on the Advanced tab (except for SICOS drivers). The following properties are available: This property allows you to Telegram format Keep Alive PC à PLC send keep alive telegrams from IGSS to the PLC with a fixed interval. For details on the keep alive telegram, click here.

84 Keep Alive PLC à PC send keep alive telegrams from the PLC to IGSS with a fixed interval. For details on the keep alive telegram, click here. If the keep alive interval times out, alarm no. 46 No heartbeat received will occur in the alarm list. Note: The Driver object which is included in every IGSS configuration you create monitors the communication at the driver level between the PLC and IGSS. The keep alive function monitors the communication at the node level. How it looks The figure below shows the Keep Alive Services tab.

85 Remote Connection tab (remote only) What it shows When you select a node in the tree view which is reached via a remote connection (modem or other scheduled connection), this tab appears. The following properties are available: This property Phone number Connect at specific points in time allows you to type the phone number of the PLC you want to connect to. connect to the PLC at specific times. Click Edit to define the times. Connect at fixed time inter- connect to the PLC with a fixed time interval (given in

86 vals Connection hold time minutes). specify the time you want to hold the remote connection open when the operator goes manually online or sends a command to the remote PLC. How it looks The figure below shows the Remote Connection tab. Connection Misc. tab (remote only) What it shows

87 When you select a node in the tree view which is reached via a remote connection (modem or other scheduled connection), this tab appears. The following properties are available: In this group Collecting Historical Data Connection Status and Control Callback to Node you can configure where you want IGSS to collect historical data. Click Configure to make the definitions. specify the PLC address for a digital object in your IGSS configuration that shows you the connection status. The object is created in Definition. Click here to learn how. make IGSS perform a callback to the node when the latter makes an unsolicited connection with the PC. Note In most cases, you will not enable this option, because it means that it will take longer to get the data that the node was trying to deliver to IGSS. But in some cases, the driver may require that you do it. How it looks The figure below shows the Connection Misc tab.

88 Add and Manage Nodes Add a new node 1. In the tree view, select the interface to which you want to add a node. 2. In some cases, the node is automatically added with the interface. In that case, skip the next step. 3. Select Edit New Node or click the above icon in the toolbar. A new node number and icon appears in the tree view. 4. Edit the node properties, as required.

89 5. If you want to add a subnode, click the button below. Add a new subnode If you want to add subnodes and use the extended services, you must enable the mailbox on the Advanced tab (SICOS drivers excepted). Edit node properties 1. In the tree view, select the node whose properties you want to change. 2. Edit the node properties, as required. For details about a tab, click its name below. If you want to add subnodes and use the extended services, you must enable the mailbox on the Advanced tab (SICOS drivers excepted). Suspend a node In some situations, you may want to suspend a node. For example, if the process components that are connected to a certain PLC are being serviced and thus provide erroneous values to IGSS. You can suspend the node as follows: 1. Right-click the node you want to suspend. 2. Select Suspend node. The node is now suspended and will not collect data from its associated process components until you select this menu item again.

90 If you suspend a manager node, all its associated subnodes will also be suspended because IGSS only communicates with the manager node. Remove a node 1. In the tree view, select the node you want to remove. 2. Select Edit Remove or click the above icon in the toolbar. A confirmation message appears. 3. Click Yes to remove the node. You can also right-click the node and select Remove Node. Collecting Historical Data from a Remote PLC Collecting historical data from a remote PLC Introduction In some IGSS installations remote PLCs will collect process data. A typical example could be remote pump stations for a wastewater treatment plant. These PLCs are not online all the time, but are automatically dialed up with a fixed interval (for example, twice a day). The dial up schedule is set up on the Remote Connection tab. Also the operator can manually dial up the remote PLC. During the offline period, the remote PLC will store process values with a given interval. Some PLCs will even support storing of events (only changes in process values are stored). This is what we call historical data. The historical data can be collected by IGSS when the remote PLC is online by following the procedure below.

91 To allow the operator to create graphs and reports for the monitored objects, the historical data must be saved in the IGSS log files and the.bcl files. Example To illustrate the functionality, we will make an example based on the IGSS Demo Configuration. We will go through the following steps: 1. In System Configuration add the remote PLC using the General Comli 31 protocol driver. 2. In System Configuration, define the Historical Data Settings. 3. In Definition, create the object that collects historical data. 4. In Definition, create a graph that shows the historical data. 5. In Supervise, show the graph Subnode Setup Overview What is a subnode? A subnode is a node (PLC) which communicates with IGSS through a gateway node (the Manager node). Manager node and subnode All communication between a subnode and IGSS is routed via the manager node which is therefore the communication gateway for IGSSas depicted in the illustration below.

92 Preconditions To define a subnode, the following preconditions must be met: The PLC program in the Manager node must be written to support subnodes The mailbox must be enabled for the manager node. The mailbox is an address area on the manager node reserved for communication with the subnode. All SICOS drivers support subnodes and do not require a mailbox.

93 Managing subnodes Adding subnodes To add a subnode, right-click the relevant manager node in the tree view, then select New Subnode in the menu or click the above icon. A default subnode number is added which you can change on the Subnode Properties tab. Editing subnode properties To edit subnode properties, select the relevant subnode in the tree view, then edit the properties on the Subnode Properties tab. Click the tab below for details. For a SICOS driver, the properties are a bit different. Click the tab below for details. Deleting subnodes To delete a subnode, select it in the tree view, then click the icon above. Subnode Properties tab What it shows When you select a subnode in the tree view, this tab appears. The following properties are available:

94 This property IGSS subnode number Keep Alive PLC à PC allows you to define the node number for the PLC the one you address in Definition. enable keep alive telegrams from the subnode to IGSS and define the appropriate interval. If the keep alive interval times out, alarm no. 46 No heartbeat received will occur in the alarm list. Note: The Driver object, which is predefined in a new IGSS configuration, monitors the communication at the driver level between the PLC and IGSS. The keep alive function monitors the communication at the node level. For details about a property, click, then click the item. How it looks The figure below shows the Subnode Properties tab.

95 Add and Manage Subnodes Add a new subnode To be able to add a subnode, the mailbox must be enabled for the manager node on the Advanced tab (SICOS drivers excepted). All communication with the subnode is handled by the manager node. 1. In the tree view, select the node (manager node) to which you want to add a subnode.

96 Select Edit New Subnode or click the above icon in the toolbar. A new subnode number and icon appear in the tree view. 2. Edit the subnode properties, as required. Edit subnode properties 1. In the tree view, select the subnode whose properties you want to change. 2. Edit the subnode properties, as required. Remove a subnode 1. In the tree view, select the subnode you want to remove. 2. Select Edit Remove or click the above icon in the toolbar. A confirmation message appears. 3. Click Yes to remove the subnode. You can also right-click the subnode and select Remove Subnode.

97 Chapter 1: Event-driven communication 1.16 Introducing Event-Driven Communication Introduction The purpose of this document is to describe the event-oriented communication protocol used by the IGSS application and especially to document the layout/format of telegrams used by eventoriented communication. The basic idea behind event-oriented communication is to let the external equipment (normally PLCs) send unsolicited data to the IGSS. This means that the IGSS application is constantly listening for any data being send from external equipment thus reducing the communication overhead associated with traditional data polling. Event-oriented communication can be combined with traditional data polling in order to provide maximum flexibility by use of the eventoriented protocols and at the same time keeping it simple with traditional cyclic polling. Notes Throughout this document, the layout of bytes is shown as it is represented in the PLCs, i.e. with the least significant byte on the left. This is the opposite of the PC convention. Data sent from the PLC to IGSS should be sent in chronologically correct sequences, i.e. an object should never receive data older than the current object value Topology and Addressing Addressing The event-oriented protocol is originally designed for use with Simatic PLC equipment. This means that the addressing method used is designed to fit to this type of PLCs but other PLC types and protocols might also be used. Please look into the documentation for the individual driver to get detailed information on how to use event-oriented communication. The addressing of data values are as follows (note that an integral number of 16-bit words must always be transferred): A number of data words in any ordinary data block in a direct node is addressed via the following components: - Node number Data Block Word offset Word length

98 1.18 Message Protocols and Format Message Format The message body format is defined with the aim of providing an efficient means of communication for a large number of object values, while also keeping the format flexible enough for easy single object value transfer. The following modes are foreseen: 1) Communicating a single object value change: - Time stamp packet (optional) - Address and value packet 2) Communicating a number of changes from different sources: - Time stamp packet (optional) - Address and value packet (1st object) - Address and value packet (2nd object) Address and value packet (nth object) Optionally extra time packets can be interspersed if the times are different. 3) Communicating a large number of values from a single source: - Time stamp packet (optional) - Value packet: Address of data block area A number of words defining many object values The latter form will be particularly efficient in a start up or re-synchronization phase, where all object values must be sent to IGSS. Message Protocols This section describes the standard data transfer protocols used, and specifies the message format supported.

99 Data objects that are configured for direct transfer have their values transferred in the backward compatible mode, i.e. the node number is implied by the connection, and the data block, word offset, and word length are part of the standard protocol message header. The message body just contains the object data values corresponding to the addressed DB area. Data objects configured for indirect event oriented transfer use the standard protocols with protocol addressing of the status/command area of the manager node, and an extended message body format, as specified below: The protocol header specifies the word length of the message body. The message body consists of one or more consecutive packets. Each packet has the following format: Byte: Packet type - Byte: Word length of packet data (w) - Word: w words of data The format of the data words depends on the packet type. Three kinds are currently defined, where one or more kinds of data may be present for a given packet type: Time Address Object Value Time Consists of 6 or 8 bytes of BCD coded information according to DIN 19244: Byte: Second - Byte: Minute - Byte: Hour - Byte: Day - Byte: Month - Byte: Year

100 - Byte: Status, bit(4) = 1: daylight-saving time, bit(0) = 1: keep time until next time packet - Byte: 10s or 100s of milliseconds If the packet length is only 3 words then no status or millisecond bytes are expected. IGSS does not support daylight saving time and does not support the millisecond count. The time stamp remains in effect for the following packets in the message - and, if bit 0 of the status byte is set, also the packets in subsequent messages - until another time packet is encountered. If the time stamp packet is not present in a message, IGSS applies its own time to the received data. Address Used to relate the packet to a particular data area in the client (which may be the manager node itself): - Byte: Node Byte: Data block Word: Word offset Object values The values that are to be assigned to the objects configured in IGSS. Seen from a communications point of view these data are transferred transparently. The interpretation of the data is specified in the "Packet Types" section External Data Types External data types Event-oriented communication supports external data types in the same manner as polled communication. The external data types available for the individual driver are listed in the System Configuration form. For further details, click here.

101 These external data types can then be selected as part of the PLC address on the Edit Mapping tab of the Object Properties form Packet Types Packet Types One or more packets are located in each message as described in "Message Protocols and Format". The packet types currently defined are listed below. The packet type is determined from the value of the first byte in the packet. Click on the packet type for further details. 1. Ordinary data packet 2. Message time packet 3. Request time synchronisation packet 4. Time synchronisation packet 5. System start packet 6. System reset packet 7. Keep alive packet 8. Alarm change packet 9. Communications error packet 10. Address List Request packet 11. Address List Response packet Ordinary Data Packet The data packet contains the start address as specified by node, DB, and word offset. All IGSS objects configured with addresses lying in the range from this start address to the end of the data area as defined by the packet length are defined to be part of the packet. If IGSS receives the packet, then all these objects are evaluated and their new values are stored together with the current time stamp.

102 If IGSS sends the packet, then it contains the current values of all objects defined in the area, except in the case where several digital commands are defined within one word. In this case, only the command that was actually issued is set - all other command bits in the word being binary zero. For more details about PLC drivers and Tuning and optimizing data communication, see the online help for the System Configuration module found in the Help pane for the IGSS master. Message Time Packet The message time packet contains the time stamp defined as 6 or 8 bytes as specified in Message Protocols and Format. The current time for the message is set to this time. All values that are evaluated within this message until the next message time packet is encountered will be stamped with this time; however, if bit 0 of the status field is set, the time specified by the packet is used also for packets in following messages, until a new time packet is encountered. Only bit 0 in the Status field is evaluated; all other bits in this field are ignored. If no message time stamp has been found in the message, the system time will be used to stamp the object values. If a message time stamp is invalid (e.g. seconds greater than 59) the following packets in the message - and, if bit 0 of the Status field is set, also those of following messages - are discarded until a valid message time packet is encountered. 2 3, 4 or 5 Second Hour Month Status msec Minute Day Year msec/10 (divided by 10) Within IGSS, each manager node can be configured to receive message time packets in all messages sent from IGSS. If so configured, each message from IGSS will contain exactly one message time packet as the first packet in each message. Request Time Synchronisation Packet

103 This packet consists of the type and length byte only. The receiver should respond with a time synchronisation packet as soon as possible. Time Synchronization Packet This packet contains the system time of the sender. This time is to be used to set the system time of the receiver. The synchronization may be sent as a response to a request time synchronization packet, or IGSS may send it at regular intervals to a manager node, if this node is so configured in IGSS. IGSS will respond to time synchronization from only one manager node, according to IGSS node configuration. 4 3 or 4 Second Hour Month Status Minute Day Year MSec. System Start Packet The system start packet contains the time when the system was last active. IGSS will send this packet to all manager nodes that are so configured. These nodes are then expected to send all object changes that have occurred since the specified time. Alternatively, they may send a copy of all object values, if this is more efficient. IGSS will ignore the reception of a system start packet.

104 System Reset Packet The system reset packet contains a start address and a single data word. When IGSS receives the reset packet, it will invalidate the values of a range of objects. Word length < 0: The values of all objects configured in the specified Client node will be invalidated. Word length = 0: The values of all objects configured in the specified Client node and Data Block will be invalidated. Word length > 0: The values of all objects configured in the specified Client node and Data Block, from the specified Word Offset and Word length words forward, will be invalidated. IGSS will not send any system reset packets. Keep Alive Packet The keep alive packet contains an address and a single data word. This packet is used to monitor whether nodes are running properly at the application level. IGSS can only monitor directly connected nodes, and only at the communication level, unless keep alive packets are used. If an object is configured as a keep alive object for a given node, then IGSS will monitor this object for changes within the configured time interval. If no changes occur, then an alarm is generated for the object. The time interval is reset every time a keep alive packet having a value different from the current value is received.

105 If the keep alive object for a given node is also configured with an output component, then IGSS will send a keep alive packet at the configured frequency to the node. The heartbeat value transmitted will step through the configured range, being incremented by one unit each time. Alarm Change Packet An alarm priority level (pr_low) can be specified for each node, causing IGSS to send an alarm change packet to the node whenever the active and/or acknowledged alarm count changes for a priority at or above pr_low. An alarm is understood to be active when it is not ended and/or not acknowledged. The alarm change packet specifies, for each priority at or above pr_low, the number of active alarms, and how many of these alarms are acknowledged. 1 <= pr_low <= hp hp: Highest alarm priority level The low and high alarm priority levels are defined in the System Configuration form. Communications Error Packet This packet has two uses: 1) When a bad packet is received, a Communications Error packet returns the bad packet back to its originating application. In this case, a bad packet is in principle caused by the originating application and not by communication errors, as such errors should be detected and handled by the communications protocol. In this case, the Error Group field must equal 45 (decimal). A reason code specifies the reason for the packet being discarded, as follows:

106 1: Unknown type 2: Word length field is invalid, too long, or incompatible with the type field 3: The packet contains obviously nonsensical data (e.g. a message time packet specifying a month that is zero or greater than 12) If the Word length field of the bad packet is in any way untrustworthy, the remainder of the message containing the bad packet is assumed to be part of the bad packet and is discarded. Error group = 45 2) The PLC application can generate a user-specified alarm in IGSS, with the field "Error group" specifying the alarm number. 30 <= Error group <= 39 Address List Request Packet A node may request a list of process I/O addresses used by IGSS and IGSS will respond with an Address List Response Packet. IGSS will not send any Address List Request packets. The List type field The List type field specifies whether a list of nodes, data blocks or word offsets is requested:

107 List type = 0: List of nodes is requested. The Node and Data Block fields are ignored. List type = 1: List of Data Blocks is requested. The Node field specifies the node for which the list of Data Blocks is requested. List type = 2: List of Word Offsets is requested. The Node and Data Block fields specify the node and Data Block for which the list of Word Offsets is requested. The Access field The Access field specifies whether the list is of input addresses, output addresses, or both: Bit 0 set: Input addresses are requested. Bit 1 set: Output addresses are requested. Both bit 0 and bit 1 may be set; other bits are ignored. If neither bit 0 nor bit 1 is set, then the packet will be discarded and an Error Received packet will be returned. Address List Response Packet On receiving an Address List Request packet, IGSS will, as soon as possible, send an Address List Response packet. The Node, Data Block, List type and Access fields are identical to those in the corresponding received Address List Request packet. The Address List Response packet contains a bit string specifying which process I/O addresses are used by IGSS: Examples List type = 0 (list of nodes), bits 6, 41, and 206 in the bit stream are set: Nodes 6, 41, and 206 are used. List type = 1 (list of DBs), Node = 6, bits 0, 100, 101 and 102 in the bit stream are set: DBs 0, 100, 101, and 102 in node 6 are used. List type = 2 (list of word offsets), Node = 6, Data Block = 100, bits 0, 1, 10, 11, 12 and 13 in the bit stream are set: word offsets 0, 1, 10, 11, 12 and 13 in node 6 are used.

108 The bit stream is in standard Intel format (in the blocks shown below, the least-significant byte is shown to the left).

109 Chapter 1: Driver Error Codes 1.21 Introduction to error codes Once the communication with the PLC is up and running, you will need information about any communication errors you run into. Driver errors are associated with the built-in Driver object. These errors are shown in the Alarm List as hexadecimal codes in the Worst Value field. If you see a driver error in the Alarm List, right-click on the alarm and select Driver Error Help in the popup menu. For a complete list of error codes for the driver in question, select Driver Help in the rightclick menu Driver error codes in the Alarm List Viewing error codes A driver communication error will result in an alarm in the Alarm List. The Alarm number will be one of the predefined alarm numbers for driver errors. The Alarm text will be the general alarm text associated with that number. The driver error code itself is shown in the Worst Value field. Its syntax is described below. Help on error codes If you get a driver error, right-click the alarm line and choose Driver Error Help. To view the full list of driver-specific error codes, choose Driver Help. Error code syntax A driver error code consists of three or four elements separated by periods. The first three elements are always there, whereas the fourth element is an extended error code. The error code convention is as follows: <Drv No>.<Node No>.<IGSS error code>.<extended error code> where:

110 Syntax Description Format Example <Drv No> <Node No> is the number of the driver used. You can find the driver ID in the ID column of the Select Communication Driver dialog or on the Driver Information tab for the selected driver. is the node number assigned to the PLC in the System Configuration program Decimal 19 (Telemechanique Xway protocol driver - 7TXWAY) Decimal 05 for node number 5 <IGSS error code> is the IGSS error code Hexadecimal 130A <Extended error code> Is the extended error code which typically comes from the PLC or the PLC interface software Hexadecimal 0c02 The full error code in the Worst value field would thus be A.0c List of general driver error codes IGSS includes a number of predefined alarms used for reporting general driver communication errors in the Alarm List. The alarms will be reported on the predefined driver communication object named Driver or the relevant node status object, if defined. The communication errors can also be viewed in the Communications viewer in the IGSS Master module. Alarm no. in Alarm List Alarm text in Alarm List 10 Global driver configuration error 11 Global driver resource problem 12 Servers def time not the same 20 Errors occurred during input fm port 21 Errors occurred while output to port

111 Alarm no. in Alarm List Alarm text in Alarm List 22 Errors reported by GetLastError() in 23 Errors reported by GetLastError() out 24 Errors reported by ClearCommError() in 25 Errors reported by ClearCommError() in 40 In remote PLC reported by protocol 41 Message protocol errors while input 42 Message protocol errors while output 43 Packet level error during input 44 Packet level error during output 45 A bad packet received and returned 46 Keep alive timeout 47 Errors from dialup module 48 DCA-TCP: Error group for remote DCA's 49 Error codes received from AlarmNet 50 Errors generated by DC at packet in 51 Errors generated by DC at packet out The error code itself is shown in the Worst value field of the Alarm List. The Error description field in the table describes the cause of the error and suggests corrective action. Worst value in Alarm List Error description Internal error text 0x0040 No buffer or request blocks NO_REQBUF 0x0041 No scan buffers NO_MSGBUF 0x0042 Ring buffer is full (B.060) RBUF_FULL

112 Worst value in Alarm List Error description Internal error text 0x0042 Received buffer does not match scan record SREC_ERR 0x0044 Received buffer has unexpected length LEN_ERR 0x0045 No channel exists for requested node NO_CHAN 0x0046 Unexpected character received CHAR_ERR 0x0047 Wrong BCC/FRC/CRC code in telegram CRC_ERR 0x0048 Unsupported data type TYPE_ERR 0x0049 Unsupported data group DB_ERR 0x004A Unsupported offset OFFSET_ERR 0x004B Transmit waiting for flow control signals (i.e. device off or cable is broken) TX_FLOWCTRL 0x004C Node suspended by operator. ONLINESUSPEND 0x0050 Open timeout TO_OPEN 0x0051 Connect request timeout TO_CR 0x0052 Send timeout TO_XMIT 0x0053 Receive timeout TO_RECV 0x0001 0x0002 0x0004 Cause: An event telegram was received with an invalid type value Action: Check the PLC program that sends the telegrams Cause: An event telegram was received with a length that is shorter then allowed Action: Check the PLC program that sends the telegrams Cause: An event telegram was received with a type message code that is not supported by DC_INVTYPE DC_BADLEN DC_NOSUPPORT

113 Worst value in Alarm List 0x0005 0x0006 0x00e1 0x00e2 0x00e3 0x00e4 0x00e5 0x00e6 0x00e7 Error description DC Action: Check the PLC program that sends the telegrams Cause: An event telegram was received with a type message code that is not supported by DC as an inbound packet Action: Check the PLC program that sends the telegrams Cause: An event telegram was received with an object address that is not in the configuration Action: Check the PLC program that sends the telegrams Cause: An event telegram was received with a bad type value. Action: Check the PLC program that sends the telegrams Cause: An event telegram was received with a length that is longer then allowed Action: Check the PLC program that sends the telegrams Cause: An event telegram was received with a wrong timestamp or an address request with wrong type. Action: Check the PLC program that sends the telegrams Cause: A time synchronization telegram was received from a node that is not time master. Action: Correct the problem in the System Configuration program Cause: Invalid Minor State Action: Internal error Cause: Unable to establish call Action: Check modem and phone line Cause: Driver can't find node to call Action: Check that node definition in System Internal error text DC_NOTINPKT DC_INVADDR _7TPOLLED_BADTYPE _7TPOLLED_BADWLEN _7TPOLLED_BADCONT _7TPOLLED_BADTSYNCH _7TPOLLED_DIALUP_ MINORSTATE_ERROR _7TPOLLED_DIALUP_ CONNECT_TIMEOUT _7TPOLLED_DIALUP_NODE_ UNDEFINED

114 Worst value in Alarm List 0x00e8 0x00e9 Error description Configuration and Definition match Cause: Can't perform a proper disconnect Action: Check modem Cause: No valid response to historical data request Action: Check quality of phone line. Internal error text _7TPOLLED_DIALUP_ DISCONNECT_TIMEOUT _7TPOLLED_DIALUP_ HISTDATA_TIMEOUT 0x00ea Cause: Timeout reading valid node number in calling PLC. Action: Check that correct node number is written into the right PLC address. Remember to write node number in SATTR16 if COMLI protocol. Check for correct Data Group and Word Offset in System Configuration-> Modem-> Remote. _7TPOLLED_DIALUP_ PREEVENT_TIMEOUT 0x00eb 0x00ec 0x00ed 0x00ee Cause: Phone connection disconnected by remote party. Action: Re-establish connection manually. Cause: IGSS could not read a valid node number in the calling PLC. Action: Make a scanned analog object that addresses the location in the PLC where you expect to find the node number. Call the PLC from IGSS and verify that the node number is correct. Cause: Unable to establish call to PLC. Action: Check phone number, modem and cable. Cause: Timeout writing scan complete indication to the PLC Action: Check for correct Data Group and Word Offset and value in System Configuration-> Modem-> Remote _7TPOLLED_DIALUP_GOT_ DISCONNECTED _7TPOLLED_DIALUP_ ILLEGAL_NODE_NO _7TPOLLED_DIALUP_ CONNECT_FAILED _7TPOLLED_DIALUP_ POSTEVENT_TIMEOUT 0x00ef Cause: Too long outbound message. Action: Check for correct segment size in System Configuration. _7TPOLLED_OUTBOUND_ LEN_ERR 0x00f0 Cause: Too long outbound mailbox message _7TPOLLED_MAILBOX_LEN_

115 Worst value in Alarm List Error description Internal error text 0x00f1 0x00f2 0x00d5 0x00d7 0x00d8 0x00d9 0x00da Action: Check for correct segment size and mailbox size in System Configuration. Cause: The time interval for collection of historical data was set to zero. The program modified the interval to 60 seconds. Action: Setting the interval in System Configuration to zero is only valid if the driver can read actual interval in the PLC. Correct the interval in System Configuration-> Node-> Connection Misc.-> Configure-> Interval. Cause: There is no dummy node configured for the alarm modem. Action: Add a node to the alarm modem in System Configuration. Cause: A telegram was received that was too long for the program. Action: Check that the PLCs are sending valid telegrams. Please contact IGSS technical support if the problem persists. Cause: The link to the node is down. Action: Check that the PLC is running and that the connection is working Cause: No keep alive telegram was received in the expected time Action: Check the PLC program Cause: A bad sequence number was received Action: Check the PLC program Cause: No buffer available Action: Increase number of messages for the driver in System Configuration. ERR _7TPOLLED_INVHISTTIME _7TPOLLED_NO_ALARMNODE _7TSICOS_EBADTLEN _7TSICOS_ELINKDOWN _7TSICOS_EKPAEXPIR _7TSICOS_EBADRCVSEQNO _7TSICOS_ENOMOREBUF 0x00dd Cause: Illegal node number specified. Action: Remove the object in the IGSS configuration that belong to the illegal node or create the node in System Configuration. _7TSICOS_EILLEGALNODE

116 1.24 Windows error codes In some cases, the extended error code is a Windows error code. This is generated by the WIN32 API and is trapped by the IGSS communication driver. The error code appears in the Alarm List as the fourth (and last) element of the complete error code. Type the Windows error code in hexadecimal or decimal notation in the IGSS utility program, ErrCode.exe, located in the \Gss folder. Click Lookup to view the description Extended error codes Extended error codes come from the PLC interface software or from the Windows operating system. As a service to you, we have added these codes to our software to provide you with as much information as possible to resolve the problem. The extended error code appears in the Alarm List as the fourth (and last) element of the driver error code. Error code descriptions This help file contains the error code descriptions we have received from the PLC manufacturers. For further details about these error codes, refer to the PLC manufacturer s documentation. The Windows error code descriptions can be viewed either directly with the IGSS utility program, ErrCode.exe, located in the \Gss folder. Simply type the Windows error code and click the Lookup button.

117 Chapter 1: Monitoring and Controlling the Communication Status 1.26 The Driver object Definition In every configuration you create, a standard system object called Driver exists. It provides information about the driver: Whether the driver is running and whether communication to the PLC(s) is possible as well as communication alarms. The Driver object monitors the communication at the driver level, so if you have several nodes defined for a driver, it is recommended to create a status object for each node. Click See Also for details. Communication alarms The alarm numbers between 10 and 51 are reserved for various communication errors (the communication ports, the PLC, the data collection engine, etc.). These alarms are automatically reported in the alarm list, if communication errors occur. Alarm numbers are used when 10 and 11 the setup of drivers is erroneous. 20 and 21 the communications ports are faulty. 30 to 39 the extended event-driven communication drivers fail; please refer to driver documentation. 40 a general PLC error occurs; please refer to PLC documentation. 41 to 45 there are driver communication errors; please refer to driver documentation. 46 the connection to the PLC program is missing; the physical connection may be in order, but for some reason the PC has not received the expected I m alive message. 47 the extended event-driven communication drivers fail; please refer to driver documentation. 48 there is an interface error to a remote driver. 49 there is an interface error to the Alarmnet. 50 incomprehensible data from the PLC is received by the data collection engine (DC).

118 Alarm numbers are used when 51 too much data output is generated, for example, if a DDE link generates too much data. Handling driver alarms During supervision, possible communication alarms will appear in the alarm list and can be handled as any other alarm (acknowledged, etc.). Displaying the Driver object The Driver object may be shown on a process diagram to easily view its status. If any of the alarms from the table above occur, the symbol representing the object will blink with the alarm colour defined for the alarm text. To view the alarm text definitions, select Edit Alarm Texts, select the relevant alarm text and click Edit. The figure below shows an example of how you can represent the Driver object using a *.bmp file. The object has two states: < - 1 when the driver is running < - 0 when the driver is not running 1.27 The node status object Purpose To monitor the communication status of the individual node, we recommend that you create a node status object. You can then reserve one or more process diagrams for an overview of your PLC network where you can view the status of each PLC in the system at a glance. How to create a node status object The node status object is created as an analog object in Definition. Click here for details. Example: PLC network with node status objects The figure below shows a PLC network where each PLC icon has been connected to a node status object. An alarm text has been attached to the object to make communication alarms visible in the Alarm List.

119 If the communication fails with a PLC, its icon will blink and the communication alarm will occur as an error code in the Value field of the Alarm List. Note: The value 0 means that there are no communication errors Monitoring and controlling the remote connection status In the Definition program, it is recommended to create a status object for each remote PLC defined in System Configuration. This is done by creating a digital object for each remote connection with a PLC address that matches the one defined on the Connection Misc tab for the remote connection. Important: The DIALUP template is built into every new configuration you create. So, if you've created the configuration from scratch in version 5 or higher, you can skip this first part of the procedure to start creating the status object immediately. If the configuration was created in a previous version of IGSS, follow the procedure to create the template first.

120 1. Open Definition and create a digital template called DIALUP. 2. In the template properties dialog box, click the Bit Map I/O tab and set the state bits (7) and command bits (2) as shown below. Remember to check the States and Commands boxes under Single Bits. 3. Click the States and Commands tab to define these state and command names (bit number in brackets):

121 States: Invalid (0), Disconnected (1), Connecting (2), Historical scan (3), Normal scan (4), Disconnecting (5), Error (not used) (6), Send command (7). Commands: Connect (0), Disconnect (1) and Fetch historical data (2). 4. Click the Command/State Config tab to enable the relevant command(s) for each state. Select each state and enable the relevant command(s). For example, for the Disconnected state, enable the Connect command.

122 5. On the Data Management Definitions tab, make sure that scanning, logging and data reduction are disabled.

123 6. Click the Edit Mapping tab to define the relevant driver and node number for the State and Command atoms. We do not specify the full PLC address in the template, this is done for the individual status objects. Result: The template is now ready for use. Click OK to save it.

124 Note No alarm bits are defined for this template and it is recommended to use a command field to display the status object on the process diagram. Therefore, you need not select a symbol on the Symbol Definition tab. The next step is to create the status object:

125 1. Right-click at the position where you want the object and select New Command Field. This is the recommended way of showing the status object. The Object Browser dialog box appears. 2. Click the + sign beside the area in which you want to create the status object. 3. Click the + sign beside Digital to show all digital templates and objects. 4. Select the DIALUP template. 5. At the bottom of the dialog box in the Create new object area, type the name of the status object. In this example, we've used DialNode10.

126 5. Click Create. The properties dialog box for the status object appears with all the predefined properties from the DIALUP template. 6. Click the Edit Mapping tab to define the PLC addresses for the State and Command atoms. Tip: The PLC address for the State and Command atoms must match the address defined on the Connection Misc tab in System Configuration. It is recommended to set the Data Group and Word Offset to 0 to collect this type of status objects in this address range.

127 7. Click the Set Command Layout tab to configure the command field as shown below. The status object is now ready to be placed on the process diagram. 8. Click OK. The command field and the object name and description now appear. 9. Resize the field and place the name and description, as required. See example below.

128 Result: When you start the IGSS configuration, the current status of the remote connection will be shown and the operator can connect, disconnect and fetch historical data using the command buttons. Tips To define more status objects, simply repeat the above procedure. For nodes that are directly connected via a serial port, you can create a node status object in the Definition program. Click here for details Suspending a remote connection from Supervise Purpose If a remote PLC is being serviced, the operator will get communication alarms in the Alarm List. In that case, the operator may want to temporarily suspend the communication. The DIALSUSPEND template For that purpose, a template is included in every new IGSS configuration. The template is called DIALSUSPEND. By using this template, the operator has access to two additional commands compared to the DIALUP template: Suspend and Resume. The template includes the following states and commands: States Invalid Commands Connect (For internal use)

129 Disconnected Connecting Disconnect Historical scan Connect Normal scan Disconnecting Error Send command Suspended Fetch historical data Suspend Resume 6-> (For internal use) 7-> (For internal use) Create the suspend / resume object In the following procedure, we recommend that you create two separate displays for this object. One for the normal commands: Connect, Disconnect and Fetch historical data and two buttons from which the operator can suspend and resume the remote connection. Create the command field 1. In the Definition module, right-click at the diagram where you want to place the object. 2. Select New Command Field. The Object Browser dialog box appears. 3. Click the + sign beside the relevant area of the configuration. 4. Click the + sign beside Digital and select the DIALSUSPEND template. 5. At the bottom of the dialog box in the Create new object area, type the relevant name of the object, for example, DialNode0.

130 6. Click the Create button. The object properties dialog box appears. 7. On the Edit Mapping tab, do the following for both State and Command: Select the relevant driver and node number for the remote connection. In the Data Group and Word Offset fields, type the exact addresses specified on the Connection Misc tab for the node. It is recommended to set the Data Group and Word Offset to 0 to collect this type of status objects in this address range.

131 8. Click the Set Command Layout tab and do the following: In the Rows and # Cmds fields, type 3 to match the number of commands to display. Click the Show command and Shadow check boxes. Under Align, select Horizontal and click OK. 9. Place and resize the command field, the object name and state, as required.

132 The operator will now be able to connect, disconnect and fetch historical data from the Supervise program. Create the Suspend button 1. Right-click where you want to place the Suspend button. It is recommended to place it beside the command field we just created. 2. Select New Standard Descriptors Button Control. The Object Browser dialog box appears. 3. Click the + sign beside the relevant area of the configuration. 4. Click the + sign beside Digital and select the DIALSUSPEND template. 5. Click the name of the object we created in the previous procedure and click the Create button.

133 2. Double-click the button to change its properties. 3. Click the Display tab and clear the Enable check boxes under Name and State / value. 4. Click the Attributes of Button tab and do the following: Double-click the Bind command on click setting to enable it. Double-click the Suspend setting to make the button send that command. Under Style, double-click the Font property and make the text bold.

134 Under Style, double-click the Text color property and select the red color to illustrate the suspend command. 5. Click OK twice to close the dialog box. 6. Position and resize the button. Create the Resume button 1. Right-click the button we just created and select Copy. 2. Right-click again and select Paste As Reference. 3. Drag the button down below the first button. 4. Double-click the new button to change its properties. 5. Click the Attributes of Button tab. 6. Under Command on click, double-click the Resume setting to make the button send that command. 7. Under Style, double-click the Text color and choose a green color to illustrate the resume command. 8. Click OK twice to close the dialog box. The final result should now look like this:

135 1.30 Communication alarms On the Data Collection tab there are settings for controlling how to display communication alarms in the Alarm list. There are 2 sets of settings as represented by the two groups at the bottom of the tab, the Alarms to Driver object and the Alarms to Node Status object groups. Alarms to Driver object There are two settings from which to choose. These are: Only if no Node Status object defined or if node number unknown Select this option if Node Status objects have been created for some of, or all, nodes in the system. Alarms not related to a specific node will still be shown on the Driver object in the Alarm list and will be given the node number To use this setting in a meaningful way, the Node Status object must have been created and attached to nodes in the system For more information on the Node Status object, click here Always Selecting this option assumes that no Node Status objects have been used in the system; driver alarms will be displayed Alarms to Node Status object Only Node Status (High Alarm) alarms Selecting this option displays only Node Status alarms on Node Status objects. Both Node Status (High Alarm) alarms and Driver object alarms Selecting this option displays both Node Status alarms and Driver alarms on the Node Status object. To use these settings in a meaningful way, the Node Status object must have been created and attached to nodes in the system For more information on the Node Status object, click here There are two additional benefits worth noting when using the Node Status object. These are:

136 1. Alarm delay can be defined for the Node Status object. 2. A quick and reliable overview of node status can be presented graphically in the system as a mimic.

137 Chapter 1: Tuning and Optimizing Data Communication 1.31 Communication efficiency information [MyConfig].prt The installation report [MyConfig].prt When you install an IGSS configuration, you get the option of viewing an installation report. You determine what you want to view in the report in the Installation Options dialogue shown below. PLC-related information The installation report contains the following sections related to PLC communication: The entire system configuration (setup of stations and drivers) Objects sorted by PLC address Objects sorted by scan class (the Scan intervals chosen on the Data Management Definitions tab in the object properties dialog box) PLC communication efficiency information For further details about the installation report, click here. The setup of stations and drivers This section of the report shows the settings defined for all stations and drivers.