Microsoft Dynamics AX Connector -...

Microsoft Dynamics AX Connector

Ch Installation Manual

Microsoft Dynamics AX Connector Installation GuideVersion 3.0Copyright Bottomline Technologies, Inc. 2008.All Rights ReservedInformation in this document is subject to change without notice and does notrepresent a commitment on the part of Bottomline Technologies. BottomlineTechnologies makes no warranties with respect to this documentation anddisclaims any implied warranties of merchantability or fitness for a particularpurpose.

Bottomline Technologies325 Corporate DrivePortsmouth, NH 03801Telephone: (603) 436-0700Fax: (603) 436-0300Email: [email protected]: www.bottomline.comSWR-CFIMDAX30-REF

v

. . . . .

T A B L E O F C O N T E N T S

Section 1: Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Section 2: Installing Create!form Integration Components . . . . . . . . . 9

Section 3: Installing Microsoft Dynamics AX Components . . . . . . . . 13

Determining Installation Type . . . . . . . . . . . . . . . . . . . . . . . 18Installation Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Section 4: Automatic Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Section 5: Manual Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Object Classes Available for Import and/or Modification. . . . . . . . . 35

Appendix A: Object Classes Available for import and/or modification 35

Object Classes Available for Import or Modification . . . . . . . . . . . . 43

Appendix B: Microsoft Dynamics AX 4.0 Connector Components Object Classes Available for Import or Modification . . . . . . . . . . . . . 43

Forms Available for Import or Modification . . . . . . . . . . . . . . . . . . . 44

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Microsoft Dynamics AX Connector Installation Guide v

vi. . .

. .

vi
Microsoft Dynamics AX Connector Installation Guide

S E C T I O N

INTRODUCTION

This guide describes the process necessary for installing Create!form in a waythat ensures its successful integration with Microsoft Dynamics AX. Thefollowing topics are covered:

Note• Code provided by Bottomline Technologies to successfully integrate

with Microsoft Dynamics AX should never be modified. • Bottomline Technologies software installer does not perform uninstalls.• There is no upgrade process for this integration from Microsoft

Dynamics AX Connector 2.x. This is because prior versions only supported Microsoft Dynamics AX 4.0.

• If you have multiple AOS Servers you need to complete the process documented in this manual for every Server you have installed.

• Bottomline recommends that you back up your entire Dynamics AX system prior to performing this install.

• Installing Create!form Integration Components• Installing Microsoft Dynamics AX Components• Automatic Installation• Manual Installation• Microsoft Dynamics AX Connector Help Installation

Section 1:Introduction

Microsoft Dynamics AX Connector Installation Guide 7

. . . . .8 S E C T I O N 1 : I N T R O D U C T I O N

8

S E C T I O N

INSTALLING CREATE!FORM INTEGRATION COMPONENTS

Note• Although the screen shots in this document show the integration

installation being performed on Microsoft Dynamics AX 2009, the installation process outlined in this manual also applies to Microsoft Dynamics AX 4.0.

• Create!form Components must be installed on the same server as Create!form Server.

To install CF Components

1 Insert the CD and click AX CF Connector Components.

Section 2:InstallingCreate!formIntegrationComponents


. . . . .10 S E C T I O N 2 : I N S T A L L I N G C R E A T E ! F O R M I N T E G R A T I O N C O M P O N E N T S

10

2 After the Install Shield launches click Next.


11

. . . . .S E C T I O N 2 : I N S T A L L I N G C R E A T E ! F O R M I N T E G R A T I O N C O M P O N E N T S

3 Use the Browse button to select the folder location for the model Create!form projects, then click Next,-OR-accept the default folder by pressing the Next button.


. . . . .12 S E C T I O N 2 : I N S T A L L I N G C R E A T E ! F O R M I N T E G R A T I O N C O M P O N E N T S

12

4 If one of the model projects exists in the selected folder, then a message appears confirming that the projects should be replaced. This warning is to prevent production Create!form projects from being inadvertently over- written.

5 Press the Finish button to complete the setup Wizard.


S E C T I O N

INSTALLING MICROSOFT DYNAMICS AX COMPONENTS

NoteAX Components must be installed on a machine with an AX Client or AOS Server.

To install Microsoft Dynamics AX Components

1 Insert the CD and click either AX 2009 Connector Components, or AX 4.0 Connector Components, depending on the version of AX being used.

2 When Install Shield launches, click Next.

Section 3:InstallingMicrosoftDynamicsAXComponents


. . . . .14 S E C T I O N 3 : I N S T A L L I N G M I C R O S O F T D Y N A M I C S A X C O M P O N E N T S

14

3 Accept the license agreement and click Next.

4 Use the Change button to select the folder location for the AX Connector Components, then click Next-OR-


15

. . . . .S E C T I O N 3 : I N S T A L L I N G M I C R O S O F T D Y N A M I C S A X C O M P O N E N T S

accept the default folder by pressing the Next button.

5 Click Install to begin installing AX Connector Components.



16

17


6 Determine whether an automatic or manual install should be performed.• Selecting Manual will end the installation• Selecting Automatic will launch the Automatic installer

Refer to Determining Installation Type for more information on deciding which install to perform.



Determining Installation Type

18

Determining Installation TypeNoteThe following sections assume that you have at least a working knowledge of Microsoft Dynamics AX.

Before installing the integration you must verify whether 3rd PartyIndependent Software Vendor (ISV) modifications were made to theApplication Object Tree (AOT) objects outside the System layer of MicrosoftDynamics AX. This verification will determine the type of installation,Manual or Automatic, that you perform.

Installation TypesThere are two types of installation:• Manual -

• If there are conflicts between Bottomline’s XPO code and an object modified outside the System layer, then you MUST perform a Manual installation.

• If there are no conflicts but you would prefer to import the XPO through the AX Client, then you can also choose a Manual installation.

• Automatic - If there are NO conflicts between Bottomline’s XPO code and objects modified outside the System layer, and you wish to perform a straightforward installation, you can choose the Automatic option.

To determine the Installation type

1 Open Microsoft Dynamics AX client.2 On the Dynamics AX toolbar click the Projects Window button.3 Click on the Import button in the Projects Window. The Import dialog box

appears.


19



4 On the Import dialog box, deselect the Import with ID values check box.5 Installation type is determined by running the backup XPO to see where

objects/classes have been modified. If using Dynamics AX, version 4.0, browse in the project SharedProject_BT_DPA_AX40_Ver_3_0_Backup_Def.xpo. If using Dynamics AX 2009 browse in the project BT_DPA_AX2009_Ver_3_0_Backup_Def.xpo. This is a definition project so it does not contain any AOT object information.

6 If using Dynamics AX 2009, open the project BT_DPA_AX2009_Ver_3_0_Backup_Def.xpo under the shared projects branch in the Project Window. If using Dynamics AX, version 4.0 open the project SharedProject_BT_DPA_AX40_VER_3_0_Backup_Def.xpo.

7 Check to see if any of the classes are modified outside of the sys layer. If AOT objects in the project are modified outside the sys layer, a manual install must be preformed. Otherwise, if preferred, an Automatic Installation may be performed.

8 (Optional) Depending on the version of Dynamics AX, the BT_DPA_AX2009_Ver_3_0_Backup_Def.xpo, or the SharedProject_BT_DPA_AX40_VER_3_0_Backup_Def.xpo are lists of objects that are modified (a project with just the objects), and useful for backing up existing objects that Create!form Integration for Dynamics AX modifies. To back up existing objects, right click on the project in the Projects Window and select Export. In the Export Window, deselect “Export with ID values” and “Export Labels” if they are checked. Then click OK.

Note




20

Refer to the Appendix A: Object Classes Available for Import and/or Modification for a list of objects that Bottomline imports and / or modifies.


S E C T I O N

AUTOMATIC INSTALLATION

NoteAll users MUST exit the Microsoft Dynamics AX Client BEFORE beginning the installation process.On some Dynamics AX configurations the Synchronization service is installed and active. This service needs to be stopped (navigate to the start menu >Control Panel > Administrative Tools > Services) before the automatic installation continues. Remember to restart the service when the installation is complete.Refer to Determining Installation Type for questions regarding which installation type to perform.

To perform an automatic installation

1 In the Installer window, on the Please Provide Path to AX Application field, type or browse in the path for AX AOS Application Folder.

Section 4:AutomaticInstallation


. . . . .22 S E C T I O N 4 : A U T O M A T I C I N S T A L L A T I O N

22

Figure 3.1: The Installer window

2 In the Select Application Instance field, click the drop down menu and select an Application Instance.

3 In the Path to AX Client field type or browse in the path to the AX Client.4 In the Configuration File field type or browse in the Configuration file if

different than the default.5 If your Application Object Server is installed on a different machine than

the Client machine, type the AOS machine name into the AX Service Machine name field.

6 In the AX Service name field, type the AX Service name.


23

. . . . .S E C T I O N 4 : A U T O M A T I C I N S T A L L A T I O N

7 On the bottom of the screen click Install. A warning box displays. Click Yes to proceed with the installation.

8 After each time the Client launches and the import completes, manually close the Client.

Figure 3.2: Compiler displaying import status

9 During the import, click Yes to All when warning messages about overwriting layers are displayed.

NoteUsers may not immediately see the Overwrite message as it sometimes appears behind another window. However, if the install is taking too long, check for an Overwrite message by minimizing the window that is currently running. This step cannot be skipped, and Yes to All must be selected in the Overwrite message, to finish the Install. Should a warning box appear during the import process it may be ignored, as the warnings are resolved during multiple compilation passes. Errors, however, should not be ignored and the installation should be halted if they are encountered.


. . . . .24 S E C T I O N 4 : A U T O M A T I C I N S T A L L A T I O N

24

Figure 3.3: Example of the Warning box that displays during import

10 Once the install is complete a confirmation prompt displays. Click OK.

Figure 3.4: Installation window with confirmation prompt and Installation status bar displayed.

11 Click Finished to exit the installation.

The automatic installation process is complete.


S E C T I O N

MANUAL INSTALLATION

Note• This section assumes that you are familiar with Microsoft Dynamics AX

development and the Application Object Tree. Only AX Administrators with ISV implementation knowledge should attempt to perform a Manual installation.

• All users MUST exit the Microsoft Dynamics AX Client BEFORE beginning the installation process.

For manual installation

1 Locate the label file named axDPA<lang-code>.ald, on the installation CD.2 Copy the label files from the CD into the AOS file system for the target

instance, located at <AX-install-dir>\Application\Appl\<instance-name>.3 Restart the AOS service:

1 To restart the AOS service click the Start menu at the bottom of your screen.

2 On the Start menu, click Control Panel.3 On the Control Panel click Administrative Tools. 4 On the Administrative Tools menu, click Services.

Section 5:ManualInstallation


. . . . .26 S E C T I O N 5 : M A N U A L I N S T A L L A T I O N

26

Figure 3.5: The Services screen

4 On the Services screen, in the Name field, highlight Dynamics AX Objects.5 On the left side of the screen, click Restart the service.6 Launch the Dynamics AX Client.7 Log on to Dynamics AX Client as an Administrator User.8 On the Dynamics AX toolbar click the Projects Window icon located next to

the AOT icon.


27

. . . . .S E C T I O N 5 : M A N U A L I N S T A L L A T I O N

Figure 3.6: Dynamics AX with the Project Window icon circled

9 In the Project Window icon, on the toolbar, click the Import button.



28

10 In the Import window deselect the Import with ID Values checkbox if it is selected.

11 Click the Show Details checkbox.12 Click the Browse button and Browse in the XPO from the files previously

installed in the Determining the Installation Type section.13 In the Import window, on the Import From tab, deselect the AOT check box.

Figure 3.7: The Import window with AOT branch expanded and individual check box circled

14 Expand each branch and click the checkbox next to each individual item if there is no conflict between Bottomline’s XPO code and an object modified outside the System layer.

15 If conflicts are found, select the conflicted item and click Compare.


29


Figure 3.8: Conflicted item Comparison screen

16 In the comparison window select the layer, by clicking the drop down menu to compare to the XPO. Click the Compare button.

17 Browse through the various elements and import Bottomline’s changes which are wrapped with Bottomline DPA comments.

18 Click the right arrow to paste Bottomline’s code, and, if necessary, click the left arrow to remove the legacy code.



30

Figure 3.9: Comparison screen with Bottomline’s changes before they are imported.


31


Figure 3.10: Comparison screen with Bottomline’s changes after they are imported.

19 Close the Comparison window after resolving conflicts.20 Repeat steps 9-19 until all conflicts are resolved.21 Verify that you have selected the check boxes next to all non-conflicting

objects in the Import window.22 On the bottom of the Import screen click OK to begin importing.23 If a warning box pops up during the import click Yes to overwrite the

change.



32

Figure 3.11: Example of the Warning box that could pop up during the import process

24 The import is complete when the Compiler says Import Completed at the bottom of the screen.

Figure 3.12: Compiler displaying import status

25 If there are any warnings after the import is complete, they should be ignored since they are resolved during multiple compilation passes. Errors, however, should not be ignored.

26 Compile forward the FormLetter class: 1 On the top of the screen, in the toolbar, click the Project Window icon.2 On the left side of the project window, expand the Shared branch.3 Open the BT_DPA project and scroll down to the FormLetter class.4 Right click FormLetter.5 On the menu, scroll down to Add-Ins.6 On the Add-Ins menu, click Compile Forward.


33


27 Close down the AX Client.28 Relaunch the Dynamics AX Client.29 From the Navigation pane, select Admin.30 On the Content pane, at the bottom of the Setup section, the Create!form

menu is displayed.

The manual import process is complete.



34

A P P E N D I X

MICROSOFT DYNAMICS AX CONNECTOR COMPONENTS

Object Classes Available for Import and/or Modification

* Existing Class

• CustVendCheque*• classDeclaration• fillSlipTxt• output• slipTxtLines• BT_DPA_ShowPDFThread• classDeclaration• btShowPDF• run• runThread• BT_DPA_StartupCmdInstall• classDeclaration

Appendix A:ObjectClassesAvailable forimport and/ormodification


. . . . .36 A P P E N D I X A : O B J E C T C L A S S E S AV A I L A B L E F O R I M P O R T A N D / O R M O D I F I C A T I O N

36

• infoRun• BT_DPA_LoadPrintSettings• classDeclaration• getDestinationNameForMedium• loadFromBtPrintSettings• packIntoPrintJobSettings• packIntoSysPrintOptions• parmEmailBCC• parmEmailBody• parmEmailCC• parmEMailDestinationName• parmEmailFrom• parmEmailSubject• parmEmailTo• parmFaxCoverText

• parmFaxDestinationName• parmFaxNumber• parmPrintCopies• parmPrinterCopies• parmPrinterDestinationName• parmPrintMedium• parmProcessDestinationName• parmReportName• parmScreenDestinationName• parmStrPrintMedium• saveIntoBtPrintSettings• unpackFromPrintJobSettings• unpackFromSysPrintOptions


37

. . . . .A P P E N D I X A : O B J E C T C L A S S E S AV A I L A B L E F O R I M P O R T A N D / O R M O D I F I C A T I O N

• validBTData• getNextStr• packStrings• passReportName• printMediumFromStr• unpackStrings• BT_DPA_Global• classDeclaration• new• BT_DPA• BT_DPA_Version• BT_DPA_Version_Num• btStrFmtlb• btStrFmtVar• cloneList

• containsClassMethod• containsMethod• getClassName• getDictClassFromClassName• getDictClassFromObject• getFormControlType• getFormCache



38

• invoke• isChequeReport• isInList• NumberOfTablesInPurchParm• NumberOfTablesInSalesParm• numberOfRemittanceLinesPerPage• removeFromCache• saveToCache• str2boolean• strCount• writeDebugStr• DateToString• BT_DPA_Report2Xml• btFilesAppending• btProlog

• classDeclaration• dateTimeToString• DeleteOldXmlFiles• endFooterSection• endHeaderSection• endPage• endReport• endSection• getDefaultDateTimeString• isIncluded• new• saveXmlDocuments• startFooterSection


39


• startHeaderSection• startPage• startReport• startSection• timeToString• writeAutoLabel• writeBitmap• writeControl• writeControlElement• writeDate• writeDateTime• writeEnum• writeField• writeInt64• writeInteger

• writeLabel• writeReal• writeShape• writeStaticText• writeString• writeSum• writeTime• xmlWriterSaveFile• BT_DPA_XmlWriter• addAsInnerXML• classDeclaration• endElement• new



40

• parmDocument• save• setAttribute• setValueStr• startElement• construct• BT_DPA_Installer• add2GlobalClass• add2GloballClass• add2SysFormAbout• addtoSysFormAbout• classDeclaration• compileForward• deleteIntermediateProjects• addCode2Method

• createMethod• main• ClassFactory*• createViewer• BT_DPA_TableNumSequenceGenerator• classDeclaration• getNextNum• setNextNum• FormLetter*• btParmDocNum• classDeclaration• combineIntoOneReport• getPMDocType


41


• PrintMgmtSetupUISettingsCtl*• getDestinationDesc• editPrintJobSettingsOnServer• PurchFormLetter*• classDeclaration• initParameters• new• run• callPrintersettingsFormletter• RunBaseDialogModify*• btSetPrinterValues• initPrinterSettings• updatePrinterSettings• RunBaseReportDialog*• main

• SalesFormLetter*• classDeclaration• initParameters• new• parmCombineIntoOneReport• resetParmListCommonCS• run• update• callPrintersettingsFormletter• SysReportRun*• btCurrentPrintJobSettings• btGetCurNumInBatch• btInit



42

• btPostProcessing• btPutSectionNamesInFont• btTraverseReportSections• classDeclaration• DeleteOldPreviewPDFs• get_BT_DPA_Destination• getBtDefaults• getBtReports• getCommonFile• getCurNumInBatch• getFileName• getFilePath• getNumberDocsInBatch• getOriginalPrintMedium• getPdfFileName

• getPdfFilePath• getPrintSettings• isBatchMode• isChequeReport• parmIsBtEnabled• print• run• SysStartupCmd*• construct


A P P E N D I X

MICROSOFT DYNAMICS AX 4.0 CONNECTOR COMPONENTS

Object Classes Available for Import or Modification

* Existing Class

• BT_DPA_Global• BT_DPA_EP_Report2XML• BT_DPA_Report2Xml• BT_DPA_StartupCmdInstall• BT_DPA_LoadPrintSettings• BT_DPA_PackageShowPDFSettings• BT_DPA_ReportTraverser• BT_DPA_XmlWriter• BT_DPA_Installer• BT_DPA_TableNumSequenceGenerator• ClassFactory*• EPSendDocument*

Appendix B:MicrosoftDynamicsAX 4.0ConnectorComponentsObjectClassesAvailable forImport orModification


. . . . .44 A P P E N D I X B : M I C R O S O F T D Y N A M I C S A X 4 . 0 C O N N E C T O R C O M P O N E N T S O B J E C T

C L A S S E S AV A I L A B L E F O R I M P O R T O R M O D I F I C A T I O N

44

• CustVendCheque*• FormLetter*• PurchFormLetter*• PurchFormLetter_Invoice*• PurchFormLetter_PackingSlip*• PurchFormLetter_PurchOrder*• PurchFormLetter_ReceiptsList*• RunBaseDialogModify*• RunBaseReportDialog*• SalesFormLetter*• SalesFormLetter_Confirm*• SalesFormLetter_Invoice*• SalesFormLetter_PackingSlip*• SalesFormLetter_PickingList*• SalesQuotationEditLinesForm*

• SysReportRun*• SysStartupCmd*• VendOutPaym_Cheque*

Forms Available for Import or Modification

*Existing Form• BT_DPA_AskPageNum• BT_DPA_Defaults• BT_DPA_Destinations• BT_DPA_Enabled_Reports• BT_DPA_ShowPDF• BT_DPA_ShowPDFProgress


45

. . . . .A P P E N D I X B : M I C R O S O F T D Y N A M I C S A X 4 . 0 C O N N E C T O R C O M P O N E N T S O B J E C T


• BT_DPA_Processes• PurchEditLines*• SalesEditLines*• SysPrintForm*• SysAbout*


. . . . .46 A P P E N D I X B : M I C R O S O F T D Y N A M I C S A X 4 . 0 C O N N E C T O R C O M P O N E N T S O B J E C T


46

47

. . . . .I N D E X

I N D E XIndex

CCreate!form for Microsoft Dynamics AX

Automatic Installation 21

DDetermining Installation Type 18

IInstallation Types 18Installing Create!form Integration Components 9Installing Microsoft Dynamics AX Components 13Introduction 7

MManual Installation 25Microsoft Dynamics AX 4.0 Connector Components

object classes available for import of modification 43Microsoft Dynamics AX Connector Compoenents

object classes available for import and/or modification 35


. . . . .48 I N D E X

48

Microsoft Dynamics AX Connector -...

Documents

Transcript of Microsoft Dynamics AX Connector -...