Professional Documents
Culture Documents
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
Index ...................................................... 89
Chapter 1
Introduction
Chapter 2
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
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
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
The WEI system has the following Privileges that can be assigned to
“Security Groups”. These Privileges allow for different access within
the WEI system.
Note: Each screen in this User’s Guide will specify what Privileges are
needed in order to perform an action.
User Interface
Figure 3
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
Operation
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.
Deleting
A user can delete the whole security group Id or delete individual
Members and Privileges from a security Group.
Chapter 4
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
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.
Item Description
Location Type Id A unique Id used as an Identifier
Deleting
The “Manage Location Types” screen allows users to delete Location
Types.
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.
Chapter 5
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
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 Group” screen allows user to create custom
location Groups.
Item Description
Group Id A unique Id used as a Identifier
Deleting
The “Manage Location Groups” screen allows user to delete custom
location Groups.
Edit
The “Manage Location Groups” screen allows user to edit custom
location Groups. User can only edit the Description of a particular
group.
Chapter 6
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
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
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)
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.
Item Description
Message Type Id A unique Id used as a Identifier
Figure 8
Deleting
The “Manage Message Types” screen allows user to delete existing
Message Types.
Editing
The “Manage Message Types” screen allows user to edit existing
Message Types.
Chapter 7
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
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
Adding
The “Manage Message Categories” screen allows user to add Message
Categories.
Item Description
Category Id A unique Id used as a Identifier
Deleting
The “Manage Message Categories” screen allows user to delete Message
Categories.
Editing
The “Manage Message Categories” screen allows user to Edit Message
Categories.
Chapter 8
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
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
Operation
Editing
The “Manage Message Services” screen allows user to edit existing
Message Services.
Item Description
Service Id A unique Id used as an identifier
Figure 11
Chapter 9
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
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
Operation
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.
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)
Item Description
*Location Id A unique Id used as an Identifier
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.
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.
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.
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
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.
Editing
The “Manage Message Locations” screen allows user to edit existing
Message Locations.
Figure 15
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.
Figure 16
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
Configuration Items
The table below shows the list of pre-defined configurable items.
Item Description
EventLog_DaysToKeep Retention period for event log messages.
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
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.
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
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
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.
Figure 19
Figure 20
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.
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
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
Re-Process WEI_Message_Modify
Archive WEI_Message_Modify
Operation
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
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.
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
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
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 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.
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”.
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.
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.
Figure 23
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.
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
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
Security Privileges
The table below shows the list of Privileges required for the actions
available in this screen.
Buttons Privileges
Refresh Portalbase_View
Operation
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.
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:
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.
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.
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”
Chapter 16
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).
Figure 25
Figure 26
Operation
Figure 27
Figure 28
Figure 29
Figure 30
Figure 31
Figure 32
Figure 33
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
Figure 35
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
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
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
IMessageProcessor, 77, 80
P
IMessageSendReceive, 77, 78 Parameters, 51
IMessageTransform, 77, 79 Paused, 14, 62, 74
L Plant Configuration, 53
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
Purge After, 44, 46, 49 Status, 39, 46, 62, 64, 74, 75
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