Microsoft INTEGRATION MANAGER SETUP GUIDE
Microsoft Dynamics™ GP
Integration Manager Quick Start
Copyright
Copyright © 2005 Microsoft Corporation. All rights reserved.
Complying with all applicable copyright laws is the responsibility of the user. Without
limiting the rights under copyright, no part of this document may be reproduced, stored in
or introduced into a retrieval system, or transmitted in any form or by any means
(electronic, mechanical, photocopying, recording, or otherwise), or for any purpose, without
the express written permission of Microsoft Corporation. Notwithstanding the foregoing,
the licensee of the software with which this document was provided may make a
reasonable number of copies of this document solely for internal use.
Trademarks
Intellectual property
Warranty disclaimer
Limitation of liability
License agreement
Microsoft, Microsoft Dynamics, and Windows are either registered trademarks or
trademarks of Microsoft Corporation or its affiliates in the United States and/or other
countries. FairCom and c-tree Plus are trademarks of FairCom Corporation and are
registered in the United States and other countries.
The names of actual companies and products mentioned herein may be trademarks or
registered marks - in the United States and/or other countries - of their respective owners.
Unless otherwise noted, the example companies, organizations, products, domain names,
e-mail addresses, logos, people, places, and events depicted herein are fictitious. No
association with any real company, organization, product, domain name, e-mail address,
logo, person, place, or event is intended or should be inferred.
Microsoft may have patents, patent applications, trademarks, copyrights, or other
intellectual property rights covering subject matter in this document. Except as expressly
provided in any written license agreement from Microsoft, the furnishing of this document
does not give you any license to these patents, trademarks, copyrights, or other intellectual
property.
Microsoft Corporation disclaims any warranty regarding the sample code contained in this
documentation, including the warranties of merchantability and fitness for a particular
purpose.
The content of this document is furnished for informational use only, is subject to change
without notice, and should not be construed as a commitment by Microsoft Corporation.
Microsoft Corporation assumes no responsibility or liability for any errors or inaccuracies
that may appear in this manual. Neither Microsoft Corporation nor anyone else who has
been involved in the creation, production or delivery of this documentation shall be liable
for any indirect, incidental, special, exemplary or consequential damages, including but not
limited to any loss of anticipated profit or benefits, resulting from the use of this
documentation or sample code.
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.
Publication date
October 2005
Contents
Introduction................................................................................................................................. 2
What’s in this manual .................................................................................................................. 3
Prerequisites .................................................................................................................................. 4
Symbols and conventions............................................................................................................ 4
Resources available from the Help menu .................................................................................5
Printable manuals......................................................................................................................... 5
Send us your documentation comments...................................................................................6
Part 1: Getting Started................................................................................................. 8
Chapter 1: Starting Integration Manager....................................................... 9
Starting Integration Manager......................................................................................................9
Getting around the main window............................................................................................10
Understanding the Integration Manager toolbar................................................................... 11
Using the shortcut keys .............................................................................................................12
Understanding the Integration Manager menus ................................................................... 13
Chapter 2: Understanding the Terminology............................................. 17
Source ........................................................................................................................................... 17
Source adapters...........................................................................................................................17
Integration Manager engine......................................................................................................17
Destination................................................................................................................................... 18
Destination adapters ..................................................................................................................18
Destination mappings................................................................................................................ 18
Query............................................................................................................................................ 18
Query relationship...................................................................................................................... 18
Part 2: Building an Integration...................................................................... 20
Chapter 3: Creating Integrations........................................................................ 21
Creating a new integration........................................................................................................ 21
Removing duplicate sources .....................................................................................................23
INTEGRATION MANAGER QUICK START i
CONTENTS
Chapter 4: Adding Sources....................................................................................... 25
Understanding sources.............................................................................................................. 25
Understanding the source files ................................................................................................ 27
Creating the GL Header query................................................................................................. 29
Previewing source data ............................................................................................................. 33
Creating the GL Line query......................................................................................................34
Chapter 5: Creating Query Relationships.................................................... 39
Relationship guidelines............................................................................................................. 39
Creating relationships ............................................................................................................... 39
Chapter 6: Adding a Destination......................................................................... 43
Understanding destinations ..................................................................................................... 43
Adding the Microsoft Dynamics GP destination .................................................................. 44
Chapter 7: Mapping Source Data to the Destination....................... 47
Understanding the Mapping window .................................................................................... 47
Mapping fields............................................................................................................................ 49
Mapping line items for the transaction................................................................................... 52
Setting options for the General Journal destination.............................................................. 56
Part 3: Running an Integration....................................................................... 60
Chapter 8: Running the Integration.................................................................. 61
Preparing to run the integration .............................................................................................. 61
Running the integration ............................................................................................................ 64
Chapter 9: Verifying the Results.......................................................................... 67
Verifying the integration results .............................................................................................. 67
What to do next .......................................................................................................................... 69
Glossary.........................................................................................................................................71
Index
ii INTEGRATION MANAGER QUICK START
................................................................................................................................................... 75
INTRODUCTION
Introduction
Integration Manager is a tool designed to help you move data quickly and
easily between applications—without the need for custom programming or
extensive knowledge of application databases.
In the Ingegration Manager Quick Start guide, you use simple tabdelimited text files as a data source and Microsoft Dynamics™ GP as the
destination, but Integration Manager does not limit you to this kind of
integration. You can combine its many source and destination adapters to
create integrations that meet your needs. No matter which combination of
sources and destinations you eventually use, the steps to building and
running integrations are basically the same.
Basic steps for creating integrations
Step 1 Open a new integration.
Step 2 Add a source.
Step 3 Set source properties or establish query relationships, depending on
which source adapter you are using.
Step 4 Add a destination (and provide destination settings if the adapter requires
them).
Step 5 Map the source data to the destination.
Step 6 Run the integration.
Whether you’ve used other integration tools or you’re new to integration
technology, use this manual to familiarize yourself with Integration
Manager, the integration tool that puts information at your
fingertips—checked, verified, and ready-to-use.
This introduction includes the following information:
• What’s in this manual
• Prerequisites
• Symbols and conventions
• Resources available from the Help menu
• Printable manuals
• Send us your documentation comments
2 INTEGRATION MANAGER QUICK START
What’s in this manual
This manual is a hands-on learning tool to help you become familiar with
Integration Manager. If you have used other data integration tools, use this
manual to understand how Integration Manager handles integrations.
Specifically, this manual shows you how to create an integration that
extracts data from an ODBC/Text source and integrates it into Microsoft
Dynamics GP. 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.
The manual is divided into the following parts:
INTRODUCTION
• Part 1,
discusses the terminology used in the integration process.
• Part 2,
integration that extracts data from an ODBC/Text source and integrates
it into the General Ledger for Microsoft Dynamics GP. By working
through the steps, you gain a basic understanding of Integration
Manager.
• Part 3,
integration as well as how to run it and verify the results.
After you are familiar with the steps presented in this manual, you can
continue to the Integration Manager User’s Guide which provides detailed
information about Integration Manager and the adapters.
Getting Started, explains how to start Integration Manager and
Building an Integration, describes the steps used to create an
Running an Integration, explains how to prepare to run the
INTEGRATION MANAGER QUICK START 3
INTRODUCTION
Prerequisites
This manual assumes you are familiar with the Microsoft Dynamics GP
family of financial applications. Knowledge of integration products and
experience working with data in tabular format is helpful, but it is not
essential to perform the tasks discussed in this manual.
This manual assumes you are using the Microsoft Dynamics GP test company. If
you are not using the test company, the sample data files may not be in the correct
format and may not work with your company without modification. You can
modify the structure in the text files by opening these files in Notepad.
Also, this manual assumes Integration Manager is already installed.
Because the tasks are arranged in sequential order, it’s important that you
perform the tasks in the order they are presented.
This manual uses the sample files GLHEADER.txt and GLLINE.txt. Before
you begin, make sure these files exist in the Samples folder, usually
C:\Program Files\Microsoft Dynamics\Integration Manager\Samples. If
you cannot locate the Sample files at this location, browse to the location
where Integration Manager was installed. If you cannot find these files,
contact your system administrator or Product Support.
General Ledger is included in the Microsoft Dynamics GP product. This manual
uses the term General Ledger to more fully describe the integration source and
destination.
Symbols and conventions
For definitions of unfamiliar terms, see the glossary in the manual or refer
to the glossary in Help.
Symbol Description
The light bulb symbol indicates helpful tips, shortcuts and
suggestions.
The warning symbol indicates situations you should be
especially aware of when completing tasks.
4 INTEGRATION MANAGER QUICK START
INTRODUCTION
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 >
Print
TAB or ENTER All capital letters indicate a key or a key sequence.
The (>>) or (>) symbol indicates a sequence of actions, such as
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.
Resources available from the Help menu
The Integration Manager Help menu gives you access to user assistance
resources on your computer.
Contents
Opens the Help file for Integration Manager, and displays the main
“contents” topic. To browse a more detailed table of contents, click the
Contents tab above the Help navigation pane.
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.
Index
Opens the Help file for Integration Manager, 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.
About this window
Displays overview information about the current window. To view related
topics and descriptions of the fields, buttons, and menus for the window,
choose the appropriate link in the topic. You also can press F1 to display
Help about the current window.
Printable manuals
The Integration Manager manuals are available in Adobe Acrobat .pdf
format, which you can print or view. The default installation folder for the
documentation is C:\Program Files\Microsoft Dynamics\Integration
Manager\Help\Documentation.
INTEGRATION MANAGER QUICK START 5
INTRODUCTION
Send us your documentation comments
We welcome comments regarding the usefulness of the Microsoft Dynamics
GP documentation. If you have specific suggestions or find any errors in
this manual, send your comments by e-mail to the following address:
bizdoc@microsoft.com
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.
.
6 INTEGRATION MANAGER QUICK START
PART 1: GETTING STARTED
Part 1: Getting Started
This part explains how to start Integration Manager and discusses the basic
terminology used in the integration process.
The information is divided into the following chapters:
• Chapter 1, “
Integration Manager, discusses the Integration Manager main window,
and introduces the menu commands and toolbar buttons.
• Chapter 2, “
terminology used in Integration Manager.
Before you use Integration Manager, review the information in this part of
the manual. Understanding the basics of integrations makes learning the
product easier.
Starting Integration Manager,” describes how to start
Understanding the Terminology,” introduces the
8 INTEGRATION MANAGER QUICK START
Chapter 1: Starting Integration Manager
As soon as you have installed Integration Manager, you can begin using it.
This chapter describes how to start Integration Manager and describes the
components that make up the Integration Manager main window.
This chapter includes the following information:
• Starting Integration Manager
• Getting around the main window
• Understanding the Integration Manager toolbar
• Using the shortcut keys
• Understanding the Integration Manager menus
Starting Integration Manager
You can start Integration Manager from the Start menu or from within
Microsoft Dynamics GP.
To start Integration Manager:
1. From the task bar, choose Start, choose Programs, and then choose
Microsoft Dynamics.
2. From the Integration Manager program group, choose Integration
Manager.
INTEGRATION MANAGER QUICK START 9
PART 1 GETTING STARTED
The main Integration Manager workspace opens.
– Or –
You also can start Integration Manager from within Microsoft
Dynamics GP. From the Tools menu, choose Integrate, and then choose
Integration Manager.
Buttons in the window become available only after you choose to create
a new integration or open an existing one.
If the Integration Manager registration window opens, you need to either
register Integration Manager or contact the Customer Assistance Department
for registration keys. You have the ability to sample some adapters without
registration keys; integrations, however, can be run only when Integration
Manager is registered.
You’re now ready to familiarize yourself with the features of Integration
Manager.
Getting around the main window
You perform all Integration Manager tasks in the main workspace. From
this workspace, you can access the following:
The Toolbar The Integration Manager toolbar consists of buttons for
commonly used commands in Integration Manager.
10 INTEGRATION MANAGER QUICK START
CHAPTER 1 STARTING INTEGRATION MANAGER
The Menus The menus include the commands available in
Integration Manager.
Understanding the Integration Manager toolbar
The Integration Manager toolbar appears in the upper portion of the main
window. Each button that appears on the toolbar represents an action you
can perform in Integration Manager. The following table lists the buttons in
the toolbar:
Button Description
Creates a new integration.
Opens an existing integration.
Prints information about the integration.
Saves the current integration.
Displays the properties for an integration, source, or destination.
Opens the Object Browser.
Opens the Add Source window, from which you select a source for the
current integration. The source you can add depends on the adapter you
have installed. If you do not have any adapters installed, you can still
add an ODBC or a text source.
Opens the Relationships window, where you create relationships
between Text or ODBC source queries.
INTEGRATION MANAGER QUICK START 11
PART 1 GETTING STARTED
Button Description
Using the shortcut keys
Shortcut keys, also known as accelerator keys, are used with the CTRL key
for menu commands that are used often. Not all menu commands have an
accelerator key.
The following table contains a list of the shortcut keys for commonly used
menu commands.:
Opens the Add Destination window, from which you select the
destination for the current integration. The destination you can add
depends on which adapters you have installed.
Opens the Integration Mapping window.
Runs the current integration.
Menu command Shortcut key
File New Integration CTRL+N
Open Integration CTRL+O
Save Integration CTRL+S
Print CTRL+P
View Relationships CTRL+L
Integration Add Source CTRL+A
Add Destination CTRL+D
Mapping CTRL+M
Run CTRL+R
12 INTEGRATION MANAGER QUICK START
CHAPTER 1 STARTING INTEGRATION MANAGER
Understanding the Integration Manager menus
The following table lists the commands that are available in Integration
Manager. It also lists the access keys corresponding to the commands.
In Microsoft
by default until you press the
Windows® 2000 and Microsoft Windows XP, access keys are hidden
ALT key.
Menu commands Description Access key
File menu New Integration Creates a new integration. ALT+F+N
Open Integration Opens an existing integration. ALT+F+O
Close Integration Closes the current integration. ALT+F+C
New Integration
Group
Open Integration
Group
Save Integration Saves the current integration. ALT+F+S
Save Integration AsMakes a copy of the current
Import
Integrations
Export
Integrations
Print Prints a report of the
Exit Exits the current session of
Edit menu Remove Script In the Integration Mapping
Remove
Translation
Creates a new integration
group.
Opens an existing integration
group.
integration.
Imports integrations from other
Integration Manager databases
(usually IM.mdb files).
Exports integrations to existing
IM.mdb files. You also can
create a new IM.mdb file for the
integrations you export.
integration.
Integration Manager.
window, removes the script
associated with a field.
In the Integration Mapping
window, removes the
translation associated with a
field.
ALT+F+G
ALT+F+R
ALT+F+A
ALT+F+I
ALT+F+E
ALT+F+P
ALT+F+X
ALT+E+S
ALT+E+T
INTEGRATION MANAGER QUICK START 13
PART 1 GETTING STARTED
Menu commands Description Access key
View menu Relationships Opens the Relationships
Integration Add Source Adds a source to the current
Tools menu Object Browser Opens the Object Browser
CTRL+L
windows, in which you create
the relationship between the
text or ODBC source queries
used for the current integration.
Properties Displays the properties of the
integration, selected source or
destination.
ALT+I+A
integration.
Add Destination Adds a destination for the
ALT+I+D
current integration.
Remove Removes the selected source or
destination from the current
integration.
Mapping Opens the Integration Mapping
ALT+I+M
window for the current
integration.
Source Settings Opens the Source Settings
ALT+I+U
window allowing you to specify
connection information for the
source adapters that require
these settings.
Destination
Settings
Opens the Destination Settings
window, allowing you to
ALT+I+S
specify connection information
for destination adapters that
require these settings.
Run Runs the current integration. ALT+I+R
Properties Displays the properties of the
ALT+I+E
integration.
ALT+T+O
window.
Registration Allows you to register
ALT+T+R
Integration Manager.
Options Opens a window from which
ALT+T+P
you can change options for
Integration Manager such as
the location of the Integration
Manager database (usually
called IM.mdb) or substitute
pathname translations.
14 INTEGRATION MANAGER QUICK START
CHAPTER 1 STARTING INTEGRATION MANAGER
Menu commands Description Access key
Window
menu
Tile Horizontally Lists all open windows and
arranges them horizontally.
Tile Vertically Lists all open windows and
arranges them vertically.
Cascade Displays all open windows in
cascading order.
Help menu Contents Provides access to the online
help for Integration Manager.
Index Contains help topics from the
online help for Integration
Manager.
About this
Window
Contains help information
about the window displayed on
the screen.
About
Integration
Manager
Provides the version, location,
and description of the installed
Integration Manager and its
adapters.
ALT+W+H
ALT+W+V
ALT+W+C
ALT+H+C
ALT+H+I
ALT+H+W
ALT+H+A
INTEGRATION MANAGER QUICK START 15
16 INTEGRATION MANAGER QUICK START
Chapter 2: Understanding the Terminology
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.
This chapter includes definitions for the following terms:
• Source
• Source adapters
• Integration Manager engine
• Destination
• Destination adapters
• Destination mappings
• Query
• Query relationship
Source
A source indicates where the requested information to be integrated comes
from. In Integration Manager, a source can be anything from a comma- or
tab-delimited file, a database such as an Open Database Connectivity
source (ODBC), and Extensible Markup Language (XML) files. Sources
exist independently of the source adapters. However, which source you can
add to your integration depends on the source adapter you have installed.
Refer to Chapter 4, “
Adding Sources,” for more information.
Source adapters
Source adapters connect to sources, filter, and extract data. The data is then
passed on to the Integration Manager engine for processing. The type of
source adapter you install determines which source you can add to your
integration. If you do not have any source adapters installed, you can still
add an ODBC/Text source, which this manual explains how to use.
Integration Manager engine
Working with the source adapter and destination adapter, the Integration
Manager engine helps you map and transform the source data into the
destination.
INTEGRATION MANAGER QUICK START 17
PART 1 GETTING STARTED
Destination
A destination indicates where you want the processed information to be
integrated. Destinations can be an application, a database, or an XML file.
Destinations also exist independently of the destination adapters. Examples
of destinations include Microsoft Dynamics GP, and XML files.
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 any destination. This manual explains
how to integrate data from an ODBC/Text source through the Microsoft
Dynamics GP adapter into the Microsoft Dynamics GP General Ledger.
Destination mappings
Destination mappings define how source data is mapped to the destination.
Typically, the information comes from the source you specified, but it can
also come from a constant value or a 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. Query relationships tell Integration Manager how the queries work
together during the integration. For more information on creating query
relationships, refer to Chapter 5, “
18 INTEGRATION MANAGER QUICK START
Creating Query Relationships.”
PART 2: BUILDING AN INTEGRATION
Part 2: Building an Integration
This part of the manual describes how to build an integration. Each chapter
contains a detailed step-by-step procedure that you can refer to later when
creating your own integrations.
This manual uses the sample files GLHEADER.txt and GLLINE.txt. Before you
begin, make sure these files exist in the Samples folder, usually C:\Program
Files\Microsoft Dynamics\Integration Manager\Samples. If the Samples folder
cannot be located at this location, browse to the location where Integration
Manager was installed. If you cannot find these files, contact your system
administrator or Product Support.
This manual is arranged in sequential order. Therefore, it’s important that
you go through the tasks in the order they are presented.
The information is divided into the following chapters:
• Chapter 3, “
create them.
• Chapter 4, “
retrieve information for the integration.
• Chapter 5, “
create query relationships and how to create them.
• Chapter 6, “
destination for the integration.
• Chapter 7, “
map the source data to the destination.
Creating Integrations,” discusses integrations and how you
Adding Sources,” explains how to add sources, which
Creating Query Relationships,” describes why you need to
Adding a Destination,” explains how to select the
Mapping Source Data to the Destination,” describes how to
20 INTEGRATION MANAGER QUICK START
Chapter 3: Creating Integrations
The first step in building any integration is to create the integration. The
integration is the primary object that manages all the components necessary
to integrate data into a specified destination.
This chapter includes the following information:
• Creating a new integration
• Removing duplicate sources
Creating a new integration
To begin an integration, you can create a new integration or open an
existing integration. This guide shows you how to create a new integration.
To create a new integration:
1. Start Integration Manager.
2. From the File menu, choose New Integration.
– Or –
From the Integration Manager toolbar, choose New Integration.
The Integration window and then the Properties window opens.
INTEGRATION MANAGER QUICK START 21
Loading...