Sie sind auf Seite 1von 91

Wonderware

Enterprise
Integrator 2012
User’s Guide

March 2013
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 Invensys Systems, Inc. No
copyright or patent liability is assumed with respect to the use of the
information contained herein. Although every precaution has been
taken in the preparation of this documentation, the publisher and the
author assume no responsibility for errors or omissions. Neither is
any liability assumed for damages resulting from the use of the
information contained herein.
The information in this documentation is subject to change without
notice and does not represent a commitment on the part of Invensys
Systems, Inc. The software described in this documentation is
furnished under a license or nondisclosure agreement. This software
may be used or copied only in accordance with the terms of these
agreements.
© 2002-2013 by Invensys Systems, Inc. All rights reserved.
Invensys Systems, Inc.
26561 Rancho Parkway South
Lake Forest, CA 92630 U.S.A.
(949) 727-3200
http://www.wonderware.com
For comments or suggestions about the product documentation, send
an e-mail message to
ProductDocumentationComments@invensys.com.
All terms mentioned in this documentation that are known to be
trademarks or service marks have been appropriately capitalized.
Invensys Systems, Inc. cannot attest to the accuracy of this
information. Use of a term in this documentation should not be
regarded as affecting the validity of any trademark or service mark.
Alarm Logger, ActiveFactory, ArchestrA, Avantis, DBDump, DBLoad,
DT Analyst, Factelligence, FactoryFocus, FactoryOffice, FactorySuite,
FactorySuite A2, InBatch, InControl, IndustrialRAD, IndustrialSQL
Server, InTouch, MaintenanceSuite, MuniSuite, QI Analyst,
SCADAlarm, SCADASuite, SuiteLink, SuiteVoyager, WindowMaker,
WindowViewer, Wonderware, Wonderware Factelligence, and
Wonderware Logger are trademarks of Invensys plc, its subsidiaries
and affiliates. All other brands may be trademarks of their respective
owners.
3

Contents

Chapter 1: Introduction .............................................. 9

Chapter 2: Launching WEI Application .......................... 11


Connection ....................................................................................... 11

Chapter 3: Manage Security ....................................... 13


Overview.......................................................................................... 13
User Interface ................................................................................. 15
Manage Security Groups ...........................................................15
Security Group Details ..............................................................16
Security Privileges ....................................................................16
Operation......................................................................................... 17
Display Manage Security Groups .............................................17
Adding........................................................................................17
Deleting .....................................................................................17

Chapter 4: Manage Location Types .............................. 19


Overview.......................................................................................... 19
User Interface ................................................................................. 19
Security Privileges .......................................................................... 20
Operation......................................................................................... 20
Adding........................................................................................20
Deleting .....................................................................................21
Edit ............................................................................................21

Wonderware Enterprise Integrator User’s Guide


4  Contents

Chapter 5: Manage Location Group .............................. 23


Overview.......................................................................................... 23
User Interface ................................................................................. 23
Security Privileges .......................................................................... 24
Operation......................................................................................... 24
Display Manage Location Group...............................................24
Adding........................................................................................24
Deleting .....................................................................................25
Edit ............................................................................................25

Chapter 6: Manage Message Types .............................. 27


Overview.......................................................................................... 27
User Interface ................................................................................. 27
Security Privileges .......................................................................... 28
Operation......................................................................................... 28
Display Manage Message Types ...............................................28
Adding........................................................................................29
Deleting .....................................................................................30
Editing .......................................................................................31

Chapter 7: Manage Location Categories ........................ 33


Overview.......................................................................................... 33
User Interface ................................................................................. 33
Security Privileges .......................................................................... 34
Operation......................................................................................... 34
Display Manage Message Categories .......................................34
Adding........................................................................................34
Deleting .....................................................................................35
Editing .......................................................................................36

Wonderware Enterprise Integrator User’s Guide


Contents  5

Chapter 8: Manage Message Services........................... 37


Overview.......................................................................................... 37
User Interface ................................................................................. 37
Security Privileges .......................................................................... 38
Operation......................................................................................... 38
Creating or Deleting a Message Service ...................................38
Editing .......................................................................................38

Chapter 9: Manage Message Locations ......................... 41


Overview.......................................................................................... 41
User Interface ................................................................................. 41
Security Privileges .......................................................................... 42
Operation......................................................................................... 43
Manage Message Locations.......................................................43
Adding........................................................................................44
Deleting .....................................................................................48
Editing .......................................................................................49
Adding Transfer Destination Locations ....................................50
Editing Transfer Destination Locations ...................................52
Deleting Transfer Destination Locations .................................52

Chapter 10: Application Configuration ............................ 53


Overview.......................................................................................... 53
User Interface ................................................................................. 53
Configuration Items ........................................................................ 54
Security Privileges .......................................................................... 54
Operation......................................................................................... 54
Displaying Plant Configuration ................................................54
Modifying Plant Configuration .................................................54

Wonderware Enterprise Integrator User’s Guide


6  Contents

Chapter 11: Event Log................................................. 57


Overview.......................................................................................... 57
User Interface ................................................................................. 57
Security Privileges .......................................................................... 58
Operation......................................................................................... 58
Displaying Event Log ................................................................58
Displaying Event Log Details ...................................................59
Write WEI Events to System Management Console ................60

Chapter 12: Message Log ............................................. 61


Overview.......................................................................................... 61
User Interface ................................................................................. 63
Security Privileges .......................................................................... 63
Operation......................................................................................... 64
Displaying Message Log ............................................................64
Re-Process Messages .................................................................65
Archive Messages ......................................................................65
Displaying Message Details ......................................................66

Chapter 13: Message Display........................................ 67


Overview ....................................................................................67
User Interface ............................................................................67
Security Privileges ....................................................................68
Operation......................................................................................... 68
Archive a Message .....................................................................68
Re-process Messages (Re-sending error and paused messages)
.................................................................................................69
Re-process Message Transfer (Re-sending error and paused
messages Transfer) .................................................................69
Exporting a Message .................................................................70
Editing or Viewing the content of a message ...........................70
Message Display Links..............................................................71

Wonderware Enterprise Integrator User’s Guide


Contents  7

Chapter 14: Manage Messages...................................... 73


Overview.......................................................................................... 73
User Interface ................................................................................. 74
Security Privileges .......................................................................... 75
Operation......................................................................................... 75
Display Message Summary by Category Listing ......................75
Change Status ...........................................................................75
Sending WEI Messages to Destination .....................................76

Chapter 15: Plug-In Development ................................. 77


Overview.......................................................................................... 77
Interfaces ......................................................................................... 78
IMessageSendReceive ...............................................................78
Definition .............................................................................78
Implementation ...................................................................78
Common use ........................................................................78
IMessagePreSend ......................................................................79
Definition .............................................................................79
Implementation ...................................................................79
Common use ........................................................................79
IMessageTransform...................................................................79
Definition .............................................................................79
Implementation ...................................................................79
Common use ........................................................................79
IMessageAbortTransfer.............................................................80
Definition .............................................................................80
Implementation ...................................................................80
Common use ........................................................................80
IMessageProcessor ....................................................................80
Definition .............................................................................80
Implementation ...................................................................80
Common use ........................................................................80

Wonderware Enterprise Integrator User’s Guide


8  Contents

Chapter 16: WEI Web Services ..................................... 81


Overview.......................................................................................... 81
User Interface ................................................................................. 81
Operation......................................................................................... 83
Invoke AddMessage Method Using Web Page .........................83
Invoke AddMessage Method From Software ............................85

Index ...................................................... 89

Wonderware Enterprise Integrator User’s Guide


9

Chapter 1

Introduction

The Wonderware Enterprise Integrator (WEI) application is a


scalable, configurable product that provides a loosely coupled linkage
between the manufacturing system and business systems such as
ERP, PLM, SCM, or LIMS. WEI facilitates the exchange of
information between disparate systems and software via messages
which are buffered and tracked to provide a seamless and reliable
interface. This interface is comprised of adapters which provide any
endpoint specific transformations, database processing, and internal
processing causing secondary message generation.
The WEI User’s Guide describes the WEI user interface for defining
message groups, types, categories source and destination locations,
and the transfer requirements which enable the transport of
messages from the source location to the specified destination
location. It also describes how to attach custom plug-ins to message
locations or to transfer requirements between message locations. The
plug-in provides extended message processing functionality to a WEI
adapter.
Finally, the WEI User’s Guide describes the application program
interface (API) needed to implement a custom WEI Plug-in.

Wonderware Enterprise Integrator User’s Guide


11

Chapter 2

Launching WEI Application

Connection
By default, WEI will be installed with its configuration and
management website on the server computer. The website may be
accessed from any computer with an IE6 or greater browser and an
authorized connection to the server. The URL is
http://<computer>/WEI/default.aspx where <computer> represents
the network name of the server computer. When using the web
browser on the actual server computer, the URL is
http://localhost/WEI/default.aspx.
Upon connecting to the WEI website, the WEI - Overview screen is
displayed (Figure 1).

Figure 1

Wonderware Enterprise Integrator User’s Guide


12  Launching WEI Application

From this screen users can navigate to all others using the menus at
the top (Figure 2). Returning to the WEI – Overview screen is
accomplished by clicking on the Wonderware icon in the upper left
corner of each page.

Figure 2

Wonderware Enterprise Integrator User’s Guide


13

Chapter 3

Manage Security

Overview
The WEI website uses windows authentication to allow access to the
system. “Security Groups” can be created, to which Windows (Active
Directory) Users and/or Groups can be associated, as well as specific
application privileges. This section describes the setup and
configuration of these “Security Groups.”
By default, when WEI is first installed the following Security Groups
are defined.

Role Description
WEI_View Users that can view all screens
WEI_Admin Users in this group will be able to perform all
possible actions (all Privileges) in the WEI
website

Wonderware Enterprise Integrator User’s Guide


14  Manage Security

The WEI system has the following Privileges that can be assigned to
“Security Groups”. These Privileges allow for different access within
the WEI system.

Privilege Name Description


PortalBase_View Ability to view screens

PortalBase_Security_Config Ability to create, modify, and


manage security groups and
users
PortalBase_AppSettings_Config Ability to create, and modify
plant configuration settings
WEI_MessageService_Config Ability to create, and modify
Message Services
WEI_Message_Send Ability to Send Paused
messages to external systems
WEI_Message_Modify Ability to archive, modify and
re-process messages
WEI_Location_Modify Ability to create, modify, and
disable Message locations
WEI_Location_ChangeStatus Ability to turn locations ON and
OFF
WEI_General_Config Ability to add or modify
Location Groups(Systems),
Message Types, and Message
Categories

Note: Each screen in this User’s Guide will specify what Privileges are
needed in order to perform an action.

Wonderware Enterprise Integrator User’s Guide


User Interface  15

User Interface

Manage Security Groups


 The Manage Security Groups screen (Figure 3) allows
administrators to create and manage “Security Groups”. This
screen is accessed through the “Configuration/ Manage Security
Groups” menu.

Figure 3

Wonderware Enterprise Integrator User’s Guide


16  Manage Security

Security Group Details


The Security Group Details screen (Figure 4) allows administrators to
save changes to a given Security Group.

Figure 4

Security Privileges
The table below shows the list of Privileges required for the actions
available in the “Security Group” screens.

Action Privileges
Create New PortalBase_Security_Config

Add PortalBase_Security_Config

Delete PortalBase_Security_Config

View PortalBase_View , PortalBase_Security_Config

Wonderware Enterprise Integrator User’s Guide


Operation  17

Operation

Display Manage Security Groups


The “Manage Security Groups” allows the user to filter or search for a
particular Security Group.

To Display the Location Groups


1. Click the Configuration tab -> Manage Security Groups.
2. Enter the Group Id or part of the Group Id you are searching for
in the “Group” textbox.
3. Press Refresh.

Adding
The ‘Manage Security Groups’ screen allows user to assign security to
Windows Users or Groups, which determine who can access the WEI
application.
The WEI application uses windows authentication. Thus all users
who require access to the application must be defined in the windows
active directory.

To add a Windows account (or group) to the WEI application


1. Log on to the application with a user that has Administrative
access.
2. Click the Configuration tab -> Manage Security Groups.
3. Click the “Create New” Button (A new screen called “Security
Group Details” is displayed).
4. Enter in Security Group Id and then press “Save.”
5. Press “Add” to add New Members.
6. Press “Add” to add New Privileges for the security Group.

Deleting
A user can delete the whole security group Id or delete individual
Members and Privileges from a security Group.

To remove a given security group Id


1. Log on to the application with a user that has Administrative
access.
2. Go to Configuration -> Manage Security Group.
3. Click the Group ID link, beside the Group ID you would like delete
(A new screen called “Security Group Details is displayed).

Wonderware Enterprise Integrator User’s Guide


18  Manage Security

4. Press the Delete button (in the security Group ID box).


5. Click the OK button when prompted with the Confirmation
Message.

To remove a given user or group from a given security


group
1. Log on to the application with a user that has Administrative
access.
2. Go to Configuration -> Manage Security Group.
3. Click the Group ID link; beside the Group ID where the user or
group is located (A new screen called “Security Group Details is
displayed).
4. Press the Delete button beside the member or group you would
like to delete.
5. Click the OK button when prompted with the Confirmation
Message.

To remove a given Privilege from a given security group


1. Log on to the application with a user that has Administrative
access.
2. Go to Configuration -> Manage Security Group.
3. Click the Group ID link, beside the Group ID where you would like
to delete privileges from (A new screen called “Security Group
Details is displayed).
4. Press the Delete button beside Privileges you would like to
remove.
5. Click the OK button when prompted with the Confirmation
Message.

Wonderware Enterprise Integrator User’s Guide


19

Chapter 4

Manage Location Types

Overview
The “Manage Location Types” screen displays all the Location Types
that the WEI system handles and provides details about the Send-
Receive Class that will be used. The user can create any number of
Location Types but must provide the Send-Receive Class that will be
used to process the message that is associated with a particular
Location.

User Interface
Figure 5 shows a sample of the Manage Location Types Screen. This
screen is accessed through the “Configuration / MessagingConfiguration
/ Manage Location Types” menu.

Figure 5

Wonderware Enterprise Integrator User’s Guide


20  Manage Location Types

Security Privileges
The table below shows the list of Privileges required for the actions
available in this screen.

Actions Privileges
Add WEI_General_Config

Edit WEI_General_Config

Delete WEI_General_Config

Update WEI_General_Config

Refresh PortalBase_View

Operation

Adding
The “Manage Location Types” screen allows user to create custom
location Types.

To add a Location Type


1. Click the Configuration tab -> Messaging Configuration -> Manage
Location Types.
2. Enter the Location Type ID, Description and the Send-Receive Class
(see table below).
3. Click Add.
The table below defines fields in more detail.

Item Description
Location Type Id A unique Id used as an Identifier

Description Description of the Location type you are


creating
Send-Receive Class This is a custom Plug in that must implement
WEI interfaces. See Section “Plug-in
Development” of this document for more details

Wonderware Enterprise Integrator User’s Guide


Operation  21

Deleting
The “Manage Location Types” screen allows users to delete Location
Types.

To delete a Location Type


1. Click the Configuration tab -> Messaging Configuration -> Manage
Location Types.
2. Press the Edit link beside the Location Type. When the sub menu
appears, click the Delete link to remove the location type.
3. Click the OK button when prompted with the Confirmation
Message.

Edit
The “Manage Location Types” screen allows user to edit Location
Types. Users are able to edit the Description and the Send-Receive
Class of a Location Type.

To edit a Location Type


1. Click the Configuration tab -> Messaging Configuration -> Manage
Location Types.
2. Press the Edit link beside the Location Type, you would like to
edit.
3. Make changes to the Location Type’s Description or Send-Receive
Class.
4. Press the Update link to complete your changes.

Wonderware Enterprise Integrator User’s Guide


23

Chapter 5

Manage Location Group

Overview
The “Manage Location Group” screen displays all the Location Groups
that the WEI system handles. Location Groups are used by the user to
associate message Locations with each other. The user can create any
number of Location Groups.

User Interface
Figure 6 shows a sample of the Manage Message Location Group screen.
This screen is accessed through the “Configuration /
MessagingConfiguration / Manage Location Groups” menu.

Figure 6

Wonderware Enterprise Integrator User’s Guide


24  Manage Location Group

Security Privileges
The table below shows the list of Privileges required for the actions
available in this screen.

Actions Privileges
Add WEI_General_Config

Edit WEI_General_Config

Delete WEI_General_Config

Update WEI_General_Config

Refresh PortalBase_View

Operation

Display Manage Location Group


Displaying “Location Groups” allows the user to associate message
Locations with each other.

To Display the Location Groups


1. Click the Configuration tab -> Messaging Configuration -> Manage
Location Groups.
2. Enter the description or part of the description you are searching
for in the “Description” textbox.
3. Press Refresh.

Adding
The “Manage Location Group” screen allows user to create custom
location Groups.

To create a Location Group


1. Click the Configuration tab -> Messaging Configuration -> Manage
Location Groups.
2. Enter the Group ID and Description in the ADD section of the
screen.
3. Click Add.

Wonderware Enterprise Integrator User’s Guide


Operation  25

The table below defines the fields in more detail.

Item Description
Group Id A unique Id used as a Identifier

Description Description of the Location Group you are


creating

Deleting
The “Manage Location Groups” screen allows user to delete custom
location Groups.

To delete a Location Group


1. Click the Configuration tab -> Messaging Configuration -> Manage
Location Groups.
2. Press the Edit link beside the Location Group. When the sub menu
appears, click the Delete link to remove the location group.
3. Click the OK button when prompted with the Confirmation
Message.

Edit
The “Manage Location Groups” screen allows user to edit custom
location Groups. User can only edit the Description of a particular
group.

To edit a Location Group


1. Click the Configuration tab -> Messaging Configuration -> Manage
Location Groups.
2. Press the Edit link beside the Location Group, you would like to
edit.
3. Make changes to the Location Group’s Description.
4. Press the Update link to complete your changes.

Wonderware Enterprise Integrator User’s Guide


27

Chapter 6

Manage Message Types

Overview
The “Manage Message Types” screen displays all the Message Types
that the WEI system handles. It will display the details and the
Summary Expression of each message. The “Summary Expression”
associate with each message is used to extract information from
within the file.

User Interface
Figure 7 shows a sample of the Manage Message Types screen. This
screen is accessed through the “Configuration / MessagingConfiguration
/ Manage Message Types” menu.

Figure 7

Wonderware Enterprise Integrator User’s Guide


28  Manage Message Types

Security Privileges
The table below shows the list of Privileges required for the actions
available in this screen.

Actions Privileges
Create New WEI_General_Config

Edit WEI_General_Config

Delete WEI_General_Config

Save WEI_General_Config

Refresh PortalBase_View

Operation

Display Manage Message Types


Displaying “Manage Message Types” allows the user to filter Message
Types based on Message Type ID and Data Type.

To display Message Types


1. Click the Configuration tab -> Messaging Configuration -> Manage
Message Types.
2. Select one or more fields in the Search Criteria panel as described
in the table below to limit the Message Types displayed.
3. Press Refresh.
The list of Message Types displayed on the “Manage Message Types”
screen can be limited based on matching selections in the following
fields:

Item Description
Message Type ID Only include Message Types with an ID
matching any part of the entry given in this
field.
Data Type Limits Results based on pre defined data types
(XML,FLAT)

Wonderware Enterprise Integrator User’s Guide


Operation  29

Adding
The “Manage Message Types” screen allows user to add Message Types.
A new screen called “Message Type Details” is displayed where user
can enter in the new data.

To create a Message Type


1. Click the Configuration tab -> Messaging Configuration -> Manage
Message Types.
2. Press the Create New (A new screen called “Message Type Details”
is displayed).
3. Enter Message Type Id, Description, Data Type and Summary
Expression information.
4. Press the Save button.
5. Click the OK button when prompted with the Confirmation
Message.
The table below defines the fields in more detail.

Item Description
Message Type Id A unique Id used as a Identifier

Description Description of the “Message Type” you are


creating
Data Type Message file format can be XML, or FLAT

Summary Expression Is used to extract important data from a


Message.
If “Data Type” is an “XML” an XLT expression
is entered here.
If “Data Type” is “Flat” a simple text file
format is entered.

Wonderware Enterprise Integrator User’s Guide


30  Manage Message Types

Figure 8 shows a sample of the Message Type Details screen.

Figure 8

Deleting
The “Manage Message Types” screen allows user to delete existing
Message Types.

To delete a Message Type


1. Click the Configuration tab -> Messaging Configuration -> Manage
Message Types.
2. Press the Message Type ID link you would like to delete (A new
screen called “Message Type Details is displayed).
3. Press the Delete button.
4. Click the OK button when prompted with the Confirmation
Message.

Wonderware Enterprise Integrator User’s Guide


Operation  31

Editing
The “Manage Message Types” screen allows user to edit existing
Message Types.

To Edit a Message Type


1. Click the Configuration tab -> Messaging Configuration -> Manage
Message Types.
2. Press the Message Type ID link you would like to edit (A new
screen called “Message Type Details is displayed).
3. Update the Description, DataType, and the Summary Expression
fields as required.
4. Press the Save button.
5. Click the OK button when prompted with the Confirmation
Message.

Wonderware Enterprise Integrator User’s Guide


33

Chapter 7

Manage Location Categories

Overview
The “Manage Location Categories” screen displays all the Categories
the WEI system handles. It will display the details and the Summary
of each Category. Each category created here will be displayed on the
“Manager Messages” Screen.

User Interface
Figure 9 shows a sample of the Manage Location Categories screen.
This screen is accessed through the “Configuration/
MessagingConfiguration / Manage Location Categories” menu.

Figure 9

Wonderware Enterprise Integrator User’s Guide


34  Manage Location Categories

Security Privileges
The table below shows the list of Privileges required for the actions
available in this screen.

Action Privileges
Add WEI_General_Config

Edit WEI_General_Config

Delete WEI_General_Config

Update WEI_General_Config

Refresh PortalBase_View

Operation

Display Manage Message Categories


“Manage Message Categories” allows the user to filter or search for a
particular Message Category.

To display the Message Categories


1. Click the Configuration tab -> Messaging Configuration -> Manage
Message Categories.
2. Enter the description or part of the description you are searching
for in the “Description” textbox.
3. Press Refresh.

Adding
The “Manage Message Categories” screen allows user to add Message
Categories.

To create a new Message Category


1. Click the Configuration tab -> Messaging Configuration -> Manage
Message Categories.
2. Enter Category Id, Description, and Position information, in the
“Add” section of the Screen.
3. Press Add.

Wonderware Enterprise Integrator User’s Guide


Operation  35

The table below defines the fields in more detail.

Item Description
Category Id A unique Id used as a Identifier

Description Description of the “Message Category” you


are creating
Display Position The position the category should be
displayed in on the Message Summary
screen. Also defines the order in which
messages are received and sent from and
to locations.
AllowUserToggle The “Allow User Toggle” option if ‘On’ will
allow users to turn locations in this
Category on or off from the Message
Summary screen.

Deleting
The “Manage Message Categories” screen allows user to delete Message
Categories.

To delete a Message Category


1. Click the Configuration tab -> Messaging Configuration -> Manage
Location Categories.
2. Press the Edit link beside the Message Location Category. When the
sub menu appears, click the Delete link to remove the category.
3. Click the OK button when prompted with the Confirmation
Message.

Wonderware Enterprise Integrator User’s Guide


36  Manage Location Categories

Editing
The “Manage Message Categories” screen allows user to Edit Message
Categories.

To Edit a Message Category


1. Click the Configuration tab -> Messaging Configuration -> Manage
Location Categories.
2. Press the Edit link beside the Message Location Category you would
like to edit.
3. Update the Description and/or the Position fields as required.
(See Note)
4. Press the Update link.
5. Click the OK button when prompted with the Confirmation
Message.
Note: There is check box called “Allow User Toggle” when editing a
location category that will give the user the ability to turn “OFF” or
“ON” a message category on the message Summary Screen.

Wonderware Enterprise Integrator User’s Guide


37

Chapter 8

Manage Message Services

Overview
The “Manage Message Services” screen displays all the Message
Services that the WEI system handles. It will display the details and
the Summary for each service and allow the ability to Control the
status of each service.

User Interface
Figure 10 shows a sample of the Manage Message Services screen. This
screen is accessed through the “Configuration / MessagingConfiguration
/ Manage Services” menu.

Figure 10

Wonderware Enterprise Integrator User’s Guide


38  Manage Message Services

Security Privileges
The table below shows the list of Privileges required for the actions
available in the Message Service screens.

Action Privileges
Edit WEI_Processor_Config

Save WEI_Processor_Config

Refresh WEI_Processor_Config, PortalBase_View

Operation

Creating or Deleting a Message Service


Message services may be created or deleted by using the WEI
Configurator utility. Please refer to the WEI Installation Guide for a
description of this process.

Editing
The “Manage Message Services” screen allows user to edit existing
Message Services.

To edit a Message Service


1. Click the Configuration tab -> Messaging Configuration -> Manage
Services.
2. Press the button labeled with the Service Id that is to be edited (A
new screen called “Message Service Details” is displayed).
3. Update the Description, Status, Sleep Time and Batch Size fields
as required.
4. Press the Save button.
5. Click the OK button when prompted with the Confirmation
Message.

Wonderware Enterprise Integrator User’s Guide


Operation  39

The table below defines the fields in more detail.

Item Description
Service Id A unique Id used as an identifier

Description Description of the Message Processor you are


creating
Status Used to Disable Or enable a Processor

Sleep Time The amount of time (in Milliseconds) between each


execution of the processor
Batch Size The number of messages to be processed at a time
as the processor is transferring messages from one
location to another or Outbound from the WEI
system to a given location.

Figure 11 shows a sample of the Message Processor Details screen.

Figure 11

Wonderware Enterprise Integrator User’s Guide


41

Chapter 9

Manage Message Locations

Overview
The “Manage Message Locations” screen displays all the Message
Locations that the WEI system handles. It will display the details and
the Summary of each message Locations and allow the ability to edit
the Location properties.

User Interface
Figure 12 shows a sample of the Manage Message Locations screen.
This screen is accessed through the “Configuration/
MessagingConfiguration / Manage Message Locations” menu.

Figure 12

Wonderware Enterprise Integrator User’s Guide


42  Manage Message Locations

Security Privileges
The table below shows the list of Privileges required for the actions
available in the Message Location screens. Items marked with an
asterisk (*) can only be done through the WEI Configurator
application and not through the web interface.

Action Privileges
Create New * WEI_Location_Modify

Edit WEI_Location_Modify

Delete * WEI_Location_Modify

Save WEI_Location_Modify

Change Location Status WEI_Location_ChangeStatus

Refresh WEI_Location_Modify, PortalBase_View

Wonderware Enterprise Integrator User’s Guide


Operation  43

Operation

Manage Message Locations


Displaying Message Locations allows the user to view Message
Location they have created. The list of Locations displayed can be
limited based on matching selections in the following fields.

Item Description
Direction Only include Message Locations with
“Direction” matching this field or select
“<All>” to skip this filter field.
Location Type Only include Message Locations with
“Location Type” matching this field or select
“<All>” to skip this filter field.
Group Only include Message Locations with “Group”
matching this field or select “<All>” to skip
this filter field.
Location ID Only include Message Locations with
“Location Id” matching any part of the entry
given in this field. Leave blank to not filter
by Location Id.

To display Message Locations


1. Click the Configuration tab -> Messaging Configuration -> Manage
Locations.
2. Click the Show Search Criteria button.
3. Select one or more fields in the Search Criteria panel as described
in the table above to limit the Message Locations displayed.
4. Press Refresh.

Wonderware Enterprise Integrator User’s Guide


44  Manage Message Locations

Adding
The “Manage Message Locations” screen allows user to add Message
Locations. A new screen called “Location Details” is displayed where
user can enter in the new data. Note that several of the required
fields must be defined prior to adding a new location. The list of
required fields below should be created in the order listed.
 Message Service (refer to the WEI Installation Guide)
 Location Type (refer to Manage Location Types)
 Group (refer to Manage Location Group)
 Message Type (refer to Manage Message Types)
 Category (refer to Manage Location Categories)

To create a Message Location


1. Click the Configuration tab -> Messaging Configuration -> Manage
Locations.
2. Press the Create New. (A new screen called “Location Details” is
displayed).
3. Enter Location Type, Group, Message Service, Message Type, and
Category in sequential order. Also, fill in the Batch Size, URI,
Label Format, Retry Limit, Retry Delay, and the Purge After
fields. Refer to the section titled “Adding Transfer Destination
Locations” for instructions about adding a transfer destination
location.
4. Press the Save button.
5. Click the OK button when prompted with the Confirmation
Message.
The table below defines the fields in more detail (* denotes required
field).

Item Description
*Location Id A unique Id used as an Identifier

*Group Is used to group Message Locations. (E.g. SAP)


Populated by the Location Groups defined on the “Manage Message
Location Group” screen

Direction Used to define if a “Message Location” is an incoming (IN) or outgoing


(Out) location. An IN location is one where messages are received
and entered into the WEI system. An OUT location is one from
which messages already in the WEI system, are sent to their final
destination (folder on disk, etc.) by the message service.

Wonderware Enterprise Integrator User’s Guide


Operation  45

Item Description
*Message Service Defines which message service will run the Message Location.
Populated by the Message Services defined on the “Manage Message
Services” screen. WEI_DEFAULT is the default service created
during the installation configuration.
*Message Type Defines which Message Type is at the current Message Location.
Populated by the Message Type defined on the “Manage Message
Type” screen.

*Category Defines which Category the Message Location is associated with.


Populated by the Message Categories defined on the “Manage
Message Categories” screen.

Label Format The file extension which will be processed at this Message Location
(E.g. *.xml, *.txt, *.*, etc…). If the Location Type chosen for this
Message Location is FOLDER, then the Label Format specifies
which files will be processed and all others will be ignored. A format
of “*.xml” means that only files with the “.xml” extension will be
processed.
*Batch Size The number of files to be processed at one time from this location.
(Note: this is really only applicable for Inbound locations)
Processing Priority This integer value specifies the priority (0 = highest) for this
location. The WEI Message Service will process locations with
higher priorities first. Locations with the same priorities will be
processed in a round robin fashion.
*Location Type Defines which Location Type the Message Location is associated
with.
Populated by the Location Types defined on the “Manage Location
Types” screen.

PreSend Class This field is only available when the direction of the Message
location is “Out” and is used to specify the PreSend plug-in
information in the format “Assembly Name, Class Name” (i.e.,
WW.Messaging, WW.Messaging.PreSend for a plug-in module
WW.Messaging.dll and a class named PreSend).
Used to Run Pre condition or manipulate data before a message is
sent to an external system.
If no plug-in is to be configured, then the field may be left blank.
Refer to Section 15.2.2 for more details.

Wonderware Enterprise Integrator User’s Guide


46  Manage Message Locations

Item Description
URI This Uniform Resource Identifier (URI) is used to define the final
destination of a message Location if the location type is FOLDER or
MSMQ. The format of the URI for these location types is below.
MSMQ: “DIRECT=OS:.\PRIVATE$\MyQueue”
FOLDER: “DRIVE:\folder1\folder2\etc” or
“\\nodename\DRIVE\folder1\folder2\etc”
If the location is not FOLDER or MSMQ and a Message Processor
plug-in is to be attached to the location, then this field will contain
the plug-in information: Assembly Name, Class Name. Refer to
Section 15.2.5 for more information on Message Processor plug-ins.
This field may be left blank if the location type is DIRECT OR
CODE.
Status When the direction is “IN” the statuses mean the following:
On – Location is ON and the associated WEI processor will attempt
to get messages from it.
OFF, Disable – Location is off. The associate WEI processor will not
attempt to get messages from it.
Retry – Location is retrying to get messages after a failure (E.g.
folder location doesn’t exist or is otherwise inaccessible)
When the direction is “OUT” the statuses mean the following:
On – Location is ON and messages will be sent to it normally.
OFF – messages to sent to this location will be marked as “paused”
Disable – messages will not be sent to this location even if a transfer
requirement is defined.
Retry – Not applicable.
Status Message If an error has occurred at this location a message will be displayed
here.
*Retry Limit The number of retries allowed before an error is logged

*Retry Delay The Time between each retry after a failure to receive a message
from this location or to send a message to this location.
*Purge After The number of days which must pass before a message is purged by
the Purge Job in the database.
Is Scheduled? When this checkbox is checked, a Next Run Date may be entered
to specify when the location starts processing messages. A Repeat
Every interval may be set to specify how often messages will be
processed.
Next Run Date The date and time entered in this field specifies when the location
will begin processing messages.

Wonderware Enterprise Integrator User’s Guide


Operation  47

Item Description
Repeat Every This integer value specifies the number of seconds of idle time when
no messages are processed by this location.
# of Failures The number of failures – only applicable for Inbound locations.

Figure 13 shows a sample of the Locations Detail screen for an IN


location. The fields in the Add Transfer Requirement (Destination)
section are discussed in the “Adding Transfer Destination Locations”
section later in this document.

Figure 13

Wonderware Enterprise Integrator User’s Guide


48  Manage Message Locations

Figure 14 shows a sample of the Locations Detail screen for an OUT


location.

Figure 14

Deleting
The “Manage Message Locations” screen allows user to Delete Message
Locations. A new screen called “Location Details is displayed where
users can delete records.

To delete a Message Locations


1. Click the Configuration tab -> Messaging Configuration -> Manage
Locations.
2. Press the Location ID you would like to delete. (A new screen called
“Location Details” is displayed).
3. Press the Delete button.
4. Click the OK button when prompted with the Confirmation
Message.

Wonderware Enterprise Integrator User’s Guide


Operation  49

Editing
The “Manage Message Locations” screen allows user to edit existing
Message Locations.

To edit a Message Locations


1. Click the Configuration tab -> Messaging Configuration -> Manage
Locations.
2. Press the Location ID you would like to edit. A new screen called
“Location Details” is displayed.
3. Modify Location Type, Group, Message Service, Message Type,
and Category in sequential order. The Batch Size, URI, Label
Format, Retry Limit, Retry Delay, and the Purge After fields may
be modified if desired. Refer to the section titled “Editing
Transfer Destination Locations” for instructions about editing a
transfer destination location.
4. Press the Save button.
5. Click the OK button when prompted with the Confirmation
Message.

Wonderware Enterprise Integrator User’s Guide


50  Manage Message Locations

Adding Transfer Destination Locations


After an IN message location has been created, the “Manage Message
Locations” screen allows user to add an existing OUT Message
Location as a Transfer Destination Location. The table on the next
page shows the fields used to add a Transfer Destination Location.

Figure 15

To add a Transfer Destination Locations


1. Click the Configuration tab -> Messaging Configuration -> Manage
Locations.
2. In the Add Transfer Requirement (Destination) section, select the
Location ID in the Location Id drop down list that is to be
configured as a transfer location.
3. If there is a Transform Class and/or an Abort class which will be
associated with this transfer requirement, then enter the
appropriate information for those plug-ins in the Transform Class
and the Abort Transfer Class fields respectively. The plug-in
information should be in the following format:
<AssemblyName>,<ClassName>
(e.g., for a plug-in like WW.Messaging.dll the field content would
be – WW.Messaging, WW.Messaging.ClassName)
4. Press the Add button.
5. Click the OK button when prompted with the Confirmation
Message.

Wonderware Enterprise Integrator User’s Guide


Operation  51

The table below defines the fields in more detail (* denotes required
field).

Item Description
*Location Id The Id of the OUT Message Location to
receive the message.
Transform Class This field specifies a plug-in which performs
transformation processing of the received
message before it is transferred. Refer to
Section 15.2.3 for information about this
type of plug-in class. This field may be left
blank if there is no plug-in configured.
Format: Assembly Name, Class Name
(i.e., WW.Messaging,
WW.Messaging.TransformClassName)
Abort Transfer Class This field is used to specify a plug-in which
will perform abort processing of the received
message before it can be transferred to the
specified OUT location. Refer to Section
15.2.4 for more information about this type
of plug-in class. This field may be left blank
if there is no plug-in configured.
Format: Assembly Name, Class Name
(i.e., WW.Messaging,
WW.Messaging.AbortClassName)
Parameters Enter additional parameter value(s) in this
field. The contents of this field are passed to
the plug-in as a string value. The plug-in is
responsible for parsing out individual
values.

Wonderware Enterprise Integrator User’s Guide


52  Manage Message Locations

Editing Transfer Destination Locations


After a Transfer Destination location has been created, the “Manage
Message Locations” screen shows the new item in the Transfer
Destination Location grid (Figure 16). Each transfer entry may be
edited following the steps below.

Figure 16

To edit a Transfer Destination Locations


1. Click the Edit link in the left column of the transfer location to be
edited.
2. Modify the Transform Class, Abort Transfer Class and/or Parameters
fields as desired. Entering values for these fields is optional.
3. Click the Update link in the left column.
4. Click the OK button when prompted with the Confirmation
Message.

Deleting Transfer Destination Locations


A Transfer Destination location may be deleted following the steps
below.

To delete a Transfer Destination Locations


1. Click the Edit link in the left column of the transfer location to be
edited.
2. Click the Delete link in the left column (see previous screen shot).
3. Click the OK button when prompted with the Confirmation
Message.

Wonderware Enterprise Integrator User’s Guide


53

Chapter 10

Application Configuration

Overview
The “Plant Configuration” screen allows the user to manage
configuration data for a specific plant and set their default values.
The configuration data consists of the Event Log items only at this
time. These items are shown in the figure below.

User Interface
Figure 17 shows a sample of the Plant Configuration screen. This
screen is accessed through the “Configuration / Application
Configuration” menu.

Figure 17

Wonderware Enterprise Integrator User’s Guide


54  Application Configuration

Configuration Items
The table below shows the list of pre-defined configurable items.

Item Description
EventLog_DaysToKeep Retention period for event log messages.

MessageHub_PurgeErrors If set to ‘1’, then errors are purged based


upon the associated location’s ‘days to keep’
value.

Security Privileges
The table below shows the list of Privileges required for the actions
available in this screen.

Action Privileges
Edit PortalBase_AppSettings_Config

Update PortalBase_AppSettings_Config

Refresh PortalBase_View

Operation

Displaying Plant Configuration


Displaying “Plant Configuration” allows the user to view configuration
data defined for the Plant.

To display plant configuration


1. Click the Configuration tab -> Application Configuration.
2. Select fields or <ALL> in the Configuration Group Dropdown panel.
3. Click the “Refresh.”

Modifying Plant Configuration


Modifying “Plant Configuration” allows the user to change the value of
a configuration data item.

To modify a configuration data item


1. Click the Configuration tab -> Application Configuration.

Wonderware Enterprise Integrator User’s Guide


Operation  55

2. Click the “Edit” link besides a configuration data item from the
‘Plant Configuration” grid.
3. Enter a new value for the configuration item and click the Update.

Wonderware Enterprise Integrator User’s Guide


57

Chapter 11

Event Log

Overview
The “Event Log Listing” screen allows the user to view WEI sub-
systems errors or warnings that may have occurred and recorded in
the system event log. In addition, errors and warnings may also be
sent to the Archestra System Management Console.

User Interface
Figure 18 shows a sample of the Event Log Listing screen. This screen
is accessed through the “Event Log Listing” menu item.

Figure 18

Wonderware Enterprise Integrator User’s Guide


58  Event Log

Security Privileges
The table below shows the list of Privileges required for the actions
available in this screen.

Action Privileges
View PortalBase_View

Refresh PortalBase_View

Operation

Displaying Event Log


Displaying “Event Log” Listing allows the user to view WEI warnings
or errors that may have occurred and were recorded in the system
event log. The list of “Event Logs” displayed can be limited based on
matching selections in the following fields:

Item Description
Message Text Only include Event Logs with “Message”
matching any part of the entry given in this
field. Leave blank to not filter by Message.
Start Date Only include Event Logs with ‘Start Date’ greater
or equal to the entry given in this field category.

Source Only include Event Logs with “Source” matching


this field or select “<All>” to skip this filter field.

To display Event Logs Listing


1. Click the “Event Log Listing” tab.
2. Select one or more fields in the Search Criteria panel as described
in the table above to limit the transfer orders displayed.
3. Press Refresh.

Wonderware Enterprise Integrator User’s Guide


Operation  59

Displaying Event Log Details


Display “Event Log Details” allows user to view the details of the event
log message found on the “Event Log Listing” page.

To display the Event Log Details,


1. Click The “Event Log Listing” tab.
2. Click the “View” link besides each event to display the event detail
(A new screen called “Event Log Detail” is displayed).
Figure 19 shows a sample of the Event Log Listing screen.

Figure 19

Wonderware Enterprise Integrator User’s Guide


60  Event Log

Write WEI Events to System Management


Console
WEI may be configured using the following procedure to send all WEI
events to the System Management Console in addition to recording
them in the WEI Event log.

To display the WEI events in the System Management


Console,
1. Open the WW.MessagingService.exe.config file located in the WEI
instance folder. The default folder location for this file is
C:\Program Files (x86)\Wonderware\WEI40\Instances\WEI.
2. Change the value of the LogErrorToSMC key from False to True as
shown in Figure 20.

Figure 20

Wonderware Enterprise Integrator User’s Guide


61

Chapter 12

Message Log

Overview
The “Message Log” screen displays all the Messages that the WEI
system has handled and provides details of these messages.

Wonderware Enterprise Integrator User’s Guide


62  Message Log

The “Message Log” grid displays message details. Depending on the


message type, some of the contextual information described in the
table below may not be available.

Item Table Heading


# The unique message ID created by the system

Creation Date Time The date time that the message entered/exited the
system
DIR.  OUT – Message goes from WEI to another
system
 IN – Message entering WEI from another
system

Group The message Group.

Message Type The message type of a given message category.

Summary Will display important information from the


message. It differs based on the message type
Src # The unique Source message ID created by the
system
Status The message status indicator
 Processing – a message that is currently being
processed
 Processed – A message that has successfully
entered/exited the system.
 Error – There was an Error processing the
message
 Paused – Message that is held back from
leaving the WEI system (because its target
location is ‘Off’)
 Archived – A message that has been archived
for some reason.
 Un-Paused - A message that was paused and
has been manually selected for re processing –
this state will only exist temporarily between
the user marking it for reprocessing and the
message processor actually doing so.
 Retrying – A message that had caused an
error, but the WEI system is attempting to
process it again.

Wonderware Enterprise Integrator User’s Guide


User Interface  63

User Interface
Figure 21 shows a sample of the Message Log screen. This screen is
accessed through the “Message Log” menu.

Figure 21

Security Privileges
The table below shows the list of Privileges required for the actions
available in this screen.

Buttons Privileges
Refresh Portalbase_View

Reset Portalbase_View

Advanced Options WEI_Message_Modify

Re-Process WEI_Message_Modify

Archive WEI_Message_Modify

Wonderware Enterprise Integrator User’s Guide


64  Message Log

Operation

Displaying Message Log


“Message Log” allows the user to view messages received from or sent
to external systems (i.e. SAP, SAM, etc.).The “Message Log” display
can be limited based on matching selections in the following fields:

Item Description
Location Only include Messages with “Location” matching
this field or select “<All>” to skip this filter field.
Message Type Only include Messages with “Message Type”
matching this field or select “<All>” to skip this
filter field.
Category Only include Messages with “Category” matching
this field or select “<All>” to skip this filter field.
Group Only include Messages with “Group” matching this
field or select “<All>” to skip this filter field.
Created After Date Only include Event Logs with ‘Start Date’ greater
or equal to the entry given in this field category.
Summary Only include Messages with “Summary” matching
any part of the entry given in this field. Leave
blank to not filter by Summary.
Content Only include Messages with “Content” matching
any part of the entry given in this field. Leave
blank to not filter by Content.
Direction Only include Messages with “Direction” matching
this field or select “<All>” to skip this filter field.
Status Only include Messages with “Status” matching this
field or select “<All>” to skip this filter field.
Message # Only include Messages within this range. If an
incorrect range is given, Message Log is simply
refreshed

Wonderware Enterprise Integrator User’s Guide


Operation  65

To display Message Log


1. Click the “Message Log” tab.
2. Click on the “Show Search Criteria” button.
3. Select one or more fields in the Search Criteria panel as described
in the table above to limit the transfer orders displayed.
4. Click “Search” button.

Re-Process Messages
“Message Log” can re-process a single or group of messages.

To Re-Process a message
1. Click the “Message Log” tab.
2. A new column with check boxes is added as the first column of the
Message Listings table.
3. Select Message(s) you want to re-process by checking the
corresponding check boxes.
4. Press the Re-Process button.
5. Click the OK button when prompted with the Confirmation
Message.

Archive Messages
“Message Log” can Archive a single or group of messages. Note that
these steps will mark a record as archived in the database. It does not
delete the record from the database. The result of this is that
messages that have been archived will no longer appear in the
Message Log unless the search criteria are set to “All” or “Archived”.

To Archive a message
1. Click the “Message Log” tab.
2. A new column with check boxes is added as the first column of the
Message Listings table.
3. Select Message(s) you want to Archive by checking the
corresponding check boxes.
4. Press the Archive button.
5. Click the OK button when prompted with the Confirmation
Message.
N ot e : If an invalid number range is entered in the “Message #”
textboxes, the screen will refresh with 0 results.

Wonderware Enterprise Integrator User’s Guide


66  Message Log

Displaying Message Details


“Message Log” allows the user to view the Messages details of
Messages that have been processed by the WEI system.

To display the Message Details,


1. Click the “Message Log” tab.
2. Click the Number link in the “#” column or “Src #” (A new screen
called “Message Display” is opened. See next section for details
about this screen).

Wonderware Enterprise Integrator User’s Guide


67

Chapter 13

Message Display

Overview
Displaying “Message Display” allows the user to view message details
received from or sent to external systems (i.e. SAP, SAM, etc.).

User Interface
Figure 22 shows a sample of the Message Display screen. The Listing
button may be used to return to the Message Log screen. In order to
display this screen, first click the “Message Log” button in the top-
level menu. Then choose a message using the Number link in the “#”
column or the Number link in the “Src #” column. The Message
Display screen will open showing the details of the selected message.

Figure 22

Wonderware Enterprise Integrator User’s Guide


68  Message Display

Security Privileges
The table below shows the list of Privileges required for the actions
available in this screen.

Actions Privileges
Refresh Portalbase_View

Listing Portalbase_View

Export WEI_Message_Modify

Re-Process WEI_Message_Modify

Re-Process Transfer WEI_Message_Modify

Archive WEI_Message_Modify

As text Portalbase_View

As xml Portalbase_View

Save WEI_Message_Modify

Operation

Archive a Message
Archiving a WEI Message allows the user to remove a message that
has been sent and no longer required. Note that these steps will mark
a record as archived in the database and the message will no longer
appear in the grid. It does not delete the record from the database.

To archive the current message


1. Click the “Message Log” tab.
2. Click the Number link in the “#” or “Src #” column, to open the
Message Display Screen.
3. Click the “Archive” button to archive the current message.
4. Click the OK button when prompted with the Confirmation
Message.

Wonderware Enterprise Integrator User’s Guide


Operation  69

Re-process Messages (Re-sending error and


paused messages)
Any message in the WEI system can be resent to its destination if
required

To Re-Process a message
1. Click the “Message Log” tab.
2. Click the Number link in the “#” or “Src #” column, to open the
Message Display Screen.
3. Click the “Re-Process” button to Re-process the selected message.
4. Click the OK button when prompted with the Confirmation
Message.
Note: Check the “Event Log Listing” Screen for more information on
errors.

Re-process Message Transfer (Re-sending error


and paused messages Transfer)
Any message in the WEI system can resend its transfer Destination
Message if required. A “transfer destination Table” will be displayed
with the option to “Re-Process Transfer” if available.

To Re-Process a message
1. Click the “Message Log” tab.
2. Click the Number link in the “#” or “Src #” column, to open the
Message Display Screen.
3. Click the “Re-Process Transfer” button in the “Transfer Destination
Table” to Re-process the selected message.
4. Click the OK button when prompted with the Confirmation
Message.
Note: Transfer Destination Tables will be only shown for Message with
a direction of “IN”.

Wonderware Enterprise Integrator User’s Guide


70  Message Display

Exporting a Message
To Export a message
1. Click the “Message Log” tab.
2. Click the Number link in the “#” or “Src #” column, to open the
Message Display Screen.
3. Click the “Export” button to export the selected message.
4. Choose a Destination location and the message will be exported to
this location.

Editing or Viewing the content of a message


To View a message
1. Click the “Message Log” tab.
2. Click the Number link in the “#” or “Src #” column, to open the
Message Display Screen.
3. “Click the “As text” button to show the message in plain text.

To edit a message
1. Click the “Message Log” tab.
2. Click the Number link in the “#” or “Src #” column, to open the
Message Display Screen.
3. Click the “As text” button to show the message in plain text.
4. Edit the message in the “Message Body” text box and click “Save”.
5. Click “as XML” to view message as XML.

Wonderware Enterprise Integrator User’s Guide


Operation  71

Figure 23 shows a sample of the Message Display screen, with a


Message in Text Format.

Figure 23

Message Display Links


The “Message Display” Screen allows user to click on Message details
and open its corresponding details screen.

To Open Message details links.


1. Click the “Message Log” tab.
2. Click the Number link in the “#” or “Src #” column, to open the
Message Display Screen.
3. Click on the link beside “Location ID”, “Message type” or “Message
Category”. This will open the screen “Location Details”, “Message
Type Details” or “Manage Message Categories” respectively.

Wonderware Enterprise Integrator User’s Guide


73

Chapter 14

Manage Messages

Overview
The “Message Summary by Location Category” screen allows the user to
view a summary of various WEI messages. The user can use this
screen to perform the following operations:
1. Turn “OFF” or “ON” a Location category.
2. Sending WEI Messages.
3. View Message log for each Location category.

Wonderware Enterprise Integrator User’s Guide


74  Manage Messages

The “Message Summary by Location Category” grid displays the number


of messages declared and sent to external systems for each message
category.

Item Description
Change Status The message category transaction mode.
OFF (Green) : New messages will be routed
automatically to destination
ON (Red) : New messages will need to be routed
manually to destination
Status Location category status – On or Off

Category The message category. This can be one of the


message categories as described above in the
message log section
Processing Total number of messages currently being
processed
Processed Total number of messages sent to an external
system.
Errored Total number messages that have failed

Retry Total number of message that are in the retry state

Paused Total number of messages that have a status


paused

User Interface
Figure 24 shows a sample of the “Message Summary by Location
Category” screen. This screen is accessed through the “Message
Summary” menu.

Figure 24

Wonderware Enterprise Integrator User’s Guide


Security Privileges  75

Security Privileges
The table below shows the list of Privileges required for the actions
available in this screen.

Buttons Privileges
Refresh Portalbase_View

Change Status WEI_Location_ChangeStatus


(On/Off)

Send Next WEI_Message_Send

Send All WEI_Message_Send

View Messages Portalbase_View

Operation

Display Message Summary by Category Listing


Display “Message Summary by Category” allows user to view a
summary of various WEI messages which can be limited base on
creation date.

To Display Message Summary


1. Click the “Manage Message” Tab button from the menu toolbar to
open the “Manage Summary by location Category” screen.
2. Select a Date from the” Created after Date” drop down. The default
is one week prior to the system date.
3. Press Refresh.

Change Status
When changing the Status, it will stop all messages from being
processed at that location category.

To Change Status
1. Click the “Message Summary” Tab button from the menu toolbar to
open the “Manage Summary by location Category” screen.
2. In the “Manage Message” screen, click the On or the Off button to
change the status of the Location Category.

Wonderware Enterprise Integrator User’s Guide


76  Manage Messages

Sending WEI Messages to Destination


To send specified number of messages in selected category
1. Click the “Message Summary” Tab button from the menu toolbar to
open the “Manage Summary by location Category” screen.
2. Enter the desired number of messages in the “Send Paused
Messages” column of the desired category.
3. Click the “Send Next” button to send the messages to their
destination.

To send ALL messages in selected category


1. Click the “Message Summary” Tab button from the menu toolbar to
open the “Manage Summary by Location Category” screen.
2. Click the “Send All” button in the “Send Paused Messages” column of
the desired category to send the messages.

Wonderware Enterprise Integrator User’s Guide


77

Chapter 15

Plug-In Development

Overview
A WEI system Plug-in can be created to implement custom
functionality. A WEI system user is able to define Plug-In references
throughout the GUI that will execute when a message is processed.
The Plug-in Reference locations and its corresponding interface are
shown in the table below:

Screen Item Plug- in Interface


Manage Location Types Send-Receive Class IMessageSendReceive

Location Details Pre-Processor Class IMessagePreSend

Location Details URI IMessageProcessor

Location Details TransformClass IMessageTransform

Location Details AbortTransferClass IMessageAbortTransfer

In order to create a plug-in, the correct API interface must be used.


The next section provides a summary of the API interface for the
IMessageSendReceive, IMessagePreSend, IMessageTransform,
IMessageAbortTransfer, and the IMessageProcessor plug-in class
types. The next section contains a more detailed description for each
interface.

Wonderware Enterprise Integrator User’s Guide


78  Plug-In Development

Interfaces

IMessageSendReceive
Definition
This Interface defines two methods “SendMessage” and
“RecieveMessage”.

Implementation
This Interface would be implemented in a plug-in when defining a
“Send-Receive Class”. The fully resolved class name may then be
entered in the Send-Receive Class field on the Manage Location Types
edit screen
By default 3 “Send-Receive Class” plug-ins have been defined for your
use.
 “WW.Messaging,WW.Messaging.FolderSendReceive”
 Used for processing message from Folders.
 Must define a folder path in the URI field of the Message
Location.
 “WW.Messaging,WW.Messaging.Dot
NetClassSendReceive”
 Used for Custom Code implementation.
 Must Define a URI (AssemblyName, ClassName) that
implements the “IMessageProcessor” in order for the plug-in to
work.
 “WW.Messaging,WW.Messaging.MSMQSendReceive”
 Used for send and receiving message from Microsoft Message
Queuing (MSMQ).

Common use
A common use for this Interface is Folder, database, FTP or MSMQ
message transfers.

Wonderware Enterprise Integrator User’s Guide


Interfaces  79

IMessagePreSend
Definition
Defines the method “PreSend”

Implementation
This interface would be implemented in a plug-in when defining a
“PreSend Class”. The fully resolved class name may then be entered
in the PreSend Class field on the Location Details screen for the desired
Message Location. A class that implements this interface may only be
used on a Message Location where the Direction field is set to “OUT”.

Common use
Common use would be to modify the content (body of the message) or
its label before a message is processed.

IMessageTransform
Definition
Defines the method “TransformMessage” which returns a structure of
type “MessageData.”

Implementation
This interface would be implemented in a plug-in when defining a
“TransformClass”. The fully resolved class name may then be entered
in the Transform Class field of a Transfer Destination Location for a
Message Location.

Common use
Common use would be to modify the status or category before a
message is processed.

Wonderware Enterprise Integrator User’s Guide


80  Plug-In Development

IMessageAbortTransfer
Definition
Defines the method “CheckAbortTransfer.”

Implementation
This interface would be implemented in a plug-in when defining an
“AbortTransferClass. The fully resolved class name may then be
entered in the Abort Transfer Class field of a Transfer Destination
Location for a Message Location.

Common use
Common use would be for when a Message is still waiting for crucial
information to be updated and cannot be sent out till that data is
received.

IMessageProcessor
Definition
Defines the methods “ProcessMessage” and “GetMessage.”

Implementation
This interface would be implemented in a plug-in when defining a
“MessageProcessorClass”. The fully resolved class name may then be
entered in the URI field on the Message Location screen.

Common use
Only used for Message Location with a Location Type “Send-Receive
Class” plug-in defined as a
“WW.Messaging.WW.Messaging.DotNetClassSendReceive”

Wonderware Enterprise Integrator User’s Guide


Overview  81

Chapter 16

WEI Web Services

Overview
WEI Message Manager is a web service that provides a message
passing mechanism which offers positive feedback to the remote
application that the message was received and stored in the WEI
database as opposed to message passing using MSMQ or files. The
web service defines one action and that is to add a single message to a
specified location.

User Interface
The web service may be excersized manually by opening the web page
at a URL such as
Error! Hyperlink reference not valid.
where <ComputerName> is replaced with the name of the WEI server
and <WEIInstanceName> is replaced with the name of the WEI
instance which was created using the WEIConfigurator utility. For
example, if browsing from the WEI Server and the default WEI
instance name was used in the configuration, then the URL would be
http://localhost/WEI/MessageManager.asmx and the web page would
appear as shown in Figure 25. This web page lists the methods
offered by the web service which consists of the AddMessage method.
The method name is a link that may be clicked to display a page,
Figure 26, showing the AddMessage details and a form which can be
used to invoke the method to insert a message into WEI. In addition,
the “Service Description” link may be clicked to view the web service
definition (WSDL).

Wonderware Enterprise Integrator User’s Guide


82  WEI Web Services

Figure 25

Figure 26

Wonderware Enterprise Integrator User’s Guide


Operation  83

Operation

Invoke AddMessage Method Using Web Page


A message may be passed to WEI via the AddMessage details web
page shown in Figure 26. This may be accomplished by entering a
valid message location into the locationId field, the message content
into the messageBody field, and a message label (this would be the file
name) in the messageLabel field shown on the form and then click the
Invoke button (Figure 27). A new window will appear showing a
message indicating the success or failure of the AddMessage operation
(Figure 28). Figure 29 and Figure 30 are of the WEI Message Log and
the Message Display pages showing the just added message.

Figure 27

Figure 28

Wonderware Enterprise Integrator User’s Guide


84  WEI Web Services

Figure 29

Figure 30

Wonderware Enterprise Integrator User’s Guide


Operation  85

Invoke AddMessage Method From Software


The WEI Web Service was designed to receive messages from other
software applications. The C# code snippets below show creating an
instance of the web service in an application and then calling the
AddMessage method from that same application.
Create instance of web service to enable access:
//Create new object from Web Reference
MessageMgr.MessageManager WebSvc = new
MessageMgr.MessageManager();

//Get Web Service URL from config file


WebSvc.Url =
Properties.Settings.Default.WEI_Plugin_MessageMgr_MessageMa
nager;
WebSvc.UseDefaultCredentials = true;
Call the AddMessage method to insert the message into WEI:
//Add message to WEI
WebSvc.AddMessage("TestIn", "<?xml version="""1.0"""
encoding="""utf-8"""?><TestMsg><MsgBody>This is the message
content.</MsgBody></TestMsg>", "Test20111201101530001");

These code snippets are from a Visual Studio project in which a


reference to the web service was created by right clicking the
References item in the Visual Studio Solution Explorer and selecting
the Add Service Reference item (Figure 32).

Figure 31

Wonderware Enterprise Integrator User’s Guide


86  WEI Web Services

Click the “Advanced…” button in the Add Service Reference dialog


(Figure 32) and then click the “Add Web Reference…” button in the
Service Reference Settings dialog (Figure 33).

Figure 32

Figure 33

Wonderware Enterprise Integrator User’s Guide


Operation  87

Enter the URL of the WEI web service into the URL field of the Add
Web Reference dialog and click the Go button (Figure 34). The URL
shown in Figure 34 contains a placeholder, <WEI Server>, which
should be replaced with the node name of the WEI Server.

Figure 34

If the URL is successfully contacted, then the MessageManager.asmx


page will appear below the URL. The “Web reference name” field may
be edited to customize the class name for the web service that will be
available for use in the code (Figure 35). This value was entered as
WebSvc for the code snippet above.

Figure 35

Wonderware Enterprise Integrator User’s Guide


88  WEI Web Services

When this procedure is complete, the new web reference will appear
in the Solution Explorer window under the Web References category
as shown in Figure 36.

Figure 36

Wonderware Enterprise Integrator User’s Guide


89

Index

Authentication, 13
#
#, 47, 62, 66
B
Batch Size, 39, 45
*
*Category, 45
C
Categories, 33, 34, 35
A Category Id, 34
Abort, 51
Change, 42, 75
Abort Transfer, 50, 52, 80
Change Status, 74, 75
AbortTransferClass, 77, 80
CheckAbortTransfer, 80
Action, 16, 42
Configuration, 23, 53, 54
Active Directory, 13
Content, 64, 70
Adapters, 9
Creation Date Time, 62
Add, 16, 17, 20, 24, 34

Advanced Options, 63
D
Data Type, 28, 29
AllowUserToggle, 35
Database, 9, 46, 65, 68
API, 9
Delete, 16, 17, 18, 20, 21, 24, 25, 28, 30, 34,
Application, 53 35, 42, 48, 52
Archive, 63, 65, 68 Description, 20, 21, 24, 25, 29, 35, 39
As text, 68

Wonderware Enterprise Integrator User’s Guide


80  Index

Destination, 44, 46, 47, 49, 50, 52, 76 Location ID, 48

Details, 16, 38, 59, 66 Log Detail, 59

DIR, 62 Log on, 17, 18

Direction, 43, 44, 64


M
Display Position, 35 Manage, 15, 17, 28, 34, 43

E Management, 11

Edit, 21, 25 Message, 28, 34, 38, 64, 65, 66, 67, 69, 70,
71, 75, 76
ERP, 9
Message Body, 70
Errored, 74
Message Display, 66, 67
Errors, 57, 58
Message Service, 37, 49
Event log, 57
MessageData, 79
Event Log, 53, 57, 58, 59
MessageProcessorClass, 80
Export, 68, 70
Messaging Configuration, 20, 24, 38
F MSMQ, 46, 78
Filter, 17, 28, 43, 58, 64
N
G Number, 66
GetMessage, 80

Group, 13, 14, 15


O
OFF, 36, 46, 73, 74
I ON, 36, 46, 73
IMessageAbortTransfer, 77, 80
Overview, 11, 12, 13, 19, 23, 27, 33, 37, 41,
IMessagePreSend, 77, 79 57, 61, 67, 73, 77, 81

IMessageProcessor, 77, 80
P
IMessageSendReceive, 77, 78 Parameters, 51
IMessageTransform, 77, 79 Paused, 14, 62, 74

L Plant Configuration, 53

Label Format, 44, 45 Plug-in, 9, 20, 77

Listing, 58, 67, 68, 75 PreSend, 45, 79

Location, 17, 19, 24, 25, 33, 35, 44, 45, 51, Privileges, 13, 14, 16, 20, 28, 34, 38, 42, 54,
71, 77, 78, 79, 80 58, 63, 68, 75

Wonderware Enterprise Integrator User’s Guide


Index  91

Processed, 62, 74 Source, 58

Processing, 62, 74 Src #, 62, 67

ProcessMessage, 80 Start Date, 58

Purge After, 44, 46, 49 Status, 39, 46, 62, 64, 74, 75

Summary, 27, 29, 33, 62, 64, 74, 75


R
RecieveMessage, 78 T
Refresh, 24, 38 Transfer Destination, 44, 47, 49, 50, 52

Re-process, 69 Transfer requirement, 9

Re-Process, 63, 65, 68 Transfer Requirement, 47

Reset, 63 Transform, 50, 51, 52, 79

Retry, 46, 74 TransformClass, 79

Retry Delay, 44, 49 Type Id, 20, 29

Type ID, 20, 28, 30


S
Save, 28, 38, 42, 68 Types, 9, 19, 27, 28

Search, 28 U
Search Criteria, 43 Update, 20, 24, 34, 54

Security, 13, 15, 16, 20, 24, 28, 38, 42, 54, URI, 44, 46, 77, 78
58, 63

Send All, 75
V
View, 13, 16, 58, 75
Send Next, 75
View Messages, 75
SendMessage, 78

Send-Receive, 19, 20, 78, 80 W


Website, 11, 13
Server, 11

Service Id, 38, 39 X


Services, 37 XML, 28, 29

Sleep Time, 38, 39

Wonderware Enterprise Integrator User’s Guide