WHDDE SuiteLink Server

for Logix5000 messaging

applicom®

a product of Woodhead Software & Electronics

WHDDE SuiteLink Server for Logix5000 messaging 1 08/02/2008

Copyright © 2006 Woodhead Software & Electronics. All rights reserved.

WHDDE SuiteLink Server for Logix5000 messaging 2 08/02/2008

Copyright © 2006 Woodhead Software & Electronics. All rights reserved.

 Table of contents

1. Presentation of the WHDDE SuiteLink Server.............................4

Utilization context of the WHDDE SuiteLink Server................................................4
Before using the DDE/SuiteLink server for the first time.........................................5
Graphic Interface of the Server ...............................................................................5

2. Configuring the DDE/SuiteLink server.........................................6

Basic parameters ....................................................................................................6
“Expert” configuration mode ....................................................................................8

3. Principles regarding access to Data ............................................9

4. Access to variables of a Logix 5000 controller .........................10

Configuration of an “image variable” topic of a Logix 5000 controller...................10
Limitations .............................................................................................................10
Diagnostics information .........................................................................................11

5. Diagnostic Interface.....................................................................12
Communication requests.......................................................................................14
Communication optimization .................................................................................15
Item Watch View ...................................................................................................16
Exporting item syntaxes ........................................................................................18
Message View .......................................................................................................20

WHDDE SuiteLink Server for Logix5000 messaging 3 08/02/2008

Copyright © 2006 Woodhead Software & Electronics. All rights reserved.

 1. Presentation of the WHDDE SuiteLink Server

Utilization context of the WHDDE SuiteLink Server

The product includes high-level software interfaces, so that data access is totally transparent for the
user. These software interfaces, which include the DDE/SuiteLink WHDDE server, enable “client”
applications to handle the data made available without having to think about managing accesses to
the boards (or to the software emulator with product Direct-Link PC Network Interfaces) or
optimizing the communication.
The WHDDE server acts as industrial data server for applications in “FactorySuite” software edited
by Wonderware supporting one of the following exchange protocols:
FastDDE (version 2 and greater)
SuiteLink
It can therefore be easily used from InTouch®.
Important notes:
The WHDDE server can be used to communicate with Control Logix type device by
using Logix 5000 messaging. It cannot be used to access the other protocols or
messaging systems of the product for which the PCDDE server is still used.
If an application should require this, the two servers can be run simultaneously on
the same machine.
Using the WHDDE server from DDE client applications not provided in the
Wonderware FactorySuite is not supported by the product. In this case, please
contact your DDE client application distributor.

The DDE/SuiteLink WHDDE server is an application (“whdde.exe”) which can run in Windows
Windows environments:
Either as a conventional application (ordinary executable file),
Or as a Windows service.

The DDE/SuiteLink server can be used locally (from a client application located on the same
machine) or remotely (from a client application located on another machine connected by the
network). In the second case, if the client application uses the SuiteLink protocol, the client/server
connection will take place via TCP/IP sockets.

See also:
In the knowledge base
Use of the DDE/Suitelink server with InTouch®

WHDDE SuiteLink Server for Logix5000 messaging 4 08/02/2008

Copyright © 2006 Woodhead Software & Electronics. All rights reserved.

Before using the DDE/SuiteLink server for the first time
The product includes:
The DDE/SuiteLink “WHDDE” server based on the FastDDE or SuiteLink protocols edited
by Wonderware for access to Logix 5000 messaging.
The DDE/SuiteLink “PCDDE” server based on the FastDDE or SuiteLink protocols edited
by Wonderware for access the other protocols or messaging systems supported by the
product.
The OPC server “APP_OPC” based on the OPC foundation specifications 3.0, 2.05A and
1.0A (using OLE technologies).

The DDE/SuiteLink servers cannot cohabit simultaneously on the same computer with the
OPC server. However, the two DDE/SuiteLink servers can cohabit and be used
simultaneously by the same application.

To run the WHDDE server, some of the Factory Suite components must necessarily be present on
the machine:
These components are automatically installed with all the FactorySuite Software
(InTouch,...) or can be eventually installed in stand alone.
Otherwise, a message indicating that a DLL (commonui.dll) cannot be found will be
displayed when trying to start the server.

Graphic Interface of the Server

By default, the WHDDE server has no graphic interface. When it is running, the server is displayed
as an icon inserted in the task bar. By default, this icon has no pop-up menu. However, this menu
can be activated from the DDE (WHDDE) parameter configuration box, by validating the option
authorize display of the server diagnostic. By right-clicking on the mouse, you can use this
menu to:
display the diagnostic environment (Diagnostic menu).
Close the server (Quit menu)

To make it easier to insert tag names in the supervision software, the WHDDE server proposes, via
its diagnostic interface, the display in tree structure of all available syntaxes.

WHDDE SuiteLink Server for Logix5000 messaging 5 08/02/2008

Copyright © 2006 Woodhead Software & Electronics. All rights reserved.

 2. Configuring the DDE/SuiteLink server

Basic parameters
All the configuration required to use the DDE/SuiteLink WHDDE server is carried out from the
configuration console, in the configuration description view.

Caution: these parameters are generally taken into account when you boot the server. You must
therefore reboot it after making any modifications.

In particular, these parameters will allow you to:

start WHDDE server as a service
initialize automatically the solution when starting WHDDE server
automatically start a client application after starting WHDDE server.

WHDDE SuiteLink Server for Logix5000 messaging 6 08/02/2008

Copyright © 2006 Woodhead Software & Electronics. All rights reserved.

 The “Self start” tab
This tab is used to set the parameters which concern the start-up of the server and the
synchronization with client applications.

Menu Description
Starting WHDDE as This option allows you to use the DDE/SuiteLink server as Windows service. The
Windows Service server will start automatically when starting Windows, even before a user logs in.
When this option is validated, the “Starting a client service area” allows you, if
necessary, to synchronize the start-up of another Windows service, DDE/SuiteLink
client.

This operation requires owning administration privileges. As a consequence, if the

user doesn’t own these rights, it is then necessary to launch the configuration
console with administrator privileges, by right-clicking on the configuration console
and selecting the “Run As Administrator” menu. The user can then be asked for a
logging and password having administration privileges.

Caution: When starting WHDDE in service mode the icon representing the
presence of the server will not be displayed in the Windows task bar. Consequently,
you will not be able to obtain the server diagnostic view.
In addition, in the service set-up parameters, the box Authorize the service to
interact with the Desktop must never be enabled.
Initialization of applicom® If this option is validated, the DDE/SuiteLink server automatically triggers
boards before server start- initialization of the boards when starting up. This option is not available if the server
up is used as Windows service.
Starting a client application This option allows you to automatically trigger the start-up of a DDE/SuiteLink client
application when the server has finished its start-up.
This option is not available if the server is used as Windows service.
Starting a client service This option allows you to automatically trigger the start-up of a DDE/SuiteLink client
service when the server also used as service has finished its start-up. This option is
only available if the server is used as Windows service.

WHDDE SuiteLink Server for Logix5000 messaging 7 08/02/2008

Copyright © 2006 Woodhead Software & Electronics. All rights reserved.

 See also:
In the documentation:
Specificities of version 4.0

“Expert” configuration mode

An expert mode to configure the DDE/SuiteLink server becomes available on the console when
the console is itself switched in expert mode. This mode is only useful for specific cases, e.g. when
you need to:
activate certain debugging capacities
use advanced, non standard functionalities of the product
modify certain timings
Additional tabs
Initially, the configuration dialog box contains only one tab to set the server start-up options. When
the console is switched into expert mode, two additional tabs are displayed:
Expert tab
It is used to configure certain internal parameters. These may modify the dynamic
behaviour of the server. Caution: some of these parameters may also directly affect the
performance of the server. They must only be changed after contacting our technical
support and are therefore not documented.

See also:
In the documentation:
Implementation: Global command of the File menu

WHDDE SuiteLink Server for Logix5000 messaging 8 08/02/2008

Copyright © 2006 Woodhead Software & Electronics. All rights reserved.

 3. Principles regarding access to Data

The DDE protocol identifies a data item via a three-part address. The three parts are Application,
Topic and Item.
Application
Refers to the Windows program (server) which can access the data items. Here, the
Application part of the DDE address is “WHDDE”.
Topic
The DDE/SuiteLink WHDDE server uses a random name called topic as access path
to the variables. With the WHDDE server you must specify the topic name of the
targeted Control Logix device, as it was configured in the configuration console. Only
the topics referencing devices on Logix5000 messaging will be recognized by the
WHDDE server.
Item
Determines a data item within the specified topic. In this specific case you must
specify the item name, as defined within the Control Logix device configuration.

Note: in certain cases, the term “point” is used for “item”.

WHDDE SuiteLink Server for Logix5000 messaging 9 08/02/2008

Copyright © 2006 Woodhead Software & Electronics. All rights reserved.

 4. Access to variables of a Logix 5000 controller

The “image variables”:

This term designates the variables available of the remote Logix 5000 controller(s). They can be
accessed via a topic of “image variable” type. You must define one topic for each remote device.
The image variables are accessible in read and write
The read requests are automatically created by the server according to requirements in variables in
the client applications. Up to 1024 transactions can be generated per channel. They are
permanently optimized to minimize the communication. These transactions contain tags defined
directly in the Logix 5000 controller you are accessing.
The writes are reflected directly in the remote device.

Configuration of an “image variable” topic of a Logix 5000 controller

Just adding a device of type “Logix5000 – Logix5000 Messaging (OPC only)” creates a topic
associated with this device, allowing it to be used in the client application.

However, the topic contains the following parameter which you can modify:
“Optimize access to structure fields”
If this parameter is checked and an item representing a field of a structure whose size is
less than or equal to 488 bytes is requested by a client, the tag identifying the complete
structure will be placed in a transaction. Consequently, if any other item representing a
different field in this structure is added, no transaction modification will be necessary. If this
parameter is not checked, each field of the structure will be added in the transactions
independently.

“Offline browsing file”

States the path and the name of the .L5K file that the server will use to obtain the list of
symbols for this topic. These symbols will be grouped under the “offline” node by the OPC
browser.

Limitations
The product used with the Logix5000 controller does not support the following standard
functionalities:
The extensions _B (BCD format) and _S (Forcing in signed value)

WHDDE SuiteLink Server for Logix5000 messaging 10 08/02/2008

Copyright © 2006 Woodhead Software & Electronics. All rights reserved.

Diagnostics information

Syntaxes Description
Device statuses
STATUS For each Topic, you can read a local write status (STATUS_WRITE), a local read status
STATUS_READ (STATUS_READ) and a status combining both (STATUS). They provide information
STATUS_WRITE about the access to the device. The Status values range from 0 to 65535.The main
statuses are given below.

For further information, please consult the protocol manuals in chapter “Function return
statuses”.

Normal values:
0: No error.
255: this is the initial value of the status items for a topic as long as no transaction
has been carried out with the board.
Number of advise faults
ADVISE_FAILED Used to access the number of advise faults which have occurred for a “Standard topic”,
i.e. the number of points refused by WHDDE because of bad syntax. This item is read
only.
Number of write errors
WRITE_ERROR Used to access the number of write errors which have occurred for a “Standard topic”.
This item is read only.
Number of read errors
READ_ERROR Used to access the number of read errors which have occurred for a “Standard topic”.
This item is read only.

WHDDE SuiteLink Server for Logix5000 messaging 11 08/02/2008

Copyright © 2006 Woodhead Software & Electronics. All rights reserved.

 5. Diagnostic Interface

To access the diagnostic interface, first select the option Authorize Display of the Server
Diagnostic in the Properties of the WHDDE Server (see cross-reference below). It is shown by
an icon in the Windows task bar upon start-up of WHDDE server.

Double-clicking on the icon displays the diagnostic environment. Right-clicking on the mouse brings
up a menu enabling the user:
to display the diagnostic window. Diagnostic menu
to close the WHDDE server. Exit menu

The diagnostic interface is only useful when debugging your application. It is very resource-hungry
to use. Consequently, it must not be activated during the operation phases. The diagnostic interface
can be used to:
create a file which contains information about the communication requests. This file can be
used by the application “DumpLogger.exe”
create a file which contains information about the communication optimization. This file can
be used by the application “DumpLogger.exe”
watch more closely the events occurring on an item
display information on the server execution.

WHDDE SuiteLink Server for Logix5000 messaging 12 08/02/2008

Copyright © 2006 Woodhead Software & Electronics. All rights reserved.

 Description of General Commands

Icon Menu Description

Diagnostic - Generates the file “dumpDDE.xml” in the configuration
Communication Request directory, which can be processed by the application
“DumpLogger.exe”, containing information on the
communication requests
This button automatically starts the application
“DumpLogger.exe” and display of file “dumpDDE.xml”
Diagnostic – Generates the file “dumpTopic.xml” in the configuration
Communication directory, which can be processed by the application
optimization “DumpLogger.exe”, containing information on the
communication optimization
This button automatically starts the application
“DumpLogger.exe” and display of file “dumpTopic.xml”
Diagnostic - Items Spy Used to spy a list of items.

Diagnostic - Output View - Closes the message view.

None
Diagnostic - Output View - Displays a view in which all the messages are written one after
Single the other, regardless of their sources.

Diagnostic - Output View - Displays the message views sorted by type.

Multiple
Diagnostic - Run VisuCyc Starts the cyclic function view application VisuCyc.

? - About... Displays the software information.

WHDDE SuiteLink Server for Logix5000 messaging 13 08/02/2008

Copyright © 2006 Woodhead Software & Electronics. All rights reserved.

Communication requests

By pressing the following button: , the file “dumpDDE.xml” is generated in the current
configuration directory. The application “DumpLogger.exe” starts and immediately loads the above
file.

This view lists all items, managed by the WHDDE server.

Double click on one of the objects in the tree to display a box showing the list of the object's internal
parameters.

WHDDE SuiteLink Server for Logix5000 messaging 14 08/02/2008

Copyright © 2006 Woodhead Software & Electronics. All rights reserved.

Communication optimization
By pressing the following button: , the file “dumpTopic.xml” is generated in the current
configuration directory. The application “DumpLogger.exe” starts and immediately loads the above
file.

This window display is static and is built when you click on the display button.
The right-hand side of the view shows information about the object selected in the left-hand
window. This information is not documented but can be used by technical support.

WHDDE SuiteLink Server for Logix5000 messaging 15 08/02/2008

Copyright © 2006 Woodhead Software & Electronics. All rights reserved.

Item Watch View

Press the following button to obtain the item watch view:

This view is divided into three areas. At the top left there is a browser to consult the accessible
data. The area at the bottom left shows the list of items to be monitored, and the right-hand area
displays the event messages affecting the items in the list.

To Watch an Item
• Select the item to be monitored in the browser
• Click and drag from the browser to the list below
• if necessary, complete the syntax (press F2 to rename) and click on the check box to select
the item

• start watching by pressing the button:

You can now no longer modify the items in active watch. However, you can add items to the list or
modify those which are not active.

Stop watching with the button:

Notes:
• You can if you wish simply click and drag between the items in the connection view and
the list of items to be watched.
• The list of items to be watched can be saved and restored.

WHDDE SuiteLink Server for Logix5000 messaging 16 08/02/2008

Copyright © 2006 Woodhead Software & Electronics. All rights reserved.

 • The Logger Parameters command in the Diagnostic menu enables the user to save all
messages displayed in the view in a “Spylog” file located in the configuration directory.
Caution: these parameters are applied both to the “Spy.log” file and to the “DDE.log” file
that saves application messages.

Commands available

Icon Menu Description

Watch - Item List - New List Creates a new list of items to be watched. If a list exists
already and has not been saved, a message is displayed.
Watch - Item List - Open Opens a list previously saved on the disk. If a list exists
already and has not been saved, a message is displayed.
Watch - Item List - Save Saves the active list on the disk.

Watch - Find Finds a character string in the current window. The case is
unimportant.
Watch - Traces - Clear Deletes all messages in the message view.

Watch - Traces - Copy Copies the text selected in the message view to the
clipboard. It can therefore be easily pasted into any other
text file.
Watch - Start Starts the watch on all items selected in the list.

Watch - Stop Stops the watch on all items.

Watch - Item List - Add Adds the item selected in the tree to the list.

Watch - Item List - Delete Deletes the selected item from the list.

Watch - Item List - Check Selects the item(s) to be watched.

WHDDE SuiteLink Server for Logix5000 messaging 17 08/02/2008

Copyright © 2006 Woodhead Software & Electronics. All rights reserved.

Exporting item syntaxes
Item syntaxes can be exported to create a text file containing the syntaxes of the items that can be
accessed by the server. This feature is extremely useful to create the supervision application
without having to type the syntaxes completely.
To export the syntaxes, simply display the Spy window in the diagnostic environment.
Two export methods are available:
1. Partial export: Used to obtain the syntaxes recursively from the selected node (Menu Items
Spy - Export - Export Selected Branch)
2. Complete export: Used to obtain the syntaxes recursively from the tree root (Menu Items Spy -
Export - Export All)

WHDDE SuiteLink Server for Logix5000 messaging 18 08/02/2008

Copyright © 2006 Woodhead Software & Electronics. All rights reserved.

WHDDE SuiteLink Server for Logix5000 messaging 19 08/02/2008

Copyright © 2006 Woodhead Software & Electronics. All rights reserved.

Message View
This view displays information related to execution of the application. You can activate this view
with the following three buttons:

The first closes the message window.

The second displays the view, separating the messages into three tabs:
• Read tab: displays a message every time that the server is going to acquire data from the
emulator
• Write tab: displays a message every time that the server sends data to the emulator
• Error tab: displays a message whenever an error occurs (syntax error, bad value
conversion, etc.)
The third displays the view, putting all messages in the same window.

You can stop the message trace in the Windows by selecting the Diagnostic - Messages – Stop
command. Use the Restart command to resume the traces. These two commands act on all
message Windows at the same time. When stopping or resuming, a message is shown in each tab.
Caution: All messages between stopping and resuming are lost.

Use the Clear command to delete all messages in the visible tab. The messages of the other tabs
are not affected by this command.

Remark:
The Logger Parameters... command in the Diagnostic menu enables the user to save all
messages displayed in the view(s) in a “WHDDE.log” file located in the configuration directory.
Caution: these parameters are applied both to the “DDE.log” file and to the “Spy.log” file used to
save the item watch messages.

WHDDE SuiteLink Server for Logix5000 messaging 20 08/02/2008

Copyright © 2006 Woodhead Software & Electronics. All rights reserved.

WHDDE SuiteLink Server for Logix5000 messaging 21 08/02/2008

Copyright © 2006 Woodhead Software & Electronics. All rights reserved.