Econnect Installation and Administration Guide: Microsoft Dynamics GP
Econnect Installation and Administration Guide: Microsoft Dynamics GP
Complying with all applicable copyright laws is the responsibility of the user. Without limiting the
rights under copyright, no part of this document may be reproduced, stored in or introduced into
a retrieval system, or transmitted in any form or by any means (electronic, mechanical,
photocopying, recording, or otherwise), or for any purpose, without the express written
permission of Microsoft Corporation. Notwithstanding the foregoing, the licensee of the software
with which this document was provided may make a reasonable number of copies of this
document solely for internal use.
Trademarks Microsoft, Microsoft Dynamics, Visual Basic, Visual Studio, BizTalk Server, Windows, Windows
Vista, and Windows Server are either registered trademarks or trademarks of Microsoft
Corporation or its affiliates in the United States and/or other countries.
The names of actual companies and products mentioned herein may be trademarks or registered
marks - in the United States and/or other countries - of their respective owners.
Unless otherwise noted, the example companies, organizations, products, domain names, e-mail
addresses, logos, people, places, and events depicted herein are fictitious. No association with
any real company, organization, product, domain name, e-mail address, logo, person, place, or
event is intended or should be inferred.
Intellectual property Microsoft may have patents, patent applications, trademarks, copyrights, or other intellectual
property rights covering subject matter in this document. Except as expressly provided in any
written license agreement from Microsoft, the furnishing of this document does not give you any
license to these patents, trademarks, copyrights, or other intellectual property.
Warranty disclaimer Microsoft Corporation disclaims any warranty regarding the sample code contained in this
documentation, including the warranties of merchantability and fitness for a particular purpose.
Limitation of liability The content of this document is furnished for informational use only, is subject to change without
notice, and should not be construed as a commitment by Microsoft Corporation. Microsoft
Corporation assumes no responsibility or liability for any errors or inaccuracies that may appear
in this manual. Neither Microsoft Corporation nor anyone else who has been involved in the
creation, production or delivery of this documentation shall be liable for any indirect, incidental,
special, exemplary or consequential damages, including but not limited to any loss of anticipated
profit or benefits, resulting from the use of this documentation or sample code.
License agreement Use of this product is covered by a license agreement provided with the software product. If you
have any questions, please call the Microsoft Dynamics GP Customer Assistance Department at
800-456-0025 (in the U.S. or Canada) or +1-701-281-6500.
Chapter 8: Troubleshooting...................................................................................................... 59
Functional currency ....................................................................................................................................59
Connection string problems ......................................................................................................................59
Login problems ...........................................................................................................................................59
Incoming or Outgoing Services ................................................................................................................60
eConnect event log......................................................................................................................................60
Incoming Service problems .......................................................................................................................61
COM+ application ......................................................................................................................................61
Glossary ......................................................................................................................................................... 63
Index ................................................................................................................................................................... 65
ii E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
INTRODUCTION
Introduction
Welcome to eConnect for Microsoft Dynamics™ GP. This documentation explains
how to install and administer eConnect. An eConnect installation includes files,
tools, and services that allow applications to integrate with Microsoft Dynamics GP.
Before you begin installing and using eConnect, take a few moments to review the
information presented here.
To learn about creating applications that use eConnect for Microsoft Dynamics GP,
refer to the eConnect Programmer’s Guide and Reference document.
Symbol Description
The light bulb symbol indicates helpful tips, shortcuts,
and suggestions.
Margin notes summarize Margin notes call attention to critical information and
important information. direct you to other areas of the documentation where
a topic is explained.
Convention Description
Part 1, eConnect Basics Bold type indicates a part name.
Chapter 1, “Overview” Quotation marks indicate a chapter name.
Installing eConnect Italicized type indicates a section name.
using System.IO; This font is used to indicate script examples.
Microsoft Message Acronyms are spelled out the first time they’re used.
Queuing (MSMQ)
TAB or ALT+M Small capital letters indicate a key or a key sequence.
2 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
IN T RO D U C T IO N
Product support
Microsoft Dynamics GP technical support can be accessed online or by telephone.
Go to www.microsoft.com/Dynamics and click the CustomerSource or
PartnerSource link, or call 888-477-7877 (in the US and Canada) or 701-281-0555.
6 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
Chapter 1: eConnect Overview
eConnect for Microsoft Dynamics GP allows you to integrate your business
applications with Microsoft Dynamics GP. The following topics introduce eConnect
for Microsoft Dynamics GP:
• What is eConnect?
• What eConnect can do
• Getting started
What is eConnect?
eConnect is a collection of tools, components, and interfaces that allow applications
to programmatically exchange data with Microsoft Dynamics GP. The key eConnect
components and interfaces include:
These eConnect interfaces allow external applications like web storefronts, web
services, point-of-sale systems, or legacy applications to integrate with Microsoft
Dynamics GP. The external applications can perform actions like creating, updating,
retrieving, and deleting back office documents and transactions.
Throughout the documentation, the terms front office and back office are used. The term
back office refers to the financial management system, in this case, Microsoft Dynamics GP.
The term front office refers to customer relationship management systems, data warehouses,
web sites, or other applications that communicate with the back office.
Dynamics GP data. eConnect also reduces development time when the business
logic contained in the back office is reused by new custom applications.
Getting started
How you start depends on your role:
System administrator
If you are the system administrator, complete the following:
Software Developer
If you are a developer, complete the following:
8 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
C H A P T E R 1 E C O N N E C T O V E R V I E W
• Discuss the installation procedure with the system administrator to learn what
configuration settings were used during the eConnect installation.
• Architecture diagram
• Configurations
• Business objects
• eConnect API
• BizTalk
• Transaction Requester
• Replication Service
Architecture diagram
eConnect installs a collection of components that work together to provide
programmatic access to Microsoft Dynamics GP data. The following diagram
illustrates the basic components:
Integrating
Applications
XML XML
Runtime
Layer .NET Assemblies
COM+ Object
Business Objects
Data Access
Layer
Microsoft
Dynamics GP
The diagram illustrates eConnect’s two key layers and the components each layer
contains.
• The data access layer contains the eConnect business objects. The business
objects are installed on the Microsoft Dynamics GP server.
• The eConnect runtime layer contains the components that simplify using the
eConnect business objects. The eConnect runtime layer installs on the same
computer as the integrating application.
The eConnect runtime includes several components that allow you to access the
eConnect business objects.
• The eConnect BizTalk adapter allows you to use BizTalk to configure and
manage the integration between your application and Microsoft Dynamics GP
The diagram also shows that your integrating application can bypass the eConnect
runtime and use the eConnect business objects directly.
Configurations
There are two common configurations for an eConnect installation. The following
illustration shows the most common configuration for eConnect. In this
configuration, the eConnect runtime is installed on a separate server, and accesses
the SQL Server that manages Microsoft Dynamics GP data over the local network.
To obtain optimal performance, you should use the two server configuration
whenever possible.
Local Network
12 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
C H A P T E R 2 EC O N N EC T A R C HI TE C T U R E
Which configuration you choose will depend on what types of integration you
need, and what server resources you have available. eConnect can also be part of a
BizTalk integration. Refer to BizTalk documentation for information about the types
of configurations possible with BizTalk Server.
Business objects
The most basic eConnect components are known as business objects. The eConnect
business objects are a collection of SQL stored procedures. The eConnect stored
procedures are added to the system database (DYNAMICS) during the initial
installation of Microsoft Dynamics GP. The eConnect stored procedure are also
included when you create a new company using Microsoft Dynamics GP Utilities.
The stored procedures contain the business logic used by eConnect. In addition, the
stored procedures validate the data and supply default values. Any eConnect action
that queries, creates, updates, or deletes data from Dynamics GP uses one or more
of these stored procedures.
See the eConnect You cannot modify eConnect stored procedures. However, eConnect provides an
Programmer’s Guide alternative that allows you to customize its business logic. Each stored procedure
and Reference for includes specially named pre and post stored procedures. You customize
information about eConnect’s business logic by adding SQL queries and commands to these pre and
customizing business post procedures. The pre stored procedure runs your custom code immediately
logic. before the eConnect stored procedure, while the post stored procedure runs
immediately after the eConnect stored procedure.
Start
For example, assume you want to modify the business logic for the eConnect stored
procedure named taSopHdrIvcInsert. You complete this modification by adding
custom SQL code to the stored procedure named taSopHdrIvcInsertPost. Your
custom code will run immediately after every execution of the taSopHdrIvcInsert
procedure. To run custom code prior to the execution of the taSopHdrIvcInsert
procedure, place the custom SQL code in the stored procedure named
taSopHdrIvcInsertPre.
Once eConnect installs its business objects, the stored procedures are available on
the server and can be utilized by your application. However, a direct call to an
eConnect stored procedure requires you to:
To avoid the extra work of direct calls to the stored procedures, use one of the APIs
that eConnect supplies. These API provide a simpler approach to using the
eConnect business objects.
eConnect API
eConnect provides a collection of APIs that interact with the business objects. There
are APIs for Microsoft .NET, and Microsoft Message Queuing (MSMQ). These
eConnect APIs allows you to use the interface that best fits your integration project
and the available development tools.
To support its API, eConnect supplies a COM+ application that manages interaction
with the eConnect business objects. The COM+ application installs in Component
Services of the computer where you installed the eConnect runtime. The COM+
application requires a user logon. The logon must have sufficient privileges (i.e. be
assigned to DYNGRP) to access the Dynamics GP databases on your SQL server.
14 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
C H A P T E R 2 EC O N N EC T A R C HI TE C T U R E
Schema information To use the eConnect API, your application must create or read eConnect XML
can be found in the documents. eConnect supplies XML schema to specify the contents of each
eConnect document.
Programmer’s Guide
and Reference A schema is an XML file (with typical extension .xsd) that describes the syntax and
semantics of XML documents using a standard XML syntax. An XML schema
specifies the content constraints and the vocabulary that compliant documents must
accommodate.
The eConnect business objects validate documents against the schema and reject
documents that do not comply.
Microsoft .NET
eConnect installs .NET assemblies on your computer and adds them to the global
assembly cache. The assemblies use the COM+ application to access the eConnect
business objects. To use eConnect in a .NET development project, add references to
these assemblies.
MSMQ
The MSMQ API uses MSMQ queues and Windows services to asynchronously
transport data between your application and Microsoft Dynamics GP. Your
application must be able to access the queues used by the services. Both the
Incoming and Outgoing services use the COM+ application to access the eConnect
business objects.
To use the eConnect Incoming Service, create an XML document and place it in the
specified queue. The Incoming Service monitors that queue and periodically
processes the valid XML documents stored in the queue.
The eConnect Outgoing Service relies on SQL triggers and the business objects to
retrieve specified eConnect documents. The service stores the documents in a
specified queue. Your application must monitor the queue, retrieve the supplied
documents, and perform its actions based on the data in the documents.
BizTalk
eConnect provides a BizTalk adapter is an application integration component (AIC)
that you can install on your BizTalk 2004 or BizTalk 2006 server. The BizTalk adapter
allows you to use BizTalk to manage interaction with eConnect business objects.
Transaction Requester
The Transaction Requester is a collection of SQL database tables and database
triggers that eConnect uses to make Dynamics GP data changes available to other
applications.
The Transaction
Requester’s SQL trigger
reacts to the record’s
creation, and inserts an
entry to the eConnect_Out
table.
The Transaction Requester supports other eConnect services that export data from
Dynamics GP to other applications.
When eConnect installs the Transaction Requester, it creates three tables in each
specified Dynamics GP database:
• eConnect_Out This table stores data from selected create, update, or delete
operations that occur within Microsoft Dynamics GP. The data identifies the
individual transactions that occurred. Other eConnect services use the data in
the table to create messages that can be used to integrate Dynamics GP data
with other applications.
To configure the eConnect Transaction Requester, use the eConnect Requester Setup
Tool. The eConnect Requester Setup Tool allows you to specify Dynamics GP
objects and operations you want to export to another application. The utility then
adds SQL triggers to Dynamics GP that populate the eConnect_Out table for the
specified objects and operations. For a detailed explanation of how to configure the
Transaction Requester, see Transaction Requester on page 42.
For example, assume you want an external application to be updated when a new
customer is added to Microsoft Dynamics GP. To begin, use the eConnect Requester
Setup Tool to specify the customer object and the SQL insert operation. The
eConnect Requester Setup Tool adds a SQL trigger to the database. When a new
customer record is inserted, the SQL trigger creates a record of the event in the
eConnect_Out table.
16 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
C H A P T E R 2 EC O N N EC T A R C HI TE C T U R E
The eConnect Outgoing Service periodically queries the eConnect_Out table. The
service uses the record in the table to create an XML document that describes the
new customer transaction.
The Outgoing Service then places the XML document in a message queue where it
can be retrieved and used to notify the external application.
Replication Service
eConnect includes the Replication Service that copies selected data changes from
Microsoft Dynamics GP to a specified target database. The Replication Service
asynchronously updates the target database to reflect changes made in Dynamics
GP.
To use the Replication Service, the target database must have the same table structure as the
Microsoft Dynamics GP database.
Microsoft Dynamics GP
database
The Transaction Requester’s SQL
trigger reacts to the record’s
creation, and inserts an entry to
the eConnect_Out table. eConnect_Out
table
MSMQ eConnect
Outgoing queue
External application
database
The Replication Service uses many of eConnect’s other components and interfaces:
• The eConnect Outgoing Service creates the XML documents from the
information provided by the Transaction Requester Service. It places them in
the Outgoing queue in MSMQ.
• The eConnect Replication Service takes the documents from the Outgoing
Queue and uses the data to replicate the transaction directly into the external
application’s database.
Since the Replication Service performs a specific task, it does not provide an API.
You cannot programmatically customize the Replication Service. Before starting the
Replication Service, you must configure the service. For a detailed explanation of
how to configure the Replication Service, see Replication Service on page 39.
18 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
PART 2: INSTALLATION
Part 2: Installation
This portion of the documentation explains how to install eConnect for Microsoft
Dynamics GP. The following information is discussed:
• Chapter 3, “Prerequisites,” describes the software required and the actions you
must perform before you install eConnect for Microsoft Dynamics GP.
20 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
Chapter 3: Prerequisites
Before installing eConnect for Microsoft Dynamics GP, there are several
prerequisites you must check. This portion of the documentation describes the
software requirements and the additional steps to perform before installing
eConnect. The following topics are discussed:
• Operating system
• Microsoft .NET 2.0 Framework
• COM+ user account
• Distributed Transaction Coordinator (DTC)
• Functional currency
• Microsoft Message Queueing (MSMQ)
Operating system
To install eConnect, the computer must be running one of the following operating
systems:
• Windows XP Professional
• Windows Server 2003 and Windows Server 2003 R2
• Windows Small Business Server 2003
• Windows Vista Enterprise
• Windows Vista Business
• Windows Vista Ultimate
• Windows Server 2003 x64 Edition
• Windows Server 2003 for Itanium-based Systems
When you install eConnect, you will be prompted to supply the credentials for this
user account.
Enabling DTC
For Windows Server 2003 and Windows XP, you enable network DTC through the
Windows Components Wizard. To do this, complete the following procedure:
22 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
C H A P T E R 3 PR ER EQ U I SIT E S
Configuring DTC
If the two computers are in the same domain, the default configuration for DTC can
be used with eConnect. If you have made modifications to the security
configuration for DTC, you must be sure the following settings are used:
If the two computers are in a Windows workgroup, or are in domains that do not
have an established trust relationship, update your DTC security configuration to
use No Authentication Required. To configure DTC, complete the following
procedure:
For Windows Vista™ enter comexp.msc in the search box of the Start menu.
Select the My Computer node. From the Action menu choose Properties. Select
the MSDTC tab, and click the Security Configuration button.
Functional currency
eConnect requires a functional currency to be set up for Microsoft Dynamics GP,
even if multicurrency is not being used. To set up a functional currency, complete
the following procedure:
24 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
C H A P T E R 3 PR ER EQ U I SIT E S
• Installation procedure
• What to do next
Installation procedure
To install eConnect, complete the following procedure:
When you click a button for a feature, a pop-up menu of options appears. Refer
to the following table for information about each option.
To include a feature, click the button and select “Install entire feature.” To
exclude a feature, click the button and select “Do not install feature.”
BizTalk 2004 Components Installs the files needed to install the BizTalk
2004 application integration component (AIC) adapter.
BizTalk 2006 Components Installs the files needed to install the BizTalk
2006 application integration component (AIC) adapter.
The account must be a member of the DYNGRP role in the Microsoft Dynamics GP
system and company databases on your Microsoft Dynamics GP SQL Server.
28 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
C H A P T E R 4 E C O N N E C T I N S T A L L A T I O N
Click Install to begin the installation process. The install will run for several
minutes.
The installation creates the eConnect event log. The log stores all the error,
warning and information messages that eConnect generates. To view the
eConnect event log, open the Start menu and select Control Panel >>
Administrative Tools >> Event Viewer. Click eConnect to view the current list
of messages.
What to do next
After eConnect for Microsoft Dynamics GP has installed, consider taking the
following steps:
• Learn about actions you will need to take to configure and maintain the
eConnect for Microsoft Dynamics GP components you installed. Details are
found in Part 3, Administration.
32 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
Chapter 5: Configuring eConnect Services
After installing eConnect, you may need to configure the eConnect services or the
BizTalk adapter. The following sections describes how to configure these
components:
• Overview
• Incoming Service
• Outgoing Service
• Replication Service
• Transaction Requester
• BizTalk adapter
Overview
The complete eConnect installation adds three Windows services to your
computer’s Service Control Manager. The installer initially configures each service
and stores the configuration information in an XML file. These XML configuration
files contain keys and values that control the operation of each service. To customize
the behavior of a service or to adjust the service to reflect changes in your server
environment, change the values for one or more keys in the configuration file.
Make a backup copy of the configuration file before making any changes. This ensures you
will always be able to restore the service if necessary.
After changing the settings in a configuration file, you must stop and restart the
service. The changes in the configuration file will not be implemented until the
service restarts.
The eConnect install also includes the Transaction Requester that publishes
eConnect XML documents to a specified queue. Use the eConnect Requester Setup
utility to specify which Microsoft Dynamics GP documents to publish.
If you install the eConnect Adapter for BizTalk 2004, you must configure BizTalk
Server 2004 to work with the adapter. You use the BizTalk Server Administration
utility and Visual Studio .NET 2003 to configure the BizTalk server.
Incoming Service
The Incoming Service integrates eConnect XML documents into Microsoft
Dynamics GP. The Incoming Service uses a configuration file named
eConnect_Incoming.exe.config to control its operations. This file is found in the
eConnect installation location, typically C:\Program files\Common
Files\Microsoft Shared\eConnect 10\Services\Incoming Service.
<addkey="eConnect.BackOffice.ConnectionString"value="data
source=MYServer;initial catalog=MyDatabase;integrated
security=SSPI;persist security info=False;packet size=4096"/>
<addkey="eConnect.LogAll"value=""/>
<add key="eConnect.Threads" value="0" />
</appSettings >
</configuration>
<addkey="eConnect.Incoming_Queue"value=""/>
<addkey="eConnect.Transactional_deadletter_Queue"value="0"/>
The value “0” stores the undeliverable message in the system’s transactional
deadletter queue.
<addkey="eConnect.Schema.Type"value=""/>
A blank key value means there is no schema validation. The other possible values is
XSD. You set the value to XSD when you want to validate an eConnect XML
documents against the eConnect schema.
Schema validation ensures the XML document in the message contains all the
information required for a successful create, update, or delete operation in
Microsoft Dynamics GP. Schema validation verifies the name of each XML node, the
order of each node in the XML document, and the values contained by the node. If
the XML document fails validation, an error is logged in the eConnect event log and
the XML document is discarded.
If you elect not to perform schema validation, the order and name of each XML
node is not verified. When eConnect encounters an XML document that contains a
34 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
C H A P T E R 5 C O N F I G U R I N G E C O N N E C T S E R V I C E S
node with an unrecognized name, the data value for that node is omitted but the
specified operation is allowed to proceed. No log entry is made about the omitted
node. Invalid data values are detected and logged as an error in the eConnect event
log even when schema validation is not performed. XML documents with invalid
data are discarded after logging the error message.
eConnect.Schema This key specifies the location of the XSD schema file. The
default value is blank.
<addkey="eConnect.Schema"value=""/>
A blank key value indicates incoming XML documents will not be validated. If you
have set the eConnect.Schema.Type key to XSD, use this key to supply the path to
the XSD schema file. For example, use value="C:\Program
Files\CommonFiles\Microsoft Shared\eConnect 10\XML Schemas\Incoming XSD
Schemas\eConnect.xsd" to validate against the schema definitions contained in that
XSD file.
<addkey="eConnect.BackOffice.ConnectionString"value="data source=MYServer;
initial catalog=MyDatabase;integrated security=SSPI;persist security info=
False;packet size=4096"/>
You change how the connection string works by changing the value parameters. For
example, you may change the data source or initial catalog parameters to reflect
changes in your server configuration.
If you install eConnect on a separate computer from the SQL Server that manages
Microsoft Dynamics GP data, you must change this key’s data source parameter.
The default configuration assumes a single server install. Change the data source
value to specify the SQL Server where the eConnect business objects are installed.
Invalid changes to connection string parameters can prevent the service from working. You
should carefully test changes to ensure the connection string is valid.
eConnect.LogAll The key specifies the types of messages to log in the eConnect
event log. The default value is blank.
<addkey="eConnect.LogAll"value=""/>
The value ““ logs only errors. Change the value to “1” to log all messages in the
eConnect event log.
eConnect.Threads This key specifies the number of threads that are available
when the service starts. The default value is “0”.
A value of “0” indicates a single thread will be used. You can set the value to any
number between 0 and 19. A value of 19 makes 20 threads available when the
service starts. A higher number of threads should allow the service to process
documents more quickly.
There are scenarios where increasing the number of threads degrades system performance. If
the server cannot support more threads, or custom code added to an eConnect pre or post
stored procedures is not thread safe, adding threads may cause unexpected results. Changes
to this key’s value require careful evaluation and testing.
Outgoing Service
The Outgoing Service allows you to integrate transaction information originating in
Microsoft Dynamics GP into your application. The Outgoing Service creates XML
documents and stores them in a message queue. Your application must retrieve
these messages to use the XML documents they contain. The Outgoing Service
creates a default queue named machine_name\private$\econnect_outgoing to store
outgoing messages.
<?xmlversion="1.0"encoding="Windows-1252"?>
<configuration>
<appSettings>
<addkey="BackOffice.ConnectionString"value="data
source=MyServer;initial catalog=MyDatabase;Integrated
Security=SSPI;persist security info=False;packet size=4096"/>
<add key ="Requester.ACTION" value ="0" />
<add key ="Requester.OutputType" value ="2" />
<add key ="Requester.Remove" value ="1" />
<add key ="Timer1.Interval" value ="1000" />
<add key ="Delay.Interval" value ="5" />
</appSettings >
<DatabaseNames database1="DYNAMICS" database2="TWO" />
</configuration>
Requester.ACTION This key specifies the type of database operations you want
the service to monitor. The default value is “0”.
<addkey="Requester.ACTION"value="0"/>
The value “0” creates and stores an XML document in the queue whenever there is
an insert, update, or delete operation for the Dynamics GP document types selected
using the Requester Enabler/Disabler utility.
36 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
C H A P T E R 5 C O N F I G U R I N G E C O N N E C T S E R V I C E S
Value Description
0 Creates an XML document and stores it in a message queue for each
Transaction Requester enabled insert, update, or delete operation.
1 Creates an XML document and stores it in a message queue for each
Transaction Requester enabled insert operation. The Outgoing Service ignores
any Transaction Requester enabled update or delete operations.
2 Creates an XML document and stores it in a message queue for each
Transaction Requester enabled update operation. The Outgoing Service ignores
any Transaction Requester enabled insert and delete operations.
3 Creates an XML document and stores it in a message queue for each
Transaction Requester enabled delete operation. The Outgoing Service ignores
any Transaction Requester enabled insert and update operations.
4 Creates an XML document and stores it in a message queue for each
Transaction Requester enabled insert or update operation. If a record is updated
multiple times, the queue contains an XML document for each update
operation. The Outgoing Service ignores any Transaction Requester enabled
delete operations.
5 Creates an XML document and stores it in a message queue for Transaction
Requester enabled insert and update operations. Inserts and updates to the
same record produce only a single XML document in the queue. The Outgoing
Service ignores any Transaction Requester enabled delete operations.
Use this key to specify the types of XML documents produced by the Outgoing
Service.
Requester.OutputType This key specifies the type of the XML document that is
created. The default value is “2”, which retrieves the complete document.
<addkey="Requester.OutputType"value="2"/>
Value Description
0 Retrieves key information. The XML document contains the record’s unique key
value and the database and table in Microsoft Dynamics GP where it is stored.
1 Retrieves the master document only. The XML master document contains all
the eConnect schema fields for that record. For example, the XML document
produced for a new customer will include every field defined by the eConnect
customer schema.
2 Retrieves the complete document. The XML document contains the master
document data and any child documents related to the master document. For
example, the XML document for a customer will also include the address
documents for that customer.
Use this key to adjust the amount of data the Outgoing Service places in each XML
document.
Requester.Remove This key specifies whether or not the record is deleted from
the eConnect_Out table after the service places the document in the message queue.
The default value is “1”.
<addkey="Requester.Remove"value="1"/>
A value of ”1” deletes the record from the eConnect_Out table. A value of ”0” keeps
the record in the eConnect_Out table.
The service queries the list of records in the eConnect_Out table. It then cycles
through the list of records to identify the documents to place in the message queue.
If the record in the eConnect_Out table is not deleted, the service creates a duplicate
document in the message queue each time it runs.
Timer1.Interval This key specifies the number of milliseconds the service pauses
between queries of the eConnect_Out table. Default value is ”1000”
<addkey="Timer1.Interval"value="1000"/>
Change the value when you need to optimize the workload the service places on
your computer.
Delay.Interval This key specifies the number of seconds a record must exist in
the eConnect_Out table to be eligible for processing by the service. The default
value is ”5”.
<addkey=”Delay.Interval"value="5"/>
The default value indicates a record will not be processed until it has been in the
eConnect_Out table for a minimum of five seconds.
<addkey="BackOffice.ConnectionString"value="data source=MyServer;initial
catalog=MyDatabase;Integrated Security=SSPI;persist security
info=False;packet size=4096"/>
You change how the connection string works by changing the value parameters. For
example, you may change the data source or initial catalog parameters to reflect
changes in your server configuration.
If you install eConnect on a separate computer from the SQL Server that manages
Microsoft Dynamics GP data, you must change this key’s data source parameter.
The default configuration assumes a single server install. Change the data source
value to specify the SQL Server where the eConnect business objects are installed.
Invalid changes to connection string parameters can prevent the service from working. You
should carefully test changes to ensure the connection string is valid.
DatabaseNames This XML node contains attributes that specify the databases
the Outgoing Service monitors. The default includes all of the Dynamics GP
databases that existed when the service was installed.
The Outgoing Service monitors the databases in the order they are listed. Each
specified database must include the eConnect business objects and the
eConnect_Out, eConnect_Out_Setup, and eConnectOutTemp tables.
To add a company to the Outgoing Service, you must identify the company
database in the configuration file’s DatabaseNames node. For example, assume you
added a new company named CONTOSO to Microsoft Dynamics GP. To add this
company to the Outgoing Service, complete the following:
38 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
C H A P T E R 5 C O N F I G U R I N G E C O N N E C T S E R V I C E S
Replication Service
The Replication Service allows you to integrate information originating in Microsoft
Dynamics GP with another application’s database. A typical example uses the
Replication Service to update a front office sales and service application with key
data from Microsoft Dynamics GP. The term front office database describes this
type of target database.
The Replication Service requires the Outgoing Service to retrieve documents from
Microsoft Dynamics GP. The Replication Service uses the XML documents in the
outgoing queue to replicate the data changes to the front office database.
The configuration settings allow the Replication Service to target one or more front
office databases. The front office database is specified by the key named
eConnect.FrontOffice.ConnectionString.0.
<addkey="eConnect.FrontOffice.ConnectionString.1" value="
datasource=127.0.0.1;initial catalog=DYNAMICS_FRONT;integrated
security=SSPI;persist security info=False;packet size=4096"/>
Each connection string key requires the configuration file to specify the queues that
the Replication Service uses for its XML documents. The configuration file specifies
the incoming and deadletter queues. The key names must contain the same integer
value as the connection string key it supports.
You must add the correct connection string and queue information to the configuration file
before starting the Replication Service.
The value sets the data source and initial catalog parameters to the server address
and database of a front office application that the Replication Service targets.
40 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
C H A P T E R 5 C O N F I G U R I N G E C O N N E C T S E R V I C E S
The value sets the data source and initial catalog parameters to the server address
and database of a second front office application that the Replication Service targets.
<addkey="eConnect.Requester.Incoming_Queue.0" value=".\private$\
econnect_company_front"/>
The Replication Service monitors the specified queue and uses the XML documents
placed in that queue to update the front office database. The value specifies the
queue where the eConnect Outgoing Service is placing the XML documents that
need to be replicated.
The Replication Service monitors the specified queue and uses the XML documents
placed in that queue to update the second front office database. The value specifies
the queue where the eConnect Outgoing Service is placing the XML documents that
need to be replicated.
<addkey="eConnect.Requester.DeadLetter_Queue.0" value=".\private$\
econnect_company_front_deadLetter"/>
The value specifies the queue the Replication Service uses to store undeliverable
messages for the first incoming queue.
<addkey="eConnect.Requester.DeadLetter_Queue.1" value=".\private$\
econnect_system_front_deadLetter"/>
The value specifies the queue the Replication Service uses to store undeliverable
messages for the second incoming queue.
<addkey="eConnect.Timer.Interval" value="1000"/>
The default value causes the service to pause for one second before checking the
incoming queues for new messages. Increase the number of milliseconds to lessen
the workload the Replication Service places on your computer.
Transaction Requester
The Transaction Requester allows you to specify Microsoft Dynamics GP
documents to publish as eConnect XML documents. You also specify whether to
publish for an insert, update, or delete operation in a Microsoft Dynamics GP
database. You configure the Transaction Requester, complete the following
procedure:
To create the connection string, choose Setup Connection from the Connection
Settings menu. The Connection Setup window opens. Enter the name of the
Microsoft Dynamics GP SQL Server and the company database you will use
with the Transaction Requester.
42 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
C H A P T E R 5 C O N F I G U R I N G E C O N N E C T S E R V I C E S
Mark the Integrated Security check box to use your Windows logon
information. If you clear the Integrated Security check box, you must supply a
SQL user name and password that enables the Requester Setup Tool to access
the specified database.
Click Save.
To discontinue the publishing of a document, remove the check from the check
box for that document type.
To discontinue the publishing of a document, remove the check from the check
box for that document type.
To discontinue the publishing of a document, remove the check from the check
box for that document type.
If you do not specify a queue, the eConnect Outgoing Service places the XML
documents in the econnect_outgoing10 queue.
BizTalk adapter
The BizTalk adapter allows you to use eConnect in a BizTalk orchestration or in a
simple pass-through situation. A BizTalk orchestration allows applications with
differing message formats to integrate, while a BizTalk pass-through simply routes
messages between applications.
44 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
C H A P T E R 5 C O N F I G U R I N G E C O N N E C T S E R V I C E S
To configure the eConnect BizTalk 2004 adapter, you must have already installed Microsoft
Visual Studio .NET 2003 on the computer. To configure the eConnect BizTalk 2006 adapter,
you must have already installed Microsoft Visual Studio 2005 on the computer.
In BizTalk Server 2006, click BizTalk Server 2006 >> BizTalk Group >> Platform
Settings. Right-click Adapters and select New >> Adapter.
Click OK to continue.
In BizTalk Server 2004, select the Properties tab. In BizTalk Server 2006, click the
Properties button. The eConnect Transport Properties window opens.
46 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
C H A P T E R 5 C O N F I G U R I N G E C O N N E C T S E R V I C E S
Expand the node for your BizTalk server. Right-click Send Ports. Select Add
Send Port. The Create New Send Port dialog opens. Select Static One-Way
Port. Click OK.
Click OK to continue.
48 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
C H A P T E R 5 C O N F I G U R I N G E C O N N E C T S E R V I C E S
If you are not using BizTalk orchestration, click the Filters & Maps folder in the
left pane. Select Filters to open Static One-Way Send Port Properties -
Configurations - Filters and Maps - Filters window. In the Property drop-
down list, select BTS.ReceivePortName. In the Value text box, enter the name
of the receive port.
Click OK to continue.
Completing a repair
If the eConnect for Microsoft Dynamics GP application becomes damaged, the
repair operation may help resolve the issue. The Repair wizard fixes the following:
• Restore default configuration settings for the COM+ application, MSMQ, or the
Incoming, Outgoing, and Replication services.
• Remove or restore your customizations made to any Pre or Post stored
procedure.
2. Choose Repair.
The Modify eConnect Runtime for Microsoft Dynamics GP 10.0 Installation
window opens.
Click Repair.
4. Ready to repair.
Click Repair to begin. The repair will run for several minutes.
5. Installation complete
When the Installation Complete window appears, click Exit to close the
wizard.
52 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
C H A P T E R 6 M A I N T E N A N C E
Removing eConnect
The eConnect remove operation allows you to delete all of the installed eConnect
folders and files. It deletes only the files and folders created in the local machine’s
file system.
2. Click Remove.
The Modify eConnect Runtime for Microsoft Dynamics GP 10.0 Installation
window opens.
Click Remove.
For more information about the Requester Setup Tool, see Transaction Requester on
page 42.
If you install using the eConnect runtime installer, the eConnect MSMQ control is not
available. To use the eConnect MSMQ control, you must install the eConnect SDK. The
runtime install does not include the eConnect MSMQ control.
To use the eConnect MSMQ Control, open the Start menu and select All Programs
>> Microsoft Dynamics >> eConnect 10 >> eConnect MSMQ Control. This opens
eConnect Queue Messaging in Internet Explorer.
Select the type of queue. The eConnect MSMQ Control allows you to work with
private queues, public queues, or the Deadletter queue. Enter the path for the queue
in the Queue Path text box. Click Open. The Messages list box displays the label of
each message in that queue.
To view or edit a specific message, click its label in the list box. The Message
Contents textbox at the bottom of the screen displays the message. If you want to
change the contents of the message, use the textbox to find and edit the XML.
To resubmit the message or to send it to another queue, enter the path to the target
queue in the Queue Path for Resending text box. Click Resend. The Message Log
textbox logs any messages from resending the message. The eConnect MSMQ
Control also allows you to indicate whether to leave the original messages in the
queue or have the original message deleted once the messages is resent. The
eConnect MSMQ Control also allows you to relabel a message.
56 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
C H A P T E R 7 UT IL IT IE S
To use the utility, open the Start menu and select All Programs >> Microsoft
Dynamics >> eConnect 10 >> Release Information >> Release Info. The eConnect
Release Information window opens.
Choose the Set Connect String command from the Connection menu. When the
Connection Properties window opens, specify the name of your Microsoft
Dynamics GP SQL Server.
To use your Windows logon credentials, mark the Windows Integrated Security
check box. Click Connect or choose Retrieve from the menu.
If your Windows logon account cannot access the Microsoft Dynamics GP server,
you may use a SQL logon. To use a SQL logon, you must clear the Windows
Integrated Security check box. Enter your SQL user name and password.
The eConnect Release Information windows displays the company name, and the
eConnect release number for each company on the specified server.
58 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
Chapter 8: Troubleshooting
If you encounter problems with eConnect for Microsoft Dynamics GP, the following
sections may be helpful. They describe some of the most common situations that
can occur when using eConnect. The following items are discussed:
• Functional currency
• Connection string problems
• Login problems
• Incoming or Outgoing Services
• eConnect event log
• Incoming Service problems
Functional currency
If you add a new company to Microsoft Dynamics GP and you install the eConnect
business object for the new company, you may encounter problems when eConnect
attempts a create, update, or delete operation. Common examples include:
• The eConnect Incoming Service fails to update the company database. You find
Microsoft message queuing (MSMQ) messages that target the new company in
the system’s Transactional dead-letter messages queue.
• Applications using the eConnect API generate error messages that indicate a
functional currency is needed.
• You find the eConnect event log contains entries that report a functional
currency has not been set up and is required.
To use the eConnect business objects, you must define a functional currency for the
new company. eConnect requires a currency ID for the company, even if
multicurrency is not being used. Review the setup procedure, Functional currency on
page 24, to specify a functional currency.
To eliminate the error, check the connection string. The connection string must
contain:
Integrated Security=SSPI;
If this parameter is missing from the connection string or is not set to SSPI, edit the
connection string to supply the correct integrated security setting.
Login problems
After installing eConnect, any attempt to use the eConnect API or start an eConnect
service creates an error message in the eConnect event log. The log entries indicate
the user login is invalid or cannot perform the requested action. To resolve these
issues, review the following:
• Verify that the login account can access the SQL Server where the eConnect
business objects are installed. The login must be able to access the Microsoft
Dynamics GP server.
• Verify that the login account can access the DYNAMICS database and the
company databases where the eConnect business objects are installed. SQL
Server must authorize the login account to access these databases.
• Verify that the login account is assigned to the DYNGRP database role. The
login account must have the DYNGRP role for the DYNAMICS database and
each company database where the eConnect business objects are installed.
Could not start the Microsoft Business Solutions - Great Plains eConnect
Incoming Service on the Local Computer.
Error 1075: The dependency service does not exist or has been marked for
deletion.
The message indicates MSMQ was not installed on the computer with the eConnect
Incoming and Outgoing services. Refer to Microsoft Message Queueing (MSMQ) on
page 25 for instructions on installing MSMQ.
You will want to check the eConnect event log in the following situations:
• Your application produces error messages. Check the event log to see if
eConnect is logging any messages that specify the cause of the error.
• You find insert, update, or delete operations performed by eConnect are not
visible in the Microsoft Dynamics GP client. Review the eConnect event log to
see whether operations are being aborted. The log will contain an error message
that explains why the operation was not completed.
• If you validate incoming XML documents, the event log will contain error
messages about the documents that failed validation. Use the messages in the
event log to correct the XML so the documents can be resubmitted.
The information in the error messages specifies the type of error and its source. Use
the information contained in the messages to identify the corrective actions that are
needed.
60 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
C H A P T E R 8 TR O U B L E S H O O T I N G
To see whether validation is the cause, open the configuration file for the Incoming
Service and check the eConnect.Schema.Type key. If the key value is XSD, the
Incoming Service is validating the XML of all the incoming documents. For
additional information about configuring the Incoming Service, see the Incoming
Service on page 33.
When validation is enabled, the Incoming Service checks all incoming documents
for compliance with eConnect’s schema definition for that document. A validation
error occurs if the document contains improperly named nodes, the sequence of the
nodes within the document differs from the schema, or the nodes contain
unexpected values. If the Incoming Service encounters a validation error, it logs an
error message in the eConnect event log. After logging the error message, the
operation is aborted.
To prevent operations from being lost to validation errors, perform one of the
following actions:
• Use the error information to determine what is causing the validation problem.
Change the application that generates the XML documents to comply with the
eConnect schema.
• Use the error messages in the log to identify documents that failed validation.
Use the information in the error message to correct each XML document.
Resubmit the documents to the Incoming Service.
• Disable validation for the Incoming Service. This will stop eConnect from
logging an error when an XML document contains an unknown element name,
or the order of the elements in the document differ from the document’s
schema.
COM+ application
Your eConnect application suddenly stops producing changes in Microsoft
Dynamics GP. Your investigation finds that the application was previously working.
You cannot find any recent changes to the application or the eConnect
configuration. To determine whether the eConnect COM+ application is causing the
unexpected result, perform the following actions:
• Check whether the eConnect COM+ application is using the correct login
credentials. The installation requires you to provide a user name and password
for the COM+ application. If the you later change that user’s password and do
not update the COM+ application with the new password, the COM+
application will not start. To update the COM+ password, open the eConnect
COM+ application in the Component Services console. Right-click the
eConnect 10 for Microsoft Dynamics GP application and select Properties.
Click the identity tab. Update Password with the specified user’s current
password.
• Check whether the COM+ application has been disabled. Open the eConnect
COM+ application in the Component Services Console. Right-click the
eConnect 10 for Microsoft Dynamics GP application and select Start. If you
receive an error message stating you must enable the application, right-click
eConnect 10 for Microsoft Dynamics GP and select Enable.
62 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E
Glossary Microsoft message queuing
(MSMQ)
A message infrastructure and development
Application programming interface platform for creating distributed, loosely-
(API) coupled messaging applications.
A set of functions or features you access to
programmatically use or manipulate a Outgoing Service
software component or application. A Microsoft Windows service that publishes
eConnect XML documents to a specified
Back office queue. The XML documents represent
A financial management system. In an documents that were created, updated, or
eConnect environment, this refers to deleted in Microsoft Dynamics GP.
Microsoft Dynamics GP.
Post stored procedure
BizTalk server A customized SQL stored procedure that
A Microsoft platform that manages the runs immediately after an eConnect stored
exchange of data between applications. procedure.
Microsoft Visual Studio .NET 2003, Replication Service (continued) troubleshooting (continued)
BizTalk configuration 44 defined 63 services 60
missing files, repairing 52 described 17
modifying Requester Tool 42-44, described 55 U
described 51 Requester.Action 36 uninstall
eConnect installation, procedure 51 Requester.OutputType 37 described 53
MSMQ, see Microsoft message queuing Requester.Remove 37 removing eConnect 53
MSMQ Control roles user account
described 55 software developer 8 COM+ object 21
monitoring queue activity 56 system administrator 8 troubleshooting 61
starting 55 utilities
multithreading, Incoming Service 35 S chapter 55-58
schema MSMQ Control 55
N defined 63 Release Information 57
.NET assembly 15 described 15 Requester Tool 55
.NET Framework 21 files 35
schema validation, see validation V
O services validation
operating system, required 21 see also Incoming Service, Outgoing described 34
Outgoing Service Service, Replication Service error messages 34
see also Transaction Requester defined 63 schema files 35
configuration 36-39 described 33 troubleshooting 61
configuration keys 36-39 restarting 33 Visual Studio .NET, BizTalk configuration
action types 36 troubleshooting 60 44
connection string 38 software developer, responsibilities 8
database names 38 SQL trigger W
delay interval 38 defined 63 warning symbol 2
output types 37 Requester Tool 16 windows services, see services
remove record 37 stored procedures
time interval 38 see also business objects
X
defined 63 XML, defined 63
calling 14
described 15 XML document
defined 63
defined 63
described 14
P modifying 13
described 8
performance, optimizing 35 post 63
Prerequisites pre 63
chapter 21-25 support, for Microsoft Dynamics GP
COM+ user account 21 eConnect 3
Distributed Transaction Coordinator symbols in documentation 2
22 system administrator, responsibilities 8
functional currency 24
Microsoft .NET Framework 21 T
operating system 21 technical support, for Microsoft Dynamics
product support, for Microsoft Dynamics GP eConnect 3
GP eConnect 3 threads, Incoming Service 35
Timer1.Interval 38
R Transaction Requester
registry entries, repairing 52 configuration 42-44
Release Information connection string 42
connection string 57 database tables 16
described 57 defined 63
viewing the release number 57 described 15
removing eConnect 53 Requester Tool 42, 55
repair, described 52 troubleshooting
repairing eConnect, procedure 52 chapter 59-62
Replication Service COM+ object 61
adding a database 39 connection string 59
configuration 39-41 event log 60
configuration keys 40-41 functional currency 59
connection string 40 Incoming Service 61
message queues 41 login problems 59
time interval 41
66 E C O N N E C T I N S TA L L A T I O N A N D A D M I N I S TR A T I O N G U I D E