GEI-100625 Mark Vie EGD Editor

GEI-100625

GE Energy Ethernet Global Data (EGD) Generic Editor These instructions do not purport to cover all details or variations in equipment, nor to provide for every possible contingency to be met during installation, operation, and maintenance. The information is supplied for informational purposes only, and GE makes no warranty as to the accuracy of the information included herein. Changes, modifications, and/or improvements to equipment and specifications are made periodically and these changes may or may not be reflected herein. It is understood that GE may make changes, modifications, or improvements to the equipment referenced herein or to the document itself at any time. This document is intended for trained personnel familiar with the GE products referenced herein. GE may have patents or pending patent applications covering subject matter in this document. The furnishing of this document does not provide any license whatsoever to any of these patents. All license inquiries should be directed to the address below.  If further information information is desired, desired, or if particular particular problems arise that are not covered  sufficiently for the purchaser’s purpose, the matter should should be referred to: to: GE Energy  Post Sales Service Service 1501 Roanoke Blvd. Salem, VA 24153-6492 USA  Phone: + 1 888 GE4 SERV (888 434 7378, United United States) + 1 540 378 3280 (International)  Fax:

+ 1 540 387 8606 (All) (All)

(“+” indicates the international access code required when calling from outside the USA) This document contains proprietary information of General Electric Company, USA and is furnished to its customer solely to assist that customer in the installation, testing, operation, and/or maintenance of the equipment described. This document  shall not be reproduced reproduced in whole or in part nor shall shall its contents be disclosed to any third party without the written approval of GE Energy. GE provides the following document and the information included therein as is and without warranty of any kind, express or implied, including but not limited to any implied statutory warranty of merchantability or fitness for particular purpose.

 2005 - 2006 General Electric Company, USA. All rights

g

reserved.

Ethernet is a registered trademark of Xerox Corporation. OPC is a registered trademark of OPC Foundation. WorkstationST and ToolboxST are trademarks of General Electric Company, USA.

Contents Section

Page

Introduction ........................... ........................................ ........................... ........................... ........................... ........................... ................... ...... 3  Network Adapters.................. Adapters................................ ........................... ........................... ............................ ............................ .................. .... 3 EGD Configuration .......................... ........................................ ............................ ............................ ........................... .................... ....... 4 EGD Configuration Server Settings .......................... ....................................... ........................... ........................ .......... 5 Produced Pages....................... Pages..................................... ............................ ........................... ........................... ............................ ................. ... 6 Editing Produced Pages..................................... Pages................................................... ............................ ............................ ................. ... 7 Page Compression ........................... ......................................... ............................ ............................ ........................... ..................... ........ 9 Variables........................ Variables...................................... ............................ ............................ ........................... ........................... .......................... ............ 9 Editing Exchange Signatures and Configuration Configuration Time .......................... ................................ ...... 10 Referenced Devices............. Devices ........................... ........................... ........................... ........................... ........................... ................... ..... 11 Implementation Profile.................................... Profile................................................. ........................... ............................ .................. .... 13 Viewing Live Data Values .......................... ........................................ ............................ ............................ ..................... ....... 15 Finder ........................... ......................................... ............................ ............................ ............................ ............................ ........................ .......... 16 Find Methods .......................... ....................................... ........................... ............................ ............................ ...................... ........ 17 Replace Options ........................... ......................................... ............................ ........................... ........................... ................. ... 20 Menus ............................ .......................................... ........................... ........................... ............................ ............................ ........................ .......... 20 Acronyms and Abbreviations .......................... ........................................ ........................... ........................... .................. .... 21 Terms............................. Terms.......................................... ........................... ............................ ............................ ............................ ........................ .......... 22

Safety Symbol Legend

Indicates a procedure, practice, condition, or statement that, i f not strictly observed, could result in personal injury or death.

Indicates a procedure or condition that, if not strictly observed, could result in damage to or destruction of equipment.

Note Indicates an essential or important important procedure or statement. statement.

2

Ethernet Global Data (EGD) Generic Editor

GEI-100625

Introduction ®

The EGD Component Editor for external devices allows you to configure Ethernet Global Data (EGD) for an external or third-party device. The EGD protocol allows controller components (sometimes known as nodes) to share information in a networked environment. EGD allows one controller device, referred to as the  producer of the data, to simultaneously send information to any number of peer controller devices (consumers) at a fixed periodic rate. This network supports a large number of controller devices capable of both producing and consuming.

Network Adapters The General tab configures Ethernet adapters for an external EGD-capable device. One adapter is created by default, and up to four adapters can be added. 

1

From the System Editor , right-click an external device, then select Edit EGD. (If Edit EGD is not available, the EGD Editor Enable  property of the component may be set to False. The EGD Component Editor  opens.)

2

From the Component Editor , select the General tab.

3

From the Tree View, right-click the Network Adapters item, then select Add Adapter .



GEI-100625 

To add a network adapter 

To remove a network adapter 

1

From the System Editor , right-click an external device, then select Edit EGD. (If Edit EGD is not available, the EGD Editor Enable  property of the component may be set to False. The EGD Component Editor opens.)

2

From the Component Editor , select the General tab.

3

From the Tree View, right-click the network adapter to be removed, then select Delete Adapter .

Ethernet Global Data (EGD) Generic Editor 

• 

3

The following properties are available for configuration when a Network Adapter is selected in the Tree View:

Host Name is the Internet Protocol (IP) host name for the selected network adapter. IP Address is the IP address for the selected network adapter. Network Name is the name of the connected network. Subnet Mask is the subnet mask associated with the connected network. Wire Speed is the speed of the connected network.

EGD Configuration 

To configure EGD for an external device

1

Start the EGD Generic Edito r. From the File menu, select Open and select an EGD Device to open the EGD Component Editor .

2

From the Component Editor , select the EGD tab.

3

In the Tree View , select Ethernet Global Data . The Ethernet Global Data  properties display in the Property Editor .

In the Tree View, select Ethernet Global Data.

4

Ethernet Global Data (EGD) Generic Editor

GEI-100625

These properties are available for configuration when Ethernet Global Data is selected in the Tree View:

Collection controls the Collection to which this EGD component belongs when viewed in the EMT. This information is published to the EGD Configuration server in the GUI component document, GUIDevice.xml . Producer ID is assigned when the component is created. The Property Editor displays the EGD Producer ID formatted as an unsigned integer, but dotted and hexadecimal representations are available by clicking the ellipsis button.

EGD Configuration Server Settings

GEI-100625 



To open the EGD Configuration Server settings



From the Options  menu, select Settings .The Settings  dialog box displays.

Ethernet Global Data (EGD) Generic Editor 

• 

5 

The following settings are available for the Generic EGD Device item in the Tree View:

EGD Configuration Server  is set to True to enable the EGD Configuration Server, and to False to disable it. The following settings are available for the EGD Configuration Server item in the Tree View:

Local Server Cache Path is the path to the local cached directory. If this property is configured, the resulting files from selecting the Get command is copied to this directory. If the server is not available, this cache can be used. Work Offline is set to True to use the mirror local server cache directory for Get and Publish command. In most situations, this property should be set to False so that the real EGD Configuration server is used. If the server is not available, the mirror cache can be used as a temporary alternative.

When working offline, any configuration saved to the mirror cache must be re-saved to the real configuration server once that server is available. At that time, the Work Offline property must be returned to False.

Base Path is the Uniform Resource Identifier (URI) on the EGD Configuration Server where EGD files reside. This should only be changed b y your system administrator. Host Name or IP address of the EGD Configuration server being used for all software on this computer. Server Port is the server port value to use. The default assigned value is 7938 per the EGD Protocol specification. Timeout (in milliseconds) is used to communicate to the EGD configuration server. The default value is 10000 ms (10 seconds). Use IE Proxy has a default value of False. If True, the Internet Explorer proxy settings are used. Using the proxy is not recommended.

Produced Pages Produced Pages are data sets configured to be available to other components on the network. 

6

To add a new Produced Page

1

From the Tree View, right-click the Produced Pages item, then select Add Page.

2

Enter a unique name for the new page in the Page Name dialog box, then click OK.

Ethernet Global Data (EGD) Generic Editor

GEI-100625

 To 

delete a Produced Page

From the Tree View, right-click the page you wish to delete, then select Delete.

Editing Produced Pages  

To configure a Produced Page From the Tree View, select the EGD tab, then expand the Produced Pages.

Under Produced Pages, select the desired page.

The page properties display in the Property Editor.

GEI-100625 

Ethernet Global Data (EGD) Generic Editor 

• 

7 

The following properties are available for configuration when a Produced Page is selected in the Tree View:

Ethernet 0, if selected, broadcasts EGD on Ethernet 0. (If more than one Ethernet Adapter has been configured for EGD, additional Ethernet properties displays.) Mode can be set to Broadcast, Unicast, or Multicast, depending on the modes supported by the device's EGD implementation profile. Exchanges indicate the number of exchanges in the selected page. It is updated after selecting the Build command. Allow Editing  when False, a variable's exchange ID and offset for variables on a manual page cannot be edited. A page compress will also be disabled. This prevents you from inadvertently editing a page with manual selected as Layout mode. Name uses this property to rename the selected page. Period  indicates the transmission period of the page in milliseconds. Skew is used to prevent exchanges with the same period from being produced at exactly the same instant. The skew for the first exchange in the page is set to this value, and each additional exchange skew differs from the previous exchange’s skew  by exactly this value. For example, if you have three exchanges in a page and a skew value of 2, the first exchange’s skew is two, the second exchange’s skew is four and the third exchange’s skew is six. Note The Skew property will not be visible if it is not supported in the implementation profile configuration. (The skew property is measured in nanoseconds.) Destination IP Address  sets the IP address to which the exchanges on this page are unicast or multicast. (If the  Mode property is set to Broadcast, this property is not available.)

8

Ethernet Global Data (EGD) Generic Editor

GEI-100625

Page Compression When a page compress command is performed, the variable locations are optimized. The variables are located in increasing size order, starting with Booleans, then Words, Double Words, and finally all other variables.  

 

To compress a single page From the Tree View, right-click the page to compress, and then select Compress .

To compress all Produced Pages in a component From the Tree View, right-click Produced Pages, and then select Compress All.

Variables  

To add a variable to a produced page From the Tree View, select a Produced Page  to display a Data Grid in the Summary View .

Click the Name cell in the Append row, type a variable name, and then click Enter  . The variable will display in a new row, where you can change other properties.

GEI-100625 

Ethernet Global Data (EGD) Generic Editor 

• 

9



To delete a variable from an EGD Page



From the Summary View, right-click the variable to delete, and then select Delete Selected Row(s).



To copy variable information from an EGD page to the clipboard



From the Summary View, right-click a variable, and then select Copy Selected/Current Row(s). The data is copied in .csv format.

Editing Exchange Signatures and Configuration Time  Normally, the exchange signature is managed automatically. The major signature must be incremented when the exchange content changes in any way other than additions to the end. If you are using the EGD Device Editor to configure EGD for a device and the device signature changes only when the manufacturer updates the configuration, you may need to manually set the signature.

Note To edit exchange signatures and configuration time, set Layout Mode to  Manual .



10

To edit exchange signatures and configuration time

1

From the EGD tab, select a Produced Page  in the Tree View.

2

Right-click an exchange in the Summary View, then select Edit Exchange Signatures and Configuration Time .

3

Review the warning about manual Exchange Signature  editing, then click OK.

Ethernet Global Data (EGD) Generic Editor

GEI-100625

4

Make any desired changes to the signatures and configuration time, then click OK to close the dialog box.

Referenced Devices The EGD variables defined in other components can be added to the current component’s variable list by adding a reference. References can only be created to EGD-capable devices that are consumers of Produced Pages, and as such only EGDcapable devices are available for referencing. 

To select the devices that are referenced



From the Tree View, right-click the Referenced Devices item, and then select Select Devices to display the Select Devices dialog box.

Select or clear the check boxes next to each component name. Click OK.

GEI-100625 

Ethernet Global Data (EGD) Generic Editor 

• 

11

The EGD configuration for the selected devices is loaded and the variables display in the Summary View.

When theFilter button is selected, only variables selected for consumption are visible. 

To delete a referenced device

 From

the Tree View, right-click the device to be deleted and select Delete.

When EGD configurations are edited in remote devices, you must refresh the configuration to ensure that the latest variable information is used. This is automatically done when you use the Bind and Build command, as well as when a configuration is saved.  To 

12

refresh the configuration of a referenced device

In the Tree View, right-click the device to be refreshed, and then select Refresh.

Ethernet Global Data (EGD) Generic Editor

GEI-100625

Implementation Profile Each EGD node type has a set of supported EGD features. For example, a device might have an EGD implementation that only supports broadcast-produced data. The implementation profile contains details about the EGD implementation of a  particular device.

The following properties are available when editing an Implementation Profile:

Configuration Support configures the operations supported by the device. Accepts Deletes indicates device support for HTTP deletes. Multiple Producer IDs indicates device support for multiple producer IDs. Accepts Puts indicates device support for HTTP Put commands. Zip Content indicates device support for zipped transfers. Data Types allows you to configure supported data types. (Clicking the ellipsis  button will open an editor window.)

GEI-100625 

Ethernet Global Data (EGD) Generic Editor 

• 

13

Double Word Alignment indicates that the offset of a DWORD length variable must be evenly divisible by this number. Word Alignment is set to True if the device requires that all WORD length variables be aligned on an even boundary. Broadcast is set to True if the device supports broadcast destinations for EGD data or command packets and False otherwise. Masked Write is set to True if the device supports the MaskedWrite command and False otherwise. Max Coherent Data returns the maximum size in bytes of a variable that still is guaranteed coherent transfer. If the attribute is not present then all data is guaranteed coherent transfer regardless of size. It is optional and is initialized to 0. Max Exchanges returns the maximum number of exchanges supported by the device. It is optional and is initialized to 0. Max String returns the maximum size string supported by the device. If the attribute is not present then the device has no set maximum size for strings. It is optional and is initialized to 0. Multicast is set to True if the device supports multicast destinations for EGD data or command packets and False otherwise. Skew is a Boolean value representing the capability of the producer to support the skewing of produced exchanges with respect to time. Unicast is a Boolean value that is set to True if the device supports unicast destinations for EGD data or command packets. Otherwise, it is set to False. Device Class is defined in the EGD Protocol Specification: Class Description 0

Supports only the configuration port.

1

Supports the data port and the Data Production PDU.

2

Supports all class 1 services plus at least acts as a responder for the command port and the commands associated with that port.

3

Supports all class 2 services plus the configuration port and the required commands associated with that port. Such devices support responding to configuration requests but do not dynamically bind their consumed variables.

4

Supports all class 3 services plus dynamically binding consumed variables.

Device Class Name is name of the class of device to which this device belongs.

14

Ethernet Global Data (EGD) Generic Editor

GEI-100625

Viewing Live Data Values The EGD specification defines a Command Message Protocol (CMP), which allows for reading and writing values. It allows you to obtain statistical and configuration information from an EGD device. The EGD device must be Class 2 or greater for CMP support. The generic editor uses CMP to display live data values on a produced or referenced device summary grid view. The Connection Toolbar  button sends the CMP message to the device to obtain the data.

Once connected, the Produced Pages or Referenced Devices option displays the values. Use the Refresh button in the column header to update the grid.

GEI-100625 

Ethernet Global Data (EGD) Generic Editor 

• 

15 

Finder The Finder provides a powerful way to search items in the EGD Generic Editor. It can be especially useful to rapidly search through descriptions of items. 

To open the Finder 



From the toolbar , click the

Finder  button.

-or

From the Edit  menu, select Find.

-or

Press CTRL+F . Enter the text to search for in this box.

Click to display added options for  replacing text.

Click to begin the search.

Selects a type of search to perform.(Refer to the next section, Find Methods) Select this box to distinguish between upper  and lower case characters while searching. Select to include descriptions in the search.

16

Ethernet Global Data (EGD) Generic Editor

GEI-100625

Find Methods A variety of find methods are available that control how the text entered in the Find  box is matched to text in the EGD Generic Editor.

Anywhere finds the specified text anywhere within a searchable text string.  A search for abc

matches

but does not match:

abc

abdc

abcde

ab

xyzabc

bc

zabcz

Begins with finds the specified text only at the beginning of a searchable text string.  A search for abc

matches

but does not match:

abc

xyzabc

abcde

abdc ab bc

Ends with finds the specified text only at the end of a searchable text string.  A search for abc

matches

but does not match:

abc

abcde abdc

xyzabc

ab bc

Match Exactly finds the specified text only when it is exactly equal to an entire searchable text string.  A search for abc

matches abc

but does not match: abcde xyzabc abdc ab bc abc cde

GEI-100625 

Ethernet Global Data (EGD) Generic Editor 

• 

17 

Match Whole Word finds the named text only when it is exactly equal to an entire word of a searchable text string, meaning it is surrounded on both sides by either  punctuation or white space.  A search for abc

matches

but does not match:

abc

abcde

abc cde

xyzabc

spell your abc's.

abdc ab bc spell your abcs.

Wildcards is similar to Match Exactly, except any single letter can substitute for a ? character and any sequence of zero or more letters can substitute for a * character.  A search for a?c

matches

but does not match:

abc

abdc

adc

bc abc cde abcde xyzabc

a*

abc

bc

adc

cde abc

abcde abdc ab abc cde

18

Ethernet Global Data (EGD) Generic Editor

GEI-100625

Regular Expressions processes the text entered in the Find box as a regular expression (sometimes abbreviated regex). A regular expression is an advanced ™ system of wildcards used to match a specific set of text. ToolboxST  supports a standard set of regular expression commands similar to many p opular third party tools. While a detailed discussion of regular expression syntax is out of the scope of this document, there are many excellent books and online resources available with details about regular expressions.  A search for

matches

[cvrm]at

but does not match:

cat

sat

cats

bat

vat rat mat (Mon|Tues|Wednes|Thurs|Fri)day

Monday

Saturday

Tuesday

Sunday

Wednesday

Fries

Thursday Friday Fridays var[0-9]+

var0

varx

var9

var7a

var7

var

var48 var[a-zA-Z]*

var

var5

variable

var!

varZZZZ

GEI-100625 

Ethernet Global Data (EGD) Generic Editor 

• 

19

Replace Options Besides performing simple searches, the Finder also supports search-and-replace operations.  

To display the Replace options In the Finder  window, click the Replace button. The window expands to include new options.

Enter the text to search for in this box.

Navigate to the next occurrence of the Find text.

Enter the text to be substituted for the Find text in this box.

Replaces the currently displayed occurrence of the Find text with the Replace With text.

Replaces all occurrences of the Find text with the Replace With text automatically.

Menus File Menu  New creates a new EGD device. Open opens an existing EGD device. Save updates the EGD configuration files, refreshes consumed exchanges and variables, assigns produced variables to exchanges, and, if an EGD configuration server has been specified, publishes the configuration to the server.

Close Device closes the current device. Import and Export allows you to transfer produced data, consumed data, symbols, implementation profiles, and GUI device EGD configuration files to and from a variety of file formats.

Print  outputs the summary grid view with the column selection, order, and width currently visible in the view.

Exit closes the EGD Generic Editor

20

Ethernet Global Data (EGD) Generic Editor

GEI-100625

Edit Menu  Undo returns the editor to the state it was in before the last action was performed. Redo performs an action again after an undo command. Cut moves the currently selected portion of the data grid to the clipboard. Copy transfers a duplicate of the currently selected portion of the data grid to the clipboard.

Paste transfers the contents of the clipboard into the data grid. Delete deletes the currently selected item. Find opens the Finder dialog box. For more information, refer to Chapter , Finder . Device Menu  Bind and Build  refreshes the consumed information for all referenced devices, automatically sets the layout of any unassigned produced variables, and, if no errors occur, publishes the configuration to the EGD Configuration Server.

Options Menu  Settings  open a dialog box with configuration settings for the EGD Configuration Server.

Help Menu  Contents open this help document. Submit Problem Report  opens a dialog box that you can use to electronically report problems to GE Energy.

Release Notes opens the release notes for the current version of the application.

About shows version and copyright information about the application.

 Acronyms and Abbreviations

GEI-100625 

CMP

Command Message Protocol

EGD

Ethernet Global Data, a control network and communication protocol

EMT

EGD Management Tool

GUI

Graphical User Interface

IP

Internet Protocol

OPC

OLE for Process Control

PDU

Protocol Data Unit

URI

Uniform Resource Identifier

Ethernet Global Data (EGD) Generic Editor 

• 

21

Terms Bind - To establish the correspondence between the data in an exchange and variables in a device. Bind/Build  - To bind the configuration for each consumed exchange and create/update the configuration for any produced exchange. Collection  - More formally, an EGD Collection. A group of devices that constitutes a formal subset of the devices participating in a particular EGD installation. This arbitrary grouping allows users to subdivide the system to make some tasks easier. Consume  - To receive an EGD data message (exchange). Consumer  - An EGD node configured to receive an EGD data message. EGD - A mechanism that provides access to global data between nodes supporting the EGD protocol. Exchange - An EGD data message consisting of a header and a body of data. The header contains the producer ID and the exchange ID that uniquely identifies the message. The body of data is a block of bytes in a format agreed upon by the  producer and all consumers. ™

Feature - An element of the WorkstationST  runtime system, which can be ™ optionally enabled through ToolboxST . Examples include OPC Server, Recorder, and Alarm Viewer. Global Data - A concept in which multiple controllers on a network can share information by exchanging portions of their local memory with peer controllers. ®

OPC  (OLE for Process Control) - A standard for data exchange in the industrial environment (OLE is Microsoft’s Object Language Embedding). The OPC foundation provides specifications for various OPC standards such as OPC DA (Data Access) and OPC AE (Alarm and Event). Produce - To send an EGD data message (exchange). Producer - The EGD node configured to send data messages. The source of the data samples for an exchange. Refresh - To bind the configuration for each consumed exchange for a particular consumed device. Runtime  - Software stored in the controller’s Flash memory that converts application code (pcode) to executable code. Unbound Variables  - Variables required by a consumer that were not found in the  producer configuration during the bind.

g 22

Ethernet Global Data (EGD) Generic Editor

GE Energy 1502 Roanoke Blvd. Salem, VA 24153-6492 USA

GEI-100625 060207

1 540 387 7000 www.geenergy.com

GEI-100625