AVEVA™

Communication Drivers Pack – Allen

Bradley - ABCIP Driver

User Guide
© 2020 AVEVA Group plc and its subsidiaries. All rights reserved.

No part of this documentation shall be reproduced, stored in a ret rieval system, or transmitted by any
means, electronic, mechanical, photocopying, rec ording, or otherwise, without the prior written
permission of AVEVA. No liability is assumed with respect to the use of the information contained herein.
Although precaution has been taken in the preparation of this doc umentation, AVEVA assumes no
responsibility for errors or omissions. The information in this documentation is subject to change without
notice and does not represent a commitment on the part of AVEVA. The soft ware described in this
documentation is furnished under a license agreement. This soft ware may be used or copied only in
accordance with the terms of such license agreement.
ArchestrA, Aquis, Avantis, Citect, DYNSIM, eDNA, EYESIM, InBatch, InduSoft, InStep, Int elaTrac,
InTouch, OASyS, PIPEPHASE, PRiSM, PRO/II, PROV ISION, ROMeo, SIM4ME, SimCentral, SimSci,
Skelta, SmartGlance, Spiral Software, Termis, WindowMaker, WindowViewer, and Wonderware are
trademarks of AVEVA and/or its subsidiaries. An extensive listing of AVEVA trademarks can be found at:
https://sw.aveva.com/legal. All other brands may be trademarks of their respective owners.
Publication date: Wednesday, November 18, 2020
Contact Information
AVEVA Group plc
High Cross
Madingley Road
Cambridge
CB3 0HB. UK
https://sw.aveva.com/
For information on how to cont act sales and customer training, see https://sw.aveva.com/contact.
For information on how to cont act technical support, see https://sw.aveva.com/support.
 AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Contents
Chapter 1 Introduction to the ABCIP Communication Driver.......................................... 7
About the ABCIP Communication Driver..................................................................................... 7
Supported Client Protocols ........................................................................................................ 7
Supported Device Protocols....................................................................................................... 7
Supported Device Networks....................................................................................................... 7
Supported Devices .................................................................................................................... 7
Cont rolLogix Controllers ...................................................................................................... 8
GuardLogix Controllers ........................................................................................................ 8
SoftLogix 5800 Controllers ................................................................................................... 8
CompactLogix Cont rollers .................................................................................................... 8
FlexLogix Controllers ........................................................................................................... 8
MicroLogix Controllers ......................................................................................................... 9
PLC-5 Controllers ................................................................................................................ 9
SLC500 Cont rollers ............................................................................................................. 9
Supported Topologies ............................................................................................................... 9
Dual E NB Routing Topology .............................................................................................. 11
Device-Level Ring (DLR) Topology ..................................................................................... 11
Windows Firewall Considerations ............................................................................................. 11

Chapter 2 Configuring the ABCIP Communication Driver............................................. 13

Configuring Port Objects for the ABCIP Communication Driver .................................................. 13
Adding, Renaming, Deleting Port Objects ........................................................................... 13
Adding a Port .............................................................................................................. 13
Renaming a Port ......................................................................................................... 13
Deleting a Port ............................................................................................................ 14
Configuring ABCIP Communication Driver Ports.................................................................. 14
CIP Port Connection Set-up ......................................................................................... 14
The Ethernet Network .................................................................................................. 15
The ControlNet Net work ............................................................................................... 26
The DeviceNet Network ............................................................................................... 31
The Data Highway Plus Network .................................................................................. 31
Configuring Device Redundancy................................................................................... 35
Device Groups and Device Items ............................................................................................. 37
Device Group Definitions ................................................................................................... 37
Device Item Definitions ...................................................................................................... 39
Exporting and Importing Communic ation Driver Item Data ................................................... 40
Scan-Based Message Handling ......................................................................................... 42
Unsolicited Message Handling ........................................................................................... 42

Using Auto-Build with the ABCIP Communication Driver ................................................ 45

About Auto-B uild and the ABCIP Communication Driver ............................................................ 45
Prerequisites for Auto-Build Operation...................................................................................... 45

3
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide Contents

Accessing the Auto-Build screen .............................................................................................. 47

Monitoring Auto-Build Progress ................................................................................................ 47
Templat e Generation in the Application Server ......................................................................... 48
PLC Tag Dat abase Feature Support ........................................................................................ 48
Auto-Build Data Type Mapping ................................................................................................ 49

ABCIP Communication Driver Reference .......................................................................... 51

OPC Browsing ........................................................................................................................ 51
Off-line OP C Item Browsing (Static Browsing) ..................................................................... 51
Online OPC Item Browsing (Dynamic Browsing) .................................................................. 51
Logix5000 Optimization Mode .................................................................................................. 52
UDT Optimization .............................................................................................................. 53
UDT Optimization with None Access Attribute ............................................................... 53
Logix5000 Write Optimization............................................................................................. 53
Data Type Determination ................................................................................................... 54
Tag Database Status ................................................................................................... 54
Tag Database Version ................................................................................................. 54
Invalid Items Handling ....................................................................................................... 55
Logix5000 Online Tag Management ......................................................................................... 55
Adding or Removing Tags.................................................................................................. 55
Making PLC Program Routine Changes.............................................................................. 55
Modifying Tags Through Downloaded Programs ................................................................. 55
Loading Tag Database from File .............................................................................................. 56
Auto Load Tags on Activation............................................................................................. 56
Auto Synchronize Tags ...................................................................................................... 56
Persisted Tags .................................................................................................................. 56
Tag Database from File Options Matrix ............................................................................... 56
Manual Tag Synchronization .............................................................................................. 58
Accessing Secured Logix5000-series Controllers ...................................................................... 58
Auto Synchronize Tag Functionality Matrix.......................................................................... 59
Persisted Tag Functionality Matrix ...................................................................................... 59
Cont roller Time Stamping ........................................................................................................ 60
Item Names/Reference Descriptions ........................................................................................ 62
Logix5000 Item Naming ..................................................................................................... 62
Module-Defined Data Types ......................................................................................... 65
User-Defined Data Types ............................................................................................. 65
Block Reads and Writes of Arrays................................................................................. 65
PLC-5 Item Naming ........................................................................................................... 66
Output File Items ......................................................................................................... 68
Input File Items............................................................................................................ 68
Status File Items.......................................................................................................... 69
Binary File It ems.......................................................................................................... 69
Timer File Items .......................................................................................................... 70
Counter File Items ....................................................................................................... 70
Cont rol File Items ........................................................................................................ 71
Integer File Items ......................................................................................................... 71
Floating Point File Items ............................................................................................... 71
ASCII File It ems .......................................................................................................... 72
BCD File Items ............................................................................................................ 72

4
Contents AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

ASCII String Section Items ........................................................................................... 73

Block Transfer Section Items ........................................................................................ 73
PID Section Items ........................................................................................................ 73
SFC Status Section Items ............................................................................................ 74
Message Section Items ................................................................................................ 74
CNetMessage Control Block Items ............................................................................... 75
SLC500 Item Naming ........................................................................................................ 75
Output File Items ......................................................................................................... 77
Input File Items............................................................................................................ 77
Addressing SLC I/O Modules ....................................................................................... 78
Status File Items.......................................................................................................... 80
Binary File It ems.......................................................................................................... 80
Timer File Items .......................................................................................................... 81
Counter File Items ....................................................................................................... 81
Cont rol File Items ........................................................................................................ 82
Integer File Items ......................................................................................................... 82
Floating Point File Items ............................................................................................... 83
ASCII File It ems .......................................................................................................... 83
ASCII String Section Items ........................................................................................... 84
MicroLogix Item Naming .................................................................................................... 84
Output File Items ......................................................................................................... 85
Input File Items............................................................................................................ 86
Status File Items.......................................................................................................... 86
Binary File It ems.......................................................................................................... 87
Timer File Items .......................................................................................................... 87
Counter File Items ....................................................................................................... 87
Cont rol File Items ........................................................................................................ 88
Integer File Items ......................................................................................................... 89
Floating Point File Items ............................................................................................... 89
ASCII String Section Items ........................................................................................... 89
Long Integer Section Items........................................................................................... 89
PID Section Items ........................................................................................................ 90
Message Section Items ................................................................................................ 90
Communication Driver-S pecific System Item ....................................................................... 91
Generic OPC Syntax ......................................................................................................... 97

Troubleshooting the ABCIP Communication Driver ......................................................... 99

Troubleshooting with Windows Tools........................................................................................ 99
Troubleshooting with the OI Server Manager ............................................................................ 99
Finding Version Information ..................................................................................................... 99
Using the Log Viewer .............................................................................................................. 99
Basic Log Flags .............................................................................................................. 100
Communication Driver Log Flags...................................................................................... 100
Communication Driver-Device Interface Log Flags ............................................................ 101
Error Codes and Error Messages ........................................................................................... 101
ABCIP Communication Driver Error Codes ....................................................................... 101
Logix5000 Error Codes .................................................................................................... 101
Data Highway Plus Error Conditions ................................................................................. 105
ABCIP Communication Driver Error Messages .................................................................. 106
PLC-5 Error Messages .................................................................................................... 113
SLC500 and MicroLogix Error Messages .......................................................................... 115
PLC-5, SLC500, and MicroLogix Error Messages .............................................................. 115

5
 AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

C HAPTER 1
Introduction to the ABCIP Communication
Driver

About the ABCIP Communication Driver

The ABCIP Communication Driver is a Microsoft Windows application that allows client applications
direct and indirect access to Allen-Bradley families of ControlLogix, GuardLogix, FlexLogix,
CompactLogix, SoftLogix 5800, MicroLogix, PLC-5, and S LC500 controllers.
The Communication Driver does not require the Rockwell Software RSLinx™ package.

Supported Client Protocols

Client applications connect to the ABCIP Communication Driver is activated from the System
Management Console (SMC).Communication Driver

Supported Device Protocols

The ABCIP Communication Driver to communicate with the following supported Allen-B radley
controllers:
 PLC-5 controllers
 SLC500 cont rollers
 MicroLogix controllersCommunication Driver

Supported Device Networks

The ABCIP Communication Driver communicates wit h supported devices either directly or indirectly
across the following device networks:
 Cont rolNet
 Data Highway 485 (DH485)
 Data Highway Plus (DH+)
 DeviceNet
 Ethernet

Supported Devices
The AB CIP Communication Driver provides direct and indirect connectivity to the following Allen-B radley
controllers:
 Cont rolLogix Controllers on page 8
 GuardLogix Controllers on page 8
 SoftLogix 5800 Controllers on page 8

7
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideIntroduction to the ABCIP Communication Driver

 CompactLogix Cont rollers on page 8

 FlexLogix Controllers on page 8
 MicroLogix Controllers on page 9
 PLC-5 Controllers on page 9
 SLC500 Cont rollers on page 9

Note: The Optimize for Startup mode is not supported on Logix Cont rollers using firmware version 21 or
above. For more information, see Logix5000 Optimization Mode on page 52.

ControlLogix Controllers
The 1756-EWEB enhanced Web-server module provides both CIP communications and Internet
browser web-services. ABCIP Communication Driver supports ONLY CIP communications. The AB CIP
Communication Driver is capable of accessing multiple Cont rolLogix processors in a single chassis.
 All Cont rolLogix processors (1756-series processors ) directly accessible from t he Ethernet using the
Cont rolLogix Ethernet or EtherNet/IP Bridge module (1756-E NE T, 1756-E NB T, 1756-E N2T, or
1756-EWEB) through the backplane.
 All ControlLogix processors (1756-series processors ) that are Accessible through the Cont rolLogix
Gateway from the Cont rolNet net work by means of the ControlLogix ControlNet Bridge module
(1756-CNB/CNBR or 1756-CN2/ CN2R).
 All Cont rolLogix 1756-RM and 1757-SRM processors directly accessible from the Ethernet using the
Cont rolLogix Ethernet or Et herNet/ IP Bridge module (1756 -EN2T for t he 1756-RM or 1756-E NB T for
the 1757-S RM) or accessible through the ControlLogix Gateway from the ControlNet Bridge module
(1756-CN2R).

GuardLogix Controllers
 All GuardLogix Integrated Safety processors (1756-LSP & 1756-L6xS ) directly accessible from the
Ethernet using the Cont rolLogix Ethernet or EtherNet/IP Bridge module (1756-E NB T or
1756-EWEB) through the backplane.
 All GuardLogix Integrated Safety processors (1756-LSP & 1756-L6xS ) accessible through the
Cont rolLogix Gateway from the ControlNet network by means of the ControlLogix ControlNet Bridge
module (1756-CNB/ CNB R or 1756-CN2).

SoftLogix 5800 Controllers

 All SoftLogix 5800 controllers (1789-series) directly accessible from the Ethernet on an industrial or
desktop PC.

CompactLogix Controllers
 All CompactLogix processors (5069/1769/1768 -series) directly accessible from the Ethern et using
the integrated EtherNet/IP port.
 All CompactLogix processors (1769/1768-series) accessible from the Ethernet via the EtherNet/IP
interface module for CompactLogix/MicroLogix (1761-NE T-E NI).

FlexLogix Controllers
 All FlexLogix processors (1794-series) accessible from the Ethernet using the EtherNet/IP
communications daughter-card (1788-E NB T).

8
Introduction to the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

 All FlexLogix processors (1794-series) accessible through the ControlLogix Gateway from the
Cont rolNet net work by means of the ControlNet daughter-card (1788-CNC).

MicroLogix Controllers
 All MicroLogix 1100 processors (1763-series) and 1400 processors (1766-series) directly accessible
from the Ethernet using the integrat ed EtherNet/IP port.
 All MicroLogix 1000/ 1200/1500 processors accessible from the Ethernet via the Ethernet/IP
interface module for CompactLogix/MicroLogix (1761-NE T-E NI) series B or higher.
 All MicroLogix 1000/ 1200/1500 processors accessible from the DH485 network using the
RS-232C-to-DH485 Advanced Interface Converter module (1761-NE T-A IC) to connect to the Data
Highway Plus net work through a DH+ -to-DH485 Bridge module (1785-KA5) and routed through the
Cont rolLogix Gat eway by means of the ControlLogix DH+/ RIO Bridge module (1756 -DHRIO) to
Ethernet.

PLC-5 Controllers
 All PLC-5 processors (1785-series ) accessible through the ControlLogix Gateway from the Data
Highway Plus net work by means of the ControlLogix DH+/ RIO Bridge module (1756 -DHRIO)
 All ControlNet-capable PLC-5 processors (1785-series) accessible through the ControlLogix
Gateway from the Cont rolNet net work by means of the ControlLogix ControlNet Bridge module
(1756-¬CNB/CNB R).

SLC500 Controllers
 All SLC 5/05 processors accessible from the Ethernet using the built-in EtherNet/IP int erface.
 All SLC 5/03, /04 processors (1747-series) accessible from the Ethernet using the EtherNet/IP
interface module (1761-NE T-E NI).
 All SLC 5/04 processors (1747-series) accessible through the ControlLogix Gateway from the Data
Highway Plus net work by means of the ControlLogix DH+/ RIO Bridge module (1756 -DHRIO).
 All SLC 5/03, /04, /05 processors (1747-series) linked to the SLC500 ControlNet RS-232 interface
module (1747-KFC15) accessible through the ControlLogix Gateway from t he Cont rolNet net work by
means of the ControlLogix ControlNet Bridge module (1756-CNB ).
 All SLC 5/03, /04, /05 processors (1747-series) accessible from the DH485 network using the
RS-232C-to-DH485 Advanced Interface Converter module (1761-NE T-A IC) to connect to the Data
Highway Plus net work through a DH+ -to-DH485 Bridge module (1785-KA5) and routed through the
Cont rolLogix Gat eway by means of the ControlLogix DH+/ RIO Bridge module (1756 -DHRIO) to the
Ethernet.
While primarily intended for use with InTouch®, the Communication Driver may be used by any Microsoft
Windows program capable of acting as a DDE, FastDDE, SuiteLink™, or OP C client.

Supported Topologies
This ABCIP Communication Driver communic ates with supported Allen -Bradley families of
CompactLogix, ControlLogix, FlexLogix, GuardLogix, MicroLogix, PLC-5, SLC500, and SoftLogix 5800
controllers across:
 Cont rolNet
 Data Highway 485 (DH485)
 Data Highway Plus (DH+)
 DeviceNet

9
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideIntroduction to the ABCIP Communication Driver

 Ethernet
Before attempting to configure your Communication Driver, you should determine the hierarchical
structure of your network/controller environment.

10
Introduction to the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Dual ENB Routing Topology

The ABCIP Communication Driver can connect to a ControlLogix rack via an ENB module on the same
subnet, and route from the backplane to a second ENB module on a different subnet.
The ControlLogix rack becomes a rout er between two subnets. The AB CIP Communication Driver can
connect to the following controllers and devices on a second Ethernet subnet:
 Cont rolLogix
 CompactLogix
 FlexLogix
 MicroLogix
 SLC500

Note: Only one Ethernet subnet hop is supported.

Device-Level Ring (DLR) Topology

DLR is network technology provided by Rockwell Automation to enable Ethernet ring net work topologies
at the device level. The DLR protoc ol enables Ethernet devices to connect directly to neighboring nodes
through dual network ports to form a ring topology.
When a DLR detects a break in the ring, it provides alternate routing of the data to help recover the
network.
The ABCIP Communication Driver provides data connectivity to other supported controllers connected
on the same DLR net work. The computer where the ABCIP Communication Driver is installed must be
connected to the DLR network via the 1783-E TAP device. Following is a sample DLR topology:

Windows Firewall Considerations

If the Communication Driver runs on a computer with a firewall enabled, a list of application names or port
numbers must be put in the firewall exception list so the Communication Driver can function correctly.
The Communication Driver installation program makes the required entries in the firewall exception list
for you.

11
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideIntroduction to the ABCIP Communication Driver

The following applications are added to the firewall exception list on the computer where the
Communication Driver run-time application is installed:
 ABCIP.exe
 aaLogger. exe
 DASAgent.exe
 dllhost.exe
 mmc.exe
 OPCEnum.exe
 Slssvc.exe
The following port numbers are added to the firewall exception list on the computer where the
Communication Driver run-time application is installed:
 5413 - TCP port for slss vc.exe
 445 - TCP port for file and print er sharing
 135 - TCP port for DCOM
The following applications are added to the firewall exception list on the computer where the OI Server
Manager (configuration part) is installed:
 aaLogger. exe
 dllhost.exe
 mmc.exe
The following port numbers are added to the firewall exception list on the comput er where the OI Server
Manager (configuration part) is installed:
 445 - TCP port for file and print er sharing
 135 - TCP port for DCOM
Un-installing the Communic ation Driver does not remove the firewall exception list entries. You must
delete the firewall exception list entries manually. For more information on how to do this, see your
firewall or Windows security documentation.

12
 AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

C HAPTER 2
Configuring the ABCIP Communication
Driver

Configuring Port Objects for the ABCIP Communication

Driver
Network Communication Bridge/Int erface Modules are the communication links between the ABCIP
Communication Driver and its supported Allen-B radley controllers. You must create t hese links wit hin the
OI Server Manager hierarchy to bridge/ rout e control and in formation dat a between different networks to
target controllers.
This is accomplished by creating P ort Objects. These Port Objects simulate the physical hardware layout
and must be built to establish communications with each of the controllers. Once you ha ve built the
ABCIP hierarchy, you can configure the respective devices for communications. Finally, you can create
the desired Device Groups for each controller.
Before you add these Ports in the SMC, you need to identify your hardware topology to the devi ces being
connected.
Once you have established this hierarchy you will then add, rename, or delete Port objects to accurately
represent how your network is organized.

Adding, Renaming, Deleting Port Objects

Use the procedures described in this section to add, rename, or delete port objects.

Adding a Port
The first step in specifying the network bet ween the Communication Driver and a device is to add Port
objects. After you add the necessary Ports depicting your network, you will then be able to add and
communicate with your devices.
To add a port
1. Open the OI Server Manager in the SMC.
2. Locate and expand the target Communication Driver group hierarchy you wish to add ports to.
3. Right -click the default Configuration node and select the applicable Add Port Object. The console
tree will now show the new port with its default port name selected.
4. Edit the name as needed and press Enter.

Renaming a Port
After you create ports in the OI Server Manager, it may be necessary to rename them to work with your
client applications.

13
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideConfiguring the ABCIP Communication Driver

To change an existing port object name

1. In the OI Server Manager, expand the Communication Driver hierarchy tree t o display the target port
object node you wish to rename.
2. Select and right-click the port object’s name (or press the <F2> key). Click Rename.
3. Type the new name and press Enter.

Note: Changing the port name prevents clients from registering data using the old name. Data for
existing queries is set to bad quality. It is recommended not to make changes to parameters like the Port
name after you develop a large client application.

Deleting a Port
If your hardware network topology is changed you may need to delet e a port object.
When you delete a port, all nodes below the port in its hierarchy (child nodes) are also deleted. If a client
application requests new data from a deleted port or a node on a deleted port, the request is rejected.
Data for existing queries is set to bad quality.
To delete a port
1. In the OI Server Manager, expand the Communication Driver hierarchy tree to display the target port
object node you wish to delete.
2. Right -click the port object node to be delet ed and click Delete.
3. Read the warning and then click Yes. The port object and all nodes (devices ) below it in the
hierarchy are deleted.

Configuring ABCIP Communication Driver Ports

The AB CIP Communication Driver hierarchy in the OI Server Manager starts with the P ORT_CIP Object,
followed by the support ed communication -interface/gateway modules that allow the Communication
Driver to access the s upported networks and devic es. The logical endpoint for each branch of the AB CIP
hierarchy tree is always a Processor Type node whic h represents the controller device.
The following sections detail the steps necessary to configure your Communication Driver Port Objects
according to your network type.

Note: Before attempting to configure your Communication Driver, you should determine the hierarchical
structure of your device/net work environment.

CIP Port Connection Set-up

The Communication Driver hierarc hy tree under the OI Server Manager starts at the PORT_CIP port
object. It is a logical representation of the Ethernet port for CIP communications on a computer.

Note: Only one PORT_CIP connection is allowed per ABCIP Communication Driver.

To create PORT_CIP objects from the Configuration branch

1. Select and right-click on Configuration.
2. Select Add PORT_CIP Connection from the shortcut menu. A New_PORT_CIP_000 object is
created.
3. Rename the newly created object as appropriate. The Port_CIP_000 Parameters configuration
view is displayed in the Configuration branch of the hierarchy.
This configuration view has two parameters, one of which is configurable:

14
Configuring the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

 Port Type: The information is provided aut omatically by the OI Server Manager (CIP).
 Maximum Queued Msgs: The default number of unconnected messages that the Communication
Driver can send to a device before a reply is received. When this number is reached, the
Communication Driver queues messages until a reply is received from the device.
o The valid range is 1 - 40.
o The default value is 4.

Note:
- Applies to MicroLogix or SLC500 Connections, only if not using CIP Connections.
- Simultaneous Message Configuration for Logix Controllers is set in Device Configuration.

The Ethernet Network

Through the PORT_CIP object, the ABCIP Communication Driver accesses data from the ControlLogix,
CompactLogix, FlexLogix, GuardLogix, MicroLogix, SLC500, and SoftLogix 5800 controllers on the
Ethernet network that uses the EtherNet/IP protocol.

ENB_CLX Object
The ENB_CLX object represents the physical Allen-Bradley EtherNet/IP Communications module within
a ControlLogix chassis.
o 1756-E NE T
o 1756-E NB T
o 1756-E N2T
o 1756-EWEB
The ENB _CLX object is hosted by CIP.

Note: A maximum of 65535 ENB_CLX objects can be created for the Communication Driver.

To add ENB_CLX objects to your ABCIP hierarchy

1. Select and right-click on the New_PORT_CIP_000 object.
2. Select Add ENB_CLX Connection from the shortcut menu. A New_ENB _CLX_000 object is
created.
3. Rename the newly created object as appropriate. The ENB_CLX Parameters configuration view is
displayed.
This configuration view has three parameters, two of which are configurable:
 Module Type: Information provided automatically by the OI Server Manager (Ethernet Comm).
 Host Name: Host Name or IP Address of the destination 1756-E NE T/ENB T/EN2T/EWEB module.
o The Host Name is defined in the system Host file, usually found in:
\Windows\system32\drivers\etc\hosts folder.
o Type in the network address where the PLC is located (for ex ample, "10. 11.12.13") or type in a
host name if one is defined in the LocalHost list. The number of characters cannot be more than
255. The field cannot be blank.

Note: The Host Name defaults to the LocalHost. If the LocalHost is selected and deleted, resulting in
a blank Host Name box, and you apply the changes, this will result in an error message.

15
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideConfiguring the ABCIP Communication Driver

Important: If setting up a Soft Logix or GuardLogix devic e, the host or IP address of the
corresponding SoftLogix or physical GuardLogix device must be entered in the Ethernet/IP Bridge
Module (ENB ) node within the ABCIP Communication Driver hierarchy to establish communications
with the device. For more information, see SoftLogix 5800 Controllers on page 8 or GuardLogix
Cont rollers on page 8.
 Connection Timeout: Time (in milliseconds) allowed for establishing a socket connection t o a target
devic e.
o The valid range is 10 - 10000 milliseconds.
o The default value is 2000.
o The connection timeout is used if the object is underneath PORT_CIP.

BACKPLANE_CLX Object
The BackPlane_CLX object represents the physical backplane of an Allen -Bradley ControlLogix
controller chassis.
This object is hosted by the ENB_CLX and CNB_P ort_CLX objects.

Note: Only one instanc e of the BACKPLA NE_CLX object can be created per ENB _CLX and
CNB _Port_CLX branch. The Communication Driver is capable of operating with multiple ControlLogix
processors in a single backplane.

To add the BACKPLANE_CLX object to your ABCIP hierarchy

1. Select and right-click on the New_ENB_CLX_000 object.
2. Select Add BACKPLANE_CLX Connection from the shortcut menu. The
New_BA CKPLANE _CLX_000 object is created.
3. Rename the newly created object as appropriate. The BACKPLANE_CLX Parameters
configuration view is displayed.
This configuration view has one element:
 Device Type: The information is provided aut omatically by the OI Server Manager (BackPlane).

PORT_ENB Object
The Port _ENB object represents the physical Ethernet port for the Allen-B radley Ethernet Net work
bridge module.
This object is hosted by the BACKPLA NE_CLX object.
To add the PORT_ENB object to your ABCIP hierarchy
1. Select and right-click on the New_BACKPLA NE_CLX_000 object.
2. Select Add PORT_ENB Connection from the shortcut menu. The New_PORT_ENB _000 object is
created.
3. Rename the newly created object as appropriate. The PORT_ENB Parameters configuration view
is displayed.
This configuration view has the following elements:
 Module Type: Information provided automatically by the OI Server Manager (Ethernet
Communication).
 Slot Number: A sequential number beginning with 0 (zero) assigned to each slot in a ControlLogix
chassis.
o The slot number indicates where the module resides in the parent backplane.
o The valid range is 0 - 16.

16
Configuring the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

o The default value is 0 (zero).

LOGIX5000_CLX Object
The Logix5000_CLX object is a logical representation of the Allen -Bradley ControlLogix processor
modules within a ControlLogix chassis.
o 1756-L1
o 1756-L55
o 1756-L6x
o 1756-L7x
The Logix5000_CLX object is also a logical represent ation of the following Allen -Bradley processor
modules:
o SoftLogix 5800
o GuardLogix 1756-L6xS
This object is hosted by BackPlane_CLX.
To add the LOGIX5000_CLX object to your ABCIP hierarchy
1. Select and right-click on the New_BACKPLANE_CLX _000 object.
2. Select Add LOGIX5000_CLX Connection from the shortcut menu. The
New_LOGIX5000_CLX_000 object is created.
3. Rename the newly created object as appropriate. The Logix5000_CLX Parameters configuration
view is displayed.
This configuration view has nine parameters, eig ht of which are configurable:
 Processor Type: Information provided automatically by the OI Server Manager (Cont rolLogix
/GuardLogix /SoftLogix).
 Slot Number: A sequential number beginning with 0 (zero) assigned to each slot in a ControlLogix
chassis.
o The slot number indicates where the module resides in the parent backplane.
o The valid range is 0 - 16.
o The default value is 0 (zero).
 Reply Timeout: Time (in seconds) the Communication Driver will wait for the acknowledgement
after it sends out a message. The message will be resent when time-out occurs.
o The valid range is 1 - 300 seconds.
o The default value is 15.
 Max CIP Connections: The maximum number of CIP connections that can be originated from the
Communication Driver to this devic e.
o The valid range is 1 - 31.
o The default value is 4 (four).

Note: For each CIP connection established, the PLC allocates certain resources to handle the
connection. If too many CIP connections are established by the Communication Driver, the PLC
processor allocates more resources for the CIP, and other operations will suffer. For example, wit h
31 connections, the data updates become extremely sluggish since the PLC ran out of resources to
handle the runtime logic and updating the control items.

 Optimization Mode (For detailed information, see Logix5000 Optimization Mode on page 52):

17
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideConfiguring the ABCIP Communication Driver

o No optimization: The server uses the most basic communication method available by using the
tag name for eac h communication with the controller. The tag dat abase will be uploaded from
the processor to validate the tag names.
o Optimize for read (Default ): All tags are accessed by predefining messages in the controller,
thus optimizing blocks of information from the controller. Initialization of this mode requires that
these message blocks are built when connecting to the controller, therefore start up time will
require more time. This mode is most effective with a large number of tags on continuous scan.
o Optimize for startup time: This option provides the best overall performance. All tags are
accessed from the Logix processor using the device’s memory location table. If this option is
checked, the ‘Auto Synchronize Tag’ option is checked automatically and cannot be unchecked.

Note: "Optimize for Startup time" is not supported on Logix Controllers using firmware version
21 or above. For more information, see Logix5000 Optimization Mode on page 52.

 Optimize User Defined Data Types: The optimization for reading structures is enabled when
selected (Default is unchecked). For more detailed information, see UDT Optimization on page 53.
If selected, the server will retrieve the whole structure in one packet provided the size of the structure
is 488 bytes or less.
 Tag Database Options: Three options are selectable to implement manual or automated updat es of
the Logix processor’s tag database. For more information, see Logix5000 Online Tag Management
on page 55
o Auto Load Tags on Startup (Default)
o Auto Synchronize Tags
o Use Persisted Tags (Default)

Note: If "Optimize for startup time" is selected, the "Auto Synchronize Tags" option will be
automatically selected and will not be changeable (option will be dimmed). The Communication
Driver will need to synchronize physical address tags from the device.

Important: Support for secured Logix5000 controllers will affect the way the ’Auto Synchronize
Tags’ and ’Persisted Tags’ behave. For detailed information, see Accessing Secured
Logix5000-series Controllers on page 58.

ENB_FLX Object
The ENB _FLX object represents the physical Allen-Bradley FlexLogix Ethernet Communication
Daughter Card.
o 1788-E NB T
This object is hosted by the CIP Net work Object.

Note: A maximum of 65535 ENB_FLX objects can be created for the Communication Driver.

To add ENB_FLX objects to your ABCIP hierarchy

1. Select and right-click on the New_PORT_CIP_000 object.
2. Select Add ENB_FLX Connection from the shortcut menu. A New_E NB_FLX_000 object is
created.
3. Rename the newly created object as appropriate. The ENB_FLX Parameters configuration view is
displayed.
This configuration view has three parameters, two of which are configurable:

18
Configuring the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

 Module Type: Information provided automatically by the OI Server Manager (Ethernet

Communication).
 Host Name: The Host Name or IP Address of the destination 1788-E NB T module.
o The Host Name is defined in the system Host file, usually found in:
\Windows\system32\drivers\etc\hosts folder.
o The number of characters cannot be more than 255. The field cannot be blank.

Note: The Host Name defaults to the LocalHost. If the Loc alHost is selected and deleted, resulting in
a blank Host Name box, and you apply the changes, this will result in an error message.

 Connection Timeout: Time (in milliseconds) allowed for establishing a socket connection to a target
devic e.
o The valid range is 10 - 10000 milliseconds.
o The default value is 2000.
o The connection timeout is used if the object is underneath PORT_CIP.

BACKPLANE_FLX Object
The BackPlane_FLX object represents the physical backplane of an Allen-B radley FlexLogix controller
assembly.
This object is hosted by ENB_FLX and CNB _Port _FLX.

Note: The Communication Driver is capable of operating with multiple FlexLogix processors in a single
backplane. Only one instance of the BACKPLA NE_FLX object can be creat ed per ENB _FLX branc h.

To add the BACKPLANE_FLX object to your ABCIP hierarchy

1. Select and right-click on the New_ENB _FLX_000 object.
2. Select Add BACKPLANE_FLX Connection from the shortcut menu. A
New_BA CKPLANE _FLX_000 object is created.
3. Rename the newly created object as appropriate. The BACKPLANE_FLX Parameters
configuration view is displayed.
This configuration view has one element:
Device Type: The information is provided aut omatically by the OI Server Manager (Backplane).

LOGIX_FLX Object
The Logix_FLX object represents the physical Allen-B radley FlexLogix proc essor module.
o 1794-Lxx
This object is hosted by BACKPLANE _FLX.
To add the LOGIX_FLX object to your ABCIP hierarchy
1. Select and right-click on the NEW_BA CKPLANE _FLX_000 object.
2. Select Add LOGIX_FLX Connection from the shortcut menu. The New_LOGIX_FLX_000 object is
created.
3. Rename the newly created object as appropriate. The LOGIX_FLX Parameters configuration view
is displayed.
This configuration view has nine parameters, eight of which are configurable:
Processor Type: (not configurable) Information provided automatically by the OI Server Manager
(FlexLogix).

19
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideConfiguring the ABCIP Communication Driver

Slot Number: A sequential number beginning with 0 (zero) assigned to each slot in a FlexLogix
chassis.
o The slot number indicates where the module resides.
o The valid range is 0 - 16.
o The default value is 0.
Reply Timeout: Time (in seconds) the Communication Driver will wait for the acknowledgement
after it sends out a message. The message will be resent when time-out occurs.
o The valid range is 1 - 300.
o The default value is 15.
Max CIP Connections: The maximum number of CIP connections that can be originated from the
Communication Driver to this devic e.
o The valid range is 1 - 31.
o The default value is 4 (four).

Note: For each CIP connection established, the PLC allocates certain resources to handle the
connection. If too many CIP connections are established by the Communication Driver, the PLC
processor allocates more resources for the CIP, and other operations will s uffer. For example, wit h
31 connections, the data updates become extremely sluggish since the PLC ran out of resources to
handle the runtime logic and updating the control items.

Optimization (For det ailed information, see Logix5000 Optimization Mode on page 52):
o No optimization: The server uses the most basic communication method available by using the
tag name for eac h communication with the controller. The tag dat abase will be uploaded from
the processor to validate the tag names.
o Optimize for read (Default): All tags are accessed by predefining messages in the controller, thus
optimizing blocks of information from the controller. Initialization of this mode requires that these
message blocks are built when connectin g to the controller, therefore startup time will require
more time. This mode is most effective with large number of tags on continuous scan.
o Optimize for startup time: This option provides the best overall performance. All tags are
accessed from the Logix processor using the device’s memory location table. If this option is
checked, the ‘Auto Synchronize Tag’ option is checked automatically and cannot be unchecked.
Note: "Optimize for Startup time" is not supported on Logix Controllers using firmware versi on
21 or above. For more information, see Logix5000 Optimization Mode on page 52.

Optimize User Defined Data Types: The optimization for reading structures is enabled when
selected (Default is unchecked). For more detailed information, see UDT Optimization on page 53.
o If selected, the server will retrieve the whole structure in one packet provided the size of the
structure is 488 bytes or less.
Tag Database Options: Three options are s electable to implement manual or automated updates of
the Logix processor’s tag database. For more information, see Logix5000 Online Tag Management
on page 55.
o Auto Load Tags on Startup (Default)
o Auto Synchronize Tags
o Use Persisted Tags (Default)

Note: If the Optimization setting is selected for "Optimize for startup time", the "Auto Synchronize Tags"
option is automatically selected and unchangeable (dimmed). The Communication Driver will need to
synchronize physical address tags from the device.

20
Configuring the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Important: Support for secured Logix5000 controllers will effect the way the ’Auto Synchronize Tags’
and ’Persisted Tags’ behave. For detailed information, see Accessing Secured Logix5000-s eries
Cont rollers on page 58.

ML_EN Object
The ML_EN object represents the physical Allen-B radley MicroLogix processor with the built-in
EtherNet/IP port or coupled with the Ethernet Interface module for MicroLogix and CompactLogix
(1761-NE T-ENI).
 1763-L16xxx
 1761-L10xxx, 1761-L16xxx, 1761-L20xxx, 1761-L32xxx
 1762-L24xxx, 1762-L40xxx
 1764-LSP, 1764-LRP
This object is hosted by CIP Network Object
To add ML_EN objects to your ABCIP hierarchy
1. Select and right-click on the New_PORT_CIP_000 object.
2. Select Add ML_EN Connection from the shortcut menu. A New_ML_EN_000 object is created.
3. Rename the newly created object as appropriate. The ML_EN Parameters configuration view is
displayed.
This configuration view has six parameters, five of which are configurable:
 Processor Type: (not configurable) Information provided automatically by the OI Server Manager
(MicroLogix).
 Host Name: The Host Name or IP Address of the destination MicroLogix processor or
1761-NE T-E NI module connected to a MicroLogix processor.
o The Host Name is defined in the system Host file, usually found in:
\Windows\system32\drivers\etc\hosts folder.
o The number of characters cannot be more than 255. The field cannot be blank.
 Reply Timeout: Time (in seconds) the Communication Driver will wait for the acknowledgement
after it sends out a message. The message will be resent when time-out occurs.
o The valid range is 1 - 300 seconds.
o The default value is 15.
 Connection Timeout: Time (in milliseconds) allowed for establishing a socket connection to a target
devic e.
o The valid range is 10 - 10000 milliseconds.
o The default value is 2000.
o The connection timeout is used if the ML_EN object is beneath PORT_CIP.
 Use CIP Connection: This option specifies if the CIP connection should be used to communicate
with the MicroLogix controller. It must be selected to support MicroLogix model 1100/1400 -series
controllers with direct CIP connection. It is optional for all other MicroLogix models.
o The default value is True.

Note: The number of CIP connections in the controllers are limited (S ee Max CIP Connections
below).

21
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideConfiguring the ABCIP Comm unication Driver

 Maximum CIP Connections: The maximum number of CIP connections which can be originated
from the Communication Driver to this device.
o The valid range is 1 - 31.
o The default value is 1 (one).

Note: Max CIP Connections setting available only if the CIP connection is selected.

The logic al endpoint for each branch of the ABCIP hierarc hy tree is always a Processor Ty pe node,
which represents the controller device.

ENB_CPLX Object
The ENB _CPLX object represents the physical integrated EtherNet/IP port on the Allen -Bradley
CompactLogix Ethernet processor.
This object is hosted by CIP Network Object

Note: A maximum of 65536 ENB_CPLX objects can be created for the Communication Driver.

To add ENB_CPLX objects to your ABCIP hierarchy

1. Select and right-click on the New_PORT_CIP _000 object.
2. Select Add ENB_CPLX Connection from the shortcut menu. A New_ENB_CPLX_000 object is
created.
3. Rename the newly created object as appropriate. The ENB_CPLX Parameters configuration view
appears.
This configuration view has three parameters, two of which are configurable:
 Module Type: (not configurable) Information provided automatically by the OI Server Manager
(Ethernet Communication).
 Host Name: The Host Name or IP Address of the destination Ethernet-capable CompactLogix
processor.
o The Host Name is defined in the system Host file, usually found in:
\Windows\system32\drivers\etc\hosts folder.
o The number of characters cannot be more than 255. The field cannot be blank.

Note: The Host Name defaults to the LocalHost. If the LocalHost is selected and deleted, resulting in
a blank Host Name box, and you apply the changes, this will result in an error message.

 Connection Timeout: Time (in milliseconds) allowed for establishing a socket connection to a target
devic e.
o The valid range is 10 - 10000 milliseconds.
o The default value is 2000.
o The connection timeout is used if the E NB_CP LX object is beneath PORT_CIP.

ENI_CPLX Object
The ENI_CPLX object represents the physical Allen-B radley Ethernet Int erface module for MicroLogix
and CompactLogix (1761-NE T-ENI).
o 1761-NE T-E NI Module
This object is hosted by CIP Network Object

Note: A maximum of 65535 ENI_CPLX objects can be creat ed for the Communication Driver.

22
Configuring the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

To add ENI_CPLX objects to your ABCIP hierarchy

1. Select and right-click on the New_PORT_CIP _000 object.
2. Select Add ENI_CPLX Configuration from the shortcut menu. A New_E NI_CP LX_000 object is
created.
3. Rename the newly created object as appropriate. The ENI_CPLX Parameters configuration view is
displayed.
This configuration view has three parameters, two of which are configurable:
 Module Type: (not configurable) Information provided automatically by the OI Server Manager
(Ethernet Interface).
 Host Name: The Host Name or IP Address of the destination 1761 -NE T-E NI module.
o The Host Name is defined in the system Host file, usually found in:
\Windows\system32\drivers\etc\hosts folder.

Note: The Host Name defaults to the LocalHost. If the LocalHost is selected and deleted, resulting in
a blank Host Name box, and you apply the changes, this will result in an error message.

 Connection Timeout: Time (in milliseconds) allowed for establishing a socket connection to a target
devic e.
o The valid range is 10 - 10000 milliseconds.
o The default value is 2000.
o The connection timeout is used if the E NI_CP LX object is beneath PORT_CIP.

BACKPLANE_CPLX Object
The BACKPLA NE_CPLX object represents the physical backplane of a CompactLogix controller
assembly.
This object is hosted by ENB_CPLX and ENI_CPLX.

Note: The Communication Driver is capable of operating with multiple CompactLogix proc essors in a
single backplane. Only one instanc e of the BACKPLA NE_CP LX object can be creat ed per ENB _CPLX
or ENI_CPLX branc h.

To add the BACKPLANE_CPLX object to your ABCIP hierarchy

1. Select and right-click on the New_ENB _CPLX_000 or New_E NI_CPLX_000 object.
2. Select Add BACKPLANE_CPLX Connection from the shortcut menu. The
New_BA CKPLANE _CP LX_000 object is created.
3. Rename the newly created object as appropriate. The BACKPLANE_CPLX Parameters
configuration view appears.
This configuration view has one element:
Device Type: The information is provided aut omatically by the OI Server Manager (Backplane).

LOGIX_CPLX Object
The LOGIX_CPLX object represents the physical CompactLogix processor module.
o 1768-Lxx
o 1769-Lxx
This object is hosted by BACKPLANE _CP LX.

23
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideConfiguring the ABCIP Communication Driver

To add the LOGIX_CPLX object to your ABCIP hierarchy

1. Select and right-click on the NEW_BACKPLANE_CPLX_000 object.
2. Select Add LOGIX_CPLX Connection from the shortcut menu. The New_LOGIX_CPLX_000
object is created.
3. Rename t he newly created object as appropriate. The LOGIX_CPLX Parameters configuration view
is displayed.
This configuration view has nine parameters, eight of which are configurable:
 Processor Type: (not configurable) Information provided automatically by the OI Server Manager
(LOGIX5000).
 Slot Number: A sequential number beginning with 0 (zero) assigned to each slot in a Logix5000
chassis.
o The slot number indicates where the module resides.
o The valid range is 0 - 16.
o The default value is 0 (zero).
 Reply Timeout: Time (in seconds) the Comm unication Driver will wait for the acknowledgement
after it sends out a message. The message will be resent when time-out occurs.
o The valid range is 1 - 300.
o The default value is 15.
 Max CIP Connections: The maximum number of CIP connections which can be originated from the
Communication Driver to this devic e.
o The valid range is 1 - 31
o The default value is 4 (four)

Note: For each CIP connection established, the PLC allocates certain resources to handle the
connection. If too many CIP connections are established by the Communication Driver, the PLC
processor allocates more resources for the CIP, and other operations will suffer. For example, wit h
31 connections, the data updates become extremely sluggish since the PLC ran out of resources to
handle the runtime logic and updating the control items.

 Optimization (For det ailed information, see Logix5000 Optimization Mode on page 52):
o No optimization: The server uses the most basic communication method available by using the
tag name for eac h communication with the controller. The tag dat abase will be uploaded from
the processor to validate the tag names.
o Optimize for read (Default): All tags are accessed by predefining messages in the controller, thus
optimizing blocks of information from the controller. Initialization of this mode requires that these
message blocks are built when connecting to the controller, therefore startup time wi ll require
more time. This mode is most effective with large number of tags on continuous scan.
o Optimize for startup time: This option provides the best overall performance. All tags are
accessed from the Logix processor using the device’s memory location table. If this option is
checked, the ‘Auto Synchronize Tag’ option is checked automatically and cannot be unchecked.

Note: "Optimize for Startup time" is not supported on Logix Controllers using firmware version
21 or above. For more information, see Logix5000 Optimization Mode on page 52.

 Optimize User Defined Data Types: The optimization for reading structures is enabled when
selected (Default is unchecked). For more detailed information, see UDT Optimization on page 53.

24
Configuring the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

o If selected, the server will retrieve the whole structure in one packet provided the size of the
structure is 488 bytes or less.
 Tag Database Options: Three options are s electable to implement manual or automated updates of
the Logix processor’s tag database. For more information, see Logix5000 Online Tag Management
on page 55.
o Auto Load Tags on Startup (Default)
o Auto Synchronize Tags
o Use Persisted Tags (Default)

Note: If the Optimization setting is selected for "Optimize for startup time", the "Auto Synchronize
Tags" option is automatically selected and unchangeable (dimmed). The Communication Driver will
need to synchronize physical address tags from the device.

Important: Support for secured Logix5000 controllers will affect the way the ’Auto Synchronize
Tags’ and ’Persisted Tags’ behave. For detailed information, see Accessing Secured
Logix5000-series Controllers on page 58.

SLC500_EN Object
The SLC500_E N object represents the physical Allen-Bradley SLC500 and SLC505 processors
connected to an Allen-Bradley Ethernet Interface for MicroLogix and CompactLogix (1761-NE T-ENI).
o 1747-L55x
o 1747-L5xx with 1761-NE T-ENI
This object is hosted by CIP Network Object
To add SLC500_EN objects to your ABCIP hierarchy
1. Select and right-click on the New_PORT_CIP_000 object.
2. Select Add SLC500_EN Connection from the shortcut menu. A New_S LC500_E N_000 object is
created.
3. Rename the newly created object as appropriate. The SLC500_EN Parameters configuration view
is displayed.
This configuration view has six parameters, five of which are configurable:
 Processor Type: (not configurable) Information provided automatically by the OI Server Manager
(SLC500).
 Host Name: The Host Name or IP Address of the destination 1761-NE T-E NI Module.
o The Host Name is defined in the system Host file, usually found in:
\Windows\system32\drivers\etc\hosts folder.
o The number of characters cannot be more than 255. The field cannot be blank.
 Reply Timeout: Time (in seconds) the Communication Driver will wait for the acknowledgement
after it sends out a message. The message will be resent when time-out occurs.
o The valid range is 1 - 300 seconds.
o The default value is 15.
 Connection Timeout: Time (in milliseconds) allowed for establishing a socket connection to a target
devic e.
o The valid range is 10 - 10000 milliseconds.

25
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideConfiguring the ABCIP Communication Driver

o The default value is 2000.

o The connection timeout is used if the SLC500_EN object is beneath PORT_CIP.
 Use CIP Connection: Must be selected to support SLC 5/05-series controllers wit h direct CIP
connection.
o The default value is True.
 Maximum CIP Connections: The maximum number of CIP connections which can be originated
from the Communication Driver to this device.
o The valid range is 1 - 31.
o The default value is 4 (four).

Note: Max CIP Connections setting available only if the direct CIP connection is selected. For each
CIP connection established, the PLC allocates certain resources to handle the connection. If too
many CIP connections are established by the Communication Driver, the PLC processor allocates
more resources for the CIP, and other operations will suffer. For example, with 31 connections, the
data updates become extremely sluggish since the PLC ran out of resources to handle the runtime
logic and updating the control items.

The ControlNet Network

Routing through the CNB_CLX or the CNB _FLX object from Ethernet net work, the ABCIP
Communication Driver accesses data from ControlLogix, GuardLogix, CompactLogix, FlexLogix, PLC-5,
and SLC500 processors over the ControlNet network.

CNB_CLX Object
The CNB_CLX object represents the physical Allen-B radley ControlLogix ControlNet Bridge module.
o 1756-CNB (R)
o 1756-CN2(R)
This object is hosted by BACKPLANE _CLX.
To add the CNB_CLX object to your ABCIP hierarchy
1. Select and right-click on the New_BACKPLANE_CLX _000 object.
2. Select Add CNB_CLX Connection from the shortcut menu. The New_CNB_CLX _000 object is
created.
3. Rename the newly created object as appropriate. The CNB_CLX Parameters configuration view is
displayed.
This configuration view has two parameters, one of which is configurable:
 ModuleType: (not configurable) Information provided automatically by the OI S erver Manager
(ControlNet Communication)
 Slot Number: A sequential number beginning with 0 (zero) assigned to each slot in a ControlNet
communications interface module.
o The slot number indicates where the sub -module resides.
o The valid range is 0 - 16.
o The default value is 0 (zero).

26
Configuring the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

CNB_FLX Object
The CNB_FLX object represents the physical Allen-Bradley FlexLogix ControlNet Communication
Daughter Card.
o 1788-CNC(R)
o 1788-CNF(R)
This object is hosted by BACKPLANE _FLX.
To add the CNB_FLX object to your ABCIP hierarchy
1. Select and right-click on the NEW_BACKPLANE_FLX_000 object.
2. Select Add CNB_FLX Connection from the shortcut menu. The New_CNB _FLX_000 object is
created.
3. Rename the newly created object as appropriate. The CNB_FLX Parameters configuration view is
displayed.
This configuration view has two parameters, one of which is configurable:
 ModuleType: (not configurable) The information is provided automatically by the OI Server Manager
(ControlNet Comm.)
 Slot Number: A sequential number beginning with 0 (zero) assigned to each slot in a FlexLogix
chassis.
o The slot number indicates where the module resides.
o The valid range is 0 - 16.
o The default value is 0.

Note: ABCIP Communication Driver supports single hops from one ControlNet link to another for
accessing data in the target ControlLogix or FlexLogix processor. That is, an additional level of
Logix_CLX or Logix_FLX object can be populated under the respective BACKP LANE_CLX_000 or
BACKPLANE_FLX_000 object along the CNB_CLX or CNB _FLX hierarchy branch.

PORT_CN Object
The Port _CN object represents the physical ControlNet port for the Allen -Bradley ControlNet Bridge
module.
This object is hosted by CNB _CLX and CNB_FLX.
To add the PORT_CN object to your ABCIP hierarchy
1. Select and right-click on the New_CNB_CLX_000 object.
2. Select Add PORT_CN Connection from the shortcut menu. The New_PORT_CN_000 object is
created.
3. Rename the newly created object as app ropriat e. The PORT_CN Parameters configuration view is
displayed.
This configuration view has three parameters, two of which are configurable:
 Port Type: (not configurable) Information provided automatically by the OI Server Manager
(ControlNet ).
 Channel Number: The number of physical channels/ports used on the ControlNet net work.
o Select Channel A or Channel B.
 ControlNet Addre ss: The node address on the ControlNet net work.

27
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideConfiguring the ABCIP Communication Driver

o The valid range is 1 - 99 decimal.

o The default value is 1 (one).

PLC5_CN Object
The PLC5_CN object represents the physical Allen Bradley Cont rolNet -capable PLC-5 processor.
o 1785-LxxC
This object is hosted by PORT_CN.
To add the PLC5_CN object to your ABCIP hierarchy
1. Select and right-click on the New_PORT_CN_000 object.
2. Select Add PLC5_CN Connection from the shortcut menu. The New_PLC5_CN_000 object is
created.
3. Rename the newly created object as appropriate. The PLC5_CN Parameters configuration view is
displayed.
The configuration view contains five parameters, four of whic h are configurable:
 Processor Type: (not configurable) The information is automatically provided (P LC -5).
 ControlNet Addre ss: The node address on the Control Net net work (Octal).
o The valid range is 1 - 99 decimal.
o The default value is 1 (one).
 Source Link ID: The source link ID of the module. This link ID has to match what has been defined
in the ControlNet Routing table for the ControlNet network.
o The valid range is 1 - 199.
o The default value is 1 (one).
 Reply Timeout: Enter the maximum amount of time (in seconds) that the Communication Driver will
wait for a response from the controller.
o The valid range is 1 - 300 seconds.
o The default value is 15 seconds.
 Max CIP Connections: The maximum number of CIP connections which can be originated from the
Communication Driver to this devic e.
o The valid range is 1 - 31.
o The default value is 4 (four).

Note: For each CIP connection established, the PLC allocates certain resources to handle the
connection. If too many CIP connections are established by the Communication Driver, the PLC
processor allocates more resources for the CIP, and other operations will suffer. For example, wit h
31 connections, the data updates become extremely sluggish sinc e the PLC ran out of resources to
handle the runtime logic and updating the control items.

SLC500_CN Object
The SLC500_CN object represents the physical Allen Bradley SLC500 processor coupled with the
Allen-Bradley SLC500 Cont rolNet RS-232 Int erface module (1747-KFC15).
o 1747-L5xx with 1747-KFC15
This object is hosted by PORT_CN.

28
Configuring the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

To add the SLC500_CN object to your ABCIP hierarchy

1. Select and right-click on the New_PORT_CN_000 object.
2. Select Add SLC500_CN Connection from the shortcut menu. The New_SLC500_CN_000 object is
created.
3. Rename the newly created object as appropriate. The SLC500_CN Parameters configuration view
is displayed.
The configuration view contains four paramet ers, three of which are configurable:
 Processor Type: (not configurable) The information is automatically provided (S LC500).
 ControlNet Addre ss: The node address on the ControlNet Network (Octal).
o The valid range is 1 - 99 decimal.
o The default value is 1 (one).
 Reply Timeout: Enter the maximum amount of time (in seconds) that the Communication Driver will
wait for a response from the controller.
o The valid range is 1 - 300 seconds.
o The default value is 15 seconds.
 Max CIP Connections: The maximum number of CIP connections which can be originated from the
Communication Driver to this devic e.
o The valid range is 1 - 31.
o The default value is 4 (four).

Note: For each CIP connection established, the PLC allocates certain resources to handle the
connection. If too many CIP connections are established by the Communication Driver, the PLC
processor allocates more resources for the CIP, and other operations will s uffer. For example, wit h
31 connections, the data updates become extremely sluggish since the PLC ran out of resources to
handle the runtime logic and updating the control items.

CNB_PORT_CLX Object
The CNB_P ort_CLX object is a logical representation of the ControlNet port for the Allen-Bradley
Cont rolNet bridge module.
This object is hosted by PORT_CN.
To add the CNB_PORT_CLX object to your ABCIP hierarchy
1. Select and right-click on the New_PORT_CN_000 object.
2. Select Add CNB_PORT_CLX Connection from the shortcut menu. The
New_CNB_PORT_CLX _000 object is created.
3. Rename the newly created object as appropriate. The CNB_PORT_CLX Parameters configuration
view is displayed.
This configuration view has four parameters, three of which are configurable:
 ModuleType: (not configurable) The information is provided automatically by the OI Server Manager
(ControlNet ).
 Slot Number: A sequential number beginning with 0 (zero) assigned to each slot in the ControlLogix
Cont rolNet Bridge module.
o The slot number indicates where the sub -module resides.
o The valid range is 0 - 16.

29
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideConfiguring the ABCIP Communication Driver

o The default value is 0 (zero).

 Channel Number: The number of physical channels/ports used on the ControlLogix ControlNet
interface module.
o Select Channel A or Channel B.
 ControlNet Addre ss: The node address on the ControlNet net work.
o The valid range is 1 - 99 decimal.
o The default value is 1 (one).

CNB_PORT_FLX Object
The CNB_P ort_FLX object represents the physical ControlNet port for the Allen-B radley FlexLogix
Cont rolNet Communication Daughter Card.
This object is hosted by PORT_CN.
To add the CNB_PORT_FLX object to your ABCIP hierarchy
1. Select and right-click on the New_PORT_CN_000 object.
2. Select Add CNB_PORT_FLX Connection from the shortcut menu. The
New_CNB_PORT_FLX_000 object is created.
3. Rename the newly created object as appropriate. The CNB_P ORT_FLX Parameters configuration
view is displayed.
This configuration view has four parameters, three of which are configurable:
 Module Type: (not configurable) Information provided automatically by the OI Server Manager
(ControlNet ).
 Slot Number: A sequential number beginning with 0 (zero) assigned to each slot in the ControlLogix
Cont rolNet Bridge module.
o The slot number indicates where the sub -module resides.
o The valid range is 0 - 16.
o The default value is 0.
 Channel Number: The number of physical channels/ports used on the ControlLogix ControlNet
interface module.
o Select Channel A or Channel B.
 ControlNet Addre ss: The node address on the ControlNet net work.
o The valid range is 1 - 99 decimal.
o The default value is 1 (one).

CNB_PORT_CPLX Object
The CNB_P ort_CPLX object represents the physical Cont rol Net port for the Allen-Bradley
CompactLogix Cont rolNet processor module.
This object is hosted by PORT_CN.
To add the CNB_PORT_CPLX object to your ABCIP hierarchy
1. Select and right-click on the New_PORT_CN_000 object.
2. Select Add CNB_PORT_CPLX Connection from the shortcut menu. The
New_CNB_PORT_CPLX _000 object is created.

30
Configuring the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

3. Rename the newly created object as appropriate. The CNB_P ORT_CPLX Parameters
configuration view is displayed.
This configuration view has four parameters, three of which are configurable:
 Module Type: (not configurable) The information is provided automatically by the OI S erver
Manager (ControlNet Communication).
 Slot Number: A sequential number beginning with 0 (zero) assigned to each slot in the ControlLogix
Cont rolNet Bridge module.
o The slot number indicates where the sub -module resides.
o The valid range is 0 - 16.
o The default value is 0 (zero).
 Channel Number: The number of physical channels/ports used on the ControlLogix ControlNet
interface module.
o Select Channel A or Channel B.
 ControlNet Addre ss: The node address on the ControlNet net work.
o The valid range is 1 - 99 decimal.
o The default value is 1 (one).

The DeviceNet Network

The following Allen-B radley controllers can be configured to communicat e with I/O data from the
DeviceNet devices for the Communication Driver to access using the following met hods:
 Cont rolLogix controller by means of its DeviceNet Bridge module.
 FlexLogix controller by means of its Devic eNet daughter-card.
 CompactLogix controller by means of its DeviceNet scanner.
 PLC-5 controller by means of its DeviceNet scanner.
 SLC500 cont roller by means of its DeviceNet scanner.
 MicroLogix controller by means of its DeviceNet scanner.
Important: The DeviceNet connectivity is achieved with the DeviceNet scanner attached to the
corresponding controller. The ABCIP Communication Driver does not internally implement the
DeviceNet protocol.

The Data Highway Plus Network

Routing through the DHRIO_CLX object, the ABCIP Communication Driver accesses data from the
PLC-5 and S LC500 processors on the Data Highway Plus network, as well as the MicroLogix proc essors
on the DH485 network via the DH+/DH485 Bridge module (1785-KA5).

DHRIO_CLX Object
The DHRIO_CLX object represents the physical Allen-Bradley Cont rolLogix DH+/RIO Communication
Interface module.
o 1756-DHRIO
This object is hosted by BACKPLANE _CLX.

31
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideConfiguring the ABCIP Communication Driver

To add the DHRIO_CLX object to your ABCIP hierarchy

1. Select and right-click on the New_BACKPLANE_CLX _000 object.
2. Select Add DHRIO_CLX Connection from the shortcut menu. The New_DHRIO_CLX_000 object
is created.
3. Rename the newly created object as appropriat e. The DHRIO_CLX Parameters configuration view
is displayed.
This configuration view has three parameters, two of which are configurable:
 Module Type: (not configurable) Information provided automatically by the OI Server Manager
(DH+/RIO Communication).
 Slot Number: A sequential number beginning with 0 (zero) assigned to each slot in a ControlLogix
DH+/RIO B ridge module.
o The slot number indicates where the sub -module resides.
o The valid range is 0 - 16.
o The default value is 0 (zero).
 Max CIP Connections per Channel: The maximum number of CIP connections allowed per
channel.
o The valid range is 1- 31.
o The default value is 4 (four).

Note: For each CIP connection established, the PLC allocates certain resources to handle the
connection. If too many CIP connections are established by the Communication Driver, the PLC
processor allocates more resources for the CIP, and other operations will suffer. For example, wit h
31 connections, the data updates become extremely sluggish since the PLC ran out of resources to
handle the runtime logic and updating the control items.

PORT_DHP Object
The PORT_DHP object represents the physical DH+ port for the Allen -Bradley DH+/ RIO Communication
Interface e module.
This object is hosted by DHRIO_CLX.
To add the PORT_DHP object to your ABCIP hierarchy
1. Select and right-click on the New_DHRIO_CLX_000 object.
2. Select Add PORT_DHP Connection from the shortcut menu. The New_PORT_DHP_000 object is
created.
3. Rename the newly created object as appropriate. The PORT_DHP Parameters configuration view
is displayed.
4. This configuration view has four parameters, three of which are configurable:
 Port Type: (not configurable) Information provided automatically by the OI Server Manager (DH
Plus).
 Channel Number: The number of physical channels/ports used on the ControlLogix DH+/RIO
Bridge module. Select Channel A or Channel B.
 DH Plus Node Addre ss: The node address on the DH+ network (Octal).
o The valid range is 0 - 77 octal.
o The default value is 1 (one) octal.

32
Configuring the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

 DH Plus Link ID: The DH+ link ID of the channel.

o The link ID is defined in the DHRIO routing table for the channel.
o The valid range is 1 - 199.
o The default value is 1 (one).

SLC500_DHP Object
The SLC500_DHP object represents the physical Allen-Bradley SLC500 processor on the Data Highway
Plus network.
o 1747-L54x
This object is hosted by PORT_DHP.
To add the SLC500_DHP object to your ABCIP hierarchy
1. Select and right-click on the New_PORT_DHP_000 object.
2. Select Add SLC500_DHP Object from the shortcut menu. The New_SLC500_DHP_000 object is
created.
3. Rename the newly created object as appropriate. The SLC500_DHP Parameters configuration view
is displayed.
The configuration view contains three parameters, two of which are configurable:
 Processor Type: (not configurable) The information is automatically provided (S LC500).
 DH Plus Node Addre ss: The node address on the DH+ network (Octal). Select the DH+ node
number from the drop-down box.
o The valid range is 0 - 77 octal.
o The default value is 0 (zero) octal.
 Reply Timeout: Enter the maximum amount of time (in seconds) that the Communication Driver
will wait for a response from the controller.
o The valid range is 1 - 300 seconds.
o The default value is 15 seconds.

M1785KA5_GWY Object
The M1785KA 5_GWY object represents the physical Allen-Bradley DH+/DH485 Gateway (1785-KA5)
Communication module.
o 1785-KA5
This object is hosted by PORT_DHP.
To add the M1785KA5_GWY object to your ABCIP hierarchy
1. Select and right-click on the New_PORT_DHP_000 object.
2. Select Add M1785KA5_GWY Connection from the shortcut menu. The
New_M1785KA5_GW Y_000 object is created.
3. Rename the newly created object as appropriate. The M1785KA5_GW Y Parameters configuration
view is displayed.
There are three parameters in this configuration view, two of which are configurable:
 Module Type: (not configurable) The information is automatically provided (1785 -KA5).
 DH-485 Node Addre ss: The node address on the DH-485 network.

33
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideConfiguring the ABCIP Communication Driver

o Select the DH-485 node number from the drop-down box.

o The valid range is 1 - 31.
o The default value is 1 (one).
 DH-485 Link ID: The DH-485 link ID of the module.
o This link ID has to match what has been defined in the DHRIO Routing table for the DH+ Bridge.
o The valid range is 1 - 199.
o The default value is 1 (one).

ML_DH485 Object
The ML_DH485 object represents the physical Allen-B radley MicroLogix processor coupled with the
Allen-Bradley Advanced Interface Converter for DH485 (1761-NE T-A IC).
o 176x-Lxxx with 1761-NE T-A IC
This object is hosted by M1785KA5_GWY.
To add the ML_DH485 object to your ABCIP hierarchy
1. Select and right-click on the New_M1785KA5_GWY_000 branch.
2. Select Add ML_DH485 Connection from the shortcut menu. The New_ML_DH485_000 object is
created.
3. Rename the newly created object as appropriate. The ML_DH485 Parameters configuration view is
displayed.
The configuration view contains three parameters, two of which are configurable:
 Processor Type: (not configurable) The information is automatically provided (Mic roLogix).
 DH485 Node Addre ss: The node address on the DH485 network.
o The valid range is 0 - 31.
o The default value is 1 (one).
 Reply Timeout: The maximum amount of time (in seconds) that the Communication Driver will wait
for a response from the controller.
o The valid range is 1 - 300 seconds.
o The default value is 15 seconds.

SLC500_DH485 Object
The SLC500_DH485 object represents the physical Allen-Bradley SLC500 processor coupled with the
Allen-Bradley Advanced Interface Converter for DH485 (1761-NE T-A IC).
o 1747-L5xx
This object is hosted by M1785KA5_GWY.
To add the SLC500_DH485 object to your ABCIP hierarchy
1. Select and right-click on the New_M1785KA5_GWY_000 branch.
2. Select Add SLC500_DH485 Connection from the shortcut menu. The New_SLC500_DH485_000
object is created.
3. Rename the newly created object as appropriate. The SLC500_DH485 Parameters configuration
view is displayed.
The configuration view contains three parameters, two of which are configurable:

34
Configuring the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

 Processor Type: (not configurable) The information is automatically provided (S LC500).

 DH485 Node Addre ss: The node address on the DH485 network.
o Valid range is 0 - 31.
o The default value is 1 (one).
 Reply Timeout: The maximum amount of time (in seconds) that the Communication Driver will wait
for a response from the controller.
o The valid range is 1 - 300 seconds.
o The default value is 15 seconds.

Configuring Device Redundancy

The OI Server Manager provides the ability to assign redundant devices for fail -over protection in the
event of device failure. Two devices must be configured in the same Communi cation Driver having
identical item syntax.
Primary and secondary devices will be setup in the REDUNDA NT_DEV ICE object in the SMC, along
with a common item name (ping item) shared by each device to determine device status.
To setup up a REDUNDANT_DEVICE from the configuration branch:
1. Set-up a primary device and hierarchy in the OI Server Manager in the SMC.
Create at least one device item that can be shared between the primary and secondary devices to
determine devic e status.

35
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideConfiguring the ABCIP Communication Driver

2. Set up a secondary device on the same Communication Driver. Once again, create an identical
devic e item within the the secondary device so that device status can be determined.

3. Select and right-click on the Configuration node under the CIP Net work Devic e object.
4. Select Add REDUNDANT_DEVICE Object. An object called New_RE DUNDANT_DEV ICE_000 is
created.

5. Rename the newly created object as appropriate. The New_REDUNDA NT_DEVICE_000

configuration view is displayed in the Configuration branch of the hierarchy.

36
Configuring the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

6. Enter or use the device browser to select the primary and secondary devices. Click the Save icon to
save the hierarchy node configuration.

Note: Unsolicited message configuration is not supported by the device redundant hierarchy.

Important: A Ping item must be specified and be a valid tag in both the primary and secondary
controllers to determine the connection status for $SYS$Status. The Ping item can be a static item in the
devic e such as a firmware version or proc essor type. If the Ping item is invalid or does not exist in the
controller, the failover operation may not work correctly as the value of $SYS$Status may continue to
stay as FALSE in the standby device.

Device Groups and Device Items

The Device Group and Device Item tabs in the OI Server Manager user interface are used to create new,
modify, or delet e device group and item definitions for an object.
For DDE/SuiteLink communications, one or more device group definitions must exist for each controller
that the Communication Driver will communicate with. Each device group (topic ) definition should
contain a unique name for the controller associated with it.

Device Group Definitions

The Device Groups dialog box is displayed by clicking the Device Groups tab in the CIP,
LOGIX5000_CLX, LOGIX_FLX, ML_E N, LOGIX_CPLX, SLC500_E N, PLC5_CN, SLC500_CN,
PLC5_DHP, SLC500_DHP, ML_DH485, SLC500_DH485 node configuration view. The Device Groups
dialog box allows you to add, define, and delete device groups, in addition to configuring default update
intervals and editing update intervals for the objects.

37
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideConfiguring the ABCIP Communication Driver

Note: When you add a new device group, ent er a unique name. When you select another part of the
Communication Driver tree hierarc hy, you are prompted to save the modific ations to the configuration
set.

To create or add device groups

1. Right -click in the Device Groups box.
2. Select the Add command from the shortcut menu.
o When adding a new device group, enter a unique name (up to 32 characters long).
3. Click the Save icon (the floppy disk icon in the upper right corner).
To make edits on device groups
1. In the Name column, double-click on the device group’s name to be edit ed and make the change.
2. In the Update Interval column, double-click on the device group’s value to be edited and make the
change.
3. To enable unsolicited messages, right-click on the device group name, and select Edit to display
Device Group Parameters. Select Support Unsolicited Message s and click OK.
4. Click the Save icon (the floppy disk icon in the upper right corner).
To delete device groups
1. Right -click on the devic e group to be deleted.
2. Select the Delete command from the shortcut menu.
o The OI Server Manager confirmation box is displayed.
3. Click Yes to proceed wit h the deletion.
4. Click the Save icon (the floppy disk icon in the upper right corner).
To configure default update intervals
1. Right -click in the Device Groups box.

38
Configuring the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

2. Select Config Default Update Interval from the shortcut menu.

3. Click the Save icon (the floppy disk icon in the upper right corner).
To edit update intervals
1. Double-click its value in the Update Interval column and make the edit.
o Update Interval is the frequency (in milliseconds) that the Communication Driver acquires data
from the topics associated with that device group.
o Different topics can be polled at different rates in a controller by defining multiple device group
names for the same controller and setting a different Update Interval for eac h device group.

Device Item Definitions

To make it easier to remember lengthy or strictly structured item names, the Communication Driver
enables you to creat e aliases for these item names. For example, it may be easier for you to remember
the item syntax "T4:1.acc" as "Timer1."
The Device Items tab in the OI Server Manager user interface is used to create new, modify, delete,
export, or import device item definitions for an object. The configuration is performed in the Device Items
dialog box, which you can open by clicking the Device Items tab in the LOGIX5000_CLX, LOGIX_FLX,
ML_EN, LOGIX_CPLX, SLC500_EN, PLC5_CN, SLC500_CN, PLC5_DHP, SLC500_DHP, ML_DH485
or SLC500_DH485 node configuration view.
Once the Device Items feature is used to configure item nam es, it provides the Communic ation Driver
with the capability to perform OPC Item browsing. When the Communic ation Driver is running and an
OPC client requests item information, the configured items will show up under the controller hierarchy
node.

Note: Devic e items have the precedence in addressing items in the controller device at run time. Items
request from the client would be searched from the Device Items Name list first before going out to the
controller.

To create or add device items

1. Right -click in the Device Items box.
2. Select the Add command from the shortcut menu.
3. Type the item name (symbolic name) of your choice in the Name column.
o The device item name must be unique and is limited to 32 characters long.

39
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideConfiguring the ABCIP Communication Driver

4. Double-click the line on the Item Reference column and enter the correlated item reference (the
actual I/O item name in the device) for the device item name you have just selected.
o For example, "n7:0."
5. Click the Save icon (the floppy disk icon in the upper right corner).

Note: System items are not valid item references, but Communication Driver -specific system items are
valid.

To rename device items

1. Right -click on the devic e item to be renamed.
2. Select Rename from the shortcut menu, then make the change.
3. Click the Save icon (the floppy disk icon in the upper right corner).
To delete device items
1. Right -click on the devic e item to be deleted from the list.
2. Select the Delete command from the shortcut menu.
3. Click the Save icon (the floppy disk icon in the upper right corner).
To clear all device items
1. Right -click in the Device Items box.
2. Select the Clear All command from the shortcut menu.
o The OI Server Manager confirmation box appears.
3. Click Yes to confirm the deletion.
o All the device items listed will be cleared.

Exporting and Importing Communication Driver Item Data

The Export and Import commands on the shortcut menu enable you to export and import the
Communication Driver item dat a to and from a CSV file, after the configuration of the Device Items has
been completed. These commands will allow you to perform an off-line, large-scale edit on the item data
configured for a controller, and import what has been edited back into the controller configuration.
To export Communication Driver item data to a CSV file
1. Right -click in the Device Items box.
2. Select the Export command from the shortcut menu.
o The Save As dialog box appears.
o The file name has defaulted into "PLCHierarchyNodeName.cs v," within the
current-system-configured default directory.
3. Accept the defaults to save the file or rename the file if appropriate.
o The file is saved as New_PLC5_DHP_000.cs0v.

40
Configuring the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

o It is editable in Microsoft Excel.

The file can now be edited off-line. It contains one row for each item configured wit h two columns, Name
and Item Reference, res pectively.
To import Communication Driver item data from a CSV file
1. Right -click in the Device Items box.
2. Clear all the item data you wish to replace with the edited.cs v file by selecting the Clear All
command.
o The OI Server confirmation box is displayed.
3. Click Yes to confirm the deletion.
o The data will be cleared.
4. Select the Import command from the shortcut menu.
o The Open dialog box appears.
o It defaults to the .csv file extension within the current -system-configured default directory.
5. Browse and select the specific CSV file you want to import, select it, then click OK for confirmation.
The OI Server Manager will import the file and deposit it in the Device Items box.
During the imported file processing:
o New item references will be added bas ed on unique names.
o If t here are duplicat e names, you will be provided with t he ability to replace the existing entry with
the new entry, or ignore the new entry.

When the Communication Driver is running and an OPC client requests item information, the imported
configured items will show up under the controller hierarchy node.

41
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideConfiguring the ABCIP Communication Driver

Note: When you select another part of the Communication Driver tree hierarchy, you are prompt ed to
save the modifications to the configuration set.

Each configuration view associated with nodes in the Communication Driver hierarchy tree has a
common feat ure, the Save button locat ed on the upper-right corner of the configuration view.
When you modify any parameters in the Device Groups dialog box, click Save to implement the new
modifications.
If you do not click Save, you will be prompt ed to save the new data to the configuration set.

Scan-Based Message Handling

The Communication Drivers are based on the concept of polling a hardware device for information. This
polling is driven by a need that is expressed in the form of requests from one or more clients. After a
particular piece of information has been requested by a client, the Communication Driver formulates its
own request and sends that request to the hardware device. The Communication Driver then waits for a
response to its request. After the information has been rec eived, the Communication Driver passes that
information back to the client, and repeats the process until all clients have ceased requesting
information.
The rate at which the Communication Driver will poll a particular device for a s pecific piece of information
is defined in the device group (topic definition) inside the Communication Driver, using a parameter
called the Update Interval. When setting this parameter, there is always a trade -off bet ween the updat e
speed of the device group and the resulting dec rease in sy stem responsiveness.
Because you more than likely want a very fast response, the temptation is to set the Update Int erval to a
value close to 0 seconds. However, if every point is polled at this rate, the entire system will suffer due to
slow response time. Therefore, you should compromise, and set the Update Interval to a more
reasonable value. You could als o create multiple device groups for each device, setting the Updat e
Interval to different values, then assigning different items to different device gr oups depending on how
quickly the values change and how quickly you want to see an updat e of those changes.
Some items, like alarms, change very infrequently but because of their importance require very fast
updates. For those kinds of items, you should set the Update Interval at a very small value. If you desire
an immediate response, set the Update Interval at 1.

Unsolicited Message Handling

In the world of controllers and Communication Drivers, it is obvious that a controller will know when a
critical event has occurred before the Communication Driver will have a chance to poll for that data.
Therefore, it would seem natural that if a critical event occurs, the controller should have the capability to
inform the Communication Driver immediately, without having to wait for the Communication Driver to
poll it.
This is the role of an unsolicited message. After a controller has determine d that a critical condition
exists, it can generate a message immediately sent to the Communication Driver without a prior request
from the Communication Driver. The unsolicited message implementation requires both the messaging
instructions properly programmed in the controller logic and the device group appropriat ely configured in
the Communication Driver.

Note: The use of unsolicited messages requires configuration changes in the controller. Please refer to
the related Rockwell Automation documentation for procedures to set up unsolicited messages from the
supported controller processors.

The ABCIP Communication Driver supports unsolicited messages from the following processors:
 PLC-5 and SLC 5/04 processors on the Data Highway Plus network.
The following non-Logix processor configuration does not support unsolicited message handling:
MicroLogix with 1785-KA5 via ControlLogix Gateway (1756 -DHRIO and 1756-ENB ).

42
Configuring the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

 Logix5000 and MicroLogix 1100 processors on the Ethernet network.

The following Logix5000 processor configuration does not support unsolicited message handling:
CompactLogix going through the EtherNet/ IP interface module (1761-NE T-E NI).
 Logix5000, PLC-5, and SLC500 processors on the ControlNet network.
The following SLC500 proc essor configuration does not support unsolicited message handling:
SLC500 using 1747-KFC15 interface on ControlNet via the ControlLogix Gateway (1756-CNB and
1756-E NB) to RSLinx on Ethernet.
To configure the ABCIP Communication Driver to receive unsolicited messages
This option is available only to the cont rollers listed above.
1. Click on the target controller node under the controller branch of the Communication Driver
hierarchy.
2. Select the Device Group tab of the configuration view.
3. Add a new device group or select an existing device group.
4. Right -click on the devic e group name, then select Edit from the shortcut menu.
The Device Group Parameters dialog box is displayed.

5. In the Device Group Parameters dialog box, select the Support Unsolicited Message s check
box.
6. Click OK.

Note: Because the status of Support Unsolicited Messages check box cannot be readily viewed from
the Device Groups tab, proper naming of device groups that support uns olicited messages is
strongly recommended.

7. If appropriat e, you can modify the Update Interval to "0".

8. Click Save to save the configuration change.

43
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideConfiguring the ABCIP Communication Driver

Note: To enhance performance in message handling, the default for the device group is to not
provide unsolicited message data; therefore, the Support Unsolicited Messages check box is not
checked.
The setting of this check box is hot-configurable. Unsolicited message handling will take effect in the
Communication Driver as soon as the change made in the configuration view is saved.

Target-specific Unsolicited Messages

The Communication Driver s upports target-specific unsolicited messages. This met hod involves sending
messages to its target as specified by a given static IP address.
 Configure the appropriate message instructions in the controller with the proper path (including the
destination IP address) for sending unsolicited messages.
 Configure the c omputer, in which t he Communication Driver resides to receive unsolicited messages
from the controller, with the corresponding IP address.
 Two instances of target-specific unsolicited messages are generated by the Communication Driver:
o If the value of "Update Interval" for a topic is 0 (zero), the server will poll this topic only one time
at the start. After that, only an unsolicited message will update the data.
o If the value of "Updat e Int erval" for a topic is >0 (greater than zero), the server will update the
data for a particular item immediately upon receiving an unsolicited message for the item. The
Communication Driver will also update the data at every Update Int erval.

Note: The Communication Driver requires unsolicited messages t o be configured as "Connected" in

Logix5000 processors. For det ails in setting the Allen-B radley hardware for unsolicited messaging,
please refer to the relat ed Rockwell Automation documentation.

To Receive Unsolicited Messages

1. Activate the Communication Driver.
2. Add the items, defined in the controller for unsolicited messages, for updates under the device group
set up for receiving unsolicited messages.
To Access the Settings for Device groups
1. Click on the target controller node under the Configuration hierarchy of your Communication Driver.
2. Select the Device Groups tab of the configuration view pane at right.
3. Right -click on the devic e group name, then select Edit from the shortcut menu.

Note: Unsolicited PLC-5 Typed Write using CIP with Source ID method from the Logix5000 processor is
not supported. Instead, configure the message instruction with CIP Data Table Write using the CIP
method from the Logix5000 processor.

44
 AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

C HAPTER 3
Using Auto-Build with the ABCIP
Communication Driver

About Auto-Build and the ABCIP Communication Driver

Auto-Build is an E ngineering Efficiency feat ure that allows you to read the templates and instanc es in the
controllers capable of running the Auto -Build feature. You can also replicate these structures to
Application Server using a set of simple steps, that allows a one-to-one correspondence between the
PLC and a Galaxy project.
This feature is accessible in the Auto-Build tab of the appropriate Logix controller hierarchy within the OI
Server Manager.
Auto-Build browsing can be accomplished online if connec ted to the PLC, or offline if the PLC file is
available. The Auto-Build feature supports only user-defined data types. It does not support other data
types.

Prerequisites for Auto-Build Operation

Ensure the following prerequisites are met before configuring the Auto-B uild.
Operating System Requirements
Auto-Build requires one of the following OS configurations:
 Windows 2016
 Windows 2012 and 2012 R2
 Windows 10
 Windows 2008 R2
 Windows 8 and 8.1
 Windows 7 with SP1
Software Requirements
While most of the prerequisite software required for Auto-Build are installed during the Communication
Drivers Pack installation, others need to be manually downloaded as listed below.

Software Component Installation Instruction

Installed with Communication Drivers Pack

.NET Framework .NET 4.0
as a prerequisite

45
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideUsing Auto-Build with the ABCIP Communication Driver

 Pre-installed wit h the OS - Windows

2016, Windows 2012 R2, Windows 10
and Windows 8.1
.NET 4.5+
 Requires manual download for Windows
2012, Windows 2008 R2, Windows 8
and Windows 7
VC 9.0 SP1
Microsoft C Installed with Communication Drivers Pack
VC 10.0 SP1
Runtime Libraries as a prerequisite
VC 2013
Installed with Communication Drivers Pack
XML XML 6.0
as a prerequisite
Installed with Communication Drivers Pack
SDS SDS 1.0 (ASB V5)
as a prerequisite
ArchestrA Data Installed with Communication Drivers Pack
ADS 2.0.4
Store as a prerequisite
Installed with Communication Drivers Pack
AdminUs er 64-Bit AdminUser
as a prerequisite, on 64-bit OS only

Browser Requirements
Auto-Build requires Internet Explorer 11 or higher for functioning. For IE versions lower than 11, an error
message is displayed in the Auto-B uild tab:
IE version X is not supported. Please upgrade to IE 11
IE 11 is pre-installed with Windows 2016 (not as default browser), Windows 2012 R2, Windows 10, and
Windows 8.1. IE 11 should be manually downloaded for Windows 2008 R2 and Windows 7
Installation Requirements:
Auto-Build must be installed in the same node as an Application Server Galaxy Repository.
Licensing Requirements
Auto-Build requires a Professional Communication Driver licens e or higher. Refer to the Licensing
section of the Communication Drivers Pack Help for more details.
If the license server is not configured, a warning message is displayed:
Unable to obtain a license for Auto -Build

Note: A standard license, or no license will allow the user to exercise Auto-Build configuration steps, but
not building the objects in Application Server.

46
Using Auto-Build with the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Accessing the Auto-Build screen

Click the Auto-Build tab in the logix node configuration view to view the Auto -Build screen. Select the
server-specific PLC Tag File (.L5X for AB CIP ) to initiate the build operation.

Refer to the section "Using Auto-Build" in the Communication Drivers Pack Help for more details.

Monitoring Auto-Build Progress

The progress bar displays the extent of completion of the building operation.
Open the Log Viewer within the Arc hestrA SMC to view the logs recorded during the upload.
Stopping the Auto Build Operation
1. Click the Stop button during the progress to terminate the Auto Build operation.
2. The progress displays the terminating proc ess.
The Arc hestrA galaxy templates and instanc es created prior to the stop request will continue to remain in
the Galaxy.

Note: Click anywhere on the screen during the building or build termination stages to mini mize the
progress to the title bar. Click the title bar again to bring back the progress bar.

47
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideUsing Auto-Build with the ABCIP Communication Driver

Template Generation in the Application Server

The instances submitted from Auto-Build are generated in the selected Galaxy within the ArchestrA IDE.

The attributes of the selected instance are displayed in the cente r of the IDE screen as shown below.

PLC Tag Database Feature Support

Allen-Bradley Logix TagDB Features Support Status

Logix Program Auto-Build Online Offline

Category TagDB Item
Feature Feature Mode Mode

User Defined
Data Type User-Defined (UDT) data Templat e Y Y
structure
Add-On-Defined
Data Type Add-On-Defined (ADT) data Templat e Y Y
structure
I/O &
Communication
Data Type Module-Defined Not Support ed N N
Module (MDT) data
structure

48
Using Auto-Build with the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

System
Data Type Pre-Defined Pre-Defined (P DT) Templat e Y Y
data structure
Instance /
Scope Cont roller Global tag Y Y
Attribute
Scope Program Program tag Not Support ed N N
Usage Local Local tag for A DT Not Support ed N* N
Attribute
Usage Input Parameter for ADT (non-specific Y Y
field)
Attribute
Usage Output Parameter for ADT (non-specific Y Y
field)
Parameters for
Usage InOut Not Support ed N N
ADT
Attribute
Tags Tag Type "Base" / "Alias" (non-specific Y Y
field)
Refer to the entries
Tags Data Type under "Data Type" n/a Y Y
Category above
Array dimension of Attribute
Tags Dimension Y Y
"1" / "2" / "3" enumeration
Attribute
Text field of 512
Tags Description (Description N Y
characters
field)
Tag properties for
Attribute
"Read/Write" / Read/Wri
Tags External Access writeability Y
"Read Only" / te
properties
"None"
Attribute
Tag properties of
Tags Constant (non-specific Y Y
"true" / "false"
field)
Value display in
Binary / Octal / Attribute
Tags Style N N
Decimal / Hex / display style
ASCII

Note:Auto-B uild Online Mode does not hide the Local Tags from displaying, but they are not support ed
for item subscription with OI ABCIP.
ADT InOut parameters and local tags are not shown up in the actual tag list under RS Logix5000 TagDB.
The Auto-Build feat ure supports only user-defined data types. It does not support other data types.

Auto-Build Data Type Mapping

49
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideUsing Auto-Build with the ABCIP Communication Driver

Logix Program
Logix Data Type Description AppServer Data Type
Base Data Type

BOOL Boolean MxBoolean

REAL Real as 32-bit IEEE Floating-point number MxFloat
SINT Singular Integer as 8-bit signed integer MxInteger
DINT Double Integer as 32-bit signed int eger MxInteger
INT Integer as 16-bit signed integer MxInteger
LINT Long Integer as 64-bit signed integer MxInteger
STRING String as character bytes MxString

50
 AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

C HAPTER 4
ABCIP Communication Driver Reference

OPC Browsing
Two types of OP C browsing, namely off-line OP C browsing and on-line OP C browsing, are supported by
the ABCIP Communication Driver.

Note: For t ag items defined as array data types in an item addition request, the OPC_E_BADTYPE error
is returned when an OP C client does not specify the array data type or the V T_EMP TY data type. The
only exception is when an OPC client specifies V T_BS TR as the requested data type for an item that is
defined as VT_ARRAY|V T_UI1. In this case, the Communication Driver accepts the item addition and
returns the data as VT_BS TR.

Off-line OPC Item Browsing (Static Browsing)

The Communication Driver implements population of the namespac e to enable OP C browsing of
Cont rolLogix, CompactLogix, FlexLogix, GuardLogix, PLC-5, SLC500, MicroLogix, and SoftLogix
processor items. Browsing can also be performed off-line using the .aacfg file for Device It ems created
and saved with the cont roller hierarchy node of the Communication Driver.
OPC browsing on item names is also provide d to all controllers by means of importing a
comma-separated-value (.cs v) file, which provides symbolic names to tag names, into the .aac fg file.

Online OPC Item Browsing (Dynamic Browsing)

The online OP C browsing for Cont rolLogix, CompactLogix, FlexLogix, GuardLogix, PLC-5, SLC500,
MicroLogix, and SoftLogix proc essor items is implemented by the Communication Driver. Using the
information retrieved from the processor's tag databas e, the ABCIP Communication Driver will
dynamically create a configuration hierarc hy that allows the OI Engine to browse into it.
When it detects that the processor's tag dat abase has changed while browsing, the ABCIP
Communication Driver will update the internal tag database but not the configuration hierarchy until the
$SYS$BrowseTags system tag is poked with "1."

Note: The OPC item browsing capability is available on-line only when the AB CIP Communication Driver
is connecting to the corresponding processor and its tag database is available for access. Otherwise,
only off-line items (system items and saved device items) will be displayed.

Note: By default, dynamic OPC browsing of tags from the Communication Driver is disabled. In order to
browse tags online from the Communication Driver, a "1" must be written to the $SYS$B rowseTags
system tag associated with the chosen processor hierarc hy node. Subsequent OPC item browsing
operation on this particular processor should be enabled.

51
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide ABCIP Communication Driver Reference

Logix5000 Optimization Mode

Operation of the ABCIP Communication Driver per device will be such that it can operate in the same
multi-request service (non-optimized) mode or in optimized mo de for any device. If the device and
firmware support optimization, the default mode for the device will be with optimization. You will have the
capability of disabling optimization even though the device and firmware may support it.
The optimization will require a tag database upload from the Logix5000-s eries controller (ControlLogix,
CompactLogix, FlexLogix, GuardLogix, SoftLogix). The tag database c ontains the data types and unique
references that can be used to reference the physical tags available in t he controller. The tag database
kept in the controller is versioned. ABCIP Communication Driver provides the option that can be used to
periodically probe the controller for any version changes and to obtain the changes in the tag database.
 The AB CIP Communication Driver supports only No Optimization and Optimize for Read mode on
firmware versions 21 and higher. By default Optimize for Read is selected.
 The Optimize for Startup mode will only be used to access controllers operating on firmware
versions 20 and lower.
 The ABCIP Communication Driver will switch to Optimize for Read mode from Optimize for
Startup if firmware version 21 or higher is detected from the controller, even if the optimization
setting is set to Optimize for Startup. In this instance, the ABCIP Communication Driver will
generate a warning line in the logger to alert that the Optimize for Startup mode is not supported for
firmware version 21 and higher cont rollers.
Three selectable options are:
1. No optimization
All tags that communicate with the Logix processor will use the tag name. The tag databas e will be
uploaded from the controller to validat e the tag names. No optimization will have the fastest startup
time, but will have the slowest read performance. It will create more messages for cont roller
communication than the other two options. The length of the tag name will affect the number of
messages creat ed.
2. Optimize for Read
All tags that communicate with the Logix processor will require a tag database to be available as a
prerequisite. This operation also generates a memory buffer inside the controller and thus requires
the longest startup time among the three options.
Despite the longer startup time, Optimize for Read provides the fastest read performance after the
tag database upload operation has been completed. It will create fewer messages for controller
communication.
3. Optimize for startup time
A vailable only for firmware versions 20 and lower, this option provides the best overall per formance
among all three optimization options. All tags that communicate with the Logix processor will require
a tag database to be available as a prerequisite.
This option does not generat e a memory buffer inside the cont roller and thus provides a faster
startup time than the Optimize for read option. All tags communicating with the Logix processor will
be using the physical tag address. It provides a faster read performance than the No Optimization
option as multiple tags can be referenced in one request packet to the Logix processor. It will create
a higher number of messages for controller communication than the Optimize for read option.

Note: If this option is checked, the ‘Auto Synchronize Tag’ option is checked automatically and
cannot be unchecked.

52
ABCIP Communication Driver Reference AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

UDT Optimization
A UDT (User-Defined Type) is a data type defined by the user in the Logix5000 processor. A UDT can
group various data types, such as integers, floats, and so on, into a single structure. When this feature is
enabled, the Communication Driver will attempt to group requests for a UDT’s elements into a request for
the whole structure. In fact, this feature also works for system predefined structure.
If the size of the structure exceeds 488 bytes, the Communication Driver will send separat e requests for
each structure’s element. If the UDT involved is a nested structure (a UDT containing other UDTs ), the
Communication Driver will determine the optimal UDT to retrieve.

Note: Optimization and UDT Optimization features are selectable from all Logix5000 -series controllers.

UDT Optimization with None Access Attribute

Starting with ControlLogix firmware version 18.x, using the Rockwell RS Logix 5000 Programming
Software, UDT tags, and their elements can be configured with an External Access property setting of
Read/Write, ReadOnly or None. The None setting is specifically meant to define a private tag within the
processor, which is not exposed to components outside of the controller, such as the ABCIP
Communication Driver. This affects the UDT optimization capability in the ABCIP Communication Driver.
This also affects Add On Instructions behavior, which makes extensive use of UDTs. For these reasons,
UDTs wit h elements having the External Access property set to None is not supported. UDTs must not
contain any elements with External Access property set to None when the UDT optimization option is
checked in the ABCIP Communication Driver.

Important: You must reset, or deactivate and reactivate, the Communication Driver if you change the
access rights of an element in a UDT from None to ReadOnly or Read/Write.

Logix5000 Write Optimization

The Pok e Mode parameter in the configuration screen of the ABCIP Communication Driver (OI.ABCIP.x)
in the SMC controls how the Communication Driver treats pokes within a trans action with respect to
optimization and folding.
You can select one of three modes:
 Cont rol Mode
 Transition Mode
 Optimization Mode (AB CIP Default)
Control Mode - preserves the poke order wit hout folding. Typically used by batch and control
applications that depend on the order of the pokes and processing every item poked.
Transition Mode - preserves the pok e order with minimum folding by keeping the first, second, and
last poke values of an item. Typically used by batch and control applications that depend on the
order of pokes but not processing every item poked.
Optimization Mode (ABCIP Default) - does not preserve the poke order and has maximum folding
by only poking the last value of an item.
When Poke Mode is set to Optimized, the Communication Driver will attempt to group consec utive
tag writes (array elements) into a single request. Depending on the timing situation, there is no
guarantee that consecutive tag writes will be grouped into a single request.

Note: For more information on all Communication Driver Global Parameters, see the
Communication Drivers Pack Help.

53
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide ABCIP Communication Driver Reference

Data Type Determination

When a client sends a read/writ e request to the ABCIP Communic ation Driver, the server needs to know
if the tag is defined in the controller; it also needs to know the tag’s data type and size. To determine this
information, the ABCIP Communication Driver int ernally builds the item table (tag database) in the
server-specific code before any item is created.
 This table includes information on the item's name, dat a type, and size.
 If an item is a structure, it also includes its members and their data types.
To build the table, the ABCIP Communication Driver sends a request to the controller for all the tag
information defined in the controller. The controller then returns all the information needed. The table is
built one time for each cont roller, unless a "refresh" request is received from the client. The ABCIP
Communication Driver does not rely on the Allen -Bradley .csv and .L5K files.

Important: The manual "refresh" tag database request for the Logix processor needs to be activated by
your writing "true" (of type VT_BOOL) to the $Sys$UpdateTagInfo; it is not activated by selecting the
option (c heck box) as was implemented in the ABCIP OI Server 1.1.

Tag Database Status

To provide the status of the tag dat abas e for the Logix processor cached in the ABCIP Communication
Driver, this version of the Communication Driver will implement a predefined, read-only system variable,
$Sys$TagDBStatus, of type V T_I2.
This system variable takes on any of the following values:
 0 – No tag database
 1 – Uploading tag database
 2 – tag database uploaded
 3 – tag database upload failed
The value of $Sys$TagDBStatus can only be changed by poking to the system variable
$Sys$UpdateTagInfo. Poking a TRUE to $Sys$UpdateTagInfo while $Sys$TagDBStatus is 1 will not
cause consecutive tag database uploads to the ABCIP Communication Driver.

Note: $Sys$UpdateTagInfo and $Sys$TagDBStat us are only available as item names associated with
the Logix processor.

Regardless of the status of the tag database upload, the ABCIP Communication Driver periodically
syncs the tag database from the controller. The Logix5000 controller has a journaling capability that
keeps track of the changes in its tag database. Whenever the tag database in the Logix5000 controller is
changed, a new journal and version are generated within the controller.

Tag Database Version

The ABCIP Communication Driver periodically checks for version changes and uploads the journal
information from the controller, so that the tag database it maintains matches the corresponding
database in the cont roller.
You can monitor changes in the Lo gix tag database version by subscribing to the tag database system
item $SYS$TagDBVersion at the hierarchy of any CompactLogix, FlexLogix, or ControlLogix controller.
The ABCIP Communication Driver shows the new database major and minor versions presented as a
number in addition to uploading the journal information from the controller.

54
ABCIP Communication Driver Reference AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Note: For tag items defined as array data types in an item addition request, the OPC_E_BADTYPE error
is returned when an OP C client does not specify the array data type or t he V T_EMP TY data type. The
only exception is when an OPC client specifies V T_BS TR as the requested data type for an item that is
defined as VT_ARRAY|V T_UI1. In this case, the Communication Driver accepts the item addition and
returns the data as VT_BS TR.

Invalid Items Handling

Item syntax verification is based on the type of controllers associated with it. The PLC -5 and SLC500
controllers have predefined syntax on their item names. When an item is specified for these two types of
controllers, its item syntax will be verified immediately. If the item syntax is incorrect, the item is rejected
immediat ely and will not be added to the Communic ation Driver does periodically send messages to the
Logix5000 controller for tag database update. The item that has a BAD syntax will be re-evaluated when
a new tag dat abase has been downloaded to the Logix5000 controller. If the item is subsequently
matched to an item in the new tag database, the item will automatically switch to a GOOD quality with the
proper data value.Communication Driver

Logix5000 Online Tag Management

The ABCIP Communication Driver can detect online changes to the Logix5000 proc essor tag databas e
and automatically update the status of these tags in your application.

Note: Tag change detection and updat es are dependent on the Auto Load Tags on Activation, Auto
Synchronize Tags, and Use Persisted Tags setting for t hese Logix5000-compatible controllers. For more
information on On these tag database options, see Loading Tag Dat abase from File on page 56

Adding or Removing Tags

When tags are added or removed from the Logix5000 processor, the Communication Driver can detect
the change and update its internal tag dat abas e. If the newly added tags have already been accessed in
your application, the quality of these tags will be changed to GOOD and their values updated. In the case
when the tags are removed from the processor, the tags’ quality will be changed to BAD.
Because the det ection is done through periodic pollings of your Logix5000’s status, there will be a delay
between the time when tags are modified and the time when tags’ information is updated in your
application. The delay can be a few seconds to minutes, depending on how busy your Communication
Driver is.

Making PLC Program Routine Changes

If you import a routine containing new tags to an online PLC, the Auto Synchronize Tags option will not
synchronize the new tags with the Communication Driver. The Communic ation Driver will reject the new
tags as invalid even with the Auto Synchronize Tags option enabled until the tag database is re-reset by
poking a 1 to the system item $SYS$UpdateTagInfo.
As a best practice, changes of PLC program routines should be done when the PLC is offline. Changing
or importing the PLC program routines when the PLC is online is not supported.

Modifying Tags Through Downloaded Programs

Tag information can also be modified with an updated program. When a program is downloaded to the
Logix5000 processor while data access is in progress, the Communication Driver can detect the change
of state in your Logix 5000 processor. A message will be displayed in the logger to inform you about the
event and data access to the processor will be temporarily suspended.

55
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide ABCIP Communication Driver Reference

As soon as the program downloading process has completed, the Communication Driver will re-upload
all the tag database from the Logix5000 processor and resume your access to the processor. All tags in
your application will be updated to reflect the change.

Loading Tag Database from File

The ControlLogix, GuardLogix, Soft Logix, CompactLogix, and FlexLogix controllerads have options to
upload the Tag database from the file. Each option can improve the tag database upload time depending
on your tag database management setup.

Auto Load Tags on Activation

When the Communication Driver is activated, it can perform a tag database upload.
If Auto Load Tags on Activation is selected, the Communication Driver will check the controller
database version on startup. If it is different from the versio n stored in the file, it will read t he tags from the
controller and synchronize the file. The Tag Database from File Options Matrix on page 56 explains the
database upload feature from the file.
If this option is NOT selected, the Communication Driver will not perform an upload upon activation but
will wait until an item has been advised by a client.

Auto Synchronize Tags

If Auto Synchronize is selected, the Communication Driver will periodically check the controller version
number and perform an upload if a newer version is present.

Important: If the optimization option Optimize for Startup time is selected, the Auto Synchronize
Tags is automatically selected and unchangeable. In this situation, the Communication Driver needs to
synchronize physical address of tags from device.

For information about importing new tags to an online PLC, see Mak ing PLC Program Routine Changes
on page 55.

Persisted Tags
The Cont rolLogix, GuardLogix, SoftLogix, CompactLogix and FlexLogix controllers have an option to use
Persisted Tags for uploading the tag database from the file. This feature wil l improve the tag database
upload time.
When the Communication Driver is activated with the Persi sted Tags option selected, it reads the tags
from the controller and stores them into a file under the bin\CIP TagDB directory.
If the version of the tag database matches the tag dat abas e file persisted from the last run, the ABCIP
Communication Driver will skip the tag database upload option and use the persisted file as the basis of
the tag database.
If the Communication Driver det ects the controller database version is different from the version stored in
the file, it will read the tags from the controller and synchronize the file.
The subsequent restart of the Communication Driver will read the tag database from this file. This file will
store the dat abas e major and minor version information.

Important: If secured cont rollers (password protected), are a part of your hierarchy, changes in the
Persisted Tags functionality will occur. See Tag Database from File Options Matrix on page 56 for a
detailed description of each option.

Tag Database from File Options Matrix

56
ABCIP Communication Driver Reference AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Tag Database Options Selected (checked) Not Selected (Unchecked)

Auto Load Tags on The tag database will be uploaded as The tag database will be uploaded
Startup soon as the Communication Driver is as soon as the first device item is
activated. The Communication Driver subscribed.
(Configurable
will attempt to connect to the device
parameter in the editor) The system item
only one time. If the device is not
$SYS$Updat eTagInfo can not be
connected, it will retry when the first
used to trigger a tag database
item is subscribed.
upload until the first device item is
subscribed.

Auto Synchronize Tags The tag database in the The tag database in the
Communication Driver will be Communication Driver will not be
(Configurable
synchronized periodically with the synchronized with the devic e.
parameter in the editor)
devic e. If the device is secured, the
The system item
Communication Driver will not be able
$SYS$Updat eTagInfo can be
to automatically synchronize the tag
used to synchronize the tag
database.
database manually.
Note: If the optimization option is set
for Optimize for startup time, the
value is always True. In this case, the
Communication Driver needs to
synchronize the physical addresses
of tags from the device.

Use Persisted Tags The Communication Driver will read The Communication Driver will
the tags from the tag database file. If always upload the tag database
the file does not exist, it will then read from the device and store them in
the tags from the controller and store to a file.
them into a file under bin\CIP TagDB
directory.
If the controller is unsecured and the
database version is different from the
controller version, then the
Communication Driver will read the
tags from the controller and store
them into a file.
The system item
$SYS$Updat eTagInfo can be used to
force the tag database upload from
the device.
Note: If the optimization option is
Optimize for startup time, the
physical address of the tags will also
be stored in the file.

57
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide ABCIP Communication Driver Reference

Tag Database Options Selected (checked) Not Selected (Unchecked)

$SYS$Updat eTagInfo The tag database will be uploaded Poking the value False will not
from the devic e if value True is poked affect the tag database.
(System item can be
to this item.
accessed by any client
application) This system item is provided for
manual synchronization of the tag
database. If the device is secured,
use this item to synchronize tag
database.
Note: If Use Persi sted Tags is
enabled, the original file will be
renamed to <####>_temp.aaTDB
(where ### represent the serial
number of the devic e). If the
Communication Driver fails to upload
tags from the device, it will use the
renamed file to recover the database.
The temporary file
(<####>_temp.aaTDB) will be
deleted, after the tag database is
uploaded successfully.

Manual Tag Synchronization

This system item ( $SYS$UpdateTagInfo) is provided for manual synchronization of tag database. If the
devic e is secured (P assword protected), use this item to synchronize tag database.
The system item $SYS$UpdateTagInfo can be accessed by any client application.
The tag database will be uploaded from the device if value True is poked to this item.

Note: If Use Persi sted Tags is enabled, the original file will be renamed to <####>_temp. aaTDB (where
### represent the serial number of the device). If the Communication Driver fails to upload tags from
devic e, it will use the renamed file to recover the database. The temporary file (< ####>_temp.aaTDB)
will be deleted after the tag database is uploaded successfully.

Poking the value False will not affect the tag database.

Accessing Secured Logix5000-series Controllers

When Logix5000 controllers are secured (Password protected), accessing the program version number
will fail. When the controllers are secured, the tag database in the ABCIP Communication Driver may not
be in-sync with the controller tag database.
If the run-time tag database synchronization has not been turned off and the controller is unsecured, the
ABCIP Communication Driver will re -sync the tag dat abases at the next re-synchronization interval.
When the controller is secured an error is returned to the AB CIP Communication Driver indicating that
the controller is secured and a message will be logged indicating that tag database re-synchronization
failed bec ause the cont roller is secured.

58
ABCIP Communication Driver Reference AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Because re-syncing is still running at the re -syncing interval, if the controller goes from secured to
unsecured, the tag databases will be re -synced if necessary and a message will be logged indicating that
the controller is unsecured.
The system variable $Sys$DeviceSecurity will indicate if the controller security is On or Off.
You can turn on or off, through configuration, the tag database re -syncing, to minimize the traffic
between AB CIP Communication Driver and the controller.

Note: The server can be started and in-sync with the controller, and the controller can be secured and
un-secured with no changes, so that the server is still in-sync with the controller. E ven though the
controller is secured, the tag database can still be uploaded. The error returned from the controller when
the controller is secured is only on the program version check.

The Auto Synchronize Tag Functionalit y Matrix on page 59 and Persisted Tag Functionalit y Matrix on
page 59 show when a tag database upload will occur or not occur based upon security.

Auto Synchronize Tag Functionality Matrix

Server Runtime behavior:
Auto Synchronize
Tag Configuration For unsecured controller For secured controller

Selected (Checked) Tag databas e version in the Tag databas e version in the
controller will be checked controller will be queried but no
periodically and the version upload will be made automatically.
changes will be uploaded to the Changes in the tag databas e in
ABCIP Communication Driver the controller will only be uploaded
automatically. when the $SYS$UpdateTagInfo
system tag in the ABCIP
Communication Driver is written
into.

Unselected Tag databas e version will not be Same behavior as if the cont roller
(Unc hecked) checked. Changes in the tag is unsecured.
database in the cont roller will only
be uploaded if the
$SYS$Updat eTagInfo system tag
in the ABCIP Communication
Driver is written into.

Persisted Tag Functionality Matrix

Server Runtime behavior:
Persi sted Tags
Configuration For unsecured controller For secured controller

59
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide ABCIP Communication Driver Reference

Server Runtime behavior:

Persi sted Tags
Configuration For unsecured controller For secured controller

Selected (Checked) 1. The Communication Driver will The Communication Driver will
read the tags from the file. If the read the tags from the file. If the
file does not exist then it will read file does not exist, then it will read
the tags from controller and store the tags from controller and store
them into a file under them into a file under the
bin\CIP TagDB directory. bin\CIP TagDB directory.

2. If the file database version is

different from the controller
version, then the Communic ation
Driver will read the tags from the
controller and store them into a
file.

Unselected The Communication Driver will always upload the tags from the
(Unc hecked) controller and store them into a file.

Controller Time Stamping

ABCIP Communication Driver has the capability to time stamp data changes with the controller’s dat e
and time as opposed to the PC’s date and time. A new item syntax to time stamp data changes with the
controller’s date and time must be used.

Note: Controller Time Stamping is supported only in the Allen -Bradley Logix-family of controllers, version
16.x or later.

Important: The " TimeTag" in the controller must contain date and time as LINT type in UTC format. The
logic behind the association bet ween the specific DataTag & TimeTag pair is assumed to be
user-defined in the controller program.

Specifying controller time stamping in native InTouch requires the time-stamping qualified DataTag plus
both of its Date and Time Dotfield string tags.

60
ABCIP Communication Driver Reference AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

The following sequence shows the Tagname Dictionary and the sample items.

 DataTag: Can be almost any type including boolean, integer, string, and array. In the example, the
Value tag is an integer for illustration purposes only.
 TimeTag: Must be string type.
When you enter an item name on the client side, you must enter an item name that is a Data tag and
Time tag pair. You will use the "&T&" delimiter, to identify the time tag.
For example if you enter an item name such as DataTag& T& TimeTag, the Communication Driver will
treat the item as two separate tags, "DataTag" and "TimeTag", and will validate each tag separat ely.
DataTag example " TimeStamp1":
Integer_Recipe(0)&T&TimeStamp(0)

TimeTag example, concatenated:

61
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide ABCIP Communication Driver Reference

TimeStamp1.TimeTimeString+""+TimeStamp1.TimeDateString

The Communication Driver will read the data for the two tags from the controller.
When the pair of values is read by the server, the TimeTag value will be used to time stamp the DataTag
value before sending the updat es to the client.
If you enter an item name such as DataTag only, the value read from the c ontroller is time stamped with
the PC’s date and time before sending the updates to the client.

Note: When advising an item using timestamping with "&T&", and communic ation is lost with the
controller, the Communication Driver will timestamp the item and updat e its quality.

Item Names/Reference Descriptions

The ABCIP Communication Driver currently supports item names that follow the conventions described
for the various Allen-B radley ControlLogix, CompactLogix, FlexLogix, PLC-5, SLC500, and MicroLogix
families of controllers.
 Logix5000 Item Naming on page 62
 PLC-5 Item Naming on page 66
 SLC500 Item Naming on page 75
 MicroLogix Item Naming
 OI Server-Specific System Item
 Generic OPC S yntax on page 97

Logix5000 Item Naming

The Logix5000 cont rollers (ControlLogix, CompactLogix, FlexLogix, GuardLogix and SoftLogix) store
data in tags, whose names you create. This is in contrast to the traditional Allen -Bradley PLC-5, SLC500
or MicroLogix controllers which store data in data/section files, whose names must follow the
vendor-predefined naming convention.
The Logix5000 tags uses arrays instead of file numbers in addressing a set of multiple items. That is, "[]"
would be accepted as a valid symbol but ":" would be rejected for the tag nam e. The Logix5000 item
syntax is shown in the following table. The Communication Driver will adhere to this syntax for native
mode.

Note: A tagname can be up to 40 characters in length and cannot include a file number. File numbers are
not applicable to Control Logix. File numbers are valid for PLC5, SLC500 and MicroLogix only.

62
ABCIP Communication Driver Reference AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Reference Syntax

Program tag Program:<Program_Name>.<Tag_Name>

IO tag <Location>:<slot_#>:<Dat a_
Type><Member_Name>.<SubMember_Name>.[<bit_#>]

Entire tag <Tag_Name>

Member of structure tag <Tag_Name>.<Member_Name>

Array element <Tag_Name>[<element_X>]

Two-dimensional array element <Tag_Name>[<element_X>,<element_Y>]

Three-dimensional array element <Tag_Name>[<element_X>,<element_Y>,<element_Z>]

Block reads/writ es of one-dimensional <Tag_Name>[<element_X>],L<number_of_it ems_#>

arrays (supported types: BOOLS,
SINTS, INTS, DINTS, REALS, LONG)

String tag <String_Tag_Name>[.DA TA[[<element_#>]

]][,SC<string_lengt h_#>]
<String_Tag_Name>[.DA TA[[<element_#>]
]][,SP<string_length_#>]
<String_Tag_Name>[.DA TA[[<element_#>]
]][,SS<string_length_#>]

String tag array <String_Tag_Name>[<element_X>][.DA TA

[[<element_#>]]][,SC<string_lengt h_#>]
<String_Tag_Name>[<element_X>][.DA TA
[[<element_#>]]][,SP<string_length_#>]
<String_Tag_Name>[<element_X>][.DA TA
[[<element_#>]]][,SS<string_length_#>]

Bit within integer <Tag_Name or Member_Name>.<bit_#>

Read-only item syntax to read <Tag_Name>& T&<Time_Tag>

controller time-stamped data
<Hierarchy_Node_Path>< Tag_Name>&T&[.]<TimeTag>

Note: When the dat a and timestamp Example:

are locat ed in the same structure (e.g.
A.B.C.D.DataTag&T&A.B.C.D.TimeTag
UDT), the optional period following the
&T& delimiter when entering the item A.B.C.D.DataTag&T&.TimeTag
name for structures reduces the need
to retype the same structure name for
the time tag.

63
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide ABCIP Communication Driver Reference

Reference Syntax

Note: [DT] qualifier is an option to Example:

subscribe the value (LINT) in date and
A.B.C.D.TimeTag DT
time format.
Note: A space must be inserted between the < TimeTag> and
DT qualifier. Using the [DT] qualifier causes the tag to become
Read Only.

In the preceding table:

 [ ] italicized brackets designate element as optional.
 [ ] not italicized brackets denote array index.
 < > means user input (as defined in the controller program).
 String placeholder (start with uppercase): Location, Program_Name, Tag_Name, Data_Ty pe,
Member_Name, SubMember_Name, and String_Tag_Name.
 Numeric placeholder (all in lowercase): elemeny_#, element_X, element_Y, element_Z,
string_length_#, slot_#, bit_#, and number_of_items_#.
 <Location>identifies net work location as:
LOCA L = Local rail or chassis
<Adapter_Name> = Name of the remote module
 <Data_Ty pe> is represented by a single letter as follows:
I=input, O=output, C=configuration, and S=status.
 All others are predefined keywords or symbols.
Examples:

Tag Name Example

String tag array BatchRecipe[4], BatchRecipe[4].DA TA

BatchRecipe[4].DA TA[0],sc82
(all of them return the same data)

Two-dimensional array tag Mixer_StepTimer_Preset[3,5]

User-defined structure tag ProductionUnit.AssemblyLine[2].Counter[4]

Program tag Program:MainProgram. Tank[1,2,4].Level

Program:Us erProgram.OperationMode

Module tag Local:6:O.Data.31

Remote_IO:2: C.ProgValue

Note: A S TRING type member is implicitly a structure in the form of StringTag.DA TA and StringTag.LEN
(where the DA TA member is an array of 82 elements and the LE N member defines the actual length of
the string). Therefore, a string member consumes two nesting levels by default.
The length field of a string will be used to determine the length of the string to be ret urned if the DA TA
member is not explicitly included in the string specification when the string is put into subscription.

64
ABCIP Communication Driver Reference AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Note: The "DT" qualifier returns a UTC date/time for OP C Clients requesting a "VT_DA TE" binary value.
For DDE and SuiteLink clients, requesting a "VT_BS TR", the dat e is converted to a UTC Date/ Time
string. The dates supported by the Date/ Time string include values from 1/1/1970 1 2:00:00AM (GMT) to
8/30/2920 5: 19:59AM (GMT).

Module-Defined Data Types

Module-defined data types are created automatically in the RSLogix5000 software after their
corresponding I/O or DeviceNet modules are defined.
 Module-defined tags do not allow user modification.
 Formats are fixed by the Logix5000 controller.

User-Defined Data Types

The ABCIP Communication Driver supports read and write of us er-defined data types. The Logix
user-defined data type is a custom-made structure consisting of members that can be atomic, arrays
(single dimension only), or structures themselves.
The user-defined dat a-type tags can be atomic or arrays up to three dimensions. The members of the
structure can be any data types supported by this Communication Driver. If a structure cont ains anot her
structure as its member, the maximum nesting supported is up to 20 levels.
Each level of members in a structure or each array dimension within a user-defined tag consumes one
nesting level. The individual bits that make up a structure member do not constitute a nesting level.
The Communication Driver supports the optimization of user-defined data types. For information on UDT
optimization, see Logix5000 Read Optimization.

Block Reads and Writes of Arrays

The ABCIP Communication Driver supports Block Reads and Writes of one -dimensional arrays from the
supported ControlLogix, FlexLogix, and CompactLogix controllers.
The following features are not supported by the Communication Driver:
 Block Reads/Writes of strings.
 Block Reads/Writes of structures (either predefined or us er-defined).

Note: The requested block size cannot exceed 486 bytes.

There are five different data types that are supported, each of which requires a different allowance on the
qualifier due to the block size limitation.
There are three optimization modes supported, each with a different maximum qualifier allowance as
shown in the following table: Optimize for Reads, Optimize for Startup, and No Optimization.

Note: The number in the "Ln" qualifier should not need an offset, because it is the total number counting
from 1 (one).

Qualifier Allowance (n)

Optimize for Startup

Data Type Optimize for Read No Optimization

Boolean (V T_BOOL) 3840 3831

65
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide ABCIP Communication Driver Reference

Qualifier Allowance (n)

Optimize for Startup

Data Type Optimize for Read No Optimization

SINT (V T_I1) 486 478

INT (V T_I2) 243 239

DINT (V T_I4) 114 114

Real (V T_R4) 121 119

LINT (V T_I8) 60 59

Note: Boolean array tags may allow up to 3872 items in a block if the specified range of array elements
fits exactly into a contiguous block of DINT-based (4-byte) memory units. That is, Boolean array item
block starting from array index zero or at every quadruple of byte (32-bits) margin.
For example, index 0, 32, 64, 96, … can exploit this feature to the maximum.

The Block Reads and Writes of Arrays feature works differently for a DDE/SuiteLink client and OP C
client.
 In an OPC client, the array of data is displayed as an array of values (a series of data) separated by
";" according to their data types.
 In a DDESuiteLink client, the array of data is expressed as a string of Hex data block, of which each
unit occupies the same byte size as defined by the data types.
o The Hex value contained in each unit of the data block is equivalent to the decimal quantity
stored in each individual item in the controller.
o The data in the array block can be parsed according to the byte s ize of the data type.
o The Hex value can be converted to its equivalent decimal quantity for use in the application.
For example:
A DINT (double integer data type) item occupies 4 (four) bytes of dat a, which amounts to 8 (eight)
Hex digits.
An array block of DINT items from the InTouch HMI using DDESuiteLink should be parsed into
individual units of 8 (eight) Hex characters.
Then each unit of parsed data needs to be convert ed from Hex to its equivalent decimal value for
usage.

PLC-5 Item Naming

The general format of item names for data from the PLC -5 controllers matches the naming convention
used by the programming software. The following is the format:
[$] X [ file] : element [.field] [/bit]

Note: The parts of the name shown in square brackets ([]) are optional.

Item Name Description

$ Purely optional.

66
ABCIP Communication Driver Reference AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Item Name Description

X Identifies the file type.

The following table summarizes the valid file types, the default file number for
each type, and the fields allowed (if any).

file File number (0 - 999 decimal).

 File 0 must be Output.
 File 1 must be Input.
 File 2 must be Status.

element Element number within the file.

 For Input and Output files it is also called rack-and-group number and must
be 0 - 777 octal.
 For all other file types, it must be 0 - 999 decimal.

.field Valid only for Counter, Timer, ASCII String, PID, SFC Status, Block Transfer,
and Cont rol files.
Refer to the following table.

/bit Valid for all file types except ASCII String and Floating Point.
 For Input and Output files it must be 0 - 17 octal.
 For all other file types it must be 0 - 15 decimal.

Identifier File Type Default File # .fields

O Output 0 N/A

I Input 1 N/A

S Status 2 N/A

B Binary 3 N/A

T Timer 4 .PRE .ACC .EN .TT .DN

C Counter 5 .PRE .ACC .CU .CD .DN .OV .UN

R Cont rol 6 .LEN .POS .EN .EU .DN .EM .ER .UL
.IN .FD

N Integer 7 N/A

F Floating Point 8 N/A

A ASCII None N/A

67
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide ABCIP Communication Driver Reference

Identifier File Type Default File # .fields

D BCD None N/A

ST ASCII String* None .LEN

PD PID* None .ADRF .ADRE .BIAS .CA .CL .CT

.DB .DO .DVDB .DV N .DVNA .DVP
.DVPA .EN .ERR .EWD .INI .KD .KI
.KP .MAXI .MA XO .MA XS .MINI
.MINO .MINS .MO .OLH .OLL .OUT
.PE .PV .PVDB .PVH .PVHA .PVL
.PVLA .PVT .SO .SP .SPOR .SWM
.TIE .UPD

SC SFC Status* None .DN .ER .FS .LS .OV .PRE .SA .TIM

BT Block Transfer* None .EN .ST .DN .ER .CO .EW .NR .RW
(Read-Only) .TO .RLEN .DLEN .FILE .ELEM

MG Message None .NR . TO .EN .ST .DN .ER .CO .EW

.ERR .RLE N .DLE N .DA TA[0]
through .DA TA[51]

CT CNet Message None .TO .EW .CO .ER .DN .S T .EN .ERR
.RLEN .DLEN .FILE .ELEM

* Available only on certain PLC-5 models. Check the Processor Manual for the model being used.

Output File Items

O[n]:rg[/b] n represents the file number and it is optional. If

specified, it must be 0 (zero).

r indicates the rack number (0 - 27 octal).

g indicates the I/ O group (0 - 7 octal).

b specifies the bit (0 - 17 octal). /b may be omitted, if

necessary, to treat the I/O group as a numeric value.

Examples:
O0:00/0
$O:177/17
O:3 4BCD (for 16-bit 7-segment display)

Input File Items

I[n]:rg[/b] n represents the file number and is optional. If specified,

it must be 1 (one).

68
ABCIP Communication Driver Reference AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

r indicates the rack number (0 - 27 octal).

g indicates the I/ O group (0 - 7 octal).

b specifies the bit (0 - 17 octal). /b may be omitted, if

necessary, to treat the I/O group as a numeric value.

Examples:
I1:0/0
I:177/17
I:3 4BCD (for 16-bit thumbwheel input)

Status File Items

S[n]:e[/b] n represents the file number and is optional. If specified,

it must be 2 (two).

e indicates the element number in the file.

b is optional. If specified, it indicates the bit (0 - 15

decimal).

Note: Refer to the 1785 PLC-5 Family Processor Manual (Allen-Bradley Publication 1785-6.8. 2) for a
complete description of the Status file information.

Examples:
$S:18 (year)
$S2:18 (year)
S2:19 (mont h)
S2:10/0 (battery low status bit)

Binary File Items

B[n]:e[/b] or n represents the file number and is optional. If not

B[n]/m specified, it is assumed to be 3 (three). If specified, the file
number must be 3 - 999 decimal.

e specifies the element (word) number within the Binary

file. It must be 0 - 999 decimal.

b specifies the bit number within the word and is optional.

In the first form (where :e is present), the bit number must
be 0 - 15 decimal.

m specifies the bit number within the file. However, in the

second form, no word numbers are specified and the bit
number may be 0 - 15999.

Examples:

69
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide ABCIP Communication Driver Reference

B:33
B:6/4 (same bit as B/100)
B3/15999 (same bit as B:999/15)

Timer File Items

T[n]:e[.f][/b] n represents the file number and is optional. If not specified, it

is assumed to be 4 (four). If specified, the file number must be
3 - 999 decimal.

e specifies the element number (three words per element)

within the Timer file. It must be 0 - 999 decimal.

f identifies one of the valid Timer fields. The valid fields for
Timer Files are listed in the table. If .f is omitted, it is assumed
to be the word containing the status bits.

b is optional and is normally not used. All of the fields of a

timer can be accessed by specifying the .f fields. However, it
is possible to use /b to single out a bit in the .PRE or .ACC
fields (which are words ). If specified, the bit number must be 0
- 15 decimal.

Examples:
T4:0.ACC
T4:0.DN
T4:1.PRE

Counter File Items

C[n]:e[.f][/b] n represents the file number and is optional. If not specified, it is

assumed to be 5 (five). If specified, the file number must be 3 -
999 decimal.

e specifies the element number (three words per element)

within the Counter file. It must be 0 - 999 decimal.

f identifies one of the valid Counter fields. The valid fields for the
Counter files are listed in the table. If .f is omitted, it is assumed
to be the word containing the status bits.

b is optional and is normally not used. Specifying the .f fields

can access all of the fields of a counter. However, it is possible
to use /b to single out a bit in the .PRE or .ACC fields (which are
words). If specified, the bit number must be 0 - 15 decimal.

70
ABCIP Communication Driver Reference AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Examples:
C5:0.ACC
C5:3.OV
C5:1.PRE

Control File Items

R[n]:e[.f][/b] n represents the file number and is optional. If not specified, it is

assumed to be 6 (six). If specified, the file number must be 3 -
999 decimal.

e specifies the element number (three words per element) within

the Control file. It must be 3 - 999 decimal.

f identifies one of the valid Cont rol fields. The valid fields for
Cont rol files are listed in the table. If .f is omitted, it is assumed
to be the word containing the status bits.

b is optional and is normally not used. Specifying the . f fields can

access all of the fields of a Control file. However, it is possible to
use /b to single out a bit in the .LE N or .POS fields (which are
words). If specified, it indicates the bit (0 - 15 decimal).

Examples:
R6:0.LE N
R6:3.EM
R6:1.POS

Integer File Items

N[n]:e[/b] n represents the file number and is optional. If not specified, it is

assumed to be 7 (seven). If specified, the file number must be 3 -
999 decimal.

e specifies the element number within the Integer file. It must be

0 - 999 decimal.

b is optional. If specified, it indicates the bit (0 - 15 decimal).

Examples:
N7:0
N7:0/15
N7:3

Floating Point File Items

71
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide ABCIP Communication Driver Reference

F[n]:e n represents the file number and is optional. If not

specified, it is assumed to be 8 (eight). If specified, the
file number must be 3 - 999 decimal.

e specifies the element number within the Floating Point

file. It must be 0 - 999 decimal.

Examples:
F8:0
F8:3

ASCII File Items

An:e[/b] n represents the file number (NOT optional) and must be 3 - 999
decimal.
An:x-y
e specifies the element number within the AS CII file. It must be 0 -
999 decimal. Each element in an ASCII file contains two ASCII
characters.

b is optional. If specified, it indicates the bit (0 - 15 decimal).

x and y also specify element numbers. In this form, the item is an

ASCII string occupying element x through element y. Each
element contains two ASCII characters: the first character is the
high-order byte and the second is the low-order, and so on.

Note: If reading only one word as a two-character string, the range must be "x-x." For example, A20:3-3.

Examples:
A20:3
A10:0/0
A9:0-19 (40-character ASCII string)

BCD File Items

Dn:e[/b] n represents the file number (NOT optional) and must be 3 -

999 decimal.

e specifies the element number within the BCD file. It must be 0

- 999 decimal. Each element in a B CD file contains a number
between 0 - 9999.

b is optional. If specified, it indicates the bit (0 - 15 decimal).

Examples:
D20: 3

72
ABCIP Communication Driver Reference AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

D10: 0/3

ASCII String Section Items

STn: e[.f] n represents the file number (NOT optional) and must be 3 - 999
decimal.

e specifies the element number within the String file. It must be

0 - 779 decimal. Each element in a String file contains an ASCII
string with a maximum length of 82 characters.

f identifies the following ASCII string field: .LEN. If .f is omitted, it

is assumed to be the string.

Examples:
ST9: 0
ST9: 700
ST9: 700. LEN

Block Transfer Section Items

BTn: e[.f][/b] n represents the file number (NOT optional) and must be 3 - 999
decimal.

e specifies the element number (three words per element) within the
Block Transfer file (0 - 999 decimal).

f identifies one of the valid Block Transfer fields. The valid fields for
Block Transfer items are listed in the table. If .f is omitted, it is assumed
to be the word containing the status bits.

b is optional and is normally not used. Specifying the .f fields can

access all of the fields of a Block Transfer. However, it is possible to
use /b to single out a bit in the .FILE or .ELEM fields (which are words).
If specified, the bit number must be 0 - 15 decimal.

Note: Block Transfer files are read-only.

Examples:
BT9: 0.EN
BT9: 3.RLE N
BT9: 3.FILE

PID Section Items

PDn:e.f[/b] n represents the file number (NOT optional) and must be 3 - 999
decimal.

73
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide ABCIP Communication Driver Reference

e specifies the element number within the P ID file. It must be 0 - 398

decimal.

f identifies one of the valid PID fields. The valid fields for P ID files are
listed in the table. If PID field .ADDR is needed, use .ADRE for
element and .ADRF for file.

b is optional and is normally not used. All of the fields of a PID can be
accessed by specifying the .f fields. If specified, it indicates the bit (0 -
15 decimal).

Important: Access to PID files may degrade the Communic ation Driver's performance due to the
extreme size of the P ID element (82 words each). If accessing only a few P IDs at a time, performance will
not be greatly affected. If accessing a few fields of many PIDs at the same time, it may be faster to move
the needed fields to an intermediate file (Floating Point or Binary) and let the Communication Driver
access the intermediate files.

Examples:
PD9:2.SP
PD9:3.OLH
PD9:0.INI

SFC Status Section Items

SCn:e[.f][/b] n represents the file number (NOT optional) and must be 3 - 999
decimal.

e specifies the element number within the SFC Status file. It must be 0 -
999 decimal.

f identifies one of the valid SFC fields. The valid fields for SFC files are
listed in the table.

b is optional and is normally not used. Specifying the .f fields can

access all of the fields of an SFC. If specified, the bit number must be 0
- 15 decimal.

Examples:
SC9:0
SC9:0.PRE
SC9:0.SA

Message Section Items

MGn:e[.f] [/b] n represents the file number (NOT optional) and must be 3 - 999
decimal.

e specifies the element number within the SFC Status file. It must be 0
- 999 decimal.

74
ABCIP Communication Driver Reference AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

.f identifies one of the valid MSG fields. The valid fields for MSG files
are listed in the table.

b is optional and is normally not used. Specifying the .f fields can

access all of the fields of a .MG. However, it is possible to use /b to
single out a bit in the word fields. If specified, the bit number must be 0
- 15 decimal.

Important: Access to MSG files may degrade the Communication Driver's performance, due to the
extreme size of the MSG file element (56 words each). If accessing only a few MSG elements at one
time, performanc e will not be affected greatly. However, if accessing a few fields of many MSG file
elements at one time, it may be faster to move t he needed fields to an intermediate file (Binary or Integer)
and let the Communication Driver access the intermediat e files.

Examples:
MG9:0.NR
MG255:1.DLEN

CNetMessage Control Block Items

CTn:e[.f][/b] n represents the file number (NOT optional) and must be 3 -

999 decimal.

e specifies the element number within the CT file. It must be 0

- 999 decimal.

f identifies one of the valid CT fields. Valid CT fields are listed

in the table.

b is optional and normally not used. Specifying the .f fields

can access all of the fields of a CT. If specified, the bit number
must be 0 - 15 decimal.

Examples:
CT10:0
CT10:0. TO
CT10:0.ELEM

SLC500 Item Naming

The general format of item names for data from the SLC500 controllers matches the naming convention
used by the programming software. The format is as follows:
[$] X [ file] : element [.field] [/bit]

Note: The parts of the name shown in square brackets ([]) are optional.

Item Name Description

$ Purely optional.

75
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide ABCIP Communication Driver Reference

Item Name Description

X Identifies the file type.

The following table summarizes the valid file types, the default file number
for each type, and the fields allowed (if any).

file Identifies the file number.

 File numbers must be 0 - 255 decimal.
 File 0 must be Output.
 File 1 must be Input.
 File 2 must be Status.
 All other file numbers, 9 - 255 decimal, are open to all file types.

element Identifies the element number within a file.

 For Input and Output files it must be between 0 and 30 decimal.
 For all other file types, the element number must be 0 - 255 decimal.

.field Valid only for Counter, Timer, and Control files.

See the following table.

/bit Valid for all file types except ASCII String and Floating Point.
 For Input and Output files it must be 0 - 17 octal
 For all other file types it must be 0 - 15 decimal.

Default
Identifier File Type File # .fields

O Output* 0 N/A

I Input* 1 N/A

S Status 2 N/A

B Binary 3 N/A

T Timer 4 .PRE .ACC .EN .TT .DN

C Counter 5 .PRE .ACC. CU .CD .DN .OV .UN .UA

R Cont rol 6 .LEN .POS .EN .DN .ER .UL .IN .FD

N Integer 7 N/A

F Floating Point* 8 N/A

76
ABCIP Communication Driver Reference AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Default
Identifier File Type File # .fields

A ASCII* None N/A

ST ASCII String* None .LEN

*Available only on certain SLC500 models. Check the Processor Manual for the model being used.

Output File Items

O[n]:e[/b] n represents the file number and is optional. If specified, it

must be 0 (zero).

e indicates the element number in the file (0 - 255).

b specifies the bit (0 - 15 decimal). /b may be omitted, if

necessary, to treat the I/O group as a numeric value.

Note: The elements in I/O modules are sequentially mapped into a memory table, and are different from
the item names in the controller programming software. Refer to the Addressing SLC I/O Modules
section.

Examples:
O0:0/0
$O:2/15
O:3 4BCD (for 16-bit 7-segment display)

Input File Items

I[n]:e[/b] n represents the file number and is optional. If specified, it

must be 1 (one).

e indicates the element number in the file (0 - 255).

b specifies the bit (0 - 15 decimal). /b may be omitted if

necessary to treat the I/O group as a numeric value.

Note: The elements in I/O modules are sequentially mapped into a memory table and are different from
the item names in the controller programming software. Refer to the Addressing SLC I/O Modules
section.

Examples:
I1:0/0
I:2/15
I:3 4BCD (for 16-bit thumbwheel input)

77
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide ABCIP Communication Driver Reference

Addressing SLC I/O Modules

The elements (words) in I/ O modules are mapped into a memory table. If the Analog I/O modules are
being used, then the point naming will differ from the point naming in the programming soft ware. The
Communication Driver item name must be computed from the sum total of words used by the previous
input or output blocks. The operator can use the programming software Dat a Monitor to look at the
memory map of the I file or O file to verify your address. If the address is unsure, or if the controller
configuration is likely to change, copy the points in question to the N t able or B table, and access the data
from there.
The naming conventions used in the Allen-Bradley programming software are not supported by the
Allen-Bradley Ethernet Direct Communication Driver. The addressing convention is similar to that of the
PLC-5 family processors. To derive the correct address for each I/O point, see the following Diagram
System on page 78. Also see the following topics, Label I/O Modules with "Word Counts" on page 79,"
Sequentially Number the Input Modules on page 79, and Sequentially Number the Output Mo dules on
page 79, to complet e addressing the SLC I/O modules.

Diagram System
Addressing of the I/O points begins by drawing a schematic of the system. The following figure is a
diagram of the SLC-5/02 system.

The far left unit is the power supply.

From left to right, the modules are:

1747-L524 SLC-5/02 Module Processor

1746-IA8 8-point 120VAC input module

1746-OA 16 16-point 120VA C output module

1746-IA16 16-point 120VA C input module

1746-NI4 4-point 20mA analog input module

1746-NO4I 4-point 20mA analog output module

1746-0A8 8-point 120VAC input module

1746-IB32 32-point DC input module

78
ABCIP Communication Driver Reference AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Label I/O Modules with "Word Counts"

The address of any point within the I/O data table space, in an SLC processor, is the sum of the words
occupied by previous modules (to the left in the rack) of the same type. Therefore, to determine the
correct address for any particular point in the I/O data table, the number of words each module will
consume must be known. Refer to the following list:

Number of
Words Module

0 1747-L524 SLC-5/02 Module Processor

1 1746-IA8 8-point 120VAC input module

1 1746-OA 16 16-point 120VA C output module

1 1746-IA16 16-point 120VA C input module

4 1746-NI4 4-point 20mA analog input module

4 1746-NO4I 4-point 20mA analog output module

1 1746-0A8 8-point 120VAC input module

2 1746-IB32 32-point DC input module

Note: In the preceding table, the minimum number of words which can be consumed by a module is 1
(16-bits). This is due to the memory scheme of all Allen -Bradley processors.

Sequentially Number the Input Modules

In the following I/O diagram, the first input module's addressing should start with "I:0." As previously
noted, this module consumes one data table word. Therefore, the addressing of the next INPUT module
encounter, moving from left to right, will begin with "I:1," regardless of the module's physical location.

Sequentially Number the Output Modules

In the following I/O diagram, the first output card encount ered is the OA16. Although it is not in the first
slot, its address will be "O:0" ("OHH, colon, ZERO" ). This module consumes one data table word.
Therefore, the addressing of the next OUTPUT module, moving from left to right, will begin with "O:1,"
regardless of the module's physical location.
I/O Diagram

79
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide ABCIP Communication Driver Reference

Status File Items

S[n]:e[/b] n represents the file number and is optional. If specified, it must be 2

(two).

e indicates the element number in the file.

b is optional. If specified, it indicates the bit (0 - 15 decimal).

Note: Refer to the S LC500 Family Processor Manual (Allen -Bradley Publication) for a complete
description of the Status file information.

Examples:
S2:6 (major error fault)
S2:13 (math register)
S:1/5 (forces enabled)

Binary File Items

B[n]:e/b or n represents the file number and is optional. If not specified,

B[n]/m it is assumed to be 3 (t hree). If specified, the file number
must be 3 or 9 - 255 decimal.

e specifies the element (word) number within the Binary file.

It must be 0 - 255 decimal.

80
ABCIP Communication Driver Reference AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

b specifies the bit number within the word. In the first form
(where :e is present), the bit number must be 0 - 15 decimal.

m also represents the bit number. However, in the second

form, no word numbers are specified and the bit number may
be 0 - 4095.

Examples:
B:33
B:6/4 (same bit as B/100)
B3/4095 (same bit as B:255/15)

Timer File Items

T[n]:e[.f][/b] n represents the file number and is optional. If not

specified, it is assumed to be 4 (four). If specified, the file
number must be 4 or 9 - 255 decimal.

e specifies the element number (three words per element)

within the Timer file. It must be 0 - 255 decimal.

.f identifies one of the valid Timer fields. The valid fields for
Timer Files are listed in the table. If .f is omitted, it is
assumed to be the word containing the status bits.

b is optional and is normally not used. All of the fields of a

timer can be accessed by specifying the . f fields. However,
it is possible to use /b to single out a bit in the .PRE or
.ACC fields (which are words ). The bit number must be 0 -
15 decimal.

Examples:
T4:0.ACC
T4:3.DN
T4:1.PRE

Counter File Items

C[n]:e[.f][/b] n represents the file number and is optional. If not specified, it

is assumed to be 5 (five). If specified, the file number must be
5 or 9 - 255 decimal.

e specifies the element number (three words per element)

within the Counter file. It must be 0 - 255 decimal.

81
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide ABCIP Communication Driver Reference

.f identifies one of the valid Counter fields. The valid fields for
the Counter Files are listed in the table. If .f is omitted, it is
assumed to be the word containing the status bits.

b is optional and is normally not used. Specifying the .f fields

can access all of the fields of a counter. However, it is
possible to use /b to single out a bit in t he .PRE or .ACC fields
(whic h are words). The bit number must be 0 - 15 decimal.

Examples:
C5:0.ACC
C5:3.OV
C5:1.PRE

Control File Items

R[n]:e[.f][/b] n represents the file number and is optional. If not specified, it

is assumed to be 6 (six). If specified, the file number must be 6
or 9 - 255 decimal.

e specifies the element number (three words per element)

within the Control file. It must be 0 - 255 decimal.

f identifies one of the valid Cont rol fields. The valid fields for
the Control files are listed in the table. If .f is omitted, it is
assumed to be the word containing the status bits.

b is optional and is normally not used. All of the fields of a

Cont rol file can be accessed by specifying the .f fields.
However, it is possible to use /b to single out a bit in the .LEN
or .POS fields (whic h are words). The bit number must be 0 -
15 decimal.

Examples:
R6:0.LE N
R6:3.EN
R6:1.POS

Integer File Items

N[n]:e[/b] n represents the file number and is optional. If not

specified, it is assumed to be 7 (seven). If specified, the
file number must be 7 or 9 - 255 decimal.

82
ABCIP Communication Driver Reference AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

e specifies the element number within the Integer file. It

must be 0 - 255 decimal.

b is optional. If specified, it indicates the bit (0 - 15

decimal).

Examples:
N7:0
N7:0/15
N7:3

Floating Point File Items

F[n]:e n represents the file number and is optional. If not

specified, it is assumed to be 8 (eight). If specified, the file
number must be 8 - 255 decimal.

e specifies the element number within the Floating Point

file. It must be 0 - 255 decimal.

Examples:
F8:0
F8:3

ASCII File Items

An:e[/b] n represents the file number (NOT optional) and must be

9 - 255 decimal.
An:x-y
e specifies the element number within the AS CII file. It
must be 0 - 255 decimal. Each element in an ASCII file
contains two ASCII characters.

b is optional. If specified, it indicates bit (0 - 15 decimal).

x and y also specify element numbers. In this form, the

item is an ASCII string occupying element x through
element y. Each element contains two ASCII characters:
the first character is the high-order byte and the second
is the low-order, and so on.

Note: If reading only one word as a two-character string, the range must be "x-x." For example, A20:3-3.

Examples:
A20:3
A10:0/0
A9:0-19 (40-character ASCII string)

83
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide ABCIP Communication Driver Reference

ASCII String Section Items

STn: e n represents the file number (NOT optional) and must be

9 - 255 decimal.

e specifies the element number within the String file. It

must be 0 - 255 decimal. Each element in a String file
contains an ASCII string wit h a maximum length of 82
characters.

Examples:
ST9: 0
ST9: 200

MicroLogix Item Naming

The general format of item names for data from the MicroLogix controllers matches the naming
convention used by the programming software. The following is the format:
[$] X [ file] : element [.field] [/bit]

Note: The parts of the name shown in square brackets ([]) are optional.

Item Name Description

$ Purely optional.

X Identifies the file type.

The following table summarizes the valid file types, the default file number for
each type, and the fields allowed (if any).

file Identifies the file number.

 File numbers must be 0 - 999 decimal.
 File 0 (zero) must be Output.
 File 1 (one) must be Input.
 File 2 (two) must be Status.
 All other file numbers, 9 - 255 decimal, are open to all file types.

element Identifies the element number within a file.

 For Input and Output files it must be between 0 and 777 octal.
 For all other file types it must be 0 - 999 decimal.

.field Valid only for Counter, Timer, ASCII String, P ID, SFC Status, Block Trans fer,
and Cont rol files.
Refer to the following table.

84
ABCIP Communication Driver Reference AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Item Name Description

/bit Valid for all file types except ASCII String and Floating Point.
 For Input and Output files it must be 0 - 17 octal.
 For all other file types it must be 0 - 15 decimal.

Default
Identifier File Type File # .fields

O Output 0 N/A

I Input 1 N/A

S Status 2 N/A

B Binary 3 N/A

T Timer 4 .PRE .ACC .EN .TT .DN

C Counter 5 .PRE .ACC .CU .CD .DN .OV .UN

R Cont rol 6 .LEN .POS .EN .EU .DN .EM .ER .UL .IN .FD

N Integer 7 N/A

F Floating Point 8 N/A

A ASCII None N/A

L Long None N/A

ST ASCII String* None .LEN

PD PID* None .TM .AM .CM .OL .RG .SC . TF .DA .DB .UL
.LL .SP .PV .DN .EN .SPS .KC .TI . TD .MA XS
.MINS . ZCD .CVH . CVL .LUT .SPV .CVP

MG Message None .IA .RBL .LBN .RB N .CHN .NOD .MTO .NB
.TFT . TFN .ELE .SEL .TO .CO .EN .RN .EW
.DN .ER .ST

* Available only on certain MicroLogix models. Check the Processor Manual for the model being used.

Output File Items

O[n]:e[/b] n represents the file number and is optional. If s pecified, it must

be 0 (zero).

85
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide ABCIP Communication Driver Reference

e indicates the element number in the file (0 - 255).

b specifies the bit (0 - 15 decimal). /b may be omitted, if

necessary, to treat the I/O group as a numeric value.

Note: The elements in I/O modules are sequentially mapped into a memory table, and are different from
the item names in the controller programming software. MicroLogix and SLC500 adopt the same I/O
addressing format. Refer to the Addressing SLC I/O Modules section for det ails.

Examples:
O0:0/0
$O:2/15
O:3 4BCD (for 16-bit 7-segment display)

Input File Items

I[n]:e[/b] n represents the file number and is optional. If specified, it

must be 1 (one).

e indicates the element number in the file (0 - 255).

b specifies the bit (0 - 15 decimal). /b may be omitted if

necessary to treat the I/O group as a numeric value.

Note: The elements in I/O modules are sequentially mapped into a memory table and are different from
the item names in the controller programming software. MicroLogix and SLC500 adopt the same I/O
addressing format. Refer to the Addressing SLC I/O Modulessection for details.

Examples:
I1:0/0
I:2/15
I:3 4BCD (for 16-bit thumbwheel input)

Status File Items

S[n]:e[/b] n represents the file number and is optional. If specified, it must

be 2 (two).

e indicates the element number in the file.

b is optional. If specified, it indicates the bit (0 - 15 decimal).

Note: Refer to the S LC500 Family Processor Manual (Allen -Bradley Publication) for a complete
description of the Status file information.

Examples:
S2:6 (major error fault)
S2:13 (math register)
S:1/5 (forces enabled)

86
ABCIP Communication Driver Reference AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Binary File Items

B[n]:e/b or n represents the file number and is optional. If not specified,

B[n]/m it is assumed to be 3 (t hree). If specified, the file number
must be 3 or 9 - 255 decimal.

e specifies the element (word) number within the Binary file.

It must be 0 - 255 decimal.

b specifies the bit number within the word. In the first form
(where :e is present), the bit number must be 0 - 15 decimal.

m also represents the bit number. However, in the second

form, no word numbers are specified and the bit number
may be 0 - 4095.

Examples:
B:33
B:6/4 (same bit as B/100)
B3/4095 (same bit as B:255/15)

Timer File Items

T[n]:e[.f][/b] n represents the file number and is optional. If not

specified, it is assumed to be 4 (four). If specified, the file
number must be 4 (four) or 9 - 255 decimal.

e specifies the element number (three words per element)

within the Timer file. It must be 0 - 255 decimal.

.f identifies one of the valid Timer fields. The valid fields for
Timer Files are listed in the table. If .f is omitted, it is
assumed to be the word containing the status bits.

b is optional and is normally not used. All of the fields of a

timer can be accessed by specifying the .f fields.
However, it is possible to use /b to single out a bit in the
.PRE or .ACC fields (which are words). The bit number
must be 0 - 15 decimal.

Examples:
T4:0.ACC
T4:3.DN
T4:1.PRE

Counter File Items

87
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide ABCIP Communication Driver Reference

C[n]:e[.f][/b] n represents the file number and is optional. If not specified, it

is assumed to be 5 (five). If specified, the file number must be 5
(five) or 9 - 255 decimal.

e specifies the element number (three words per element)

within the Counter file. It must be 0 - 255 decimal.

.f identifies one of the valid Counter fields. The valid fields for
the Counter Files are listed in the table. If .f is omitted, it is
assumed to be the word containing the status bits.

b is optional and is normally not used. Specifying the .f fields

can access all of the fields of a count er. However, it is possible
to use /b to single out a bit in the .PRE or .A CC fields (which are
words). The bit number must be 0 - 15 decimal.

Examples:
C5:0.ACC
C5:3.OV
C5:1.PRE

Control File Items

R[n]:e[.f][/b] n represents the file number and is optional. If not specified, it is

assumed to be 6 (six). If specified, the file number must be 6
(six) or 9 - 255 decimal.

e specifies the element number (three words per element) wit hin
the Control file. It must be 0 - 255 decimal.

f identifies one of the valid Control fields. The valid fields for the
Cont rol files are listed in the table. If .f is omitted, it is assumed
to be the word containing the status bits.

b is optional and is normally not used. All of the fields of a

Cont rol file can be accessed by specifying the . f fields. However,
it is possible to use /b to single out a bit in the .LEN or .POS
fields (which are words). The bit number must be 0 - 15 decimal.

Examples:
R6:0.LE N
R6:3.EN
R6:1.POS

88
ABCIP Communication Driver Reference AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Integer File Items

N[n]:e[/b] n represents the file number and is optional. If not specified, it

is assumed to be 7 (seven). If specified, the file number must
be 7 (seven) or 9 - 255 decimal.

e specifies the element number within the Integer file. It must

be 0 - 255 decimal.

b is optional. If specified, it indicates the bit (0 - 15 decimal).

Examples:
N7:0
N7:0/15
N7:3

Floating Point File Items

F[n]:e n represents the file number and is optional. If not specified, it

is assumed to be 8 (eight). If specified, the file number must be
8 - 255 decimal.

e specifies the element number within the Floating Point file. It

must be 0 - 255 decimal.

Examples:
F8:0
F8:3

ASCII String Section Items

STn: e n represents the file number (NOT optional) and must be 9 -

255 decimal.

e specifies the element number within the String file. It must

be 0 - 255 decimal. Each element in a String file contains an
ASCII string with a maximum length of 82 characters.

Examples:
ST9: 0
ST9: 200

Long Integer Section Items

89
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide ABCIP Communication Driver Reference

Ln:e[/b] n represents the file number. If not specified, it is

assumed to be 0 (zero). If specified, the file number must
be 0 - 255 decimal.

e specifies the element number within the Long Integer

file. It must be 0 - 255 decimal.

b is optional. If specified, it indicates the bit (0 - 31

decimal).

Examples:
L15:3

PID Section Items

PDn:e[.f][/b] n represents the file number. If not specified, it is

assumed to be 0 (zero). If specified, the file number must
be 0 - 255 decimal.

e specifies the element number within the P ID file. It

must be 0 - 255 decimal.

.f identifies one of the valid PID fields. The valid fields for
PID files are listed in the table.

b is optional and is normally not used. Specifying the .f

fields can access all of the fields of a PID. If specified, it
indicates the bit (0 - 15 decimal).

Important: Access to PID files may degrade the Communic ation Driver's performance, due to the
extreme size of the PID element (23 words each). If accessing only a few PIDs at one time, performance
will not be affected greatly. However, if accessing a few fields of many PIDs at once, it may be faster to
move the needed fields to an int ermediate file (Floating Point or Binary) and let the Communication
Driver access the intermediate files.
Examples:
PD:0.SP
PD9:3.LUT
PD1:0.CVP

Message Section Items

MGn:e[.f] [/b] n represents the file number. If not specified, it is

assumed to be 0 (zero). If specified, the file number
must be 0 - 255 decimal.

e specifies the element number within the String file. It

must be 0 - 255 decimal.

.f identifies one of the valid MS G fields. The valid fields

for MSG files are listed in the table.

90
ABCIP Communication Driver Reference AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

b is optional and is normally not used. Specifying the . f

fields can access all of t he fields of a timer. However, it
is possible to use /b to single out a bit in the .PRE or
.ACC fields (which are words). For Timer files, the bit
number must be 0 - 15 decimal.

Important: Access to MSG files may degrade the Communication Driver's performance, due to the
extreme size of the MSG file element (56 words each). If accessing only a few MSG elements at one
time, performanc e will not be affected greatly. However, if accessing a few fields of many MSG file
elements at once, it may be faster to move the needed fields to an intermediate file (Binary or Integer)
and let the Communication Driver access the intermediat e files.

Examples:
MG9:0.NOD
MG255:1.ELE

Communication Driver-Specific System Item

The system items described in this section refers to specific information regarding the Communication
Driver, OI Server Manager, and the controllers.
The following generic system items are supported for all Allen -Bradley controllers, unless otherwise
noted.

Type/
System Item Name Acce ss Rights Description Values

$SYS$DeviceStatus String/Read Status of the processor. RANGE:

OK or faulted

$SYS$Mode String/Read Current mode of the processor. RANGE:

Run, Program,
Remote Run, or
Remote Program

$SYS$PLCTy pe String/Read Name of the process type. Descriptive text

for the process
type.
$SYS$ProcessorName String/Read Name of the program running in the Descriptive text
processor. for the
corresponding
processor name.
$SYS$Revision String/Read Firmware of the processor. Descriptive text
for the firmware
revision.

91
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide ABCIP Communication Driver Reference

Type/
System Item Name Acce ss Rights Description Values

$SYS$Updat eTagInfo Boolean/ Force updat e of the whole RANGE:

ReadWrite controller tag database. On or Off
The OI Server returns
WriteComplete for
$SYS$Updat eTagInfo when poked.
The transaction will be complet ed
with no timeout.
Note: The value in $SYS$Update
TagInfo will return to "0" from "1"
after the process is finished.
Note: The OI Server will implement
manual and automated updates of
the ControlLogix tag database in
the event that you add or delete
items by direct controller
programming.
Warning! Updating a tag
database online consume s
resource s. During the updating
proce ss, the Communication
Driver may be held up from
updating the client application.

The following tag-database-specific system items are supported for all Allen -Bradley controllers, unless
otherwise noted.

Type/
System Item Name Acce ss Rights Description Values

$SYS$BrowseTags Boolean/ Indicates whether the controller RANGE: True or

ReadWrite tags are browsable from OP C false
client.
If a TRUE value is written to this
item, the controller tags will
become browsable, provided that
the tag database is ready at the
time.
If a FALSE value is written to this
item, all controller tags will not be
browsable.
$SYS$TagDBStatus String/ Indicates the status of the tag
Read-Only database as follows:

92
ABCIP Communication Driver Reference AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Type/
System Item Name Acce ss Rights Description Values

Uninitializ ed – The tag databas e is Uninitializ ed

uninitialized, typically in a start
state.
Uploading – The tag database is Uploading
being uploaded from the controller

Uploaded – The tag database has Uploaded

been completely uploaded from the
controller.

Error – The tag database is not Error

uploaded bec ause of errors
encountered during the upload

$SYS$TagDBVersion String/ Indicates the version of the Tag RANGE: Major

Read-Only database. version: 0...65535
(no padding)
String format: MajorVersion.
MinorV ersion Minor version:
0...999 (no
If version information cannot be
padding)
acquired (for example, due to a bad
PLC connection) the value initially
displays "Uninitialized" as a string.
$SYS$Updat eTagInfo Boolean/ Forces update of the controller tag RANGE: True or
ReadWrite database upon adding the next false
item for advise or poking any value
to an existing item (On or Off).

The following Logix5000 system items are supported for ControlLogix, CompactLogix, and FlexLogix
processors, unless otherwise noted.

Type/
System Item Name Acce ss Rights Description Values

$SYS$DeviceS ecurity Boolean/ Status of controller security RANGE:

Read-Only True or False

93
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide ABCIP Communication Driver Reference

Type/
System Item Name Acce ss Rights Description Values

$SYS$Optimization Boolean/ Indicates the status of Cont rolLogix RANGE:

Read-Only message optimization in handle True or False
mode as enabled with the
Cont rolLogix Optimization check
box under the Logix5000 node
editor in OI Server Manager (True
or False). If:
FALSE - no message optimization
will be used.
TRUE - either the ‘Optimized for
read’ option or the ‘Optimized for
startup’ is being used.

$SYS$UDTOptimization Boolean/ Indicates the status of the RANGE:

Read-Only Cont rolLogix user-defined data True or False
type optimization enabled with the
User Defined Data Type
Optimization check box under the
Logix5000 node edit or in the OI
Server Manager (On or Off).

$SYS$FreeMem DWord/ Returns the current unused RANGE:

Read-Only memory, in number of bytes, in the 0…2147483647
Logix processor (I/O + data table +
general).
This item is not supported on ControlLogix
L8x controllers. For L8x controllers, quality
will be 0x07 (CONFIG_ERROR and
LIMIT_CONSTANT).

$SYS$FreeMemDT DWord/ Returns the unused data table RANGE:

Read-Only memory in number of bytes. 0…2147483647
This item is not applicable to 1756-L1, and is
not supported on ControlLogix L8x
controllers. For L8x controllers, quality will
be 0x07 (CONFIG_ERROR and
LIMIT_CONSTANT).

$SYS$FreeMemGM DWord/ Returns the total available general RANGE:

Read-Only memory in number of bytes. 0…2147483647
This item is applicable to 1756-L55M16 only,
and is not supported on ControlLogix L8x
controllers. For L8x controllers, quality will
be 0x07 (CONFIG_ERROR and
LIMIT_CONSTANT).

$SYS$FreeMemIO DWord/ Returns the total available I/O RANGE:

Read-Only memory in number of bytes. 0…2147483647
This item is not supported on ControlLogix
L8x controllers

94
ABCIP Communication Driver Reference AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Type/
System Item Name Acce ss Rights Description Values

$SYS$TotalMem DWord/ Returns the total memory, in RANGE:

Read-Only number of bytes, in the Logix 0…2147483647
processor.
This item is not supported on ControlLogix
L8x controllers

$SYS$TotalMemDT DWord/ Returns the total available data RANGE:

Read-Only table memory in number of bytes. 0…2147483647
This item is not applicable to 1756-L1, and is
not supported on ControlLogix L8x
controllers.

$SYS$TotalMemGM DWord/ Returns the total available general RANGE:

Read-Only memory in number of bytes. 0…2147483647
This item is applicable to 1756-L55M16 only,
and is not supported on ControlLogix L8x
controllers.

$SYS$TotalMemIO DWord/ Returns the total available I/O RANGE:

Read-Only memory in n umber of bytes. 0…2147483647
This item is not supported on ControlLogix
L8x controllers

The following system items are supported by eac h communications node in the AB CIP Communication
Driver, unless otherwise noted.

Type/
System Item Name Acce ss Rights Description Values

$SYS$OpenConnections DWord/ Returns the number of open CIP RANGE:

Read-Only connections. 0…2147483647

$SYS$ConnectionsInitiat DWord/ Returns the number of CIP RANGE:

ed Read-Only connections initiated by the server. 0…2147483647

$SYS$ConnectionsRefus DWord/ Returns the number of CIP RANGE:

ed Read-Only connections refused by the 0…2147483647
communications module.
$SYS$RequestSent DWord/ Returns the number of message RANGE:
Read-Only requests originating from the 0…2147483647
communications module.

$SYS$ReplyReceived DWord/ Returns the number of reply RANGE:

Read-Only packets received. 0…2147483647
$SYS$UnsolReceived DWord/ Returns the number of unsolicited RANGE:
Read-Only messages received by the 0…2147483647
communications module.

95
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide ABCIP Communication Driver Reference

Type/
System Item Name Acce ss Rights Description Values

$SYS$Unsolreplied DWord/ Returns the number of replies sent RANGE:

Read-Only in response to the unsolicited 0…2147483647
message.
$SYS$RequestErrors DWord/ Returns the number of errors for RANGE:
Read-Only the requests sent. 0…2147483647

$SYS$RequestTimeout DWord/ Returns the number of request RANGE:

Read-Only timed out 0…2147483647
$SYS$ResetStatistics Boolean/ The item $SYS$ResetStatistics is RANGE:
Write-Only available at root hierarchy True or False
PORT_CIP and will res et statistic
counters of all child nodes.

$SYS$TotalP acketSent DWord/ Returns the number of data RANGE:

Read-Only packets sent. 0…2147483647

$SYS$TotalP acketReceiv DWord/ Returns the number of replies RANGE:

ed Read-Only received. 0…2147483647

$SYS$RateSent DWord/ Returns the number of packets sent RANGE:

Read-Only per second 0…2147483647

$SYS$RateReceived DWord/ Returns the number of packets RANGE:

Read-Only received per second. 0…2147483647

$SYS$ItemUpdateRate DWord/ Returns the number of read items RANGE:

Read-Only received per second. 0…2147483647

$SYS$ItemW riteRate DWord/ Returns the number of write items RANGE:

Read-Only sent out per second. 0…2147483647

Important: The Redundant Hierarchy, including the Device Group, is not hot -configurable, and requires
a Reset on the Redundant Hierarchy to effect a configuration change.

96
ABCIP Communication Driver Reference AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Generic OPC Syntax

Communication Driver serves as a container for the OP C Groups, which provide the mechanism for
containing and logically organizing OP C items. Within each OPC Group, an OP C-compliant client can
register OPC items, which represent connections to data sources in the field device. In other words, all
access to OPC items is maintained through the OP C Group.
The fully qualified name for an OPC item is called the Item ID (equivalent to the union of Link Name and
Item Name). The syntax for specifying a unique It em ID is OI Server -dependent. In OPC data acquisition
Communication Drivers, the syntax can be as follows:
AREA10.VESSEL1.TIC1.PLC.N7:11
where each component (delimit ed by a hint, that is, a period in case of Communication Driver) represents
a branch or leaf of the field device’s hierarchy.
In this example:
 AREA10.VESSEL1. TIC1 is the link name for Communication Driver.
 PLC is the name of the target controller.
 N7:11 is the specific data point (Item) desired.
 An item is typically a single value such as an analog, digital, or string value.
Where Item ID describes the syntax for defining the desired data point, OPC provides for another
parameter, called Access Path, that defines optional specifications for obtaining that data.
In Communication Drivers, Access Paths are equivalent to Devic e Groups; it is this parameter that is
used to define the update interval between the Co mmunic ation Driver and the field device for accessing
the values of data points in the controller.

97
 AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

C HAPTER 5
Troubleshooting the ABCIP Communication
Driver

Troubleshooting with Windows Tools

Windows has two tools that may be useful in troubleshooting performance problems.
You can find quick verification that the Communication Driver process is running by looking at the
Windows Task Manager. It also provides information on the user, CP U, and memory usage of the
processes.
If you need more information, or need to gather data while not logged in, you can use the Performance
and Alerts application. For more information, see the Microsoft Management Cons ole (MMC) help files
on the Performance application. The Performance application is one of the administrative tools found in
the Windows Control Panel.

Troubleshooting with the OI Server Manager

The OI Server Manager has information that may be useful in troubleshooting problems. When the
Communication Driver is active, a diagnostic node is present below t he configuration node in the c onsole
tree of the System Management Console.
Each diagnostic leaf contains information about Communication Driver activity. For more information,
see the Communication Drivers Pack Help.

Finding Version Information

If you contact Technical Support, you may need to supply version information.
To determine the OI Server Manager version
 In the OI Server Manager, right-click OI Server Manager, and then click About OI Server Manager.
An About box appears showing the version and build date of the OI Server Manager.
To determine version information for Communication Driver components
 In the OI Server Manager, select the Communication Driver name in the console tree. The version
information for each Communication Driver component is shown in the details pane.

Using the Log Viewer

Error messages are created by the Communication Driver and logged by the Logger. You can view these
messages with the Log Viewer. The Log Viewer help files explain how to view messages and how to filter
which messages are shown.
Log Flags are categories of messages. The Log Flag Editor User Guide contains an explanation of the
categories. Using the Log Flag Editor, you can specify which log flags the Communication Driver creates.

99
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideTroubleshooting the ABCIP Communication Driver

Note: Generating large numbers of diagnostic messages can impact Communication Driver
performance. You should not run in production with any more flags than those set when the
Communication Driver is installed. To troubles hoot you can turn on more flags, but there is a
performance impact. For more information, see the Log Flag Editor User Guide.

To open the Log Flag Editor

1. In the System Management Console, expand Log Viewer and then expand the log viewer group.
2. Select Local.
3. On the Action menu, click Log Flags.
In general, look at error and warning messages to determine if a problem exists. To det ermine whether
the Communication Driver is communicating with a device, you can enable the DASSend and
DASRec eive log flags. From these you can determine whether or not the device is responding.

Basic Log Flags

The basic log flags for all ArchestrA components are:
 Error: A fatal error, the program cannot continue. By default set on by logger.
 Warning: The error is recoverable. A client called with a bad parameter, or the result of some
operation was incorrect, but the program can continue. By default set on by logger.
 Start-Stop: Each main component logs a message to this category as it starts and stops.
 Info: General diagnostic messages.
 Ctor-Dtor: C++ classes of interest log messages to this category as they are constructed and
destructed.
 Entry-Exit: Functions of interest log messages to this category as they are called and return.
 Thread Start -Stop: All threads should log messages to this category as they start and stop.

Communication Driver Log Flags

Messages creat ed for these log flags are for Communication Driver common components and contain
information about internal Com munication Driver activities.
 DACmnProtFail: Some failure occurred in the common components while sending a message,
updating an item, or otherwise moving data. Typically, this repres ents some unexpected behavior in
the server-specific DLL.
 DACmnProtWarn: Some problem occurred that interfered with sending messages, updating items,
or otherwise moving data. Common examples are slow poll, value limiting during type conversion,
and transaction timeout messages.
 DACmnTrace: Normal processing of client program requests and data movement to and from the
server-specific DLL are traced on this log flag. Use this in conjunction with DA CmnV erbose to get the
most information.
 DACmnVerbose: Many log flags used by the DAS common components are modified occasionally
by DACmnV erbose. When DACmnVerbos e is set, the logging of messages on other log flags
includes more information.
 DACmnSend: Operations within the DAS Engine DLL that revolve around sending messages to the
server-specific DLL.
 DACmnReceive: E vents surrounding messages that are returned to the DAS Engine by the
server-specific DLL, including the blocking and unblocking of hierarchies.

100
Troubleshooting the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Communication Driver-Device Interface Log Flags

Messages creat ed for the following log flags are specific to an individual Communication Driver and
contain information about communications bet ween the Communication Driver and device.
 DASProtFail: An error in the protocol occurred, for example, device disconnected. The program can
continue, and, in fact, this category is expected during normal operation of the program. Must be set
on by the generic DAS code when the Communication Driver starts.
 DASProtWarn: Something unexpected occurred in the protocol, for example, a requested item with
an otherwise valid item name is not supported by this device. Must be set on by the generic DAS
code when the Communication Driver starts.
 DASStateCat1: General diagnostic messages of a protocol-s pecific nat ure. For example, you can
provide the number of items in a message for a specific protocol, then optimize bas ed on the
number.
 DASVerbose: Modifies all other DAS logging flags. When on, provides detailed messages.
 DASSend: Protocol messages sent to the device are logged to this category.
 DASRec eive: Protocol messages received from the devic e are logged to this category.
 DASStateCat1, DASStateCat2, DASStateCat3, DASStateCat4: These are general categories for
use by the server developer. As DeviceEngine-generated state machines are created by the
Communication Driver, they can be told to log state machine messages to one of the following:
DASStateCat1, DASStateCat2, DASStateCat3, or DASStateCat4. These messages indicate when a
state is made the active state, when a state handler is run, when a state handler completes, and
when a timeout occurs for a state machine.
 DASStateMachine: By default, DeviceEngine -generat ed state machines created by the
Communication Driver log to this category unless specifically told to log to one of the DASStateCatN
categories. In addition, general state machine messages are logged to this category. These
messages indicate when a state machine is created and delet ed.

Error Codes and Error Messages

This section describes the various error codes and er ror messages that might appear when working with
the ABCIP Communication Driver.

ABCIP Communication Driver Error Codes

There are two server-specific error codes, shown in the following table, that augment those provided by
the Operations Integration Toolkit.

Error Code Logger Message Log Flag

-10001 PLC not connected DASProtFail

-10002 PLC times out DASProtFail

Logix5000 Error Codes

The Logix5000 processor generates error conditions. The following tables show these errors and the
server-specific strings generated by the Communication Driver to the logger.

Note: All of the error messages shown in the following table apply to the DASProtFail log flag.

101
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideTroubleshooting the ABCIP Communication Driver

General Allen-Bradley
Error Code (High byte =
00) Logger Message

00 Success

01 Connection failed

02 Insufficient Connection Manager resources

03 Invalid connection number

04 IOI could not be deciphered. Either it was not formed correctly

or the match tag does not exist

05 The particular item referenc ed could not be found

06 The amount of data requested would not fit into the response
buffer. Partial data transfer has occurred.

07 Connection has been lost

08 Requested service not supported

09 Error in data segment or invalid attribute number

0A An error has occurred trying to process one of the attribut es

0C Service cannot be performed while object is in current state

10 Service cannot be performed while device is in current state

11 Response data too large

13 Not enough command data/parameters were supplied in the

command to execute the service requested

14 Attribute not support ed

15 Too much data was received

1C An insufficient number of attributes were provided compared

to the attribute count

1E Errors encountered with the items in the message

26 The IOI word length did not match the amount of IOI which was
processed

102
Troubleshooting the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

General Allen-Bradley
Error Code (High byte =
00) Logger Message

None of the above codes Unknown Status

Extended
Allen-Bradley Error
Code (Hex) Logger Message

2104 The beginning offset was beyond the end of the template.

2105 You have tried to access beyond the end of the dat a object.

2106 Data in use.

2107 The abbreviated type does not match the data type of the data
object.

0100 Connection in Use or Duplicate Forward Open.

0103 Trans port Class and Trigger combination not support ed.

0106 Ownership Conflict.

0107 Connection not found at target application.

0108 Invalid Connection Type. Indicates a problem with either the

Connection Type or Priority of the Connection.

0109 Invalid Connection Size.

0110 Device not configured

0111 RPI not supported. May also indicate problem with connection
time-out multiplier.

0113 Connection Manager cannot support any more connections.

0114 Either the Vendor ID or the Product Code in the key segment did
not match the device.

0115 Product Type in the key segment did not match the device.

103
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideTroubleshooting the ABCIP Communication Driver

Extended
Allen-Bradley Error
Code (Hex) Logger Message

0116 Major or Minor Revision information in the key segment did not
match the device.

0117 Invalid Connection Point.

0118 Invalid Configuration Format.

0119 Connection request fails since there is no controlling connection

currently open.

011A Target Application cannot support any more connections.

011B RPI is smaller than the Production Inhibit Time.

0203 Connection cannot be closed since the connection has timed out.

0204 Unconnected Send timed out waiting for a response.

0205 Parameter Error in Unc onnected Send Service.

0206 Message too large for Unconnected message service.

0207 Unconnected acknowledge without reply.

0301 No buffer memory available.

0302 Network Bandwidth not available for data.

0303 No Tag filters available.

0304 Not Configured to send real -time data.

0311 Port specified in Port Segment Not A vailable.

0312 Link Address specified in Port Segment Not A vailable.

0315 Invalid Segment Type or Segment Value in Path.

0316 Path and Connection not equal in close.

0317 Either Segment not present or Encoded Value in Network

Segment is invalid.

0318 Link Address to Self Invalid.

104
Troubleshooting the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Extended
Allen-Bradley Error
Code (Hex) Logger Message

0319 Resources on Secondary Unavailable.

031A Connection already established.

031B Direct connection already established.

031C Miscellaneous.

031D Redundant connection mismatch.

None of the above Unknown Extended Status.

codes

Note: For more information about the general and extended Allen -Bradley error codes, please refer to
the Allen-B radley controller documentation.

Data Highway Plus Error Conditions

The Data Highway Plus generates error conditions. Thes e error conditions and the server -specific
strings are generated by the Communication Driver to the logger.

Note: All of the error messages shown in the following table apply to the DASProtFail log flag.

Allen Bradley Error Code Logger Message

DHPE RR_DP _FNC (0x20000001) Dual-port memory functionality test error

DHPE RR_RAM (0x20000002) Unknown random access memory test error

DHPE RR_RAM (0x20000003) Failure of Z80 RAM 0

DHPE RR_RAM (0x20000004) Failure of dual-port RAM

DHPE RR_RAM (0x20000005) Failure of Z80 RAM 1

DHPE RR_RAM01 (0x20000006) Failure of both Z80 RAM 0 and RAM 1

DHPE RR_RAM1_DP (0x20000007) Failure of both RAM 1 and Dual-P ort RAM

DHPE RR_CTC (0x20000008) Unknown counter timer circuit test error

DHPE RR_CTC_TMR (0x20000009) Failure of CTC timer module

DHPE RR_CTC_CNT (0x2000000A ) Failure of CTC counter module

DHPE RR_CTC_TC (0x2000000B) Failure of both CTC timer and counter modules

DHPE RR_SIO (0x2000000C) Unknown serial input output test error

105
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideTroubleshooting the ABCIP Communication Driver

Allen Bradley Error Code Logger Message

DHPE RR_SIO_INT (0x2000000D) Failure of CIO channel: no interrupt

DHPE RR_SIO_LOOP (0x2000000E ) Failure of SIO channel A: Loopback failure

DHPE RR_PROT_LOA D Protocol file download error

(0x2000000F)

DHPE RR_LOAD_B LK (0x20000010) Block too large error

DHPE RR_RAM_FULL (0x20000011) Z80 RAM too full for next block

DHPE RR_BD_WRITE (0x20000012) Cannot write to adapter card memory

DHPE RR_OPE N_LOADP CL Cannot open file LOADP CL.BIN

(0x20000013)

DHPE RR_OPE N_KLP CL Cannot open file KLP CL.BIN

(0x20000014)

DHPE RR_OPE N_KLS T0 Cannot open file KLS T0.BIN

(0x20000015)

DHPE RR_OPE N_KLS T1 Cannot open file KLS T1.BIN

(0x20000016)

DHPE RR_OPE N_KLS T2 Cannot open file KLS T2.BIN

(0x20000017)

DHPE RR_OPE N_P ROT Cannot open prot ocol file

(0x20000018)

TIMEOUT_E RR (0x01) Timeout error

CANCELLED_E RR (0x02) Canc elled error code

ABCIP Communication Driver Error Messages

The following table lists the error messages produced by the Communication Driver that are logged to
the Log Viewer.
 <Message ID> corresponds to the message ID displayed in the Communication Driver’s Diagnostics
root in the OI Server Manager.
 <Devic e> refers to the node name of the device.

Note: All of the error messages shown in the following table apply to the DASProtFail log flag.

106
Troubleshooting the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Error Message Explanation Probable Cause Solution

A PLC (IP:< IPAddress>) The maximum number The maximum Decrease the number of
attempted to send us an of sockets used for number of sockets unsolicited data to
unsolicited data packet. unsolicited data used for unsolicited communicate to the
But the maximum number communications has data communications socket.
of simultaneous been reached. No has been reached.
unsolicited data more unsolicited data
connections [MA X socket] packages will be
has already been accepted.
reached. Data packet
ignored.

ABCIPAcceptedSocket: Unable to associate Software internal Restart the

Initialize unable to the event with a valid error. Communication Driver
associate an event with a handle within the and try again.
handle internal state
computer.

Array index error found The Bit number Bit number is out of Verify and specify the
while formatting message specified in the item is range correct bit number
for block <Block Number> out of range appropriate for the data
type of the item tag.

Attempt to resolve remote Failed to resolve the The HostName Check if the HostName
hostname <HostName> HostName. cannot be translated is configured correctly in
failed to a valid IP address the server.
internally.
Cannot create optimize The server failed to It is an internal error.
structure for item <Item create internal
Name> message structure.
<MessageID>
Connection to < Target Error is returned from Indicated by OS
Address> on port <Port the OS while trying to returned <Error
Number> failed with error establish the socket Code>.
<Error Code>. connection.
Connection to < Target No connection can be The target address is Check the device
Address> on port <Port made becaus e the not a ControlLogix configured with the
Number> refused. target device actively Ethernet Module. address.
refused it.
Encountered the following Error codes are Depends on the CIP Check to see if there are
error in reply message returned in the errors ret urned (refer other error messages in
<Message ID> when poll-message to the tables in the logger. Check the
reading from <Device> response from the Logix5000 Error Communication Driver
devic e; further Codes). diagnostics, if
explanations follow. necessary.

107
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideTroubleshooting the ABCIP Communication Driver

Error Message Explanation Probable Cause Solution

Encountered the following Error codes are Depends on the CIP Check to see if there are
error in reply message returned in the errors ret urned (refer other error messages in
<Message ID> when poke-message to the tables in the logger. Check the
writing to <Device> response from the Logix5000 Error Communication Driver
devic e; further Codes). diagnostics, if
explanation follows. necessary.
Encountered the following Error codes are Depends on the CIP Check to see if there are
error when reading block returned in the request errors ret urned (refer other error messages in
<Block Item Name> in block for Multi-Request to the tables in the logger.
message <Message ID> messages. Logix5000 Error Check the
from <Device> Further explanation of Codes on page 101). Communication Driver
the errors will be listed. diagnostics, if
necessary.
Encountered the following The error code is This is an internal
error when reading returned from the error. See the CIP
optimized block <Internal Cont rolLogix controller Service error code
Block Address> in when the s erver t ries to for details.
message <Message ID> read the optimization
from <Node> structure in the
controller.
Encountered the following Error codes are Depends on the CIP Check to see if there are
error when writing block returned in the request errors ret urned (refer other error messages in
<Block Item Name> in block for Multi-Request to the tables in the logger.
message <Message ID> messages. Logix5000 Error Check the
from <Device> Further explanation of Codes on page 101). Communication Driver
the errors will be listed. diagnostics, if
necessary.
Error encountered There is a failure to Another application Make sure that no other
initializing Unsolicited create a listening has already been application is running
Data Port. No direct (i.e.: socket for the listening at the same and listening at the same
peer-to-peer) unsolicited peer-to-peer port. port (such as RS Linx).
data will be accepted. unsolicited data used.
The network Make sure the net work is
As a result, no
communications is functioning.
unsolicited data can be
having a problem.
accepted. Make sure the controller
The controller is is functioning.
having a problem
communicating.
ExtSTS=<Extended Error The error message CIP -error dependent
Code>: <Description> shows the extended (refer to the tables in
CIP error code and Logix5000 Error
description, if there is Codes on page 101).
one.

108
Troubleshooting the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Error Message Explanation Probable Cause Solution

Failed to add block <block The error message Either the tag does Set the UDT member
number> with base name shows when advising a not exist in the PLC external access from
<UDT base name> in UDT member with or one or more UDT NONE to Read Only or
<PLC address>, tag does external access set to members are Read/Write, or create
not exist in the PLC or NONE or the PLC tag configured for an the tag.
some of its UDT members does not exist. External Access
are configured for attribute of "None".
External Access=None in
the PLC
Failed to initialize Listen Listening socket with There may be third Shut down any
Socket (CIP port = <Port the indicated port party products third-party product (such
Number> ) number is being used already listening on as RSLinx) listening on
by another process. the same CIP port. the same CIP port and
ABCIP Communication restart ABCIP
Driver cannot receive Communication Driver.
unsolicited message
from controllers.

Host EtherNet/IP <IP The maximum number The maximum System limit on TCP
address> connect host of sockets allowed was number of sockets sockets on the machine
failed, maximum number exceeded. allowed was hosting the
of socket <MA X socket> exceeded. Communication Driver is
exceeded reached. Check if there
are ot her programs on
same the machine
consuming a large
number of sockets.
Inconsistent message The Communication This is an internal
type encountered for Driver encounters an error.
<Devic e Name> internal error.
Invalid item <Item Name> UDT member was not Invalid Item syntax Specify the member of
fields required for defined in the item the UDT structure in the
structure item syntax item tag
Invalid item <Item Name> The Bit number The bit number is Verify and specify the
bit number not allowed or specified in the item is specified for a correct bit number
invalid out of range or invalid non-integer type. appropriate for the data
type of the item tag.
Invalid item <Item Name> Specified UDT Invalid item syntax Verify if the UDT
structure not found structure does not exist structure name is correct
in the controller and exists in the
controller.
Invalid item <Item Name>, "," was used to specify An incorrect format Check the item’s format.
invalid item format the item’s format. was used for the
<format> However, the format item.
was found to be invalid
for the item.

109
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideTroubleshooting the ABCIP Communication Driver

Error Message Explanation Probable Cause Solution

Invalid item <Item Name>, An invalid index is An invalid index is Check the index
invalid index specified in the item. found in the item. specified. Only integer is
accepted as an index.
Invalid item <Item Name>, The member of the The member is not Check the structure’s
member <Member structure cannot be defined in the definition in the device.
Name> not found in found. structure.
structure
Invalid item <Item Name>, The item’s definition The item is not Check the item’s
not defined in the cannot be found in the defined in the Logix definition in the device.
processor tag database. processor.
Invalid item <Item Name>, The internal limit of the The item’s nesting Reduce the item’s
offset dimension item’s nesting level level exceeds the nesting level.
exceeded (20) was exceeded. server’s limit.
In general, each "." and
the index [x] increment
the item’s nesting level
by 1.
Invalid item <Item Name>, The item points to a A structure item is Retrieve an individual
retrieving whole structure structure other than a specified. member of the structure
not supported string. The instead of the whole
Communication Driver structure.
does not support this
type of item.
Invalid item <Item Name>, The structure definition Invalid item Check the item’s
structure not found for the item cannot be encountered. definition in the device.
located.
Invalid item <Item Name>, There is a syntax error An invalid item is Check the item’s syntax.
syntax error in the item. specified.
Invalid item <Item Name>, The suffix specified The suffix is not Check the suffix
unknown suffix after "," is not supported. specified for the item.
recognized by the
Communication Driver.
Invalid item <Item Name>, The dimension The item’s array Check the item’s
dimension mismatch specified in the <Item dimension is different definition in the device.
Name> is different from the definition in
from what has been the device.
defined in the device.
Invalid item <Item Name>, The bracket for the An invalid item is Correct the item’s
index bracket mismatch index is mismatched. entered. syntax.
This is an item syntax
error.
Invalid item <Item Name>, The index specified in The item’s index is Check the item’s
index out of range the <Item Name> is too large. definition in the device.
outside the range
defined in the device.

110
Troubleshooting the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Error Message Explanation Probable Cause Solution

Invalid item <Item Name>, The bit number An invalid item is The bit number specified
invalid bit number specified in the item is specified. cannot go beyond the
invalid. range allowed for the
item’s data type. For
example, INT range is
0-15 and DINT range is
0-31.
Item <ItemName> cannot ABCIP Communication The system ran out Reduce the number of
be creat ed, out of Driver failed to obtain of memory. tags in the
memory. memory during item Communication Driver.
creation. Close other applications.
Message <Message ID> The Communication The device is off line. Check the device’s
for <Device> timed out. Driver did not receive network connection.
the message’s
response from the
devic e within the
<Reply Timeout>
specified.
Mismatched bracket Invalid item syntax Missing bracket in Specify the missing
found while formatting the item tag bracket in the item tag.
message for block <Block
Number>
Received packet from The received packet Incorrect data packet Check if the server is
[HostName] too big on from the controller was read from the configured properly for
port [PortNumber] ([#of exceeds the maximum socket. the target ControlLogix
bytes received] bytes) packet size allowed for controller.
this type of prot ocol.
Received incomplete The response packet is Bad connection or Check if there are ot her
response packet for incomplet e or there is a error messages in the
message <Message ID> corrupted. Communication logger.
from <Device> Driver problem. Check the OI Server
diagnostics if necessary.
rec v() for <HostName> on Failed to read from the Failed to read from Repeat the operation by
port <Port Number> failed Window Socket the Winsock. restarting the
specified. Communication Driver.
Register Session The Communication Not communicating Check the controller
encountered the following Driver encountered an with a ControlLogix configuration.
error: error while trying to controller.
Check if the server is
establish an
recd packet from Incorrect data packet configured properly for
EtherNet/IP session
[HostName] too big on was read from the the target ControlLogix
with the controller.
port [PortNumber] ([#of socket. controller.
bytes received] bytes) The received packet
from the controller
exceeds the maximum
packet size allowed for
this type of prot ocol.

111
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideTroubleshooting the ABCIP Communication Driver

Error Message Explanation Probable Cause Solution

Rejected %s ITEM = %s The item cannot be The time tag portion If the &T& syntax is
on plc %s added or subscribed in the &T& syntax is used, make sure that it
from the OI Server. missing or invalid. consists of a valid data
The time tag portion in tag followed by the
the &T& syntax is "&T&" and a valid time
missing or invalid. tag.
Rejected <PLC Type The & T& time tag Cont roller firmware Upgrade the controller
Name> ITEM = <Item syntax cannot be used version is not firmware version to 16 or
Name> on plc <PLC Node with controller firmware compatible with & T& above if the & T& time
Name>. Time Tags not prior to version 16.0. time tag requirement. tag syntax is to used.
supported on Firmware
Revision less than 16.0
Rejected <PLC Type The data type of the The data type of the The data type for time
Name> ITEM = <Item time tag is not correct time tag is not correct tag must be LINT
Name> on plc <PLC Node
Name>. Invalid data type
for time tag
Response service code The service code in the Packet corrupted or Check if there are ot her
<ServiceCode> different message sent does not OI Server problem error messages in the
from command <Service match the one in the encountered. logger.
Code> for message reply. Check the
<Message ID> Communication Driver
diagnostics, if
necessary.
Response service code Unex pected service This is an internal The service code
<ServiceCode> not code was encountered error. received by the
handled in the reply packet from Communication Driver is
the controller. not supported. Verify the
controller firmware
version against version
supported by the
Communication Driver.
Session error <Error Communications CIP -error dependent
Code>, packet ignored errors encountered. (refer to the tables in
Logix5000 Error
Codes on page 101).
Socket <SocketID> send() This is an internal This is an internal
returned <ErrorNumber>, Winsock error. Winsock error.
connection to be closed

Socket <SocketID> Failed to send on This is an internal

sending packet with buffer socket due to the data error.
size <BufferSize> larger packet size.
than <MA X buffer size>

112
Troubleshooting the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Error Message Explanation Probable Cause Solution

STS=<CIP Error Code>: The error message CIP -error dependent

<Description> lists the CIP error code (refer to the tables in
and description. Logix5000 Error
Codes on page 101).
Timeout waiting for an Timeout occurred Failed to receive Make sure the controller
unknown event from PLC while waiting for unsolicited data from is configured to send out
on an unsolicited dat a port unsolicited data packet a controller. unsolicited data
connected to <PLC Host from a controller. correctly.
Name>
Make sure the
Communication Driver is
functioning correctly.
Timeout waiting for data Timeout occurred Failed to receive Make sure the controller
packet from PLC on an while waiting for unsolicited data from is configured to send out
unsolicited data port unsolicited data packet a controller. unsolicited data
connected to <PLC Host from a controller. correctly.
Name>
Make sure the
Communication Driver is
functioning correctly.
Timeout waiting for Timeout occurred Failed to receive Make sure the controller
initialization packet from while waiting for unsolicited data from is configured to send out
PLC on an unsolicited unsolicited data a controller. unsolicited data
data port connected to header from a correctly.
<PLC Host Name> controller.
Make sure the
Communication Driver is
functioning correctly.
Unsolicited socket not Unsolicited socket was This is an internal Reset the node
open for device <Device> not open when the error. hierarchy to restart the
Communication Driver connection
tried to send a reply
message to the device.

PLC-5 Error Messages

The error messages generated specifically for the PLC-5 family controllers are listed in the following
table.

Error Message Explanation Possible Cause Solution

BCD file number Incorrect format for the The BCD Item’s File Only access the BCD
must be greater item. The BCD Item’s File Number must be 3 or Item with File Number
than 2 Number was smaller than 3 larger. equal to 3 or larger.
for PLC-5.

113
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideTroubleshooting the ABCIP Communication Driver

Error Message Explanation Possible Cause Solution

BINA RY file Incorrect format for this The Binary Item’s File Only access the Binary
number must be item. The Binary Item’s File Number must be 3 or Item with File Number
greater than 2 Number was smaller than 3 larger. equal to 3 or larger.
for PLC-5.

BT file number Incorrect format for the The B T Item’s File Only access the BT
must be > 8 Item. The B T item’s File Number must be 9 or Item with File Number
Number was 8 or smaller larger. equal to 9 or larger.
for PLC-5.

Cannot write to Failed to write to a B T item For PLC-5, write Do not attempt to write
file for PLC-5. operation to a BT item is to a BT item for PLC-5.
BT[FileNumber] not permitted.

CONTROL file Incorrect format for the The Control Item’s File Only access the
number must be item. The Control Item’s Number must be 3 or Cont rol It em with File
greater than 2 File Number was smaller larger. Number equal to 3 or
than 3 for PLC-5. larger.

INTE GER file Incorrect format for the The Integer Item’s File Only access the
number must be item. The Int eger Item’s Number must be 3 or Integer Item with File
greater than 2 File Number was smaller larger. Number equal to 3 or
than 3 for PLC-5. larger.

item <ItemName> PID feat ure is not The PLC-5 configuration Select the "Support
not valid, PLC supported for this PLC-5 indicates that the PID PID" feature option for
does not have configuration. feature is not supported. PLC-5, if the cont roller
PID feat ure supports the feature.

PD file number Incorrect format for the The PID Item’s File Only access the PID
must be > 8 item. The PID Item’s File Number must be 9 or Item with File Number
Number was 8 or smaller larger. equal to 9 or larger.
for PLC-5.

SC file number Incorrect format for the The S T Item’s File Only access the ST
must be > 4 Item. The S C item’s File Number must be 5 or Item with File Number
Number was 4 or smaller larger. equal to 5 or larger.
for PLC-5.

ST file number Incorrect format for the The S T Item’s File Only access the ST
must be > 8 Item. The S T item’s File Number must be 9 or Item with File Number
Number was 8 or smaller larger. equal to 9 or larger.
for PLC-5.

114
Troubleshooting the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Error Message Explanation Possible Cause Solution

TIMER file Incorrect format for the The Timer Item’s File Only access the Timer
number must be item. The Timer Item’s File Number must be 3 or Item with File Number
greater than 2 Number was smaller than 3 larger. equal to 3 or larger.
for PLC-5.

SLC500 and MicroLogix Error Messages

The following table lists all the SLC500 and MicroLogix controller-specific error messages.

Error Message Explanation Possible Cause Solution

BINA RY file number Incorrect format for this Binary Item’s File Only access Binary Item
must be 3 or 9-255 item. The Binary Item’s File Number must be 3 or with valid File Number.
Number was not 3 or 9-255 9-255.
for SLC500 and
MicroLogix.

CONTROL file Incorrect format for the The Control Item’s File Only access the Control
number must be item. The Control Item’s Number must be 6 or Item with the valid File
greater than 6 or File Number was not 6 or 9-255. Number.
9-255 9-255.

COUNTE R file Incorrect format for the Counter Item’s File Only access Counter
number must be item. The Counter Item’s Number must be 5 or Item with valid File
greater than 5 or File Number was not 5 or 9-255. Number.
9-255 9-255.

FLOA T file number Incorrect format for the The Float Item’s File Only access the Float
must be 8 or 8-255 item. The Float It em’s File Number must be 8 or Item with the valid File
Number was not 8 or 8-255. Number.
8-255.

INTE GER file number Incorrect format for the The Integer Item’s File Only access the Integer
must be 7 or 9-255 item. The Int eger Item’s Number must be 7 or Item with the valid File
File Number was not 7 or 9-255. Number.
9-255.

TIMER file number Incorrect format for the Timer It em’s File Only access Timer Item
must be 4 or 9-255 item. The Timer Item’s File Number must be 4 or with valid File Number.
Number was not 4 or 9-255.
9-255.

PLC-5, SLC500, and MicroLogix Error Messages

The error messages listed in the following table pertain to the PLC-5, SLC500, and MicroLogix
controllers.

115
AVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User GuideTroubleshooting the ABCIP Communication Driver

Error Message Explanation Possible Cause Solution

[Sub-Element] not Incorrect format for Wrong Item format with a Only access the valid
valid for type the item. The wrong Sub-Element type. item format with the
[FileType] files. Sub-Element is not correct Sub-Element
valid for this File type.
Type.

ASCII file number Incorrect format for The ASCII Item’s File Only access the ASCII
must be greater than the item. The ASCII Number must be 3 or larger. Item with a File Number
2 Item’s File Number equaling to 3 or larger.
was smaller than 3.

BINA RY file, bit>15 Incorrect format for The valid format for a PLC-5 Only access the Binary
and element>0 the item. The Binary Binary Item is: Item with the valid
Item contained an B[FileNumber]: range.
element number, but [Element]/[Bit], where Bit is
its bit number was from 0 to 15.
larger than 15.
In this case, the Bit field was
larger than 15.

File numbers must be Incorrect format for A bad item File Number was Use a valid range for
between 0 and 999 the Item. The Item’s used. the Item’s File Number.
File Number was out
of range.

FLOA TING POINT file Incorrect format for The Floating Point Item Only access the
cannot have bit the item. The Floating must not contain a bit Floating Point Item
number Point Item contained number field. without a bit number
a bit number field. field.

FLOA TING POINT file Incorrect format for The Floating Point Item’s Only access the
number must be the item. The Floating File Number must be 3 or Floating Point Item with
greater than 2 Point Item’s File larger. a File Number that
Number was smaller equals to 3 or larger.
than 3.

INP UT file number Incorrect format for The Input Item’s File Only access the Input
must be 1 the item. The Input Number must be 1. Item with a File Number
Item’s File Number that equals to 1.
was not 1.

OUTP UT file number Incorrect format for The Out put Item’s File Only access the Output
must be 0 the item. The Output Number must be 0. Item with a File Number
Item’s File Number equaling to 0.
was not 0.

116
Troubleshooting the ABCIP Communication DriverAVEVA™ Communication Drivers Pack – Allen Bradley - ABCIP Dri ver User Guide

Error Message Explanation Possible Cause Solution

STA TUS file number Incorrect format for The Status Item’s File Only access the Status
must be 2 the item. The Status Number must be 2. Item with a File Number
Item’s File Number equaling to 2.
was not 2.

Unsupported file type Incorrect format for There was no such Item Use the valid Item
[File Type] the item. An invalid Type name. Type.
Item Type was used.

[Sub-Element not Incorrect format for Wrong Item format. Use only the valid item
valid for type the item. The format.
[FileType] section. Sub-Element is not
valid for this section.

Attempt to write read Write operation failed An attempt to write to a Do not attempt a write
only item in file due to an attempt to read-only item caused the operation to a read-only
[FileNumber] element write to a read-only failure. item.
[Element#] item.
subelement
[Sub-Element#]
ignored

117