Perceptive Connector for Microsoft Dynamics AX

Transcription

1 Perceptive Connector for Microsoft Dynamics AX Installation and Setup Guide Version: 2.4.x Written by: Product Knowledge, R&D Date: February 2018

2 2016 Lexmark. All rights reserved. Lexmark is a trademark of Lexmark International, Inc., registered in the U.S. and/or other countries. All other trademarks are the property of their respective owners. No part of this publication may be reproduced, stored, or transmitted in any form without the prior written permission of Lexmark.

3 Table of Contents What is Connector for Microsoft Dynamics AX?... 4 Required components... 4 Software prerequisites... 4 Conditions for installing the web service... 5 Installation and setup... 5 Download the required files from the Customer Portal... 5 Import Perceptive Connector for Microsoft Dynamics AX model... 6 Run the Perceptive Connector for Microsoft Dynamics AX executable file... 7 Create and configure service endpoints automatically... 7 Obtain the WSDL URI... 9 Delete an existing AIF service endpoint... 9 Configure AX Connector manually to call additional AIF Service Groups... 9 Validate proxy dll in custom service group Check in AX developer workspace

4 What is Connector for Microsoft Dynamics AX? Perceptive Connector for Microsoft Dynamics AX is a SOAP-based web service that you can integrate with your application to fetch data from Microsoft Dynamics AX and create an invoice. For example, if you integrate Perceptive Connector for Microsoft Dynamics AX with an eform, it acts as a medium layer that fetches data from Microsoft Dynamics AX to populate fields in the eform. Based on the populated fields, you may create an invoice in Microsoft Dynamics AX. Required components Software prerequisites Before you install Perceptive Connector for Microsoft Dynamics AX, you must have the following software installed on the target computer. The operating system must be Windows Server 2008R2. Microsoft Dynamics AX Server, versions 2012 R2 CU6 or R2 CU7, R3, R3 CU8, R3 CU9, R3 CU10, R3 CU11, R3 CU12 and R3 CU13 Microsoft Dynamics AX AIF services is successfully deployed Microsoft Dynamics AX Client, versions 2012 R2 CU6 or R2 CU7, R3, R3 CU8, R3 CU9, R3 CU10, R3 CU11, R3 CU12 and R3 CU13.NET Framework 4.0 for AX 2012 R2 CU6 and R2 CU7.NET Framework 4.5 for AX 2012 R3, R3 CU8 and R3 CU9, R3 CU10, R3 CU11, R3 CU12 and R3 CU13 ASP.NET Internet Information Service (IIS), version 7 or higher You must have the following executable file ready for use. PerceptiveConnectorforMSDynamicsAXSetup_2.4.x.x.exe Based on the Microsoft Dynamics AX version you use, you must have one of the following Perceptive Connector for Microsoft Dynamics AX models ready to be imported into Microsoft Dynamics AX. PerceptiveAXConnectorR2CU62.4.x.xxx.axmodel PerceptiveAXConnectorR2CU72.4.x.xxx.axmodel PerceptiveAXConnectorR3CU82.4.x.xxx.axmodel PerceptiveAXConnectorR3CU92.4.x.xxx.axmodel PerceptiveAXConnectorR3CU102.4.x.xxx.axmodel PerceptiveAXConnectorR3CU112.4.x.xxx.axmodel PerceptiveAXConnectorR3CU122.4.x.xxx.axmodel PerceptiveAXConnectorR3CU132.4.x.xxx.axmodel 4

5 Conditions for installing the web service Before installing the web service, you must complete the following steps to prepare the system. 1. Uninstall any previous version of Perceptive Connector for Microsoft Dynamics AX. Note If you want to save the previous configuration file, create a backup for the DAXConnectorConfiguration.xml file. 2. In Windows Features, turn IIS on and, under Application Development Features, under World Wide Web Services, select the ASP.NET check box. 3. Run the ASP.NET IIS Registration Tool (Aspnet_regiis.exe) for.net Framework, versions 4 and 4.5. At the Command Prompt, type the following command and press Enter. %windir%\microsoft.net\framework\<v4.x.x>\aspnet_regiis.exe i where <v4.x.x> is the absolute version of the.net Framework. Notes This is mandatory if.net Framework is installed after installing IIS. If you know the windows directory that contains the IIS Registration Tool, you may provide the absolute path. The system you use must host the Microsoft Dynamics AX Server or be in the same domain as the Microsoft Dynamics AX Server. The identity of the IIS Application Pool must be executed as an AX Administrator level service account. Installation and setup To install and set up Perceptive Connector for Microsoft Dynamics AX, perform the following procedures. 1. Download the required files from the Customer Portal. 2. Import Perceptive Connector for Microsoft Dynamics AX model. 3. Run the Perceptive Connector for Microsoft Dynamics AX executable file. 4. Create and configure service endpoints automatically. Download the required files from the Customer Portal To download the required the files from the Customer Portal, complete the following steps. 1. Go to the Lexmark Enterprises Software website at and log in to the Customer Portal. 2. In the Product Downloads page, search for all downloadable items for Perceptive Connector for Microsoft Dynamics AX, version 2.4. For details, see the Software prerequisites section. 3. Download the PerceptiveConnectorforMSDynamicsAXSetup_2.4.x.x.exe file to a temporary directory on your computer. 4. Download the Perceptive Connector for Microsoft Dynamics AX model for your environment to a temporary directory on your computer. 5

6 Import Perceptive Connector for Microsoft Dynamics AX model Prerequisite Before importing the model, close the client connections to the Application Object Server (AOS) instance with which you are working. If more than one server is using the same database, stop all other AOS instances. To import the model, complete the following steps. 1. Open a Command Prompt window. 2. Navigate to the directory for the management utilities. Typically, the location of this directory is %ProgramFiles%\Microsoft Dynamics AX\60\ManagementUtilities. 3. At the Command Prompt window, type the import command and then press Enter. The import command syntax is axutil import /file:<file name> where <File name> is the absolute path of the model file. 4. After completion, start the AOS. 5. Open Microsoft Dynamics AX Client. A dialog box appears with the message that the new model has been modified and provides options to run the model as required. 6. To upgrade the model, in the Microsoft Dynamics AX dialog box, perform one of the following actions. If you are uploading the model for the first time, select Start the model upgrade checklist, click OK, and then proceed with the instructions that follow. If you uploaded the same model before, select Compile and synchronize and click OK. 7. Optional. If you selected the Compile and synchronize option, generate the Incremental CIL build from X++ after the compilation and database synchronization is complete. To generate the Incremental CIL build from X++, complete the following substeps. 1. In Microsoft Dynamics AX Client, open New Development Workspace and right-click AOT. 2. Click Add-Ins and then click Incremental CIL generation from X++. When the process is complete, proceed with the usual operations. 8. After importing the model, to deploy the INAPEFormServiceGroup service group, complete the following substeps. 1. In Microsoft Dynamics AX Client, open New Development workspace. 2. Under AOT, under Service Groups, right-click INAPEFormServiceGroup and click Deploy Service Group. 6

7 Run the Perceptive Connector for Microsoft Dynamics AX executable file To execute the Perceptive Connector for Microsoft Dynamics AX executable file, complete the following steps. 1. Run the PerceptiveConnectoforMSDynamicsAXSetup_2.4.x.x.exe file on the target computer in administrator mode. 2. In the Perceptive Connector for Microsoft Dynamics AX Installation Wizard window, complete the following substeps. 1. In the Welcome to the Perceptive Connector for Microsoft Dynamics AX Installation Wizard page, click Next. 2. In the License Agreement page, scroll down to the end of the agreement, select the I accept the terms in the license agreement check box. 3. Click Next. 3. In the Ready to Install the Program page, click Install. 4. After the installation is complete, in the Installation Wizard Completed section, complete the following substeps. 1. Click Finish to exit the Installation Wizard. 2. Optional. To create endpoints automatically, select the Launch the Manage Endpoints application check box. 3. Optional. To view the windows installer log, select the Display installer log check box. Create and configure service endpoints automatically There are instances where you need to configure the AX Connector to call more than one AIF Service Group. This process is automated through an application that can create and delete endpoints. Prerequisites IIS (Internet Information Services) is required to run the application. You must install IIS before proceeding with the executable file and execute the PerceptiveConnectorMSDynamicsAXSetup_2.4.x.x.exe file in the target computer. To create and configure AIF endpoints automatically, complete the following steps. 1. To launch the Manage Endpoints application, complete one of the following procedures. In the Perceptive Connector for Microsoft Dynamics AX Installation Wizard, in the Installation Wizard Completed section, select the Launch the Manage Endpoints application check box. From the Start menu, right-click the Manage Endpoints application and open it in administrator mode. 2. In the Manage Endpoints window, complete the following substeps: 1. Click New. 2. In the Endpoint name box, type the endpoint name used to publish this service. An Application Pool with the name of <endpoint name>apppool and a website with the name of <endpoint name> are created. 3. In the Website section, complete the following substeps. 7

8 1. In the Service port number box, type the port number used to publish the service. 2. Click Authenticate. 3. In Application Pool Identity credentials window, provide the following credentials. Optional. In the User name box, type the user name in the format <Domain\User name>. Optional. In the Password box, type the password. Note You must enter valid Application Pool Identity credentials in IIS or recreate an endpoint by deleting the existing one. If the Application Pool Identity credentials are left blank, the built-in NetworkService is used to authenticate the application pool. In IIS, the user must change the network service account to a Dynamics AX service account with administrative privileges in the Microsoft Dynamics AX Server prior to the first use. The user must be in the same domain as that of the server where the Perceptive Connector for Microsoft Dynamics AX is installed. If Microsoft Dynamics AX Server and Perceptive Connector for Microsoft Dynamics AX are on separate computers, ensure that both the computers are in the same domain. 4. Click OK. 4. In the WSDL URIs section, complete the following substeps. 1. In the Metadata service URL box, enter the Meta data service URI. Perceptive Connector for Microsoft Dynamics AX does not support any modification of this web service. The standard format for WSDL URI is server hostname or IP address>:<port number of AIF services>/dynamicsax/services/ MetaDataService?wsdl. 2. In the Query service URL box, enter the Query service URI. Perceptive Connector for Microsoft Dynamics AX does not support any modification of this web service. The standard format for WSDL URI is server hostname or IP address>:<port number of AIF services>/dynamicsax/services/ QueryService?wsdl. 3. In the Method service URL box, enter the Method service URI. This service is available only if you deploy the INAPEFormServiceGroup service group after importing the model. The standard format for WSDL URI is server hostname or IP address>:<port number of AIF services>/dynamicsax/services/ INAPEFormServiceGroup?wsdl. 4. In the Endpoint service URL box, enter the Endpoint service URI. Use the WSDL URL of the service that is used to create the invoice, journal or any other record. The standard format for WSDL URI is listed below. server hostname or IP address>:<port number of AIF services>/dynamicsax/service/<service Name>?wsdl Note To obtain the WSDL URI for AIF service and MethodService, in Microsoft Dynamics AX, see the Obtain the WSDL URI section. 5. Click Validate. 5. In the Class name box, enter the class name. For example, VendInvoiceInfoINClass, LedgerJournalTableINClass. 8

9 6. In the Method name box, enter the method name. For example, findbytablerefid, findbyjournalnum. 7. To save the AIF service endpoint, complete one of the following options. Click Apply to create and save AIF service endpoint. Click OK to save AIF service endpoint and close the application. Note As you create and save the AIF service endpoint, a Command Prompt window appears. Ensure that you do not close the Command Prompt window manually. After few seconds, the command prompt closes automatically. Obtain the WSDL URI To get the WSDL URI for AIF service and MethodService, in Microsoft Dynamics AX, complete the following steps. 1. In the Navigation pane, click System administration. 2. In the System administration area page, under Setup, under Services and Application Integration Framework, click Inbound ports. 3. In the left pane, in the Port name column, select the relevant AIF service and copy the respective WSDL URI. 4. Click INAPEFormServiceGroup and copy the respective WSDL URI. Delete an existing AIF service endpoint To delete an existing AIF service endpoint, complete the following step. In the Manage Endpoints window, select the endpoint and click Delete. Configure AX Connector manually to call additional AIF Service Groups There are instances, where you need to configure the AX Connector to call more than one AIF Service Group. The default installation configures the Connector to call the AccountsPayableService group for invoice processing. To call the Accounts Payable AX AIF service, the AX Connector is installed as a single IIS hosted web site. This is commonly used to create Pending Vendor Invoices in AX that are usually PO related. You can create a Pending Vendor Invoice that is Non-PO related with this service, but may be required to use a different service group, such as, Ledger Journal services. To configure the AX Connector to call a different AX AIF Service, complete the following steps. 1. Complete the Perceptive AX Connector installation process. 2. Copy all the files in the current root directory of the installed site to back up the installation. 3. Copy and paste the installed web site folder using the File Explorer. 9

10 4. To create the new web site in Internet Information Services (IIS) Manager, complete the following substeps. 1. Open Internet Information Services (IIS) Manager, version 7.0, in Administrative tools. 2. Expand the Server node to the Sites level. 3. In the Site node, right-click and select Add Web site. 4. Enter the web site name. 5. Select the Physical Path. 6. Modify the port number from the default value to the value that is not currently used. 7. Click OK. 5. To generate new proxy files and an updated web.config file, complete the following substeps. 1. Copy PerceptiveConnectorLibraryGeneratorAPP.exe and PerceptiveConnectorLibraryGenerator.dll that are included in the install package to the new web site directory. 2. In the Administrator mode, at the command prompt, execute the following command, replacing the <text> with values from the current AX installation. This command creates or modifies the existing serviceproxy.dll and web.config files. PerceptiveConnectorLibraryGeneratorApp.exe <Appropriate AIF Service WSDL URI> <MetadataService WSDL URI> <QueryService WSDL URI> <MethodService WSDL URI> <Location of the serviceproxy.dll file> <Location of the web.config file> <Location of external dll file> Note All the above parameters are mandatory except the <Location of external dll file> parameter. This parameter is mandatory, only if the compilation of the service depends on any external DLL file. The system generates the serviceproxy.dll and web.config files. 3. In the IIS Manager, complete the following tasks. 1. Select the application pool of the website that is created and click Advanced Settings under Edit Application Pool. 2. In the Advanced Settings window, under Process Model, in the Identity field, enter an AX service account with administrative privileges in the Microsoft Dynamics AX Server. 3. Select the application pool and click Recycle. 4. Select the website name that is created and click Restart. 6. Modify the file DAXConnectorConfiguration.xml located in the Config folder of the newly installed site. This file contains the methods and queries used in the new site AIF service. 7. Set up Envoy services to consume this new web site for creating Ledger Journal based invoice vouchers. 10

11 Validate proxy dll in custom service group Within AX, you can create a new AIF inbound port from an existing port to isolate it from other applications. AccountsPayableServices is the standard AX inbound port (Service Group) used in common AP solutions. Note To ensure that the new service is a copy of the AccountsPayableServices, you must verify within the AX developer workspace and the service proxy dll file that is generated. Check in AX developer workspace The new service includes the following services. LedgerVendorPaymentService VendPaymentService VendVendInvoiceService Within the AX developer workspace, you can check this, expand the AOT Service Groups section, and compare it with the AccountsPayableService. 11