Microsoft Dynamics AX Connector. Installation Manual

Transcription

1 Microsoft Dynamics AX Connector Installation Manual

2

3 Microsoft Dynamics AX Connector Installation Guide Version 3.1 Copyright Bottomline Technologies, Inc All Rights Reserved Information in this document is subject to change without notice and does not represent a commitment on the part of Bottomline Technologies. Bottomline Technologies makes no warranties with respect to this documentation and disclaims any implied warranties of merchantability or fitness for a particular purpose. Bottomline Technologies 325 Corporate Drive Portsmouth, NH Telephone: (603) Fax: (603) [email protected] Internet: SWR-CFIMDAX31-REF

4

5 T ABLE OF CONTENTS v Section 1: Introduction Section 2: Installing Create!form Integration Components Section 3: Installing Microsoft Dynamics AX Components Determining Installation Type Installation Types.. 23 Section 4: Automatic Installation 27 Section 5: Manual Installation..33 Object Classes Available for Import and/or Modification Appendix A: Object Classes Available for import and/or modification 43 Object Classes Available for Import or Modification.. 47 Appendix B: Microsoft Dynamics AX 4.0 Connector Components Object Classes Available for Import or Modification Forms Available for Import or Modification Index Microsoft Dynamics AX Connector Installation Guide v

6 vi vi Microsoft Dynamics AX Connector Installation Guide

7 S ECTION Section 1: Introduction INTRODUCTION This guide describes the process necessary for installing Create!form in a way that ensures its successful integration with Microsoft Dynamics AX. Note Code provided by Bottomline Technologies to successfully integrate with Microsoft Dynamics AX should never be modified. 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 Microsoft Dynamics AX system prior to performing this install. The following topics are covered in this manual: Installing Create!form Integration Components Installing Microsoft Dynamics AX Components Automatic Installation Manual Installation Microsoft Dynamics AX Connector Help Installation Hardware and Software Requirments The Bottomline Dynamics AX Connector uses the same requirements as Microsoft Dynamics AX. No additional hardware or system requirements are needed. Please refer to the Microsoft Dynamics AX documentation for details on the hardware and system requirements. Microsoft Dynamics AX Connector Installation Guide 7

8 8 SECTION 1: INTRODUCTION 8 Microsoft Dynamics AX Connector Installation Guide

9 S ECTION Section 2: Installing Create!form Integration Components 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 Create!form Components 1 Insert the CD and click AX CF Connector Components. Microsoft Dynamics AX Connector Installation Guide 9

10 10 SECTION 2: INSTALLING CREATE!FORM INTEGRATION COMPONENTS 2 On the Microsoft Dynamics AX Connector screen, click the correct version of Microsoft Dyamics AX Connector you are using. Figure 2.1: 10 Microsoft Dynamics AX Connector Installation Guide

11 SECTION 2: INSTALLING CREATE!FORM INTEGRATION COMPONENTS 11 3 On the Microsoft Dynamics AX Connector screen, click AX 2009 CF Connector Components. Note If you select AX 4.0 Connector Components in the previous screen, click AX 4 Connector Components. Microsoft Dynamics AX Connector Installation Guide 11

12 12 SECTION 2: INSTALLING CREATE!FORM INTEGRATION COMPONENTS 4 On the Welcome screen, click Next. 12 Microsoft Dynamics AX Connector Installation Guide

13 SECTION 2: INSTALLING CREATE!FORM INTEGRATION COMPONENTS 13 5 On the Install Shield Wizard screen, click Finish. Microsoft Dynamics AX Connector Installation Guide 13

14 14 SECTION 2: INSTALLING CREATE!FORM INTEGRATION COMPONENTS 14 Microsoft Dynamics AX Connector Installation Guide

15 S ECTION Section 3: Installing Microsoft Dynamics AX Components INSTALLING MICROSOFT DYNAMICS AX COMPONENTS Note AX 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. Microsoft Dynamics AX Connector Installation Guide 15

16 16 SECTION 3: INSTALLING MICROSOFT DYNAMICS AX COMPONENTS 2 On the Microsoft Dynamics AX Connector screen, click AX 2009 (or 4, if you are installing 4.0) AX Connector Components. 16 Microsoft Dynamics AX Connector Installation Guide

17 SECTION 3: INSTALLING MICROSOFT DYNAMICS AX COMPONENTS 17 3 On the Welcome screen, click Next. Microsoft Dynamics AX Connector Installation Guide 17

18 18 SECTION 3: INSTALLING MICROSOFT DYNAMICS AX COMPONENTS 4 On the License screen, if you agree with the terms,click Yes. 18 Microsoft Dynamics AX Connector Installation Guide

19 SECTION 3: INSTALLING MICROSOFT DYNAMICS AX COMPONENTS 19 5 On the Choose Destination Location screen, click Change to select a location or click Next to select the default location. Microsoft Dynamics AX Connector Installation Guide 19

20 20 SECTION 3: INSTALLING MICROSOFT DYNAMICS AX COMPONENTS 6 On the Ready to Install the Program screen, click Install. 7 Click Install to begin installing AX Connector Components. 20 Microsoft Dynamics AX Connector Installation Guide

21 SECTION 3: INSTALLING MICROSOFT DYNAMICS AX COMPONENTS 21 Microsoft Dynamics AX Connector Installation Guide 21

22 22 SECTION 3: INSTALLING MICROSOFT DYNAMICS AX COMPONENTS 8 On the Automatic or Manual Install screen, determine whether an automatic or manual install should be performed. Selecting Manual will end the installation Selecting Automatic will launch the Automatic installer 9 Refer to Determining Installation Type for more information on deciding which install to perform 22 Microsoft Dynamics AX Connector Installation Guide

23 SECTION 3: INSTALLING MICROSOFT DYNAMICS AX COMPONENTS Determining Installation Type 23 Determining Installation Type Note The following sections assume that you have at least a working knowledge of Microsoft Dynamics AX. Before installing the integration you must verify whether 3rd Party Independent Software Vendor (ISV) modifications were made to the Application Object Tree (AOT) objects outside the System layer of Microsoft Dynamics AX. This verification will determine the type of installation, Manual or Automatic, that you perform. Installation Types There 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. Microsoft Dynamics AX Connector Installation Guide 23

24 24 SECTION 3: INSTALLING MICROSOFT DYNAMICS AX COMPONENTS Determining Installation Type 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. 24 Microsoft Dynamics AX Connector Installation Guide

25 SECTION 3: INSTALLING MICROSOFT DYNAMICS AX COMPONENTS Determining Installation Type 25 Note Refer to the Appendix A: Object Classes Available for Import and/or Modification for a list of objects that Bottomline imports and / or modifies. Microsoft Dynamics AX Connector Installation Guide 25

26 26 SECTION 3: INSTALLING MICROSOFT DYNAMICS AX COMPONENTS Determining Installation Type 26 Microsoft Dynamics AX Connector Installation Guide

27 S ECTION Section 4: Automatic Installation AUTOMATIC INSTALLATION Note All users MUST exit the Microsoft Dynamics AX Client BEFORE beginning the installation process. On some Microsoft 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. Microsoft Dynamics AX Connector Installation Guide 27

28 28 SECTION 4: AUTOMATIC INSTALLATION Figure 4.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. 28 Microsoft Dynamics AX Connector Installation Guide

29 SECTION 4: AUTOMATIC INSTALLATION 29 7 (2009 only) In the Choose AX 2009 Version section, click to install or not to install the Service Pack. 8 On the bottom of the screen click Install. A warning box displays. Click Yes to proceed with the installation. 9 After each time the Client launches and the import completes, manually close the Client. Figure 4.2: Compiler displaying import status 10 During the import, click Yes to All when warning messages about overwriting layers are displayed. Note Users 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. Microsoft Dynamics AX Connector Installation Guide 29

30 30 SECTION 4: AUTOMATIC INSTALLATION 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. Figure 4.3: Example of the Warning box that displays during import 11 Once the install is complete a confirmation prompt displays. Click OK. Figure 4.4: Installation window with confirmation prompt and Installation status bar displayed. 30 Microsoft Dynamics AX Connector Installation Guide

31 SECTION 4: AUTOMATIC INSTALLATION Click Finished to exit the installation. The automatic installation process is complete. Microsoft Dynamics AX Connector Installation Guide 31

32 32 SECTION 4: AUTOMATIC INSTALLATION 32 Microsoft Dynamics AX Connector Installation Guide

33 S ECTION Section 5: Manual Installation 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. Microsoft Dynamics AX Connector Installation Guide 33

34 34 SECTION 5: MANUAL INSTALLATION Figure 5.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. 34 Microsoft Dynamics AX Connector Installation Guide

35 SECTION 5: MANUAL INSTALLATION 35 Figure 5.6: Dynamics AX with the Project Window icon circled 9 In the Project Window icon, on the toolbar, click the Import button. Microsoft Dynamics AX Connector Installation Guide 35

36 36 SECTION 5: MANUAL INSTALLATION 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 5.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. 36 Microsoft Dynamics AX Connector Installation Guide

37 SECTION 5: MANUAL INSTALLATION 37 Figure 5.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. Microsoft Dynamics AX Connector Installation Guide 37

38 38 SECTION 5: MANUAL INSTALLATION Figure 5.9: Comparison screen with Bottomline s changes before they are imported. 38 Microsoft Dynamics AX Connector Installation Guide

39 SECTION 5: MANUAL INSTALLATION 39 Figure 5.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. Microsoft Dynamics AX Connector Installation Guide 39

40 40 SECTION 5: MANUAL INSTALLATION Figure 5.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 5.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. 40 Microsoft Dynamics AX Connector Installation Guide

41 SECTION 5: MANUAL INSTALLATION 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. Microsoft Dynamics AX Connector Installation Guide 41

42 42 SECTION 5: MANUAL INSTALLATION 42 Microsoft Dynamics AX Connector Installation Guide

43 A PPENDIX Appendix A: Object Classes Available for import and/or modification MICROSOFT DYNAMICS AX CONNECTOR COMPONENTS Object Classes Available for Import and/or Modification DPA Classes: BT_DPA_Package Attachments BT_DPA_LoadPrintSettings BT_DPA_Global BT_DPA_Installer BT_DPA_EP_Report2XML BT_DPA_Report2Xml BT_DPA_PackageShowPDFSettings BT_DPA_ReportTraverser BT_DPA_StartupCmdInstall BT_DPA_TableNumSequenceGenerator BT_DPA_XmlWriter Microsoft Dynamics AX Connector Installation Guide 43

44 44 APPENDIX A: OBJECT CLASSES AVAILABLE FOR IMPORT AND/OR MODIFICATION * Existing Class ClassFactory CustVendCheque FormLetter FormLetterReport PrintMgmtSetupUISettingsCtl PurchFormLetter RunBaseDialogModify RunBaseReportDialog SalesFormLetter SalesQuotationEditLinesForm SysReportRun SysStartupCmd VendOutPaym_Cheque 44 Microsoft Dynamics AX Connector Installation Guide

45 APPENDIX A: OBJECT CLASSES AVAILABLE FOR IMPORT AND/OR MODIFICATION 45 Microsoft Dynamics AX Connector Installation Guide 45

46 46 APPENDIX A: OBJECT CLASSES AVAILABLE FOR IMPORT AND/OR MODIFICATION 46 Microsoft Dynamics AX Connector Installation Guide

47 A PPENDIX Appendix B: Microsoft Dynamics AX 4.0 Connector Components Object Classes Available for Import or Modification 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* Microsoft Dynamics AX Connector Installation Guide 47

48 48 APPENDIX B: MICROSOFT DYNAMICS AX 4.0 CONNECTOR COMPONENTS OBJECT CLASSES AVAILABLE FOR IMPORT OR MODIFICATION 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 48 Microsoft Dynamics AX Connector Installation Guide

49 APPENDIX B: MICROSOFT DYNAMICS AX 4.0 CONNECTOR COMPONENTS OBJECT CLASSES AVAILABLE FOR IMPORT OR MODIFICATION 49 BT_DPA_Processes PurchEditLines* SalesEditLines* SysPrintForm* SysAbout* Microsoft Dynamics AX Connector Installation Guide 49

50 50 APPENDIX B: MICROSOFT DYNAMICS AX 4.0 CONNECTOR COMPONENTS OBJECT CLASSES AVAILABLE FOR IMPORT OR MODIFICATION 50 Microsoft Dynamics AX Connector Installation Guide

51 Index INDEX I NDEX 51 Numerics BT Heading 1 Installing Create!form Integration Components 9 A Automatic Installation 27 C Create!form for Microsoft Dynamics AX Automatic Installation 27 D Determining Installation Type 23 F Forms 48 H Hardware and Software Requirments 7 I Installation Types 23 Installing Create!form Integration Components 9 Installing Microsoft Dynamics AX Components 15 Introduction 7 M Manual Installation 33 Microsoft Dynamics AX 4.0 Connector Components object classes available for import of modification 47 Microsoft Dynamics AX Connector Compoenents object classes available for import and/or modification 43 Microsoft Dynamics AX Connector Installation Guide 51

52 52 INDEX O Object Classes 43, 47 T To determine the Installation type 23 To install Create!form Components 9 52 Microsoft Dynamics AX Connector Installation Guide