Wondereware Operations Integration -

Supervisory ABCIP Server (G-1 Series)

© 2016 Schneider Electric Software, LLC. All rights reserved.
No part of this documentation shall be reproduced, stored in a retrieval system, or transmitted by any
means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written
permission of Schneider Electric Software, LLC. No liability is assumed with respect to the use of the
information contained herein.
Although precaution has been taken in the preparation of this documentation, Schneider Electric
Software, LLC 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 Schneider
Electric Software, LLC. The software described in this documentation is furnished under a license
agreement. This software may be used or copied only in accordance with the terms of such license
agreement.
ArchestrA, Avantis, DYNSIM, eDNA, EYESIM, Foxboro, Foxboro Evo, I/A Series, InBatch, InduSoft,
InStep, IntelaTrac, InTouch, PIPEPHASE, PRiSM, PRO/II, PROVISION, ROMeo, Schneider Electric,
SIM4ME, SimCentral, SimSci, Skelta, SmartGlance, Spiral Software, VISUAL FLARE, WindowMaker,
WindowViewer, and Wonderware are trademarks of Schneider Electric SE, its subsidiaries, and
affiliated companies. An extensive listing of Schneider Electric Software, LLC trademarks can be found
at: http://software.schneider-electric.com/legal/trademarks/. All other brands may be trademarks of
their respective owners.
Schneider Electric Software, LLC
26561 Rancho Parkway South
Lake Forest, CA 92630 U.S.A.
(949) 727-3200
http://software.schneider-electric.com/
Publication date: 7/11/2016
Contact Us
Contact Schneider Electric Software Technical Support
Contact our Software Technical Support Group if you have a question or issue with Avantis, SimSci,
Skelta, or Wonderware software products.
 Priority email for Customer First Members: [email protected]
 Customers without a support agreement: [email protected]
Americas: Lake Forest, California, U.S.
 Tel: + 1 800 966 3371 / + 1 949 639 8500
Asia Pacific: Shanghai, China
 Tel: + 800 4500 3457 (All Asia) / + 400 820 1521 (China) / + 86 400 8201521
 Email: [email protected]
Europe and Middle East, Africa (EMEA): Bratislava, Slovakia
 Tel: + 421 2 32 200 342 / See our website at http://software.schneider-electric.com/ for a list of
toll-free numbers.
Contact Schneider Electric Software Learning Services
Contact Software Learning Services for assistance regarding classes, schedule, offerings, frequently
asked questions, tuition, policies, and more.
 Phone: + 1 866 998 7246 in the U.S. and Canada
 + 1 949 639 8508 direct
 Fax: + 1 949 639 1847
 Email: [email protected]
 Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

Contents
Chapter 1 Introduction to the ABCIP OI Server .......................................................... 9
About the ABCIP OI Server ................................................................................................................9
Supported Client Protocols .................................................................................................................9
Supported Device Protocols ...............................................................................................................9
Supported Device Networks .............................................................................................................10
Supported Devices ............................................................................................................................10
ControlLogix Controllers .............................................................................................................11
GuardLogix Controllers ...............................................................................................................11
SoftLogix 5800 Controllers .........................................................................................................11
CompactLogix Controllers ..........................................................................................................11
FlexLogix Controllers ..................................................................................................................11
MicroLogix Controllers ................................................................................................................11
PLC-5 Controllers .......................................................................................................................12
SLC500 Controllers ....................................................................................................................12
Supported Topologies .......................................................................................................................12
Dual ENB Routing Topology .......................................................................................................15
Device-Level Ring (DLR) Topology ............................................................................................15
Windows Firewall Considerations .....................................................................................................15
Chapter 2 Configuring the ABCIP OI Server ............................................................ 17
Configuring Port Objects for the ABCIP OI Server ...........................................................................17
Adding, Renaming, Deleting Port Objects ..................................................................................17
Adding a Port ........................................................................................................................17
Renaming a Port ...................................................................................................................18
Deleting a Port ......................................................................................................................19
Configuring ABCIP OI Server Ports ............................................................................................20
CIP Port Object Set-up .........................................................................................................20
The Ethernet Network...........................................................................................................21
The ControlNet Network .......................................................................................................38
The DeviceNet Network........................................................................................................45
The Data Highway Plus Network ..........................................................................................46
Configuring Device Redundancy ..........................................................................................51
Device Groups and Device Items ...............................................................................................54
Device Group Definitions ......................................................................................................54
Device Item Definitions .........................................................................................................55
Exporting and Importing OI Server Item Data ......................................................................57
Scan-Based Message Handling ...........................................................................................58
Unsolicited Message Handling .............................................................................................59
ABCIP OI Server Reference....................................................................................... 63
OPC Browsing...................................................................................................................................63
Off-line OPC Item Browsing (Static Browsing) ...........................................................................63

5
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Contents

On-line OPC Item Browsing (Dynamic Browsing) ......................................................................63

Logix5000 Optimization Mode ..........................................................................................................64
UDT Optimization .......................................................................................................................65
UDT Optimization with None Access Attribute .....................................................................65
Logix5000 Write Optimization .....................................................................................................65
Data Type Determination ............................................................................................................66
Tag Database Status ............................................................................................................66
Tag Database Version ..........................................................................................................67
Invalid Items Handling ................................................................................................................67
Logix5000 Online Tag Management .................................................................................................67
Adding or Removing Tags ..........................................................................................................67
Making PLC Program Routine Changes While the Logix Controller is Online ...........................68
Modifying Tags Through Downloaded Programs .......................................................................68
Loading Tag Database from File.......................................................................................................68
Auto Load Tags on Activation .....................................................................................................68
Auto Synchronize Tags ...............................................................................................................68
Persisted Tags ............................................................................................................................69
Tag Database from File Options Matrix ......................................................................................69
Manual Tag Synchronization ......................................................................................................71
Accessing Secured Logix5000-series Controllers ............................................................................71
Auto Synchronize Tag Functionality Matrix ................................................................................71
Persisted Tag Functionality Matrix .............................................................................................72
Controller Time Stamping .................................................................................................................73
Item Names/Reference Descriptions ................................................................................................74
Logix5000 Item Naming ..............................................................................................................75
Module-Defined Data Types .................................................................................................77
User-Defined Data Types .....................................................................................................77
Block Reads and Writes of Arrays ........................................................................................77
PLC-5 Item Naming ....................................................................................................................79
Output File Items ..................................................................................................................80
Input File Items .....................................................................................................................81
Status File Items ...................................................................................................................81
Binary File Items ...................................................................................................................81
Timer File Items ....................................................................................................................82
Counter File Items ................................................................................................................82
Control File Items .................................................................................................................83
Integer File Items ..................................................................................................................83
Floating Point File Items .......................................................................................................84
ASCII File Items....................................................................................................................84
BCD File Items .....................................................................................................................85
ASCII String Section Items ...................................................................................................85
Block Transfer Section Items ...............................................................................................85
PID Section Items .................................................................................................................86
SFC Status Section Items ....................................................................................................86
Message Section Items ........................................................................................................87
CNetMessage Control Block Items ......................................................................................87
SLC500 Item Naming .................................................................................................................88
Output File Items ..................................................................................................................89
Input File Items .....................................................................................................................89
Addressing SLC I/O Modules ...............................................................................................90
Status File Items ...................................................................................................................92
Binary File Items ...................................................................................................................92

6
Contents Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

Timer File Items ....................................................................................................................93

Counter File Items ................................................................................................................93
Control File Items .................................................................................................................94
Integer File Items ..................................................................................................................94
Floating Point File Items .......................................................................................................95
ASCII File Items....................................................................................................................95
ASCII String Section Items ...................................................................................................96
MicroLogix Item Naming .............................................................................................................96
Output File Items ..................................................................................................................97
Input File Items .....................................................................................................................98
Status File Items ...................................................................................................................98
Binary File Items ...................................................................................................................99
Timer File Items ....................................................................................................................99
Counter File Items ..............................................................................................................100
Control File Items ...............................................................................................................100
Integer File Items ................................................................................................................101
Floating Point File Items .....................................................................................................101
ASCII String Section Items .................................................................................................101
Long Integer Section Items ................................................................................................101
PID Section Items ...............................................................................................................102
Message Section Items ......................................................................................................102
OI Server-Specific System Item................................................................................................103
Generic OPC Syntax ................................................................................................................109
Troubleshooting the ABCIP OI Server ..................................................................... 111
Troubleshooting with Windows Tools .............................................................................................111
Troubleshooting with the OI Server Manager .................................................................................111
Finding Version Information ............................................................................................................111
Using the ArchestrA Log Viewer .....................................................................................................112
Basic Log Flags ........................................................................................................................112
OI Server Log Flags ..................................................................................................................112
OI Server-Device Interface Log Flags ......................................................................................113
ABCIP OI Server Error Messages ..................................................................................................113
ABCIP OI Server Error Codes ........................................................................................................120
Logix5000 Error Codes ...................................................................................................................120
Data Highway Plus Error Conditions ..............................................................................................124
PLC-5 Error Messages ...................................................................................................................125
SLC500 and MicroLogix Error Messages .......................................................................................127
PLC-5, SLC500, and MicroLogix Error Messages ..........................................................................127
Index ........................................................................................................................ 131

7
 Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

C HAPTER 1
Introduction to the ABCIP OI Server
In This Chapter
About the ABCIP OI Server .......................................................................................................................9
Supported Client Protocols .......................................................................................................................9
Supported Device Protocols ......................................................................................................................9
Supported Device Networks ....................................................................................................................10
Supported Devices ..................................................................................................................................10
Supported Topologies .............................................................................................................................12
Windows Firewall Considerations ...........................................................................................................15

About the ABCIP OI Server

The Wonderware Supervisory ABCIP Operations Integration (OI) Server 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 SLC500
controllers.
The ABCIP OI Server does not require the Rockwell Software RSLinx™ package.

Supported Client Protocols

Client applications connect to the ABCIP OI Server using:
 OPC
 SuiteLink
 DDE/FastDDE
Important: Local DDE is supported only when the OI Server is configured as "Not a Service" and
activated from its executable file or launched from InTouch. Local DDE is not supported when the OI
Server is activated from the System Management Console (SMC)

Supported Device Protocols

The ABCIP OI Server connects to supported controllers across an Ethernet/IP network using the
Common Industrial Protocol (CIP).
 The Ethernet Industrial Protocol (EtherNet/IP) is an open industrial networking standard using CIP
on top of a TCP/IP suite as its lower-level transport and data-link vehicle.
 The Common Industrial Protocol (CIP) is a common application-layer protocol used by EtherNet/IP,
ControlNet, and DeviceNet. The following network communication protocols use CIP as their top
application layer:

9
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Introduction to the ABCIP OI Server

o ControlNet - The ControlNet protocol is a real-time deterministic control-layer networking

protocol using CIP as its top application layer.
o DeviceNet - The DeviceNet protocol is an open lower-level networking standard using CIP on
top of Controller Area Network (CAN) to connect industrial field devices to controllers and
computers.
Note: The ABCIP OI Server does not implement the DeviceNet protocol internally. Device data from
the DeviceNet network needs to be mapped to the appropriate controllers before the ABCIP OI Server
can access them.

For supported non-Logix controllers, Allen-Bradley uses the Programmable Controller Communications
Commands (PCCC) application-layer protocol.
This is accomplished by using the DF1 protocol in its lower data-link layer. The DF1 protocol supports
features for both D1 (data transparency) and F1 (two-way simultaneous transmission with embedded
responses) subcategories of ANSI x3.28 specifications.
This protocol is encapsulated in CIP when used by the OI Server to communicate with the following
supported Allen-Bradley controllers:
o PLC-5 controllers
o SLC500 controllers
o MicroLogix controllers

Supported Device Networks

The ABCIP OI Server communicates with supported devices either directly or indirectly across the
following device networks:
 ControlNet
 Data Highway 485 (DH485)
 Data Highway Plus (DH+)
 DeviceNet
 Ethernet

Supported Devices
The ABCIP OI Server will provide direct and indirect connectivity to the following Allen-Bradley
controllers:
o ControlLogix Controllers on page 11
o GuardLogix Controllers on page 11
o SoftLogix 5800 Controllers on page 11
o CompactLogix Controllers on page 11
o FlexLogix Controllers on page 11
o MicroLogix Controllers on page 11
o PLC-5 Controllers on page 12
o SLC500 Controllers on page 12

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

10
Introduction to the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

ControlLogix Controllers
 All ControlLogix processors (1756-series processors) directly accessible from the Ethernet using
the ControlLogix Ethernet or EtherNet/IP Bridge module (1756-ENET, 1756-ENBT, 1756-EN2T, or
1756-EWEB) through the backplane.
 All ControlLogix processors (1756-series processors) accessible through the ControlLogix
Gateway from the ControlNet network by means of the ControlLogix ControlNet Bridge module
(1756-CNB/CNBR or 1756-CN2/CN2R).
 ControlLogix 1756-RM and 1757-SRM processors directly accessible from the Ethernet using the
ControlLogix Ethernet or EtherNet/IP Bridge module (1756-EN2T for the 1756-RM or 1756-ENBT
for the 1757-SRM) or accessible through the ControlLogix Gateway from the ControlNet Bridge
module (1756-CN2R).
The 1756-EWEB enhanced Web-server module provides both CIP communications and Internet
browser web-services. ABCIP OI Server supports ONLY CIP communications.
The ABCIP OI Server is capable of accessing multiple ControlLogix processors in a single chassis.

GuardLogix Controllers
 All GuardLogix Integrated Safety processors (1756-LSP & 1756-L6xS) directly accessible from the
Ethernet using the ControlLogix Ethernet or EtherNet/IP Bridge module (1756-ENBT or
1756-EWEB) through the backplane.
 All GuardLogix Integrated Safety processors (1756-LSP & 1756-L6xS) accessible through the
ControlLogix Gateway from the ControlNet network by means of the ControlLogix ControlNet
Bridge module (1756-CNB/CNBR 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 (1769/1768-series) directly accessible from the Ethernet 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-NET-ENI).

FlexLogix Controllers
 All FlexLogix processors (1794-series) accessible from the Ethernet using the EtherNet/IP
communications daughter-card (1788-ENBT).
 All FlexLogix processors (1794-series) accessible through the ControlLogix Gateway from the
ControlNet network 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 integrated EtherNet/IP port.
 All MicroLogix 1000/1200/1500 processors accessible from the Ethernet via the Ethernet/IP
interface module for CompactLogix/MicroLogix (1761-NET-ENI) series B or higher.

11
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Introduction to the ABCIP OI Server

 All MicroLogix 1000/1200/1500 processors accessible from the DH485 network using the
RS-232C-to-DH485 Advanced Interface Converter module (1761-NET-AIC) to connect to the Data
Highway Plus network through a DH+-to-DH485 Bridge module (1785-KA5) and routed through the
ControlLogix Gateway 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 network 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 ControlNet network by means of the ControlLogix ControlNet Bridge module
(1756-¬CNB/CNBR).

SLC500 Controllers
 All SLC 5/05 processors accessible from the Ethernet using the built-in EtherNet/IP interface.
 All SLC 5/03, /04 processors (1747-series) accessible from the Ethernet using the EtherNet/IP
interface module (1761-NET-ENI).
 All SLC 5/04 processors (1747-series) accessible through the ControlLogix Gateway from the Data
Highway Plus network 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 the ControlNet network
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-NET-AIC) to connect to the Data
Highway Plus network through a DH+-to-DH485 Bridge module (1785-KA5) and routed through the
ControlLogix Gateway by means of the ControlLogix DH+/RIO Bridge module (1756-DHRIO) to the
Ethernet.
While primarily intended for use with Wonderware InTouch®, the OI Server may be used by any
Microsoft Windows program capable of acting as a DDE, FastDDE, SuiteLink™, or OPC client.

Supported Topologies
This ABCIP OI Server communicates with supported Allen-Bradley families of CompactLogix,
ControlLogix, FlexLogix, GuardLogix, MicroLogix, PLC-5, SLC500, and SoftLogix 5800 controllers
across:
 ControlNet
 Data Highway 485 (DH485)
 Data Highway Plus (DH+)
 DeviceNet
 Ethernet

12
Introduction to the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

Before attempting to configure your OI Server, you should determine the hierarchical structure of your
network/controller environment.

13
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Introduction to the ABCIP OI Server

14
Introduction to the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

Dual ENB Routing Topology

The ABCIP OI Server is able to 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 router between two subnets. The ABCIP Server will able to connect
to the following controllers and devices on a second Ethernet subnet:
 ControlLogix
 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 network
topologies at the device level. The DLR protocol 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 OI Server provides data connectivity to other supported controllers connected on the same
DLR network. The computer where the ABCIP OI Server is installed must be connected to the DLR
network via the 1783-ETAP device. Following is a sample DLR topology:

Windows Firewall Considerations

If the OI Server 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 OI Server can function correctly. The OI Server
installation program makes the required entries in the firewall exception list for you.

15
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Introduction to the ABCIP OI Server

The following applications are added in to the firewall exception list on the computer where the OI
Server run-time application is installed:
 DASABCIP.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 OI
Server run-time application is installed:
 5413 - TCP port for slssvc.exe
 445 - TCP port for file and printer sharing
 135 - TCP port for DCOM
The following applications are added in 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 in to the firewall exception list on the computer where the OI
Server Manager (configuration part) is installed:
 445 - TCP port for file and printer sharing
 135 - TCP port for DCOM
Un-installing the OI Server 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.

16
 Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

C HAPTER 2
Configuring the ABCIP OI Server
In This Chapter
Configuring Port Objects for the ABCIP OI Server .................................................................................17

Configuring Port Objects for the ABCIP OI Server

Network Communication Bridge/Interface Modules are the communication links between the ABCIP OI
Server and its supported Allen-Bradley controllers. You must create these links within the OI Server
Manager hierarchy to bridge/route control and information data between different networks to target
controllers.
This is accomplished by creating Port Objects. These Port Objects simulate the physical hardware
layout and must be built to establish communications to each of the controllers. Once you have 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 devices
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 between the OI Server 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 OI Server 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.

17
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Configuring the ABCIP OI Server

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.
To change an existing port object name
1. In the OI Server Manager, expand the OI Server hierarchy tree to display the target port object
node to display the port you wish to rename.
2. Select and right-click the port object’s name (or <F2>). Click Rename.

18
Configuring the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

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. Try 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 delete 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 from 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 OI Server hierarchy tree to display the target port object
node you wish to delete.
2. Right-click the port object node to be deleted and click Delete.

19
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Configuring the ABCIP OI Server

3. Read the warning and then click Yes. The port object and all nodes (devices) below it in the
hierarchy are deleted.

Configuring ABCIP OI Server Ports

The ABCIP Hierarchy in the OI Server starts with the PORT_CIP Object, followed by the supported
communication-interface/gateway modules that allow the OI Server to access the supported networks
and devices.
The following sections detail the steps necessary to configure your OI Server Port Objects according to
your network type.
The logical endpoint for each branch of the ABCIP hierarchy tree is always a Processor Type node
which represents the controller device.

Note: Before attempting to configure your OI Server, you should determine the hierarchical structure of
your device/network environment.

CIP Port Object Set-up

The OI Server hierarchy 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 in a computer.

Note: Only one PORT_CIP object is allowed per ABCIP OI Server.

To create PORT_CIP objects from the Configuration branch

1. Select and right-click on Configuration.
2. Select Add PORT_CIP Object from the shortcut menu. An object called New_PORT_CIP_000 is
created.

20
Configuring the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

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:

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

The Ethernet Network

Through the PORT_CIP object, the ABCIP OI Server 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-ENET
o 1756-ENBT
o 1756-EN2T
o 1756-EWEB
The ENB_CLX object is hosted by CIP.

Note: A maximum of 65535 ENB_CLX objects can be created for the OI Server.

21
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Configuring the ABCIP OI Server

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 Object from the shortcut menu. A New_ENB_CLX_000 object is created.
3. Rename the newly created object as appropriate. The ENB_CLX parameters 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-ENET/ENBT/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 example, "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.

Important: If setting up a SoftLogix or GuardLogix device, 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 OI Server hierarchy to establish communications with the device. For more
information, see SoftLogix 5800 Controllers on page 11 or GuardLogix Controllers on page 11.

Connection Timeout: Time (in milliseconds) allowed for establishing a socket connection to a target
device.
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.

22
Configuring the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

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_Port_CLX objects.
Note: Only one instance of the BACKPLANE_CLX object can be created per ENB_CLX and
CNB_Port_CLX branch. The OI Server 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 Object from the shortcut menu. The New_BACKPLANE_CLX_000
object is created.
3. Rename the newly created object as appropriate. The BACKPLANE_CLX Parameters view is
displayed.

This configuration view has one element:

Device Type: The information is provided automatically by the OI Server Manager (BackPlane).

PORT_ENB Object
The Port_ENB object represents the physical Ethernet port for the Allen-Bradley Ethernet Network
bridge module.
This object is hosted by the BACKPLANE_CLX object.
To add the PORT_ENB object to your ABCIP hierarchy
1. Select and right-click on the New_BACKPLANE_CLX_000 object.
2. Select Add PORT_ENB Object from the shortcut menu. The New_PORT_ENB_000 object is
created.

23
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Configuring the ABCIP OI Server

3. Rename the newly created object as appropriate. The PORT_ENB Parameters view is displayed.

This configuration view has one element:

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).

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 representation 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 Object from the shortcut menu. The New_LOGIX5000_CLX_000
object is created.

24
Configuring the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

3. Rename the newly created object as appropriate. The Logix5000_CLX Parameters view is
displayed.

This configuration view has nine parameters, eight of which are configurable:
Processor Type: Information provided automatically by the OI Server Manager (ControlLogix
/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 OI Server 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 which can be originated from the
OI Server to this device.
o The valid range is 1 - 31.
o The default value is 4 (four).
Optimization Mode (For detailed information, see Logix5000 Optimization Mode on page 64):
o No optimization: The server uses the most basic communication method available by using the
tag name for each communication with the controller. The tag database 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 will
require more time. This mode is most effective with large number of tags on continuous scan.

25
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Configuring the ABCIP OI Server

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 64.

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 65.
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 updates
of the Logix processor’s tag database. For more information, see Logix5000 Online Tag
Management on page 67.
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 OI Server 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 71.

ENB_FLX Object
The ENB_FLX object represents the physical Allen-Bradley FlexLogix Ethernet Communication
Daughter Card.
o 1788-ENBT
This object is hosted by the CIP Network Object.

Note: A maximum of 65535 ENB_FLX objects can be created for the OI Server.

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 Object from the shortcut menu. A New_ENB_FLX_000 object is created.

26
Configuring the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

3. Rename the newly created object as appropriate. The ENB_FLX Parameters 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
Communication).
Host Name: The Host Name or IP Address of the destination 1788-ENBT 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 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
device.
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-Bradley FlexLogix controller
assembly.
This object is hosted by ENB_FLX and CNB_Port_FLX.
Note: The OI Server is capable of operating with multiple FlexLogix processors in a single backplane.
Only one instance of the BACKPLANE_FLX object can be created per ENB_FLX branch.

To add the BACKPLANE_FLX object to your ABCIP hierarchy

1. Select and right-click on the New_ENB_FLX_000 object.

27
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Configuring the ABCIP OI Server

2. Select Add BACKPLANE_FLX Object from the shortcut menu. A New_BACKPLANE_FLX_000

object is created.
3. Rename the newly created object as appropriate. The BACKPLANE_FLX Parameters view is
displayed.

This configuration view has one element:

Device Type: The information is provided automatically by the OI Server Manager (Backplane).

LOGIX_FLX Object
The Logix_FLX object represents the physical Allen-Bradley FlexLogix processor 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_BACKPLANE_FLX_000 object.
2. Select Add LOGIX_FLX Object from the shortcut menu. The New_LOGIX_FLX_000 object is
created.

28
Configuring the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

3. Rename the newly created object as appropriate. The LOGIX_FLX Parameters 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).
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 OI Server 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 OI Server to this device.
o The valid range is 1 - 31.
o The default value is 4 (four).
Optimization Mode (For detailed information, see Logix5000 Optimization Mode on page 64):
o No optimization: The server uses the most basic communication method available by using the
tag name for each communication with the controller. The tag database 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 will
require more time. This mode is most effective with large number of tags on continuous scan.

29
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Configuring the ABCIP OI Server

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 64.

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 65.
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 selectable to implement manual or automated updates
of the Logix processor’s tag database. For more information, see Logix5000 Online Tag
Management on page 67.
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 OI Server will need to
synchronize physical address tags from the device.

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-series
Controllers on page 71.

ML_EN Object
The ML_EN object represents the physical Allen-Bradley MicroLogix processor with the built-in
EtherNet/IP port or coupled with the Ethernet Interface module for MicroLogix and Compactogix
(1761-NET-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 Object from the shortcut menu. A New_ML_EN_000 object is created.

30
Configuring the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

3. Rename the newly created object as appropriate. The ML_EN Parameters 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-NET-ENI
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 OI Server 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
device.
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 (See Max CIP Connections below).

Max CIP Connections: The maximum number of CIP connections which can be originated from the OI
Server to this device.

31
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Configuring the ABCIP OI Server

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 logical endpoint for each branch of the ABCIP hierarchy tree is always a Processor Type 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 OI Server.

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_Object 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.

32
Configuring the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

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 device.
o The valid range is 10 - 10000 milliseconds.
o The default value is 2000.
o The connection timeout is used if the ENB_CPLX object is beneath PORT_CIP.

ENI_CPLX Object
The ENI_CPLX object represents the physical Allen-Bradley Ethernet Interface module for MicroLogix
and CompactLogix (1761-NET-ENI).
o 1761-NET-ENI Module
This object is hosted by CIP Network Object

Note: A maximum of 65535 ENI_CPLX objects can be created for the OI Server.

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_Object from the shortcut menu. A New_ENI_CPLX_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-NET-ENI module.

33
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Configuring the ABCIP OI Server

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 device.
o The valid range is 10 - 10000 milliseconds.
o The default value is 2000.
o The connection timeout is used if the ENI_CPLX object is beneath PORT_CIP.

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

Note: The OI Server is capable of operating with multiple CompactLogix processors in a single
backplane. Only one instance of the BACKPLANE_CPLX object can be created per ENB_CPLX or
ENI_CPLX branch.

To add the BACKPLANE_CPLX object to your ABCIP hierarchy

1. Select and right-click on the New_ENB_CPLX_000 or New_ENI_CPLX_000 object.
2. Select Add BACKPLANE_CPLX Object from the shortcut menu. The
New_BACKPLANE_CPLX_000 object is created.
3. Rename the newly created object as appropriate. The BACKPLANE_CPLX Parameters view
appears.

This configuration view has one element:

Device Type: The information is provided automatically by the OI Server Manager (Backplane).

34
Configuring the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

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_CPLX.
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 Object from the shortcut menu. The New_LOGIX_CPLX_000 object is
created.
3. Rename the newly created object as appropriate. The LOGIX_CPLX Parameters 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 OI Server 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 OI Server to this device.

35
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Configuring the ABCIP OI Server

o The valid range is 1 - 31

o The default value is 4 (four)
Optimization Mode (For detailed information, see Logix5000 Optimization Mode on page 64):
o No optimization: The server uses the most basic communication method available by using the
tag name for each communication with the controller. The tag database 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 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 version
21 or above. For more information, see Logix5000 Optimization Mode on page 64.

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 65.
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 selectable to implement manual or automated updates
of the Logix processor’s tag database. For more information, see Logix5000 Online Tag
Management on page 67.
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 OI Server 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 71.

SLC500_EN Object
The SLC500_EN object represents the physical Allen-Bradley SLC500 processor connected to an
Allen-Bradley Ethernet Interface for MicroLogix and CompactLogix (1761-NET-ENI).
o 1747-L5xx with 1761-NET-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 Object from the shortcut menu. A New_SLC500_EN_000 object is
created.

36
Configuring the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

3. Rename the newly created object as appropriate. The SLC500_EN Parameters 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-NET-ENI 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 OI Server 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 device.
o The valid range is 10 - 10000 milliseconds.
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 with direct CIP
connection.
o The default value is True.
Max CIP Connections: The maximum number of CIP connections which can be originated from
the OI Server to this device.
o The valid range is 1 - 31.
o The default value is 4 (four).

37
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Configuring the ABCIP OI Server

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

The ControlNet Network

Routing through the CNB_CLX or the CNB_FLX object from Ethernet network, the ABCIP OI Server
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-Bradley 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 Object from the shortcut menu. The New_CNB_CLX_000 object is
created.
3. Rename the newly created object as appropriate. The CNB_CLX Parameters view is displayed.

This configuration view has two parameters, one of which is configurable:

Port Type: (not configurable) Information provided automatically by the OI Server 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).

38
Configuring the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

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 Object from the shortcut menu. The New_CNB_FLX_000 object is created.
3. Rename the newly created object as appropriate. The CNB_FLX Parameters view is displayed.

This configuration view has two parameters, one of which is configurable:

Port Type: (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 OI Server 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 BACKPLANE_CLX_000 or BACKPLANE_FLX_000
object along the CNB_CLX or CNB_FLX hierarchy branch.

39
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Configuring the ABCIP OI Server

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 Object from the shortcut menu. The New_PORT_CN_000 object is created.
3. Rename the newly created object as appropriate. The PORT_CN Parameters 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 network.
o Select Channel A or Channel B.
ControlNet Address: The node address on the ControlNet network.
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 ControlNet-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 Object from the shortcut menu. The New_PLC5_CN_000 object is created.

40
Configuring the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

3. Rename the newly created object as appropriate. The PLC5_CN Parameters view is displayed.

The configuration view contains five parameters, four of which are configurable:
Processor Type: (not configurable) The information is automatically provided (PLC-5).
ControlNet Address: The node address on the Control Net network (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 OI Server 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 OI Server to this device.
o The valid range is 1 - 31.
o The default value is 4 (four).

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

41
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Configuring the ABCIP OI Server

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 Object from the shortcut menu. The New_SLC500_CN_000 object is
created.
3. Rename the newly created object as appropriate. The SLC500_CN Parameters view is displayed.

The configuration view contains four parameters, three of which are configurable:
Processor Type: (not configurable) The information is automatically provided (SLC500).
ControlNet Address: 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 OI Server 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 OI Server to this device.
o The valid range is 1 - 31.
o The default value is 4 (four).

CNB_PORT_CLX Object
The CNB_Port_CLX object is a logical representation of the ControlNet port for the Allen-Bradley
ControlNet 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.

42
Configuring the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

2. Select Add CNB_PORT_CLX Object 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 view is
displayed.

This configuration view has four parameters, three of which are configurable:
Port Type: (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 ControlNet 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 Address: The node address on the ControlNet network.
o The valid range is 1 - 99 decimal.
o The default value is 1 (one).

CNB_PORT_FLX Object
The CNB_Port_FLX object represents the physical ControlNet port for the Allen-Bradley FlexLogix
ControlNet 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.

43
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Configuring the ABCIP OI Server

2. Select Add CNB_PORT_FLX Object from the shortcut menu. The New_CNB_PORT_FLX_000
object is created.
3. Rename the newly created object as appropriate. The CNB_PORT_FLX Parameters view is
displayed.

This configuration view has four parameters, three of which are configurable:
Port 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 ControlNet 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 Address: The node address on the ControlNet network.
o The valid range is 1 - 99 decimal.
o The default value is 1 (one).

CNB_PORT_CPLX Object
The CNB_Port_CPLX object represents the physical ControlNet port for the Allen-Bradley
CompactLogix ControlNet 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.

44
Configuring the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

2. Select Add CNB_PORT_CPLX Object from the shortcut menu. The

New_CNB_PORT_CPLX_000 object is created.
3. Rename the newly created object as appropriate. The CNB_PORT_CPLX Parameters view is
displayed.

This configuration view has four parameters, three of which are configurable:
Port Type: (not configurable) The information is provided automatically by the OI Server Manager
(ControlNet Communication).
Slot Number: A sequential number beginning with 0 (zero) assigned to each slot in the
ControlLogix ControlNet 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 Address: The node address on the ControlNet network.
o The valid range is 1 - 99 decimal.
o The default value is 1 (one).

The DeviceNet Network

The following Allen-Bradley controllers can be configured to communicate with I/O data from the
DeviceNet devices for the OI Server to access using the following methods:
 ControlLogix controller by means of its DeviceNet Bridge module.
 FlexLogix controller by means of its DeviceNet daughter-card.
 CompactLogix controller by means of its DeviceNet scanner.

45
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Configuring the ABCIP OI Server

 PLC-5 controller by means of its DeviceNet scanner.

 SLC500 controller 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 OI Server does not internally implement the DeviceNet protocol.

The Data Highway Plus Network

Routing through the DHRIO_CLX object, the ABCIP OI Server accesses data from the PLC-5 and
SLC500 processors on the Data Highway Plus network, as well as the MicroLogix processors on the
DH485 network via the DH+/DH485 Bridge module (1785-KA5).

DHRIO_CLX Object
The DHRIO_CLX object represents the physical Allen-Bradley ControlLogix DH+/RIO Communication
Interface module.
o 1756-DHRIO
This object is hosted by BACKPLANE_CLX.
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 Object from the shortcut menu. The New_DHRIO_CLX_000 object is
created.
3. Rename the newly created object as appropriate. The DHRIO_CLX Parameters 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).

46
Configuring the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

Slot Number: A sequential number beginning with 0 (zero) assigned to each slot in a ControlLogix
DH+/RIO 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).
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).

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 Object from the shortcut menu. The New_PORT_DHP_000 object is
created.
3. Rename the newly created object as appropriate. The PORT_DHP Parameters 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.
o Select Channel A or Channel B.

47
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Configuring the ABCIP OI Server

DH Plus Node Address: The node address on the DH+ network (Octal).
o The valid range is 0 - 77 octal.
o The default value is 1 (one) octal.
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 view is
displayed.

The configuration view contains three parameters, two of which are configurable:
Processor Type: (not configurable) The information is automatically provided (SLC500).
DH Plus Node Address: The node address on the DH+ network (Octal).
o Select the DH+ node number from the drop-down box.
o The valid range is 0 - 77 octal.

48
Configuring the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

o The default value is 0 (zero) octal.

Reply Timeout: Enter the maximum amount of time (in seconds) that the OI Server 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 M1785KA5_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 Object from the shortcut menu. The New_M1785KA5_GWY_000
object is created.
3. Rename the newly created object as appropriate. The M1785KA5_GWY Parameters 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).
DH485 Node Address: The node address on the DH485 network.
o Select the DH485 node number from the drop-down box.
o The valid range is 1 - 31.
o The default value is 1 (one).
DH485 Link ID: The DH485 link ID of the module.

49
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Configuring the ABCIP OI Server

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-Bradley MicroLogix processor coupled with the
Allen-Bradley Advanced Interface Converter for DH485 (1761-NET-AIC).
o 176x-Lxxx with 1761-NET-AIC
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 Object from the shortcut menu. The New_ML_DH485_000 object is
created.
3. Rename the newly created object as appropriate. The ML_DH485 Parameters view is displayed.

The configuration view contains three parameters, two of which are configurable:
Processor Type: (not configurable) The information is automatically provided (MicroLogix).
DH485 Node Address: 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 OI Server will wait for a
response from the controller.
o The valid range is 1 - 300 seconds.
o The default value is 15 seconds.

50
Configuring the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

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-NET-AIC).
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 Object from the shortcut menu. The New_SLC500_DH485_000
object is created.
3. Rename the newly created object as appropriate. The SLC500_DH485 Parameters view is
displayed.

The configuration view contains three parameters, two of which are configurable:
Processor Type: (not configurable) The information is automatically provided (SLC500).
DH485 Node Address: 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 OI Server 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 OI Server having identical item
syntax.

51
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Configuring the ABCIP OI Server

Primary and secondary devices will be setup in the REDUNDANT_DEVICE 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 device status.

2. Set up an secondary device on the same OI Server. Once again, create an identical device item
within the secondary device so that device status can be determined.

3. Select and right-click on the configuration node under the CIP Network Device object.

52
Configuring the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

4. Select Add REDUNDANT_DEVICE Object. An object called New_REDUNDANT_DEVICE_000 is

created.

5. Rename the newly created object as appropriate. The New_REDUNDANT_DEVICE_000

configuration view is displayed in the Configuration branch of the hierarchy.
6. Enter or use the device browser to select the primary and secondary devices. Save the hierarchy
node configuration by clicking on the save icon.

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

53
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Configuring the ABCIP OI Server

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 device such as a firmware version or processor 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 delete 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 OI Server 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_EN, LOGIX_CPLX, SLC500_EN, 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.

Note: When you add a new device group, enter a unique name. When you select another part of the
OI Server tree hierarchy, you are prompted to save the modifications 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).

54
Configuring the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

To make edits on device groups

1. In the Name column, double-click on the device group’s name to be edited 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 Messages if desired 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 device 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 with 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.
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 OI Server 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 each device group.

Device Item Definitions

To make it easier to remember lengthy or strictly structured item names, the OI Server enables you to
create 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 names, it provides the OI Server with the
capability to perform OPC Item browsing. When the OI Server is running and an OPC client requests
item information, the configured items will show up under the controller hierarchy node.

55
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Configuring the ABCIP OI Server

Note: Device 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.
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 OI Server-specific system items are valid.

To rename device items

1. Right-click on the device 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 device 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).

56
Configuring the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

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 OI Server Item Data

The Export and Import commands on the shortcut menu enable you to export and import the OI Server
item data 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 OI Server 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.csv," 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.csv.
o It is editable in Microsoft Excel.

The file can now be edited off-line. It contains one row for each item configured with two columns,
Name and Item Reference, respectively.
To import OI Server 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.csv 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.

57
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Configuring the ABCIP OI Server

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 based on unique names.
o If there are duplicate names, you will be provided with the ability to replace the existing entry
with the new entry, or ignore the new entry.

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

Note: When you select another part of the OI Server tree hierarchy, you are prompted to save the
modifications to the configuration set.

Each configuration view associated with nodes in the OI Server hierarchy tree has a common feature,
the Save button located 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 prompted to save the new data to the configuration set.

Scan-Based Message Handling

Wonderware's OI Servers are based on the concept of polling a hardware device for information. This
polling is driven by a need which 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 OI Server formulates its own request
and sends that request to the hardware device. The OI Server then waits for a response to its request.
After the information has been received, the OI Server passes that information back to the client, and
repeats the process until all clients have ceased requesting information.

58
Configuring the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

The rate at which the OI Server will poll a particular device for a specific piece of information is defined
in the device group (topic definition) inside the OI Server, using a parameter called the Update Interval.
When setting this parameter, there is always a trade-off between the update speed of the device group
and the resulting decrease in system responsiveness.
Because you more than likely want very fast response, the temptation is to set the Update Interval 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 also create multiple device groups for each device, setting the Update
Interval to different values, then assigning different items to different device groups depending on how
quickly the values change and how quickly you want to see an update 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 OI Servers, it is obvious that a controller will know when a critical event
has occurred before the OI Server 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 OI Server
immediately, without having to wait for the OI Server to poll it.
This is the role of an unsolicited message. After a controller has determined that a critical condition
exists, it can generate a message immediately sent to the OI Server without a prior request from the OI
Server. The unsolicited message implementation requires both the messaging instructions properly
programmed in the controller logic and the device group appropriately configured in the OI Server.
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 OI Server supports unsolicited messages from the following processors:
 PLC-5 and SLC 5/04 processors on the Data Highway Plus network.
Note: The following non-Logix processor configuration does not support unsolicited message handling:
MicroLogix with 1785-KA5 via ControlLogix Gateway (1756-DHRIO and 1756-ENB).

 Logix5000 and MicroLogix 1100 processors on the Ethernet network.

Note: The following Logix5000 processor configuration does not support unsolicited message
handling:
CompactLogix going through the EtherNet/IP interface module (1761-NET-ENI).

 Logix5000, PLC-5, and SLC500 processors on the ControlNet network.

Note: The following SLC500 processor configuration does not support unsolicited message handling:
SLC500 using 1747-KFC15 interface on ControlNet via the ControlLogix Gateway (1756-CNB and
1756-ENB) to RSLinx on Ethernet.

To configure the ABCIP OI Server to receive unsolicited messages

This option is available only to the controllers listed above.
1. Click on the target controller node under the controller branch of the OI Server hierarchy.
2. Select the Device Group tab of the configuration view.
3. Add a new device group or select an existing device group.

59
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Configuring the ABCIP OI Server

4. Right-click on the device 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 Messages 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 which support unsolicited messages
is strongly recommended.

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

8. Save the configuration change by clicking the Save button.

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 OI
Server as soon as the change made in the configuration view is saved.

The OI Server supports target-specific unsolicited messages.

Target-specific: This method involves sending messages to its target as specified by a given static
IP address.
o Configure the appropriate message instructions in the controller with the proper path (including
the destination IP address) for sending the unsolicited messages.
o Configure the computer, in which the OI Server resides to receive unsolicited messages from
the controller, with the corresponding IP address.
o Two instances of target-specific unsolicited messages are generated by the OI Server:
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 "Update Interval" 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
OI Server will also update the data at every Update Interval.

60
Configuring the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

Note: The OI Server requires unsolicited messages to be configured as "Connected" in Logix5000

processors. For details in setting the Allen-Bradley hardware for unsolicited messaging, please refer to
the related Rockwell Automation documentation.

To receive unsolicited messages

1. Activate the OI Server.
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 OI Server.
2. Select the Device Groups tab of the configuration view pane at right.
3. Right-click on the device 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 CIP
method from the Logix5000 processor.

61
 Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

C HAPTER 3
ABCIP OI Server Reference
In This Chapter
OPC Browsing .........................................................................................................................................63
Logix5000 Optimization Mode .................................................................................................................64
Logix5000 Online Tag Management .......................................................................................................67
Loading Tag Database from File .............................................................................................................68
Accessing Secured Logix5000-series Controllers ..................................................................................71
Controller Time Stamping .......................................................................................................................73
Item Names/Reference Descriptions ......................................................................................................74

OPC Browsing
Two types of OPC browsing, namely off-line OPC browsing and on-line OPC browsing, are supported
by the ABCIP OI Server.
Note: For tag items defined as array data types in an item addition request, the OPC_E_BADTYPE
error is returned when an OPC client does not specify the array data type documented in the ABCIP
User's Guide or the VT_EMPTY data type. The only exception is when an OPC client specifies
VT_BSTR as the requested data type for an item that is defined as VT_ARRAY|VT_UI1. In this case,
the OI Server accepts the item addition and returns the data as VT_BSTR.

Off-line OPC Item Browsing (Static Browsing)

The OI Server implements population of the namespace to enable OPC browsing of ControlLogix,
CompactLogix, FlexLogix, GuardLogix, PLC-5, SLC500, MicroLogix, and SoftLogix processor items.
Browsing can also be performed off-line using the .aacfg file for Device Items created and saved with
the controller hierarchy node of the OI Server.
OPC browsing on item names is also provided to all controllers by means of importing a
comma-separated-value (.csv) file, which provides symbolic names to tag names, into the .aacfg file.

On-line OPC Item Browsing (Dynamic Browsing)

The on-line OPC browsing for ControlLogix, CompactLogix, FlexLogix, GuardLogix, PLC-5, SLC500,
MicroLogix, and SoftLogix processor items is implemented by the OI Server. Using the information
retrieved from the processor's tag database, the ABCIP OI Server will dynamically create a
configuration hierarchy that allows the DAS Engine to browse into it.
When it detects that the processor's tag database has changed while browsing, the ABCIP OI Server
will update the internal tag database but not the configuration hierarchy until the $SYS$BrowseTags
system tag is poked with "1."

63
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) ABCIP OI Server Reference

Note: The OPC item browsing capability is available on-line only when the ABCIP OI Server 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 OI Server is disabled. In order to browse
tags online from the OI Server, a "1" must be written to the $SYS$BrowseTags system tag associated
with the chosen processor hierarchy node. Subsequent OPC item browsing operation on this particular
processor should be enabled.

Logix5000 Optimization Mode

Operation of the ABCIP OI Server per device will be such that it can operate in the same multi-request
service (non-optimized) mode or in optimized mode 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-series controller (ControlLogix,
CompactLogix, FlexLogix, GuardLogix, SoftLogix). The tag database contains the data types and
unique references that can be used to reference the physical tags available in the controller. The tag
database kept in the controller is versioned. ABCIP OI Server 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 ABCIP OI Server supports only "No Optimization" and "Optimize for Read" mode on firmware
versions 21 and higher.
 The "Optimize for Startup" mode will only be used to access controllers operating on firmware
versions 20 and lower.
 The ABCIP OI Server 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 OI Server 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 controllers.
Three selectable options are:
1. No optimization
All tags that communicate with the Logix processor will use the tag name. The tag database
will be uploaded from the controller to validate the tag names. No optimization will have the
fastest startup time, but will have the slowest read performance. It will create more messages
for controller communication than the other two options. The length of the tag name will affect
the number of messages created.
2. Optimize for read (Default)
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
Available only for firmware versions 20 and lower, this option provides the best overall
performance among all three optimization options. All tags that communicate with the Logix
processor will require a tag database to be available as a prerequisite.

64
ABCIP OI Server Reference Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

This option does not generate a memory buffer inside the controller 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.

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 OI Server 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 OI Server will send separate requests for each
structure’s element. If the UDT involved is a nested structure (a UDT containing other UDTs), the OI
Server 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 RSLogix 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 OI Server.
This affects the UDT optimization capability in the ABCIP OI Server. This also affects Add On
Instructions behavior, which makes extensive use of UDTs. For these reasons, UDTs with 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 UDT optimization option is checked in the
ABCIP OI Server.

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

Logix5000 Write Optimization

The Poke Mode parameter in the ABCIP OI Server Manager configuration screen (OI.ABCIP.x) in the
SMC controls how the OI Server treats pokes within a transaction with respect to optimization and
folding.
You can select one of three modes:
o Control Mode
o Transition Mode
o Optimization Mode (ABCIP Default)
Control Mode - preserves the poke order without 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 poke 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.

65
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) ABCIP OI Server Reference

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 OI Server will attempt to group consecutive 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 OI Server Global Parameters, see the OI Server Manager User’s
Guide.

Data Type Determination

When a client sends a read/write request to the ABCIP OI Server, 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 OI Server internally 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, data type, and size.
 If an item is a structure, it also includes its members and their data types.
To build the table, the ABCIP OI Server 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 controller, unless a "refresh" request is received from the client. The ABCIP OI Server
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 (check box) as was implemented in the ABCIP DAServer 1.1.

Tag Database Status

To provide the status of the tag database for the Logix processor cached in the ABCIP OI Server, this
version of the OI Server will implement a predefined, read-only system variable, $Sys$TagDBStatus, of
type VT_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 OI Server.
Note: $Sys$UpdateTagInfo and $Sys$TagDBStatus are only available as item names associated with
the Logix processor.

Regardless of the status of the tag database upload, the ABCIP OI Server 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.

66
ABCIP OI Server Reference Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

Tag Database Version

The ABCIP OI Server 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
controller.
You can monitor changes in the Logix 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 OI Server shows the new database major and minor versions presented as a number in
addition to uploading the journal information from the controller.
Note: For tag items defined as array data types in an item addition request, the OPC_E_BADTYPE
error is returned when an OPC client does not specify the array data type documented in the ABCIP
User's Guide or the VT_EMPTY data type. The only exception is when an OPC client specifies
VT_BSTR as the requested data type for an item that is defined as VT_ARRAY|VT_UI1. In this case,
the OI Server accepts the item addition and returns the data as VT_BSTR.

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 immediately and will not be added to the OI Server address space.

Note: An item can have a valid item syntax but invalid name depending on how the controller is
programmed. In this case, the item will be added to the address space of the ABCIP OI Server with a
BAD quality indication.

For the Logix5000 family of controllers, the ABCIP OI Server uses a different approach on item
validation. When a Logix5000 controller item is requested to be subscribed or poked, the item is
always added to the address space of the OI Server. If the item syntax does not match any of the items
defined the Logix5000 controller, the item will maintain a BAD quality and is removed from any periodic
scanning.
The ABCIP OI Server does periodically send messages to the Logix5000 controller for tag database
update. The item that has a BAD syntax will be re-evaluated again when a new tag database 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.

Logix5000 Online Tag Management

The ABCIP OI Server has the ability to detect online changes to the Logix5000 processor tag database
and automatically update the status of these tags in your application.

Note: Tag change detection and updates are dependent on the Auto Load Tags on Activation, Auto
Synchronize Tags, and Use Persisted Tags setting for these Logix5000-compatible controllers. For
more information on On these tag database options, see Loading Tag Database from File on page 68

Adding or Removing Tags

When tags are added or removed from the Logix5000 processor, the OI Server can detect the change
and update its internal tag database. 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.

67
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) ABCIP OI Server Reference

Because the detection 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 OI Server is.

Making PLC Program Routine Changes While the Logix Controller is

Online
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 OI Server. The OI Server 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 OI Server can detect the change of state in
your Logix5000 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.
As soon as the program downloading process has completed, the OI Server 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, SoftLogix, CompactLogix and FlexLogix controller’s 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 OI Server is activated, it can perform an tag database upload.
If Auto Load Tags on Activation is selected, the OI Server will check the controller database version
on startup. If it is different from the version stored in file, it will read the tags from the controller and
synchronize the file. The Tag Database from File Options Matrix on page 69 explains the database
upload feature from the file.
If this option is NOT selected, the OI Server 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 OI Server 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 OI Server needs to synchronize
physical address of tags from device.

For information about importing new tags to an online PLC, see Making PLC Program Routine
Changes While the Logix Controller is Online on page 68.

68
ABCIP OI Server Reference Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

Persisted Tags
The ControlLogix, GuardLogix, SoftLogix, CompactLogix and FlexLogix controllers have an option to
use Persisted Tags for uploading the tag database from the file. This feature will improve the tag
database upload time.
When the OI Server is activated with the Persisted Tags option selected, it reads the tags from the
controller and stores them into a file under the bin\CIPTagDB directory.
If the version of the tag database matches the tag database file persisted from the last run, the ABCIP
OI Server will skip the tag database upload option and use the persisted file as the basis of the tag
database.
If the OI Server detects 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 OI Server will read the tag database from this file. This file will store the
database major and minor version information.
Important: If secured controllers (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 69 for a
detailed description of each option.

Tag Database from File Options Matrix

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 OI Server is activated. as soon as the first device item is
The OI Server will attempt to connect subscribed.
(Configurable
to the device only one time. If the
parameter in the The system item
device is not connected, it will retry
editor) $SYS$UpdateTagInfo can not be
when the first item is subscribed.
used to trigger a tag database
upload until the first device item is
subscribed.

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

69
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) ABCIP OI Server Reference

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

Use Persisted Tags The OI Server will read the tags from The OI Server will always upload
the tag database file. If the file does the tag database from the device
not exist, it will then read the tags and store them in to a file.
from the controller and store them into
a file under bin\CIPTagDB directory.
If the controller is unsecured and the
database version is different from the
controller version, then the OI Server
will read the tags from the controller
and store them into a file.
The system item
$SYS$UpdateTagInfo 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.

$SYS$UpdateTagInfo The tag database will be uploaded Poking the value False will not
from the device 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 Persisted Tags is
enabled, the original file will be
renamed to <####>_temp.aaTDB
(where ### represent the serial
number of the device). If the OI
Server 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.

70
ABCIP OI Server Reference Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

Manual Tag Synchronization

This system item ( $SYS$UpdateTagInfo) is provided for manual synchronization of tag database. If
the device is secured (Password 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 Persisted Tags is enabled, the original file will be renamed to <####>_temp.aaTDB
(where ### represent the serial number of the device). If the OI Server fails to upload tags from 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.

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 OI Server 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 OI Server will re-sync the tag databases at the next re-synchronization interval.
When the controller is secured an error is returned to the ABCIP OI Server indicating that the controller
is secured and a message will be logged indicating that tag database re-synchronization failed
because the controller is secured.
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 ABCIP OI Server 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. Even 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 Functionality Matrix on page 71 and Persisted Tag Functionality Matrix on
page 72 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

71
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) ABCIP OI Server Reference

Server Runtime behavior:

Auto Synchronize
Tag Configuration For unsecured controller For secured controller

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

Unselected Tag database version will not be Same behavior as if the controller
(Unchecked) checked. Changes in the tag is unsecured.
database in the controller will only
be uploaded if the
$SYS$UpdateTagInfo system tag
in the ABCIP OI Server is written
into.

Persisted Tag Functionality Matrix

Server Runtime behavior:
Persisted Tags
Configuration For unsecured controller For secured controller

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

2. If the file database version is

different from the controller
version, then the OI Server will
read the tags from the controller
and store them into a file.

Unselected The OI Server will always upload the tags from the controller and
(Unchecked) store them into a file.

72
ABCIP OI Server Reference Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

Controller Time Stamping

ABCIP OI Server has the capability to time stamp data changes with the controller’s date 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 between 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.
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 OI Server will treat the item
as two separate tags, "DataTag" and "TimeTag", and will validate each tag separately.
DataTag example "TimeStamp1":

73
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) ABCIP OI Server Reference

Integer_Recipe(0)&T&TimeStamp(0)

TimeTag example, concatenated:

TimeStamp1.TimeTimeString+""+TimeStamp1.TimeDateString

The OI Server 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 updates to the client.
If you enter an item name such as DataTag only, the value read from the controller 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 communication is lost with the
controller, the OI Server will timestamp the item and update its quality.

Item Names/Reference Descriptions

The Wonderware ABCIP OI Server currently supports item names that follow the conventions
described for the various Allen-Bradley ControlLogix, CompactLogix, FlexLogix, PLC-5, SLC500, and
MicroLogix families of controllers.
 Logix5000 Item Naming on page 75
 PLC-5 Item Naming on page 79
 SLC500 Item Naming on page 88

74
ABCIP OI Server Reference Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

 MicroLogix Item Naming

 OI Server-Specific System Item
 Generic OPC Syntax on page 109

Logix5000 Item Naming

The Logix5000 controllers (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 name. The Logix5000
item syntax is shown in the following table. The OI Server 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.

Reference Syntax

Program tag Program:<Program_Name>.<Tag_Name>

IO tag <Location>:<slot_#>:<Data_
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/writes of one-dimensional <Tag_Name>[<element_X>],L<number_of_items_#>

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

String tag <String_Tag_Name>[.DATA[[<element_#>]

]][,SC<string_length_#>]
<String_Tag_Name>[.DATA[[<element_#>]
]][,SP<string_length_#>]
<String_Tag_Name>[.DATA[[<element_#>]
]][,SS<string_length_#>]

75
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) ABCIP OI Server Reference

Reference Syntax

String tag array <String_Tag_Name>[<element_X>][.DATA

[[<element_#>]]][,SC<string_length_#>]
<String_Tag_Name>[<element_X>][.DATA
[[<element_#>]]][,SP<string_length_#>]
<String_Tag_Name>[<element_X>][.DATA
[[<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 data and timestamp Example:

are located 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 A.B.C.D.DataTag&T&.TimeTag
item name for structures reduces the
need to retype the same structure
name for the time tag.

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).
o String placeholder (start with uppercase): Location, Program_Name, Tag_Name, Data_Type,
Member_Name, SubMember_Name, and String_Tag_Name.
o Numeric placeholder (all in lowercase): elemeny_#, element_X, element_Y, element_Z,
string_length_#, slot_#, bit_#, and number_of_items_#.
o <Location>identifies network location as:
LOCAL = Local rail or chassis
<Adapter_Name> = Name of the remote module
o <Data_Type> is represented by a single letter as follows:
I=input, O=output, C=configuration, and S=status.
o All others are predefined keywords or symbols.
Examples:

76
ABCIP OI Server Reference Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

String tag array BatchRecipe[4], BatchRecipe[4].DATA

BatchRecipe[4].DATA[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:UserProgram.OperationMode

Module tag Local:6:O.Data.31

Remote_IO:2:C.ProgValue

Note: A STRING type member is implicitly a structure in the form of StringTag.DATA and
StringTag.LEN (where the DATA member is an array of 82 elements and the LEN 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 returned if the
DATA member is not explicitly included in the string specification when the string is put into
subscription.

Note: The "DT" qualifier returns a UTC date/time for OPC Clients requesting a "VT_DATE" binary
value. For DDE and SuiteLink clients, requesting a "VT_BSTR", the date is converted to a UTC
Date/Time string. The dates supported by the Date/Time string include values from 1/1/1970
12: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 OI Server supports read and write of user-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 data-type tags can be atomic or arrays up to three dimensions. The members of the
structure can be any data types supported by this OI Server. If a structure contains another 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 OI Server 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 OI Server 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 OI Server:

77
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) ABCIP OI Server Reference

 Block Reads/Writes of strings.

 Block Reads/Writes of structures (either predefined or user-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 (VT_BOOL) 3840 3831

SINT (VT_I1) 486 478

INT (VT_I2) 243 239

DINT (VT_I4) 114 114

Real (VT_R4) 121 119

LINT (VT_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 OPC
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 size of the data type.
o The Hex value can be converted to its equivalent decimal quantity for use in the application.
For example:

78
ABCIP OI Server Reference Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

A DINT (double integer data type) item occupies 4 (four) bytes of data, 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 converted 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.

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 Control 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

79
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) ABCIP OI Server Reference

Identifier File Type Default File # .fields

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 Control 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

D BCD None N/A

ST ASCII String* None .LEN

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

.DB .DO .DVDB .DVN .DVNA .DVP
.DVPA .EN .ERR .EWD .INI .KD .KI
.KP .MAXI .MAXO .MAXS .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 .RLEN .DLEN .DATA[0]
through .DATA[51]

CT CNet Message None .TO .EW .CO .ER .DN .ST .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).

80
ABCIP OI Server Reference Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

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).

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 (month)
S2:10/0 (battery low status bit)

Binary File Items

81
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) ABCIP OI Server Reference

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:
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

82
ABCIP OI Server Reference Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

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.

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 Control fields. The valid fields for
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. 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 .LEN or .POS fields
(which are words). If specified, it indicates the bit (0 - 15
decimal).

Examples:
R6:0.LEN
R6:3.EM
R6:1.POS

Integer File Items

83
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) ABCIP OI Server Reference

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

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 ASCII 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:

84
ABCIP OI Server Reference Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

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 BCD file contains a
number between 0 - 9999.

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

Examples:
D20:3
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.

85
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) ABCIP OI Server Reference

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.RLEN
BT9:3.FILE

PID Section Items

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

e specifies the element number within the PID file. It must be 0 - 398
decimal.

f identifies one of the valid PID fields. The valid fields for PID 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 OI Server's performance due to the extreme size of
the PID element (82 words each). If accessing only a few PIDs 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 OI Server 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.

86
ABCIP OI Server Reference Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

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.

.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 OI Server'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,
performance 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 the needed fields to an intermediate file (Binary or Integer) and let
the OI Server access the intermediate 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:
87
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) ABCIP OI Server Reference

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.

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.

88
ABCIP OI Server Reference Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

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 Control 6 .LEN .POS .EN .DN .ER .UL .IN .FD

N Integer 7 N/A

F Floating Point* 8 N/A

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).

89
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) ABCIP OI Server Reference

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)

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 software. The
OI Server 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 Data 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 table 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 OI Server. 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.
Also see the following topics, Label I/O Modules with "Word Counts," Sequentially Number the Input
Modules, and Sequentially Number the Output Modules, to complete 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-OA16 16-point 120VAC output module

90
ABCIP OI Server Reference Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

1746-IA16 16-point 120VAC 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

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-OA16 16-point 120VAC output module

1 1746-IA16 16-point 120VAC 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 encountered 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

91
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) ABCIP OI Server 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 SLC500 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 (three). 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.

92
ABCIP OI Server Reference Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

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.

93
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) ABCIP OI Server 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 the .PRE or .ACC
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 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 Control 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

Control 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.LEN
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.

94
ABCIP OI Server Reference Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

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 ASCII 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

95
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) ABCIP OI Server Reference

A9:0-19 (40-character ASCII string)

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

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, PID, SFC Status, Block
Transfer, and Control files.
Refer to the following table.

96
ABCIP OI Server Reference Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

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 Control 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
.MAXS .MINS .ZCD .CVH .CVL .LUT .SPV
.CVP

MG Message None .IA .RBL .LBN .RBN .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 specified, it

must be 0 (zero).

97
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) ABCIP OI Server 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 details.

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 SLC500 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)

98
ABCIP OI Server Reference Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

S:1/5 (forces enabled)

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 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

99
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) ABCIP OI Server Reference

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 (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 counter. 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:
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)

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

f identifies one of the valid Control 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

Control 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.LEN
R6:3.EN

100
ABCIP OI Server Reference Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

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 (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

101
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) ABCIP OI Server 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 PID 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 OI Server'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 intermediate file (Floating Point or Binary) and let the OI Server 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 MSG fields. The valid

fields for MSG files are listed in the table.

102
ABCIP OI Server Reference Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

b is optional and is normally not used. Specifying the

.f fields can access all of the 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 OI Server'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,
performance 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
OI Server access the intermediate files.

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

OI Server-Specific System Item

The following system items refers to specific information regarding the OI Server, OI Server Manager,
and the controllers.

Type/

System Item Name Access Rights Description Values

The following generic system items are supported for all Allen-Bradley controllers, unless otherwise
noted.
$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$PLCType String/Read Name of the process type. Descriptive text

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

103
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) ABCIP OI Server Reference

Type/

System Item Name Access Rights Description Values

$SYS$UpdateTagInfo Boolean/ Force update of the whole RANGE:

ReadWrite controller tag database. On or Off
The OI Server returns
WriteComplete for
$SYS$UpdateTagInfo when
poked. The transaction will be
completed 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 consumes
resources. During the updating
process, the OI Server 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..

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

ReadWrite tags are browsable from OPC True or 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:

104
ABCIP OI Server Reference Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

Type/

System Item Name Access Rights Description Values

Uninitialized – The tag database is Uninitialized

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 because of errors
encountered during the upload.

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

Read-Only database. Major version:
0...65535
String format: MajorVersion.
(no padding)
MinorVersion
Minor version:
If version information cannot be
0...999
acquired (for example, due to a
(no padding)
bad PLC connection) the value
initially displays "Uninitialized" as a
string.

$SYS$UpdateTagInfo Boolean/ Forces update of the controller tag RANGE:

ReadWrite database upon adding the next True or 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..

$SYS$DeviceSecurity Boolean/ Status of controller security RANGE:

Read-Only True or False

105
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) ABCIP OI Server Reference

Type/

System Item Name Access Rights Description Values

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

Read-Only ControlLogix message optimization True or False
in handle mode as enabled with
the ControlLogix 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 ControlLogix user-defined data True or False
type optimization enabled with the
User Defined Data Type
Optimization check box under the
Logix5000 node editor 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

106
ABCIP OI Server Reference Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

Type/

System Item Name Access 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 each communications node in the ABCIP OI Server,
unless otherwise noted.

$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.

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

Read-Only in response to the unsolicited 0…2147483647
message.

107
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) ABCIP OI Server Reference

Type/

System Item Name Access Rights Description Values

$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 reset statistic
counters of all child nodes.

$SYS$TotalPacketSent DWord/ Returns the number of data RANGE:

Read-Only packets sent. 0…2147483647

$SYS$TotalPacketReceiv DWord/ Returns the number of replies RANGE:

ed Read-Only received. 0…2147483647

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

Read-Only sent 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$ItemWriteRate 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.

108
ABCIP OI Server Reference Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

Generic OPC Syntax

An OI Server serves as a container for the OPC Groups, which provide the mechanism for containing
and logically organizing OPC items. Within each OPC Group, an OPC-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 OPC 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 Item ID is OI Server-dependent. In OPC data
acquisition OI Servers, the syntax can be as follows:
AREA10.VESSEL1.TIC1.PLC.N7:11
where each component (delimited by a hint, that is, a period in case of an OI Server) represents a
branch or leaf of the field device’s hierarchy.
In this example:
 AREA10.VESSEL1.TIC1 is the link name for an OI Server.
 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 OI Servers, Access Paths are equivalent to Device Groups; it is this parameter that is used to define
the update interval between the OI Server and the field device for accessing the values of data points
in the controller.

109
 Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

C HAPTER 4
Troubleshooting the ABCIP OI Server
In This Chapter
Troubleshooting with Windows Tools ....................................................................................................111
Troubleshooting with the OI Server Manager .......................................................................................111
Finding Version Information ..................................................................................................................111
Using the ArchestrA Log Viewer ...........................................................................................................112
ABCIP OI Server Error Messages .........................................................................................................113
ABCIP OI Server Error Codes ...............................................................................................................120
Logix5000 Error Codes .........................................................................................................................120
Data Highway Plus Error Conditions .....................................................................................................124
PLC-5 Error Messages ..........................................................................................................................125
SLC500 and MicroLogix Error Messages .............................................................................................127
PLC-5, SLC500, and MicroLogix Error Messages ................................................................................127

Troubleshooting with Windows Tools

Windows has two tools that may be useful in troubleshooting performance problems.
You can find quick verification that the OI Server process is running by looking at the Windows Task
Manager. It also provides information on the user, CPU, 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 Console (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 OI
Server is active, a diagnostic node is present below the configuration node in the console tree of the
System Management Console.
Each diagnostic leaf contains information about OI Server activity. For more information, see the OI
Server Manager User Guide or Help files.

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.

111
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Troubleshooting the ABCIP OI Server

To determine version information for OI Server components

 In the OI Server Manager, select the OI Server name in the console tree. The version information
for each OI Server component is shown in the details pane.

Using the ArchestrA Log Viewer

Error messages are created by the OI Server and logged by the ArchestrA 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 OI Server creates.
Note: Generating large numbers of diagnostic messages can impact OI Server performance. You
should not run in production with any more flags than those set when the OI Server is installed. To
troubleshoot 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 determine whether
the OI Server is communicating with a device, you can enable the DASSend and DASReceive 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.

OI Server Log Flags

Messages created for these log flags are for OI Server common components and contain information
about internal OI Server activities.
 DACmnProtFail: Some failure occurred in the common components while sending a message,
updating an item, or otherwise moving data. Typically, this represents 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.

112
Troubleshooting the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

 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 DACmnVerbose to get
the most information.
 DACmnVerbose: Many log flags used by the DAS common components are modified occasionally
by DACmnVerbose. When DACmnVerbose 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: Events surrounding messages that are returned to the DAS Engine by the
server-specific DLL, including the blocking and unblocking of hierarchies.

OI Server-Device Interface Log Flags

Messages created for the following log flags are specific to an individual OI Server and contain
information about communications between the OI Server 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 OI Server 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 OI Server starts.
 DASStateCat1: General diagnostic messages of a protocol-specific nature. For example, you can
provide the number of items in a message for a specific protocol, then optimize based 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.
 DASReceive: Protocol messages received from the device 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 OI
Server, 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-generated state machines created by the OI Server
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 deleted.

ABCIP OI Server Error Messages

The following table lists the error messages produced by the OI Server that are logged to the Log
Viewer.
 <Message ID> corresponds to the message ID displayed in the OI Server’s Diagnostics root in the
OI Server Manager.
 <Device> 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.

113
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Troubleshooting the ABCIP OI Server

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 socket.
of simultaneous been reached. No communications has
unsolicited data more unsolicited data been reached.
connections [MAX socket] packages will be
has already been accepted.
reached. Data packet
ignored.

ABCIPAcceptedSocket: Unable to associate Software internal Restart the OI Server

Initialize unable to the event with a valid error. and try again.
associate an event with a handle within the
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 because 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 returned (refer other error messages in
<Message ID> when poll-message to the tables in the logger. Check the OI
reading from <Device> response from the Logix5000 Error Server diagnostics, if
device; further Codes). necessary.
explanations follow.

114
Troubleshooting the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

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 returned (refer other error messages in
<Message ID> when poke-message to the tables in the logger. Check the OI
writing to <Device> response from the Logix5000 Error Server diagnostics, if
device; further Codes). necessary.
explanation follows.
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 returned (refer other error messages in
<Block Item Name> in block for to the tables in the logger.
message <Message ID> Multi-Request Logix5000 Error Check the OI Server
from <Device> messages. Codes on page 120). diagnostics, if
Further explanation of necessary.
the errors will be
listed.
Encountered the following The error code is This is an internal
error when reading returned from the error. See the CIP
optimized block <Internal ControlLogix controller Service error code
Block Address> in when the server tries for details.
message <Message ID> to read the
from <Node> optimization 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 returned (refer other error messages in
<Block Item Name> in block for to the tables in the logger.
message <Message ID> Multi-Request Logix5000 Error Check the OI Server
from <Device> messages. Codes on page 120). diagnostics, if
Further explanation of necessary.
the errors will be
listed.
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
peer-to-peer) unsolicited peer-to-peer port. same port (such as
data will be accepted. unsolicited data used. RSLinx).
The network
As a result, no
communications is Make sure the network
unsolicited data can
having a problem. is functioning.
be accepted.
The controller is Make sure the controller
having a problem is functioning.
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 120).
one.

115
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Troubleshooting the ABCIP OI Server

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 not exist in the PLC external access from
<UDT base name> in a 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 does not exist. External Access
members are configured attribute of "None".
for 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 OI Server restart ABCIP OI
cannot receive Server.
unsolicited message
from controllers.

Host EtherNet/IP <IP The maximum number The maximum System limit on TCP
address> connect host of sockets allowed number of sockets sockets on the machine
failed, maximum number was exceeded. allowed was hosting the OI Server is
of socket <MAX socket> exceeded. reached. Check if there
exceeded are other programs on
same the machine
consuming a large
number of sockets.
Inconsistent message The OI Server This is an internal
type encountered for encounters an internal error.
<Device Name> 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 structure name is
exist in the controller correct and exists in the
controller.
Invalid item <Item "," was used to specify An incorrect format Check the item’s format.
Name>, invalid item the item’s format. was used for the
format <format> However, the format item.
was found to be invalid
for the item.
Invalid item <Item An invalid index is An invalid index is Check the index
Name>, invalid index specified in the item. found in the item. specified. Only integer is
accepted as an index.

116
Troubleshooting the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

Error Message Explanation Probable Cause Solution

Invalid item <Item The member of the The member is not Check the structure’s
Name>, member structure cannot be defined in the definition in the device.
<Member Name> not found. structure.
found in structure
Invalid item <Item The item’s definition The item is not Check the item’s
Name>, not defined in the cannot be found in the defined in the Logix definition in the device.
processor tag database. processor.
Invalid item <Item The internal limit of the The item’s nesting Reduce the item’s
Name>, 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 The item points to a A structure item is Retrieve an individual
Name>, retrieving whole structure other than a specified. member of the structure
structure not supported string. The OI Server instead of the whole
does not support this structure.
type of item.
Invalid item <Item The structure definition Invalid item Check the item’s
Name>, structure not for the item cannot be encountered. definition in the device.
found located.
Invalid item <Item There is a syntax error An invalid item is Check the item’s syntax.
Name>, syntax error in the item. specified.
Invalid item <Item The suffix specified The suffix is not Check the suffix
Name>, unknown suffix after "," is not supported. specified for the item.
recognized by the OI
Server.
Invalid item <Item The dimension The item’s array Check the item’s
Name>, dimension specified in the <Item dimension is definition in the device.
mismatch Name> is different different from the
from what has been definition in the
defined in the device. device.
Invalid item <Item The bracket for the An invalid item is Correct the item’s
Name>, index bracket index is mismatched. entered. syntax.
mismatch This is an item syntax
error.
Invalid item <Item The index specified in The item’s index is Check the item’s
Name>, index out of the <Item Name> is too large. definition in the device.
range outside the range
defined in the device.
Invalid item <Item The bit number An invalid item is The bit number
Name>, invalid bit specified in the item is specified. specified cannot go
number invalid. beyond the range
allowed for the item’s
data type. For example,
INT range is 0-15 and

117
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Troubleshooting the ABCIP OI Server

Error Message Explanation Probable Cause Solution

DINT range is 0-31.

Item <ItemName> cannot ABCIP OI Server The system ran out Reduce the number of
be created, out of failed to obtain of memory. tags in the OI Server.
memory. memory during item Close other
creation. applications.
Message <Message ID> The OI Server did not The device is off line. Check the device’s
for <Device> timed out. receive the message’s network connection.
response from the
device 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 protocol.
Received incomplete The response packet Bad connection or Check if there are other
response packet for is incomplete or there is a OI Server error messages in the
message <Message ID> corrupted. problem. logger.
from <Device> Check the OI Server
diagnostics if necessary.
recv() for <HostName> on Failed to read from the Failed to read from Repeat the operation by
port <PortNumber> failed Window Socket the Winsock. restarting the OI Server.
specified.
Register Session The OI Server Not communicating Check the controller
encountered the following encountered an error with a ControlLogix configuration.
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 protocol.
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

118
Troubleshooting the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

Error Message Explanation Probable Cause Solution

missing or invalid. tag.

Rejected <PLC Type The &T& time tag Controller firmware Upgrade the controller
Name> ITEM = <Item syntax cannot be used version is not firmware version to 16
Name> on plc <PLC with controller compatible with &T& or above if the &T& time
Node Name>. Time Tags firmware prior to time tag tag syntax is to used.
not supported on version 16.0. requirement.
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 tag must be LINT
Name> on plc <PLC correct
Node Name>. Invalid data
type for time tag
Response service code The service code in Packet corrupted or Check if there are other
<ServiceCode> different the message sent OI Server problem error messages in the
from command <Service does not match the encountered. logger.
Code> for message one in the reply. Check the OI Server
<Message ID> diagnostics, if
necessary.
Response service code Unexpected service This is an internal The service code
<ServiceCode> not code was encountered error. received by the OI
handled in the reply packet Server is not supported.
from the controller. Verify the controller
firmware version against
version supported by
the OI Server.
Session error <Error Communications CIP-error dependent
Code>, packet ignored errors encountered. (refer to the tables in
Logix5000 Error
Codes on page 120).
Socket <SocketID> This is an internal This is an internal
send() returned Winsock error. Winsock error.
<ErrorNumber>,
connection to be closed
Socket <SocketID> Failed to send on This is an internal
sending packet with socket due to the data error.
buffer size <BufferSize> packet size.
larger than <MAX buffer
size>

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 120).

119
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Troubleshooting the ABCIP OI Server

Error Message Explanation Probable Cause Solution

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 data unsolicited data packet a controller. unsolicited data
port connected to <PLC from a controller. correctly.
Host Name>
Make sure the OI Server
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 OIServer
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 OI Server
is functioning correctly.
Unsolicited socket not Unsolicited socket was This is an internal Reset the node
open for device <Device> not open when the OI error. hierarchy to restart the
Server tried to send a connection
reply message to the
device.

ABCIP OI Server 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 OI Server to the logger.

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

00 Success

120
Troubleshooting the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

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

01 Connection failed DASProtFail

02 Insufficient Connection Manager resources DASProtFail

03 Invalid connection number DASProtFail

04 IOI could not be deciphered. Either it was not DASProtFail

formed correctly or the match tag does not exist

05 The particular item referenced could not be found DASProtFail

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

07 Connection has been lost DASProtFail

08 Requested service not supported DASProtFail

09 Error in data segment or invalid attribute number DASProtFail

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

attributes

0C Service cannot be performed while object is in DASProtFail

current state

10 Service cannot be performed while device is in DASProtFail

current state

11 Response data too large DASProtFail

13 Not enough command data/parameters were DASProtFail

supplied in the command to execute the service
requested

14 Attribute not supported DASProtFail

15 Too much data was received DASProtFail

1C An insufficient number of attributes were provided DASProtFail

compared to the attribute count

1E Errors encountered with the items in the message DASProtFail

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

121
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Troubleshooting the ABCIP OI Server

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

None of the above Unknown Status DASProtFail

codes

Extended Allen-Bradley
Error Code (Hex) Logger Message Log Flag

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

2105 You have tried to access beyond the end of the DASProtFail
data object.

2106 Data in use. DASProtFail

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

0100 Connection in Use or Duplicate Forward Open. DASProtFail

0103 Transport Class and Trigger combination not DASProtFail

supported.

0106 Ownership Conflict. DASProtFail

0107 Connection not found at target application. DASProtFail

0108 Invalid Connection Type. Indicates a problem DASProtFail

with either the Connection Type or Priority of
the Connection.

0109 Invalid Connection Size. DASProtFail

0110 Device not configured DASProtFail

0111 RPI not supported. May also indicate problem DASProtFail

with connection time-out multiplier.

0113 Connection Manager cannot support any more DASProtFail

connections.

0114 Either the Vendor ID or the Product Code in the DASProtFail

key segment did not match the device.

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

122
Troubleshooting the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

Extended Allen-Bradley
Error Code (Hex) Logger Message Log Flag

0116 Major or Minor Revision information in the key DASProtFail

segment did not match the device.

0117 Invalid Connection Point. DASProtFail

0118 Invalid Configuration Format. DASProtFail

0119 Connection request fails since there is no DASProtFail

controlling connection currently open.

011A Target Application cannot support any more DASProtFail

connections.

011B RPI is smaller than the Production Inhibit Time. DASProtFail

0203 Connection cannot be closed since the DASProtFail

connection has timed out.

0204 Unconnected Send timed out waiting for a DASProtFail

response.

0205 Parameter Error in Unconnected Send Service. DASProtFail

0206 Message too large for Unconnected message DASProtFail

service.

0207 Unconnected acknowledge without reply. DASProtFail

0301 No buffer memory available. DASProtFail

0302 Network Bandwidth not available for data. DASProtFail

0303 No Tag filters available. DASProtFail

0304 Not Configured to send real-time data. DASProtFail

0311 Port specified in Port Segment Not Available. DASProtFail

0312 Link Address specified in Port Segment Not DASProtFail

Available.

0315 Invalid Segment Type or Segment Value in DASProtFail

Path.

0316 Path and Connection not equal in close. DASProtFail

0317 Either Segment not present or Encoded Value DASProtFail

in Network Segment is invalid.

0318 Link Address to Self Invalid. DASProtFail

123
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Troubleshooting the ABCIP OI Server

Extended Allen-Bradley
Error Code (Hex) Logger Message Log Flag

0319 Resources on Secondary Unavailable. DASProtFail

031A Connection already established. DASProtFail

031B Direct connection already established. DASProtFail

031C Miscellaneous. DASProtFail

031D Redundant connection mismatch. DASProtFail

None of the above codes Unknown Extended Status. DASProtFail

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

Data Highway Plus Error Conditions

The Data Highway Plus generates error conditions. These error conditions and the server-specific
strings are generated by the OI Server 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

DHPERR_DP_FNC (0x20000001) Dual-port memory functionality test error

DHPERR_RAM (0x20000002) Unknown random access memory test error

DHPERR_RAM (0x20000003) Failure of Z80 RAM 0

DHPERR_RAM (0x20000004) Failure of dual-port RAM

DHPERR_RAM (0x20000005) Failure of Z80 RAM 1

DHPERR_RAM01 (0x20000006) Failure of both Z80 RAM 0 and RAM 1

DHPERR_RAM1_DP (0x20000007) Failure of both RAM 1 and Dual-Port RAM

DHPERR_CTC (0x20000008) Unknown counter timer circuit test error

DHPERR_CTC_TMR (0x20000009) Failure of CTC timer module

DHPERR_CTC_CNT (0x2000000A) Failure of CTC counter module

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

DHPERR_SIO (0x2000000C) Unknown serial input output test error

DHPERR_SIO_INT (0x2000000D) Failure of CIO channel: no interrupt

124
Troubleshooting the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

Allen Bradley Error Code Logger Message

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

DHPERR_PROT_LOAD Protocol file download error

(0x2000000F)

DHPERR_LOAD_BLK (0x20000010) Block too large error

DHPERR_RAM_FULL (0x20000011) Z80 RAM too full for next block

DHPERR_BD_WRITE (0x20000012) Cannot write to adapter card memory

DHPERR_OPEN_LOADPCL Cannot open file LOADPCL.BIN

(0x20000013)

DHPERR_OPEN_KLPCL Cannot open file KLPCL.BIN

(0x20000014)

DHPERR_OPEN_KLST0 Cannot open file KLST0.BIN

(0x20000015)

DHPERR_OPEN_KLST1 Cannot open file KLST1.BIN

(0x20000016)

DHPERR_OPEN_KLST2 Cannot open file KLST2.BIN

(0x20000017)

DHPERR_OPEN_PROT Cannot open protocol file

(0x20000018)

TIMEOUT_ERR (0x01) Timeout error

CANCELLED_ERR (0x02) Cancelled error code

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 larger. equal to 3 or larger.
3 for PLC-5.

125
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Troubleshooting the ABCIP OI Server

Error Message Explanation Possible Cause Solution

BINARY file Incorrect format for this The Binary Item’s File Only access the
number must be item. The Binary Item’s Number must be 3 or Binary Item with File
greater than 2 File Number was smaller larger. Number equal to 3 or
than 3 for PLC-5. larger.

BT file number Incorrect format for the The BT Item’s File Only access the BT
must be > 8 Item. The BT 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 BT 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
BT[FileNumber] not permitted. PLC-5.

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 Control Item with File
greater than 2 File Number was smaller larger. Number equal to 3 or
than 3 for PLC-5. larger.

INTEGER file Incorrect format for the The Integer Item’s File Only access the
number must be item. The Integer 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 feature 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 controller
PID feature 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 ST Item’s File Only access the ST
must be > 4 Item. The SC 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 ST Item’s File Only access the ST
must be > 8 Item. The ST 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.

126
Troubleshooting the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

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 larger. equal to 3 or larger.
3 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

BINARY file number Incorrect format for this Binary Item’s File Only access Binary
must be 3 or 9-255 item. The Binary Item’s Number must be 3 or Item with valid File
File Number was not 3 or 9-255. Number.
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.

COUNTER 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.

FLOAT file number Incorrect format for the The Float Item’s File Only access the Float
must be 8 or 8-255 item. The Float Item’s File Number must be 8 or Item with the valid File
Number was not 8 or 8-255. Number.
8-255.

INTEGER file number Incorrect format for the The Integer Item’s File Only access the Integer
must be 7 or 9-255 item. The Integer 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 Item’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.

127
Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series) Troubleshooting the ABCIP OI Server

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 Item with a File
2 Item’s File Number larger. Number equaling to 3
was smaller than 3. or larger.

BINARY file, bit>15 Incorrect format for The valid format for a Only access the Binary
and element>0 the item. The Binary PLC-5 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 Use a valid range for
between 0 and 999 the Item. The Item’s was used. the Item’s File Number.
File Number was out
of range.

FLOATING POINT Incorrect format for The Floating Point Item Only access the
file 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.

FLOATING POINT Incorrect format for The Floating Point Item’s Only access the
file 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.

INPUT 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
Item’s File Number Number that equals to
was not 1. 1.

OUTPUT file number Incorrect format for The Output Item’s File Only access the Output
must be 0 the item. The Output Number must be 0. Item with a File
Item’s File Number Number equaling to 0.
was not 0.

STATUS 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
Item’s File Number Number equaling to 2.
was not 2.

128
Troubleshooting the ABCIP OI Server Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

Error Message Explanation Possible Cause Solution

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
[FileNumber] element write to a read-only failure. read-only item.
[Element#] item.
subelement
[Sub-Element#]
ignored

129
 Wondereware Operations Integration - Supervisory ABCIP Server (G-1 Series)

Index
No index entries found.

131