Microsoft Dynamics GP

Transcription

1 Microsoft Dynamics GP Microsoft Dynamics GP is a web-based Customer Relationship Management (M) software platform that enables users to access information using a number of web services interfaces such as econnect. This connector supports both Microsoft Dynamics GP documents and econnect business objects within them. Microsoft Dynamics GP Versions Supported This connector supports the following versions of Microsoft Dynamics GP: Microsoft Dynamics GP 2010 Microsoft Dynamics GP 2010 Service Pack 1 Microsoft Dynamics GP 2010 Service Pack 2 Connectivity Requirements Note To use Map Designer with a Microsoft Dynamics GP connector, your web service API for the Microsoft Dynamics GP platform must be enabled. Enter the following to connect to Microsoft Dynamics GP: Web Service URL - Web service URL for your instance of Microsoft Dynamics GP. For example: Username - User name for the web service user. Password - Password for the user name you enter. Domain - Area of control within Microsoft Dynamics GP. Properties The following source (S) and target (T) properties can be set for Microsoft Dynamics GP connections. Property S/T Use Batch Size S Number of source records the connector caches before processing them in a map. Default is zero. Page 1

2 Show Children S/T Controls whether or not child objects are shown in data and metadata. True Shows all child objects. False (default) Does not show child objects Flush Frequency T Number of operations the connector caches before writing them to the target. Default is zero. Batch Response T Path name for the batch response file, which provides detailed results for each object in a batch where the batch size is greater than 1. These results are useful for doing the following: Capturing system-generated object IDs for use in future updates. Correlating errors with their objects and getting information about the error for exception handling and error diagnosis. A batch response entry is generated on top-level records only. Domain S/T Area of control within Microsoft Dynamics GP. OrganizationKey S/T Company in Microsoft Dynamics GP in which the method should be performed. CultureName S/T Optional string property that specifies the culture (locale) of the user making the method call. Based on the locale specified, the Dynamics GP service can return values in a format specific to that locale. Page 2

3 CurrencyType S/T Indicates how currency values are retrieved for a document. This property should be specified only when information is being retrieved from the Dynamics GP service. RoleKey S/T Optional. If supplied, the specified role will be used to choose the policy instance and appropriate behavior options for the method call. If you do not supply a role key, the Dynamics GP service will try to find a role for the user and company specified for the context object. If only one role can be found, that role will be used. If more than one role is found, or no roles are found, the default role will be used. IgnoreRecordErrors S Whether or not to ignore server errors during retrieval for an individual record. True - Ignores errors during record retrieval. False (default) - Does not ignore errors during record retrieval. PreValidate T Whether or not to validate data before accessing the web service. PortNumber S/T The port number that IIS uses. If you do not provide a value, the default (38620) is used. To use the econnect web service to access econnect business objects, you must deploy the econnect web service to Internet Information Services (IIS). See De ploying the econnect Web Service to IIS. Page 3

4 Supported Operations The Microsoft Dynamics GP connector supports the Create (C), Read (R), Update (U), and Delete (D) operations; however, not all entities support all operations. The following table lists the entities and the operations they support. Entity Bank Deposit Bank Transaction CashReceipt Customer CustomerAddress Fee GLTransaction Kit PayablesCreditMemo PayablesFinanceCharge PayablesInvoice PayablesMiscellaneousCharge PayablesReturn Payroll PostedPayablesVendorPayment PurchaseInvoice PurchaseOrder PurchaseReceipt Supported Operations UD UD UD UD UD UD Page 4

5 ReceivablesCreditMemo ReceivablesDebitMemo ReceivablesFinanceCharge ReceivablesInvoice ReceivablesReturn ReceivablesServiceRepair ReceivablesWarranty SalesBackOrder SalesFulfillmentOrder SalesItem SalesInvoice SalesOrder SalesQuote SalesReturn Service Vendor VendorAddress UD UD UD UD UD UD U UD Supported Data Types The following data types are available for the Microsoft Dynamics GP Connector: Boolean Date BigDecimal Integer String Page 5

6 Short Note The data type in source or target fields should not be changed. Changing the data type in a target field could result in error. Connector-Specific Notes Supported Java Version The Microsoft Dynamics GP requires at least jre1.6.0._04. We recommend using the latest available jre. Microsoft Dynamics GP Object Query Language In source connections, you may use a query statement to query for objects. The Microsoft Dynamics GP connector supports the Microsoft Dynamics GP Object Query Language only. The query language provides a query subsystem that allows clients of the API to perform SQL-like queries against the Dynamics GP platform. The query language is based on a subset of Object Query Language (OQL), a text-based SQL-like query language that has been extended to handle object notation. Syntax The Microsoft Dynamics GP Object Query Language supports object query. Object query: SELECT * or fieldname FROM primaryobject Examples Select all fields from the Customer object: SELECT * FROM Customer Select the key_id for all Customer records: SELECT Key_Id FROM Customer Primary Objects and Sub-Objects Page 6

7 Primary objects are objects with a unique ID (primary key) that can be directly created, read, updated and deleted. Sub-objects are children of primary objects and primary objects contain sub-objects. The only way to manage the sub-objects is through UD operations on the primary objects. If a primary object is deleted, all of its sub-objects are also deleted. econnect Web Service The custom web service is an ASP.NET web service. ASP.NET is a web application framework that is a part of the Microsoft.NET framework. To provide write access, it uses ADO.NET. This is Microsoft.NET's data access framework. To provide write access, it uses econnect. The custom web service has to be deployed onto the machine that is running GP 2010 and its standard web services. This implies that econnect, IIS, etc. is installed. By default, the DMS does not expose the additional record types. Some steps have to be taken on the machine running Data Integrator for these to be exposed. Installing on Server 2008 Note The Econnect subdirectory is located in the econnect Web Service folder Copy and unzip the ecconnect package to any directory on the GP server machine. Click Start > Control Panel > Administrative Tools > Internet Information Services (IIS) Manager. Right-click Application Pools from the left tree menu and select Add Application Pool. Enter the following values for the Application Pool: Name - Enter econnect.net Framework version - Select.Net Framework <version>. Managed pipeline mode - Set to Integrated Start application pool immediately option - Keep this option selected. Click OK to create the application pool. Select the econnect application pool in the middle window, and then select Advanced Settings on the right panel (Action). Make sure the Identity option is set to LocalSystem. Expand the <machine name\user> on the left tree menu. Expand Sites on the left tree menu. Right-click Sites and select Add Web Site. Provide the following information: Site name - In the space provided, enter the Web Service name on IIS. Application pool - Click the Select button and select econnect. Physical path - Enter or browse to the path to the folder that contains the DynamicsGPExt.asmx file (this is the same location where the econnect package was unzipped to in step 1). Type - Keep the default value. IP address - Keep the default value. Port - The Web Service port number. Change this value to 810. Host name - In the space provided, enter the computer name. Click OK to create the web site. Right-click the Web Site you added in the previous step and choose Add application. Provide the Page 7

8 following information: Alias - Enter DynamicsGPExt in the space provided. Application pool - Click the Select button and select econnect. Physical path - Enter or browse to the path to the folder that contains the DynamicsGPExt.asmx file (this is the same location where the econnect package was unzipped to in step 1). Click OK to create the application. Open a browser window and enter the following URL to test if econnect is set up properly: Deploying the econnect Web Service to IIS Note To deploy the econnect web service, Internet Information Services (IIS) and WCF Activation (Net.Pipe Listener Adapter) must be installed on the Microsoft Dynamics GP platform. Microsoft Dynamics GP 2010 administrators may install a web service that exposes data in a manner that allows it to be viewed and manipulated in ways that are consistent with GP's business logic. In order to integrate with GP 2010, Pervasive has developed a DMS (Data Mediation Service) that interacts with the GP 2010 web service to provide UD access to the data. Since the GP 2010 web service does not expose all the data, Pervasive has developed a custom web service to expose additional record types. This econnect Web Service should reside on the GP 2010 server. The econnect web service enables you to access econnect business objects. Enabling and Disabling econnect Enabling and disabling the econnect Web Service communication requires editing the properties file named resource.properties. This file is located in the connector-dms-dynamicsgp2010- <version>.jar file directory. The.jar file can be edited with any zip editing tools. To enable, change the value of the use_econnect_client property to true. To disable, change the value of the use_econnect_client property to false. Supported Operations on econnect Objects The following table shows the econnect object supported operations: GP Object Name Read Insert Update Delete BankTransaction Yes Yes Yes Yes BankTransaction Distributions No No No No Page 8

9 BankTransaction TransactionDists Yes Yes Yes Yes BankDeposit Yes Yes Yes Yes BankDeposit BankDepositesLine s No No No No Payroll Yes Yes Yes Yes Payroll Transactions Yes Yes Yes Yes For BankTransaction Distributions and BankDeposit BankDepositesLines object names, the connector does not support UD operations because the GP econnect APIs do not support them. Page 9