IMUsers Guide
IMUsers Guide
IMUsers Guide
Limitation of liability This document is provided “as-is”. Information and views expressed in this document, including
URL and other Internet Web site references, may change without notice. You bear the risk of using
it.
Some examples depicted herein are provided for illustration only and are fictitious. No real
association or connection is intended or should be inferred.
Intellectual property This document does not provide you with any legal rights to any intellectual property in any
Microsoft product.
You may copy and use this document for your internal, reference purposes.
Trademarks Microsoft, Microsoft Dynamics, Access, ActiveX, Internet Explorer, MSDN, SQL Server, Visual
Basic, Windows, Windows Server, and Windows Vista are trademarks of the Microsoft group of
companies. FairCom and c-tree Plus are trademarks of FairCom Corporation and are registered in
the United States and other countries.
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.
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.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E i
C O N T E N T S
ii I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C O N T E N T S
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E iii
C O N T E N T S
iv I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C O N T E N T S
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E v
vi I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
INTRODUCTION
Introduction
Integration Manager for Microsoft Dynamics® GP is a data integration software tool
that you can use to extract, transform, validate, and transfer data among your
business applications, so that you won’t need to re-key data. Integration Manager
provides a cost-effective way to integrate data without a need for specialized
knowledge of databases or programming interfaces.
• Part 2, Building and running integrations, explains how to create and run
integrations. It also contains information about troubleshooting integration
problems.
• Part 4, Adapter reference, describes the adapters that can be used with
Integration Manager and contains a destination reference for each adapter.
Some features described in this documentation are optional and can be purchased
through your Microsoft Dynamics GP partner.
To view information about the release of Integration Manager that you’re using and
which adapters are installed, choose Help > About Integration Manager.
2 IN T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
IN T RO D U C T IO N
Prerequisites
This manual assumes that you are familiar with Microsoft Dynamics financial
applications. Experience working with data in tabular format is also helpful.
If you intend to use the advanced capabilities of Integration Manager, then you
should know how to set up an ODBC data source and issue queries using SQL
statements.
Symbol Description
The light bulb symbol indicates helpful tips, shortcuts and
suggestions.
This manual uses the following conventions to refer to sections, navigation and
other information.
Convention Description
Creating a batch Italicized type indicates the name of a section or procedure.
File >> Print or File > The (>>) or (>) symbol indicates a sequence of actions, such as
Print selecting items from a menu or toolbar, or pressing buttons in
a window. This example directs you to go to the File menu and
choose Print.
TAB or ENTER All capital letters indicate a key or a key sequence.
Contents
Opens the Help file for the active Microsoft Dynamics GP component, and displays
the main “contents” topic. To browse a more detailed table of contents, click the
Contents tab above the Help navigation pane. Items in the contents topic and tab
are arranged by module. If the contents for the active component includes an
“Additional Help files” topic, click the links to view separate Help files that
describe additional components.
To find information in Help by using the index or full-text search, click the
appropriate tab above the navigation pane, and type the keyword to find.
To save the link to a topic in the Help, select a topic and then select the Favorites tab.
Click Add.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 3
I N T R O D U C T I O N
Index
Opens the Help file for the active Microsoft Dynamics GP component, with the
Index tab active. To find information about a window that’s not currently displayed,
type the name of the window, and click Display.
Lookup
Opens a lookup window, if a window that you are viewing has a lookup window.
For example, if the Checkbook Maintenance window is open, you can choose this
item to open the Checkbooks lookup window.
Printable Manuals
Displays a list of manuals in Adobe Acrobat .pdf format, which you can print or
view.
What’s New
Provides information about enhancements that were added to Microsoft Dynamics
GP since the last major release.
To send comments about specific topics from within Help, click the Documentation
Feedback link, which is located at the bottom of each Help topic.
Note: By offering any suggestions to Microsoft, you give Microsoft full permission to use
them freely.
4 IN T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
PART 1: GETTING STARTED
Part 1: Getting started
Use this part of the documentation to learn how to install and start Integration
Manager. If you are new to Integration Manager, you might want to follow the steps
outlined in the Integration Manager Quick Start guide to familiarize yourself with
Integration Manager.
6 IN T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Chapter 1: Integration Manager overview
This part of the documentation includes some of the common terminology used in
Integration Manager. Before you begin using Integration Manager, you should
familiarize yourself with the terminology used throughout the product to have a
better understanding of the integration process.
• Integration Manager
• Source
• Source adapters
• Integration Manager engine
• Destination
• Destination adapters
• Destination mappings
• Query
• Query relationship
Integration Manager
Integration Manager provides you with a safe and easy way of integrating data
between business applications. Integrating data involves extracting data from
source applications or databases and bringing the data into a destination. You can
integrate data from external business databases, e-commerce solutions, or other
data file types into the Microsoft Dynamics GP application.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 7
PA RT 1 G E TT I N G S T A R TE D
Source
A source indicates where the information to be integrated comes from. In
Integration Manager, a source can be anything from a comma- or tab-delimited file,
or a database such as an Open Database Connectivity source (ODBC). Sources exist
independently of the source adapters. Refer to Chapter 5, “Adding sources,” for
more information.
Source adapters
Source adapters connect to sources, and filter and extract data. The data is passed
on to the Integration Manager engine for processing.
Destination
A destination indicates where to integrate the processed information. A destination
can be an application or database. Destinations exist independently of the
destination adapters. Microsoft Dynamics GP is an example of a destination.
Destination adapters
Destination adapters validate data before integrating it to the destination
application, database, or file. If you do not have a destination adapter installed, you
won't be able to select a destination.
8 IN T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 1 IN T E G R A T IO N M A N A G ER O V E R V I E W
Destination mappings
Destination mappings define how source data is mapped to the destination.
Typically, the information comes from the source you specified, but it also can come
from a constant value or default value in the destination. The integration mapping
includes several rules you can use when creating a destination mapping.
Query
A query is a request for information. In Integration Manager, queries are used to
refer specifically to requests for information from a text file or ODBC source. You
can create several queries when using ODBC/text as your source.
Query relationship
When you specify more than one ODBC/text source, you create several queries, as
well. You need to create a query relationship between these queries. This
relationship tells Integration Manager how the queries work together during the
integration. For more information about creating query relationships, refer to
Chapter 6, “Creating query relationships.”
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 9
10 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Chapter 2: Installing Integration Manager
This information will guide you through the steps you need to complete to install
Integration Manager, and includes the information you need to know before you
begin using Integration Manager.
• System requirements
• Integration Manager installation requirements
• Integration Manager user information
• Uninstalling previous versions of Integration Manager
• Installing Integration Manager
• Registering Integration Manager
• Storing registration keys in the Microsoft.Dynamics.GP.IntegrationManager.ini file
• Security requirements
• User security
• Security considerations for integrations
• Uninstalling the current version of Integration Manager
• Repairing your Integration Manager installation
System requirements
System requirements, including which operating systems are supported, are
available at the following site. The requirements for Integration Manager will be the
same as the requirements listed for Microsoft Dynamics GP, unless otherwise noted.
http://go.microsoft.com/fwlink/?LinkId=249465
You should verify that all system requirements are met before installing Integration
Manager.
Microsoft Dynamics GP
If you are using the Microsoft Dynamics GP destination adapter, you must install
Microsoft Dynamics GP before you install Integration Manager. If you select to
install the Microsoft Dynamics GP destination adapter when Microsoft Dynamics
GP isn’t installed, a message appears.
eConnect
You must install eConnect before you can install the Microsoft Dynamics GP
eConnect destination adapter.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 11
PA RT 1 G E T TI N G S TA R T E D
Readme
Refer to the Readme file (IMReadme.rtf) for last minute changes.
1. If you’re using Windows Vista® or Windows Server 2008, choose Start >
Control Panel > Programs > Programs and Features.
If you’re using Windows 7 or Windows Server 2008 R2, choose Start > Control
Panel > Uninstall a program.
12 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 2 I N S TA LL IN G I N T E G R A T IO N M A N A G E R
3. Click Remove.
2. From the Microsoft Dynamics GP media, double-click the Setup.exe file to open
the installation window.
The installation program verifies that your system has the minimum operating
system required to run Integration Manager for Microsoft Dynamics GP 2013. If
your system does not meet requirements, the installation will not continue.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 13
PA RT 1 G E T TI N G S TA R T E D
7. In the Select Features window, indicate where to install the Integration Manager
engine and adapter files and click Next to continue.
8. The Ready to Install window opens. Click Install to start the installation. Click
Back to review your settings and make corrections as necessary.
10. The next time someone launches Microsoft Dynamics GP, a message appears.
The message may indicate that new code must be included or that the
dictionary needs to be un-chunked. Click Yes.
11. If you backed up your Integration Manager database file before the installation,
move that file into the destination folder you specified during installation.
You also can change the location of your default Integration Manager database file by
choosing Tools > Options in Integration Manager. The Options window opens, and
you can enter the default Integration Manager database path on the General tab. If you
do not have a default Integration Manager database, the Select Database window opens,
where you can select a database.
14 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 2 I N S TA LL IN G I N T E G R A T IO N M A N A G E R
Use the following procedure to register Integration Manager using the Integration
Manager Registration window.
– Or –
2. In the Integration Manager Registration window, enter the site name exactly as
it appears in your registration keys.
3. Enter the unique set of registration keys you were given when you purchased
Integration Manager and click OK.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 15
PA RT 1 G E T TI N G S TA R T E D
The IM Registration Utility window opens. Note that the default location points
to where Integration Manager is installed and the default file name is
IMReg.xml.
6. On the message that appears, which explains that the registration entries file
has been created, click OK.
7. Copy the file that you just created to each workstation that has Integration
Manager installed and put it in the Integration Manager application directory.
Registration settings will be imported the next time you start Integration
Manager.
The first time a user starts Integration Manager, the software looks for a file named
Microsoft.Dynamics.GP.IntegrationManager.ini in the folder where Integration
Manager is installed. If it finds an Microsoft.Dynamics.GP.IntegrationManager.ini
file, then it uses the settings that are stored there to override some of the default
behaviors in Integration Manager.
16 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 2 I N S TA LL IN G I N T E G R A T IO N M A N A G E R
For example:
[IMRegistration]
SiteName=Fabrikam, Inc.
Key1=H94KDFJ9009SDF
Key2=J90DF75KDLK0
Key3=LSDKJAF92348UL
Key4=F98
Security requirements
There are certain items that only the system administrator has access to. If you are
not the administrator of the workstation, you can run Process Monitor to see what
items you do not have security access to. Process Monitor is a Sysinternals product.
Refer to the Sysinternals Web site (http://technet.microsoft.com/en-us/
sysinternals/default.aspx) for additional information.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 17
PA RT 1 G E T TI N G S TA R T E D
You must have security access to all of the windows in the destination that you are
importing into. All of the buttons and other windows that can be opened from the
destination window need to have security granted to the user that is running the
integration.
Data can only be imported into the standard Microsoft Dynamics GP windows.
Integration Manager cannot import data into any modified windows or third party
products.
User security
If the Integration Manager option is not available in Microsoft Dynamics GP
(Microsoft Dynamics GP menu > Tools > Integrate > Integration Manager), either
you have not registered Integration Manager or you do not have the proper user
security settings. For more information about registering Integration Manager, refer
to Registering Integration Manager on page 15. For more information about user
security settings, refer to your System Setup Guide (Help > Contents > select
Setting Up the System).
18 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 2 I N S TA LL IN G I N T E G R A T IO N M A N A G E R
Command line integrations If you run integrations from the command line
and create a login macro, note that the macro will need to store a User ID and
Password to launch Microsoft Dynamics GP. Be extremely cautious in who has
access to the directory location where the macro is stored. For more information, see
Recording the login macro on page 107.
Rule properties for override fields If you set up rules that allow a value to be
overridden, and if your company’s business practices require that a password be
entered to override that value, Integration Manager can store the appropriate
password. Be extremely cautious in who has access to the integrations that have this
capability. For more information, see Chapter 19, “Adapters and Destination
Mappings.”
2. Close all programs that are running, including those in the system tray.
3. From the Microsoft Dynamics GP media, double–click the Setup.exe file to open
the installation window. Click Integration Manager > Install.
— Or —
If you’re using Windows Vista or Windows Server 2008, choose Start > Control
Panel > Programs > Programs and Features.
If you’re using Windows 7 or Windows Server 2008 R2, choose Start > Control
Panel > Uninstall a program.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 19
PA RT 1 G E T TI N G S TA R T E D
2. From the Microsoft Dynamics GP media, double–click the Setup.exe file to open
the installation window. Click Integration Manager > Install.
— Or —
If you’re using Windows Vista or Windows Server 2008, choose Start > Control
Panel > Programs > Programs and Features.
If you’re using Windows 7 or Windows Server 2008 R2, choose Start > Control
Panel > Uninstall a program.
20 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Chapter 3: Using Integration Manager
This information describes how to start Integration Manager and how to use the
elements of the Integration Manager workspace. It includes the following
information.
In order to run integrations, you must have administrative privileges on the workstation. If
you are not the administrator of the workstation, you can run the RegMon or FileMon
applications to see what items you do not have security access to.
You also can use the shortcut command ALT+F12 to launch Integration Manager
from Microsoft Dynamics GP.
3. If you do not have a default Integration Manager database, the Select Database
window opens. Use this window to select the database you want to open. You
also can mark the Set as default database option.
If the Integration Manager menu item is not available on the Tools menu in
Microsoft Dynamics GP, check with your system administrator to be sure you have
access to Integration Manager.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 21
PA RT 1 G E TT I N G S T A R TE D
3. In the Adapter Data pane, expand Destinations and Sources. All the adapters
you installed are listed. Expand each adapter that you installed. If an adapter is
not installed properly, a message appears.
The following areas are displayed in the message dialog if you decide to show
details of the error.
Call Stack Displays a trace of the method calls. You can use this trace to follow
the execution path to the line number in the method where the exception occurred.
Data Displays parameters, key values, and field names if there are issues with
data assignments or conversion issues.
22 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 3 U S I N G I N T E G R A T I O N M A N A G E R
2. Browse to the location where you want to save your new database and enter a
name for the new database.
We recommend creating new databases outside of the root directory. For example, if
your root directory is located at C:/Programs/Microsoft Dynamics/Integration
Manager, you could save your database to C:/Programs/Microsoft Dynamics/
Integration Manager/Data.
3. Click Create.
4. Click OK to the message that appears telling you that the database has been
created.
Converting a database
Use the Database Conversion window to convert a database from a previous
version of Integration Manager to an Integration Manager 2013 database.
To convert a database:
1. Open the Database Conversion window.
(Tools > Convert Database)
2. Click Select Database. Browse to the location of the database to convert and
select the database.
3. Click Open.
4. Click Convert Database. The database is converted and a check mark is added
to each step when the conversion for that step is completed successfully. The
new file (Converted_<Name of database>) and a log file (Converted__<Name
of database>.log) are saved to the same folder location as the original database.
If any of the steps in the list were not completed or converted successfully, a warning
icon is displayed by that step. Click the warning icon to find out why the step was not
converted successfully. You can view the log file (Converted__<Name of database>.log)
to find out more information about a conversion that was not completed successfully.
Contact Microsoft Dynamics GP support for more information.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 23
PA RT 1 G E TT I N G S T A R TE D
6. When you are finished, click Close to close the Database Conversion window.
You can click on the converted database file to open Integration Manager.
• Change the file extension. You can change the file extension to .mdb.
If the file extension is .imd, you can double click the file to open your
Integration Manager database. If you change the extension to .mdb, you’ll
need to open the database file from Integration Manager.
Menu
Toolbar
24 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 3 U S I N G I N T E G R A T I O N M A N A G E R
You’ll use the menu commands and toolbar buttons to complete your tasks. See
Integration Manager toolbar on page 25 and Integration Manager menus on page 26 for
more information.
Button Description
Create a new integration.
Print a report of the integration. You can print reports of other items in the
integration using the Object Browser window.
Add a source to the current integration. Which sources you can add depends on
which adapters are installed. If you do not have any adapters installed, you can
add only text or ODBC source queries.
Open the Relationships window, where you create relationships between text or
ODBC source queries.
Add a destination to the current integration. Which destinations you can add
depends on which adapters are installed.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 25
PA RT 1 G E TT I N G S T A R TE D
The following table provides the menu commands with their corresponding
descriptions and access keys (if available). Access keys are keyboard shortcuts. They
are underlined and used in conjunction with the ALT key.
26 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 3 U S I N G I N T E G R A T I O N M A N A G E R
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 27
PA RT 1 G E TT I N G S T A R TE D
The following table contains the access keys assigned to common buttons in the
Integration Manager windows.
Apply ALT+A
When a window for Integration Manager is open, you also can press the F1 key to access the
online help.
The following table contains a list of the shortcut keys for commonly used menu
commands.
Print CTRL+P
Mapping CTRL+M
Run CTRL+R
28 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
PART 2: BUILDING AND RUNNING INTEGRATIONS
Part 2: Building and running
integrations
This part of the documentation describes the components of an integration and
explains how to create them. The information is presented in the order in which you
typically build an integration. Step-by-step procedures are included. Refer to these
procedures when you build your own integrations.
• Chapter 6, “Creating query relationships,” explains why you may need query
relationships, and how to create them.
• Chapter 7, “Data types,” describes how to select the most appropriate data
types for source queries.
30 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Chapter 4: Creating integrations
The first step in the integration process is to create the integration that contains the
source and destination information. You can either define a new integration or use
an existing integration.
Step Description
Step 1 Create the integration
Step 2 Add a source
Step 3 Create query relationships (if necessary)
Step 4 Add a destination
Step 5 Create destination mappings
Step 6 Save the integration
Step 7 Run the integration
Step 8 Examine the integration results
• Parts of an integration
• Overview of building and running an integration
• Creating a new integration
• Using an existing integration
Parts of an integration
The process of extracting data from source applications or databases and bringing
the data into a destination is called an integration. Integration Manager provides
you with a safe and easy way of integrating data between business applications.
You can integrate data from external business databases, an e-commerce solution, or
other data file types into the Microsoft Dynamics GP application.
• Sources include the data to integrate into a destination. Source data can
originate from text files, ODBC databases, and XML files. With Integration
Manager, you can integrate text and ODBC source data. You also may integrate
source data from XML files.
• The destination mapping indicates where each item from your source data goes
in the destination.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 31
PA RT 2 B U I L D I N G A N D R U N N I N G I N T E G R A TI O N S
To guide you through the process, the Integration window shows the parts of an
integration that you need to set up.
An integration is
made up of
several parts.
Step Description
Step 1 Create an integration that contains the source and destination information.
You can either define a new integration or use an existing integration. For
more information, refer to Chapter 4, “Creating integrations.”
Step 2 Add a source, which indicates where information for the integration
originates. For more information, refer to Chapter 5, “Adding sources.”
Step 3 Create query relationships (if necessary). If you are using more than one text
or ODBC source to provide information for the integration, you need to create
relationships between the source queries. For more information, refer to
Chapter 6, “Creating query relationships.”
Step 4 Select the destination for the extracted source information. For more
information, refer to Chapter 8, “Adding a destination.”
Step 5 Create destination mappings which indicate where each item in the
integration destination originates. For more information, refer to Chapter 9,
“Creating mappings.”
Step 6 Save the integration. You should save the integration periodically as you build
it.
Step 7 Run the integration to bring data into your selected destination, For more
information, refer to Chapter 10, “Running integrations.”
Step 8 Examine the integration results after the integration has finished running. For
more information, refer to Evaluating integration results on page 82.
32 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 4 C R E A T I N G I N T E G R A T I O N S
The Integration window opens, and the Properties window for the integration
opens.
Use any integration name that helps you and others easily identify the
integration.
The integration description can provide information about the integration, such
as a short description of the source and the destination, as well as a date or a
time interval such as “monthly” or “daily.”
If you plan to add a text or an ODBC source, don’t use ODBC reserved words in
the column names for the ODBC source or destination. These words can
prevent the integration from running properly. For a list of ODBC reserved
words, go to http://msdn.microsoft.com and search for “ODBC Reserved
Words”. You’ll find a list of reserved keywords in Appendix C of the ODBC
Programmer’s Reference.
You do not need to define the other properties on the General tab until later. In fact, you
can’t define some of them, such as the destination edit mode, until you add a destination
to the integration. From the Properties window, you also can add scripts to the
integration (see Chapter 20, “Using scripts”) and set properties for the integration log
(see Chapter 14, “Managing logs”).
If you are using a master level destination, select a destination edit mode in the
Integration Properties window (Integration > <integration name> Properties)
before you save the integration. See Chapter 10, “Running integrations,” for
information about setting the destination edit mode.
4. Choose File > Save Integration to save the integration. You also may want to
make a backup of the Integration Manager database file to protect against
losing the integrations you created.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 33
PA RT 2 B U I L D I N G A N D R U N N I N G I N T E G R A TI O N S
Integrations are stored in a database file. You can specify the location of the
Integration Manager database file using the Options window. Choose Tools >
Options to open the Options window.
If you are creating an integration that is similar to an existing integration, you may
want to start with a copy of the existing integration rather than creating the
integration from scratch.
34 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 4 C R E A T I N G I N T E G R A T I O N S
If the integration you opened is complete and you are ready to run it, refer to
Chapter 10, “Running integrations.”
3. To make a copy of this integration, choose File > Import Integrations or Export
Integrations.
If you are importing the integration, refer to Importing integrations on page 91.
If you are exporting the integration, refer to Exporting integrations on page 91.
This creates another integration that contains the same source and destination.
You will be prompted to rename the integration name and integration source
names if you are importing into the same Integration Manager database file.
If you are using a master level destination, select a destination edit mode in the
Integration Properties window (Integration > <integration name> Properties)
before you save the integration. See Chapter 10, “Running integrations,” for
information about setting the destination edit mode.
5. Choose File > Save Integration to save the integration. You also may want to
make a backup of the Integration Manager database file to protect against
losing the integrations you created.
Integrations are stored in a database file. You can specify the location of the
Integration Manager database file using the Options window. Choose Tools >
Options to open the Options window.
If you are ready to run your integration, refer to Chapter 10, “Running
integrations.”
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 35
36 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Chapter 5: Adding sources
The next step in setting up your integration is to add your source.
Step Description
Step 1 Create the integration
Step 2 Add a source
Step 3 Create query relationships (if necessary)
Step 4 Add a destination
Step 5 Create destination mappings
Step 6 Save the integration
Step 7 Run the integration
Step 8 Examine the integration results
When you add a source to an integration, you are defining which data from your
source to later integrate into a destination. With Integration Manager, you can
integrate source data from text files, XML files, or ODBC sources.
• Understanding sources
• Understanding sources
• Adding sources to an integration
• Using ODBC and text sources
• Adding text sources
• Adding simple ODBC sources
• Setting up general properties for text sources
• Setting up general properties for ODBC sources
• Setting additional properties for ODBC or text sources
• Understanding the XML source adapter
• Setting up XML source definitions
• Using a template for XML source definitions
• Editing XML source definitions
• XML source settings
• Defining XML source settings
• Previewing sources
• Removing a source from an integration
• Query relationships
Understanding sources
A source indicates where the requested information you are integrating originates.
In Integration Manager, a source can be a comma- or tab-delimited file, XML file, or
a database such as an ODBC source. Sources exist independently of the source
adapters; however, the sources you can add to your integration depend on the
source adapters you have installed.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 37
PA RT 2 B U I L D I N G A N D R U N N I N G I N TE G R A T I O N S
The ODBC/text adapter extracts data from ODBC and text sources. Integration
Manager supports three types of ODBC/text sources: Text, Simple ODBC, and
Advanced ODBC. Text sources retrieve data from text files. Simple ODBC sources
retrieve data from an ODBC data source. Advanced ODBC sources issue SQL
statements from SQL Server to retrieve information from an ODBC data source.
SOURCES
SO U R C E
SOURCES AD APT ER
SOURCES
Integration M anager engine
You also can right-click on the Sources item in the Integration window, and from the
menu that appears, click Add Source.
Define a new
source or select
from the
existing sources
to add to your
integration.
38 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 5 A DD IN G S O U R C E S
4. From the Sources pane, select the name of the source or, if available, click
Define New Source, and click Open.
The window that opens next—a Properties window, a Source Settings window,
or no window—depends on which source adapter and source you are using.
• No window opens if you select a source with properties that are already
defined.
For more information about adding text and ODBC sources, see Using ODBC
and text sources on page 39.
For more information about setting up XML source definitions, see Setting up
XML source definitions on page 49.
6. If you are adding a source that uses source settings, define them on a Source
Settings window. Source settings connect the actual source to the source adapter
in Integration Manager. These settings include, but are not limited to, File Path,
Filter, Use Filter, User Name, and Password. For more information about
specifying XML source settings, refer to XML source settings on page 51.
After you select a source and, if necessary, set up source definitions and source
settings, the source appears in the Integration window, and you can continue to
build your integration.
You can drag a source file from the desktop or Windows Explorer onto the Integration
Manager workspace and the Integration Source Properties window automatically
opens. For the new source, the default Delimiter setting is Comma. Change the
Delimiter and First Row Contains Column Names settings to match the file
information.
Integration Manager can issue queries for text sources (see Adding text sources on
page 40), simple ODBC sources (see Adding simple ODBC sources on page 40), and
advanced ODBC sources (see Chapter 18, “Using advanced ODBC source queries”).
Several of the following topics in this part of the documentation describe how to
create text and simple ODBC sources. Chapter 18, “Using advanced ODBC source
queries,” describes advanced ODBC sources.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 39
PA RT 2 B U I L D I N G A N D R U N N I N G I N TE G R A T I O N S
3. In the Adapters pane of the Add Source window, expand the ODBC/Text folder
and select Text.
4. From the Sources pane, select an existing text source or select Define New Text
and click Open.
If you select an existing source, the source is added to your integration. You
don’t need to set up the source properties.
If you are creating a new source, the Properties window opens, allowing you to
set the properties of the text query. See Setting up general properties for text sources
on page 41.
If you add a text source to an integration that already contains ODBC/text sources, a
message appears reminding you to create a relationship between the sources.
3. In the Adapters pane of the Add Source window, expand the ODBC/Text
folder, and select Simple ODBC.
40 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 5 A DD IN G S O U R C E S
4. From the Sources pane, select an existing Simple ODBC source or select Define
New Simple ODBC and click Open.
If you select an existing Simple ODBC source, the source is added to your
integration. You don’t need to set up the source properties.
If you are creating a new Simple ODBC source, the Properties window opens,
allowing you to set the different properties of the Simple ODBC query. See the
topic Setting up general properties for ODBC sources on page 42.
If you try to add an existing simple ODBC source to an integration that already
contains ODBC/text queries, you are asked to create a relationship between the new and
existing queries.
The name should describe the type of information retrieved by the text query.
An optional description should provide information about the source, such as
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 41
PA RT 2 B U I L D I N G A N D R U N N I N G I N TE G R A T I O N S
what type of data is retrieved by the query or what data is contained in the
source.
Don’t use ODBC reserved words in the source name. They can prevent the integration
from running properly. For a list of ODBC reserved words, go to the MSDN online
library (http://msdn.microsoft.com) and search for “ODBC reserved words”. You’ll find
a list of reserved keywords in Appendix C of the ODBC Programmer’s Reference.
3. In the File field, enter or select the path to the text file that is being used as the
source.
4. Specify the delimiter used for the text file, and whether the first row of the text
file contains column names.
First Row Contains Column Names Select this check box to use the
names in the text file when referring to columns. Otherwise, Integration
Manager provides a set of default names.
After setting up the general properties of the text source, you need to set up the
other source properties. Refer to Setting additional properties for ODBC or text sources
on page 43 for more information. Be sure to save your source when you are finished.
42 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 5 A DD IN G S O U R C E S
The name should describe the type of information retrieved by the ODBC
query. The description should provide information about the source, such as
what type of data is retrieved by the query or what data is contained in the
source.
Don’t use ODBC reserved words in the source name. They can prevent the integration
from running properly. For a list of ODBC reserved words, go to the MSDN online
library (http://msdn.microsoft.com) and search for “ODBC reserved words”. You’ll find
a list of reserved keywords in Appendix C of the ODBC Programmer’s Reference.
3. On the General tab of the Properties window, select the data source and table
from which the information will be retrieved.
Table This is the table to use from the ODBC data source.
4. If you’re using an .xls file type, enter a named range. Select the data range,
including column headings, and choose Insert > Name > Define. Type the new
name for the reference and click Add.
5. After setting up the general properties of the simple ODBC source, you need to
set up the other source properties. See Setting additional properties for ODBC or
text sources on page 43. Be sure to save your integration when you are finished.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 43
PA RT 2 B U I L D I N G A N D R U N N I N G I N TE G R A T I O N S
If you are creating a text source and the text file does not contain column names,
you may want to edit the column names to make them more meaningful.
If you rename any of the column names, you must rename all of the column names in
order for the integration to be successful.
Column Name These are the names of the data items that are available for
the source. If you marked the option indicating that the first row of the text file
contained column names, those names appear here. If the text file does not
contain column names, Integration Manager supplies its own names. You can
edit the column names to make them more meaningful.
Don’t use ODBC reserved words in the source name. They can prevent the integration
from running properly. For a list of ODBC reserved words, go to the MSDN online
library (http://msdn.microsoft.com) and search for “ODBC reserved words”. You’ll find
a list of reserved keywords in Appendix C of the ODBC Programmer’s Reference.
Datatype This value indicates what type of data is contained in the column.
If you are creating a text source, Integration Manager examines the data in the
text file and provides a default value. If you’re using a simple ODBC data
source, the data type value is automatically retrieved from the ODBC data
source and can’t be changed.
Column names and the data types you have chosen are stored in the Schema.ini file,
which is in the same location as the text file.
You can change the value in the Datatype column, based on the type of data in
the text file and how the information is used in the destination of the
integration. Refer to Chapter 7, “Data types,” to help determine the most
appropriate data type for each column in the text file.
Size If you are creating a simple ODBC source, the Size column indicates the
data size of each column, in bytes. You can’t edit this value.
Show Select the Show check box to include the data in this column in your
integration. If you are using a large source file and you do not want all the data
to integrate, clear this check box for the columns to exclude.
Is Key Select the Is Key check box to indicate that the data items within a
column are unique identifiers. For example, you might select a column called
Customer ID as Is Key to indicate that the values within a column are unique.
44 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 5 A DD IN G S O U R C E S
Integration Manager uses the values selected as Is Key to identify specific rows that
cause errors in the integration.
You don’t need to select this check box for any columns.
If the properties of the text file or the ODBC data source used for the source have
changed, click the Refresh Columns button to update the columns list.
2. Choose the Filter tab to display the restriction criteria for the source (optional).
Restrictions allow you to specify the rows that will be included in the source.
All rows that do not fit the criteria are excluded from the source results.
The LIKE operator allows you to perform basic pattern matching with string
data types. You can use the percent sign (%) as a wildcard character,
representing any sequence of characters. The percent sign can be used multiple
times within a single string. For example, to include all customers whose names
include the word “ACME”, the expression would be similar to the following:
To exclude all rows where a particular field is blank, use a single wildcard character. For
example, to exclude all customers where the “CustomerName” field is blank, the
expression would be similar to the following:
CustomerName <>0.
3. Choose the Sorting tab to specify sorting and grouping information for the
source.
By adding columns to the Order By list, you indicate the order rows should
appear in the source. Individual columns can be sorted in ascending or
descending order. Specifying a sort order is needed when the data in the source
text file is not in the desired order. This is useful for integrations such as General
Ledger transactions, where the order in which items are added is important.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 45
PA RT 2 B U I L D I N G A N D R U N N I N G I N TE G R A T I O N S
To remove a column from the list, click the line selection button (to the left of the item) to
select the entire line, and press Delete.
The Group By list allows you to “collapse” the rows in the source that have
identical values for corresponding columns. To compare values, specify the
columns containing the values by adding them to the Group By list. These
columns must also have the Show option marked in the Columns tab. When
the rows are collapsed, only one row is included in the source results for any
group of rows for which all of the selected columns match.
If you group the items in a source, only columns included in the group are included in
the source results. No other columns are included in the source results.
Grouping is typically used when you have header information and line item
information in a single source file. For example, General Ledger transactions are
composed of a transaction header and line items. The transaction header
contains the transaction date and reference. The line items contain information
for each item in the transaction.
46 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 5 A DD IN G S O U R C E S
To get the transaction header information from the text file, the items in the file
need to be “collapsed.” Each transaction is uniquely identified by the
transaction date and reference, but several linesin the text file have the same
transaction date and reference. To collapse the file, the Trx Date and Reference
columns are added to the Group By list. The results of the source are shown in
the following illustration.
The results contain only one row for each unique transaction date and reference
combination. The only columns included in the source results are those in the
Group By list.
5. After you set up properties for the text or simple ODBC source query, click OK.
The source you created is added to the Integration window.
Be sure to save your source after setting the source properties. From the File menu, click
Save Integration.
You will see how Integration Manager uses this document definition later when you
map the source to a destination. In the meantime, the following example shows how
the XML source adapter converts XML for Integration Manager. You can use the
table at the end of the example as a reference when you specify properties in the
XML Source Definition window.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 47
PA RT 2 B U I L D I N G A N D R U N N I N G I N TE G R A T I O N S
<Orders>
<Orders>
<Name>My Order</Name>
<OrderNumber>123</OrderNumber>
<CreditCard>
<Type>americharge</Type>
<exp>05/01/07</exp>
<Number>1234112233224455</Number>
</CreditCard>
<Item>
<Name>T-Shirt</Name>
<size>Medium</size>
<price>12.99</price>
</Item>
</Orders>
</Orders>
The following table shows how Integration Manager interprets XML. The second
and fourth columns include information from the previous example.
48 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 5 A DD IN G S O U R C E S
The root recordset is not necessarily the root element in the XML source file. Instead, the
XML source adapter looks for the first XML element that matches the value of the root
recordset’s XML Node as defined in the XML Source Definition window. In the previous
table, the display name of “Order” (in the fourth column) matches the XML root element
name of “Order.” You can change the display name of the root recordset, other recordsets,
and fields in the XML Source Properties window.
– Or –
The root recordset represents the object that contains the entire source
document definition, including the root recordset and its properties, all child
recordsets of the root and their properties, and all fields within all recordsets
and their properties. The following table describes the components and
properties of a root recordset.
Properties Description
Display Name The name of the Root Recordset. Use any name that is
appropriate for the source you are defining. Typically, this is
the name of the object that this Root Recordset represents.
XML Name The name of the source document definition that you are
setting up. This name appears in the Add Source window. Use
any name that helps you easily identify this source document
definition.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 49
PA RT 2 B U I L D I N G A N D R U N N I N G I N TE G R A T I O N S
Properties Description
Display Name The name of the recordset. Use any name that is appropriate
for the source you are defining.
XML Name The name of the XML node in the source document that this
recordset represents. This name must match the one in the
source.
Properties Description
Display Name The name of the field.
XML Name The name of the XML name in the source document that this
field represents. This name must match the one in the source.
Data Type The type of data this field contains, such as String, Boolean,
Currency, Date, Double, or Long Integer. Click the drop-down
arrow in this field to select an appropriate data type.
Key Field Click Yes to indicate that the field contains unique identifiers.
5. When you are finished, you can save or close the window.
To set the XML source definitions, use the Template button on the XML Source
Definition window. The template approximates the structure of an XML source that
you select and converts it into recordsets and fields—a structure Integration
Manager can use.
When using the template, you select an XML data file. To quickly approximate the
source structure, the XML source adapter scans only the first few records of the
XML source you selected, making the template a convenient tool for starting the
document definition process.
50 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 5 A DD IN G S O U R C E S
2. From the Open window, select the XML data file that uses the structure you
want to use in the XML Source Definition window and then click Open.
The file you select does not need to be the file you use as your source. It simply needs to
represent the same data structure as your source. Later, when you specify source
settings, you set the path and file name of the actual source.
After you click Open, the XML Source adapter approximates the structure of
the data, converts it into a hierarchy of recordsets and fields, and then displays
this new structure in the XML Source Definition window.
The default value for Data Type is “String,” and the default value for Key Field
is “No.” You may want to change these default values, especially for Data Type.
See Setting up XML source definitions on page 49 for more details.
The Source Settings window opens if you are assigning the XML source to an
integration. You can use this window to connect this document definition to the
source containing the data to integrate. At this point, you are no longer setting
properties that are attached to the source. Source Settings are properties of the
integration. See XML source settings on page 51 for more information.
The XML Source Definition window opens so that you can make the necessary
changes.
There are additional properties relating to a source that are associated with the
individual integration. These properties are not automatically inherited by other
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 51
PA RT 2 B U I L D I N G A N D R U N N I N G I N TE G R A T I O N S
integrations that use the same source document definition. These additional
properties are called source settings.
The Source Settings window automatically opens when you first add a new or
existing XML source definition to an integration.You can use this window to
specify the physical data file to be used for the integration. If you already added
a source to the integration, you can double-click Source Settings in the
Integration window.
2. Click in the Value column next to File Path, and then click the Lookup (...)
button. The Open dialog box opens.
3. Navigate to the source file and select it. Then, click Open. You also can type or
paste the path and file name.
By specifying a file path in the Source Settings window, you are connecting the
document definition of the source to the actual source.
Previewing sources
Before you run an integration, it’s useful to know that the source you have created is
returning the data you expect.
To preview a source:
1. From the Integration window, right-click the source to preview.
52 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 5 A DD IN G S O U R C E S
Depending on which type of source you are previewing, either the Data Viewer
or the Source Preview window opens. For those source adapters that use source
settings, you can preview the source only if you have specified accurate settings
on the Source Settings window.
3. Examine the data returned by the source to verify that the source is working
properly. If you are using a text or ODBC source, search for empty fields or
incorrectly formatted data, such as account numbers that have characters
missing, and check that the data types are appropriate. See Chapter 7, “Data
types,” for more information about selecting the appropriate data types.
You also can select the source to remove and press the Delete key.
Query relationships
When you use ODBC and text sources, Integration Manager issues queries to the
sources to retrieve the source data. When you use more than one ODBC or text
source in an integration, you need to create relationships among the sources. The
relationships tell Integration Manager how the various queries to the sources
should work.
For more information about how to set up query relationships, refer to Creating
query relationships on page 55.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 53
54 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Chapter 6: Creating query relationships
When you use ODBC and text sources in your integration, Integration Manager
issues queries to the sources to retrieve the source data. When you use more than
one ODBC or text source in an integration, you need to create relationships among
the sources. The relationships tell Integration Manager how the various queries to
the sources should work.
Step Description
Step 1 Create the integration
Step 2 Add a source
Step 3 Create query relationships (if necessary)
Step 4 Add a destination
Step 5 Create destination mappings
Step 6 Save the integration
Step 7 Run the integration
Step 8 Examine the integration results
• Relationship guidelines
• Creating query relationships
• Removing query relationships
Relationship guidelines
When creating query relationships, keep the following guidelines in mind.
• There must be only one “root” query that has no arrows pointing into it. This is
the main query that is executed. All other queries must be related to the “root”
query in some way.
• You can link one query to another using more than one column.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 55
PA RT 2 B U I L D I N G A N D R U N N I N G I N T E G R A TI O N S
3. Examine the queries you are using for the integration. Decide which query is
considered the “root” and which queries are considered child queries.
Remember that each query must be directly or indirectly connected to the root.
No query or group of queries can remain unconnected.
For example, two queries are used to retrieve bank transaction information.
One query retrieves basic information, including checkbook ID, number, and
amount. The other retrieves line detail information. To allow Integration
Manager to work with both queries, a relationship must be created between
them. In this case, the BR TRX Header query would be considered the master.
Each time Integration Manager reads a record from this query, the
corresponding record should be read from the BR TRX Line query.
To set up this relationship, you need to draw a line between the corresponding
columns in the two queries. In this case, the corresponding column is Index
Number. You can resize the window to show more of the query information.
To improve the performance of your integration, we recommend that you sort the
queries based on the columns used for the query relationship. To sort the queries, open
the Properties window for the source, and choose the Sorting tab.
56 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 6 C R E A TI N G Q U E R Y R E L A T I O N S H I P S
5. To set the relationship type, right-click the line connecting the two queries and
choose Properties.
The relationship type indicates how many records exist in the child query for
each record in the master. The four types of query relationships are summarized
in the following table.
Type Description
1 There are zero records or one record in the child for each record in the
master.
2 There is exactly one record in the child for each record in the master.
3 There can be zero or more records in the child for each record in the
master. This is the default relationship type.
4 There must be at least one record in the child for each record in the
master.
The default relationship type is 3, indicating there are zero or more records in the child
query for each record in the master.
7. Click Close to close the Relationships window. When you close the
Relationships window, all of the relationships you created are verified. If any
problems exist, a message appears. Reopen the Relationships window and
correct any problems.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 57
PA RT 2 B U I L D I N G A N D R U N N I N G I N T E G R A TI O N S
2. Select the relevant fields and right-click the line between the two queries.
3. Click Remove.
58 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Chapter 7: Data types
When adding source queries to your integrations, use the following information to
help you select the most appropriate data type.
Data type
Boolean Destination Object Boolean
Type
Acceptable Data Boolean, Byte, Integer, String
types
Preferred Data type Boolean
Additional If using Boolean as the data type, the following
information values are Acceptable as true or false:
TrueFalseTrueFalse
TFYN
tfyn
TrueFalseYesNo
TRUEFALSEYESNO
10Non-zero0
Currency Destination Object Currency
Type
Acceptable Data Currency, Double, Single, String
types
Preferred data type Currency
Additional If the currency data in the text file is formatted, for
information example, if it has a dollar sign ($), you must use a
Currency data type.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 59
PA RT 2 B U I L D I N G A N D R U N N I N G I N T E G R A TI O N S
Data type
Date Destination Object Date
Type
Acceptable Data Date, String
types
Preferred data type Date
Additional If you are using date information to restrict the
information source, you must use the Date data type.
60 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 7 DA TA T Y P E S
Data type
Numeric Destination Object Numeric
Type
Acceptable Data Currency, Double, Integer, Long integer, Single,
types String
Preferred data type String
Additional If the numeric data in the text file has more than 6
information significant digits, do not use the Single data type. If
the data has more than 14 significant digits, do not
use the Double data type. Instead, use the
Currency or String data types.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 61
62 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Chapter 8: Adding a destination
After you add a source and, if necessary, specify source settings, you can begin to
add your destination.
Step Description
Step 1 Create the integration
Step 2 Add a source
Step 3 Create query relationships (if necessary)
Step 4 Add a destination
Step 5 Create destination mappings
Step 6 Save the integration
Step 7 Run the integration
Step 8 Examine the integration results
A destination indicates where the information should go. Integration Manager has
destination adapters that validate data before integrating it to the destination
application or database.
Integration Manager can support many destinations. See Chapter 19, “Adapters
and Destination Mappings,” for more information about the specific destination
adapters that are available in Integration Manager.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 63
PA RT 2 B U I L D I N G A N D R U N N I N G I N T E G R A TI O N S
You also can right-click on the Destination item in the Integration window, and choose
Add Destination.
The Adapters pane lists all destination adapters that are available to you. The
destination document definitions for each adapter appear in the Destinations
pane as you select the different adapters. Most destination adapters include
predefined destination document definitions, such as General Journal or
Payables Transaction.
For some adapters, a Destination Settings window opens, where you specify
how the integration connects to the destination application or database. Refer to
Specifying destination settings on page 64 for more information.
If you use an existing destination, be cautious about changing its properties because it
might be attached to other integrations. If you change the properties of a destination in
one integration, you are changing the properties of the destination in all integrations in
which it is being used.
You must add a destination to the integration before you’ll be able to open this window.
Refer to Adding the destination on page 63 for more information.
64 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 8 A DD IN G A DE S T IN A T IO N
The Destination Settings window for each of the destination adapters looks
slightly different, and the settings that you’ll define will differ, depending on
which adapter you’re using.
2. Specify the destination settings by clicking in each field and entering the
appropriate information. After you enter the information, you can click Set As
Default to save these settings. If you choose to do this, the settings you entered
are saved and used in each session. To clear these settings, click Clear Default.
If you need to run an integration for several companies, you can change the destination
settings each time you run that integration, or you can create a separate integration for
each company.
When you close this window, the destination settings are saved with the
integration. To display these settings again, choose Integration > Destination
Settings.
You also can double-click the name of the destination in the Integration window to open
the Destination Properties window.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 65
PA RT 2 B U I L D I N G A N D R U N N I N G I N T E G R A TI O N S
Each attribute has a True or False value. The actions listed in the table are
allowed when the value for each attribute is True.
Attribute Description
Insert Allowed New records can be added to this destination.
Open Allowed Existing records can be opened.
Update Allowed Existing records can be updated by an integration.
Delete Allowed Existing records can be deleted.
Duplicate Keys Allowed Duplicate records can be created in the destination.
Pay particular attention to the Update Allowed attribute. If this value is True, you
can update existing records for this destination type. If the value is False, you can
create new records but can’t update existing ones.
For the Insert Allowed attribute, update functionality is limited to adding new
child records. For example, you can add a new record, but you cannot update
fields in an existing record.
4. Choose the Fields tab to display a list of the fields that are included in the
destination.
5. Select a field in the field list and click Properties to view the properties for the
fields in the destination.
66 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 8 A DD IN G A DE S T IN A T IO N
Be sure to note the fields that are required. When you create the mapping for
your integration, you need to supply a value for each required field.
Data Type The type of data the field contains. The valid types are boolean,
currency, date, enumeration, integer, long integer, numeric, string, and time.
Which data types are valid depends on the type of data.
Size The number of bytes required to store the field. For string fields, it is the
number of characters that can be stored by the field.
Precision The number of digits after the decimal point in numeric fields.
Attributes Indicate how information can be imported into the field. The
following is a list of the common attributes that apply to destination fields.
Attributes Description
Required Indicates that a value must be supplied for the field.
Readonly Indicates that data can’t be imported into the field.
Updatable Indicates whether the existing value in the field can be updated.
Fixed Length Indicates that the value in the field is a fixed length.
Has Default Indicates that the field has a non-blank default value available.
6. When you are finished viewing destination properties, close the window.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 67
PA RT 2 B U I L D I N G A N D R U N N I N G I N T E G R A TI O N S
3. Click Properties.
4. In the properties window for the integration, choose the Other Information tab.
You will learn more about enumerations when you create a mapping for your
integration.
You also can select the desalination and press the DELETE key to remove the destination.
68 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Chapter 9: Creating mappings
After you’ve added a destination, you must map the source data to your
destination.
Step Description
Step 1 Create the integration
Step 2 Add a source
Step 3 Create query relationships (if necessary)
Step 4 Add a destination
Step 5 Create destination mappings
Step 6 Save the integration
Step 7 Run the integration
Step 8 Examine the integration results
When you create the mapping, you will need to set up a rule for each required field
in the root recordset of the destination. You also can set up mapping options.
Required fields and mapping options for each adapter are described in Chapter 19,
“Adapters and Destination Mappings.”
Use the following procedure to map your source data to the destination.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 69
PA RT 2 B U I L D I N G A N D R U N N I N G I N T E G R A TI O N S
The upper left pane of the Integration Mapping window shows the destination
in terms of recordsets. There are three types of recordsets in an Integration
Manager destination: root recordsets, one-to-many child recordsets, and one-to-
one child recordsets.
Root recordset The root recordset is the top level of the destination. For
example, the root recordset of the Customer destination is called Customer and
it contains the Customer ID and Customer Name fields (plus a number of
additional fields). Each destination has only one root recordset.
You need to select a rule for each of the required fields in the root recordset for
the selected destination. Required fields are those fields in a destination
recordset that need to be mapped for the integration to run successfully. Some
of the child recordsets also contain required fields. You do not need to map the
required fields for child recordsets if you do not map any of the other fields in
that recordset.
70 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A PT E R 9 C R E A TI N G M A P P I N G S
2. From the Fields tab, set mapping rules for individual fields.
As you click each row, information about that field is displayed at the bottom of
the Integration Mapping window. This information includes the type of field
(such as String, Numeric, and so on), the field length, and if the field is a
required field.
You also can view the properties for a field in the Integration Mapping window. Right-
click a field and choose Field Properties to view the properties, which helps you
determine the data type, field size, and whether the field is required.
Rule Description
Use Source Field The information for the field originates from one of the sources
that is part of the integration. A Lookup button appears in the
Source column, allowing you to open the Source Object
window and select a field.
Use Constant You can type a value into the Source column. This value is
used for every record created or updated when you run the
integration.
Use System Date For date fields, the field in the destination is set to the system
date.
Use Positive Source Field For debit fields, positive values are imported as they are.
Negative values are imported as zero.
Use Negative Source Field For credit fields, negative values are imported as the
corresponding positive value. Positive values are imported as
zero.
Use Default For newly inserted documents, the default value for that field is
used, as determined by the business logic of the destination
application. When updating existing records, the default value
is typically the value that already exists for the field.
Blank For some string fields, the field in the destination is left blank
when you run the integration.
Use Script You’ll attach a Visual Basic script that runs to provide the value
for the field. Refer to Chapter 20, “Using scripts.”
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 71
PA RT 2 B U I L D I N G A N D R U N N I N G I N T E G R A TI O N S
Rule Description
Use Input Solicits input from a user when the integration runs. When you
use this rule, you can define the prompt in the Rule
Properties section of the Integration Mapping window. If you
do not define the prompt, the default prompt for a string field
is, “Please enter a value for <name of field>.” If the field uses an
enumerated data type, the default prompt is, “Select a value for
<name of field>”, where you can select a value from a list. For
fields that use dates, the prompt will include a Calendar view
from which you can select a date.
The Use Positive Source Field and Use Negative Source Field rules allow you to
use the same source field for both the debit and credit value of a transaction.
3. Click the lookup button in the Source column to select a value for the source.
The Source Object window opens.
4. Choose the name of the source that contains the information to be used for the
field. Choose the name of the field and click Select.
If you chose the Use Source Field rule, you must specify a source for the field.
The item you selected appears in the Source column of the Integration Mapping
window.
You also can drag items from the Source Object window to the Source column in the
Integration Mapping window. The Rule column automatically is set to Use Source
Field and the Source column displays the item you selected.
5. For fields that are not using default values, set the appropriate rule properties.
Some rules have additional properties that you specify in the Rule Properties
section of the Integration Mapping window.
72 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A PT E R 9 C R E A TI N G M A P P I N G S
6. To set the mapping options, choose the destination in the upper-left list in the
Integration Mapping window and choose the Options tab.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 73
PA RT 2 B U I L D I N G A N D R U N N I N G I N T E G R A TI O N S
Some destinations have additional options that you specify on the Options tab.
These options indicate how Integration Manager handles special circumstances
when importing data into a specific destination. Additional mapping options
are listed in Chapter 19, “Adapters and Destination Mappings.”
When you select an option, the properties for that option appear in the Rule
Properties section of the Integration Mapping window. Use these properties to
specify individual options. For more information, refer to Part 4, Adapter
reference.
The default rule for one-to-many child recordsets is Use Default. The first time
you map any field in a one-to-many recordset by setting its mapping rule to Use
Source Field, Integration Manager automatically changes the Record Source
option to Use Source Recordset, and sets the Source Recordset to the
appropriate value.
The Record Source option (which is found on the Options tab of the Integration
Mapping window) specifies which recordsets in the source will be associated
with each recordset in the destination. There are different Record Source
options for the different types of recordsets. See Chapter 19, “Adapters and
Destination Mappings,” for more information.
The root recordset does not have a Record Source option. It is always associated with
the root recordset of the source. For each record in the root recordset of the source, one
record will be created in the destination’s root recordset.
74 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A PT E R 9 C R E A TI N G M A P P I N G S
Option Description
Use Source Recordset Creates one recordset in the destination for each record in the
associated source recordset.
Use Default For newly inserted documents, the default values for the
recordset are used, as determined by the business logic of the
destination application. When updating existing documents,
the default values typically consist of the records that already
exist in that recordset.
Empty No records are integrated to this recordset. If the destination
application contains business logic that typically would
populate this recordset with default data, the default logic is
superseded by the Empty Record Source option, and no
records are created in this recordset for this destination.
Default Non-Imported A default set of records is generated for this recordset, but
some of them may be overwritten by records mapped to this
recordset. For example, if you are integrating to Payables
Transaction and you select the Default Non Imported rule
for the Distributions recordset, a default set of distributions is
created based on the business rules in the destination
application. Typically this would be a debit to the vendor’s
default Purchases account and a credit to the default
Accounts Payable account. Mapping a Purchases distribution
in this situation overwrites the default Purchases distribution,
but leaves the default Accounts Payable distribution intact.
7. To set the recordset options, choose the recordset in the upper-left pane in the
Integration Mapping window and choose the Options tab.
Recordsets have options that allow you to control how items in the recordset are
mapped. (Descriptions for the different recordsets are at the beginning of this
procedure.)
Option Description
Use Field Rules The mapping rules that appear on the Fields tab of the
Integration Mapping window will be applied.
Use Default This is the same as selecting Use Default as the mapping
rule for all fields within that recordset.
8. When you are finished creating the destination mapping, choose File > Save
Integration and close the window.
Field translations
A field translation allows you to define a relationship between values in the source
file and corresponding values that are used for the destination field. For example,
assume the source file for an integration contains numeric codes that represent
specific salespeople. However, you might want to use names for the Salesperson ID
field, rather than the numeric code. You can use a field translation to accomplish
this.
Field translations can be local or global. You can create local translations in the
Integration Mapping window to use in the current integration, or you can create
global translations that can be used with any integration.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 75
PA RT 2 B U I L D I N G A N D R U N N I N G I N T E G R A TI O N S
Local translations are created directly from the mapping window. A local
translation is available only for the specific field and is used in a specific destination
mapping. Refer to Creating a destination mapping on page 69 to create and use local
translations in a destination mapping. Refer to Creating global translations on page 76
for more information about creating global translations.
2. Click Translations in the types list, and click New to create a new translation.
3. Enter a name and description for the translation, and create the translation.
Understanding enumerations
An enumeration is a data type that is restricted to a fixed set of named values. When
you set the value of an enumeration field, you supply the integer value or string
that corresponds to one of the items in the enumeration.
To view a list of the items in the enumeration, view the properties for the field. The
enumeration items are located on the Other Information tab. See Viewing
enumeration items on page 67.
If you choose the Use Source Field rule to supply the value of an enumeration, the
value from the source should be the integer or string corresponding to the
appropriate item in the enumeration. Using the example above, the value of the
field can be set to Percent either by mapping the value 2 or by mapping the value
Percent from the source data. You can use a translation to map values from the
source file to the appropriate integer value.
If you choose the Use Constant rule to supply the value of an enumeration, the
items from the enumeration appear in a list in the Source column. Select the
appropriate value from the list. The value you select will be used for all records that
are integrated.
76 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A PT E R 9 C R E A TI N G M A P P I N G S
2. Select a field name that has a translation rule, such as Finance Charge Type.
5. In the Rule Properties pane, find the Translation row and click the Value cell.
Click Yes.
6. Choose the Translation tab and set values for each enumeration.
• Set all documents that are to be integrated to use the same enumeration
value. For example, if all the customer records you are integrating use
percent finance charges, use the Use Constant rule.
7. Click OK to save your changes and close the Properties window for the
translation.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 77
78 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Chapter 10: Running integrations
Now you are ready to run the integration.
Step Description
Step 1 Create the integration
Step 2 Add a source
Step 3 Create query relationships (if necessary)
Step 4 Add a destination
Step 5 Create destination mappings
Step 6 Save the integration
Step 7 Run the integration
Step 8 Examine the integration results
Running the integration imports the source data into your selected destination.
Verify the integration properties To view the properties for the integration,
choose Integration > <Integration Name> Properties. Verify that the destination
edit mode is set appropriately. Also verify that the number of errors and warnings
to encounter before the integration is automatically stopped is correct. Refer to
Setting integration properties on page 79 for more information.
Verify the log settings Verify that the log level is set appropriately. You will
learn more about the integration log later.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 79
PA RT 2 B U I L D I N G A N D R U N N I N G I N T E G R A TI O N S
2. Choose File > Open Integration. Select the integration to run and click Open.
4. Select a destination edit mode, which indicates how records are imported into
the destination. You will not be able to specify the destination edit mode when
you first create an integration. The destination edit mode only becomes
available when you choose the destination for the integration. Some edit modes
may not be available for some destinations. The default mode is Insert Only.
Mode Description
Insert Only Only new records can be created by the integration. Existing
records can’t be updated.
Update Only Only existing records can be updated by the integration. New
records can’t be created.
Insert and Update New records can be created and existing records can be
updated by the integration.
When you run an integration, this value indicates the number of errors that can
occur before the integration is automatically stopped. An error occurs when a
document fails to be integrated, typically because of an invalid condition in the
data. For example, if you try to integrate a Microsoft Dynamics GP receivables
invoice where the total sales amount is a negative number, the document is not
integrated, because negative invoice amounts are not allowed.
When you run an integration, this value indicates the number of warnings that
can occur before the integration is automatically stopped. A warning occurs
when a document is integrated, but some information needs to be presented to
80 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 1 0 R U N N I N G I N T E G R A T I O N S
the user. For example, Microsoft Dynamics GP allows you to enter and save a
general journal entry where the total debits do not match the total credits.
However, a warning appears, explaining that the transaction can’t be posted
until the problem has been resolved. Using Integration Manager, the
unbalanced journal entry can be integrated, but it results in a warning similar to
the one presented by Microsoft Dynamics GP.
Use the Scripts properties to attach scripts to the integration. An integration can
have several scripts attached that are executed at various points during the
integration. Scripts are written in VBScript, a subset of the Microsoft Visual
Basic programming language. For more information, refer to Chapter 20,
“Using scripts.”
8. On the Logs tab, set the log properties to specify how to view the log files
created by Integration Manager. For more information about log properties,
refer to Specifying integration log storage types on page 97.
9. Click Apply to apply the integration properties and click OK to close the
window.
To be sure that users have the correct permissions to run an integration, you must use the
appropriate user privileges when you run the integration for the first time. Typically, this
means being part of the Administrators group or the Power Users group on Windows XP.
On Windows Vista, Windows 7, or Windows Server 2008, it means running the integration
with administrative privileges. For example, you can run the integration from the shortcut
on the Start menu, select Microsoft Dynamics > Integration Manager and right-click
Run Integration, and then select Run as Administrator. Refer to your operating system’s
documentation for more information. When you run as an administrator, the registry and
other settings are updated so other users can run integrations without permission issues.
Integration Manager
To run the integration from within Integration Manager, choose Run from the
Integration Manager toolbar. You also can right-click an item in the Integration
window and choose Run Integration.
Microsoft Dynamics GP
To run an integration directly from within Microsoft Dynamics GP, start tMicrosoft
Dynamics GP and close all the windows. Choose Tools > Integrate > Run
Integration. The Run Integration window opens. Use this window to select and run
an existing integration.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 81
PA RT 2 B U I L D I N G A N D R U N N I N G I N T E G R A TI O N S
Start menu
To run the integration from the Start menu, choose Start > Programs > Microsoft
Dynamics > Integration Manager > Run Integration. The Run Integration window
opens. Select the integration to run, and click Run.
As the integration is running, messages appear in the window that describe the
integration status. Any errors or warnings are listed in this window. Details of the
integration progress are shown at the bottom of the window.
Click View Log to view the log results. Refer to Viewing and printing logs on page 98
for more information.
Field Description
Total Queried The number of rows returned from the query for the
integration.
Attempted The number of items Integration Manager attempted to
integrate.
Integrated Successfully The number of items that were integrated without any errors
or warnings.
Integrated with Warning The number of items that were integrated, but encountered a
warning.
Integration Failed The number of items that encountered an error and failed to
be integrated.
82 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 1 0 R U N N I N G I N T E G R A T I O N S
2. In the Options window, choose Create rejection files for text queries.
Any rejection files that are created are placed in the same location as the text file
used for the query. They have the same name as the query, but have an .rjt
extension.
For example, assume the Vendors query retrieves information from C:\My
Documents\VendInfo.txt file. If you select the Create rejection files for text
queries option, any rejected records are written to the following file: C:\My
Documents\Vendors.rjt.
Rejection files are not persistent between integrations. If you run an integration again,
any existing rejection files are overwritten.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 83
84 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Chapter 11: Troubleshooting integrations
This part of the documentation contains information about troubleshooting
integrations if they are not working properly.
• Source problems
• Mapping problems
• Integration problems
• Errors from Microsoft Dynamics GP
Source problems
The following information includes common problems that occur with sources.
Solution It is possible that null or empty values for fields exist in the source. If
this is the case, the application is behaving as it should.
If you are certain that the source does not contain null values, the field may have an
incorrect data type defined for it. If an incorrect data type is set for a field, the value
of the field will appear to be null. For information about setting data types for
columns, refer to Chapter 7, “Data types.”
If the data type is correct, then data for the source field might not be valid. Date
fields must be in a proper date format and numeric values must not exceed the
range allowed by the specific data type. For more information about proper date
formats and numeric ranges, refer to Chapter 7, “Data types.”
ODBC errors
Situation When I preview a source query or run an integration, I receive ODBC
errors.
Solution Try previewing the individual source queries to determine which query
is causing the error. If all source queries generate errors, be sure that the DSN used
by the source query is set up correctly in the ODBC control panel. For other ODBC
problems, refer to your ODBC driver documentation.
Solution Check the row restrictions for the source query in the Properties
window for the source. If the row restriction is not set up properly, it may be too
restrictive and doesn’t return enough rows, or it may not be restrictive enough and
returns too many rows.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 85
PA RT 2 B U I L D I N G A N D R U N N I N G I N T E G R A TI O N S
If you are using multiple source queries for the integration, be sure the relationships
between the sources are set up correctly. If the relationship type is wrong, the child
source query could return an incorrect number of rows.
Be sure there aren’t any blank rows in the source files. Blank rows typically appear
at the bottom when you preview the source.
Solution This usually happens when the Show property for the field is incorrect.
In the Source Query Properties window, choose the Columns tab and verify that the
Show property is set. If you don’t want to display the field in the Data Viewer, or
use the field in the Destination Mapping, then clear the Show check box. Otherwise,
be sure it’s selected.
If you are missing fields, that may be a result of the grouping set for the source
query. When a grouping is set for a source query, the source returns only the
columns that are a part of the grouping.
Mapping problems
The following information includes common problems that occur with mappings.
Solution The default rule for destination fields is If Null Cancel Document. If
this is not the desired behavior, change the destination field rule to If Null Use
Blank or If Null Use Default. To change this rule, open the Destination Mapping
window and select the field that is causing the error. In the lower left corner of the
mapping window, change the Rule Property selection from If Null Cancel
Document to the appropriate value.
Integration problems
The following information includes common problems that can occur when you run
an integration.
Solution Be sure that the Record Source is set to the proper source. In the
Destination Mapping window, select the child recordset that is not integrating.
Choose the Options tab. The Record Source option should be set to a valid source
query. If it is not, click in the Source column and select the proper source query or
recordset from the list.
86 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 1 1 T R O U B L E S H O O T I N G I N T E G R A T I O N S
Solution New integrations have a default setting that causes them to fail after 10
errors or 10 warnings. To change this, open the Integration Properties window and
set the number of warnings to a higher number.
Slow integrations
Situation My integration runs slowly.
Solution There are several changes you can make to your integration to increase
the performance of the integration.
• If multiple sources are used in an integration, the integration will run faster if
you set the sorting options of the source query in Integration Manager. You can
set the sorting options in the Source Query Properties window by choosing the
Sorting tab, and adding columns to the Order By list.
This only works if the sorting options are specified in Integration Manager. The
performance of the integration won’t increase if the data is sorted by other
means, such as specifying an “order by” clause in the SQL text for Advanced
ODBC or using a view or stored procedure that sorts the retrieved data.
• Be sure that you have mapped the minimum number of fields required to
integrate your data. If a field contains no values, or the value it contains is the
default value used in the destination, remove the mapping for that field.
• If you use VBScript in the integration to open an ActiveX™ Data Objects (ADO)
connection, be sure the connection is opened only once during the integration.
If an ADO connection is opened and closed for every document, the
performance of the integration may suffer. It is possible to open an ADO
connection once and reuse that connection across script events and documents.
You can accomplish this by using the VBScript method SetVariable to store the
connection and GetVariable to retrieve it. Be sure to close the connection by
using the VBScript method objConn.Close when you are finished.
Solution This is a known issue with VBScript version 5 and Integration Manager.
The fix is to fully qualify the Execute method by adding “Integration.” before the
Execute statement.
Instead of this:
Call Execute(“C:\Windows\System32\Notepad.exe”)
Use this:
Call Integration.Execute(“C:\Windows\System32\Notepad.exe”)
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 87
PA RT 2 B U I L D I N G A N D R U N N I N G I N T E G R A TI O N S
• A source field was mapped to the wrong destination field. Check the field
mappings in the Destination Mapping window.
• Rule options for a field were set to round or truncate source data. Check the rule
properties for this field in the Destination Mapping window.
• Rule options for the field were set to shift the decimal position of the field value.
Check the rule properties for this field in the Destination Mapping window.
88 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
PART 3: MANAGING INTEGRATIONS
Part 3: Managing integrations
This part of the documentation provides information about managing integrations
with Integration Manager.
• Chapter 14, “Managing logs,” explains how to manage the logs that contain
information about the results of an integration.
• Chapter 15, “Compacting the Access database,” explains how to compact the
Microsoft Access database to reclaim space in the database file.
• Chapter 17, “Running integrations from the command line,” explains how to
run integrations from the command line.
• Chapter 18, “Using advanced ODBC source queries,” explains how to use a
SQL statement to create advanced ODBC queries.
90 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Chapter 12: Modifying integrations
Integration Manager allows you to use integrations from other databases. You can
import and export integrations from within Integration Manager. You also can
modify the various components that you use to create integrations.
• Importing integrations
• Exporting integrations
• Modifying components used in integrations
Importing integrations
You can import integrations from another database to the current Integration
Manager database. Choose Tools > Options to determine the current database.
Importing an integration does not remove it from a database. Instead, a copy of the
integration is imported to the current database. To remove the integration from the other
database, change the Integration Manager database path to point to the other database, and
use the Object Browser window to delete the integration.
To import integrations:
1. From the File menu, choose Import Integrations.
As you click integrations to select them, you can press the SHIFT key to select a
range of integrations and the CTRL key to select integrations that are not listed
next to each other.
If an integration with the same name already exists in the current database,
Integration Manager prompts you to rename the integration you are importing.
Integration Manager also prompts you to change the name of the integration’s
components if components with the same name already exist in the current
database.
Exporting integrations
You can export integrations from the current Integration Manager database to
another database. Choose Tools > Options to determine the current database.
Exporting an integration does not remove it from the current database. Instead, a copy is
exported to the other database. To remove the integration from the current database, use the
Object Browser window.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 91
PA RT 3 M A N A G I N G I N TE G R A T I O N S
To export integrations:
1. From the File menu, choose Export Integrations.
As you click integrations to select them, you can press the SHIFT key to select a
range of integrations and the CTRL key to select integrations that are not listed
next to each other.
3. From the Open window, select the database to export the selected integration or
integrations to and click Open.
You can view, edit, print, and delete the following components using the Object
Browser window.
• Integration groups
• Integrations
• Data sources
• Translations
• Sources
• Destinations
2. To view items, select the item type from the Types pane. The Objects pane lists
the items associated with the selected item type.
92 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 1 2 M O DI FY I N G IN T E G R A T IO N S
3. To create a new item, delete an existing item, view the properties of an item, or
print a report for an item, use the buttons at the bottom of the window.
The buttons are active only when that function is available for the selected type.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 93
94 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Chapter 13: Pathname translations
A pathname translation allows you to define substitutions for the pathnames that
are defined in the Integration Manager database file. For example, assume that
several people access Integration Manager from different workstations. Each user
might store the Integration Manager source files to a different drive. You can use a
pathname translation to locate the source files.
For example, one workstation may use the drive letter H to refer to the network
location where the source files are stored. Another workstation may use the drive
letter R to refer to the same network location. If you tried to use the same
Integration Manager database file on both workstations, one of them would not be
able locate the source files.
Pathname translations are stored on a per user basis, not per workstation. If you create a
pathname translation on a computer, and log in as someone else, that translation won’t be
available.
In the previous example, all the paths for the queries on the first workstation use the
drive letter H. If you moved the Integration Manager database file to the second
workstation, you would need to create a pathname translation on that workstation
that translates from the drive letter H to the drive letter R. Any path that used the
drive letter H would then have the drive letter R substituted.
You do not need to use pathname translations if the source files are stored on the server and
everyone on the network uses the same drive letter for the server.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 95
PA RT 3 M A N A G I N G I N TE G R A T I O N S
3. On each line, enter the From and To values for the translation. Click OK to save
the changes.
You are not limited to mapping only drive letters. You can map partial paths, as well.
For instance, you could map the path C:\Program Files\Microsoft
Dynamics\Integration Manager\ to the path D:\IntegrationManager\.
96 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Chapter 14: Managing logs
Integration Manager can create a log file that contains detailed information about
the results of an integration. The Integration Log shows a list of logs; one log for
each time you run the integration.
If multiple users are using the same Integration Manager Database and these users are
saving log information to a database, ODBC and primary key errors may occur. To prevent
this from happening, each user should store log information to a text file.
If you choose to store the log in a text file, you must specify the folder that contains
the log. By default, text file logs are stored in the Logs folder in the location where
you installed Integration Manager.
Level Description
Summary Basic information about the integration is logged, including starting and
ending times, completion status, and record counts. Information about
individual records is logged if a warning or error is encountered.
Document In addition to summary information, information about every integrated
record is logged. This can produce a large log.
Trace Detailed information is logged for all aspects of the integration. This is
intended primarily as a debugging tool. Because of the large quantity of
information logged, it is best to store this type of log in a text file.
None No information is logged for the integration.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 97
PA RT 3 M A N A G I N G I N T E G R A TI O N S
3. Change the level to the desired level of detail for this integration.
• Integration name
You also can choose View Log in the Progress window of the integration.
3. Select a log for a specific integration and click Open. You also can double-click
the log item to view the details for that integration.
98 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A PT E R 1 4 M AN A G I N G L O G S
5. To view more information about any of the items, select any of the items in the
Document Detail or Activity Detail lists and click Open.
If the information in the Message column in the Activity Detail section is too lengthy
to view, select the message and click Open.
Deleting logs
When you store integration logs in a database file, that file can become quite large.
You can delete logs whenever you need to. When you delete a log, you can choose
whether to delete only detail information or both summary information and detail
information.
To remove a log:
1. From the Integration window, select the integration and click Properties.
5. To remove all log information, click Yes. To remove only the detail information,
click No.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 99
100 IN T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Chapter 15: Compacting the Access database
When you remove information from your integrations, that process removes
information from the Access database file, but does not reclaim the space used by
the file.
If you have Microsoft Access installed, you can use it to compact the your
Integration Manager database, such as IntegrationManager.mdb. Refer to the
Access documentation for information about how to do this.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 101
PA RT 3 M A N A G I N G I N T E G R A TI O N S
4. Choose Microsoft Access Driver (*.mdb) and click Finish. The ODBC
Microsoft Access Setup window opens.
5. Click Compact.
A window opens, asking you to locate the Access database file to compact.
The compacting process creates a new Access database file. Name this new file
and click OK.
102 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 1 5 C O M P AC T I N G T HE A C C E S S D AT AB AS E
• Rename the compacted Access database file so it has the same name as the
original database file. Then replace the original file.
• Set up Integration Manager to use the new file. To do this, start Integration
Manager. From the Tools menu, choose Options. Choose the General tab and
set the Default Integration Manager Database field to use the compacted
Access database file.
If you are running in a multiuser configuration and you change the Default Integration
Manager Database setting, be sure to change the path for all workstations that use the file.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 103
104 IN T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Chapter 16: Using integration groups
In some cases, it is useful to perform several integrations in succession. For
example, you might want to run several integrations overnight. Integration groups
allow you to do this.
3. Enter the name for the integration group. You also may want to provide a
description of the integration group.
The integration group description should provide information about the group,
such as which integrations it contains or when it should be run.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 105
PA RT 3 M A N A G I N G I N T E G R A TI O N S
4. Choose the Integrations tab to specify which integrations will be part of the
group. Click in each line and select an integration from the list that appears. The
integrations run in the order you add them to the integrations list.
5. For each integration, specify how errors will be handled. If an integration in the
group fails, you can choose to have the integration group stop or have the
remaining integrations in the group run.
2. Select Integration Groups as the type, select the group, and click Properties.
2. In the Run Integration window, select any integration group and click Run.
106 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Chapter 17: Running integrations from the
command line
You can start integrations or integration groups directly from the command line.
This is useful if you need to schedule integrations to start at predefined times.
Microsoft Dynamics GP must be running before you can start an integration from
the command line. Typically, this means you also need to start Microsoft Dynamics
GP from the command line. To do this, you first need to record a macro that
performs the login process to Microsoft Dynamics GP.
2. At the Welcome window, press ALT+F8 to begin recording the login macro.
Name the macro and save it in a known location, such as the Microsoft
Dynamics GP folder.
3. Log in to Microsoft Dynamics GP. Be sure to manually type any user ID and
password information so this information is captured by the macro.
4. After you have logged in to the accounting system, stop recording the macro. To
stop recording the macro, from the Tools menu, choose Macro and choose Stop
Record. You also can press ALT+F8 to stop recording.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 107
PA RT 3 M A N A G I N G I N T E G R A TI O N S
5. Edit the macro using a text editor such as Notepad to add the following line as
the second line of the macro:
Adding this line prevents any message displayed by the macro, such as the total
running time, from being displayed on the screen and preventing the login to
Microsoft Dynamics GP. Instead, all messages generated by the macro are
written to the MACRO.LOG file.
When you have finished editing the macro, save your changes.
Notice that a complete path is used to refer to the Microsoft Dynamics GP runtime
engine and launch file, and the macro to be run.
108 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 1 7 R U N N I N G I N T EG R A T I O N S F R O M T H E C O M M A N D L I N E
Note that you can run an integration or an integration group, but not both at the same time.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 109
110 IN T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Chapter 18: Using advanced ODBC source queries
Advanced ODBC source queries are those that use a SQL statement to retrieve
information from an ODBC data source. We recommend that you have at least a
basic understanding of SQL to use advanced queries for your integration.
3. Enter a name and description for the advanced ODBC source query.
Name Each advanced ODBC source query must have a name. The name
should describe the type of information retrieved by the query.
4. Enter or select a data source and SQL statement to use for the advanced ODBC
query.
Data Source This is the ODBC data source or data source created in
Integration Manager from which you retrieve data. Refer to the documentation
for the ODBC driver for more information about setting up ODBC data sources.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 111
PA RT 3 M A N A G I N G I N T E G R A TI O N S
5. Choose the Columns tab to display the columns returned by the query and
change the datatype and size, as necessary.
Column Name Displays the names of the data items available for the query.
Datatype Indicates what type of data is contained in the column. The data
type value is automatically retrieved from the ODBC data source. In most cases,
the data type is appropriate. In other cases, you may need to change the data
type to better reflect how the data is used for the integration. To change the data
type, click in the Datatype column and choose an item from the drop-down list.
Refer to Chapter 7, “Data types,” for more information about selecting
appropriate data types.
Size This value indicates the data size of each column, in bytes. In most cases,
the default size is appropriate. In special cases, you may need to adjust the size
to better reflect the size of the data value returned by the query.
Show Select the Show check box to include the data in this column in your
integration. If you are using a large source file and you do not want all the data
to be integrated, clear this check box for the columns to exclude.
Is Key Select the Is Key check box to indicate that the data items within a
column are unique identifiers. For example, you might select a column called
Customer ID as Is Key to indicate that the values within a column are unique.
Integration Manager uses values marked as Is Key to identify specific rows that cause
errors in the integration.
7. Choose the Scripts tab to attach scripts that are executed before and after the
query is performed. Scripts are written in VBScript, a subset of the Microsoft
Visual Basic programming language. For more information, refer to Chapter 20,
“Using scripts.”
112 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 1 8 U S I N G A D V A N C E D O D B C S O U R C E Q U E R I E S
To view this window, open the properties window for the advanced ODBC source
and from the General tab, choose Query Builder.
Selecting rows
Use the fields at the top of the window to specify which rows are included in the
query results.
To select specific rows from the table, you create selection criteria based on fields
from the tables available for the query. You can use logical AND and logical OR
operators to apply several criteria.
The LIKE operator allows you to perform basic pattern matching with string
columns. You can use the percent sign (%) as a wildcard character, representing any
sequence of characters.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 113
PA RT 3 M A N A G I N G I N T E G R A TI O N S
Selecting fields
You can select the fields that are included in the query results.
To specify the fields to include in the query results, select the appropriate tables in
the Tables list. Then select the individual fields in the Fields to Show list. If you do
not select any fields in the list, all fields for the selected tables are included.
Grouping
If you select an item in the Group By list, the data returned by the query is grouped
based on that field. For example, if you group by the City field, the rows that have
the same value for City appear as a group.
Sorting
To specify how the rows returned by the query are sorted, select an item in the
Order By list. The rows returned by the query are sorted based on the field you
select. You can sort items in ascending or descending order.
If you are creating a query relationship for this query, you can improve the performance of
the integration by sorting the query results by the field used for the relationship.
Joins
If the query returns data from more than one table, you must create joins between
the tables to indicate how they are related. To create a join, select the two tables that
are related and click Set Table Joins.
114 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 1 8 U S I N G A D V A N C E D O D B C S O U R C E Q U E R I E S
In the Join Tables window, select the two tables to join. Select the field or fields in
each table that are related. The table join is based on these fields. Click Add Join to
Query.
Rather than using joins, you may find it easier to use multiple queries and create query
relationships between them in Integration Manager.
If you select the Top Percent check box, the specified percentage of rows is
returned. For example, the following selections indicate that the first five percent of
the rows that meet the query criteria are returned.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 115
116 IN T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
PART 4: ADAPTER REFERENCE
Part 4: Adapter reference
This part of the documentation describes the adapters that are available with
Integration Manager and contains adapter specific destination information and
mapping options.
• Chapter 19, “Adapters and Destination Mappings,” describes the adapters that
can be used in Integration Manager and contains destination mapping
information for each destination adapter.
118 IN T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Chapter 19: Adapters and Destination Mappings
You can choose which adapters to use with Integration Manager. The information
provided in this part of the documentation describes the adapters that you can use
with Integration Manager.
The tables also include the mapping options for each destination. These mapping options are
on the Options tab of the Integration Mapping window. Because each child recordset
contains the Record Source mapping option, it is not included in the following tables.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 119
PA RT 4 AD A PT E R R EF E R E N C E
Financial
The Financial module in the Microsoft Dynamics GP adapter contains destinations
for Account, Bank Reconcile, Bank Transaction Entry, Budget, Fixed Allocation,
General Journal, Unit Allocation, and Variable Allocation.
Bank Reconcile The Bank Reconcile destination has the following properties.
Bank Transaction Entry The Bank Transaction Entry destination has the
following properties.
120 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 1 9 A DA P TE R S A N D D E S T IN A TI O N M A P P IN G S
Fixed Allocation The Fixed Allocation destination has the following properties.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 121
PA RT 4 AD A PT E R R EF E R E N C E
General Journal The General Journal destination has the following properties.
122 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 1 9 A DA P TE R S A N D D E S T IN A TI O N M A P P IN G S
Unit Allocation The Unit Allocation destination has the following properties.
Payables Management
The Payables Management module in the Microsoft Dynamics GP adapter contains
destinations for Payables Transaction and Vendor.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 123
PA RT 4 AD A PT E R R EF E R E N C E
124 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 1 9 A DA P TE R S A N D D E S T IN A TI O N M A P P IN G S
Receivables Management
The Receivables Management module in the Microsoft Dynamics GP adapter
contains destinations for Cash Receipts, Customer, and Receivables Transaction.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 125
PA RT 4 AD A PT E R R EF E R E N C E
Required Fields
Receivables Transaction Document Type
Document Number
Batch ID
Document Date
Tax Date
Customer ID
Currency ID
Commissions Applied To
Commissions Salesperson ID
Sales Territory ID
Distribution Distribution Account
Distribution Type
Distribution\Analysis Posting Analysis Group ID
Detail
Distribution\Analysis Posting Analysis Code ID
Detail\Entries
Exchange Rate Rate Type ID
126 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 1 9 A DA P TE R S A N D D E S T IN A TI O N M A P P IN G S
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 127
PA RT 4 AD A PT E R R EF E R E N C E
Choose from the following rules to specify the action to take when the comment ID does not exist.
Cancel Document
Add New Comment—Use the following rule properties to add a new comment.
Series—Select the value for the series.
Comment—Enter a comment.
Restrictions This destination is insert–only. It cannot be used to update existing sales order transactions.
Required Fields
Sales Transaction Type
Type ID
Document No
Date
Batch ID
Customer ID
Customer Name
Currency ID
Commissions Salesperson ID
Territory ID
Distributions Account Number
Distribution Type
Distributions\Analysis Posting Analysis Group ID
Detail
Distributions\Analysis Posting Analysis Code ID
Detail\Entries
Exchange Rate Rate Type ID
Exchange Rate
Items Item Number
U Of M
Quantity
Items\Intrastat Tax Registration
Country Code
Transport Mode
Transaction Nature
Items\Item Detail Site ID
Price Level
Items\Item Detail\Bin Bin
Quantity Selected
Items\Item Detail\Line Item Taxes Tax Detail ID
Items\Item Detail\Lot Numbers Lot Number
Quantity
Items\Item Detail\Serial Numbers Serial Number
Items\Returned Quantities On Hand
Returned
In Use
In Service
Damaged
Payments Date
Posting Date
Cash Receipt Number
Payment Amount
Cash Account
Deposits
Sales Tax Detail Summary Tax Detail ID
Account Number
User–Defined Fields\Tracking Tracking Number
Numbers
128 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 1 9 A DA P TE R S A N D D E S T IN A TI O N M A P P IN G S
Payroll
The Payroll module in the Microsoft Dynamics GP adapter contains destinations for
Payroll Manual Checks, Payroll Master, and Payroll Transaction.
Payroll Manual Checks The Payroll Manual Checks destination has the
following properties.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 129
PA RT 4 AD A PT E R R EF E R E N C E
Payroll Master The Payroll Master destination has the following properties.
130 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 1 9 A DA P TE R S A N D D E S T IN A TI O N M A P P IN G S
No Deductions Specified
This option is available in the Benefits recordset. Choose from the following rules to specify the
behavior when no deductions have been specified.
Cancel Document
Allow with Warning
Allow without Warning
No Pay Codes Specified
This option is available in the Benefits and Deductions recordsets. Choose from the following rules to
specify the behavior when no pay codes have been specified.
Cancel Document
Allow with Warning
Allow without Warning
Pay Codes not Set Up for Employee
This option is available in Benefits and Deductions recordsets. Choose from the following rules to
specify the behavior when no pay codes have been set up for an employee.
Cancel Document
Allow with Warning
Allow without Warning
Adding Active Records to Inactive Employee
This option is available in the Benefits, Deductions, Pay Codes, Local Tax, and State Tax recordsets.
Choose from the following rules to specify the behavior when the integration attempts to add records
for an employee that is inactive.
Cancel Document
Make Inactive with Warning
Make Inactive without Warning
Deductions not Set Up for Employee
This option is available in Benefits recordset. Choose from the following rules to specify the behavior
when no deductions have been set up for an employee.
Cancel Document
Allow with Warning
Allow without Warning
Inactive Pay Code
This option is available in the Deductions and Pay Codes recordsets. Choose from the following rules
to specify the behavior when an inactive pay code is used.
Cancel Document
Allow with Warning
Allow without Warning
Pay Rate Change
This option is available in Pay Codes recordset. Choose from the following rules to specify the
behavior when a pay rate changes.
Cancel Document
Roll Down to all Employees Using this Code
Do Not Roll Down
Shift Code Change
This option is available in Pay Codes recordset. Choose one of the following rules to specify the
behavior when a shift code changes.
Cancel Document
Roll Down to all Employees Using this Code
Do Not Roll Down
Data Entry Default for Salary Pay Codes
This option is available in the Pay Codes recordset. Choose from the following rules.
Cancel Document
Allow with Warning
Allow without Warning
Inactive Local Tax Code
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 131
PA RT 4 AD A PT E R R EF E R E N C E
This option is available in the Tax Information\Local Tax recordset. Choose from the following rules to
specify the behavior when an inactive local tax code is used.
Cancel Document
Allow with Warning
Allow without Warning
Inventory
The Inventory module in the Microsoft Dynamics GP adapter contains destinations
for Inventory Item and Inventory Transaction.
132 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 1 9 A DA P TE R S A N D D E S T IN A TI O N M A P P IN G S
Inventory Item The Inventory Item destination has the following properties.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 133
PA RT 4 AD A PT E R R EF E R E N C E
Required Fields
Inventory Transaction Document Type
Number
Date
Batch ID
Items Item Number
U of M
Quantity
Unit Cost
Site ID
Items\Bins Bin
Quantity Selected
Items\Lot Numbers Lot Number
Quantity Selected
Items\Serial Numbers Serial Number
Setup
The Setup module in the Microsoft Dynamics GP adapter contains a destination for
Exchange Rate.
Exchange Rate The Exchange Rate destination has the following properties.
134 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 1 9 A DA P TE R S A N D D E S T IN A TI O N M A P P IN G S
The tables also include the mapping options for each destination. These mapping options are
on the Options tab of the Integration Mapping window. Because each child recordset
contains the Record Source mapping option, it is not included in the following tables.
Receivables Management
The Receivables Management module in the Microsoft Dynamics GP eConnect
adapter contains destinations for Customer.
Inventory
The Inventory module in the Microsoft Dynamics GP eConnect adapter contains
destinations for Inventory Item and Inventory Transaction.
Inventory Item The Inventory Item destination has the following properties.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 135
PA RT 4 AD A PT E R R EF E R E N C E
Purchasing
The Purchasing module in the Microsoft Dynamics GP eConnect adapter contains
destinations for Purchasing Order Entry, Receivings Transaction Entry, and Vendor.
Purchasing Order Entry The Purchasing Order Entry destination has the
following properties.
136 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 1 9 A DA P TE R S A N D D E S T IN A TI O N M A P P IN G S
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 137
PA RT 4 AD A PT E R R EF E R E N C E
Financial
The Financial module in the Microsoft Dynamics GP eConnect adapter contains
destinations for GL Account and GL Transaction.
138 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 1 9 A DA P TE R S A N D D E S T IN A TI O N M A P P IN G S
Company
The company module in the Microsoft Dynamics GP eConnect adapter contains
destinations for Shipping Method.
Project Accounting
The Project Accounting module in the Microsoft Dynamics GP eConnect adapter
contains destinations for Employee Expense and Timesheet Entry.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 139
PA RT 4 AD A PT E R R EF E R E N C E
Timesheet Entry The Timesheet Entry destination has the following properties.
140 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 1 9 A DA P TE R S A N D D E S T IN A TI O N M A P P IN G S
Asset Book The Asset Book destination has the following properties.
1=No;
2=Yes
Special depreciation allowance percentage
Luxury auto:
1=No;
2=Yes
Luxury van or truck:
0=No;
1=Yes
Luxury electric auto:
0=No;
1=Yes
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 141
PA RT 4 AD A PT E R R EF E R E N C E
Asset General Information The Asset General Information destination has the
following properties.
Method 1
Set up the Fixed Asset Class ID to have a default Account Group ID field in Microsoft Dynamics GP.
1. Open the Class Setup window (Financial >> Setup >> Fixed Assets >> Class).
2. Set up a class for the new assets or select an existing class.
3. Select an account group ID.
4. Click Save.
5. Map the Class ID field in the Asset General Information destination mapping folder in the
Integration Manager Destination Mapping window.
The Asset Account Master (FA00400) table will be updated with the account group data that is
associated with the class.
Method 2
Set up the default accounts for the company to have an account group ID in Microsoft Dynamics GP
1. Open the Fixed Assets Company Setup window (Financial >> Setup >> Fixed Assets >> Company).
2. Choose the Default Accounts expansion button to open the Default Accounts window.
3. Enter an account group ID.
4. Click OK.
5. Choose Save in the Fixed Assets Company Setup window.
You do not have to map any specific field within Integration Manager.
The Asset Account Master (FA00400) table will be updated with the account group data that is
associated with the default account information in the Fixed Asset company setup.
142 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 1 9 A DA P TE R S A N D D E S T IN A TI O N M A P P IN G S
Asset Insurance The Asset Insurance destination has the following properties.
Asset Lease The Asset Lease destination has the following properties.
Asset User Data The Asset User Data destination has the following properties.
Field Name The name of the field in the Integration Mapping window.
Data Type The type of data in each field.
Length The number of characters that can be stored in the field.
Required States whether the field is required.
Be sure that you have a transaction/document number when you map your
destinations.
Destinations
You can map Analytical Accounting integrations for the following destinations:
Inventory Transaction, Receivings Transaction Entry, Sales Transaction, and GL
Transaction. Each of these destinations contain the following recordsets.
Analytics recordset
Field Name Data Type Length Required
Account Number string 75 No
Assign ID* long integer 4 No
Amount* numeric 14 No
Assigned Percent* numeric 14 No
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 143
PA RT 4 AD A PT E R R EF E R E N C E
Analytics recordset
Field Name Data Type Length Required
Reference string 30 No
Note string 32768 No
*Not available in the Inventory Transaction Destination
Dimensions recordset
Field Name Data Type Length Required
Transaction Dimension string 30 No
Transaction Dimension AlphaNumeric Code string 30 No
Transaction Dimension Numeric numeric 14 No
Transaction Dimension Boolean boolean 2 No
Transaction Dimension Date date 8 No
Transaction Dimension ID long integer 4 No
Transaction Dimension Code ID long integer 4 No
The XML source adapter allows you to create integrations that use XML files as
source data. Then, you can map the source data to any destination, depending on
which destination adapters you have.
To use the XML source adapter, you use the XML Source Definition window to
define your XML source. You can define the source from scratch or simply point to
an XML file and let the adapter do the work for you. Integration Manager uses this
definition to convert the XML structure into a document definition it can use. A
document definition is the metadata that Integration Manager uses to describe the
structure and content of the source. It describes recordsets, hierarchical
relationships, fields, data types, and more. It is analogous to an XML schema, but it
usually contains more information.
After the document definition is set up, you use the Integration Mapping window
to map the source data to a destination. In addition to mapping source values to the
destination, you can choose from a number of additional rules for each field,
including:
When you add an XML source to an integration, you are telling Integration
Manager the format of the source data to be used. When you add a source, you can
choose to define a new source or select an existing source. You complete adding a
XML source by defining the properties.
You can add only one XML source to any integration. You cannot add two XML sources and
link them together as you can with ODBC and text sources. You must remove the old source
before adding the new XML source, or you must create a new integration.
144 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 1 9 A DA P TE R S A N D D E S T IN A TI O N M A P P IN G S
Each child recordset in the Microsoft Dynamics GP destination adapter contains the
Record Source mapping option.
The following table describes the rules available with the Record Source mapping
option.
Rule Description
Use Default The default values for the fields in the recordset are used,
regardless of the field rule selected for each field.
Use Field Rules The rules chosen for individual fields in the recordset are used.
Use Source Recordset This rule is available only for recordsets that allow multiple sets
for each record. It allows you to specify a query to associate with
the recordset. One set of items will be read into the recordset for
each row returned by the selected query.
Empty All fields in the recordset will be made empty, regardless of any
default values or rules you have applied to individual fields.
Default (Non–Imported) For some recordsets, such as Distributions, Microsoft Dynamics
GP provides default values. If you choose to map selected fields
in the recordset, you can choose this rule to have Microsoft
Dynamics GP provide default values for the remaining fields.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 145
146 IN T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
PART 5: USING VBSCRIPT
Part 5: Using VBScript
Integration Manager provides scripting capabilities so that you are able to
customize integrations. Integration Manager uses the command set, grammar, and
syntax of the Microsoft Visual Basic Scripting™ Edition (VBScript), a subset of the
Microsoft Visual Basic programming language. It can be used throughout
Integration Manager to do the following activities.
By adding scripts to fields and integration events, you can significantly extend the
functionality of Integration Manager.
• Chapter 20, “Using scripts,” provides an overview of how VBScript can be used
in Integration Manager.
148 IN T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Chapter 20: Using scripts
You can use VBScript–which is included in Integration Manager–to attach scripts
that automate integrations. VBScript allows you to attach code that runs as various
actions are performed by Integration Manager.
• Overview of VBScript
• Attaching scripts to integrations
• Attaching scripts to ODBC or text sources
• Attaching scripts to fields
• Using the Script Editor window
• Working with source fields
• Working with destination fields
• Order of events
• Null values
• Variables
• Debugging scripts
Overview of VBScript
VBScript is a language that can be embedded into products such as Integration
Manager to enhance them with scripting capabilities. Developed by Microsoft,
VBScript is based on Visual Basic. If you have used Visual Basic or Visual Basic for
Applications (VBA), you are already familiar with the syntax of VBScript.
This part of the documentation assumes that you have basic knowledge of scripting in
general, and VBScript in particular. It is not intended to teach VBScript. Rather, it is
intended to show you how to use the implementation of VBScript that has been added to
Integration Manager.
For more information about VBScript, go to the MSDN online library (http://
msdn.microsoft.com) and click on the Library link) and search for VBScript.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 149
PA RT 5 U S I N G V B S C R I P T
2. From the Integration window, click Properties, and choose the Scripts tab.
An icon next to a script indicates that the script is attached to this integration.
The type of script you choose depends on when the script should run.
– or –
The Script Editor window opens, where you can write the script.
To remove a script, select the script in the list and click Remove Script.
150 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 2 0 U S I N G S C R I P T S
2. From the Integration window, select the source, choose Properties on the
toolbar, and choose the Scripts tab.
The type of script you choose depends on when the script should run.
The Script Editor window appears, where you can write the script.
To remove a script, select the script in the list and choose Remove Script.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 151
PA RT 5 U S I N G V B S C R I P T
3. Set the rule for the field to Use Script. In the Rule Properties, click the lookup
button for the Script Text rule to open the Script Editor window.
To remove a script, select the Script Text rule property for the field. Choose Edit and
choose Remove Script. After you remove the script, be sure to change the field rule to
some value other than Use Script.
The Script Editor acts like any basic text editor. The commands on the File and Edit
menus allow you to edit, cut, copy, paste, and save your scripts.
You can use the VBScript Library for Integration Manager to check the syntax of
your script. In the Script Editor window, choose Script > Script Library to open the
VBScript Library. The VBScript Library for Integration Manager is a collection of
commonly used scripts that you might find useful in your integrations.
To make composing and editing scripts easier, the Script Editor includes line
numbering, which you can turn on and off from the Edit menu, and it includes
unlimited undo and redo functionality, which is also on the Edit menu. If you select
multiple lines and press TAB, you can indent several lines at once. Also, if you are
working on a long script, you can use a horizontal splitter so you can see two areas
of the script at the same time. This horizontal splitter is located just above the
vertical scroll bar.
152 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 2 0 U S I N G S C R I P T S
As you compose scripts, you will notice that the Script Editor automatically
highlights syntax and maintains the tab positions from the previous line. It also
employs keyword case normalization as you type. For example, it changes “dim” to
“Dim”.
To save the script and close the Script Editor, choose File > Save and Close.
Order of events
It is helpful to know when scripts are run in relation to the actions performed as an
integration runs. The following table describes the events and scripts performed as
an integration runs, in the order in which they are performed.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 153
PA RT 5 U S I N G V B S C R I P T
Null values
If you are using the SourceFields object to retrieve data from a source, but no value
exists for that field in the current row, a NULL value is returned. You can’t check for
a NULL value directly. Instead, you must use the VBScript IsNull function. The
following example shows how to use this function.
If IsNull(SourceFields(“Fax”)) Then
CancelDocument “No fax number”, 5000, “Fax”
End If
Variables
Variables are scoped at the script level. A variable may be created in a particular
script (such as a Before Integration script) and assigned a value, but the variable
will not be recognized by other scripts in the same integration (such as a Field
script). The GetVariable and SetVariable methods are designed to store variables
from one script so that they may be retrieved by another script.
Sometimes, you need to pass information from one script in the integration to
another. The SetVariable statement, GetVariable function, and ClearVariables
statement are available in Integration Manager to allow this. With these commands,
you can create, set, and retrieve variables from any script in the integration. For
more information, refer to Chapter 22, “Functions.”
Debugging scripts
Any errors that prevent your scripts from running properly will be listed in the
integration’s Progress window.
If you are familiar with using a debugger, the Microsoft Script Debugger is available
from msdn.microsoft.com. Refer to the documentation included with the debugger
for a complete description of its features.
To use this debugger with Integration Manager, install the debugger and include the
Stop statement in your VBScript code where debugging should begin. When this
statement is encountered, the debugger starts, allowing you to debug from that
point.
Microsoft Dynamics GP does not provide technical support for debugging scripts or using
the Microsoft Script Debugger.
154 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Chapter 21: VBScript objects
VBScript objects are a combination of code and data that can be treated as a unit. An
object can be a piece of an application or an entire application. All objects are
created as identical copies of their classes. Once they exist as individual objects, you
can change their properties.
• CurrentField object
• DestinationFields object
• Errors Collection object
• Error object
• Query object
• SourceFields object
• GPConnection object
CurrentField object
The CurrentField object is used in scripts that are attached to fields in the
Integration Mapping window. This object refers to the destination field that the
script is attached to.
Syntax
CurrentField.[property | method]
Example
The following example sets the current field to the value 19.95.
CurrentField.Value = 19.95
FullName property
The FullName property returns a string containing the full name of a field.
Syntax
object.FullName
Parameters
object—A current field object.
Comments
This name also contains the names of any collections the current field may be part
of.
Example
The following example sets the CurrentField variable to the full name of the current
field.
Name property
The Name property returns a string containing the name of a field.
Syntax
object.Name
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 155
PA RT 5 U S I N G V B S C R I P T
Parameters
object—A current field object.
Comments
This name does not contain any information about a collection the current field may
be part of.
Example
The following example sets the CurrentField variable to the name of the current
field.
SetToDefault method
The SetToDefault method specifies that a destination field will use its default value.
Syntax
object.SetToDefault
Parameters
None
Comments
You can use the HasDefault property to verify that a destination field has a non-
empty default value before you use the SetToDefault method.
Examples
The following example is the Before Document Commit script for a customer
integration. If the CustomerType value from the Customer query is Preferred, the
Finance Charge Percent is set to 8. Otherwise, it is set to use the field’s default.
DestinationFields object
The DestinationFields object refers to any destination field in the Integration
Mapping window. It is typically used in scripts attached to fields in the Integration
Mapping window, and also can be used in the Before Document Commit script.
Syntax
DestinationFields(name).[property | method]
Parameters
name—A string containing the full name of the destination field. If the destination
field is part of a collection, the full name includes the names of any collections the
field is part of, separated by periods.
Example
The following example is the Before Document Commit script for a vendor
integration. It sets the Comment 1 field to the value “Imported by IM”.
156 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 2 1 V B S C R I P T O B J E C T S
The following example is the Before Document Commit script for a customer
integration. It sets the Credit Limit Amount field, which is part of the Options
collection, to the CreditLimit value returned by a query.
DefaultIsSet property
The DefaultIsSet property returns a boolean indicating whether a destination field
is set to use the default value. True indicates it uses the default value. False indicates
it does not.
Syntax
object.DefaultIsSet
Parameters
object—A destination field object.
Example
The following example is the Before Document Commit script for an integration. It
examines the Transaction Date destination field to find out whether it is set to the
default value. If it is, a message appears and the integration is stopped.
HasDefault property
The HasDefault property returns a boolean indicating whether a destination field
has a non-empty default value. True indicates the field has a non-empty default
value, while false indicates it does not.
Syntax
object.HasDefault
Parameters
object—A destination field object.
Comments
Use the HasDefault property to verify that a destination field has a default value
before you use the SetToDefault method.
Example
The following example verifies that the Post Sales In destination field in the
Account object has a non-empty default value. If it does, the default value is used.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 157
PA RT 5 U S I N G V B S C R I P T
SetToDefault method
The SetToDefault method specifies that a destination field will use its default value.
Syntax
object.SetToDefault
Parameters
None
Comments
You can use the HasDefault property to verify that a destination field has a non-
empty default value before you use the SetToDefault method.
Example
The following example is the Before Document Commit script for a customer
integration. If the CustomerType value from the Customer query is Preferred, the
Finance Charge Percent is set to 8. Otherwise, it is set to use the field’s default.
Syntax
Set MyErrors = GetVariable(“Errors”)MyErrors.[property]
Parameters
None
Example
Dim MyErrors, MyError
Set MyErrors = GetVariable("Errors")
Set MyError = MyErrors.LastError
Count property
The Count property returns the total number of errors in the collection.
Syntax
object.Count
Example
If MyErrors.Count > 0 then
MsgBox "An error occurred"
End If
158 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 2 1 V B S C R I P T O B J E C T S
LastError property
The LastError property contains the Error Object for the last error or warning that
occurred.
Syntax
object.LastError
Examples
Set MyError = MyErrors.LastError
Item property
Description
The Item property acts as the array indexer into the Errors Collection. You can
retrieve a specific Error using this property by passing in the ordinal of the Error
you want. The ordinal starts at 1.
Syntax
object.Item
Example
This example gets the Error Object at the start of the collection:
Error object
The Error object is used in scripts to get information about a specific error, such as
the time it occurred or the text of the error. The only way to access a specific error is
through the Errors Collection object. An Error object may contain warnings as well
as errors.
Syntax
Set MyError = GetVariable(“Errors”).LastError
MyError.[property]
– Or –
GetVariable(“Errors”).LastError.[property]
Parameters
None
Example
The following example demonstrates retrieving the last error that occurred in the
integration:
The following example shows how to display the text of the last error or warning
that occurred:
MsgBox GetVariable("Errors")._
LastError.MessageText
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 159
PA RT 5 U S I N G V B S C R I P T
DateTime property
The DateTime property is a time stamp for when the error or warning occurred.
Syntax
object.DateTime
Severity property
Description
The Severity property indicates whether the Error Object is an error or a warning.
Syntax
object.Severity
Example
This example checks whether the error object is a warning:
MessageText property
The MessageText property contains the description of the error or warning that
occurred.
Syntax
object.MessageText
Query object
The Query object is used to access and set properties of a source query. It can be
used only in scripts attached to queries.
Syntax
Query.[property | method]
Parameters
None
Example
The following example is the Before Query script. It adds additional selection
criteria to a query used for a vendor integration.
160 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 2 1 V B S C R I P T O B J E C T S
AdditionalCriteria property
The AdditionalCriteria property allows you to add additional selection criteria to a
text query or simple ODBC query.
Syntax
Query
Parameters
object—The query object to which additional selection criteria is applied.
Comments
You must set the AdditionalCriteria property in the Before Query script.
If you refer to a column whose name contains spaces or other special characters, be
sure to enclose the column name in square brackets [].
You can use parentheses, logical AND, logical OR, Like and wildcard (%) operators
in the criteria string, similar to how you use them in the Query Properties window.
Example
object.AdditionalCriteria [= criteria]
OverrideCriteria property
The OverrideCriteria property allows you to replace the selection criteria used for a
text query or simple ODBC query.
Syntax
object.OverrideCriteria [= criteria]
Parameters
object—The query object for which the selection criteria will be replaced.
Comments
You must set the OverrideCriteria property in the Before Query script.
If you refer to a column whose name contains spaces or other special characters, be
sure to enclose the column name in square brackets [].
You can use parentheses, logical AND, logical OR, Like and wildcard (%) operators
in the criteria string, similar to how you use them in the Query Properties window.
Example
The following example replaces the selection criteria for a query to include only
customers from North Dakota.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 161
PA RT 5 U S I N G V B S C R I P T
OverrideFileLocation property
The OverrideFileLocation property allows you to specify a different file location for
the source file used for a text query.
Syntax
object.OverrideFileLocation [= path]
Parameters
object—A query object for text query.
path—A string containing the new location of the source file. Note that this is the
location of the source file. The name of the source file must remain the same.
Comments
You must set the OverrideFileLocation property in the Before Query script.
Example
The following example is a Before Query script. It reads the value of the Path
variable, which was set in the Before Integration script. Then it uses the path
information to override the location of the source file for the query.
Query.OverrideFileLocation = GetVariable(“Path”)
QueryName property
The QueryName property returns a string containing the name associated with a
query object.
Syntax
object.QueryName
Parameters
object—A query object.
Example
The following example is the Before Query script for a query. It retrieves the name
of the query and sets a variable to be used later in the integration.
DeleteSourceFile method
The DeleteSourceFile method allows you to delete the source file used for a text
query.
Syntax
object.DeleteSourceFile({suppress})
Parameters
object—The query object for which the source file will be deleted.
Comments
You can use the DeleteSourceFile method in the After Query script.
162 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 2 1 V B S C R I P T O B J E C T S
Example
The following example is the After Query script for a query. It deletes the source file
from the query.
query.DeleteSourceFile()
DeleteSourceRecords method
The DeleteSourceRecords method allows you to delete the source records from a
simple ODBC query that was used for an integration.
Syntax
object.DeleteSourceRecords({suppress})
Parameters
object—The query object for which the source records used will be deleted.
Comments
You can use the DeleteSourceRecords method in the After Query script.
If the integration was completed successfully, you may want to delete the records
from the source query if they are no longer required.
Example
The following example is the After Query script for a query. It deletes the source
records from the query, without prompting the user.
Query.DeleteSourceRecords(True)
ExecuteSQL method
The ExecuteSQL method allows you to execute a SQL statement for an ODBC
query that was used for an integration.
Syntax
object.ExecuteSQL(SQL_statement)
Parameters
object—The query object for which a SQL statement will be executed.
Comments
The ExecuteSQL method is typically used in the After Query script to complete any
post processing, such as updating a status column, necessary for the data source.
The SQL statement you execute should not produce a result set.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 163
PA RT 5 U S I N G V B S C R I P T
Example
The following example is the After Query script for an integration. It executes a SQL
statement that updates the IntStatus column of the Vendors table to indicate which
items were imported by Integration Manager.
SourceFields object
The SourceFields object is used in scripts attached to fields in the Integration
Mapping window. It refers to any field in the queries that are part of the integration.
Syntax
SourceFields(name)
Parameters
name—A string containing the name of the source field. The full name includes the
name of the query the field is part of, followed by a period. If the source field is part
of the root query for the integration, you do not need to include the query name.
Example
The following example is the Before Document Commit script for a vendor
integration. It retrieves a value of the VendorID field from a query used by the
integration and stores it in a variable to be used later in the integration.
The following example is the Before Document Commit script for a General Ledger
integration. It retrieves a value of the Doc Num field from the GL Header query
used by the integration and stores it in a variable to be used later in the integration.
GPConnection object
The GPConnection object is used in scripts instead of the RetreiveGlobals dynamic
link library that was used in Microsoft Dynamics GP 9.0 and previous versions.
Open method
The Open method allows you to open an ADO connection using the current GP
user login information.This method uses the data source that is in use when
Microsoft Dynamics GP is open. If you want to use a default company database
(TWO or GPDAT) for this method, then you must set the Open value in the
connection string before using the Open method. You will not be able to update the
connection string after the Open method is called. There is no close method for this
object. Once the connection is returned to the same way the connection object was
initially created in the script, that connection object can be closed normally.
Syntax
object.Open({suppress})
Comments
All properties for the Open method will return string values.
164 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 2 1 V B S C R I P T O B J E C T S
Examples
The following example is the Open script. It opens the data connection.
recset = MyCon.Execute(updatecommand )
MyCon.Close
The following are examples of retrieving the properties exposed by the new
GPConnection object.
MsgBox GPConnection.GPConnUserDate
MsgBox GPConnection.GPConnInterCompanyID
MsgBox GPConnection.GPConnUserID
MsgBox GPConnection.GPConnUserName
MsgBox GPConnection.GPConnDataSource
UserDate property
The UserDate property contains the current user date.
Syntax
object.UserDate
CompanyID property
The CompanyID property contains the intercompany ID (company database ID).
Syntax
object.CompanyID
Example
The following is an example of initializing the connection string to specify a default
database. In this case it is set to the current company. This could be set to a constant
database, such as GPDAT.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 165
PA RT 5 U S I N G V B S C R I P T
UserID property
The UserID property contains the current User ID.
Syntax
object.UserID
UserName property
The UserName property contains the name of the current user.
Syntax
object.UserName
Example
The following is an example of creating a string to update the customer name in the
customer master table.
DataSource property
The DataSource property contains the name of the current data source that is being
used in Microsoft Dynamics GP.
Syntax
object.DataSource
166 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Chapter 22: Functions
VBScript contains many built-in functions. The available functions are a subset of
those included in Visual Basic. Most are identical to their Visual Basic counterparts.
• CancelDocument function
• CancelIntegration function
• ClearVariables function
• DocumentIsNew function
• DocumentNo function
• Execute function
• GetVariable function
• LogDetail function
• LogDocDetail function
• LogDocWarning function
• LogWarning function
• PlaySound function
• SetVariable function
CancelDocument function
The CancelDocument function cancels the current document for an integration and
writes an entry to the log file.
Syntax
CancelDocument [message, source, status_code, field_name, field_value]
Parameters
message—An optional string parameter corresponding to the Message item that is
written to the log file for the integration.
Comments
All parameters for this function are optional.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 167
PA RT 5 U S I N G V B S C R I P T
Example
The following example is the Before Document script for an integration. It examines
the Fax number field and cancels the document if no fax number is available.
If IsNull(SourceFields(“Fax”)) Then
CancelDocument “No fax number”, 5000, “Fax”
End If
CancelIntegration function
The CancelIntegration function cancels the current integration and writes an entry
to the log file.
Syntax
CancelIntegration [message, source, status_code]
Parameters
message—An optional string parameter corresponding to the Message item that is
written to the log file for the integration.
Comments
All parameters for this function are optional.
Example
The following example is the Before Integration script for an integration. It displays
a dialog, asking the user to supply a password required to start the integration. If an
incorrect password is supplied, the integration is canceled.
Dim Input
Input = InputBox(“Enter password”, “Password”)
ClearVariables function
The ClearVariables function clears all variables set by the SetVariable function.
Syntax
ClearVariables
Parameters
None
168 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 2 2 F U N C T I O N S
Example
The following is the After Document script for an integration. It clears all variables
that were set earlier in the integration.
ClearVariables
Related items
GetVariable function
SetVariable function
DocumentIsNew function
The DocumentIsNew function returns a value indicating whether the document
(record) being written to a destination is new or is being updated.
Syntax
DocumentIsNew
Parameters
None
Return value
A boolean. True indicates a new document is being written to the destination. False
indicates an existing document is being updated.
Comments
You can use the DocumentIsNew function in the Before Document, Before
Document Commit and After Document scripts.
Example
The following example is the Before Document Commit script for a vendor
integration. The Comment 2 field is set based on whether a new vendor is being
written or an existing vendor is being updated.
DocumentNo function
The DocumentNo function returns a long integer value indicating the sequence of
the current document (record) being written to the destination. The value 1
indicates the first document that was written, 2 indicates the second document that
was written, and so on.
Syntax
DocumentNo
Parameters
None
Return value
A long integer
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 169
PA RT 5 U S I N G V B S C R I P T
Comments
You can use the DocumentNo function in the Before Document, Before Document
Commit and After Document scripts.
Example
The following example is the After Document script for a vendor integration. It
creates a text file that lists whether each document being imported created a new
vendor or updated an existing vendor. The DocumentNo function indicates the
order in which documents were added or updated. The DocumentID variable used
was set in the Before Document script.
Const ForAppending = 8
Dim fso, f
Set fso = CreateObject(“Scripting.FileSystemObject”)
Set f = fso.OpenTextFile(“C:\Program Files\Microsoft Dynamics\Integration
Manager\VendRslt.txt”,
ForAppending, True)
If DocumentIsNew = True Then
f.WriteLine “Document “ & DocumentNo & “ “ &
GetVariable(“DocumentID”) & “ is new.”
Else
f.WriteLine “Document “ & DocumentNo & “ “ &
GetVariable(“DocumentID”) & “ was updated.”
End If
Execute function
The Execute function starts another application.
Syntax
Execute path [, timeout] [, window_style]
Parameters
path—A string parameter specifying the complete path to the application to be
started.
timeout—An optional long integer specifying the time in seconds to allow before
control returns to Integration Manager. If this parameter is not included, the default
timeout of 30 seconds is used. If the value –1 is used, the application launches
asynchronously without any timeout value.
Value Description
0 The window is hidden and focus is passed to the hidden window.
1 The window has focus and is restored to its original size and position.
2 The window is displayed as an icon with focus.
3 The window is maximized with focus.
4 The window is restored to its most recent size and position. The currently active
window remains active.
6 The window is displayed as an icon. The currently active window remains active.
170 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 2 2 F U N C T I O N S
Comments
To have an application run silently, use the value 0 (zero) for the window_style.
Example
The following example is the After Integration script for an integration. It executes
the PostProc.bat file, which performs some post processing actions.
GetVariable function
The GetVariable function retrieves the value of a global variable that was set by the
SetVariable function.
Syntax
GetVariable(variable)
Parameters
variable—A string parameter specifying to the name of the variable to retrieve.
Return value
A variant containing the value of the variable.
Example
The following example is a Before Query script. It reads the value of the Path
variable, which was set in the Before Integration script, and uses the path
information to override the location of the source file for the query.
Query.OverrideFileLocation = GetVariable(“Path”)
Related items
ClearVariables function
SetVariable function
LogDetail function
The LogDetail function writes an activity detail entry to the log file for an
integration.
Syntax
LogDetail [message, source, status_code]
Parameters
message—An optional string parameter corresponding to the Log Text item of the
activity detail entry written to the log file.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 171
PA RT 5 U S I N G V B S C R I P T
Comments
All parameters for this function are optional.
Example
The following example is the Before Integration script for an integration. It prompts
the user for his or her name and writes the value to the log.
Dim Input
Input = InputBox(“Enter your user name.”, “User Name”)
LogDocDetail function
The LogDocDetail function writes an activity detail entry for the current document
to the log file for an integration.
Syntax
LogDocDetail [message, source, status_code, field_name, field_value]
Parameters
message—An optional string parameter corresponding to the Message item of the
document detail entry written to the log file.
Comments
The LogDocDetail function will not write information to the log file if the log level
for the integration is set to Summary.
172 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 2 2 F U N C T I O N S
Example
The following example is the Before Document Commit script for an integration. It
examines the Contact field and logs a message if no contact is supplied.
If IsNull(SourceFields(“Contact”)) Then
LogDocDetail “No contact supplied.”
End If
LogDocWarning function
The LogDocWarning function writes an activity detail entry for the current
document to the log file for an integration and increases the warning count for the
integration by one.
Syntax
LogDocWarning [message, source, status_code, field_name, field_value]
Parameters
message—An optional string parameter corresponding to the Message item of the
document detail entry written to the log file.
Comments
All parameters for this function are optional.
Example
The following example is the Before Document Commit script for an integration. It
examines the Fax number field and logs a warning if no fax number is available.
If IsNull(SourceFields(“Fax”)) Then
LogDocWarning “No fax number.”
End If
LogWarning function
The LogWarning function writes an activity detail entry to the log file for an
integration and increases the warning count for the integration by one.
Syntax
LogWarning [message, source, status_code]
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 173
PA RT 5 U S I N G V B S C R I P T
Parameters
message—An optional string parameter corresponding to the Log Text item of the
activity detail entry written to the log file.
Comments
All parameters for this function are optional.
Example
The following example is the Before Query script for an integration. It overrides the
criteria for the query. The warning indicates that the criteria were overridden.
PlaySound function
The PlaySound function plays a Windows .wav file.
Syntax
PlaySound path
Parameters
path—A string parameter specifying the complete path to the .wav file to be played.
Comments
All parameters for this function are optional.
Example
The following example is the After Integration script for an integration. It plays the
Msremind.wav file to indicate that the integration is complete.
PlaySound “c:\windows\system\Msremind.wav”
SetVariable function
The SetVariable function sets the value of a global variable that can be accessed by
any script in the integration.
Syntax
SetVariable variable, value
Parameters
variable—A string parameter containing the name of the variable to set.
value—A variant containing the value that the variable will be set to.
174 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
C H A P T E R 2 2 F U N C T I O N S
Example
The following example is the Before Integration script for an integration. It reads a
path value from the path.txt file, and uses that value to set the value of the Path
variable.
Const ForReading = 1
Dim fso, f
Set fso = CreateObject(“Scripting.FileSystemObject”)
Set f = fso.OpenTextFile(“C:\Program Files\Microsoft Dynamics\Integration
Manager\path.txt”, ForReading, True)
FilePath = f.ReadLine
SetVariable “Path”, FilePath
Related items
ClearVariables function
GetVariable function
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 175
176 IN T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Glossary Destination mapping
Where information for each item in the
Long integer
A data type that stores integral numeric
integration destination originate. For many values. It must be in the range –2,147,483,648
Adapter items in the destination, the destination to 2,147,483,647.
An Integration Manager component that mapping indicates that information
connects to a destination or source originates from a query. For other items, the LongVarChar
application. mapping indicates that a constant value or a A data type that stores a sequence of up to
default value from Microsoft Dynamics GP 65,535 characters.
Advanced ODBC query should be used.
A query that issues a SQL statement to Mixed element
retrieve information from an ODBC data Document definition Those elements that contain child elements
source. See also Simple ODBC query. The metadata that Integration Manager uses to attributes as well as data.
to describe the structure and content of a Null
Boolean source or destination. It describes recordsets,
The logical value of True or False. A keyword that indicates a field or variable
hierarchical relationships, fields, data types, does not contain valid data.
Comma-delimited file field lengths, and more. It is analogous to an
XML schema, but it usually contains more Numeric
A text file that uses commas to separate the
individual data items in the text file. information than an XML schema. A data type specific to Integration Manager.
It stores decimal values that can have up to
Collections Double 19 digits with up to 5 of the digits after the
See Recordset. A data type that stores a double-precision decimal point.
floating point number. The value can have
.CSV file up to fifteen significant digits. Query
An acronym for Comma-Separated Values. It A request for information. In Integration
Negative values must be in the range
indicates a text file that uses commas to Manager, a query can request information
–1.79769313486232E308 to
separate the individual data items. from text files or from ODBC data sources.
–4.94065645841247E–324.
Currency Positive values must be in the range
Query builder
A data type that is intended to hold A tool in Integration Manager to aid writing
4.94065645841247E–324 to
monetary values. It can have up to four 1.79769313486232E308. a SQL statement to use for an advanced
decimal places and must be in the range ODBC query.
–922,337,203,685,477.5808 to eConnect destination adapter
922,337,203,685,477.5807. An Integration Manager destination adapter
Query relationship
A relationship between two queries that
that enables integration with Microsoft
Data source Dynamics GP data using eConnect.
defines how they work together to retrieve
An ODBC data source from which you information.
retrieve data. Enumeration
A data type that is restricted to a fixed set of
Recordset
Data type named values. Enumeration fields in a An element that is used to map items in an
A data source setting that indicates what integration destination. There are two types
destination correspond to list boxes,
type of data is contained in the column of a of recordsets. One type of recordset simply
drop-down lists and other list controls in
data source. Common data types include Microsoft Dynamics GP. When you set the groups related fields in the destination. The
booleans, currencies, integers and strings. other type of recordset indicates that several
value of an enumeration field, you supply
sets of fields in the recordset can be
Delimiter the integer value that corresponds to one of
the items in the enumeration. See also associated with a single instance of a record
A character or characters that separate the imported into the destination. These
individual data items in a text file. Commas Translation.
recordsets are represented by the folder icon.
and tab characters are often used as Filter
delimiters.
Specifies the criteria for determining
Rejection file
A text file that contains records that were
Destination precisely which documents to extract from
the source. You can define filters only for rejected from text queries by Integration
Where data gathered by Integration Manager. Rejection files have the .rjt
Manager is placed in Microsoft Dynamics those fields located in the Root Recordset.
extension.
GP. Integration Manager provides several Integer
common destinations, such as customer
A data type that stores integral numeric
Restriction
information or receivables transactions. A set of criteria that allows you to specify the
values. It must be in the range –32,768 to
32,767. A set of integrations that are rows that will be included in a query. All
Destination adapter rows that do not fit the criteria are excluded.
A feature that validates data before performed in succession in a specified order.
integrating it to the destination application Integration Manager engine Rule
or database such as Microsoft Dynamics GP. Defines where the information for an item in
An Integration Manager component that
the destination mapping originate.
receives data from the source adapter,
provides mapping and transformation Simple ODBC query
functionality, and passes data to a A query that retrieves data from an ODBC
destination adapter. data source. See also Advanced ODBC query.
Join
A database operation that combines some or
all records from two or more tables.
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 177
GLOS SA RY
Single XML
A data type that stores a single-precision Extensible Markup Language (XML) is the
floating point number. The value can have standard method of viewing data on the
up to seven significant digits. Web. Rich, structured data from any
application can be easily described in a
Negative values must be in the range
standard and consistent manner through the
–3.402823E38 to –1.401298E–45. use of XML. It also is a complementary
Positive values must be in the range format of HTML.
1.401298E–45 to 3.402823E38.
XSLT
Source eXtensible Stylesheet Language for
Indicates where the data to be integrated Transformations (XSLT) is used as a part of
comes from. A source can either be a text file, XSL, which functions as a stylesheet
a database, or an application language for XML. XSL includes an XML
vocabulary for specifying formatting; XSL
Source adapter specifies the styling of an XML document by
A feature that connects to a database, text file using XSLT to describe how the document is
or application source. It filters and extracts transformed into another XML document
the data from the source before passing the that uses the formatting vocabulary.
information to the Integration Manager
engine.
Source data
Shows data from the source one document at
a time and in the structure of the document
definition.
Source name
The name of the source document definition
that you are setting up. This name appears in
the Add Source window. You may use any
name that helps you easily identify this
source document definition.
Source settings
Source settings connect the source document
definition to an actual source by having you
specify certain parameters. They are
additional properties relating to a source and
are associated with an individual
integration. They are not, however,
automatically inherited by other integrations
that use the same source document
definition.
String
A data type that stores a sequence of up to
255 characters.
Tab-delimited file
A text file that uses tab characters to separate
the individual data items in the text file.
Text query
A query that retrieves data directly from text
files.
Translation
Allows you to define a relationship between
values in the source file and corresponding
values that are used for the destination field.
VBScript
A subset of the Microsoft Visual Basic
programming language that is embedded
into Integration Manager to provide
scripting capabilities.
178 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Index advanced ODBC queries
data source 111
changes since last release, information
about 4
general properties 111 child queries 55
A properties 111 child recordsets
About Integration Manager menu query description 111 described 70
command 28 query name 111 not integrating 86
About this Window menu command 28 SQL statement 111 ClearVariables statement 168
Access, compacting the database 101 After Document script, order of events 153 Close access key 28
access keys After Document script event 150 Close Integration, command 26
About Integration Manager 28 After Integration script, order of events Close sources, order of events 153
About this Window 28 153 column
Add Destination 27 After Integration script event 150 Column Name property 112
Add Source 27 After Query script event 151 Datatype property 112
Apply 28 After Source script, order of events 153 Is Key property 112
Cancel 28 Apply access key 28 properties 112
Cascade 27 attaching Show property 112
Close 28 a script to an integration 81, 149 Size property 112
Close Integration 26 scripts to a source 151 Column Name, column property 44
Contents 28 Attempted field, integration results 82 Column Properties window 112
Destination Settings 27 Attributes field column property
Exit 26 on the Destination Properties Column Name 44
Export Integrations 26 window Fields tab 67 Datatype 44
Help 28 on the Destination Properties Is Key 44
Import Integrations 26 window General tab 66 Show 44
Index 28 Size 44
Mapping 27 B command, Export Integrations 26
New Integration 26, 28 backing up, IntegrationManager.mdb 13 command line
New Integration Group 26 Before Document commit script, order of running integrations from 107
Object Browser 27 events 153 starting integrations from 109
OK 28 Before Document Commit script event 150 starting Microsoft Dynamics GP from
Open 28 Before Document script, order of events 108
Open Integration 26 153 commands
Open Integration Group 26 Before Document script event 150 Add Destination 25
Options 27 Before Integration script, order of events Add Source 25
Print 26 153 Close Integration 26
Properties 27 Before Integration script event 150 Exit 26
Registration 27 Before Query script event 151 File 26
Remove Script 26 Before Source script, order of events 153 Import Integrations 26
Remove Translation 26 Blank rule 71 Mapping 25
Run 27 Boolean data type 59 New Integration 26
Source Settings 27 browsers, supported for script library 12 New Integration Group 26
Tile Hortizontally 27 building, an integration 32 Objects 25
Tile Vertically 27 buttons Open Integration 26
understanding 26 Add Destination 25 Open Integration Group 26
adapters Add Source 25 Print 25, 26
destination adapters defined 8 Mapping 25 Properties 27
source adapters defined 8 New Integration 25 Relationships 26
Add Destination command 25 Objects 25 Remove Script 26
Add Destination menu command 27 Open Integration 25 Remove Translation 26
Add Destination shortcut key 28 Print 25 Run 25
Add Destination window 64 Properties 25 Save Integration 26
Add Source command 25 Relationships 25 compacting, the Access database 101
Add Source menu command 27 Run 25 Contents menu command 28
Add Source shortcut key 28 Save 25 converting, Integration Manager
Add Source window 38 databases 23
adding C copying, an integration 34
destinations 63 Cancel access key 28 Count object property 158
simple ODBC sources 40 CancelDocument statement 167 Create New Data Source window 102
sources 38 CancelIntegration statement 168 creating
text sources 40 Cascade menu command 27 a new integration 32
AdditionalCriteria object property 161 an integration group 105
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 179
IN DEX
180 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
I N D E X
First Row Contains Column Names, Integration Error script event 150 LogDocWarning statement 173
general property for a text source 42 Integration Failed field, integration results login macro, recording 107
Fixed Length, destination property field 82 logs
attribute 67 integration group managing integration 97
FullName object property 155 creating 105 purging 99
functions, in VBScript 167 defined 105 understanding integration log levels
starting 106 97
G integration log levels understanding integration log
general properties Document 97 storage types 97
Data Source 43 None 97 viewing 98
Delimiter 42 Summary 97 LogWarning statement 173
First Row Contains Column Names Trace 97 Long Integer data type 60
42 Integration Log Viewer window 99
setting up for a text source 41 Integration Manager database M
setting up for an ODBC source 42 Convert 23 macro, recording login 107
Table 43 Create new 23 Macro window 108
General rule properties 73 Integration Manager Engine, defined 8 managing integration logs 97
GetVariable function 171 Integration Manager engine, defined 7 mapping
global translations, creating 76 Integration Manager main workspace command 25
GPConnection object 164 window 24 creating 69
GPConnection object properties 165 Integration Mapping window 70, 74, 75 shortcut key 28
Group By, sorting property 46 Integration menu commands 27 troubleshooting problems 86
grouping, in query builder 114 integration results mapping menu command 27
guidelines Attempted field 82 master queries 55
for running integrations 79 Integrated Successfully field 82 menu commands
query relationships 55 Integrated with Warning field 82 About Integration Manager 28
Integration Failed field 82 About this Window 28
H Total Queried field 82 Add Destination 27
handling rejected records 83 Integration Window Add Source 27
Has Default, destination property field Logs tab on 81 Cascade 27
attribute 67 Scripts tab on 81 Contents 28
HasDefault object property 157 Integration window 32, 35, properties on Destination Settings 27
help, displaying 3 80 Edit 26
Help access key 28 IntegrationManager.mdb, backing up 13 Help 28
Help menu, described 3 integrations Index 28
Help menu command 28 copying 34 Integration 27
creating new 32 Mapping 27
I editing properties 91 Object Browser 27
icons, used in manual 3 Options 27
exporting 91
ID field, on the Destination Properties Properties 26
importing 91
window Fields tab 67 Registration 27
opening existing 34
IM Registration Utility, using 15 Remove 27
parts of defined 31
Import command 50 Run 27
running 81
Import Integrations command 26 Source Settings 27
starting from command line 109
importing, integrations 91 Tile Horizontally 27
troubleshooting 85
incorrect data, in Microsoft Dynamics GP Tile Vertically 27
Internet Explorer, and the script library 12
88 Tools 27
Is Key, column property 44, 112
Index menu command 28 View 26
Item object property 159
Insert Allowed, destination property Window 27
general attribute 66 J message, new code 14
Insert and Update, Destination Edit Mode joins, creating in query builder 114 MessageText object property 160
80 Microsoft Dynamics GP
Insert Only, Destination Edit Mode 80 L incorrect data after integration 88
installing 13, 19 LastError object property 159 launching Integration Manager from
preparing for 12 launching Integration Manager 21
verifying the installation 21 from Microsoft Dynamics GP 21 starting from command line 108
Integer data type 60 from the start menu 21 troubleshooting problems 88
Integrated Successfully field, integration library, VBScript 152 Microsoft Dynamics GP standard,
results 82 local translations 75 destination adapter defined 119
Integrated with Warning field, integration LogDetail statement 171 missing
results 82 LogDocDetail statement 172 data for field value 85
integration, displaying error details 22
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 181
IN DEX
182 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
I N D E X
I N TE G R A T I O N M A N A G E R U S E R ’ S G U I D E 183
IN DEX
184 I N T E G R A T I O N M A N A G E R U S E R ’ S G U I D E
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies: