PRO_007

Version 4
May 2024

Ovation™
Using the Modbus Protocol with Ovation
About this manual
Welcome to the Emerson Ovation distributed control system. Ovation is a highly reliable and responsive
real-time plant monitoring and process control system that uses commercially available hardware platforms,
operating systems, and open network technology.

This manual provides an overview of the Modbus protocol, which is a serial communications protocol for use
with programmable logic controllers (PLCs). It is used for transmitting information over serial lines between
electronic devices.

The information in this manual represents the recommended standards and procedures. If your system
requires a different configuration, contact your Emerson service representative or sales office for help
with the review of your system. All installation and maintenance procedures described in this document
are performed by qualified personnel and the equipment used is only for the purposes described. Using
alternate methods of installation or configuration could yield undesirable results.

Summary of changes
This version of the Using the Modbus Protocol with Ovation user guide includes the following new
information:

• Updated for the CPS 3.3.1 and SCADA 3.3.1 releases.

• Added support for OPH Only [42]points.
• Made miscellaneous corrections and clarifications.

Versions and software requirements

Protocol manuals are not tied to a specific Ovation release.

Conventions used in this manual

For security purposes, actual IP addresses are not used in Ovation user manuals. The IP addresses used in this
manual are for example purposes only and should not be used in an actual system.

Emerson strives to deliver products, services, and documentation that reflect our commitment to diversity
and inclusion. Some publications, including software and related materials, may reference non-inclusive
industry terms. As diversity and inclusive language continue to evolve, Emerson will periodically re-assess
the usage of such terms and make appropriate changes.
Copyright Notice
Since the equipment explained in this document has a variety of uses, the user and those responsible for applying
this equipment must satisfy themselves as to the acceptability of each application and use of the equipment.
Under no circumstances will Emerson Process Management Power and Water Solutions, Inc. (Emerson) be
responsible or liable for any damage, including indirect or consequential losses resulting from the use, misuse,
or application of this equipment.

The text, illustrations, charts, and examples included in this manual are intended solely to explain the use and
application of the Ovation™ Unit. Due to the many variables associated with specific uses or applications, Emerson
cannot assume responsibility or liability for actual use based on the data provided in this manual.

No patent liability is assumed by Emerson concerning the use of circuits, information, equipment, or software
described in this manual.

No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or by any
means, including electronic, mechanical, photocopying, recording, or otherwise without the prior express written
permission of Emerson.

The document is the property of and contains Proprietary Information owned by Emerson and/or its
subcontractors and suppliers. It is transmitted in confidence and trust, and the user agrees to treat this document
in strict accordance with the terms and conditions of the agreement under which it was provided.

This manual is printed in the USA and is subject to change without notice.

Ovation is the mark of Emerson. Other marks are the property of their respective holders.

Copyright © Emerson Process Management Power & Water Solutions, Inc. All rights reserved.

Emerson
Power & Water Solutions
1000 Westinghouse Drive
Suite 500
Cranberry Township, PA 16066
USA

Email: Technical.Communications@Emerson.com
Website: https://www.ovationusers.com
 Contents

Contents
Section 1 Introduction to the Modbus Protocol .................................................................................... 9
1.1 What is the Modbus protocol? ............................................................................................ 9
1.1.1 What is a Modbus Client? ....................................................................................... 9
1.1.2 What is a Modbus Server? ....................................................................................... 9
1.2 What is a Modbus Client RTU? ........................................................................................... 10
1.3 Modbus configuration overview ........................................................................................ 10
1.4 Understanding how Ovation platforms work with protocols ..................................................... 11
1.4.1 Modbus error codes ............................................................................................. 12
1.5 Modbus Client Line Redundancy ........................................................................................ 13

Section 2 Understanding the Protocol Configuration Tool ................................................................... 15

2.1 What is the Protocol Configuration Tool? ............................................................................. 15
2.2 Understanding the Protocol Configuration Tool window .......................................................... 16
2.3 Accessing the Protocol Configuration Tool ........................................................................... 16
2.3.1 Accessing the Ovation Developer Studio ................................................................... 16
2.3.2 To access the Protocol Configuration Tool for ELC ........................................................ 17
2.3.3 To access the Protocol Configuration Tool for OCC ....................................................... 18
2.3.4 To access the Protocol Configuration Tool for OCR3000 ................................................ 20
2.3.5 To access the Protocol Configuration Tool for OMC100 ................................................. 22
2.3.6 To access the Protocol Configuration Tool for Standalone Controllers ............................... 24
2.3.7 To access the Protocol Configuration Tool for SCADA .................................................... 25
2.4 What are the Protocol Configuration Tool menu options? ........................................................ 27
2.5 What are the Protocol Configuration Tool toolbar options? ...................................................... 29
2.6 What are the Protocol Configuration Tool windows? ............................................................... 31
2.6.1 Using the Add Items window to add an item to the Protocol Configuration Tool hierarchy ..... 31
2.6.2 To delete an item from the Protocol Configuration Tool ................................................ 33
2.6.3 Using the Import window to import configuration files ................................................. 33
2.6.4 Using the Export window to export configuration files .................................................. 35
2.6.5 Editing XML configuration files ............................................................................... 36
2.6.6 Using the Error Browser to check for configuration errors .............................................. 37
2.6.7 Using the Point Create Dialog window to create a point ................................................ 38
2.6.8 Updating the Ovation Database for applicable platform configuration .............................. 39
2.6.9 Viewing configuration information .......................................................................... 41
2.6.10 Selecting points using the Point Selector window ...................................................... 42
2.6.11 Selecting Configuration Tool options ...................................................................... 46
2.6.12 To reset default values ........................................................................................ 47

PRO_007 5
Contents

Section 3 Using the Protocol Configuration Tool ................................................................................. 49

3.1 What items are configured in the Protocol Configuration Tool? ................................................. 49
3.2 Configuring the Server in the Protocol Configuration Tool ........................................................ 49
3.2.1 Configuring the Configuration tab for the ELC platform ................................................ 51
3.2.2 Configuring the Configuration tab for the SCADA platform ............................................ 52
3.2.3 Configuring the Configuration tab for the Controller platform ........................................ 53
3.2.4 Configuring the Statistic Points tab for all Ovation platforms .......................................... 54
3.2.5 Configuring the Drop Configuration tab for the Controller and ELC .................................. 56
3.2.6 Configuring the Drop Configuration tab for the SCADA platform ..................................... 57
3.2.7 Configuring the Partner Statistics Points tab for the ELC platform only .............................. 59
3.3 What are ports? ............................................................................................................. 61
3.3.1 To configure an RS 232 Serial Port window ................................................................. 62
3.3.2 To configure a DIGI Terminal Server Port window ........................................................ 64
3.3.3 To configure a Generic Terminal Server Port window .................................................... 66
3.3.4 To configure a TCP Ethernet Port window .................................................................. 68
3.3.5 To configure a UDP Ethernet Port window ................................................................. 69
3.4 What is a communication line? .......................................................................................... 70
3.4.1 Configuring the Partner Configuration tab for a communication line ................................ 70
3.5 What is an RTU device? .................................................................................................... 71
3.5.1 RTU Configuration tabs ......................................................................................... 71
3.5.2 Configuring the Statistic Points tab for RTUs .............................................................. 72
3.5.3 Configuring the Partner Configuration tab for RTUs ..................................................... 73
3.5.4 Configuring Partner Statistics Points tab for RTUs ........................................................ 75
3.6 What are scanblocks? ..................................................................................................... 76
3.7 What are status points? ................................................................................................... 76
3.8 What are scan points? ..................................................................................................... 77
3.8.1 General Scan Point window configuration guidelines .................................................... 77
3.8.2 General Scan Points icon descriptions ....................................................................... 78
3.8.3 General Scan Points window examples ..................................................................... 78
3.9 What are simulated points? .............................................................................................. 79
3.9.1 Simulated Analog, Digital, and Packed points ............................................................. 80
3.9.2 Constant simulated points ..................................................................................... 80
3.9.3 Timestamp simulated points .................................................................................. 80
3.9.4 Placeholder simulated points ................................................................................. 80

Section 4 Understanding the Protocol Analyzer Tool ........................................................................... 83

4.1 What is the Protocol Analyzer Tool? .................................................................................... 83
4.2 What is the role of the Protocol Analyzer Tool? ...................................................................... 83
4.3 Accessing the Protocol Analyzer Tool .................................................................................. 83
4.3.1 To access the Protocol Analyzer Tool for SCADA and CPS systems .................................... 83
4.4 Menu options for the Protocol Analyzer window .................................................................... 84

6 PRO_007
 Contents

4.5 Toolbar options for the Protocol Analyzer window ................................................................. 87

4.5.1 Toolbar icons in the Protocol Analyzer window ........................................................... 87

Section 5 Using the Protocol Analyzer Tool ......................................................................................... 89

5.1 Overview of using the Protocol Analyzer tool ........................................................................ 89
5.1.1 To use the Protocol Analyzer Tool for the ELC, OCC, OCR3000, Standalone Controller, and
OMC100 platforms ...................................................................................................... 89
5.1.2 To use the Protocol Analyzer Tool for the SCADA platform ............................................. 90
5.1.3 Protocol Analyzer right-click menu options ................................................................ 90
5.1.4 Additional features of the Protocol Analyzer ............................................................... 93
5.2 Control - Server ............................................................................................................. 94
5.3 Control - Line ................................................................................................................ 95
5.4 Control - RTU ................................................................................................................ 98

Section 6 Modbus Client configuration ............................................................................................ 101

6.1 Overview of configuring the Modbus Client protocol ............................................................ 101
6.1.1 To add a port to the server for the Modbus Client protocol ........................................... 101
6.1.2 To add a line to a server for the Modbus Client protocol ............................................... 102
6.1.3 To add a Generic Modbus RTU to a line for the Modbus Client protocol ........................... 106
6.1.4 To add a Generic Modbus Gateway to a line for the Modbus Client protocol ..................... 110
6.1.5 To add a Generic Modbus Gateway RTU to a line for the Modbus Client protocol ............... 113
6.1.6 To add a scanblock to an RTU for the Modbus Client protocol ....................................... 115
6.1.7 To save protocol configuration information .............................................................. 119
6.2 Modbus Client Scanblock Types ....................................................................................... 119
6.2.1 Modbus Client Scanblock Type - Read Coil Status ....................................................... 120
6.2.2 Modbus Client Scanblock Type - Read Input Registers ................................................. 122
6.2.3 Modbus Client Scanblock Type - Read Input Status ..................................................... 124
6.2.4 Modbus Client Scanblock Type - Alarm With Ack ....................................................... 126
6.2.5 Modbus Client Scanblock Type - Force Single Coil ...................................................... 127
6.2.6 Modbus Client Scanblock Type - Preset Single Register ............................................... 129
6.2.7 Modbus Client Scanblock Type - Force Multiple Coils .................................................. 132
6.2.8 Modbus Client Scanblock Type - Preset Multiple Registers ........................................... 134
6.2.9 Modbus Client Scanblock Type - Mask Write Register ................................................. 137

Section 7 Modbus Server configuration ........................................................................................... 141

7.1 Overview of configuring the Modbus Server protocol ............................................................ 141
7.1.1 To add a port to the server for the Modbus Server protocol .......................................... 141
7.1.2 To add a line to a server for the Modbus Server protocol .............................................. 142
7.1.3 To configure an RTU for the Modbus Server protocol .................................................. 145
7.1.4 To add a scanblock to an RTU for the Modbus Server protocol ....................................... 147
7.1.5 To save protocol configuration information .............................................................. 150
7.2 Modbus Server Scanblock Types ...................................................................................... 150

PRO_007 7
Contents

7.2.1 Modbus Server Scanblock Type - Read Coil Status ...................................................... 151
7.2.2 Modbus Server Scanblock Type - Read Input Status .................................................... 152
7.2.3 Modbus Server Scanblock Type - Read Holding Registers ............................................. 153
7.2.4 Modbus Server Scanblock Type - Read Input Registers ................................................ 154
7.2.5 Modbus Server Scanblock Type - Force Single Coil ..................................................... 155
7.2.6 Modbus Server Scanblock Type - Preset Single Register ............................................... 156
7.2.7 Modbus Server Scanblock Type - Force Multiple Coils ................................................. 157
7.2.8 Modbus Server Scanblock Type - Preset Multiple Registers ........................................... 158

Section 8 Understanding the Modbus Simulator ............................................................................... 161

8.1 What is the Modbus Simulator? ....................................................................................... 161
8.2 Installing a Modbus Simulator ......................................................................................... 161
8.3 What is a Modbus Server Simulator? ................................................................................. 161
8.3.1 Working with the Modbus Server Simulator ............................................................. 162
8.3.2 Configuring port ............................................................................................... 162
8.3.3 Configuring servers ............................................................................................ 163
8.3.4 Transferring values from a Modbus Server simulator to a Scan point .............................. 165
8.3.5 Transferring values from Scan point to Modbus Server simulator ................................... 166
8.4 What is a Modbus Client simulator? .................................................................................. 168
8.4.1 Working with Modbus Client Simulator ................................................................... 168
8.4.2 Configuring communication port .......................................................................... 168
8.4.3 Transferring values from Scan point to Modbus Client simulator ................................... 172
8.4.4 Diagnostics ...................................................................................................... 173

8 PRO_007
 What is the Modbus protocol?

1 Introduction to the Modbus Protocol

Topics covered in this section:
• What is the Modbus protocol? [9]
• What is a Modbus Client RTU? [10]
• Modbus configuration overview [10]
• Understanding how Ovation platforms work with protocols [11]
• Modbus Client Line Redundancy [13]

1.1 What is the Modbus protocol?

Modbus is a serial communications protocol for use with programmable logic controllers
(PLCs). It is used for transmitting information over serial lines between electronic devices.
The device requesting the information is called the Modbus Client and the devices
supplying information are Modbus Servers. In a standard Modbus network, there is one
Client and up to 247 Servers, each with a unique Client Address from 1 to 247. The Client
can also write information to the Servers.

Modbus is typically used to transmit signals from instrumentation and control devices
back to the main controller or data-gathering system. Modbus is often used to connect a
supervisory computer with a remote terminal unit (RTU) in supervisory control and data
acquisition (SCADA) systems. Versions of the Modbus protocol exist for serial lines (Modbus
RTU and Modbus ASCII) and for Ethernet (Modbus TCP).

For more information on Modbus, refer to:

https://www.schneider-electric.us

MODBUS is a registered trademark of Schneider Automation, Inc.

1.1.1 What is a Modbus Client?

When a device is configured as a Modbus Client, it is designated as the device requesting
information. A Modbus Client initiates requests to read or write information in the form
of Modbus Functions; different Modbus Functions are used to read or write different types
of data registers. A Modbus Client can request Modbus Functions from up to 247 unique
Modbus Server nodes.

1.1.2 What is a Modbus Server?

When a device is configured as a Modbus Server, it is designated as the device responding to
requested information. A Modbus Server is programmed with registers that can hold data
for a Modbus Client to read or write to.

At a minimum, a Modbus Server should specify:

• A unique node number

• Modbus registers and addresses

If the Modbus Server is communicating over ethernet, it should specify:

PRO_007 9
What is a Modbus Client RTU?

• A TCP listening port

• An IP address

1.2 What is a Modbus Client RTU?

A Modbus Client RTU defines the end device(s), or Modbus Server(s), that the SCADA/CPS
Modbus Client is intended to talk to. SCADA/CPS can communicate directly with a Modbus
RTU or with a Modbus Gateway (a hub for multiple Modbus RTUs or a Modbus media
converter). RTUs configured on a Modbus Gateway are processed in series.

Settings available at the Modbus Client RTU level include:

• RTU timeout – a communication timeout defining the amount of time to wait for a
response to a request before determining the request has timed out.
• RTU retries – the number of times the Modbus Client attempts to retry a failed request
before determining the RTU is Out of Service.
• When enabled, the SCADA/CPS Modbus Client can support Modbus broadcast
messages.
• When enabled, the SCADA/CPS Modbus Client can support Daniel Floats. When the
RTU is in Daniel Floats mode, holding registers are assumed to be 31 bits long instead
of 16 bits.

1.3 Modbus configuration overview

Modbus communication can be described as a Modbus Client requests to read or write data
to or from a Modbus Server and that Server responds to fulfill that Client’s requests. A
Modbus Server holds its data within registers.

The available register types within the Modbus protocol are described in the following
table.

Table 1. Modbus Registers Types

Register Type Address Data Size

Coil 0001-9999 1 bit
Discrete/Input Status 10001-19999 1 bit
Input Register 30001-39999 16 bits
Holding Register 40001-49999 16 bits

The available data types within the Modbus Protocol are described in the following table.

Table 2. Data Types

Data Type Data Size Modbus Register Size (of 16 bits)

BOOL 1 bit 1/16 register
BYTE 8 bits 1/2 register
INT 16 bits 1 register

10 PRO_007
 Understanding how Ovation platforms work with protocols

Data Type Data Size Modbus Register Size (of 16 bits)

FLOAT 32 bits 2 registers

A Modbus Client can read or write values to or from a Modbus Server’s registers through
Modbus Functions. Different Modbus Functions are used to perform a read or write on a
Modbus Server for a specific register type at specific addresses.

General expectations of Modbus communication are:

• A Modbus Client sends a request containing: the intended node number, function
code, starting register, and number of registers requested.
• A Modbus Server sends a response containing: its node number, function code, length
of message, and the requested data.

1.4 Understanding how Ovation platforms work with

protocols
Emerson developed a unified set of communication protocol software that works across
multiple platforms. This includes the following:

• Ovation SCADA Communication Server software that runs on the Ovation workstation
platform.
• Communication Protocol software that runs on the Ovation Ethernet Link Controller
(ELC) platform.

Note
The ELC platform requires that you download the appropriate protocol library file from
the Controller Diagnostics utility.

For more information, refer to the Ethernet Link Controller User Guide.

• Communication Protocol software that runs on the Ovation Compact Controller

(OCC100) platform.
• Communication Protocol software that runs on the Ovation Controller (OCR3000)
platform.
• Communication Protocol software that runs on the Ovation Micro Controller
(OMC100) platform.
• Communication Protocol software that runs on the Standalone Controller platform.

This approach allows all targeted platforms to support the same communication protocols.
This manual discusses an individual protocol and how it works with each Ovation platform.
Most functions are identical. Where differences exist between platforms, those differences
are noted in the document.

The procedures in this manual assume that you have already properly configured the
platform in the Ovation Developer Studio. For information on these platforms, refer to the
following platform manuals:

PRO_007 11
Understanding how Ovation platforms work with protocols

• SCADA User Guide

• Ethernet Link Controller User Guide
• Ovation Compact Controller (OCC100) User Guide
• Ovation Controller (OCR3000) User Guide
• Ovation Micro Controller (OMC100) User Guide
• Standalone Controller Software Toolkit (OVSCST500) User Guide

1.4.1 Modbus error codes

The Modbus protocol is equipped with error codes. If a Modbus Server receives a request it
cannot process, it may send error codes explaining what is wrong.

Table 3. Modbus error codes

Code Field Name Meaning

01 Illegal Function The function code received in the query is not an allowable action for the
slave. This may be because the function code is too new and not available
on this device. This may also indicate the slave is in the wrong state
to process a request of this type, or that the particular register being
requested a value from is unconfigured.
02 Illegal Data The data address received in the query is not an allowable address for
Address the slave. More specifically, the combination of reference number and
transfer length is invalid. For example, in a controller with 100 registers,
a request with offset 96 length 4 succeeds, while a request with offset 95
length 5 causes this error.
03 Illegal Data Value A value contained in the query data field is not an allowable value for the
slave. This indicates a fault in the structure of the remainder of a complex
request, such as the implied length is incorrect.

Note
The Modbus protocol is unaware of the significance of any value within
a given register, therefore this error specifically DOES NOT MEAN that
a data item submitted for storage in a register has a value outside the
expectation of the application program.

04 Slave Device An unrecoverable error occurred while the slave was attempting to
Failure perform the requested action.
05 Acknowledge Specialized use in conjunction with programming commands. The slave
has accepted the request and is processing it which could take time;
this response is returned to prevent a timeout error occurring in the
master. The master can next issue a Poll Program Complete message to
determine if the process is completed.
06 Slave Device Busy Specialized use in conjunction with programming commands. The slave
is engaged in processing a long-duration program command; the master
should retransmit the message later when the slave is free.
DA Gateway Path Specialized use in conjunction with gateways. This error indicates the
Unavailable gateway was unable to allocate an internal communication path from the
input port to the output port for processing this request.

12 PRO_007
 Modbus Client Line Redundancy

Code Field Name Meaning

DB Gateway target Specialized use in conjunction with gateways. This error indicates that no
device failed to response was obtained from the target device; typically, this means the
respond device is not present on the network.

1.5 Modbus Client Line Redundancy

A Modbus Client Line defines the communication path to the Modbus Server RTU. It must
be assigned to a port within the SCADA/CPS configuration. All RTUs on a single line are
processed in series. All lines on a SCADA/CPS server are processed in parallel.

A Modbus Client Line supports redundant communication paths; two ports (primary and
backup) may be assigned to a single line.

• The primary path is defined by the primary port and assigned protocol. This is the
preferred communication path and is used by the Modbus Client when available.
• The backup path is defined by the backup port and assigned protocol. This path is only
used if the primary path is unavailable.

A Modbus Client Line can use a different type of Modbus protocol for the primary and
backup ports. For example, Modbus Open TCP can be selected as the primary protocol with
port 1 defined as a TCP port while Modbus RTU can be selected as the backup protocol with
port 2 defined as a serial port.

A Modbus Client Line can support two-port redundancy or four-port redundancy.

• In two-port redundancy, the primary SCADA server attempts to communicate with the
RTU over the primary port. If that communication fails, it attempts to communicate
with the RTU over the backup port. In a redundant configuration, when the partner
SCADA server is in control mode, it attempts to communicate with the RTU over the
partner's primary port. If that communication fails, it attempts to communicate with
the RTU over the partner backup port.
• In four-port redundancy, the primary and partner SCADA servers, whichever is in
control, attempt to communicate with the RTU over the primary port. If that
communication fails, it attempts communication over the backup port. If that
communication fails it attempts communication over the backup two ports. If that
communication fails it attempts communication over the backup three port.

PRO_007 13
 What is the Protocol Configuration Tool?

2 Understanding the Protocol

Configuration Tool
Topics covered in this section:
• What is the Protocol Configuration Tool? [15]
• Understanding the Protocol Configuration Tool window [16]
• Accessing the Protocol Configuration Tool [16]
• What are the Protocol Configuration Tool menu options? [27]
• What are the Protocol Configuration Tool toolbar options? [29]
• What are the Protocol Configuration Tool windows? [31]

2.1 What is the Protocol Configuration Tool?

The Protocol Configuration Tool is a configuration application launched by the Ovation
Developer Studio that is used to configure the protocols for the applicable Ovation
platform. The tool allows you to create various communication objects (ports, lines,
gateways, RTUs, and so forth), configure their attributes, and map remote data values to
Ovation process points.

The Protocol Configuration Tool stores this configuration information in an XML file on
the Ovation Database Server and updates the relevant information within the Ovation
configuration database. The Ovation Developer Studio is used to access the Protocol
Configuration Tool and to load the configuration information to the target platform.

The Protocol Configuration Tool is typically used on an Ovation engineering workstation

and accessed from the Ovation Developer Studio. However, the Protocol Configuration
Tool can also be used on a standalone PC to edit a local configuration file. In this case,
the tool is accessed from the Windows menu. This is considered the offline mode. When
it is in offline mode, the Protocol Configuration Tool cannot interact with the Ovation
database. Therefore, it cannot present the user with point lists and cannot update the
Ovation configuration with the applicable changes. The configuration file created in the
offline mode can be manually moved to an Ovation system and imported into the online
Protocol Configuration Tool on that system.

PRO_007 15
Understanding the Protocol Configuration Tool window

2.2 Understanding the Protocol Configuration Tool

window
The Protocol Configuration Tool is split into two panes. The left pane displays a hierarchy of
configuration objects, such as servers, ports, lines, gateways, RTUs, and scanblocks.

The right pane of the Configuration Tool displays the property page applicable to the item
selected in the hierarchy. For example, if an RTU is selected in the hierarchy tree, the right
pane displays the property page for that RTU. The configuration parameters displayed on
the property page are specific to the selected object and the configured protocol.

The Protocol Configuration Tool drop-down menus and toolbar provide access to other
functionality of the Configuration Tool.

2.3 Accessing the Protocol Configuration Tool

Use the Protocol Configuration Tool to configure protocols for the Ethernet Link
Controller, Ovation Compact Controller, Ovation OCR300 Controller, Ovation OMC100
Micro Controller, Standalone Controller, and the SCADA Server. While the tool is the same
for all platforms, accessing the tool in the Developer Studio varies slightly.

Select the topic that applies to your platform:

• To access the Protocol Configuration Tool for ELC [17].

• To access the Protocol Configuration Tool for OCC [18].
• To access the Protocol Configuration Tool for OCR3000 [20].
• To access the Protocol Configuration Tool for OMC100 [22]
• To access the Protocol Configuration Tool for Standalone Controller [24]
• To access the Protocol Configuration Tool for SCADA [25].

2.3.1 Accessing the Ovation Developer Studio

When the Ovation system is loaded, the Developer Studio icon appears on the desktop.
Double-click the icon to access the Developer Studio. For more information, refer to the
Ovation Developer Studio User Guide.

You can also access the Developer Studio from the context menu of the Operator Station
applications, such as Point Information. For more information, refer to the Ovation Operator
Station User Guide.

Note
Much of the setup and configuration of the Developer Studio contents and hierarchy is
typically performed by an Emerson representative before the system is installed.

16 PRO_007
 Accessing the Protocol Configuration Tool

2.3.2 To access the Protocol Configuration Tool for ELC

1. Access the Ovation Developer Studio [16].
2. Navigate to the ELC module in the system tree. For example, this step shows the ELC
module added to an OCR1100 Controller.
Systems > Networks > Units > Drops > Drop # > I/O Devices > I/O Device # IOIC >
> [I/O Interfaces] > I/O Interface # Local Ovation > Branch # > Slot # > Ethernet Link
BusModule > Ethernet Link Configuration

Note
For information on adding modules to Compact Controllers, refer to the Ovation
Compact Controller (OCC100) User Guide. For information on adding modules to
Controllers, refer to the Ovation Controller (OCR3000) User Guide. For information on
adding modules to Micro Controllers, refer to the Ovation Micro Controller (OVMAN51)
User Guide.

3. Right-click the Ethernet Link Configuration folder and select Engineer from the pop-up
menu.

Figure 1. Engineer menu item selected from Ethernet Link Configuration item -
OCR1100 Controller

PRO_007 17
Accessing the Protocol Configuration Tool

4. The Protocol Configuration Tool window appears.

Figure 2. Protocol Configuration Tool window for ELC

Note
When the Configuration Tool is started from the Developer Studio and is connected to the
database, the current configuration for the Server appears in the Tool. If a configuration
does not exist, a new empty, configuration is started.

2.3.3 To access the Protocol Configuration Tool for OCC

1. Access the Ovation Developer Studio [16].
2. Use the system tree to navigate to the I/O Device # Embedded Ethernet Link folder:
Systems > Networks > Units > Drops > Drop # > I/O Devices > I/O Device # Embedded
Ethernet Link

18 PRO_007
 Accessing the Protocol Configuration Tool

3. Right-click the I/O Device # Embedded Ethernet Link item and select Engineer from the
pop-up menu.

Figure 3. Engineer menu item selected from Embedded Ethernet Link item

4. The Protocol Configuration Tool window appears.

Figure 4. Protocol Configuration Tool window for OCC

Note
When the Configuration Tool is started from the Developer Studio and is connected
to the database, the current configuration for the Server appears in the Tool. If a
configuration does not exist, a new, empty configuration is started.

PRO_007 19
Accessing the Protocol Configuration Tool

2.3.4 To access the Protocol Configuration Tool for OCR3000

1. Access the Developer Studio [16].
2. Use the system tree to navigate to the I/O Device # Embedded Ethernet Link item:
Systems > Networks > Units > Drops > Drop # > I/O Devices > I/O Device # Embedded
Ethernet Link
3. Right-click the I/O Device # Embedded Ethernet Link item and select Engineer from the
pop-up menu.

Figure 5. Engineer menu item selected from Embedded Ethernet Link item

4. The Protocol Configuration Tool window appears. For a list of available protocols, refer
to the Ovation Users website.

20 PRO_007
 Accessing the Protocol Configuration Tool

Figure 6. Protocol Configuration Window for OCR3000

Note
When the Configuration Tool is started from the Developer Studio and is connected
to the database, the current configuration for the Server appears in the Tool. If a
configuration does not exist, a new, empty configuration is started.

PRO_007 21
Accessing the Protocol Configuration Tool

2.3.5 To access the Protocol Configuration Tool for OMC100

1. Access the Ovation Developer Studio.
2. Use the system tree to navigate to the I/O Device # Embedded Ethernet Link item:
Systems > Networks > Units > Drops > Drop # > I/O Devices > I/O Device # Embedded
Ethernet Link
3. Right-click the I/O Device # Embedded Ethernet Link item and select Engineer from the
pop-up menu

Figure 7. Engineer menu item selected from Embedded Ethernet Link item

4. The Protocol Configuration Tool window appears.

Figure 8. Protocol Configuration Tool window

22 PRO_007
 Accessing the Protocol Configuration Tool

Note
When the Configuration Tool is started from the Developer Studio and is connected
to the database, the current configuration for the Server appears in the Tool. If a
configuration does not exist, a new, empty configuration is started.

PRO_007 23
Accessing the Protocol Configuration Tool

2.3.6 To access the Protocol Configuration Tool for Standalone

Controllers
1. Access the Ovation Developer Studio.
2. Use the system tree to navigate to the I/O Device # Embedded Ethernet Link item:
3. Right-click the I/O Device # Embedded Ethernet Link item and select Engineer from the
pop-up menu. For the following example, select Systems > SCsys > Network > UNIT
>Standalone Controller > Tank-31 > I/O Devices > I/O Device # Embedded Ethernet Link

Figure 9. Engineer menu item selected from Embedded Ethernet Link item

4. The Protocol Configuration Tool window appears.

24 PRO_007
 Accessing the Protocol Configuration Tool

Figure 10. Protocol Configuration Tool window

Note
When the Configuration Tool is started from the Developer Studio and is connected
to the database, the current configuration for the Server appears in the Tool. If a
configuration does not exist, a new, empty configuration is started.

2.3.7 To access the Protocol Configuration Tool for SCADA

Note
When the Configuration Tool is started from the Developer Studio and is connected to the
database, the current configuration for the Server appears in the Tool. If a configuration
does not exist, a new, empty configuration is started.

1. Access the Ovation Developer Studio [16].

2. Use the system tree to navigate to the designed Ovation Workstation drop.
3. Use the system tree to navigate to the SCADA 3 folder:
System > Network > Unit > Drops > DROP# (where SCADA software is loaded) >
Configuration > SCADA 3

PRO_007 25
Accessing the Protocol Configuration Tool

4. Right-click the SCADA 3 folder and then select Engineer from the pop-up menu.

Figure 11. Engineer menu item accessed from SCADA 3 folder

26 PRO_007
 What are the Protocol Configuration Tool menu options?

5. The Protocol Configuration Tool appears.

Figure 12. Protocol Configuration Tool window for SCADA

2.4 What are the Protocol Configuration Tool menu

options?
The following table lists and describes the Protocol Configuration Tool menu options.

Table 4. Protocol Configuration Tool menu options

Menu Description and Keyboard Shortcut (shown in parentheses, if applicable)

File New - Clears the current configuration and creates a new and blank configuration.
(Ctrl + N)
Open - Opens an existing configuration file.
Import - Imports the selected configuration files. (Ctrl + I)
Save - Saves the current configuration. (Ctrl + S)
Save As - Saves the current configuration to a different file.
Export - Exports the current configuration to the selected configuration file. (Ctrl +
E)
Page Setup - Displays printer and print options.
Print Preview - Displays the active document as it appears when printed.
Print - Prints the current configuration in XML format. (Ctrl + P)

PRO_007 27
What are the Protocol Configuration Tool menu options?

Menu Description and Keyboard Shortcut (shown in parentheses, if applicable)

Exit - Closes the active window.
Edit Cut - Copies the selection to the clipboard and marks it for deletion when Paste is
selected. (Ctrl + X)
Copy - Copies the selection to the clipboard. (Ctrl + C)
Paste - Pastes the clipboard contents to the desired area. (Ctrl + V)
Go To - Displays the Go To window. The Go To window searches and locates
objects in the configuration treeview. This includes Server, Port, Line Gateway,
RTU, Gateway RTU, and Scanblock objects. This provides a quick way to navigate
to a Line, RTU, or Scanblock in large configurations.
Find and Replace

Find - Displays the Find tab of the Find and Replace Window. This function allows
point names within the configuration to be found. The Find function starts its
search at the top of the treeview hierarchy and searches to the bottom of the
configuration. The find function does not wrap around and start back at the
beginning. This is important to understand when using both the Find and the
Replace functions. By default, the find function is case insensitive. A case-sensitive
search is performed if the Match case option is selected. By default, the find
function searches for any portion of the point name that matches the user-entered
Find string. If the Match whole word option is selected, then the user-entered
string must match the entire point name. By default, the ‘*’ character can be
used as a wildcard. The Use regular expressions option can be enabled for more
flexibility in find criteria. Regular expressions can then be used for the find
function.

This will not find a point anywhere in the configuration. This will not find a point in
the Scan Points tab.

Replace - Displays the Replace tab of the Find and Replace Window. This function
allows point names within the configuration to be found and replaced with the
user-entered replacement string. The find options are the same for Find as for
Replace. When Replace is selected, the first occurrence is replaced. When Replace
All is selected, all occurrences found are replaced.

This functionality only finds and replaces point names. It does not work for general
text fields such as descriptions.

Note
The find begins at the node currently selected in the treeview and searches in that
node and all child nodes. For example, select the server node to find/replace the
entire configuration.

Add - Displays the Add Items window.

Delete - Deletes the selected item from the hierarchy tree.
Edit XML - Allows you to edit the current configuration in XML format in a text
editor rather than editing information in the Configuration Tool entry fields.
Tools Validate - Validates the current configuration. If any errors exist, open the Error
Browser window.
Create Points - Opens the Create Points window, which displays a list of undefined
points and allows you to create those points in the Ovation Database.

28 PRO_007
 What are the Protocol Configuration Tool toolbar options?

Menu Description and Keyboard Shortcut (shown in parentheses, if applicable)

Update Database - Forces an update of the hardware configuration for all points in
the Configuration Tool.
Import Description Fields - Updates the Description fields with the Ovation Point
Engineering Description (ED) field.
Configuration Information - Displays a window of basic configuration statistics
information.
Options - Displays Configuration tools options window.
Help Contents - Displays the online help (Table of Contents displays).
Index - Displays the online help for the (Help Index displays).
Search - Provides a search tool for help.
About - Displays program information for the Protocol Configuration Tool.
Defaults Resets the attribute configuration in the property page pane to the default values.
Help Displays the online help for the current property page.
Apply Accepts and applies the selections or changes.
Cancel Cancels the current action.
Error icon (icon If there is an error in the Configuration Tool, this icon is enabled. If you select it, the
on the right) Error Browser window appears. If there are no errors, the icon is grayed out.
Database Indicates the tool's connection status to the Ovation database. If there is an "x"
Connection over the line in the icon, it means the tool is not connected to the database
icon (icon on (offline). If no "x" appears over the line in the icon, it means the tool is connected to
the right) the database (online).

Note
The tooltip over the Database Connection icon also indicates the state of the
Ovation database connection, which is Offline Mode or Online Mode.

2.5 What are the Protocol Configuration Tool toolbar

options?
The Protocol Configuration Tool window displays a toolbar of operator command options.
An illustration of the toolbar is shown below.

Figure 13. Protocol Configuration Tool toolbar

Table 5. Protocol Configuration Tool toolbar icons and descriptions

Toolbar Icons and Description

Buttons
Toolbar Icons (left to right)
New Clears the current configuration and creates a new and blank configuration.

PRO_007 29
What are the Protocol Configuration Tool toolbar options?

Toolbar Icons and Description

Buttons
Open Opens a configuration file.
Save Saves the current configuration.
Print Prints the current configuration in XML format.
Print Preview Displays the active document as it appears when printed.
Cut Copies the selection to the clipboard and marks it for deletion when Paste is
selected.
Copy Copies the selection to the clipboard.
Paste Pastes the clipboard contents to the desired area.
Add Displays the Add Items window.
Delete Deletes the selected item from the hierarchy tree.
Validate Validates the current configuration. If any errors exist, the Error Browser
window opens.
Create Points Opens the Create Points window, which displays a list of undefined points
and allows those points to be created in the Ovation Database.
Help Displays the online help.

30 PRO_007
 What are the Protocol Configuration Tool windows?

2.6 What are the Protocol Configuration Tool

windows?
Several windows are accessed from the Protocol Configuration Tool. These windows allow
you to perform various functions, which are described in the following sections:

• Add Items window [31].

• Import window [33].
• Export window [35].
• XML View window [36].
• Error Browser window [37].
• Create Points window [38].
• Updating Database window [39].
• Configuration Statistics window [41].
• Point Selector window [42].
• Configuration Tool Options window [46].

2.6.1 Using the Add Items window to add an item to the

Protocol Configuration Tool hierarchy
The Add Items window is used to add items such as ports, lines, gateways, RTUs, and
scanblocks to the configuration hierarchy.

1. Access the Protocol Configuration Tool [16].

2. Access the Add Items window in one of the following ways:
• Click the Plus icon (+) on the Protocol Configuration toolbar.
OR
• Pull down the Edit menu on the Protocol Configuration window and select Add.
OR
• Highlight an item in the Configuration Tool hierarchy tree (Server, Line, or RTU).
Right-click and select Add from the menu.

Note
The following figure shows one example of the information that could appear on the
Add Items window. The contents of the Add Items window change based on the item
highlighted in the hierarchy tree (Port, Line, Gateway, or RTU). The only protocols that
appear in an Add Items window are those that are configured in the Ovation Developer
Studio.

PRO_007 31
What are the Protocol Configuration Tool windows?

3. Select the desired item and click the Add New button. (You can also double-click the
desired item.) The Add Items window closes and the selected item is added to the
Configuration Tool tree.

Figure 14. Add Items window

32 PRO_007
 What are the Protocol Configuration Tool windows?

2.6.2 To delete an item from the Protocol Configuration Tool

1. Access the Protocol Configuration Tool [16].
2. Select the item to delete in the hierarchy tree.
3. Choose one of the following methods:
• Click the X icon from the Protocol Configuration Tool toolbar.
OR
• Pull down the Edit menu and select Delete.
OR
• Highlight an item in the Configuration Tool hierarchy tree. Right-click and select
Delete from the menu.
The Protocol Configuration Tool delete window appears.

Figure 15. Protocol Configuration Tool delete dialog box

4. Click Yes to delete or No to exit the delete window without making any changes.

Note
You cannot delete an item that is in use.

2.6.3 Using the Import window to import configuration files

The Import operation should be used to import a new configuration file that has been
generated or modified outside of the Protocol Configuration Tool for this specific device.
This includes configuration files that have been edited with a text editor, edited with the
offline version of the Protocol Configuration Tool, files from a different device, and files
from a different Ovation system. The imported configuration file replaces the existing
configuration file.

The Import operation removes point SID information from the imported configuration,
clears the hardware fields of the points in the existing configuration, and updates
the hardware fields with the points in the new configuration. When modifying the
configuration outside of the Configuration Tool, always use the import operation.

Note
Editing the existing configuration file with any tool other than the Protocol Configuration
Tool can lead to unexpected results.

Use the following procedure to import a configuration file.

PRO_007 33
What are the Protocol Configuration Tool windows?

1. Access the Protocol Configuration Tool [16].

2. Pull down the File menu and select Import.
3. A message appears asking whether you want to clear the current configuration and
import a new configuration file. Click OK.
4. The Open window appears. Select an XML configuration file from the scrolling list, and
click Open.

Figure 16. Open window -- used for importing configuration files

5. The file import process begins.

Figure 17. Importing File processing window

6. Once the file has been imported, the Protocol Configuration window updates to show
the imported file in the hierarchy and the configuration window. If any errors exist, the
Error Browser [37] appears showing the configuration error.

34 PRO_007
 What are the Protocol Configuration Tool windows?

2.6.4 Using the Export window to export configuration files

The Export operation should be used to save the configuration to an XML file for review,
editing, or transport to a different system. During the Export operation, you are prompted
for a filename and location to save the current configuration. If this file is edited manually,
the updated file must be imported back into the Configuration Tool using the Import
operation [33].

Use the following procedure to export a configuration file.

1. Access the Protocol Configuration Tool [16].

2. Pull down the File menu and select Export. The Export File window appears.

Figure 18. Export File window

3. Enter a name for the exported file in the File name entry field, and select the Save
button.
The configuration file is exported and saved.

PRO_007 35
What are the Protocol Configuration Tool windows?

2.6.5 Editing XML configuration files

The Edit XML window allows you to edit the configuration file using standard XML syntax.
Edit configuration files carefully to ensure that both content and syntax are correct.

In the hierarchy view on the left side of the Configuration Tool window, you can select any
item (node) in the tree for editing. Right-click the item and select the Edit XML option from
the menu. The Edit XML window appears and displays, the information for the selected XML
node and all child nodes that can be edited. When you finish editing, validate the syntax and
contents. If the new configuration is valid, the changes are accepted and the configuration
is updated to reflect these changes.

Use the following procedure to edit an XML configuration file.

1. Access the Protocol Configuration Tool [16].

2. Access the XML View window in one of the following ways:
• Pull down the Edit menu and select Edit XML.
OR
• Highlight a node in the hierarchy, right-click, and select Edit XML from the menu.
3. The XML Editor window appears showing the node that was highlighted in the
hierarchy tree and its child nodes that can be edited.

Figure 19. XML Editor window

36 PRO_007
 What are the Protocol Configuration Tool windows?

4. Make the appropriate edits and select the OK button to confirm the edits and quit the
window. Select Apply to confirm the edits, but leave the XML window open.

Note
Any errors in the XML code generate an error in a pop-up window.

2.6.6 Using the Error Browser to check for configuration errors

The Error Browser identifies errors in the selected item(s) in the Protocol Configuration Tool.

1. Access the Protocol Configuration Tool [16].

2. Select the Tools menu and click the Validate option or click the Validate button on the
Protocol Configuration toolbar.
3. The validation process runs. If no errors exist, an information message appears stating
that you have no errors.
4. If errors exist, the Error Browser window appears and identifies the error. The following
figure shows an Error Browser window.

Figure 20. Error Browser window

5. Double-click the desired error to display it in the Configuration Tool.

PRO_007 37
What are the Protocol Configuration Tool windows?

2.6.7 Using the Point Create Dialog window to create a point

The Create Points window allows you to create Ovation points in the Ovation Database.

1. Access the Protocol Configuration Tool [16].

2. Select the Tools menu and click the Create Points option or click the Create Points
button in the Protocol Configuration toolbar and the Point Create Dialog window
appears.

Figure 21. Point Create Dialog window

3. Select the checkbox next to each point that is created.

38 PRO_007
 What are the Protocol Configuration Tool windows?

4. Enter the required information in the entry fields of each of the selected points. See the
following table.

Table 6. Create Point Dialog field descriptions

Create Points window Description

fields
Undefined Points
Point Name Shows a list of points referenced by the Configuration Tool that do
not exist in the Developer Studio or the Ovation Database.
Record Type Specifies the type of point.
Task Index Specifies the task index for the new point.
Description Specifies a description for the new point.
Point Reference
Reference Identifies where the point is used in the configuration.
Record Type Shows the point type.
Address Identifies the point address based on the reference location.
Buttons
Export Opens the Export window.
Refresh Reloads the configuration and updates the undefined points list.
Create Creates the selected point.
Close Closes the Point Create Dialog window.

5. Click the Create button.

2.6.8 Updating the Ovation Database for applicable platform

configuration
The Protocol Configuration Tool interacts with the Ovation Database to retrieve information
as well as to save configuration information. The configuration of the Ovation platforms
requires both the information stored by the Protocol Configuration Tool as well as the
hardware field configuration of the Ovation points associated with the platform.

Each time points are added to or deleted from the Configuration Tool, the Ovation Database
updates to reflect these changes. However, sometimes the Ovation Database configuration
can be out of sync with the platform configuration. This typically happens when a user edits
the XML file directly without using the Protocol Configuration Tool.

When this out-of-sync situation occurs, the configuration contains a set of points that
is different from the set of points configured for that platform in the Ovation Database.
In this situation, a database update must be performed. The database update clears all
hardware fields of the points associated with the platform in the Ovation Database, and
updates the hardware fields of the points specified in that platform's configuration file, thus
synchronizing the configuration between the configuration file and the database.

PRO_007 39
What are the Protocol Configuration Tool windows?

Note
This operation may take a considerable amount of time, based on the number of points
contained within the platform configuration. Therefore, this operation should be used only
when necessary.

Use the following procedure to update the database.

1. Access the Protocol Configuration Tool [16].

2. Pull down the Tools menu and select Update Database. The Run Update Database
dialog box appears.

Figure 22. Run Update Database

If you choose to update, the Updating Database window appears and begins
processing.

Figure 23. Updating Database window

Note
When the updating process completes, the window quits. No confirmation message
appears.

40 PRO_007
 What are the Protocol Configuration Tool windows?

2.6.9 Viewing configuration information

The Configuration Statistics window shows some basic statistics about the configuration.
The total number of elements, such as ports, lines, RTUs, and so forth are displayed.

Use the following procedure to view configuration information.

1. Access the Protocol Configuration Tool [16].

2. Pull down the Tools menu and select Configuration Info. The Configuration Statistics
window appears.

Note
The Configuration Statistics window is read-only. The fields cannot be edited.

Figure 24. Configuration Statistics window

PRO_007 41
What are the Protocol Configuration Tool windows?

2.6.10 Selecting points using the Point Selector window

The Point Selector window allows you to search for the appropriate point for an entry field.
Whenever an entry field on the Configuration Tool window requires a point name, use the
Point Selector window to search for the appropriate point.

1. Access the Protocol Configuration Tool [16].

2. Click in an entry field that requires a point name. When you click the entry field, a
button with three dots (...) appears. This is the Point Search button. For example, the
Point Search button is shown in the Name field in the following figure.

Figure 25. Protocol Configuration Tool window showing the Point Search button

42 PRO_007
 What are the Protocol Configuration Tool windows?

3. Click the Point Search button. The PointSearch window appears.

Figure 26. PointSearch window

The PointSearch window contains three tabs, see the following figures.
• Ovation Points - Ovation points are the predominant type of points used within
the SCADA configuration. These point values are written to the Ovation network
and can also be sent directly to the OPH through the OPH SCADA Scanner API.
• Local Points - Local points are defined as any point name that begins with the ‘$’
character. These points are “local” to the SCADA server and can be used anywhere
within the SCADA configuration that an Ovation point can be used.
• OPH Only Points - The OPH Only points are points not defined within Ovation,
the SCADA Server is responsible for providing the point configuration to the
OPH. Attributes, such as point name, English description, Engineering Units,
Set Description, Reset Description, and so forth, must be provided to the
OPH in a well-defined XML configuration file. These points are identified by a
special starting character sequence ($SCA$). They are usable within the SCADA
configuration anywhere that local and Ovation points can be used.

PRO_007 43
What are the Protocol Configuration Tool windows?

Figure 27. PointSearch window - Ovation Points tab

Figure 28. PointSearch window - Local Points tab

44 PRO_007
 What are the Protocol Configuration Tool windows?

Figure 29. PointSearch window - OPH-Only points tab

Filters appear at the top of the window. Items that are selected indicate the
appropriate settings (requirements) for the type of point you need for the entry field
on the Configuration Tool window:
• Point Type Filter -- selects the type of points shown on the window. The choices
are Analog, Digital, Packed, Module, and Node. Note that certain point types are
only valid in certain entry fields.
• Originated/Received Filter -- selects where the points come from. If Originated
is selected, only points originating on the platform are shown. If Received is
checked, only points received by the module are shown.
• Point Name Filter -- shows the points on the window whose name you have
entered in the Point Name text box and clicked Apply. You can utilize a wild card
character (*) with the point name to help broaden and narrow your point search.
Click Clear to clear the point name from the Point Name text box.
4. Highlight the desired point name in the list and click Select. You can also enter the
point name in the entry field and click Select. The selected point name appears in the
entry field on the Protocol Configuration Tool window. Click Cancel to quit the window
without selecting a point.

PRO_007 45
What are the Protocol Configuration Tool windows?

2.6.11 Selecting Configuration Tool options

The Configuration Tool Options window displays the configuration options that change how
the protocol configuration tool displays.

Use the following procedure to select the configuration tool options in the Configuration
Tool Options window:

1. Access the Protocol Configuration Tool [16].

2. Pull down the Tools menu and select Options. The Configuration Tool Options window
appears.

Figure 30. Configuration Tool Options window

3. Select the following options in the Startup Options group:

• Load Received Points – determines if the Received points or only Originated are
loaded at startup.
• Hide Splash Screen – determines if the splash screen displays when the
configuration tool is started.

46 PRO_007
 What are the Protocol Configuration Tool windows?

4. Select the following options in the Tool Options group:

• Allow Undefined Points – determines if the configuration can be saved if undefined
points exist.
• Allow Configuration Errors – determines if the configuration can be saved if errors
exist in the configuration file.
• Create System Viewer Files - selected by default. Determines if system viewer files
are created.
• Create SCADA Scanner Files - selected by default. Determines if SCADA scanner
files are created.
• Create System Reference - If this option is enabled, point references are added to
the Ovation Database. The “Where Used” feature in Developer Studio will then
show that the point is used in the SCADA configuration. Also, suppose a user
attempts to delete a point in the Developer Studio that is being used in the SCADA
Configuration. In that case, this point reference is shown and will prevent the point
from being deleted.
• Create Engineering Audit Records - If this option is enabled, entries are added
to the Engineering Audit Log showing each time the SCADA/CPS configuration is
saved.
5. The configuration tool shows the object name as well as the object type by default.
However, you can change them by using the following options in the Display group:
• Object Type – displays the object type in the tree view.
• Object Name – displays the object name in the tree view.
• Object Type and Name – displays both the object type and the object name in the
tree view.
6. If the Object Type and Object Name are selected in the Display group, then the order
displayed in the tree view can be chosen in the Display Order group:
• Object Type [Object Name] – displays the object type and then the object name in
brackets in the tree view.
• Object Name [Object Type] – displays the object name and then the object type in
brackets in the tree view.
7. Each object has a name as well as a more user-friendly alias. Select the following
options in the Display Alias group to display the object type or alias in the tree view:
• Display Object Type – displays the object type in the tree view.
• Display Object Type Alias – displays the object alias in the tree view.

2.6.12 To reset default values

You can reset any configuration window to its default settings using the Defaults button at
the bottom of the Configuration Tool window.

1. Access the Protocol Configuration Tool [16].

2. Highlight an item (node) in the hierarchy tree for which you want to return its
configuration to its default values. The current configuration settings appear on the
right side of the Configuration Tool. Click the Defaults button.

PRO_007 47
What are the Protocol Configuration Tool windows?

3. The confirmation message appears. Select Yes.

Figure 31. Reset Defaults window

4. The configuration values for the selected node are set to their default values.

48 PRO_007
 What items are configured in the Protocol Configuration Tool?

3 Using the Protocol Configuration Tool

Topics covered in this section:
• What items are configured in the Protocol Configuration Tool? [49]
• Configuring the Server in the Protocol Configuration Tool [49]
• What are ports? [61]
• What is a communication line? [70]
• What is an RTU device? [71]
• What are scanblocks? [76]
• What are status points? [76]
• What are scan points? [77]
• What are simulated points? [79]

3.1 What items are configured in the Protocol

Configuration Tool?
You can use the Protocol Configuration Tool to configure the communication objects such
as ports, lines, gateways, RTUs, and scanblocks. The configuration for these items depends
on the protocol type that uses them.

The following sections provide a brief description of each configurable item, and in some
cases, general configuration information.

3.2 Configuring the Server in the Protocol

Configuration Tool
The Protocol Configuration tool is used for these Ovation platforms (ELC, OCC, OCR3000,
OMC100, Standalone Controller, and SCADA).

Note
Select the topic that applies to your platform.

• Configuring the Configuration tab for the ELC platform [51]

• Configuring the Configuration tab for the SCADA platform [52]
• Configuring the Configuration tab for the Controller platform [53]
• Configuring the Statistic Points tab for all Ovation platforms [54]
• Configuring the Drop Configuration tab for the Controller and ELC [56]
• Configuring the Drop Configuration tab for the SCADA platform [57]
• Configuring the Partner Statistics Points tab for the ELC platform only [59]

PRO_007 49
Configuring the Server in the Protocol Configuration Tool

The Server object is the root node of the configuration hierarchy. It is added to the Protocol
Configuration Tool hierarchy when a new configuration is created. When you select the
Server in the hierarchy tree, a configuration pane with multiple tabs appears on the right
side of the Configuration Tool, as shown in the following figure.

• Configuration tab [51].

• Statistic Points tab [54].
• Drop Configuration tab [56].

Figure 32. Configuring the Server

Note
An additional tab Partner Statistics Points [59] also appears on the window when you
select Redundancy Mode as Dual in the Configuration tab for the ELC platform.

Figure 33. Partner Statistics Points tab

50 PRO_007
 Configuring the Server in the Protocol Configuration Tool

3.2.1 Configuring the Configuration tab for the ELC platform

The Configuration tab allows you to define general information about the Server. Unlike
other configuration windows in the Configuration Tool, point names are not needed.

Figure 34. Configuring the Server

Table 7. Configuration tab field descriptions for Server configuration

Dialog fields Description

Configuration
Type Identifies the type of server. This field is specific to each platform. For the ELC,
the Type is I/O Module.
Name Enter a name for the server.
Description Enter a short description for the server. This field is optional.
Server Configuration
Type Shows the configuration type. For the ELC, I/O Module appears in the field. This
field is read-only in online mode. In offline mode, the designed platform can be
specified.
Redundancy Mode If ELC redundancy is configured, this combo box is enabled. The choices are
Classic and Dual. Classic redundancy uses two ELCs as redundant partners
where one ELC operates in Primary mode and the other operates in Backup
mode. Dual redundancy uses two ELCs as peers, where each ELC can
communicate with an end device and the Controller determines which ELC to
use the data from.
Primary Drop Shows the Primary Controller containing the ELC.
Partner Drop Shows the Partner Controller containing the ELC.
Primary Module Shows the Primary ELC module location.
Partner Module Shows the Partner ELC module location.

PRO_007 51
Configuring the Server in the Protocol Configuration Tool

Dialog fields Description

ELC Classic Redundancy Control
Point Name Shows the name of a digital point that can be used to control which ELC is in
primary mode. If configured, the first ELC is in primary mode when the value of
the digital point is 0, the second ELC is in primary mode when the value of the
digital point is 1.

3.2.2 Configuring the Configuration tab for the SCADA

platform
The Configuration tab allows you to define general information about the Server. Unlike
other configuration windows in the Configuration Tool, no point names are needed.

Figure 35. Configuring the Server

Table 8. Configuration tab field descriptions for Server configuration

Dialog fields Description

Configuration
Type Identifies the type of server. This field is specific to each platform. For the SCADA
Server, the Type is Workstation.
Name Enter a name for the server.
Description Enter a short description for the server. This is an optional field.
Server Configuration
Type Shows the configuration type. The valid option for the SCADA Server is Workstation.
This field is read-only in online mode. In offline mode, the designed platform can be
specified.
Primary Drop Shows the Primary Drop containing the SCADA software.
Partner Drop Shows the Partner Drop containing the SCADA software.

52 PRO_007
 Configuring the Server in the Protocol Configuration Tool

3.2.3 Configuring the Configuration tab for the Controller

platform
The Configuration tab allows you to define general information about the Controller. Unlike
other configuration windows in the Configuration Tool, point names are not needed.

Figure 36. Configuring the Server

Table 9. Configuration tab field descriptions for Controller configuration

Dialog fields Description

Configuration
Type Identifies the type of Controller. This field is specific to each platform.
Name Enter a name for the Controller.
Description Enter a short description for the Controller. This is an optional field.
Controller Configuration
Type Shows the configuration type. For example, for OCC, Controller appears in the field.
This field is read-only in online mode. In offline mode, the designed platform can be
specified.

PRO_007 53
Configuring the Server in the Protocol Configuration Tool

Dialog fields Description

Primary Drop Shows the Primary drop number of the Controller.
Partner Drop Shows the Partner drop number of the Controller.

3.2.4 Configuring the Statistic Points tab for all Ovation

platforms
The Statistic Points tab shows the optional point names that can be used to show statistics.
This includes the performance statistics of the module as well as communication statistics
between the module and the Controller.

Figure 37. Configuring the Statistic Points tab for the Server

Refer to the following table for information on the window fields.

Table 10. Server Configuration - Statistic Points tab window descriptions

Item Setting Description

Performance Statistics Points
Duty Cycle Analog point name Determines how much of the
CPU is being utilized. Enter an
analog point name and the
module writes a value to that
point.

54 PRO_007
 Configuring the Server in the Protocol Configuration Tool

Item Setting Description

Free Memory Analog point name Determines the amount of
available memory on the
module card. Enter an analog
point name and the module
writes a value to that point.
Used Analog point name Determines the amount of used
Memory memory on the module card.
Enter an analog point name and
the module writes a value to that
point.
Controller Communications Points
Points In You can type a point name in the entry field or Number of points received per
click on the entry field to access the Point Selector minute.
button. The PointSelector window displays. You
Points Out Number of points sent per
must select an analog point that originated on the
minute.
module.
Packets In Number of message packets
received per minute.
Packets Out Number of message packets
sent per minute.
Bytes In Number of bytes received per
minute.
Bytes Out Number of bytes sent per
minute.
Statistics Configuration
Statistics 1 - 60,000 seconds Determines how often (in
Update Rate seconds) the module updates
Default = 1 the analog points that are
defined on this window.

PRO_007 55
Configuring the Server in the Protocol Configuration Tool

3.2.5 Configuring the Drop Configuration tab for the

Controller and ELC
The Drop Configuration tab displays the SOE Logger fields. Some communication protocols
allow digital input points to be configured to generate Sequence of Event (SOE) messages.
These SOE messages are sent to the specified SOE loggers.

Figure 38. Configuring the Drop Configuration tab for the Controller and ELC

Table 11. Configuration tab field descriptions for Controller and ELC configurations

Dialog fields Description

SOE Loggers
SOE Logger <n> Hostname or IP address of the Ovation Controller SOE Logger(s) on the
system.
Where <n> = 1, 2, 3, 4,
and 5
Network/Unit Configuration
Network Name Local Ovation Network Name.
Unit Name Local Ovation Unit Name.
SCADA Scanners
Primary Scanner Hostname or IP address of the Primary SCADA Scanner.
Partner Scanner Hostname or IP address of the Partner SCADA Scanner.
Event Scanners
Primary Scanner Hostname or IP address of the Primary Event Scanner.

56 PRO_007
 Configuring the Server in the Protocol Configuration Tool

Dialog fields Description

Partner Scanner Hostname or IP address of the Partner Event Scanner.
Mulesoft Adapters
Primary Adapter Hostname or IP address of the Primary Mulesoft Adapter. When this
option is enabled, data is sent to the specified Mulesoft server in XML
format and from there, can be forwarded to any system supported by
Mulesoft.
Partner Adapter Hostname or IP address of the Partner Mulesoft Adapter.
ELC Timeouts
Bus Timeout(ms) Time the Controller waits for an ELC response before assuming that the
ELC failed.
Configuration Time the Controller waits for an ELC response when the ELC is digesting
Timeout(sec) a configuration file.
Bus Retires The number of times the Controller retries communication with the ELC
before restarting the ELC.
Min Controller Pulse Minimum time in milliseconds the Controller signal spends in the "on"
Width (ms) position.
Fail on Watchdog If a process does not check in within a reasonable timeframe, a
Timeout watchdog timeout occurs. The result of this timeout can either generate
an error message or failover to the partner device if the partner device is
available.
Controller Comm The communication between the ELC and Controller is monitored. If
Timeout (Sec) the Controller stops communicating with the ELC, then the ELC no
longer has access to valid data values from Ovation. The ELC reboots
and waits for the Controller communication to resume before resuming
RTU communication.
Timestamp Configuration
Timestamp Mode Scan Time - default. When selected, the received value/quality is
tagged with the current time and passed to the Ovation network and
Historians.

Value change - When selected, the value/quality/timestamp is passed

to the Ovation network and historian(s) if the value or quality changes.
Data is passed to the SOE log if the point changes.
Failover Configuration
Fail on All RTU Failure If enabled, all RTUs marked critical must fail, before a failover to the
partner.

3.2.6 Configuring the Drop Configuration tab for the SCADA

platform
The Drop Configuration tab displays the SOE Logger fields. Some communication protocols
allow digital input points to be configured to generate Sequence of Event (SOE) messages.
These SOE messages are sent to the specified SOE loggers.

PRO_007 57
Configuring the Server in the Protocol Configuration Tool

Figure 39. Configuring the Drop Configuration tab for the Server

Table 12. Configuration tab field descriptions for Server configuration

Dialog fields Description

SOE Loggers
SOE Logger <n> Hostname or IP address of the Ovation OPH scanner drop (used as SOE
Logger(s)) on the system.
Where <n> = 1, 2, 3, 4, and 5
Network/Unit Configuration
Network Name Local Ovation Network Name.
Unit Name Local Ovation Unit Name.
SCADA Scanners
Primary Scanner Hostname or IP address of the Primary SCADA Scanner.
Partner Scanner Hostname or IP address of the Partner SCADA Scanner.
Event Scanners
Primary Scanner Hostname or IP address of the Primary Event Scanner.
Partner Scanner Hostname or IP address of the Partner Event Scanner.
Mulesoft Scanner
Primary Scanner Hostname or IP address of the Primary Mulesoft Scanner.
Partner Scanner Hostname or IP address of the Partner Mulesoft Scanner.
Timestamp Configuration

58 PRO_007
 Configuring the Server in the Protocol Configuration Tool

Dialog fields Description

Timestamp Mode Scan Time - default. When selected, the received value/quality is
tagged with the current time and passed to the Ovation network and
Historians.

Value change - When selected, the value/quality/timestamp is passed

to the Ovation network and historian(s) if the value or quality
changes. Data is passed to the SOE log if the point changes.
Failover Configuration
Fail on All RTU Failure If enabled, all RTU's that are marked critical must fail, before a failover
to the partner.

3.2.7 Configuring the Partner Statistics Points tab for the ELC
platform only
The Partner Statistics Points tab is used only for the ELC platform and only appears when
you select Redundancy Mode as Dual in the Configuration tab window. It displays the
optional point names that can be used to show statistics for the Partner ELC. This includes
the performance statistics of the ELC as well as communication statistics between the ELC
and the Controller.

Figure 40. Configuring the Partner Statistics Points tab for the Server

Refer to the following table for information on the window fields.

Table 13. Server Configuration - Partner Statistics Points tab window descriptions

Item Setting Description

Partner Performance Statistics Points (of ELC)

PRO_007 59
Configuring the Server in the Protocol Configuration Tool

Item Setting Description

Duty Cycle Analog point name Determines how much of the
CPU is being utilized. Enter an
analog point name and the ELC
writes a value to that point.
Free Analog point name Determines the amount of
Memory available memory on the ELC
card. Enter an analog point
name and the ELC writes a
value to that point.
Used Analog point name Determines the amount of
Memory used memory on the ELC card.
Enter an analog point name
and the ELC writes a value to
that point.
Partner Controller Communications Points
Points In You can type a point name in the entry field or Number of points received per
click on the entry field to access the Point Selector minute.
button. The PointSelector window appears. You
Points Out Number of points sent per
must select an analog point that originated on the
minute.
partner module.
Packets In Number of message packets
received per minute.
Packets Out Number of message packets
sent per minute.
Bytes In Number of bytes received per
minute.
Bytes Out Number of bytes sent per
minute.

60 PRO_007
 What are ports?

3.3 What are ports?

Ports are a connection through which data is input and/or output. Ovation platforms
use ports to connect to communications lines. Ports are also objects in the configuration
hierarchy that can have status points assigned so that their status can be monitored on the
Ovation system.

Figure 41. Communication Ports

Multiple port types are supported. For Ethernet-based connections, TCP and UDP ports can
be configured. For serial-based connections, direct RS-232 ports, as well as Generic and
DIGI-type terminal server ports are supported.

Ports are identified by their configured name. Ethernet ports typically use a standard
naming convention, such as TCP1 and TCP2. However, serial port names must match the
actual name of the serial port in the underlying Operating System. The following serial port
names are used:

• For a Workstation (SCADA Server), use names such as COM1 and COM2 (valid range is
COM1 to COMn.
• For the ELC platform, the serial port name is /tyCo/1.
• For the Controller, the addressable serial ports are /serial/0 through /serial/5. Note that
serial ports /serial/4 and /serial/5 support hardware flow control.

PRO_007 61
What are ports?

Each port must have a unique name. A primary port cannot have the same name as a
backup port (this applies to both serial and Ethernet ports). Therefore, you must configure
two separate port names when using redundant ports.

Note
Refer to the individual protocol sections for information on adding a new port.

The following sections discuss the configuration needed for Ethernet ports or serial ports.
Configuration for ports is not dependent on protocol type.

3.3.1 To configure an RS 232 Serial Port window

Note
The following procedure assumes that an RS-232 Serial Port was selected from the Add
Items window. [31] Procedures for adding ports are discussed in each individual protocol
section.

1. Access the Protocol Configuration Tool [16].

2. Add an RS-232 Serial Port from the Add Items window.
3. Click the RS-232 Serial port icon from the hierarchy in the left pane.
4. The RS-232 Serial Port General Configuration window appears. Enter configuration
information in the Name, Description, and Port Status fields.

Figure 42. RS-232 Serial Port General Configuration window

5. Enter the Serial Port Settings information.

62 PRO_007
 What are ports?

6. Enter the Communication Configuration information.

The following table describes fields in the RS-232 Serial Port General Configuration
window.

Table 14. RS-232 Serial Port window field descriptions

Field Description
General Configuration
Type Identifies the type of port. This field is determined when you select the
port type in the Add Items window.
Name Displays a unique name to identify the port.
Description Describe the port. This field is optional.
Port Status Identifies the node or packed point record in the Port Status field.
See What are status points? [76] This point is used to provide status
information related to this port.
Partner Port Status Shows the status of the partner module port when configured for Dual
redundancy mode.
Serial Port Settings
Baud Rate Indicates the number of bits transferred per second.
Flow Control Allows you to adjust the speed of the data transfer.
Data Bits Indicates the number of data bits to transfer. Data is transferred in bits
of 5, 6, 7, or 8.
Stop Bits Indicates the stop bits sent at the end of every character, which allows
the receiving signal hardware to detect the end of a character and to
resynchronize with the character stream.
Parity Used for error checking.
Communication Configuration
Intermessage Delay Intermessage Delay is the configuration time (in milliseconds) for the
(ms) Client (controlling) to wait after the Server (controlled) responds before
sending the next data request. This parameter is meant for the RTU level
in the configuration.

Note
The intermessage delay value should not be higher than the RTU time-
out time.

7. Click Apply after you have made your selections or changes.

PRO_007 63
What are ports?

The following table describes the ELC module serial wiring details, with the port name
as /tyCo/1.

Table 15. ELC module serial wiring descriptions

Row, Pin No. Signal Name

B4 (receiver) RX (CROSS CONNECT RX)
C4 (transmitter) TX (CROSS CONNECT TX0
B5 (ground) GND (CROSS CONNECT GND)

3.3.2 To configure a DIGI Terminal Server Port window

Note
The following procedure assumes that a DIGI Terminal Server Port is selected from the Add
Items window [31]. Procedures for adding ports are discussed in each individual protocol
section.

1. Access the Protocol Configuration Tool [16].

2. Add a DIGI Terminal Server port from the Add Items window.
3. Click the DIGI Terminal Server Port icon from the hierarchy in the left pane.
4. The DIGI Terminal Server Port General Configuration window appears. Enter
configuration information in the Name, Description, and Port Status fields.

Figure 43. Protocol Configuration Tool - DIGI Terminal Server Port General
Configuration

64 PRO_007
 What are ports?

5. Enter the Terminal Server Configuration information.

6. Enter the Partner Terminal Server Configuration information.
7. Enter the Serial Port Settings information.
8. Enter the Communication Configuration information.
9. Click Apply after you have made your selections or changes.

The following table describes the fields in the DIGI Terminal Server Port General
Configuration window.

Table 16. DIGI Terminal Server Port window field descriptions

Field Description
General Configuration
Type Identifies the type of port. This field is determined when you selected the
port type in the Add Items window.
Name Displays a unique name to identify the port.
Description Describe the port. This field is optional.
Port Status Identifies the node or packed point record in the Port Status field. See
What are status points? [76]. This point is used to provide status
information related to this port.
Partner Port Status Shows the status of the partner module port when configured for Dual
redundancy mode.
Primary Terminal Server Configuration
IP Address Indicates the Internet Protocol address of the device.
User Name Indicates the username that was used to configure the device.
Port Number Indicates the number of the port being configured.
Password Indicates the password for the username.
Partner Terminal Server Configuration
IP Address Indicates the Internet Protocol address of the backup device.
User Name Indicates the username that was used to configure the backup device.
Port Number Indicates the number of the backup port being configured.
Password Indicates the password for the backup username.
Serial Port Settings
Baud Rate Indicates the number of bits transferred per second.
Flow Control Allows you to adjust the speed of the data transfer.
Data Bits Indicates the number of data bits to transfer. Data is transferred in bits of
5, 6, 7, or 8.
Stop Bits Indicates the stop bits sent at the end of every character, which allows
the receiving signal hardware to detect the end of a character and to
resynchronize with the character stream.
Parity Used for error checking.
Communication Configuration

PRO_007 65
What are ports?

Field Description
Intermessage Delay Intermessage Delay is the configuration time (in milliseconds) for the
(ms) Client (controlling) to wait after the Server (controlled) responds before
sending the next data request. This parameter is meant for the RTU level in
the configuration.

Note
The intermessage delay value should not be higher than the RTU time-out
time.

3.3.3 To configure a Generic Terminal Server Port window

Note
The following procedure assumes that a Generic Terminal Server Port is selected from
the Add Items window. [31] Procedures for adding ports are discussed in each individual
protocol section.

1. Access the Protocol Configuration Tool [16].

2. Add a Generic Terminal Server Port from the Add Items window.
3. Click the Generic Terminal Server Port icon from the hierarchy in the left pane.
4. The Generic Terminal Server Port window appears. Enter configuration information in
the Name, Description, and Port Status fields.

Figure 44. Protocol Configuration Tool -- Generic Terminal Server Port General
Configuration window

5. Enter the Terminal Server Configuration information.

6. Enter the Serial Port Settings information.

66 PRO_007
 What are ports?

7. Enter the Communication Configuration information.

The following table describes the fields in the DIGI Terminal Server Port General
Configuration window.

Table 17. Generic Terminal Server Port window field descriptions

Field Description
General Configuration
Type Identifies the type of port. This field is determined when you selected
the port type in the Add Items window.
Name Displays a unique name to identify the port.
Description Describes the port. This field is optional.
Port Status Identifies the node or packed point record in the Port Status field. See
What are status points? [76]. This point is used to provide status
information related to this port.
Partner Port Status Shows the status of the partner module port when configured for Dual
redundancy mode.
Terminal Server Configuration
IP Address Indicates the Internet Protocol address of the device.
Port Number Indicates the number of the port being configured.
Partner Terminal Server Configuration
IP Address Indicates the Internet Protocol address of the device.
Port Number Indicates the number of the port being configured.
Serial Port Settings
Baud Rate Indicates the number of bits transferred per second.
Flow Control Allows you to adjust the speed of the data transfer.
Data Bits Indicates the number of data bits to transfer. Data is transferred in bits
of 5, 6, 7, or 8.
Stop Bits Indicates the stop bits sent at the end of every character allow the
receiving signal hardware to detect the end of a character and to
resynchronize with the character stream.
Parity Used for error checking.
Communication Configuration
Intermessage Delay Intermessage Delay is the configuration time (in milliseconds) for
(ms) the Client (controlling) to wait after the Server (controlled) responds
before sending the next data request. This parameter is meant for the
RTU level in the configuration.

Note
The intermessage delay value should not be higher than the RTU
time-out time.

8. Click Apply after you have made your selections or changes.

PRO_007 67
What are ports?

3.3.4 To configure a TCP Ethernet Port window

Note
The following procedures assume that a TCP Ethernet Port is selected from the Add Items
window. [31] Procedures for adding ports are discussed in each individual protocol section.

1. Access the Protocol Configuration Tool [16].

2. Add a TCP Ethernet Port from the Add Items window.
3. Select the TCP Ethernet Port icon from the hierarchy in the left pane.
4. The TCP Ethernet Port General Configuration window appears. Enter configuration
information in the Name, Description, and Port Status fields.

Figure 45. Protocol Configuration Tool - TCP Ethernet Port General Configuration
window

5. Click Apply after you have made your selections or changes.

The following table describes fields in the TCP Ethernet Port General Configuration window.

Table 18. TCP Ethernet Port window field descriptions

Field Description
General Configuration
Type Identifies the type of port. This field is determined when you select a port
from the Add Items window.
Name Displays a unique name to identify the port.
Description Describes the port. This field is optional.
Port Status Identifies the node or packed point record in the Port Status field. See What
are status points? [76] This point is used to provide status information
related to this port.
Partner Port Status Shows the status of the partner module port when configured for Dual
redundancy mode.
Communication Configuration

68 PRO_007
 What are ports?

Field Description
Intermessage Delay Intermessage Delay is the configuration time (in milliseconds) for the Client
(ms) (controlling) to wait after the Server (controlled) responds before sending
the next data request. This parameter is meant for the RTU level in the
configuration.

Note
The intermessage delay value should not be higher than the RTU time-out
time.

3.3.5 To configure a UDP Ethernet Port window

Note
The following procedures assume that a UDP Ethernet Port is selected from the Add Items
window. [31] Procedures for adding ports are discussed in each individual protocol manual.

1. Access the Protocol Configuration Tool [16].

2. Add a UDP Ethernet Port from the Add Items window.
3. Select the UDP Ethernet Port icon from the hierarchy in the left pane.
4. The UDP Ethernet Port General Configuration window appears. Enter configuration
information in the Name, Description, and Port Status fields.

Figure 46. Protocol Configuration Tool - UDP Ethernet Port General Configuration
window

5. Click Apply after you have made your selections or changes.

The following table describes fields in the UDP Ethernet Port General Configuration window.

Table 19. UDP Ethernet Port window field descriptions

Field Description
General Configuration
Type Identifies the type of port. This field is determined when you select a port
from the Add Items window.
Name Displays a unique name to identify the port.
Description Describes the port. This field is optional.

PRO_007 69
What is a communication line?

Field Description
Port Status Identifies the node or packed point record in the Port Status field. See What
are status points? [76] This point is used to provide status information
related to this port.
Partner Port Status Shows the status of the partner module port when configured for Dual
redundancy mode.
Communication Configuration
Intermessage Delay Defines the configuration time (in milliseconds) for the Client (controlling)
(ms) to wait after the Server (controlled) responds before sending the next data
request. This parameter is meant for the RTU level in the configuration.

Note
The intermessage delay value should not be higher than the RTU time-out
time.

3.4 What is a communication line?

Lines are the communications paths from the port to the RTU.

A communications line has a primary port and an optional backup port. Each line must
have a unique name. A name can be either the name of a node or packed point (see status
points [76]), or it can be a label. A label is any word that begins with a “$.”

A line can have more than one RTU. The software does not define a limit to the number of
RTUs per line; however, practical limitations for your system should be considered.

Note
The procedures for adding and configuring a line are discussed in the individual protocol
manuals.

3.4.1 Configuring the Partner Configuration tab for a

communication line
The Partner Configuration tab appears only when the Redundancy Mode is configured as
Dual in the Configuration tab window.

70 PRO_007
 What is an RTU device?

Refer to the following table for information on the window fields.

Table 20. Server Configuration - Partner Configuration tab window descriptions

Item Description
General Configuration
Partner By default, the Partner field has a label. Notice that the label begins with the "$"
character, which distinguishes a label from a point name. This label is used as the
descriptive text for the hierarchy tree.

OR

Click the Partner field, and click Point Selector (...). The PointSelector window
appears. Select a node or a packed point name, that originated on the module.
Select a node or a packed point name, that originated on the module, to use as
the RTU name. You can also type the point name in the Partner field. See What are
status points? [76] for more information.
Description Enter a description for the line using up to 60 characters. This field is optional.
Port Control
Partner Point Enter the name of a digital point that is used to control the use of redundant
Name ports. This port control point can be used to control which port is used when the
redundant ports are configured.

3.5 What is an RTU device?

RTU (Remote Terminal Unit) is the term used to describe the remote device in the field.

Each RTU uses a defined communication protocol such as Modbus, DNP, and so forth. The
message structure and protocol used to communicate with the RTU depends on the RTU
type. Each protocol uses a defined set of rules and message structures. This is accomplished
with scanblocks and scan points.

Each RTU must have a unique name. A name can be either the name of a node or packed
point (see status points [76]), or it can be a label. A label is any word that begins with a “$.”

RTUs can have one or more scanblocks. The software does not define a limit to the number
of scanblocks per RTU.

Note
The procedures for adding and configuring an RTU are discussed in the individual protocol
manuals.

3.5.1 RTU Configuration tabs

The RTU configuration window has the following tabs:

• Configuration -- displays the configuration parameters for the RTU based on the
protocol type that was selected.
• Statistic Points -- displays analog points that track data flow. They are designed to
give information on communications with the RTU. The parameters that appear in this
window are the same for all RTUs regardless of the protocol that is selected.

PRO_007 71
What is an RTU device?

• Partner Configuration -- displays the configuration parameters for the partner module
when the dual-mode redundancy is configured.
• Partner Statistics Points -- displays the statistics parameters for the partner module
when the dual-mode redundancy is configured.

3.5.2 Configuring the Statistic Points tab for RTUs

The Statistic Points tab displays analog points that track data flow. They are designed to
give information on communications with the RTU. The parameters that appear in this
window are the same for all RTUs regardless of the protocol that is selected.

Figure 47. Statistic Points tab window

72 PRO_007
 What is an RTU device?

Refer to the following table for information on the Statistics Points window fields.

Table 21. Statistic Points tab window field descriptions for RTUs

Field Description Setting

Communications Statistics Points
Points Out Number of points sent per minute. You can type a point name
in the entry field or click
Points In Number of points received per minute.
on the entry field to access
Packets Out Number of message packets sent per minute. the Point Selector button. The
PointSelector window displays.
Packets In Number of message packets received per You must select an analog point
minute. that originated on the module.
Bytes Out Number of bytes sent per minute.
Bytes In Number of bytes received per minute.
Communications Error Points
Missed Scans Count of missed scans. You can type a point name
in the entry field or click
No Response Count of response timeout messages.
on the entry field to access
CRC Errors Count of corrupt messages. the Point Selector button. The
PointSelector window displays.
Good Scans Count of completed scans. Resets after 9999. You must select an analog point
that originated on the module.
Statistics Configuration
Statistics Determines the frequency (in milliseconds) the 52 – 65535 msec
Rate (msec) module updates the statistic points defined on
this window. The default value is 10000.

3.5.3 Configuring the Partner Configuration tab for RTUs

The Partner Configuration tab displays the configuration parameters for the partner RTU
when Dual redundancy mode is configured.

Figure 48. Partner Configuration tab window

PRO_007 73
What is an RTU device?

Refer to the following table for information on the Partner Configuration window fields.

Table 22. RTU Configuration - Partner Configuration tab window field descriptions

Item Description
General Configuration
Partner By default, the Partner field has a label. Notice that the label begins with the "$"
character, which distinguishes a label from a point name. This label is used as the
descriptive text for the hierarchy tree.

OR

Click the Partner field, and click Point Selector (...). The PointSelector window
appears. Select a node or a packed point name, that originated on the module.
Select a node or a packed point name, that originated on the module, to use as
the RTU name. You can also type the point name in the Partner field. See What are
status points? [76] for more information.
Description Enter a description for the RTU using up to 60 characters. This field is optional.
Redundancy Configuration
RTU Control Enter the point that allows you to control which RTU is in control in the dual
Point redundancy mode.
Inactive Select the action that is performed by an inactive RTU in a dual redundancy mode
Processing configuration. The valid options are:

• None: no communication.
• Communication Test: performs the basic communication tests to verify that
the end device can be reached.
• Polling: performs the polling functions (read) but no outputs (writes).
• Full Capabilities: performs full functions, same as the primary module.

74 PRO_007
 What is an RTU device?

3.5.4 Configuring Partner Statistics Points tab for RTUs

The Partner Statistic Points tab displays the statistics parameters for the partner module
when the dual-mode redundancy is configured.

Figure 49. Partner Statistic Points tab window

Refer to the following table for information on the Partner Statistics Points window fields.

Table 23. RTU Configuration - Partner Statistic Points tab window field descriptions

Field Setting Description

Communications Statistics Points
Packets Out You can type a point name in the entry field or click on Number of message
the entry field to access the Point Selector button. The packets sent per
PointSelector window displays. You must select an analog minute.
point that is the originated module.
Packets In Number of message
packets received per
minute.
Bytes Out Number of bytes
sent per minute.
Bytes In Number of bytes
received per minute.
Points Out Number of points
sent per minute.
Points In Number of points
received per minute.
Communications Error Points

PRO_007 75
What are scanblocks?

Field Setting Description

Missed You can type a point name in the entry field or click on Count of missed
Scans the entry field to access the Point Selector button. The scans.
PointSelector window displays. You must select an analog
No Response Count of response
point that originated on the module.
timeout messages.
CRC Errors Count of corrupt
messages.
Good Scans Count of successfully
completed scans.

3.6 What are scanblocks?

A scanblock defines the operation (read, write, and so forth) and the scanning frequency
of the RTU. The communications between each RTU and the module are determined by
scanblocks.

The interval time (set on the Scanblock Configuration window) defines the time between
scans for a periodic scanblock. The fast scan interval and count define the fast scan mode
operation for the scanblock. Fast scan mode is the temporary, alternate scanning frequency
for a scanblock. An RTU goes to fast scan mode at initialization and after a user request. The
scanblock returns to normal scan mode after the fast scan count is complete. A fast scan
count of zero disables fast scan mode.

Each scanblock must have a unique name. A name can be either the name of a node or
packed point (see status points [76]), or it can be a label. A label is any word that begins
with a “$.” Scanblock configuration is specific to each protocol.

Note
The procedures for adding and configuring a scanblock are discussed in the individual
protocol manuals.

3.7 What are status points?

Status points are Ovation node (RN) or packed (LP/DP) points that provide diagnostic
information for a port, line, RTU, or scanblock object. The status point is associated with the
object by entering the status point name in the object’s Status Point or Name entry field
during configuration.

Note
Status points are used as control points when using the SCADA_CMD (226) application
program.

The status point name can be entered by manually typing it into the applicable entry field.
You can also click in the entry field and a button with three dots (ellipsis) displays. Click
on the button to display the Point Selector window that shows the Ovation points for the
selected drop. Select the desired status point from the list.

76 PRO_007
 What are scan points?

Using status points is optional but a recommended practice since status points can provide
information about the state of its associated object. For example, the status point that is
used for an RTU can be used in a graphic in the SCADA_CMD (226) application program.
The control point defined in the application program must be the same point that is defined
as the status point for the RTU. In this way, the RTU can be controlled or monitored from
a graphic that uses the SCADA_CMD (226) application program since the control point
identifies the RTU being controlled by the status point that was defined for it.

For lines, RTUs, and scanblocks, the status point name appears in the Protocol
Configuration Tool system tree hierarchy (the name that appears in the hierarchy is referred
to as the object name). If a status point is not defined, the configuration tool provides a
unique default label for the line, RTU, or scanblock to use as the object name. Label names
begin with the "$" character.

For information on bit definitions for status points, refer to the Ethernet Link Controller User
Guide or the SCADA Server User Guide.

3.8 What are scan points?

Scan points are defined when configuring scanblocks in the Protocol Configuration Tool.
Scan points are used to map the address and data type of the RTU register (protocol data)
to Ovation points. Configuration for scan points varies depending on the scanblock and
protocol that was chosen.

Note
The procedures for configuring scan points are discussed in the individual protocol manuals.

In addition, scan points can be simulated. Simulated scan points can be used in place
of Ovation process points and are used for testing and exchanging data between
communication lines.

3.8.1 General Scan Point window configuration guidelines

The configuration information for scan points varies according to the protocol you are using
and the type of scanblock that you selected for that protocol. Scan point configuration
windows are always accessed by a tab on the particular Scanblock configuration window.

The following sections provide general guidelines for using the Scan Points window. Specific
information on the window fields is found in each protocol section.

• Scan Points icon descriptions [78].

• Scan Points window examples [78].

PRO_007 77
What are scan points?

3.8.2 General Scan Points icon descriptions

The Scan Points window displays icons indicating operator functions. Refer to the following
window for icon examples.

Figure 50. Scan Points window showing possible icons

Table 24. Scan Points tab icon descriptions

Icon Description
Scan Points
Indicates the current row selection.

Numbers the row in the grid.

Indicates a new row.

Indicates editing mode.

Indicates a new row and current row selection.

Indicates an error or missing information.

Opens the Point Selector window [42].

3.8.3 General Scan Points window examples

The Scan Points window options change with each type of protocol and with each type of
scanblock. The illustrations below show samples of Modbus and DNP Scan Points windows.

78 PRO_007
 What are simulated points?

Figure 51. Scan Points window example 1

Figure 52. Scan Points window example 2

Figure 53. Scan Points window example 3

3.9 What are simulated points?

Simulated points are typically used in place of Ovation process points for testing purposes
and for exchanging data between communication lines. The point value and status are
written to the shared memory created by the Ethernet Link Controller Manager.

Simulated point names begin with the “$” character to distinguish them from Ovation
points. These points are read and written by the Server only and are not broadcast onto the
network. The following types of simulated scan points are available for use:

• Simulated Analog
• Simulated Digital
• Simulated Packed
• Constants

PRO_007 79
What are simulated points?

• Timestamps
• Placeholder

3.9.1 Simulated Analog, Digital, and Packed points

Simulated analog, digital, and packed points are used to exchange data between
communication lines. The following is an example:

A communication line gathers register data from the Server RTUs and writes this data to
simulated points.

These simulated points are then mapped to holding registers on the server communication
line. The values in the simulated points are then available to another remote client.

Examples of simulated points are as follows:

• $SIM_LA_O
• $SIM_LD_55
• $SIM_LP_2

Where:

• $SIM = the designation for a simulated point

• LA, LD, LP = record type
• 0, 55, 2 = the number of the point

3.9.2 Constant simulated points

Constant simulated points allow you to define a value (integer or real number) in a point.
For example, the constant point, $CONSTANT_5, defines the value of “5” for that simulated
point.

3.9.3 Timestamp simulated points

Timestamp simulated points are used for testing and to synchronize the time of an RTU. The
value of a timestamp point is generated from the current time of the drop. The format for
timestamps is defined below:

• $TIME_HOUR = where HOUR is 0 - 23 hours local time.

• $TIME_MIN = where MIN is 0 - 59 minutes local time.
• $TIME_SEC = where SEC is 0 - 59 seconds local time.
• $TIME_MDAY = where MDAY is 1 - 31 day of the month.
• $TIME_MON = where MON is 0 - 11 month of the year.
• $TIME_YEAR (year).
• $TIME_YDAY = where YDAY is 1 - 365 day of the year.
• $TIME_UTC = where UTC is Universal Time, also known as GMT or Greenwich Mean
Time).

3.9.4 Placeholder simulated points

As the name implies, placeholder simulated points can take the place of Ovation points.
They are used to fill in gaps in request messages where necessary.

80 PRO_007
 What are simulated points?

For example, if you define point A100 to map to holding register 40003 and another point
A101 to map to holding register 40005, a placeholder would be used ($PLACEHOLDER) to
map to holding register 40004.

In this way, there would be no “gaps” in the mapping sequence and a single write request
could be used instead of two.

PRO_007 81
 What is the Protocol Analyzer Tool?

4 Understanding the Protocol Analyzer

Tool
Topics covered in this section:
• What is the Protocol Analyzer Tool? [83]
• What is the role of the Protocol Analyzer Tool? [83]
• Accessing the Protocol Analyzer Tool [83]
• Menu options for the Protocol Analyzer window [84]
• Toolbar options for the Protocol Analyzer window [87]

4.1 What is the Protocol Analyzer Tool?

The Protocol Analyzer Tool is a graphical user interface that displays protocol data
transferred between the communication platform and the RTUs. It allows you to monitor
the operation of a selected line, RTU, scanblock, or point and to filter the type of data you
wish to receive.

4.2 What is the role of the Protocol Analyzer Tool?

The Protocol Analyzer Tool monitors the operation of the Ethernet Link Controller, Ovation
Compact Controller, Ovation Controller (OCR3000), Ovation Micro Controller (OMC100),
Standalone Controller, and the SCADA Server. You can monitor communication with remote
devices using the Protocol Analyzer. Using this interface, you can enable or disable logging,
clear the display, write the output to a file, and select message filtering.

The Protocol Analyzer Tool is typically used on an Ovation engineering workstation and
accessed from the Windows menu. You can also run the Protocol Analyzer Tool on a non-
Ovation computer such as a laptop since it does not use standard Ovation library routines.
The Protocol Analyzer Tool and the platform device must have network connectivity
between them.

4.3 Accessing the Protocol Analyzer Tool

The Protocol Analyzer Tool allows you to monitor the operation of a selected line or RTU and
to filter the type of data you wish to receive for the Ethernet Link Controller, OCC, OCR3000,
OMC100, Standalone Controller, and the SCADA Server.

4.3.1 To access the Protocol Analyzer Tool for SCADA and CPS
systems
From the Windows Start menu, select SCADA Protocol Analyzer or CPS Protocol Analyzer.

PRO_007 83
Menu options for the Protocol Analyzer window

The Protocol Analyzer Tool window appears.

Figure 54. Protocol Analyzer Tool window

The Protocol Analyzer Tool window is comprised of two panes. The left pane displays the
configuration hierarchy of the platform that is being monitored. The right pane displays the
messages of the particular line or RTU selected.

4.4 Menu options for the Protocol Analyzer window

The following table describes the Protocol Analyzer Tool window menu options.

Table 25. Protocol Analyzer Tool menu options

Menu Description
File
New Opens a new file.
Open Opens a previously saved file.
Save Saves the protocol data to a file.
Save As Saves the data to a specific file type.
Save Configuration Saves the configuration that was running at the time the protocol analyzer
capture was performed.
Export Allows the protocol analyzer data to be exported to a file format that can be
read by Wireshark, which is an open-source protocol analysis application.

Note
Wireshark is an open-source, freely available network analysis tool. It is not
provided as a part of the Communication Protocol Software.

84 PRO_007
 Menu options for the Protocol Analyzer window

Menu Description
Page Setup Displays a print preview.
Print Sends the data to a printer.
Exit Quits the Protocol Analyzer Tool.
Edit
Go To Go To Row - Displays a Go To dialog box to define the message row number to
highlight.

Go To Top - This takes you to the top of the message list.

Go To Bottom - This takes you to the bottom of the message list.

Find The Find menu searches and locates objects in the tree. This applies to Server,
Port, Line, Gateway, RTU, Gateway RTU, and Scanblocks.

This does not find a point anywhere in the configuration.

Copy Copies data.
Select All Selects all data.
Bookmarks Marks in color the information that you want to find easily again.
View
Themes Light Theme - A light background with a contrasting dark foreground.

Dark Theme - A dark background with a contrasting light foreground.

Treeview The tree view uses a combination of indentation and icons to represent the
nested relationship between parent nodes and child nodes.
Hexview Displays a file as hexadecimal values.
View Options Opens the Options Dialog box.

Select the foreground and background colors for message types, such as
communication layers, debug, verbose, error, information, transmit, and
receive. Based on the message type, you can select the color and font of the
data that you want to display in the protocol analyzer tool window.
Server
Connect Retrieves configuration information from the Server it is monitoring.
Disconnect Stops retrieving information from the server it is monitoring.
Start Monitoring Begin monitoring the module in control.
Stop Monitoring Stop monitoring the monitor in control.
Pause Scrolling Freezes message scrolling.
Clear Log Clears all protocol data.
Control Window Opens the Control Window.
Capture Options Opens the Capture Options dialog box.

Select the filters, file options, and stop options for the data.
Help Displays contents of the help file.
About Displays the Protocol Analyzer version.

PRO_007 85
Menu options for the Protocol Analyzer window

The protocol analyzer tool window also has a status bar at the bottom. The following table
describes the information that is displayed in the status bar.

Table 26. Information displayed in the status bar

Information Description
File Options Displays the save-to-file options.
Stop Options Displays the stop collection options.
Collection Filter Shows the first letter of the selected collection filter option.
Display Filter Shows the first letter of the selected display filter option.
Line Count Displays the number of lines that have been collected in the analyzer in the
current session.
Connection Status Displays an icon that indicates whether the analyzer is connected or not. A gray
icon indicates that it is not connected. A green icon indicates it is connected.

86 PRO_007
 Toolbar options for the Protocol Analyzer window

4.5 Toolbar options for the Protocol Analyzer window

The toolbar icons in the Protocol Analyzer window provide a shortcut to the menu options.
When you hover the mouse cursor over the toolbar icon, a tooltip appears describing the
icon.

4.5.1 Toolbar icons in the Protocol Analyzer window

The toolbar icons are displayed below.

Figure 55. Toolbar icons

The icons are defined from left to right in the following table.

Table 27. Left panel icons

Icon Description
New Opens a new file.
Open Opens a previously saved file.
Connect Retrieves configuration information from the Server it is monitoring.
Save Saves the protocol data to a file.
Save As Saves the protocol data to a file.
Save Configuration Saves the configuration that was running at the time the protocol analyzer
capture was performed.
Export Allows the protocol analyzer data to be exported to a file format that can be
read by Wireshark, an open-source protocol analysis application.

Note
Wireshark is an open-source, freely available network analysis tool. It is not
provided as a part of the Communication Protocol Software.

Connect Retrieves configuration information from the Server it is monitoring.

Disconnect Stops retrieving information from the server it is monitoring.
Start Monitoring Begin monitoring the module in control.
Stop Monitoring Stop monitoring the monitor in control.
Pause Scrolling Freezes message scrolling.
Clear log Clears all protocol data.
Control Window Opens the Control Window.
Capture Options Opens the Capture Options dialog box. Select the filters, file options, and
stop options for the data.
Help Displays contents of the help file.
Add/Remove Buttons Customizes the buttons shown in the toolbar.

PRO_007 87
 Overview of using the Protocol Analyzer tool

5 Using the Protocol Analyzer Tool

Topics covered in this section:
• Overview of using the Protocol Analyzer tool [89]
• Control - Server [94]
• Control - Line [95]
• Control - RTU [98]

5.1 Overview of using the Protocol Analyzer tool

The Protocol Analyzer tool is used for the following Ovation platforms: ELC, OCC, OCR3000,
OMC100, Standalone Controller, and SCADA. Select the topic that applies to your platform:

• To use the Protocol Analyzer Tool for the ELC, OCC, OCR3000, Standalone Controller,
and OMC100 platforms [89].
• To use the Protocol Analyzer Tool for the SCADA platform. [90]

5.1.1 To use the Protocol Analyzer Tool for the ELC, OCC,
OCR3000, Standalone Controller, and OMC100 platforms
1. Access the Protocol Analyzer Tool [83].
2. Pull down the File menu and select Connect.
The Connect dialog box appears.

Figure 56. Connect dialog box

3. Enter the hostname or IP address of the Controller you wish to monitor (for example,
enter drop42 or its IP address, for example, 555.55.555.5). The Server is defined in the
Configuration Tool and is based on the Ovation platform. Click OK.

Note
The Protocol Analyzer Tool can either connect to the Controller or the Ethernet Link
Controller (ELC) module. If you connect to the Controller, the ELCs that are in that
Controller are shown. If you connect to the Controller, right-click the ELC node and
select Connect to connect to that module.

PRO_007 89
Overview of using the Protocol Analyzer tool

4. The Protocol Analyzer Tool queries the Controller for the current configuration. The
configuration hierarchy for the defined platform appears on the left side of the
window.

Note
When a change is made to the platform configuration and downloaded to the drop,
you must reconnect to the Server to get the new configuration in the Protocol Analyzer
Tool.

5.1.2 To use the Protocol Analyzer Tool for the SCADA platform
1. Access the Protocol Analyzer.
2. Click the File menu and select Connect.
The Connect dialog box appears.

Figure 57. Connect dialog box

3. Enter the hostname or IP address of the SCADA Server drop you wish to monitor (for
example, enter drop42 or 555.55.555.5). Select the OK button.
4. The Protocol Analyzer queries the SCADA Server for the current configuration. The
configuration hierarchy for the SCADA Server (as defined in the Configuration Tool)
appears on the left side of the window.

Note
When a change is made to the SCADA configuration and downloaded to the drop,
you must reconnect to the SCADA Server to get the new configuration in the Protocol
Analyzer.

5.1.3 Protocol Analyzer right-click menu options

The following figure shows the right-click options for the Protocol Analyzer tool filters:

90 PRO_007
 Overview of using the Protocol Analyzer tool

Figure 58. Protocol Analyzer filter right-click options

PRO_007 91
Overview of using the Protocol Analyzer tool

Table 28. Protocol Analyzer filter right-click options

Filter Right-click Description

options options
Server Expand/Collapse Expands or closes the tree hierarchy under the Server node.
Select/Unselect Monitors or does not monitor the selected Server.
Select/Unselect Monitors or does not monitor the selected Server(s).
children
Control Allows some SCADA commands to be sent directly from the
Protocol Analyzer to the Server rather than building a process
diagram. For more details, see Control Server [94].
Line Expand/Collapse Expands or closes the tree hierarchy under the line node.
Select/Unselect Monitors or does not monitor the selected line.
Select/Unselect Monitors or does not monitor the selected line(s).
Children
Control Allows some SCADA commands to be sent directly from the
Protocol Analyzer to the Line rather than building a process
diagram. For more details, see Control Line [95].
RTU Expand/Collapse Expands or closes the tree hierarchy under the RTU node.
Select/Unselect Monitors or does not monitor the selected RTU.
Select/Unselect Monitors or does not monitor the selected RTU(s).
Children
Control Allows some SCADA commands to be sent directly from the
Protocol Analyzer to the RTU rather than building a process
diagram. For more details, see Control RTU [98].
Scan block Expand/Collapse Expands or closes the tree hierarchy under the scanblock node.
Select/Unselect Monitors or does not monitor the selected scanblock(s).
Select/Unselect Monitors or does not monitor the selected scanblock(s).
Children
Control Allows some SCADA commands to be sent directly from the
Protocol Analyzer to the RTU rather than building a process
diagram. For more details, see Control RTU [98].
Item Expand/Collapse Expands or closes the tree hierarchy under the item node.
Select/Unselect Monitors the selected point(s).
Control Allows some SCADA commands to be sent directly from the
Protocol Analyzer to the RTU rather than building a process
diagram. For more details, see Control RTU [98].

92 PRO_007
 Overview of using the Protocol Analyzer tool

5.1.4 Additional features of the Protocol Analyzer

The Protocol Analyzer tool provides the following additional features:

• Use the toolbar icons to change the ports to monitor or the messages to filter. You may
have more than one filter item selected at a time. For example, you may receive data
messages and error messages at the same time.

Note
The maximum file size is 10 megabytes. When the log file is full, a message appears.

• To freeze the message scrolling, click the Suspend Scrolling icon. Select the Suspend
Scrolling icon again to resume communications.
• To clear all messages from the window, select the Clear Log icon.
• For redundant modules (Ethernet Link Controllers, Controllers, or SCADA Servers), the
Protocol Analyzer monitors communications for the module that is in control. The
drop name that appears at the top of the Protocol Analyzer window is the drop being
monitored. If the primary module goes offline, select the Start Monitor option again,
and the Protocol Analyzer monitors the module that is now in control.
• To save the messages to a file, pull down the File menu and click Save. Select a
directory, file name, and file type, and then click Save.
• To go to a specific message row, pull down the Edit menu and select Go To.
• Select View -> Hexview to display the hexadecimal values for the message.
• The Find menu searches and locates objects in the tree. This applies to Server, Port,
Line, Gateway, RTU, Gateway RTU, and Scanblocks.

PRO_007 93
Control - Server

5.2 Control - Server

If you select the Control option from the right-click options, only the server commands are
displayed as shown:

Figure 59. Control Server commands

Table 29. Control Server commands

Command Description
Server Identifies the name of the server.
Mode Identifies the type of server.
Primary Drop Shows the primary drop.
Primary Status Shows the status of the primary drop.
Partner Drop Shows the partner drop.
Partner Status Shows the status of the partner drop.
Memory Utilization
Duty Cycle Determines how much of the CPU is being utilized.

94 PRO_007
 Control - Line

Command Description
Free Memory Determines the amount of available memory on the module card.
Used Memory Determines the amount of used memory on the module card
Communication Statistics
Bytes In Shows the number of bytes received per minute.
Bytes Out Shows the number of bytes sent per minute.
Packets In Shows the number of message packets received per minute.
Packets Out Shows the number of message packets sent per minute.
Points In Shows the number of points received per minute.
Points Out Shows the number of points sent per minute.
Fail Drop Fails the drop to its partner, as long as the partner is in good health.
Fail Lines Commands the Server to stop scanning all the RTUs on all lines and set the points to
bad quality. This command does not physically affect the devices (it does not stop
the devices from running).
Restore Lines Commands the Server to begin scanning all RTUs on all Lines.

Note
Executing this command causes the scan blocks of all RTUs to go to fast scan mode.

5.3 Control - Line

If you select the Control option from the right-click options on the line, only the server and
line commands are displayed as shown:

PRO_007 95
Control - Line

Figure 60. Control Line commands

Table 30. Control Line commands

Command Description
Line Identifies the name of the line.
Primary Port
Identifies the name of the Primary Port.
Primary Status Identifies the node or packed point record. This point is used to provide status
information related to this line.
Fail Commands the Server to stop scanning all the RTUs on all lines and set the points to
bad quality. This command does not physically affect the devices (that is, it does not
stop the devices from running).
Restore Commands the Server to begin scanning all RTUs on all lines.

Note
Executing this command causes the scan blocks of all RTUs to go to fast scan mode.

96 PRO_007
 Control - Line

Command Description
Warm Restart Allows a warm restart command to be sent from a graphic (for a line).

When an update has been made to the configuration file, the Load command,
initiated from the Developer Studio, not only loads the new file to the drop but also
issues a warm restart command informing the drop to use the updated file.

A Warm Restart does not shut down the Server protocol drivers. The new file is
incorporated while the drivers are running.

This command applies to all the RTUs on the line defined by the control point.
Cold Restart This command is similar to a warm restart of the line; however, a cold restart shuts
down the Server protocol drivers. It incorporates any file changes the same way as
when it first starts up.

PRO_007 97
Control - RTU

5.4 Control - RTU

Note
Gateways only apply to Modbus, ACEIPGW, and LoggerNet protocols.

If the Control RTU option is selected and a gateway is not connected with that RTU, the
server, line, and RTU commands are displayed as shown:

Figure 61. Control RTU commands when a gateway is not connected with RTU

Table 31. Control RTU Commands

Object Command
RTU Identifies the name of the RTU.
Status Identifies the status of the RTU.
Primary
Drop Shows the name of the primary drop.

98 PRO_007
 Control - RTU

Object Command
Status Shows the status of the primary drop.
Communication Counters
Missed Scans Shows the count of missed scans.
Timeouts Shows the count of communication timeouts.
Errors Shows the count of communication errors.
Good Scans Shows the count of successfully completed scans.
Communication Statistics
Bytes In Shows the number of bytes received per minute.
Bytes Out Shows the number of bytes sent per minute.
Packets In Shows the number of message packets received per minute.
Packets Out Shows the number of message packets sent per minute.
Points In Shows the number of points received per minute.
Points Out Shows the number of points sent per minute.
Fail Commands the Server to discontinue communications with the backup port and its
associated line.
Restore Commands the Server to begin communications again with the backup port and its
associated line.
Fast Scan Shows the scanning frequency for a Gateway.
Force Scan Force the RTU to perform a scan immediately.
Reset Stats Reset all communication statistics.

PRO_007 99
 Overview of configuring the Modbus Client protocol

6 Modbus Client configuration

Topics covered in this section:
• Overview of configuring the Modbus Client protocol [101]
• Modbus Client Scanblock Types [119]

6.1 Overview of configuring the Modbus Client

protocol
This section assumes you have already defined and configured the Server in the Protocol
Configuration Tool.

The following procedures start with adding a port to the server and continue with adding a
line, RTU, and scanblocks. All of the procedures discuss how the parameters should be set
for the Modbus Client protocol.

6.1.1 To add a port to the server for the Modbus Client

protocol
1. Access the Protocol Configuration Tool [16].
2. Right-click the Server item from the left panel on the Protocol Configuration Tool
window and choose Add.

Figure 62. Protocol Configuration Tool -- right-click Server

PRO_007 101
Overview of configuring the Modbus Client protocol

3. The Add Items window appears.

Figure 63. Add Items window -- add a port to the server

4. Select the type of Communication Port from the list and choose Add New. The port
choices are RS-232, Digi Terminal Server, Generic Terminal Server, TCP Ethernet, and
UDP Ethernet. Refer to one of the following topics for configuration information:
• To configure a RS-232 Serial Port window [62].
• To configure a DIGI Terminal Server Port window [64].
• To configure a Generic Terminal Server Port window [66].
• To configure a TCP Ethernet Port window [68].
• To configure a UDP Ethernet Port window [69].

Note
For information about deleting a port, see To delete an item from the Protocol
Configuration Tool [33].

6.1.2 To add a line to a server for the Modbus Client protocol

1. Access the Protocol Configuration Tool [16].

102 PRO_007
 Overview of configuring the Modbus Client protocol

2. Right-click the Server item from the left panel on the Protocol Configuration Tool
window and choose Add.
The Add Items window appears. Only configured protocols for this module appear in
this window.

Figure 64. Add Items window - add a line to a server (Modbus Client protocol)

PRO_007 103
Overview of configuring the Modbus Client protocol

3. Choose the Modbus Client Line and select Add New. The right side of the Protocol
Configuration Tool updates with configuration information for the new line.

Figure 65. Configuration information for Modbus Client line

104 PRO_007
 Overview of configuring the Modbus Client protocol

4. Enter the applicable information in the window entry fields according to the
descriptions in the following table.

Table 32. Configuration information for the new Modbus Client line

Field Description
General Configuration
Type Automatically filled with the appropriate Line type. In this example, it
is Modbus.
Name By default, the Name field has a label. Notice that the label begins
with the "$" character, which distinguishes a label from a point name.
This label is used as the descriptive text for the hierarchy tree.

OR

Click the Name field, and click Point Selector (...). The PointSelector
window appears. Select a node or a packed point name, originated
on the module, to use as the RTU name. You can also type the point
name in the Name field. See What are status points? [76] for more
information.
Description Enter a description for the line using up to 60 characters. This field is
optional.
Primary Communications
Port Select the primary communication port for this line.
Protocol Defines the protocol for the line. The options are Modbus RTU and
Modbus Open TCP.
Backup Communications
Port Select the backup communication port for this line.
Protocol Defines the protocol for the line. The options are Modbus RTU and
Modbus Open TCP.
Scheduler Configuration
Scheduler Type Select the type of the scheduler to scan the data. Valid options are:

• Period-Priority - sets the scan time based on a time interval

relative to the last scan (defined in the Scanblock configuration
window).
• Wall Clock - sets the scan time with an interval and the current
time of day (defined in the Scanblock configuration window).
Port Control
Point Name Only active when Port Redundancy Mode is set to 2-Way. Enter a
point name in the Port Control section of the window if you are using
redundant ports and need to control port failover from the control
logic.
Port Configuration
Port Redundancy Mode Select the type of port redundancy. The choices are:

• 2-Way - sets typical redundancy for primary and backup

connections.

PRO_007 105
Overview of configuring the Modbus Client protocol

Field Description
• 4-Way - defines two additional connections for redundancy. This
allows clients to connect to up to four servers. The two additional
connections are referenced by both the primary and backup
connections.
Failure Testing Configuration
Failed Line Testing The frequency at which a failed line is tested to re-establish
Period (sec) communication.
Failed RTU Testing The frequency at which a failed RTU is tested to re-establish
Period (sec) communication.
Backup 2 Communications
Port If 4-way redundancy is configured for the line, this is the IP port used
for the second backup communication for this line.
Protocol If 4-way redundancy is configured for the line, this is the protocol
used for the second backup communication for this line.
Backup 3 Communications
Port If 4-way redundancy is configured for the line, this is the IP port used
for the third backup communication for this line.
Protocol If 4-way redundancy is configured for the line, this is the protocol
used for the third backup communication for this line.

5. The Partner Configuration tab appears if you have configured the Redundancy Mode
as Dual in the Configuration tab window during Server configuration. Click the Partner
Configuration tab and enter all the applicable information. The information on the
Partner Configuration tab is the same for all lines.
6. After all of the information has been entered, select the Apply button to save this
configuration.

6.1.3 To add a Generic Modbus RTU to a line for the Modbus

Client protocol
1. Access the Protocol Configuration Tool [16].
2. Right-click the Line item from the left panel on the Protocol Configuration Tool window
and choose Add. The Add Items window appears.

106 PRO_007
 Overview of configuring the Modbus Client protocol

3. Choose Generic Modbus RTU and click Add New. The right side of the Protocol
Configuration Tool updates with configuration information for the new RTU.
Notice that for RTU configuration, there are two tabs on the window. The procedures
below discuss the Configuration tab. See Configuring Statistic Points tab for RTUs [72]
for information on the fields for status points.

Figure 66. RTU Configuration tab information for Generic Modbus RTU

PRO_007 107
Overview of configuring the Modbus Client protocol

4. Enter the applicable information in the window entry fields according to the
descriptions in the following table.

Table 33. RTU Configuration window field descriptions for the Modbus Client protocol

Item Description
Configuration
Name By default, the Name field has a label. Notice that the label begins with the
"$" character, which distinguishes a label from a point name. This label is
used as the descriptive text for the hierarchy tree.

OR

Click the Name field, and click Point Selector (...). The PointSelector
window appears. Select a node or a packed point name, originated on the
module, to use as the RTU name. You can also type the point name in the
Name field. See What are status points? [76] for more information.
Description Enter a description for the RTU using up to 60 characters. This field is
optional.
Communication Configuration
Timeout (ms) Defines the number of milliseconds that the module waits for a response
from the RTU before attempting a retry or setting the points to bad quality.
Retries Defines the number of times the module tries to send a message before
setting the points to bad quality and clearing the in-service bit (bit 0) of the
RTU status word.
Enable Daniel If selected, Daniel Floating points can be used in the Modbus protocol.
Floats These points transfer 32-bit data items by using a 32-bit register that is four
bytes long. Holding registers beyond 47000 are used for this, and software
drivers must be able to accommodate this special situation.
Enable Broadcast If selected, broadcasting will be enabled.
Critical Use this option if you have redundant modules configured. Select this
check box to designate an RTU as critical. If the primary module cannot
communicate to the RTU marked as critical, communication fails over to
the partner module so that it can communicate to the critical RTU. The
failure time between redundant modules is a multiple of the scan rate
when NIC port is lost.
Timeout (sec) Only active when the Critical check box is selected. This is the amount of
time after a communication failure to the RTU that the primary module
tries to re-establish communication before it fails over to the partner
module.
Monitor NIC Enables network connectivity from the module before each
communication. If the network link status is false, such as if the cable
is unplugged, communication is immediately switched to an alternate
communication port, rather than waiting for a network communication
timeout.

Note
The NIC is the network interface.

108 PRO_007
 Overview of configuring the Modbus Client protocol

Item Description
Monitor Alternate Enables monitoring of the state of the backup communication port. When
Interface this check box is selected, the module monitors the state of the backup
communication port after every 15 seconds.

Note
The 0x0100 bit (bit 8) is set in the RTU node record if the primary interface
is not operational. The 0x0200 bit (bit 9) is set if the secondary interface is
not operational.

Primary Interface
Node Node address of the primary RTU.
IP Addr IP address of the primary RTU.
Port IP port number of the primary RTU
Backup Interface -- grayed out if 2-Way redundancy is defined in the Line Configuration
window [102].
Node If 4-Way redundancy is configured for the line, this field indicates the node
address for the backup connection for the RTU. Note that this node number
could be the same as the node number for the primary RTU if only one RTU
is configured for that line.
IP Addr If 4-Way Redundancy is configured for the line, this field indicates the IP
address for the backup connection for the RTU. This field can also contain
the IP address of a second RTU or a different IP address for a single RTU.
Port If 4-Way Redundancy is configured for the line, this is the IP port for the
backup connection for the RTU. This field can also contain the IP port of a
second RTU or a different IP port for a single RTU.
Backup 2 Interface -- used for 2-Way and 4-Way redundancy in the Line Configuration window.
Node Node address of the backup RTU in a 2-Way redundancy configuration. For
a 4-Way redundancy configuration, this is the node address of the second
backup connection for the RTU.
IP Addr IP address of the backup RTU in a 2-Way redundancy setting. For a 4-Way
Redundancy setting, this is the IP address of the second backup connection
for the RTU.
Port IP port number of the backup RTU in a 2-Way redundancy setting. For a
4-Way Redundancy setting, this is the IP port number of the second backup
connection for the RTU.
Backup 3 Interface -- grayed out if 2-Way redundancy is defined in the Line Configuration
window.
Node If 4-Way redundancy is configured for the line, this field indicates the node
address for the third backup connection for the RTU.
IP Addr If 4-Way redundancy is configured for the line, this is the IP address for the
third backup connection for the RTU.
Port If 4-Way redundancy is configured for the line, this is the IP port for the
third backup connection for the RTU.

PRO_007 109
Overview of configuring the Modbus Client protocol

5. Click the Statistic Points tab and enter the applicable information. The information on
the Statistic Points tab is the same for all RTUs for all protocols.
6. The Partner Configuration and Partner Statistics Points tabs appear if you have
configured the Redundancy Mode as Dual in the Configuration tab window during
Server configuration. Click the Partner Configuration tab and enter all the applicable
information. Similarly, click the Partner Statistics Points tab and enter the applicable
information.
7. After all of the information has been entered, click Apply to save this configuration.

6.1.4 To add a Generic Modbus Gateway to a line for the

Modbus Client protocol
1. Access the Protocol Configuration Tool [16].
2. Right-click the Line item from the left panel on the Protocol Configuration Tool window
and choose Add. The Add Items window appears.
3. Choose Generic MODBUS Gateway and click Add New. The right side of the Protocol
Configuration Tool updates with configuration information for the new gateway.
Notice that for Gateway configuration, there are two tabs on the window. The
procedures below discuss the Configuration tab. See Configuring the Statistic Points
tab for RTUs [72] for information on the fields for status points.

Figure 67. Gateway Configuration tab information for Generic Modbus Gateway

110 PRO_007
 Overview of configuring the Modbus Client protocol

4. Enter the applicable information in the window entry fields according to the
descriptions in the following table.

Table 34. Gateway Configuration window field descriptions for the Modbus Client
protocol

Item Description
Configuration
Name By default, the Name field has a label. Notice that the label begins with the
"$" character, which distinguishes a label from a point name. This label is
used as the descriptive text for the hierarchy tree.

OR

Click the Name field, and click Point Selector (...). The PointSelector
window appears. Select a node or a packed point name, that originated
on the module, to use as the RTU name. You can also type the point name
in the Name field. See What are status points? [76] for more information.
Description Enter a description for the RTU using up to 60 characters. This field is
optional.
Communication Configuration
Timeout (ms) Defines the number of milliseconds that the module waits for a response
from the RTU before attempting a retry or setting the points to bad quality.
Retries Defines the number of times the module tries to send a message before
setting the points to bad quality and clearing the in-service bit (bit 0) of the
RTU status word.
Enable Daniel If selected, Daniel Floating points can be used in the Modbus protocol.
Floats These points transfer 32-bit data items by using a 32-bit register that is four
bytes long. Holding registers beyond 47000 are used for this, and software
drivers must be able to accommodate this special situation.
Critical Use this option if you have redundant modules configured. Select this
check box to designate an RTU as critical. If the primary module cannot
communicate to the RTU marked as critical, communication fails over to
the partner module so that it can communicate to the critical RTU. The
failure time between redundant modules is a multiple of the scan rate
when NIC port is lost.
Timeout (sec) Only active when the Critical check box is selected. This is the amount of
time after a communication failure to the RTU that the primary module
tries to re-establish communication before it fails over to the partner
module.
Monitor NIC Enables network connectivity from the module before each
communication. If the network link status is false, such as if the cable
is unplugged, communication is immediately switched to an alternate
communication port, rather than waiting for a network communication
timeout.

Note
The NIC is the network interface.

PRO_007 111
Overview of configuring the Modbus Client protocol

Item Description
Monitor Alternate Enables monitoring of the state of the backup communication port. When
Interface this check box is selected, the module monitors the state of the backup
communication port after every 15 seconds.

Note
The 0x0100 bit (bit 8) is set in the RTU node record if the primary interface
is not operational. The 0x0200 bit (bit 9) is set if the secondary interface is
not operational.

Primary Interface
Node Node address of the primary RTU.
IP Addr IP address of the primary RTU.
Port IP port number of the primary RTU
Backup Interface -- grayed out if 2-Way redundancy is defined in the Line Configuration
window [102].
Node If 4-Way redundancy is configured for the line, this field indicates the node
address for the backup connection for the RTU. Note that this node number
could be the same as the node number for the primary RTU if only one RTU
is configured for that line.
IP Addr If 4-Way Redundancy is configured for the line, this field indicates the IP
address for the backup connection for the RTU. This field can also contain
the IP address of a second RTU or a different IP address for a single RTU.
Port If 4-Way Redundancy is configured for the line, this is the IP port for the
backup connection for the RTU. This field can also contain the IP port of a
second RTU or a different IP port for a single RTU.
Backup 2 Interface -- used for 2-Way and 4-Way redundancy in the Line Configuration window.
Node Node address of the backup RTU in a 2-Way redundancy configuration. For
a 4-Way redundancy configuration, this is the node address of the second
backup connection for the RTU.
IP Addr IP address of the backup RTU in a 2-Way redundancy setting. For a 4-Way
Redundancy setting, this is the IP address of the second backup connection
for the RTU.
Port IP port number of the backup RTU in a 2-Way redundancy setting. For a
4-Way Redundancy setting, this is the IP port number of the second backup
connection for the RTU.
Backup 3 Interface -- grayed out if 2-Way redundancy is defined in the Line Configuration
window.
Node If 4-Way redundancy is configured for the line, this field indicates the node
address for the third backup connection for the RTU.
IP Addr If 4-Way redundancy is configured for the line, this is the IP address for the
third backup connection for the RTU.
Port If 4-Way redundancy is configured for the line, this is the IP port for the
third backup connection for the RTU.

5. Click the Statistic Points tab and enter the applicable information.

112 PRO_007
 Overview of configuring the Modbus Client protocol

6. The Partner Configuration and Partner Statistics Points tabs appear if you have
configured the Redundancy Mode as Dual in the Configuration tab window during
Server configuration. Click the Partner Configuration tab and enter all the applicable
information. Similarly, click the Partner Statistics Points tab and enter the applicable
information. The information on the Partner Configuration and Partner Statistics Points
tabs is the same for all RTUs.
7. After all of the information has been entered, click Apply to save this configuration.

6.1.5 To add a Generic Modbus Gateway RTU to a line for the

Modbus Client protocol
After you have added a Generic Modbus Gateway to a line for the Modbus Client protocol,
you can add the Generic MODBUS Gateway RTU to the gateway. To do so, perform the
following steps:

1. Access the Protocol Configuration Tool [16].

2. Right-click the Generic Modbus Gateway item, which you have added to the Client Line,
from the left panel on the Protocol Configuration Tool window and choose Add. The
Add Items window appears.
3. Choose Generic MODBUS Gateway RTU and click Add New. The right side of the
Protocol Configuration Tool updates with configuration information for the new RTU.
Notice that for RTU configuration, there are two tabs on the window. The procedures
below discuss the Configuration tab. See Configuring the Statistic Points tab for
RTUs [72] for information on the fields for status points.

Figure 68. RTU Configuration tab information for Generic Modbus Gateway RTU

PRO_007 113
Overview of configuring the Modbus Client protocol

4. Enter the applicable information in the window entry fields according to the
descriptions in the following table.

Table 35. RTU Configuration window field descriptions for the Modbus Client protocol

Item Description
General Configuration
Name By default, the Name field has a label. Notice that the label begins with
the "$" character, which distinguishes a label from a point name. This
label is used as descriptive text for the hierarchy tree.

OR

Click the Name field, and click Point Selector (...). The PointSelector
window appears. Select a node or a packed point name, originated on
the module, to use as the RTU name. You can also type the point name in
the Name field. See What are status points? [76] for more information.
Description Enter a description for the RTU using up to 60 characters. This field is
optional.
Communication Configuration
Timeout (ms) Defines the number of milliseconds the Ethernet Link Controller waits for
a response from the RTU before attempting a retry or setting the points
to bad quality.
Retries Defines the number of times the module tries to send a message before
setting the points to bad quality and clearing the in-service bit (bit 0) of
the RTU status word.
Enable Daniel Floats If selected, Daniel Floating points can be used in the Modbus protocol.
These points transfer 32-bit data items by using a 32-bit register that is
four bytes long. Holding registers beyond 47000 are used for this, and
software drivers must be able to accommodate this special situation.
Enable Broadcast When enabled, the SCADA/CPS Modbus Client can support Modbus
broadcast messages.
Critical Use this option if you have redundant modules configured. Select this
check box to designate an RTU as critical. If the primary module cannot
communicate to the RTU marked as critical, communication fails over to
the partner module so that it can communicate to the critical RTU. The
failure time between redundant modules is a multiple of the scan rate
when NIC port is lost.
Timeout (sec) Only active when the Critical check box is selected. This is the amount of
time after a communication failure to the RTU that the primary module
tries to re-establish communication before it fails over to the partner
module.
Monitor NIC Enables network connectivity from the module before each
communication. If the network link status is false, such as if the cable
is unplugged, communication is immediately switched to an alternate
communication port, rather than waiting for a network communication
timeout. Note that the NIC is the network interface.
Monitor Alternate Enables monitoring the state of the backup communication port. When
Interface this check box is selected, the module monitors the state of the backup
communication port after every 15 seconds.

114 PRO_007
 Overview of configuring the Modbus Client protocol

Item Description
Note
The 0x0100 bit (bit 8) is set in the RTU node record if the primary
interface is not operational. The 0x0200 bit (bit 9) is set if the secondary
interface is not operational.

Primary Interface
Node Node address of the primary RTU.
Backup Interface -- grayed out unless a backup port is configured in the Line Configuration
window [102].
Node If a backup port was configured for the line that this RTU communicates
through, this is the node address for the backup RTU. Note that this node
number could be the same as the node number for the primary RTU if
only one RTU is configured for that line.
Partner Primary Interface -- In a redundant module configuration, the backup module can be
configured with unique RTU addresses. This allows you to dedicate a module to a specific RTU
in a redundant configuration.
Node Node address of the partner primary RTU.
Partner Backup Interface -- The backup RTU address information that is used by the backup
module in a redundant module configuration.
Node If a backup port was configured for the line that this RTU communicates
through, this is the node address for the backup RTU. Note that this node
number could be the same as the node number for the primary RTU if
only one RTU is configured for that line.

5. Click the Statistic Points tab and enter the applicable information. The information on
the Statistic Points tab is the same for all RTUs for all protocols.
6. The Partner Configuration and Partner Statistics Points tabs appear if you have
configured the Redundancy Mode as Dual in the Configuration tab window during
Server configuration. Click the Partner Configuration tab and enter all the applicable
information. Similarly, click the Partner Statistics Points tab and enter the applicable
information.
7. After all of the information has been entered, click Apply to save this configuration.

6.1.6 To add a scanblock to an RTU for the Modbus Client

protocol
1. Access the Protocol Configuration Tool [16].

PRO_007 115
Overview of configuring the Modbus Client protocol

2. Right-click the applicable RTU node in the Configuration Tool hierarchy, and select Add
from the pop-up menu that displays.
The Add Items window appears.

Figure 69. Add Items window -- Adding scanblocks for the Modbus Client protocol

116 PRO_007
 Overview of configuring the Modbus Client protocol

3. Choose the desired Scanblock and click Add New. The Scanblock configuration window
appears.

Note
For a list of scanblock types supported for the Modbus Client protocol, see Modbus
Client Scanblock Types [119].

Notice that for Scanblock configuration, there are two tabs on the window. The
procedures below discuss the Configuration tab. Configuration information for scan
points is discussed in General Scan Point window configuration guidelines [77].

Figure 70. Scanblock Configuration window for the Modbus Client protocol

PRO_007 117
Overview of configuring the Modbus Client protocol

4. Enter the applicable information in the window entry fields according to the
descriptions in the following table.

Table 36. Configuration information for the Modbus client line

Field Description
Configuration
Name By default, the Name field has a label. Notice that the label begins with the "$"
character, which distinguishes a label from a point name. This label is used as
descriptive text for the hierarchy tree.

OR

Click the Name field, and click Point Selector (...). The PointSelector window
appears. Select a node or a packed point name, originated on the module, to
use as the RTU name. You can also type the point name in the Name field. See
What are status points? [76] for more information.
Description Enter a description for the scanblock using up to 60 characters. This field is
optional.
Scan Configuration
Operation Defines the work you want the scanblock to perform (read, write, and so
forth).
Scan Type Defines the type of scan. The choices vary by scanblock, but can be periodic,
trigger, exception, or mapping.

• Periodic - executes the scan periodically as defined by the Interval Scan

parameters.
• Trigger - executes the scan once when the digital or packed point (entered
in the Trigger Point field) goes from false to true. The Interval Scan
parameters define how often the module is polling the trigger point for
normal and fast mode.
• Exception -- varies by protocol. In general, executes the scan when the
value of one or more of the scan points associated with this scanblock
changes.
• Mapping - works with the control point defined in the SCADA_CMD (226)
application program. In general, executes the scan when the graphic that
contains the SCADA_CMD application program executes.
Trigger Point Enter a digital or packed point name for the trigger if you selected Trigger for
Scan Type.
Inhibit Point Specifies the name of a digital point that can be used to disable the scanning of
a periodic scanblock. The scanblock scanning occurs normally unless the point
is specified and has a value of 1. In this case, the scanning is inhibited.
Inhibit During initialization, all input and output scanblocks are processed. However,
Exception it may be more appropriate to wait until all input scanblocks have been
Output processed before writing the exception outputs.

If this option is selected, the exception output scanblock is not processed

during initialization, but processed normally at the subsequent scan cycles.
Inhibit Initial During initialization, all input and output scanblocks are processed. However,
Exception it may be more appropriate to wait for a period to allow inputs to be read and
Time calculations to be completed before writing the exception outputs.

118 PRO_007
 Modbus Client Scanblock Types

Field Description
Specifies the time period for which the first processing of the exception output
scanblock to be delayed. After that time period, the scanblock is processed
normally.
Interval Configuration
Interval Units Defines the unit of time for normal and fast intervals. The choices are Seconds,
Milliseconds, and Minutes.
Normal Defines the time between scans for a scanblock for normal mode. For example,
Interval if a Normal Interval is set to 5 and Interval Units is set to Seconds, then there
would be 5 seconds between scans for normal mode.
Fast Interval Defines the time between scans for a scanblock for fast mode.

Fast scan mode is temporary, alternate scanning frequency for a scanblock.

An RTU goes to fast scan mode at initialization and after a user request. The
scanblock returns to normal scan mode after the fast scan count is complete. A
fast scan count of zero disables the fast scan mode.

Fast Interval, Fast Count, and Interval Units define the fast scan mode
operation for the scanblock. For example, if Fast Interval is set to 5, Fast Count
is set to 2, and Interval Units is set to Milliseconds, then there would be 5
milliseconds between scans for fast mode and after 2 scans, normal mode
resumes.
Fast Count Defines the count for fast scan mode. This is the number of scans that happen
in fast scan mode before returning to normal mode.
Scan Interval Defines the rate at which the scan is scheduled.
Scan Offset Bias from the Scan Interval. The Scan Interval and Scan Offset are used
together to identify when the data is normally scanned. For example, if the
data is scanned 15 minutes after each hour, the Scan Interval is 60 minutes and
Scan Offset is 15 minutes.
Demand Determines how quickly the initial scan happens after the RTU is placed in
Offset service.

5. Click the Scan Points tab and enter the applicable information.
6. The Partner Configuration tab appears if you have configured the Redundancy Mode
as Dual in the Configuration tab window during Server configuration. Click the Partner
Configuration tab and enter the applicable information.
7. After entering all the information, click Apply to save this configuration.

6.1.7 To save protocol configuration information

1. After the configuration is complete (servers, ports, lines, RTUs, and scanblocks), pull
down the File menu and select Save on the Protocol Configuration window.
2. Return to the Developer Studio System Tree and find the drop where you want to load
the new configuration. Right-click the drop and select Load.

6.2 Modbus Client Scanblock Types

The following list shows scanblock types for the Modbus Client protocol:

PRO_007 119
Modbus Client Scanblock Types

• Read Coil Status [120].

• Read Input Status.
• Read Holding Registers.
• Read input Registers [122].
• Alarm With Ack [126].
• Force Single Coil [127].
• Preset Single Register [129].
• Force Multiple Coils [132].
• Preset Multiple Registers [134].
• Mask Write Register [137].

6.2.1 Modbus Client Scanblock Type - Read Coil Status

Sends Modbus Command 01.

Table 37. Configuration tab

Field Description
General configuration
Name Name of the scanblock.
Description Optional description of the scanblock.
Scan configuration
Operation Read Coil Status (grayed out)
Scan Type • Periodic - Executes the scan periodically, based on normal or fast scan
interval.
• Trigger - Executes the scan on a zero to one transition of the specified Trigger
point.
Trigger Point Enter a digital or packed point name for the trigger if you selected Trigger for Scan
Type.
Inhibit Point Specifies the name of a digital point that can be used to disable the scanning of
a periodic scanblock. The scanblock scanning occurs normally unless the point is
specified and has a value of 1. In this case, the scanning is inhibited.
Inhibit Exception During initialization, all input and output scanblocks are processed. However, it
Output may be more appropriate to wait until all input scanblocks have been processed
before writing the exception outputs. If this option is selected, the exception
output scanblock is not processed during initialization, but processed normally at
the subsequent scan cycles.
Inhibit Initial During initialization, all input and output scanblocks are processed. However, it
Exception Time may be more appropriate to wait for a period to allow inputs to be read and
calculations to be completed before writing the exception outputs. Specifies the
time period for which the first processing of the exception output scanblock to be
delayed. After that time period, the scanblock is processed normally.
Interval Configuration
Normal Interval Defines the time between scans for a scanblock for normal mode.

120 PRO_007
 Modbus Client Scanblock Types

Field Description
Fast Interval Fast scan mode is temporary, alternate scanning frequency for a scanblock.
An RTU goes to fast scan mode at initialization and after a user request. The
scanblock returns to normal scan mode after the fast scan count is complete.
A fast scan count of zero disables the fast scan mode. Fast Interval, Fast Count,
and Interval Units define the fast scan mode operation for the scanblock. For
example, if Fast Interval is set to 5, Fast Count is set to 2, and Interval Units is set
to Milliseconds, then there would be 5 milliseconds between scans for fast mode
and after 2 scans, normal mode resumes.
Fast Count Defines the count for fast scan mode. This is the number of scans that will happen
in fast scan mode before returning to normal mode.
Interval Units Defines the unit of time for normal and fast intervals. The choices are Seconds,
Milliseconds, and Minutes.
Scan Interval Defines the rate at which the scan is scheduled.
Scan Offset Bias from the Scan Interval. The Scan Interval and Scan Offset are used together
to identify when the data is normally scanned. For example, if the data is scanned
15 minutes after each hour, the Scan Interval is 60 minutes and Scan Offset is 15
minutes.
Demand Offset Determines how quickly the initial scan happens after the RTU is placed in service.

Partner Configuration tab (This tab appears if you have configured the Redundancy Mode as
Dual in the Configuration tab window during Server configuration for the ELC Platform.)

Table 38. Partner Configuration tab

Field Description
General Configuration
Name Name of the Partner scanblock.
Description Optional description of the scanblock.
Scan configuration
Trigger Point If a scan block is configured as a triggered block, a digital point is used to initiate the
execution of the block, or trigger it. The block executes on a 0 to 1 transition of the
trigger point value.
Inhibit Point Specifies the name of a digital point that can be used to disable the scanning of
a periodic scanblock. The scanblock scanning occurs normally unless the point is
specified and has a value of 1. In this case, the scanning is inhibited.

PRO_007 121
Modbus Client Scanblock Types

Table 39. Scan Points tab

Field Description
Columns • Point Name – Name of Ovation point. This is an input point into the Ovation system
(Direction = DCS).
• Data Type:
◦ BOOL – Boolean value – used for digital points.
• Address – Coil address (0x).
• SCADA Scanner - Specifies if the point value is sent to the OPH through the SCADA
Scanner.
• Description – Optional description to describe this point.

6.2.2 Modbus Client Scanblock Type - Read Input Registers

Sends Modbus Command 04.

Table 40. Configuration tab

Field Description
General configuration
Name Name of the scanblock.
Description Optional description of the scanblock.
Scan configuration
Operation Read Input Registers (grayed out)
Scan Type • Periodic - Executes the scan periodically, based on normal or fast scan
interval.
• Trigger - Executes the scan on a zero to one transition of the specified Trigger
point.
Trigger Point Enter a digital or packed point name for the trigger if you selected Trigger for Scan
Type.
Inhibit Point Specifies the name of a digital point that can be used to disable the scanning of
a periodic scanblock. The scanblock scanning occurs normally unless the point is
specified and has a value of 1. In this case, the scanning is inhibited.
Inhibit Exception During initialization, all input and output scanblocks are processed. However, it
Output may be more appropriate to wait until all input scanblocks have been processed
before writing the exception outputs. If this option is selected, the exception
output scanblock is not processed during initialization, but processed normally at
the subsequent scan cycles.
Inhibit Initial During initialization, all input and output scanblocks are processed. However, it
Exception Time may be more appropriate to wait for a period to allow inputs to be read and
calculations to be completed before writing the exception outputs. Specifies the
time period for which the first processing of the exception output scanblock to be
delayed. After that time period, the scanblock is processed normally.
Interval Configuration
Normal Interval Defines the time between scans for a scanblock for normal mode.

122 PRO_007
 Modbus Client Scanblock Types

Field Description
Fast Interval Fast scan mode is temporary, alternate scanning frequency for a scanblock.
An RTU goes to fast scan mode at initialization and after a user request. The
scanblock returns to normal scan mode after the fast scan count is complete.
A fast scan count of zero disables the fast scan mode. Fast Interval, Fast Count,
and Interval Units define the fast scan mode operation for the scanblock. For
example, if Fast Interval is set to 5, Fast Count is set to 2, and Interval Units is set
to Milliseconds, then there would be 5 milliseconds between scans for fast mode
and after 2 scans, normal mode resumes.
Fast Count Defines the count for fast scan mode. This is the number of scans that will happen
in fast scan mode before returning to normal mode.
Interval Units Defines the unit of time for normal and fast intervals. The choices are Seconds,
Milliseconds, and Minutes.
Scan Interval Defines the rate at which the scan is scheduled.
Scan Offset Bias from the Scan Interval. The Scan Interval and Scan Offset are used together
to identify when the data is normally scanned. For example, if the data is scanned
15 minutes after each hour, the Scan Interval is 60 minutes and Scan Offset is 15
minutes.
Demand Offset Determines how quickly the initial scan happens after the RTU is placed in service.

Partner Configuration tab (This tab appears if you have configured the Redundancy Mode as
Dual in the Configuration tab window during Server configuration for the ELC Platform.)

Table 41. Partner Configuration tab

Field Description
General Configuration
Name Name of the Partner scanblock.
Description Optional description of the scanblock.
Scan configuration
Trigger Point If a scan block is configured as a triggered block, a digital point is used to initiate the
execution of the block, or trigger it. The block executes on a 0 to 1 transition of the
trigger point value.
Inhibit Point Specifies the name of a digital point that can be used to disable the scanning of
a periodic scanblock. The scanblock scanning occurs normally unless the point is
specified and has a value of 1. In this case, the scanning is inhibited.

PRO_007 123
Modbus Client Scanblock Types

Table 42. Scan Points tab

Field Description
Columns • Point Name – Name of Ovation point. This is an input point into the Ovation system
(Direction = DCS).
• Data Type:
◦ BYTE – 8 bit signed value – used for analog or packed points.
◦ UBYTE – Unsigned 8 bit value – used for analog or packed points.
◦ INT16 – 16 bit signed value – used for analog or packed points.
◦ UINT16 – 16 bit unsigned value – used for analog or packed points.
◦ INT32 – 32 bit signed value – used for analog points.
◦ UINT32 – 32 bit unsigned value – used for analog points.
◦ FLOAT – IEEE 32 bit floating point number – used for analog points.
◦ BOOL – Boolean value – used for digital points.
• Address – Input register address (3x). If a single bit is specified, such as 30001.01,
then only the value of this bit is mapped to the Ovation point specified by Point
Name.
• Swap Bytes – Swaps the bit order of bytes within the returned register value.
• Swap Words – Swaps the bit order of the words within the returned register value.
• SCADA Scanner - Specifies if the point value is sent to the OPH through the SCADA
Scanner.
• Description – Optional description to describe this point.

6.2.3 Modbus Client Scanblock Type - Read Input Status

Table 43. Configuration tab

Field Description
General configuration
Name Name of the scanblock.
Description Optional description of the scanblock.
Scan configuration
Operation Read Input Registers (grayed out)
Scan Type • Periodic - Executes the scan periodically, based on normal or fast scan
interval.
• Trigger - Executes the scan on a zero to one transition of the specified Trigger
point.
Trigger Point Enter a digital or packed point name for the trigger if you selected Trigger for Scan
Type.
Inhibit Point Specifies the name of a digital point that can be used to disable the scanning of
a periodic scanblock. The scanblock scanning occurs normally unless the point is
specified and has a value of 1. In this case, the scanning is inhibited.

124 PRO_007
 Modbus Client Scanblock Types

Field Description
Inhibit Exception During initialization, all input and output scanblocks are processed. However, it
Output may be more appropriate to wait until all input scanblocks have been processed
before writing the exception outputs. If this option is selected, the exception
output scanblock is not processed during initialization, but processed normally at
the subsequent scan cycles.
Inhibit Initial During initialization, all input and output scanblocks are processed. However, it
Exception Time may be more appropriate to wait for a period to allow inputs to be read and
calculations to be completed before writing the exception outputs. Specifies the
time period for which the first processing of the exception output scanblock to be
delayed. After that time period, the scanblock is processed normally.
Interval Configuration
Normal Interval Defines the time between scans for a scanblock for normal mode.
Fast Interval Fast scan mode is temporary, alternate scanning frequency for a scanblock.
An RTU goes to fast scan mode at initialization and after a user request. The
scanblock returns to normal scan mode after the fast scan count is complete.
A fast scan count of zero disables the fast scan mode. Fast Interval, Fast Count,
and Interval Units define the fast scan mode operation for the scanblock. For
example, if Fast Interval is set to 5, Fast Count is set to 2, and Interval Units is set
to Milliseconds, then there would be 5 milliseconds between scans for fast mode
and after 2 scans, normal mode resumes.
Fast Count Defines the count for fast scan mode. This is the number of scans that will happen
in fast scan mode before returning to normal mode.
Interval Units Defines the unit of time for normal and fast intervals. The choices are Seconds,
Milliseconds, and Minutes.
Scan Interval Defines the rate at which the scan is scheduled.
Scan Offset Bias from the Scan Interval. The Scan Interval and Scan Offset are used together
to identify when the data is normally scanned. For example, if the data is scanned
15 minutes after each hour, the Scan Interval is 60 minutes and Scan Offset is 15
minutes.
Demand Offset Determines how quickly the initial scan happens after the RTU is placed in service.

Partner Configuration tab (This tab appears if you have configured the Redundancy Mode as
Dual in the Configuration tab window during Server configuration for the ELC Platform.)

Table 44. Scan Points tab

Field Description
Columns • Point Name – Name of Ovation point. This is an input point into the Ovation system
(Direction = DCS).
• Data Type:
◦ BOOL – Boolean value – used for digital points.
• Address – Input register address (3x). If a single bit is specified, such as 30001.01,
then only the value of this bit is mapped to the Ovation point specified by Point
Name.
• SCADA Scanner - Specifies if the point value is sent to the OPH through the SCADA
Scanner.
• Description – Optional description to describe this point.

PRO_007 125
Modbus Client Scanblock Types

6.2.4 Modbus Client Scanblock Type - Alarm With Ack

Monitors a bit that has been designated as an alarm bit in a PLC.

Table 45. Configuration tab

Field Description
General configuration
Name Name of the scanblock
Description Optional description of the scanblock.
Scan configuration
Operation Read Alarm With Ack (grayed out)
Scan Type • Periodic - Executes the scan periodically, based on normal or fast scan
interval.
• Trigger - Executes the scan on a zero to one transition of the specified
Trigger point.
Trigger Point Grayed out.
Inhibit Point Specifies the name of a digital point that can be used to disable the scanning
of a periodic scanblock. The scanblock scanning occurs normally unless the
point is specified and has a value of 1. In this case, the scanning is inhibited.
Inhibit Exception Grayed out.
Output
Inhibit Initial Grayed out.
Exception Time
Interval Configuration
Normal Interval Defines the time between scans for a scanblock for normal mode.
Fast Interval Fast scan mode is temporary, alternate scanning frequency for a scanblock.
An RTU goes to fast scan mode at initialization and after a user request. The
scanblock returns to normal scan mode after the fast scan count is complete.
A fast scan count of zero disables the fast scan mode. Fast Interval, Fast Count,
and Interval Units define the fast scan mode operation for the scanblock. For
example, if Fast Interval is set to 5, Fast Count is set to 2, and Interval Units is
set to Milliseconds, then there would be 5 milliseconds between scans for fast
mode and after 2 scans, normal mode resumes.
Fast Count Defines the count for fast scan mode. This is the number of scans that will
happen in fast scan mode before returning to normal mode.
Scan Interval Grayed out.
Scan Offset Grayed out.
Demand Offset Grayed out.

Partner Configuration tab (This tab appears if you have configured the Redundancy Mode as
Dual in the Configuration tab window during Server configuration for the ELC Platform.)

Table 46. Partner Configuration tab

Field Description
General Configuration

126 PRO_007
 Modbus Client Scanblock Types

Field Description
Name Name of the Partner scanblock.
Description Optional description of the scanblock.
Scan configuration
Trigger Point Grayed out.
Inhibit Point Specifies the name of a digital point that can be used to disable the scanning of
a periodic scanblock. The scanblock scanning occurs normally unless the point is
specified and has a value of 1. In this case, the scanning is inhibited.

Table 47. Scan Points tab

Field Description
Columns • Point Name – Name of Ovation point. This is an input point into the Ovation system
(Direction = DCS).
• Data Type:
◦ BOOL – Boolean value – used for digital points.
• Address – Input register address (3x). If a single bit is specified, such as 30001.01,
then only the value of this bit is mapped to the Ovation point specified by Point
Name.
• Ack Stat – Address containing the bit that indicates that the alarm has been
acknowledged.
• Ack Cmd – Address that is written to acknowledge the alarm.
• SCADA Scanner – Specifies if the point value is sent to the OPH through the SCADA
Scanner.
• Description – Optional description to describe this point.

6.2.5 Modbus Client Scanblock Type - Force Single Coil

Sends Modbus Command 05.

Table 48. Configuration tab

Field Description
General configuration
Name Name of the scanblock.
Description Optional description of the scanblock.
Scan configuration
Operation Force Single Coil (grayed out)

PRO_007 127
Modbus Client Scanblock Types

Field Description
Bad Quality Bad Quality Handling specifies how Ovation points with bad quality should be
Handling handled by the Modbus driver when they are used as outputs to the RTU in the
field.

If the Ovation point quality is good, the value is written to the RTU as expected.

Do Not Send – Do not write a value to the RTU.

Ignore – Ignore the quality and write the value to the RTU.

Send 0 – Send a value of 0

Send 999 – Send a value of 999

Last Good Value – Send the last value that had GOOD quality
Scan Type • Periodic - Executes the scan periodically, based on normal or fast scan interval.
• Trigger - Executes the scan on a zero to one transition of the specified Trigger
point.
• Executes the scan when the value of one or more of the scan points associated
with this scanblock changes.
• Mapping – Executes the scan when the graphic that contains the SCADA_CMD
(226) application program executes.
Trigger Point Enter a digital or packed point name for the trigger if you selected Trigger for Scan
Type.
Inhibit Point Specifies the name of a digital point that can be used to disable the scanning of
a periodic scanblock. The scanblock scanning occurs normally unless the point is
specified and has a value of 1. In this case, the scanning is inhibited.
Inhibit During initialization, all input and output scanblocks are processed. However, it
Exception may be more appropriate to wait until all input scanblocks have been processed
Output before writing the exception outputs. If this option is selected, the exception
output scanblock is not processed during initialization, but processed normally at
the subsequent scan cycles.
Inhibit Initial During initialization, all input and output scanblocks are processed. However, it
Exception Time may be more appropriate to wait for a period to allow inputs to be read and
calculations to be completed before writing the exception outputs. Specifies the
time period for which the first processing of the exception output scanblock to be
delayed. After that time period, the scanblock is processed normally.
Interval Configuration
Normal Interval Defines the time between scans for a scanblock for normal mode.
Fast Interval Fast scan mode is temporary, alternate scanning frequency for a scanblock. An RTU
goes to fast scan mode at initialization and after a user request. The scanblock
returns to normal scan mode after the fast scan count is complete. A fast scan
count of zero disables the fast scan mode. Fast Interval, Fast Count, and Interval
Units define the fast scan mode operation for the scanblock. For example, if Fast
Interval is set to 5, Fast Count is set to 2, and Interval Units is set to Milliseconds,
then there would be 5 milliseconds between scans for fast mode and after 2 scans,
normal mode resumes.
Fast Count Defines the count for fast scan mode. This is the number of scans that will happen
in fast scan mode before returning to normal mode.

128 PRO_007
 Modbus Client Scanblock Types

Field Description
Interval Units Defines the unit of time for normal and fast intervals. The choices are Seconds,
Milliseconds, and Minutes.
Scan Interval Defines the rate at which the scan is scheduled.
Scan Offset Bias from the Scan Interval. The Scan Interval and Scan Offset are used together
to identify when the data is normally scanned. For example, if the data is scanned
15 minutes after each hour, the Scan Interval is 60 minutes and Scan Offset is 15
minutes.
Demand Offset Determines how quickly the initial scan happens after the RTU is placed in service.

Partner Configuration tab (This tab appears if you have configured the Redundancy Mode as
Dual in the Configuration tab window during Server configuration for the ELC Platform.)

Table 49. Partner Configuration tab

Field Description
General Configuration
Name Name of the Partner scanblock
Description Optional description of the scanblock
Scan configuration
Trigger Point If a scan block is configured as a triggered block, a digital point is used to initiate the
execution of the block, or trigger it. The block executes on a 0 to 1 transition of the
trigger point value.
Inhibit Point Specifies the name of a digital point that can be used to disable the scanning of
a periodic scanblock. The scanblock scanning occurs normally unless the point is
specified and has a value of 1. In this case, the scanning is inhibited.

Note
Only one scan point can be defined for the Force Single Coil scanblock type.

Table 50. Scan Points tab

Field Description
Columns • Point Name – Name of Ovation point. This is an output point from the Ovation
system (Direction = FIELD).
• Data Type:
◦ BOOL – Boolean value – used for digital points.
• Address – Coil address (0x).
• Description – Optional description to describe this point.

6.2.6 Modbus Client Scanblock Type - Preset Single Register

Sends Modbus Command 06.

PRO_007 129
Modbus Client Scanblock Types

Table 51. Configuration tab

Field Description
General configuration
Name Name of the scanblock.
Description Optional description of the scanblock.
Scan configuration
Operation Preset Single Register (grayed out)
Bad Quality Bad Quality Handling specifies how Ovation points with bad quality should be
Handling handled by the Modbus driver when they are used as outputs to the RTU in the
field.

If the Ovation point quality is good, the value is written to the RTU as expected.

Do Not Send – Do not write a value to the RTU.

Ignore – Ignore the quality and write the value to the RTU.

Send 0 – Send a value of 0

Send 999 – Send a value of 999

Last Good Value – Send the last value that had GOOD quality
Scan Type • Periodic - Executes the scan periodically, based on normal or fast scan interval.
• Trigger - Executes the scan on a zero to one transition of the specified Trigger
point.
• Exception – Executes the scan when the value of one or more of the scan
points associated with this scanblock changes.
• Mapping – Executes the scan when the graphic that contains the SCADA_CMD
(226) application program executes.
Trigger Point Enter a digital or packed point name for the trigger if you selected Trigger for Scan
Type.
Inhibit Point Specifies the name of a digital point that can be used to disable the scanning of
a periodic scanblock. The scanblock scanning occurs normally unless the point is
specified and has a value of 1. In this case, the scanning is inhibited.
Inhibit During initialization, all input and output scanblocks are processed. However, it
Exception may be more appropriate to wait until all input scanblocks have been processed
Output before writing the exception outputs. If this option is selected, the exception
output scanblock is not processed during initialization, but processed normally at
the subsequent scan cycles.
Inhibit Initial During initialization, all input and output scanblocks are processed. However, it
Exception Time may be more appropriate to wait for a period to allow inputs to be read and
calculations to be completed before writing the exception outputs. Specifies the
time period for which the first processing of the exception output scanblock to be
delayed. After that time period, the scanblock is processed normally.
Interval Configuration
Normal Interval Defines the time between scans for a scanblock for normal mode.

130 PRO_007
 Modbus Client Scanblock Types

Field Description
Fast Interval Fast scan mode is temporary, alternate scanning frequency for a scanblock. An RTU
goes to fast scan mode at initialization and after a user request. The scanblock
returns to normal scan mode after the fast scan count is complete. A fast scan
count of zero disables the fast scan mode. Fast Interval, Fast Count, and Interval
Units define the fast scan mode operation for the scanblock. For example, if Fast
Interval is set to 5, Fast Count is set to 2, and Interval Units is set to Milliseconds,
then there would be 5 milliseconds between scans for fast mode and after 2 scans,
normal mode resumes.
Fast Count Defines the count for fast scan mode. This is the number of scans that will happen
in fast scan mode before returning to normal mode.
Interval Units Defines the unit of time for normal and fast intervals. The choices are Seconds,
Milliseconds, and Minutes.
Scan Interval Defines the rate at which the scan is scheduled.
Scan Offset Bias from the Scan Interval. The Scan Interval and Scan Offset are used together
to identify when the data is normally scanned. For example, if the data is scanned
15 minutes after each hour, the Scan Interval is 60 minutes and Scan Offset is 15
minutes.
Demand Offset Determines how quickly the initial scan happens after the RTU is placed in service.

Partner Configuration tab (This tab appears if you have configured the Redundancy Mode as
Dual in the Configuration tab window during Server configuration for the ELC Platform.)

Table 52. Partner Configuration tab

Field Description
General Configuration
Name Name of the Partner scanblock
Description Optional description of the scanblock
Scan configuration
Trigger Point If a scan block is configured as a triggered block, a digital point is used to initiate the
execution of the block, or trigger it. The block executes on a 0 to 1 transition of the
trigger point value.
Inhibit Point Specifies the name of a digital point that can be used to disable the scanning of
a periodic scanblock. The scanblock scanning occurs normally unless the point is
specified and has a value of 1. In this case, the scanning is inhibited.

Note
Only one scan point can be defined for the Preset Single Register scanblock type.

PRO_007 131
Modbus Client Scanblock Types

Table 53. Scan Points tab

Field Description
Columns • Point Name – Name of Ovation point. This is an output point from the Ovation
system (Direction = FIELD)
• Data Type:
◦ BYTE – 8 bit signed value – used for analog or packed points.
◦ UBYTE – Unsigned 8 bit value – used for analog or packed points.
◦ INT16 – 16 bit signed value – used for analog or packed points.
◦ UINT16 – 16 bit unsigned value – used for analog or packed points.
◦ INT32 – 32 bit signed value – used for analog points.
◦ UINT32 – 32 bit unsigned value – used for analog points.
◦ FLOAT – IEEE 32 bit floating point number – used for analog points.
◦ BOOL – Boolean value – used for digital points.
• Address – Holding register address (4x). If a single bit is specified, such as 40001.01,
then only the value of this bit is mapped to the ovation point specified by Point
Name.
• Swap Bytes – Swaps the bit order of bytes within the returned register value.
• Swap Words – Swaps the bit order of the words within the returned register value.
• Deadband – Deadband value for Exception scan type.
• Output Conv - None, Normal, Inverse
• Description – Optional description to describe this point.

6.2.7 Modbus Client Scanblock Type - Force Multiple Coils

Sends Modbus Command 15.

Table 54. Configuration tab

Field Description
General configuration
Name Name of the scanblock.
Description Optional description of the scanblock.
Scan configuration
Operation Force Multiple Coil (grayed out)

132 PRO_007
 Modbus Client Scanblock Types

Field Description
Bad Quality Bad Quality Handling specifies how Ovation points with bad quality should be
Handling handled by the Modbus driver when they are used as outputs to the RTU in the
field.

If the Ovation point quality is good, the value is written to the RTU as expected.

Do Not Send – Do not write a value to the RTU.

Ignore – Ignore the quality and write the value to the RTU.

Send 0 – Send a value of 0

Send 999 – Send a value of 999

Last Good Value – Send the last value that had GOOD quality
Scan Type • Periodic - Executes the scan periodically, based on normal or fast scan interval.
• Trigger - Executes the scan on a zero to one transition of the specified Trigger
point.
• Exception – Executes the scan when the value of one or more of the scan
points associated with this scanblock changes.
• Mapping – Executes the scan when the graphic that contains the SCADA_CMD
(226) application program executes.
Trigger Point Enter a digital or packed point name for the trigger if you selected Trigger for Scan
Type.
Inhibit Point Specifies the name of a digital point that can be used to disable the scanning of
a periodic scanblock. The scanblock scanning occurs normally unless the point is
specified and has a value of 1. In this case, the scanning is inhibited.
Inhibit During initialization, all input and output scanblocks are processed. However, it
Exception may be more appropriate to wait until all input scanblocks have been processed
Output before writing the exception outputs. If this option is selected, the exception
output scanblock is not processed during initialization, but processed normally at
the subsequent scan cycles.
Inhibit Initial During initialization, all input and output scanblocks are processed. However, it
Exception Time may be more appropriate to wait for a period to allow inputs to be read and
calculations to be completed before writing the exception outputs. Specifies the
time period for which the first processing of the exception output scanblock to be
delayed. After that time period, the scanblock is processed normally.
Interval Configuration
Normal Interval Defines the time between scans for a scanblock for normal mode.
Fast Interval Fast scan mode is temporary, alternate scanning frequency for a scanblock. An RTU
goes to fast scan mode at initialization and after a user request. The scanblock
returns to normal scan mode after the fast scan count is complete. A fast scan
count of zero disables the fast scan mode. Fast Interval, Fast Count, and Interval
Units define the fast scan mode operation for the scanblock. For example, if Fast
Interval is set to 5, Fast Count is set to 2, and Interval Units is set to Milliseconds,
then there would be 5 milliseconds between scans for fast mode and after 2 scans,
normal mode resumes.
Fast Count Defines the count for fast scan mode. This is the number of scans that will happen
in fast scan mode before returning to normal mode.

PRO_007 133
Modbus Client Scanblock Types

Field Description
Interval Units Defines the unit of time for normal and fast intervals. The choices are Seconds,
Milliseconds, and Minutes.
Scan Interval Defines the rate at which the scan is scheduled.
Scan Offset Bias from the Scan Interval. The Scan Interval and Scan Offset are used together
to identify when the data is normally scanned. For example, if the data is scanned
15 minutes after each hour, the Scan Interval is 60 minutes and Scan Offset is 15
minutes.
Demand Offset Determines how quickly the initial scan happens after the RTU is placed in service.

Partner Configuration tab (This tab appears if you have configured the Redundancy Mode as
Dual in the Configuration tab window during Server configuration for the ELC Platform.)

Table 55. Partner Configuration tab

Field Description
General Configuration
Name Name of the Partner scanblock.
Description Optional description of the scanblock.
Scan configuration
Trigger Point If a scanblock is configured as a triggered block, a digital point is used to initiate the
execution of the block, or trigger it. The block executes on a 0 to 1 transition of the
trigger point value.
Inhibit Point Specifies the name of a digital point that can be used to disable the scanning of
a periodic scanblock. The scanblock scanning occurs normally unless the point is
specified and has a value of 1. In this case, the scanning is inhibited.

Table 56. Scan Points tab

Field Description
Columns • Point Name – Name of Ovation point. This is an output point from the Ovation
system (Direction = FIELD)
• Data Type:
◦ BOOL – Boolean value – used for digital points.
• Address – Coil address (0x).
• Description – Optional description to describe this point.

6.2.8 Modbus Client Scanblock Type - Preset Multiple Registers

Sends Modbus Command 16.

Table 57. Configuration tab

Field Description
General configuration
Name Name of the scanblock.

134 PRO_007
 Modbus Client Scanblock Types

Field Description
Description Optional description of the scanblock.
Scan configuration
Operation Preset Multiple Registers (grayed out)
Bad Quality Bad Quality Handling specifies how Ovation points with bad quality should be
Handling handled by the Modbus driver when they are used as outputs to the RTU in the
field.

If the Ovation point quality is good, the value is written to the RTU as expected.

Do Not Send – Do not write a value to the RTU.

Ignore – Ignore the quality and write the value to the RTU.

Send 0 – Send a value of 0

Send 999 – Send a value of 999

Last Good Value – Send the last value that had GOOD quality
Scan Type • Periodic - Executes the scan periodically, based on normal or fast scan interval.
• Trigger - Executes the scan on a zero to one transition of the specified Trigger
point.
• Exception – Executes the scan when the value of one or more of the scan
points associated with this scanblock changes.
• Mapping – Executes the scan when the graphic that contains the SCADA_CMD
(226) application program executes.
Trigger Point Enter a digital or packed point name for the trigger if you selected Trigger for Scan
Type.
Inhibit Point Specifies the name of a digital point that can be used to disable the scanning of
a periodic scanblock. The scanblock scanning occurs normally unless the point is
specified and has a value of 1. In this case, the scanning is inhibited.
Inhibit During initialization, all input and output scanblocks are processed. However, it
Exception may be more appropriate to wait until all input scanblocks have been processed
Output before writing the exception outputs. If this option is selected, the exception
output scanblock is not processed during initialization, but processed normally at
the subsequent scan cycles.
Inhibit Initial During initialization, all input and output scanblocks are processed. However, it
Exception Time may be more appropriate to wait for a period to allow inputs to be read and
calculations to be completed before writing the exception outputs. Specifies the
time period for which the first processing of the exception output scanblock to be
delayed. After that time period, the scanblock is processed normally.
Interval Configuration
Normal Interval Defines the time between scans for a scanblock for normal mode.

PRO_007 135
Modbus Client Scanblock Types

Field Description
Fast Interval Fast scan mode is temporary, alternate scanning frequency for a scanblock. An RTU
goes to fast scan mode at initialization and after a user request. The scanblock
returns to normal scan mode after the fast scan count is complete. A fast scan
count of zero disables the fast scan mode. Fast Interval, Fast Count, and Interval
Units define the fast scan mode operation for the scanblock. For example, if Fast
Interval is set to 5, Fast Count is set to 2, and Interval Units is set to Milliseconds,
then there would be 5 milliseconds between scans for fast mode and after 2 scans,
normal mode resumes.
Fast Count Defines the count for fast scan mode. This is the number of scans that will happen
in fast scan mode before returning to normal mode.
Interval Units Defines the unit of time for normal and fast intervals. The choices are Seconds,
Milliseconds, and Minutes.
Scan Interval Defines the rate at which the scan is scheduled.
Scan Offset Bias from the Scan Interval. The Scan Interval and Scan Offset are used together
to identify when the data is normally scanned. For example, if the data is scanned
15 minutes after each hour, the Scan Interval is 60 minutes and Scan Offset is 15
minutes.
Demand Offset Determines how quickly the initial scan happens after the RTU is placed in service.

Partner Configuration tab (This tab appears if you have configured the Redundancy Mode as
Dual in the Configuration tab window during Server configuration for the ELC Platform.)

Table 58. Partner Configuration tab

Field Description
General Configuration
Name Name of the Partner scanblock
Description Optional description of the scanblock
Scan configuration
Trigger Point If a scan block is configured as a triggered block, a digital point is used to initiate the
execution of the block, or trigger it. The block executes on a 0 to 1 transition of the
trigger point value.
Inhibit Point Specifies the name of a digital point that can be used to disable the scanning of
a periodic scanblock. The scanblock scanning occurs normally unless the point is
specified and has a value of 1. In this case, the scanning is inhibited.

136 PRO_007
 Modbus Client Scanblock Types

Table 59. Scan Points tab

Field Description
Columns • Point Name – Name of Ovation point. This is an output point from the Ovation
system (Direction = FIELD).
• Data Type:
◦ BYTE – 8 bit signed value – used for analog or packed points.
◦ UBYTE – Unsigned 8 bit value – used for analog or packed points.
◦ INT16 – 16 bit signed value – used for analog or packed points.
◦ UINT16 – 16 bit unsigned value – used for analog or packed points.
◦ INT32 – 32 bit signed value – used for analog points.
◦ UINT32 – 32 bit unsigned value – used for analog points.
◦ FLOAT – IEEE 32 bit floating point number – used for analog points.
◦ BOOL – Boolean value – used for digital points.
• Address – Holding register address (4x). If a single bit is specified, such as 40001.01,
then only the value of this bit is mapped to the ovation point specified by Point
Name.
• Swap Bytes – Swaps the bit order of bytes within the returned register value.
• Swap Words – Swaps the bit order of the words within the returned register value.
• Deadband – Deadband value for Exception scan type.
• Output Conv - None, Normal, Inverse
• Description – Optional description to describe this point.

6.2.9 Modbus Client Scanblock Type - Mask Write Register

Sends Modbus Command 22.

Table 60. Configuration tab

Field Description
General configuration
Name Name of the scanblock.
Description Optional description of the scanblock.
Scan configuration
Operation Mask Write Register (grayed out)

PRO_007 137
Modbus Client Scanblock Types

Field Description
Bad Quality Bad Quality Handling specifies how Ovation points with bad quality should be
Handling handled by the Modbus driver when they are used as outputs to the RTU in the
field.

If the Ovation point quality is good, the value is written to the RTU as expected.

Do Not Send – Do not write a value to the RTU.

Ignore – Ignore the quality and write the value to the RTU.

Send 0 – Send a value of 0

Send 999 – Send a value of 999

Last Good Value – Send the last value that had GOOD quality
Scan Type • Periodic - Executes the scan periodically, based on normal or fast scan interval.
• Trigger - Executes the scan on a zero to one transition of the specified Trigger
point.
• Exception – Executes the scan when the value of one or more of the scan
points associated with this scanblock changes.
• Mapping – Executes the scan when the graphic that contains the SCADA_CMD
(226) application program executes.
Trigger Point Enter a digital or packed point name for the trigger if you selected Trigger for Scan
Type.
Inhibit Point Specifies the name of a digital point that can be used to disable the scanning of
a periodic scanblock. The scanblock scanning occurs normally unless the point is
specified and has a value of 1. In this case, the scanning is inhibited.
Inhibit During initialization, all input and output scanblocks are processed. However, it
Exception may be more appropriate to wait until all input scanblocks have been processed
Output before writing the exception outputs. If this option is selected, the exception
output scanblock is not processed during initialization, but processed normally at
the subsequent scan cycles.
Inhibit Initial During initialization, all input and output scanblocks are processed. However, it
Exception Time may be more appropriate to wait for a period to allow inputs to be read and
calculations to be completed before writing the exception outputs. Specifies the
time period for which the first processing of the exception output scanblock to be
delayed. After that time period, the scanblock is processed normally.
Interval Configuration
Normal Interval Defines the time between scans for a scanblock for normal mode.
Fast Interval Fast scan mode is temporary, alternate scanning frequency for a scanblock. An RTU
goes to fast scan mode at initialization and after a user request. The scanblock
returns to normal scan mode after the fast scan count is complete. A fast scan
count of zero disables the fast scan mode. Fast Interval, Fast Count, and Interval
Units define the fast scan mode operation for the scanblock. For example, if Fast
Interval is set to 5, Fast Count is set to 2, and Interval Units is set to Milliseconds,
then there would be 5 milliseconds between scans for fast mode and after 2 scans,
normal mode resumes.
Fast Count Defines the count for fast scan mode. This is the number of scans that will happen
in fast scan mode before returning to normal mode.

138 PRO_007
 Modbus Client Scanblock Types

Field Description
Interval Units Defines the unit of time for normal and fast intervals. The choices are Seconds,
Milliseconds, and Minutes.
Scan Interval Defines the rate at which the scan is scheduled.
Scan Offset Bias from the Scan Interval. The Scan Interval and Scan Offset are used together
to identify when the data is normally scanned. For example, if the data is scanned
15 minutes after each hour, the Scan Interval is 60 minutes and Scan Offset is 15
minutes.
Demand Offset Determines how quickly the initial scan happens after the RTU is placed in service.

Partner Configuration tab (This tab appears if you have configured the Redundancy Mode as
Dual in the Configuration tab window during Server configuration for the ELC Platform.)

Table 61. Partner Configuration tab

Field Description
General Configuration
Name Name of the Partner scanblock
Description Optional description of the scanblock
Scan configuration
Trigger Point If a scan block is configured as a triggered block, a digital point is used to initiate the
execution of the block, or trigger it. The block executes on a 0 to 1 transition of the
trigger point value.
Inhibit Point Specifies the name of a digital point that can be used to disable the scanning of
a periodic scanblock. The scanblock scanning occurs normally unless the point is
specified and has a value of 1. In this case, the scanning is inhibited.

PRO_007 139
Modbus Client Scanblock Types

Table 62. Scan Points tab

Field Description
Columns • Point Name – Name of Ovation point. This is an input point into the Ovation system
(Direction = FIELD).
• Data Type:
◦ BYTE – 8 bit signed value – used for analog or packed points.
◦ UBYTE – Unsigned 8 bit value – used for analog or packed points.
◦ INT16 – 16 bit signed value – used for analog or packed points.
◦ UINT16 – 16 bit unsigned value – used for analog or packed points.
◦ BOOL – Boolean value – used for digital points.
• Address – Holding register address (4x). If a single bit is specified, such as 40001.01,
then only the value of this bit is mapped to the Ovation point specified by Point
Name.
• Swap Bytes – Swaps the bit order of bytes within the returned register value.
• Swap Words – Swaps the bit order of the words within the returned register value.
• Deadband – Deadband value for Exception scan type.
• Output Conv - None, Normal, Inverse
• Description – Optional description to describe this point.

140 PRO_007
 Overview of configuring the Modbus Server protocol

7 Modbus Server configuration

Topics covered in this section:
• Overview of configuring the Modbus Server protocol [141]
• Modbus Server Scanblock Types [150]

7.1 Overview of configuring the Modbus Server

protocol
This section assumes you have already defined and configured the Server in the Protocol
Configuration Tool.

The following procedures start with adding a port to the server and continue with adding a
line, RTU, and scanblocks. All of the procedures discuss how the parameters should be set
for the Modbus Server protocol.

7.1.1 To add a port to the server for the Modbus Server

protocol
1. Access the Protocol Configuration Tool [16].
2. Right-click the Server item from the left panel on the Protocol Configuration Tool
window and choose Add.

Figure 71. Protocol Configuration Tool -- right-click server

PRO_007 141
Overview of configuring the Modbus Server protocol

3. The Add items window appears:

Figure 72. Add Items window -- add a port to the server

4. Select the type of Communication Port from the list and choose Add New. The port
choices are RS-232, Digi Terminal Server, Generic Terminal Server, TCP Ethernet, and
UDP Ethernet. Refer to one of the following topics for configuration information:
• To configure a RS-232 Serial Port window [62].
• To configure a DIGI Terminal Server Port window [64].
• To configure a Generic Terminal Server Port window [66].
• To configure a TCP Ethernet Port window [68].
• To configure a UDP Ethernet Port window [69].

Note
For information on deleting a port, see To delete an item from the Protocol
Configuration Tool [33].

7.1.2 To add a line to a server for the Modbus Server protocol

Notes:

• A Modbus RTU Simulation line causes the Ethernet Link Controller to appear as a
Modbus Server to a remote Modbus Master.

142 PRO_007
 Overview of configuring the Modbus Server protocol

• Use a label for the line name, not a status point, since the line status point is not
updated in a slave line. The RTU status point shows the status of the Modbus server
line.

1. Access the Protocol Configuration Tool [16].

2. Right-click the Server item from the left panel of the Protocol Configuration Tool
window and choose Add.
The Add Items window appears. Only configured protocols for this module appear in
this window.

Figure 73. Add Items window -- add a line to a server (Modbus protocol)

PRO_007 143
Overview of configuring the Modbus Server protocol

3. Choose the Modbus Server Line and select Add New. The right side of the Protocol
Configuration Tool updates with configuration information for the new line.

Figure 74. Configuration information for a Modbus Server Line

4. Enter the applicable information in the window entry fields according to the
descriptions in the following table.

Table 63. Configuration information for a Modbus Server line

Item Description
General Configuration
Type Automatically filled with the appropriate Line type. In this example, it is
Modbus.
Name This is a unique name given to the Communication Line. A label should be
used for the line name, not a status point, since the line status point is not
updated in a slave line.
Description Enter a description for the line using up to 60 characters. This is optional.
Primary Communications
Port Select the primary communication port for this line.
Protocol Defines the protocol for the line. The choices are: Modbus RTU and Modbus
Open TCP.
Scheduler Configuration
Scheduler Type Select the type of the scheduler to scan the data. Valid options are – Periodic-
Priority and Wall Clock.

144 PRO_007
 Overview of configuring the Modbus Server protocol

5. The Partner Configuration tab appears if you have configured the Redundancy Mode
as Dual in the Configuration tab window during Server configuration. Click the Partner
Configuration tab and enter all the applicable information. The information on the
Partner Configuration tab is the same for all lines.
6. After all of the information has been entered, select the Apply button to save this
configuration.

7.1.3 To configure an RTU for the Modbus Server protocol

The RTU Configuration tab defines the status point and node address for the RTU, which
in this case, is the Ethernet Link Controller. The remote device acts as the Modbus Client.
Only a single RTU configuration is used for a Modbus Server line since it defines the local
parameters of the Ethernet Link Controller. The RTU packed status point indicates the state
of the Ethernet Link Controller.

1. Access the Protocol Configuration Tool [16].

2. Right-click the Line item from the left panel on the Protocol Configuration Tool window
and choose Add. The Add Items window appears.
3. Choose the MODBUS Server RTU and select Add New. The right side of the Protocol
Configuration Tool updates with configuration information for the new RTU.
Notice that for RTU configuration, there are two tabs on the window. The procedures
below discuss the Configuration tab. See Configuring Statistic Points tab for RTUs [72]
for information on the fields for statistic points.

Figure 75. RTU Configuration tab information for Modbus server

PRO_007 145
Overview of configuring the Modbus Server protocol

4. Enter the applicable information in the window entry fields according to the
descriptions in the following table.

Table 64. RTU Configuration window field descriptions for the Modbus protocol

Field Description
General Configuration
Name By default, the Name field has a label. Notice that the label begins with the "$"
character, which distinguishes a label from a point name. This label is used as
the descriptive text for the hierarchy tree.

OR

Click the Name field, and click Point Selector (...). The PointSelector window
appears. Select a node or a packed point name, originated on the module, to
use as the RTU name. You can also type the point name in the Name field. See
What are status points? [76] for more information.
Description Enter a description for the RTU using up to 60 characters. This field is
optional.
Communication Configuration
Timeout (sec) Defines the number of seconds that the Ethernet Link Controller waits for a
response from the RTU before attempting a retry or setting the points to bad
quality.
Enable Daniel If selected, Daniel Floating points can be used in the Modbus protocol. These
Floats points transfer 32-bit data items by using a 32-bit register which is four bytes
long. Holding registers beyond 47000 are used for this, and software drivers
must be able to accommodate this special situation.
Critical Use this option if you have redundant modules configured. Select this check
box to designate an RTU as critical. If the primary module is unable to
communicate to the RTU marked as critical, communication fails over to the
partner module so that it can communicate to the critical RTU. The failure
time between redundant modules is a multiple of the scan rate when NIC
port is lost.
Timeout (sec) Only active when the Critical check box is selected. This is the amount of time
after a communication failure to the RTU that the primary module tries to
re-establish communication before it fails over to the partner module.
Interface Configuration
Node Number of the remote RTU.
Port Port number of the remote RTU.
Modbus Server Configuration
Idle Timeout Idle Timeout provides a way to specify that if a point has not been updated
(sec) within this period, then the point's quality will be set to the Idle Quality.

If the Idle Timeout parameter is 0, then this feature does nothing.

Separate IO If selected, when the client sends a Read Holding Register command, the
Areas value of POINT1 is returned.

It is left to the user to ensure that the application updates the value of
POINT1.
Idle Quality Bad

146 PRO_007
 Overview of configuring the Modbus Server protocol

Field Description
Poor

5. Click the Statistic Points tab and enter the applicable information. The information on
the Statistic Points tab is the same for all RTUs for all protocols.
6. The Partner Configuration and Partner Statistics Points tabs appear if you have
configured the Redundancy Mode as Dual in the Configuration tab window during
Server configuration. Click the Partner Configuration tab and enter all the applicable
information. Similarly, click the Partner Statistics Points tab and enter the applicable
information.
7. After all of the information has been entered, click Apply to save this configuration.

7.1.4 To add a scanblock to an RTU for the Modbus Server

protocol
The Configuration tab will have all of its entry fields inactive (grayed out) for a server line
(except for Name and Description). The scan points are defined in the same way as the
client line. However, a label should be used for the scanblock name, not a status point, since
the scanblock status point is not updated in a server line.

1. Access the Protocol Configuration Tool [16].

PRO_007 147
Overview of configuring the Modbus Server protocol

2. Right-click the applicable RTU item from the left panel on the Protocol Configuration
Tool window and choose Add. The Add Items window appears.
The Add Items window appears.

Figure 76. Add Items window -- Adding scanblocks for the Modbus Server protocol

148 PRO_007
 Overview of configuring the Modbus Server protocol

3. Choose the desired Scanblock and click Add New. The Scanblock configuration window
appears.

Note
For a list of scanblock types supported for the Modbus Server protocol, see Modbus
Server Scanblock Types [150].

Notice that for Scanblock configuration, there are two tabs on the window.
Configuration information for scan points is discussed in General Scan Point window
configuration guidelines [77].

Figure 77. Scanblock Configuration window for the Modbus protocol

PRO_007 149
Modbus Server Scanblock Types

4. Enter the applicable information in the window entry fields according to the
descriptions in the following table.

Table 65. Configuration information for a scanblock for a Modbus server

Field Description
General Configuration
Name This is a unique name given to the scanblock. A label should be used for the
scanblock name, not a status point, since the scanblock status point is not
updated in a slave line.
Description Enter a description for the scanblock using up to 60 characters. This field is
optional.
Scan Communication
Operation Defines the work you want the scanblock to perform (read, write, and so
forth). This field is inactive (grayed out) in a server line.
Bad Quality Bad Quality Handling specifies how Ovation points with bad quality should be
Handling handled by the Modbus driver when they are used as outputs to the RTU in the
field.

If the Ovation point quality is good, the value is written to the RTU as
expected.

If the Ovation point quality is bad, choose one of the following options:

Do Not Send – Do not write a value to the RTU

Ignore – Ignore the quality and write the value to the RTU

Send 0 – Send a value of 0

Send 999 – Send a value of 999

Last Good Value – Send the last value that had GOOD quality

5. Click the Scan Points tab and enter the applicable information.
6. The Partner Configuration tab appears if you have configured the Redundancy Mode
as Dual in the Configuration tab window during Server configuration. Click the Partner
Configuration tab and enter the applicable information.
7. After all of the information has been entered, click Apply to save this configuration.

7.1.5 To save protocol configuration information

1. After the configuration is complete (servers, ports, lines, RTUs, and scanblocks), pull
down the File menu and select Save on the Protocol Configuration window.
2. Return to the Developer Studio System Tree and find the drop where you want to load
the new configuration. Right-click the drop and select Load.

7.2 Modbus Server Scanblock Types

The following list shows scanblock types for the Modbus Server protocol:

150 PRO_007
 Modbus Server Scanblock Types

• Read Coil Status [151].

• Read Input Status [152].
• Read Holding Registers [153].
• Read Input Registers [154].
• Force Single Coil [155].
• Preset Single Register [156].
• Force Multiple Coils [157].
• Preset Multiple Registers [158].

7.2.1 Modbus Server Scanblock Type - Read Coil Status

Accepts Modbus Command 01.

Table 66. Configuration tab

Field Description
General configuration
Name Name of the scanblock.
Description Optional description of the scanblock.
Scan configuration
Operation Read Coil Status (grayed out)
Bad Quality Bad Quality Handling specifies how Ovation points with bad quality should be
Handling handled by the Modbus driver when they are used as outputs to the RTU in the
field.

If the Ovation point quality is good, the value is written to the RTU as expected.

Ignore – Ignore the quality and write the value to the RTU.

Send 0 – Send a value of 0

Send 1 – Send a value of 1

Last Good Value – Send the last value that had GOOD quality.

Partner Configuration tab (This tab appears if you have configured the Redundancy Mode as
Dual in the Configuration tab window during Server configuration for the ELC Platform.)

Table 67. Partner Configuration tab

Field Description
General Configuration
Name Name of the Partner scanblock.
Description Optional description of the scanblock.

PRO_007 151
Modbus Server Scanblock Types

Table 68. Scan Points tab

Field Description
Columns • Point Name – Name of Ovation point. This is an output point from the Ovation
system (Direction = FIELD).
• Data Type:
◦ BOOL – Boolean value – used for digital points.
• Address – Coil address (0x).
• Description – Optional description to describe this point.

7.2.2 Modbus Server Scanblock Type - Read Input Status

Accepts Modbus Command 02.

Table 69. Configuration tab

Field Description
General configuration
Name Name of the scanblock.
Description Optional description of the scanblock.
Scan configuration
Operation Read Input Status (grayed out)
Bad Quality Bad Quality Handling specifies how Ovation points with bad quality should be
Handling handled by the Modbus driver when they are used as outputs to the RTU in the
field.

If the Ovation point quality is good, the value is written to the RTU as expected.

Ignore – Ignore the quality and write the value to the RTU.

Send 0 – Send a value of 0

Send 1 – Send a value of 1

Last Good Value – Send the last value that had GOOD quality.

Partner Configuration tab (This tab appears if you have configured the Redundancy Mode as
Dual in the Configuration tab window during Server configuration for the ELC Platform.)

Table 70. Partner Configuration tab

Field Description
General Configuration
Name Name of the Partner scanblock.
Description Optional description of the scanblock.

152 PRO_007
 Modbus Server Scanblock Types

Table 71. Scan Points tab

Field Description
Columns • Point Name – Name of Ovation point. This is an output point into the Ovation system
(Direction = FIELD).
• Data Type:
◦ BOOL – Boolean value – used for digital points.
• Address – Status address (1x).
• Description – Optional description to describe this point.

7.2.3 Modbus Server Scanblock Type - Read Holding Registers

Accepts Modbus Command 03.

Table 72. Configuration tab

Field Description
General configuration
Name Name of the scanblock.
Description Optional description of the scanblock.
Scan configuration
Operation Read Holding Registers (grayed out)
Bad Quality Bad Quality Handling specifies how Ovation points with bad quality should be
Handling handled by the Modbus driver when they are used as outputs to the RTU in the
field.

If the Ovation point quality is good, the value is written to the RTU as expected.

Do Not Send – Do not write a value to the RTU.

Ignore – Ignore the quality and write the value to the RTU.

Send 0 – Send a value of 0

Send 999 – Send a value of 999

Last Good Value – Send the last value that had GOOD quality.

Partner Configuration tab (This tab appears if you have configured the Redundancy Mode as
Dual in the Configuration tab window during Server configuration for the ELC Platform.)

Table 73. Partner Configuration tab

Field Description
General Configuration
Name Name of the Partner scanblock.
Description Optional description of the scanblock.

PRO_007 153
Modbus Server Scanblock Types

Table 74. Scan Points tab

Field Description
Columns • Point Name – Name of Ovation point. This is an output point into the Ovation system
(Direction = FIELD).
• Data Type:
◦ BYTE – 8 bit signed value – used for analog or packed points.
◦ UBYTE – Unsigned 8 bit value – used for analog or packed points.
◦ INT16 – 16 bit signed value – used for analog or packed points.
◦ UINT16 – 16 bit unsigned value – used for analog or packed points.
◦ INT32 – 32 bit signed value – used for analog points.
◦ UINT32 – 32 bit unsigned value – used for analog points.
◦ FLOAT – IEEE 32 bit floating point number – used for analog points.
◦ BOOL – Boolean value – used for digital points.
• Address – Holding register address (4x). If a single bit is specified, such as 40001.01,
then only the value of this bit is mapped to the ovation point specified by Point
Name.
• Swap Bytes – Swaps the bit order of bytes within the returned register value.
• Swap Words – Swaps the bit order of the words within the returned register value.
• Description – Optional description to describe this point.

7.2.4 Modbus Server Scanblock Type - Read Input Registers

Accepts Modbus Command 04.

Table 75. Configuration tab

Field Description
General configuration
Name Name of the scanblock.
Description Optional description of the scanblock.
Scan configuration
Operation Read Input Registers (grayed out)
Bad Quality Bad Quality Handling specifies how Ovation points with bad quality should be
Handling handled by the Modbus driver when they are used as outputs to the RTU in the
field.

If the Ovation point quality is good, the value is written to the RTU as expected.

Do Not Send – Do not write a value to the RTU.

Ignore – Ignore the quality and write the value to the RTU.

Send 0 – Send a value of 0

Send 999 – Send a value of 999

Last Good Value – Send the last value that had GOOD quality.

154 PRO_007
 Modbus Server Scanblock Types

Partner Configuration tab (This tab appears if you have configured the Redundancy Mode as
Dual in the Configuration tab window during Server configuration for the ELC Platform.)

Table 76. Partner Configuration tab

Field Description
General Configuration
Name Name of the Partner scanblock.
Description Optional description of the scanblock.

Table 77. Scan Points tab

Field Description
Columns • Point Name – Name of Ovation point. This is an output point into the Ovation system
(Direction = FIELD).
• Data Type:
◦ BYTE – 8 bit signed value – used for analog or packed points.
◦ UBYTE – Unsigned 8 bit value – used for analog or packed points.
◦ INT16 – 16 bit signed value – used for analog or packed points.
◦ UINT16 – 16 bit unsigned value – used for analog or packed points.
◦ INT32 – 32 bit signed value – used for analog points.
◦ UINT32 – 32 bit unsigned value – used for analog points.
◦ FLOAT – IEEE 32 bit floating point number – used for analog points.
◦ BOOL – Boolean value – used for digital points.
• Address – Input register address (3x). If a single bit is specified, such as 30001.01,
then only the value of this bit is mapped to the Ovation point specified by Point
Name.
• Swap Bytes – Swaps the bit order of bytes within the returned register value.
• Swap Words – Swaps the bit order of the words within the returned register value.
• Description – Optional description to describe this point.

7.2.5 Modbus Server Scanblock Type - Force Single Coil

Accepts Modbus Command 05.

Table 78. Configuration tab

Field Description
General configuration
Name Name of the scanblock.
Description Optional description of the scanblock.
Scan configuration
Operation Force Single Coil (grayed out)

Partner Configuration tab (This tab appears if you have configured the Redundancy Mode as
Dual in the Configuration tab window during Server configuration for the ELC Platform.)

PRO_007 155
Modbus Server Scanblock Types

Table 79. Partner Configuration tab

Field Description
General Configuration
Name Name of the Partner scanblock.
Description Optional description of the scanblock.

Table 80. Scan Points tab

Field Description
Columns • Point Name – Name of Ovation point. This is an input point from the Ovation system
(Direction = DCS).
• Data Type:
◦ BOOL – Boolean value – used for digital points.
• Address – Coil address (0x).
• Description – Optional description to describe this point.

7.2.6 Modbus Server Scanblock Type - Preset Single Register

Accepts Modbus Command 06.

Table 81. Configuration tab

Field Description
General configuration
Name Name of the scanblock.
Description Optional description of the scanblock.
Scan configuration
Operation Preset Single Register (grayed out)

Partner Configuration tab (This tab appears if you have configured the Redundancy Mode as
Dual in the Configuration tab window during Server configuration for the ELC Platform.)

Table 82. Partner Configuration tab

Field Description
General Configuration
Name Name of the Partner scanblock.
Description Optional description of the scanblock.

156 PRO_007
 Modbus Server Scanblock Types

Table 83. Scan Points tab

Field Description
Columns • Point Name – Name of Ovation point. This is an input point from the Ovation system
(Direction = DCS).
• Data Type:
◦ BYTE – 8 bit signed value – used for analog or packed points.
◦ UBYTE – Unsigned 8 bit value – used for analog or packed points.
◦ INT16 – 16 bit signed value – used for analog or packed points.
◦ UINT16 – 16 bit unsigned value – used for analog or packed points.
◦ INT32 – 32 bit signed value – used for analog points.
◦ UINT32 – 32 bit unsigned value – used for analog points.
◦ FLOAT – IEEE 32 bit floating point number – used for analog points.
◦ BOOL – Boolean value – used for digital points.
• Address – Holding register address (4x). If a single bit is specified, such as 40001.01,
then only the value of this bit is mapped to the ovation point specified by Point
Name.
• Swap Bytes – Swaps the bit order of bytes within the returned register value.
• Swap Words – Swaps the bit order of the words within the returned register value.
• Description – Optional description to describe this point.

7.2.7 Modbus Server Scanblock Type - Force Multiple Coils

Accepts Modbus Command 15.

Table 84. Configuration tab

Field Description
General configuration
Name Name of the scanblock.
Description Optional description of the scanblock.
Scan configuration
Operation Force Multiple Coils (grayed out)

Partner Configuration tab (This tab appears if you have configured the Redundancy Mode as
Dual in the Configuration tab window during Server configuration for the ELC Platform.)

Table 85. Partner Configuration tab

Field Description
General Configuration
Name Name of the Partner scanblock.
Description Optional description of the scanblock.

PRO_007 157
Modbus Server Scanblock Types

Table 86. Scan Points tab

Field Description
Columns • Point Name – Name of Ovation point. This is an input point from the Ovation system
(Direction = DCS).
• Data Type:
◦ BOOL – Boolean value – used for digital points.
• Address – Coil address (0x).
• Description – Optional description to describe this point.

7.2.8 Modbus Server Scanblock Type - Preset Multiple

Registers
Accepts Modbus Command 16.

Table 87. Configuration tab

Field Description
General configuration
Name Name of the scanblock.
Description Optional description of the scanblock.
Scan configuration
Operation Preset Multiple Registers (grayed out)

Partner Configuration tab (This tab appears if you have configured the Redundancy Mode as
Dual in the Configuration tab window during Server configuration for the ELC Platform.)

Table 88. Partner Configuration tab

Field Description
General Configuration
Name Name of the Partner scanblock.
Description Optional description of the scanblock.

158 PRO_007
 Modbus Server Scanblock Types

Table 89. Scan Points tab

Field Description
Columns • Point Name – Name of Ovation point. This is an input point from the Ovation system
(Direction = DCS).
• Data Type:
◦ BYTE – 8 bit signed value – used for analog or packed points.
◦ UBYTE – Unsigned 8 bit value – used for analog or packed points.
◦ INT16 – 16 bit signed value – used for analog or packed points.
◦ UINT16 – 16 bit unsigned value – used for analog or packed points.
◦ INT32 – 32 bit signed value – used for analog points.
◦ UINT32 – 32 bit unsigned value – used for analog points.
◦ FLOAT – IEEE 32 bit floating point number – used for analog points.
◦ BOOL – Boolean value – used for digital points.
• Address – Holding register address (4x). If a single bit is specified, such as 40001.01,
then only the value of this bit is mapped to the ovation point specified by Point
Name.
• Swap Bytes – Swaps the bit order of bytes within the returned register value.
• Swap Words – Swaps the bit order of the words within the returned register value.
• Description – Optional description to describe this point.

PRO_007 159
 What is the Modbus Simulator?

8 Understanding the Modbus Simulator

Topics covered in this section:
• What is the Modbus Simulator? [161]
• Installing a Modbus Simulator [161]
• What is a Modbus Server Simulator? [161]
• What is a Modbus Client simulator? [168]

8.1 What is the Modbus Simulator?

The Modbus Simulator application emulates a Modbus client or server for troubleshooting
Modbus communication issues.

A Modbus Simulator that emulates the Modbus client is called a Modbus Client
Simulator [161]. A Modbus Simulator that emulates a Modbus server is called a Modbus
Server Simulator [168].

8.2 Installing a Modbus Simulator

The Modbus Simulator is available with the SCADA CD. When you install SCADA
from the SCADA CD, the Modbus Simulator is automatically installed in the
C:\Ovation\Scada\Tools\ProtocolTests directory.

The name of the executable that simulates a Modbus master is ModbusMaster.exe and the
name of the executable that simulates a Modbus slave is ModbusSlave.exe.

The Modbus Simulator is available with the Communication Protocol Software CD. When
you install Ovation Communication Protocol Software from the CPS CD, the Modbus
Simulator is automatically installed in the C:\Ovation\ELC\Tools\ProtocolTests directory.

The name of the executable that simulates a Modbus master is ModbusMaster.exe and the
name of the executable that simulates a Modbus slave is ModbusSlave.exe.

8.3 What is a Modbus Server Simulator?

The Modbus Server Simulator allows you to configure the communication port used
for communication. The Modbus Server simulator supports TCP, UDP, and serial
communication port types. For serial lines, you can configure attributes such as
Communication port name, baud rate, number of data bits, number of stop bits, and
parity. For TCP and UDP ports, you can only configure the IP address and port number. All
ports allow the Modbus protocol (RTU, ASCII, and Open TCP) and inter-message delay to
be configured. The Modbus Server simulator acts as a Modbus Gateway and responds to
multiple Modbus'.

The Modbus Server simulator acts as a Modbus Gateway and responds to multiple Modbus.

PRO_007 161
What is a Modbus Server Simulator?

8.3.1 Working with the Modbus Server Simulator

When the SCADA Server is configured as a server, click ModbusServer.exe in one of the
following locations, depending on your platform:

• C:\Ovation\Scada\Tools\ProtocolTests directory.
• C:\Ovation\ELC\Tools\ProtocolTests directory

The Modbus Server window appears.

Figure 78. Modbus Server main window

8.3.2 Configuring port

To configure the ports, perform the following steps:

1. From the Modbus window, click File > Configure Port.

Figure 79. Configure port

162 PRO_007
 What is a Modbus Server Simulator?

2. The Port Configuration window appears. Enter the required values in the fields and
click OK.

Figure 80. Port Configuration window

3. The Start button on the main window becomes active.

a. Click Start to start the processing.
b. Click Stop to stop the processing.

8.3.3 Configuring servers

To configure servers, perform the following steps:

1. From the Modbus window, click File > Configure Slaves.

Figure 81. Configure Slaves

PRO_007 163
What is a Modbus Server Simulator?

2. The Modbus Server Configuration window with the enabled slaves appears. Select
the required slave(s) and click OK to check its information. Click Cancel to cancel the
processing.

Figure 82. Modbus Slave Configuration window

164 PRO_007
 What is a Modbus Server Simulator?

3. When you click the OK button, the main window appears with the active Start button.
Click the Start button to start the communication between the SCADA Server and the
Modbus Slave Simulator. The Slave State changes from Stopped to Running, and the
Node Details for Node <x> window appears.

Figure 83. Node Details for Node <x> window

8.3.4 Transferring values from a Modbus Server simulator to a

Scan point
After you configure the slaves [163], perform the following steps to transfer values from the
Modbus server simulator to a scan point.

Note
For this example, the Read Coil Status scan block is used. The same procedure is used for
other read scan blocks.

1. From the Node Details for Node <x> window, click View.
2. From the drop-down menu that appears, click Coils.

PRO_007 165
What is a Modbus Server Simulator?

3. Enter the value in the required register, as shown in the following figure:

Figure 84. Coils for Node x window

4. Open the associated scan point in the Ovation Point Information application.
5. Click the Value tab and check the value of the required register.

Figure 85. Point Information window, Values tab

The same value at both places indicates healthy communication between the Modbus
Server simulator and the SCADA Server.

8.3.5 Transferring values from Scan point to Modbus Server

simulator

Note
For this example, the Present Single Register scan block is used. The same procedure is used
for other write scan blocks.

166 PRO_007
 What is a Modbus Server Simulator?

1. Open the associated scan point in the Ovation Point Information application and check
its value.

Figure 86. Ovation Point Information application window

2. From the Node Details for Node <x> window, click View.
3. From the menu that appears, click Holding Register.
4. Check the value of the holding register. It must be the same value, that was transferred
from the Ovation Point Information application, as shown in the following figure:

Figure 87. Holding Registers for Node x window

The same value at both places indicates healthy communication between the SCADA Server
and the Modbus Server simulator.

PRO_007 167
What is a Modbus Client simulator?

8.4 What is a Modbus Client simulator?

The Modbus Client simulator allows you to configure the communication port used for
communication. The Modbus Client simulator supports TCP, UDP, and serial communication
port types. For serial lines, you can configure attributes such as Communication port name,
baud rate, number of data bits, number of stop bits, and parity. For TCP and UDP ports, you
can only configure the IP address and port number. All ports allow the Modbus protocol
(RTU, ASCII, and Open TCP) and inter-message delay to be configured.

The Modbus Client simulator:

• Allows you to specify the starting register and number of registers to be configured for
Holding Registers, Input Registers, Coils, and Discretes.
• Allows you to select the node number of the device.
• Allows you to select the poll rate and timeout value.
• Tracks the number of successful communications, the number of no-responses, and
the number of CRC errors.
• Displays the details of the communication messages and the values retrieved for the
Holding Registers, Input Registers, Coils, and Discretes.

8.4.1 Working with Modbus Client Simulator

When you have configured the SCADA Server as a server, click the ModbusClient.exe in one
of the following locations, depending on your platform:

• C:\Ovation\Scada\Tools\ProtocolTests directory.
• C:\Ovation\ELC\Tool\ProtocolTests directory.

The Modbus Clientmain window appears.

Figure 88. Modbus Client main window

8.4.2 Configuring communication port

The communication port relays messages between the SCADA server and the Modbus
Client simulator. To configure the communication port, perform the following steps:

1. On the Modbus Client window, enter the Node number of the device.

168 PRO_007
 What is a Modbus Client simulator?

2. Click Configure Port.

3. The Port Configuration window appears. On the Port Configuration window, perform
the following steps:
a. Enter Port type. Network (TCP), Network (UDP), and Serial are the communication
ports supported.
b. If you have selected TCP or UDP port types, perform the following steps:
• Enter the IP address and port number in the IP Address and TCP Port fields
respectively.
• Select the intermessage delay value from the Intermessage Delay box.
• Select RTU from the Protocol field.

Note
You cannot configure any other fields in this area.

c. If you have selected Serial port type, perform the following steps:
• Select the protocol, serial port, baud rate, data bits, parity, stop bits, and flow
control from the respective drop-down lists.
• Select the intermessage delay value from the Intermessage Delay box.

Note
You cannot configure any other fields in this area.

PRO_007 169
What is a Modbus Client simulator?

4. Click OK.

Figure 89. Port Configuration window

170 PRO_007
 What is a Modbus Client simulator?

5. The Modbus Client window appears. Click Start in that window. The Node state
changes from stopped to connecting. The CommunicationDetails window appears
showing all the communication details.

Note
To view the communication details, you can also click View > Communications in the
Modbus Master window.

Figure 90. Communication Details window

PRO_007 171
What is a Modbus Client simulator?

6. In the Modbus Client window, view the communication results. The Stop button
becomes Active on the window. Click the Stop button if you want to stop the
communication between the Modbus client simulator and SCADA Server.

Figure 91. Modbus Master window

Note
If desired, you can change the count of the holding registers, input registers, coils, and
discretes from the Start Register and Register Count drop-down list of the associated
register.

8.4.3 Transferring values from Scan point to Modbus Client

simulator

Note
In this example, the Read Holding Registers scanblock is used. The same procedure is used
for other read scanblocks.

1. Open the associated scan point in the Ovation Point Information application and click
the Value tab. Force any value in the required register.

Figure 92. Ovation Point Information application window

172 PRO_007
 What is a Modbus Client simulator?

2. From the Modbus Client window, click View.

3. From the menu that appears, click Holding Register.
4. Check the value of the holding register. It must be the same value that was transferred
from the Ovation Point Information application, as shown in the following figure:

Figure 93. Check value of holding register

The same value in both places indicates healthy communication between the SCADA Server
and the Modbus Client simulator.

8.4.4 Diagnostics
The Modbus protocol includes messages that allow the master to retrieve diagnostic
information from the slave. To view the diagnostics information, click View > Diagnostics
from the Modbus Client main window.

Figure 94. Modbus Client main window

The Diagnostics window appears and displays the diagnostic information retrieved from the
slave.

PRO_007 173
What is a Modbus Client simulator?

Figure 95. Diagnostics window

Table 90. Diagnostics parameters/buttons

Parameters/Buttons Description
PLC Statistics
Message received Shows the count of messages received on PLC.
NAKs Sent -
No Response Errors Shows the count of response timeout errors.
Overruns Shows the count of overruns.
Busy count Shows the number of times messages were not received due to busy
signals on the PLC.
Diagnostics Register Shows the total number of communications (messages, errors, and
overruns) sent to or received from the PLC.
Line statistics
Message received Shows the count of messages received online.
Exception Error Count Shows the count of exception errors online.
Communication Error Count Shows the count of communication error online.
Clear Stats Clears the statistics for line and PLC.
Clear Overruns Clears the overruns for line and PLC.
Listen Only Mode Allows you to put the line in a mode where it only "listens" for
messages, but does not respond to or initiate communications.
Restart Comms Restarts the communication between client and server.

174 PRO_007
 PRO_007
Version 4
May 2024

Twitter: twitter.com/ovationusers
LinkedIn: linkedin.com/groups?gid=4179755
Ovation Users’ Group: www.ovationusers.com

Emerson, Power and Water Solutions

1000 Westinghouse Drive, Suite 500
Cranberry Township, PA16066