Perceptive Connector for Microsoft Dynamics AX

Transcription

1 Perceptive Connector for Microsoft Dynamics AX API Implementation Guide Version: 2.4.x Written by: Product Knowledge, R&D Date: August 2016

2 2015 Lexmark International Technology, S.A. 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 Perceptive Connector for Microsoft Dynamics AX?... 6 Using the Web Service... 6 Modify the configuration file... 6 Calling the web service... 7 Code syntax... 7 Use the web service to create an invoice... 7 Create Invoice purchase order invoice request... 9 Code syntax... 9 Accepted data types for GetInvoiceObject field value Methods Accepted data types for a method Data type table Date format table Method Constraints Environment constraints and troubleshooting Appendix A: Method Usage Real value example Microsoft Dynamics AX code sample Entry in configuration file XML request Date and Integer Example Microsoft Dynamics AX code sample Entry in configuration file String Examples Microsoft Dynamics AX code sample Entry in configuration file XML request Microsoft Dynamics AX code sample Entry in configuration file Appendix B: Query Usage Accepted data types for a query Data Types Date formats

4 Query Constraints Query example without range argument Entry in configuration file XML request Query example with range argument Entry in configuration file XML request Query with multiple range arguments Entry in configuration file XML request Query Range Operators Range operators Range Examples Using Range operators in a query Equal to Entry in configuration file XML Request Not equal to Example Entry in configuration XML Request Entry in configuration file XML query Between two values Entry in configuration file XML Request Greater than Entry in configuration file XML Request Entry in configuration file XML query Less than Entry in configuration file XML Request Entry in configuration file

5 XML query Match on containing specific characters Entry in configuration file XML Request Match a single unknown character Entry in configuration file XML Request Equal or less than Entry in configuration file XML Request Entry in configuration file XML request Entry in configuration file XML request Appendix C: Standard Queries and Methods Queries Methods

6 What is Perceptive Connector for Microsoft Dynamics AX? Perceptive Connector for Microsoft Dynamics AX is a Microsoft IIS hosted SOAP-based web service that allows integration between Perceptive Content and Microsoft Dynamics AX. This server-based integration is used to create, look up and post form data from Perceptive Content and Process into Dynamics AX using Microsoft s Application Integration Framework (AIF). It allows for instant, direct delivery of data from Dynamics AX to complete form entry in Perceptive Content or Process solutions. The intended usage of this guide is for the development or consulting technical resources that are responsible for implementation of the Dynamics AX Connector. Using the Web Service In order to call the web service you must ensure that the configuration file that contains the relevant methods and queries is correct. Modify the configuration file To modify the configuration file, complete the following steps. The Perceptive Connector for Microsoft Dynamics AX web service model includes a list of default methods and queries for reference listed in the Appendix of this document. 1. Open IIS Manager. 2. In the Connections pane, under Sites, right-click the website added during creation of the service endpoint and then click Explore. 3. Navigate to the Config directory. 4. To edit the file, right-click the DAXConnectorConfiguration.xml file and then click Edit. 5. To include each Microsoft Dynamics AX query, complete the following substeps. a. Provide the unique ID and the name of the Microsoft Dynamics AX query. For example, <query> <id> </id> <queryname>getcompanyinfo</queryname> </query> b. If the query receives one or more inputs, specify ranges in the following format. <query> <id> </id> <queryname>getcompanyinfo</queryname> <ranges> <range operator="">datasourcename.fieldname</range> <range operator=">">datasourcename.fieldname</range> </ranges> </query> 6. Save the edited file in a temporary directory on your computer. 7. Copy the edited file to the original Config directory under the web site. 6

7 8. In the Connections pane, click Application Pools and then under Application Pools, click the application pool added during creation of the service endpoint. 9. In the Actions pane, under Application Pool Tasks, click Recycle. 10. In the Connections pane, under Sites, click the website added during creation of the service endpoint. 11. In the Actions pane, under Manage Web Site, click Restart. Calling the web service To call a Perceptive method or query, you must use a web service to call the GetData(guid, company, list) web method. See below table for reference Parameter Data Type Description guid String Unique ID assigned to the Microsoft Dynamics AX method or query. company String The short name of the Microsoft Dynamics AX company for which data is being retrieved. By default, it is ceu. If this field is blank, the system sets the company name as ceu. list String List of arguments passed as a parameter in a method. List of arguments passed as a range in a query. Code syntax public string GetData(string guid, string company, List<InputData> list) Use the web service to create an invoice To create an invoice in Interact for Microsoft Dynamics AX using Connector for Microsoft Dynamics AXweb service, complete the following steps. 1. Call the GetInvoiceObject(CallContext) web method. a. The syntax is the GetInvoiceObject("CallContext") public string, where CallContext is a class name. 2. This call returns the object of the class as an XML file. 3. In the Response.xml file, add or modify the required field values. 4. Set the <HasValue> property of the class to true. 5. Save the modified Response.xml object as a string value. 6. Call the GetInvoiceObject(AxdVendInvoice) web method. 7

8 Example: The syntax is public string GetInvoiceObject ( AxdVendInvoice ), where AxdVendInvoice is a class name. 7. This call returns an XML object. 8. In the Reponse.xml object, under the appropriate class tag, add or modify the required field values. Example: <LstInvoiceFields> <FieldValue>11020</FieldValue> <FieldName>ItemId</FieldName> <Classname>AxdEntity_VendInvoiceInfoLine</Classname> <BaseType>Primitive</BaseType> <Datatype>String</Datatype> <Nullable>False</Nullable> </LstInvoiceFields> a. Note: For a field with Number data type, a maximum of 20 characters is accepted. 9. For each field that you modify, set the <HasValue> property of the class astrue. If the field belongs to a nested class, do this for all parent classes. 10. Save the modified Response.xml object as a string value. 11. Call the CreateInvoice web method. 8

9 Create Invoice purchase order invoice request The following sample shows a CreateInvoice Purchase Order based invoice request. Code syntax In the CreateInvoice request, to multiply and calculate the PurchPrice and ReceiveNow correctly, set the LineAmount to false. public string CreateInvoice(List<InputData> lstinvoiceentity, string invoiceserviceclient, string invoiceservicemethod, string inconfigname, string guid, string recordmethodguid) Parameter lstinvoiceentity invoiceserviceclient invoiceservicemethod inconfigname guid recordmethodguid Description Array of type InputData that contains two elements. In the first element, the InputData.Argument is populated with the serialized XML of the CallContext object. In the second element, the InputData.Argument is populated with the serialized XML of the InvoiceEntity object. Name of the service client used to create the invoice. For example, if you are using the default LedgerService to create the invoice, this entry is "GeneralJournalServiceClient." Name of the service client method used to create the invoice. For example, if you are using the default LedgerService to create the invoice, this entry is "create." The configuration name in the Interact parameters form that contains the capture location and document keys of the captured invoice. The guid entry found against INPathGenerator class located in the Config file. Ensure that there is no change in any entry against INPathGenerator in the config file. The guid entry for the method in the AOT that returns the record of the created invoice/journal. The default config file contains an example of this in the last entry. The user can create a custom method in his custom class in AOT to return the record of the desired invoice/ journal to be created, and add the reference of this class and method with a unique GUID in the Config file. This GUID is necessarily the recordmethodguid. This method is for internal use only and not consumed by any application using the connector. This method is an instance method and not a static method. The method accepts a Map type as parameter and returns the record of the created invoice/journal. The Map will contain all the entries found in AifEntityKeyList object that is returned after creating the invoice/journal. The method must use these entries to fetch and return the record. 9

10 Return Condition When Perceptive Interact for Dynamics AX model is installed When Perceptive Interact for Dynamics AX model is not installed Description of the returned value An XML string that contains a path and document keys. It is recommended to store the document in the Return path and set the document keys as returned. This parameter is required to create a shortcut for the document at the Return path to make the document visible from Dynamics AX form. An XML string that contains a success message. Accepted data types for GetInvoiceObject field value In the Response.xml object, a field value must have one of the following data types. Parameter Format String Enum Integer Boolean Accepts the standard string format Additionally, accepts language as string in the following format For US(English) : en-us For US(Australia) : en-au For US(Canada) : en-ca Accepts as an integer value Accepts the standard integer format Accepts as true or false Decimal Date or Date Time dd-mm-yyyyhh:mm:ss Methods The standard usage, data types, and constraints are outlined in this section Accepted data types for a method A method accepts the following primitive data types as parameters the syntax is provided in the following tables 10

11 Data type table Data Type Parameter Example Boolean String Float or Real Integer Date Accepts only TRUE or FALSE (not case sensitive).0 or 1 is not accepted. s@(string data)accepts blank value f@(float/real)acce pts blank value i@(integer)accept s blank value d@(date or date time) b@true s@abc xyz f@10.75 i@10 d@11/25/2013 Date format table Parameter Date Date Time Format mmddyyyy Use any of the following as separators. \ /. - mm/dd/yyyy h:mm:ss Method Constraints Perceptive Connector for Microsoft Dynamics AX has the following constraints regarding methods. Supports only Microsoft Dynamics AX methods of class. In an argument, Container Data Type is not supported. In an argument, Data of Any Type is not supported. In the configuration file, in the return value tag, the special characters allowed are hyphen and underscore only, however, not as a prefix. 11

12 A method can return a List of INMethodDataContract object that contains a list of string. If the output data type is anything but String, first, convert the output of the method in to string and then add it to list. Environment constraints and troubleshooting If the password of the domain user changes, the user must change the password through the Identity Manager. If the user gets an "Unable to log in to Microsoft Dynamics AX." error, it means either the user identity is not set correctly in IIS Manager or Microsoft Dynamics AX Server is down. Perceptive Connector for Microsoft Dynamics AX does not support methods for tables and queries. When you uninstall the connector, ensure that the folder with the name of the service endpoint created under C:\inetpub\wwwroot is not open. Perceptive Connector for Microsoft Dynamics AX uses default services. If any Query Service or Metadata Service in Microsoft Dynamics AX is modified, the web service does not work. Perceptive Connector for Microsoft Dynamics AX does not support Maps object type. A query does not work for Maps data source. It only works for Tables and Views. All inputs in the Config.xml and Response.xml files are case sensitive. You cannot pass two ranges through the Config.xml file. You must use a comma to make the OR operations work. For a method, you can use a space as a separator to define the Date data type. However, it does not work for a query. Perceptive Connector for Microsoft Dynamics AX supports the creation of Vendor Invoice and Journal in Microsoft Dynamics AX You can create only one invoice or one journal at a time. You can create Purchase Order based and Non-Purchase Order based invoices. For a field of data type Number, a maximum of 20 characters is accepted. Appendix A: Method Usage Real value example The following example shows a method that accepts a real value as an argument and returns a single string value. 12

13 Microsoft Dynamics AX code sample public List SumofFloat(real a,real b,real c, real d) { real result; List mylist; List innerlist; //Declare to store values to be return INMethodDataContract datacontract; //wrapper for List<String> result=a+b+c+d; mylist=new List(Types::Class); innerlist=new List(Types::String); datacontract=new INMethodDataContract(); innerlist.addend(num2str(result,0,3,1,0)); datacontract.parmlist(innerlist); //wrap the output List<String> mylist.addend(datacontract); return mylist; } Return type is List<String> so that the returned values get converted into string using various functions. The method accepts four real or float values. Accordingly, the SOAP UI calls it through four parameters. This should always match; otherwise, the system throws an exception message. It returns only one value and accordingly you must modify the configuration file. In the code example, return values are added to innerlist. Then, the innerlist is wrapped into INMethodDataContract object. Then INMethodDataContract object is added to the list. This returns multiple INMethodDataContract objects. Entry in configuration file <method> <id> </id> <classname>insumclass</classname> <name>sumoffloats</name> <returnvalues> <returnvalue>total</returnvalue> </returnvalues> </method> XML request <tem:guid> </tem:guid> <tem:argument>f@10.10</tem:argument> <tem:argument>f@20.20</tem:argument> <tem:argument>f@30.30</tem:argument> 13

14 Date and Integer Example The following example shows a method that accepts a date and integer as an argument and returns a single value. Microsoft Dynamics AX code sample public List dateaddition(date mydate, int extradays) { List mylist; List innerlist; // INMethodDataContract datacontract; utcdatetime myutcdate; // mylist=new List(Types::Class); innerlist=new List(Types::String); datacontract=new INMethodDataContract(); //date are converted into datetime for date manipulation myutcdate=global::clrsystemdatetime2utcdatetime(mydate); //Inbuild method adddays of class DateTimeUtil is called for add specified days to date myutcdate=datetimeutil::adddays(myutcdate,extradays); //the result are then converted to string and added to innerlist innerlist.addend(datetime2str(myutcdate)); datacontract.parmlist(innerlist); mylist.addend(datacontract); return mylist; } Entry in configuration file <method> <id> </id> <classname>insumclass</classname> <name>dateaddition</name> <returnvalues> <returnvalue>targetdate</returnvalue> </returnvalues> </method> 14

15 String Examples The following example shows a method that accepts a string as an argument and returns multiple values. Microsoft Dynamics AX code sample private List getsalestaxdetail(str country) { List mylist; //citylist is used to store city List citylist; //citywise sales tax rate will be added to citysalestaxlist List citysalestaxlist; //Multiple INMethodDataContract object are declare to return multiple list INMethodDataContract datacontractcity; INMethodDataContract datacontractcitysalestax; str type=strupr(country); citylist=new List(Types::String); citysalestaxlist=new List(Types::String); switch (type) { case "INDIA" : citylist.addend("kolkata"); citysalestaxlist.addend("5.75"); citylist.addend("mumbai"); citysalestaxlist.addend("7.75"); citylist.addend("chennai"); citysalestaxlist.addend("4.75"); citylist.addend("delhi"); citysalestaxlist.addend("8.75"); break; case "UAE" : citylist.addend("dubai"); citysalestaxlist.addend("0.00"); citylist.addend("sharjah"); citysalestaxlist.addend("0.00"); citylist.addend("abu Dhabi"); citysalestaxlist.addend("0.75"); break; case "AUSTRALIA": citylist.addend("sydney"); citysalestaxlist.addend("15.75"); citylist.addend("albury"); citysalestaxlist.addend("17.75"); citylist.addend("lithgow"); citysalestaxlist.addend("14.50"); citylist.addend("penrith"); citysalestaxlist.addend("10.75"); break; case "USA" : citylist.addend("new York"); citysalestaxlist.addend("12.75"); citylist.addend("los Angeles"); citysalestaxlist.addend("7.75"); citylist.addend("chicago"); citysalestaxlist.addend("4.50"); citylist.addend("washington"); 15

16 citysalestaxlist.addend("10.75"); break; default : throw error("incorrect country name"); } mylist=new List(Types::Class); datacontractcity=new INMethodDataContract(); datacontractcitysalestax=new INMethodDataContract(); datacontractcity.parmlist(citylist); datacontractcitysalestax.parmlist(citysalestaxlist); mylist.addend(datacontractcity); mylist.addend(datacontractcitysalestax); return mylist;} } Entry in configuration file <method> <id> </id> <classname>insalestaxclass</classname> <name>getsalestaxdetail</name> <returnvalues> <returnvalue>cityname</returnvalue> <returnvalue>salestaxrate</returnvalue> </returnvalues> </method> The method accepts one string argument and accordingly the SOAP UI calls it through one parameter. This should always match; otherwise, the system throws an exception message. It returns two lists, Citynames and SalesTax. You must configure the configuration file accordingly. XML request <tem:guid> </tem:guid> <tem:argument>s@india</tem:argument> Example 2 multiple return values The following example shows a method that accepts a string as an argument and returns multiple values. Microsoft Dynamics AX code sample private List getsalestaxdetail(str country){ List mylist;//citylist is used to store city List citylist;//citywise sales tax rate will be added to citysalestaxlist List citysalestaxlist;//multiple INMethodDataContract object are declare to return multiple list INMethodDataContract datacontractcity; INMethodDataContract datacontractcitysalestax; str type=strupr(country); citylist=new List(Types::String); 16

17 citysalestaxlist=new List(Types::String); switch(type) { case "INDIA" : citylist.addend("kolkata"); citysalestaxlist.addend("5.75"); citylist.addend("mumbai"); citysalestaxlist.addend("7.75"); citylist.addend("chennai"); citysalestaxlist.addend("4.75"); citylist.addend("delhi"); citysalestaxlist.addend("8.75"); break; case "UAE" : citylist.addend("dubai"); citysalestaxlist.addend("0.00"); citylist.addend("sharjah"); citysalestaxlist.addend("0.00"); citylist.addend("abu Dhabi"); citysalestaxlist.addend("0.75"); break; case "AUSTRALIA": citylist.addend("sydney"); citysalestaxlist.addend("15.75"); citylist.addend("albury"); citysalestaxlist.addend("17.75"); citylist.addend("lithgow"); citysalestaxlist.addend("14.50"); citylist.addend("penrith"); citysalestaxlist.addend("10.75"); break; case "USA" : citylist.addend("new York"); citysalestaxlist.addend("12.75"); citylist.addend("los Angeles"); citysalestaxlist.addend("7.75"); citylist.addend("chicago"); citysalestaxlist.addend("4.50"); citylist.addend("washington"); citysalestaxlist.addend("10.75"); break; default : throw error("incorrect country name"); } mylist=new List(Types::Class); datacontractcity=new INMethodDataContract(); datacontractcitysalestax=new INMethodDataContract(); datacontractcity.parmlist(citylist); datacontractcitysalestax.parmlist(citysalestaxlist); mylist.addend(datacontractcity); mylist.addend(datacontractcitysalestax); return mylist;} Entry in configuration file The method accepts one string argument and the SOAP UI calls it accordingly through one parameter. This should always match; otherwise, the system throws an exception message. It returns two lists, Citinames and SalesTax. You must configure the configuration file accordingly. <method> <id> </id> <classname>insalestaxclass</classname> <name>getsalestaxdetail</name> <returnvalues> <returnvalue>cityname</returnvalue> <returnvalue>salestaxrate</returnvalue> </returnvalues></method> Appendix B: Query Usage Accepted data types for a query A query accepts the following data types as parameters. To call a query, pass an argument in the syntax provided in the following tables. Data Types Data Type Parameter Example String Date or Date Time s@(string data) Accepts blank value d@(date or date time) s@abc xyz d@11/25/

18 Date formats Parameter Date Date Time Format mmddyyyy Use any of the following as separators. \ /. - mm/dd/yyyy h:mm:ss Query Constraints Perceptive Connector for Microsoft Dynamics AX has the following constraints regarding queries. In an argument, Container Data Type is not supported. In an argument, Data of Any Type is not supported. Less than operator < must be written as "<" to make it work. To make >=123 work, you must write it as >123. In Query, if the user configures a field of data type TIME then the configured time (local) works for fetching results, but for a field of data type DATETIME, the saved value is in UTCDATETIME format. To fetch the result, the DATETIME value must be UTCDATETIME. In Request.xml, if you enter multiple values in one range, you must provide the operator either in the configuration file or in Response.xml for the first range value. You must not provide the operator in both the configuration and Request.xml files. If you configure multiple ranges in which you configure one or more ranges incorrectly, the system ignores all incorrect ranges. Valid ranges work as desired. If you use two values (for example, 123 and 456) in a range, in the Request.xml, write it as s@123,456. Write the s@ text only once. If you use an operator (for example, >) in the range field, in Request.xml, write it as s@>123. The Range status of the Range Field should be in open state in Microsoft Dynamics AX Client. If you configure a field of data type TIME, in the range field, mention the value in Response.xml as s@(time). 18

19 Query example without range argument The following example shows a query without a range argument. Entry in configuration file <query> <id> </id> <queryname>getcompanyinfo</queryname> </query> XML request <tem:guid> </tem:guid> Query example with range argument The following example shows a query with a range argument. Entry in configuration file <query> <id> </id> <queryname>getvendorinfobyvendorname</queryname> <ranges> <range operator="">dirpartytable_ds.name</range> </ranges> </query> XML request <tem:guid> </tem:guid> <tem:argument>s@rain*</tem:argument> 19

20 Query with multiple range arguments The following example shows a query with multiple range arguments. Entry in configuration file <query> <id> </id> <queryname>getpolineitem</queryname> <ranges> <range operator="">purchline_ds.purchid</range> <range operator="">purchline_ds.linenumber</range> </ranges> </query> XML request <tem:guid> </tem:guid> <tem:argument>s@000419</tem:argument> <tem:argument>s@10</tem:argument> Query Range Operators In a query, you can use different operators to define one or more range arguments. For example, <range operator="!">inventtable_ds.itemid</range>where! is the operator. If you do not provide an operator, it means equal to. For example, <range operator="">inventtable_ds.itemid</range> is identical to <range operator="">inventtable_ds.itemid</range>. 20

21 Range operators Operator Symbol Description = Equal to! Not equal to.. Between two values > Greater than < Less than * Match values containing the characters before or after asterisk? Match a single unknown character, Seperates expression components Range Examples Example =Smith!Smith A..C Description Finds Smith Finds all values except Smith Finds all records from A to C including records with A and C. >1000 Finds all values greater than 1,000 <1000 Finds all values less than 1,000 including negative values *east* Sm?th A..D,!C Finds all values that contain the characters east Note The NOT symbol (!) can be used in front of these wildcard * values. For example, if you set the value property of the range to! *east*, all values that contain the four characters are excluded from the query results. Finds all values that include the letters s, m, the character in the placeholder, t, and h in the order shown Finds A, B, and D 21

22 Note You can provide two different operators in the same range argument. Use comma (,) as the separator of the expression components. For example, <1003 implies equal to or less than Using Range operators in a query The following examples show usage of range operators in a query Equal to The following example shows a query with = (equal to) as a range operator. =Smith Entry in configuration file <query> <id> </id> <queryname>getvendorinfobyvendname</queryname> <ranges> <range operator="=">dirpartytable_ds.name</range> </ranges> </query> XML Request <tem:guid> </tem:guid> <tem:argument>s@rain Projector*</tem:Argument> Not equal to You can use the! (not equal to) operator to search for all items that aren t equal to the search value you enter. You may provide this operator either in the configuration file or use it to define the value of the argument in the request object. Example The following example shows a query with! (not equal to) as a range operator.!smith 22

23 Entry in configuration file <query> <id> </id> <queryname>getvendorinfobyvendorname</queryname> <ranges> <range operator="!">dirpartytable_ds.name</range> </ranges> </query> XML Request <tem:guid> </tem:guid> Projector*</tem:Argument> Entry in configuration file The following example shows the operator being passed in the request object instead of the configuration file. <query> <id> </id> <queryname>getvendorinfobyvendorname</queryname> <ranges> <range operator="">dirpartytable_ds.name</range> </ranges> </query> XML query <tem:guid> </tem:guid> Projector*</tem:Argument> 23

24 Between two values The following example shows a query with.. (between two values) as a range operator. You cannot provide this operator in the configuration file. You must use this operator to define the value of the argument in the request object. Example The output shows all values between 1101 and 1103, that is 1101, 1102, and Entry in configuration file <query> <id> </id> <queryname>getvendorinfobyvendnumber</queryname> <ranges> <range operator="">vendtable_ds.accountnum</range> </ranges> </query> XML Request <tem:guid> </tem:guid> <tem:argument>s@ </tem:argument> Greater than You can use the > (greater than) operator to search for all items that include a number greater than the search value you enter. You may provide this operator either in the configuration file or use it to define the value of the argument in the request object. Example >

25 The output shows all values greater than Entry in configuration file The following example shows a query with > (greater than) as a range operator. <query> <id> </id> <queryname>getvendorinfobyvendnumber</queryname> <ranges> <range operator=">">vendtable_ds.accountnum</range> </ranges> </query> XML Request <tem:guid> </tem:guid> <tem:argument>s@9900</tem:argument> Entry in configuration file The following example shows the operator being passed in the request object instead of the configuration file. <query> <id> </id> <queryname>getvendorinfobyvendnumber</queryname> <ranges> <range operator="">vendtable_ds.accountnum</range> </ranges> </query> XML query <tem:guid> </tem:guid> 25

26 Less than You can use the < (less than) operator to search for all items that include a number less than the search value you enter. You may provide this operator either in the configuration file or use it to define the value of the argument in the request object. Example <1003 You must write the less than operator as < instead of <. Entry in configuration file The following example shows a query with > (greater than) as a range operator. <query> <id> </id> <queryname>getvendorinfobyvendnumber</queryname> <ranges> <range operator="<">vendtable_ds.accountnum</range> </ranges> </query> XML Request <tem:guid> </tem:guid> <tem:argument>s@1003</tem:argument> 26

27 Entry in configuration file The following example shows the operator being passed in the request object instead of the configuration file. <query> <id> </id> <queryname>getvendorinfobyvendnumber</queryname> <ranges> <range operator="">vendtable_ds.accountnum</range> </ranges> </query> XML query <tem:guid> </tem:guid> Match on containing specific characters The following example shows of a query with * as a range operator. The system matches all values that contain the characters before or after the asterisk and accordingly generates the output. Example Rain* The output shows all values beginning with ''Rain". Note You cannot provide this operator in the configuration file. You must use this operator to define the value of the argument in the request object. Entry in configuration file <query> <id> </id> <queryname>getvendorinfobyvendnumber</queryname> <ranges> <range operator="">dirpartytable_ds.name</range> </ranges> 27

28 </query> XML Request <tem:guid> </tem:guid> Match a single unknown character The following example shows a query with? as a range operator. Example Sm?th Note You cannot provide this operator in the configuration file. You must use this operator to define the value of the argument in the request object. Entry in configuration file <query> <id> </id> <queryname>getvendorinfobyvendnumber</queryname> <ranges> <range operator="">dirpartytable_ds.name</range </ranges> </query> XML Request <tem:guid> </tem:guid> <tem:argument>s@ra?n Projectors</tem:Argument> 28

29 Equal or less than If you use two different operators in the same range argument, use a comma (,) as the separator of the expression components. Example =1003, <1003 Implies equal to or less than Entry in configuration file The following example shows operators being passed in the request object instead of the configuration file. <query> <id> </id> <queryname>getvendorinfobyvendnumber</queryname> <ranges> <range operator="">vendtable_ds.accountnum</range> </ranges> </query> XML Request <tem:guid> </tem:guid> <tem:argument>s@=1003,<1003</tem:argument> Entry in configuration file If you want to provide the operators in two separate range arguments, you must provide identical range fields in the query. 29

30 <query> <id> </id> <queryname>getvendorinfobyvendnumber</queryname> <ranges> <range operator="">vendtable_ds.accountnum</range> <range operator="">vendtable_ds.accountnum</range> </ranges> </query> XML request <tem:guid> </tem:guid> Entry in configuration file The following is an example of the operators being passed in separate arguments in the configuration file. <query> <id> </id> <queryname>getvendorinfobyvendnumber</queryname> <ranges> <range operator="=">vendtable_ds.accountnum</range> <range operator="<">vendtable_ds.accountnum</range> </ranges> </query> XML request <tem:guid> </tem:guid> 30

31 Appendix C: Standard Queries and Methods Queries 1. GetCompanyInfo query Description : Returns the company information from AX based on the passed in company name. GUID : Input parameters:- o Company name (string) Return values:- o CompanyName (string) o Company Code (string) o Vendor Group/Data Area/Company (string) Example:- Request XML is given below: <tem:guid> </tem:guid> <!--Zero or more repetitions:--> Response XML is given below: <soap:envelope xmlns:soap=" xmlns:xsi=" xmlns:xsd=" <soap:body> <GetDataResponse xmlns=" <GetDataResult><![CDATA[<?xml version="1.0" encoding="utf-8"?> <GetCompanyInfo> <GetCompanyInfo> <CompanyInfo_DS.Name>Company accounts data</companyinfo_ds.name> <CompanyInfo_DS.PartyNumber>6473</CompanyInfo_DS.PartyNumber> <CompanyInfo_DS.DataArea>dat</CompanyInfo_DS.DataArea> </GetCompanyInfo> <GetCompanyInfo> <CompanyInfo_DS.Name>ok</CompanyInfo_DS.Name> <CompanyInfo_DS.PartyNumber>108677</CompanyInfo_DS.PartyNumber> <CompanyInfo_DS.DataArea>ok</CompanyInfo_DS.DataArea> </GetCompanyInfo> </GetCompanyInfo>]]></GetDataResult> </GetDataResponse> 31

32 </soap:body> </soap:envelope> 2. GetCurrency query:- Description : Returns all the available Currency codes from AX for the country and company specified GUID : Input parameters:- o Company name (string) Return values:- o Currency Code (string) o Currency Name (string) Example:- Request XML is given below: <tem:guid> </tem:guid> <tem:company></tem:company> <!--Zero or more repetitions:--> Response XML is given below: <soap:envelope xmlns:soap=" xmlns:xsi=" xmlns:xsd=" <soap:body> <GetDataResponse xmlns=" <GetDataResult><![CDATA[<?xml version="1.0" encoding="utf-8"?> <GetCurrency> <GetCurrency> <Currency_DS.CurrencyCode>AED</Currency_DS.CurrencyCode> <Currency_DS.Txt>UAE Dirham</Currency_DS.Txt> </GetCurrency> <GetCurrency> <Currency_DS.CurrencyCode>USD</Currency_DS.CurrencyCode> <Currency_DS.Txt>US Dollar</Currency_DS.Txt> </GetCurrency> <GetCurrency> <Currency_DS.CurrencyCode>ZWD</Currency_DS.CurrencyCode> <Currency_DS.Txt>Zimbabwe Dollar</Currency_DS.Txt> </GetCurrency> </GetCurrency>]]></GetDataResult> </GetDataResponse> </soap:body> </soap:envelope> 32

33 3. GetPaymentTerms query:- Description : Returns all the available payment term codes from AX for a given company. GUID : Input parameters:- o Company name (string) Return values:- o Payment Term Code (string), o Payment Term Calculation Method (number), o Days (number) Example:- Request XML is given below: <tem:guid> </tem:guid> <tem:company></tem:company> <!--Zero or more repetitions:--> Response XML is given below:: <soap:envelope xmlns:soap=" xmlns:xsi=" xmlns:xsd=" <soap:body> <GetDataResponse xmlns=" <GetDataResult><![CDATA[<?xml version="1.0" encoding="utf-8"?> <GetPaymentTerms> <GetPaymentTerms> <PaymTerm_DS.PaymTermId>CCBypass</PaymTerm_DS.PaymTermId> <PaymTerm_DS.PaymMethod>0</PaymTerm_DS.PaymMethod> <PaymTerm_DS.NumOfDays>0</PaymTerm_DS.NumOfDays> </GetPaymentTerms> <GetPaymentTerms> <PaymTerm_DS.PaymTermId>SP12M</PaymTerm_DS.PaymTermId> <PaymTerm_DS.PaymMethod>0</PaymTerm_DS.PaymMethod> <PaymTerm_DS.NumOfDays>0</PaymTerm_DS.NumOfDays> </GetPaymentTerms> </GetPaymentTerms>]]></GetDataResult> </GetDataResponse> </soap:body> </soap:envelope> 4. GetVendorInfoByVendorName query:- 33

34 Description : Returns the Vendor information based on the vendor name and company passed GUID : Input parameters:- o Company name (string) o Vendor party name (string) Return values:- o Vendor Number (string) o Payment Method (string) o Payment Terms Code (string) o Currency Code (string) (string) o VAT ID Number (string) o Data Area (Non-case sensitive) (string) o Vendor Group (string) o Vendor Name (string) o Address (string) o City (string) o State (string) o Zip (number) o Country/Company Code (string) Example:- Request XML is given below: <tem:guid> </tem:guid> <!--Zero or more repetitions:--> <tem:argument>s@a. Datum Corporation</tem:Argument> Response XML is given below:: <soap:envelope xmlns:soap=" xmlns:xsi=" xmlns:xsd=" <soap:body> <GetDataResponse xmlns=" <GetDataResult><![CDATA[<?xml version="1.0" encoding="utf-8"?> <GetVendorInfoByVendorName> <GetVendorInfoByVendorName> <VendTable_DS.AccountNum>3008</VendTable_DS.AccountNum> <VendTable_DS.PaymMode /> <VendTable_DS.PaymTermId>N030</VendTable_DS.PaymTermId> 34

35 <VendTable_DS.Currency>DKK</VendTable_DS.Currency> <VendTable_DS.VATNum /> <VendTable_DS.dataAreaId>ceu</VendTable_DS.dataAreaId> <VendTable_DS.VendGroup>10</VendTable_DS.VendGroup> <DirPartyTable_DS.Name>A. Datum Corporation</DirPartyTable_DS.Name> <DirPartyNamePrimaryAddressView_DS.Address>Lilienweg Köln</DirPartyNamePrimaryAddressView_DS.Address> <DirPartyNamePrimaryAddressView_DS.City>Köln</DirPartyNamePrimaryAddressView_DS.City> <DirPartyNamePrimaryAddressView_DS.State>NW</DirPartyNamePrimaryAddressView_DS.State> <DirPartyNamePrimaryAddressView_DS.ZipCode>23456</DirPartyNamePrimaryAddressView_DS.Zi pcode> <DirPartyNamePrimaryAddressView_DS.CountryRegionId>DEU</DirPartyNamePrimaryAddressView _DS.CountryRegionId> </GetVendorInfoByVendorName> </GetVendorInfoByVendorName>]]></GetDataResult> </GetDataResponse> </soap:body> </soap:envelope> 5. GetVendorInfoByVendNumberExt query:- Description Get vendor information by passed in vendor number. GUID : Input parameters:- o Company name (string) o Vendor Account Number (string) Return values:- o Vendor Account Number (string) o Payment Method (string) o Payment Term Code (string) o VAT ID Number (string) o Vendor Group/Data Area (Non-case sensitive) (string) o Currency Code (string) o Vendor Name (string) o Primary Address (string) o Primary City (string) o Primary State (string) o Primary Zip (string) o Primary Country/Company Code (string) o Postal Address (string) o Postal City (string) o Postal State (string) o Postal Zip (string) o Postal Country/Company Code (string) Example:- Request XML is given below: 35

36 <tem:guid> </tem:guid> <tem:company></tem:company> <!--Zero or more repetitions:--> Response XML is given below: <soap:envelope xmlns:soap=" xmlns:xsi=" xmlns:xsd=" <soap:body> <GetDataResponse xmlns=" <GetDataResult><![CDATA[<?xml version="1.0" encoding="utf-8"?> <GetVendorInfoByVendNumberExt> <GetVendorInfoByVendNumberExt> <VendTable_DS.AccountNum>3008</VendTable_DS.AccountNum> <VendTable_DS.PaymMode /> <VendTable_DS.PaymTermId>N030</VendTable_DS.PaymTermId> <VendTable_DS.VATNum /> <VendTable_DS.dataAreaId>ceu</VendTable_DS.dataAreaId> <VendTable_DS.Currency>DKK</VendTable_DS.Currency> <DirPartyTable_DS.Name>A. Datum Corporation</DirPartyTable_DS.Name> <DirPartyNamePrimaryAddressView_DS.Address>Lilienweg Köln</DirPartyNamePrimaryAddressView_DS.Address> <DirPartyNamePrimaryAddressView_DS.City>Köln</DirPartyNamePrimaryAddressView_DS.City> <DirPartyNamePrimaryAddressView_DS.State>NW</DirPartyNamePrimaryAddressView_DS.State> <DirPartyNamePrimaryAddressView_DS.ZipCode>23456</DirPartyNamePrimaryAddressView_DS.Zi pcode> <DirPartyNamePrimaryAddressView_DS.CountryRegionId>DEU</DirPartyNamePrimaryAddressView _DS.CountryRegionId> <DirPartyPostalAddressView_DS.Address>Lilienweg Köln</DirPartyPostalAddressView_DS.Address> <DirPartyPostalAddressView_DS.City>Köln</DirPartyPostalAddressView_DS.City> <DirPartyPostalAddressView_DS.State>NW</DirPartyPostalAddressView_DS.State> <DirPartyPostalAddressView_DS.ZipCode>23456</DirPartyPostalAddressView_DS.ZipCode> <DirPartyPostalAddressView_DS.CountryRegionId>DEU</DirPartyPostalAddressView_DS.Countr yregionid> </GetVendorInfoByVendNumberExt> <GetVendorInfoByVendNumberExt> <VendTable_DS.AccountNum>3008</VendTable_DS.AccountNum> <VendTable_DS.PaymMode /> <VendTable_DS.PaymTermId>N030</VendTable_DS.PaymTermId> <VendTable_DS.VATNum /> <VendTable_DS.dataAreaId>ceu</VendTable_DS.dataAreaId> 36

37 <VendTable_DS.Currency>DKK</VendTable_DS.Currency> <DirPartyTable_DS.Name>A. Datum Corporation</DirPartyTable_DS.Name> <DirPartyNamePrimaryAddressView_DS.Address>Lilienweg Köln</DirPartyNamePrimaryAddressView_DS.Address> <DirPartyNamePrimaryAddressView_DS.City>Köln</DirPartyNamePrimaryAddressView_DS.City> <DirPartyNamePrimaryAddressView_DS.State>NW</DirPartyNamePrimaryAddressView_DS.State> <DirPartyNamePrimaryAddressView_DS.ZipCode>23456</DirPartyNamePrimaryAddressView_DS.Zi pcode> <DirPartyNamePrimaryAddressView_DS.CountryRegionId>DEU</DirPartyNamePrimaryAddressView _DS.CountryRegionId> <DirPartyPostalAddressView_DS.Address>Lilienweg Köln</DirPartyPostalAddressView_DS.Address> <DirPartyPostalAddressView_DS.City>Köln</DirPartyPostalAddressView_DS.City> <DirPartyPostalAddressView_DS.State>NW</DirPartyPostalAddressView_DS.State> <DirPartyPostalAddressView_DS.ZipCode>23456</DirPartyPostalAddressView_DS.ZipCode> <DirPartyPostalAddressView_DS.CountryRegionId>DEU</DirPartyPostalAddressView_DS.Countr yregionid> </GetVendorInfoByVendNumberExt> </GetVendorInfoByVendNumberExt>]]></GetDataResult> </GetDataResponse> </soap:body> </soap:envelope> 6. GetPObyVendorId query:- Description : Returns all open PO information based on the Vendor number and company. GUID : Input parameters:- o Company name (string) o Vendor ID (string) Return values:- o PO Number (string) o Invoice Date (Date) o Currency Code (string) o Vendor ID (string) Example:- Request XML is given below: <tem:guid> </tem:guid> <tem:company></tem:company> <!--Zero or more repetitions:--> <tem:argument>s@1001</tem:argument> 37

38 Response XML is given below: <soap:envelope xmlns:soap=" xmlns:xsi=" xmlns:xsd=" <soap:body> <GetDataResponse xmlns=" <GetDataResult><![CDATA[<?xml version="1.0" encoding="utf-8"?> <GetPObyVendorId> <GetPObyVendorId> <PurchTable_DS.PurchId>000028</PurchTable_DS.PurchId> <PurchTable_DS.AccountingDate> T00:00:00</PurchTable_DS.AccountingDate> <PurchTable_DS.CurrencyCode>USD</PurchTable_DS.CurrencyCode> <PurchTable_DS.OrderAccount>1001</PurchTable_DS.OrderAccount> </GetPObyVendorId> <GetPObyVendorId> <PurchTable_DS.PurchId>000492</PurchTable_DS.PurchId> <PurchTable_DS.AccountingDate> T00:00:00</PurchTable_DS.AccountingDate> <PurchTable_DS.CurrencyCode>USD</PurchTable_DS.CurrencyCode> <PurchTable_DS.OrderAccount>1001</PurchTable_DS.OrderAccount> </GetPObyVendorId> </GetPObyVendorId>]]></GetDataResult> </GetDataResponse> </soap:body> </soap:envelope> 7. GetPOLineItem query:- Description : Returns Purchase Order line detail based on the PO number passed in. GUID : Input parameters:- o Company name (string) o PO Number (string) Return values:- o PO Number (string) o PO Line Number (number) o Item #/ID (string) o Original PO Qty (real) o PO Item Unit Price(real) o PO Extended Line Amount (real) o PO Item UOM (string) o Amount in the Transaction Currency (real) o Line Level Percent Discount (real) o Vendor ID (string) o PSATotalRetainAmount (real) o PO Item Description (string) o Transaction ID (string) o Purchase Qty (string) o Delivery Name where goods are being sent to (string) 38

39 o Line Discount in Amount for Price Unit (real) o Vendor Group/Data Area/Company (string) Example:- Request XML is given below: <tem:guid> </tem:guid> <!--Zero or more repetitions:--> <tem:argument>s@000424</tem:argument> Response XML is given below: <soap:envelope xmlns:soap=" xmlns:xsi=" xmlns:xsd=" <soap:body> <GetDataResponse xmlns=" <GetDataResult><![CDATA[<?xml version="1.0" encoding="utf-8"?> <GetPOLineItem> <GetPOLineItem> <PurchLine_DS.PurchId>000424</PurchLine_DS.PurchId> <PurchLine_DS.LineNumber>10</PurchLine_DS.LineNumber> <PurchLine_DS.ItemId>0002</PurchLine_DS.ItemId> <PurchLine_DS.PurchQty>1</PurchLine_DS.PurchQty> <PurchLine_DS.PurchPrice>23.99</PurchLine_DS.PurchPrice> <PurchLine_DS.LineAmount>23.99</PurchLine_DS.LineAmount> <PurchLine_DS.PurchUnit>Pcs</PurchLine_DS.PurchUnit> <PurchLine_DS.DiscAmount>0</PurchLine_DS.DiscAmount> <PurchLine_DS.DiscPercent>0</PurchLine_DS.DiscPercent> <PurchLine_DS.VendAccount>2001</PurchLine_DS.VendAccount> <PurchLine_DS.PSATotalRetainAmount>0</PurchLine_DS.PSATotalRetainAmount> <PurchLine_DS.Name>Adult Helmet Accessory Combo Set Adult Helmet Accessory Combo Set</PurchLine_DS.Name> <PurchLine_DS.InventTransId> _068</PurchLine_DS.InventTransId> <PurchLine_DS.PriceUnit>1</PurchLine_DS.PriceUnit> <PurchLine_DS.DeliveryName>Contoso Entertainment Systems (West)</PurchLine_DS.DeliveryName> <PurchLine_DS.LineDisc>0</PurchLine_DS.LineDisc> <PurchLine_DS.dataAreaId>ceu</PurchLine_DS.dataAreaId> </GetPOLineItem> </GetPOLineItem>]]></GetDataResult> </GetDataResponse> </soap:body> </soap:envelope> 39

40 8. GetGLAccount query:- Description Returns all the valid main account coding for the company for a given Chart of account. GUID : Input parameters:- o Company name (string) o Name of the chart of accounts Return values:- o Main Account number (string), o Main Account name (string), o Name of the Chart of Accounts (string) Example:- Request XML is given below: <tem:guid> </tem:guid> <tem:argument>s@cec</tem:argument> Response XML is given below: <soap:envelope xmlns:soap=" xmlns:xsi=" xmlns:xsd=" <soap:body> <GetDataResponse xmlns=" <GetDataResult><![CDATA[<?xml version="1.0" encoding="utf-8"?> <GetGLAccount> <GetGLAccount> <MainAccount_DS.MainAccountId>0102</MainAccount_DS.MainAccountId> <MainAccount_DS.Name>Closing Consolidation</MainAccount_DS.Name> <LedgerChartOfAccounts_DS.Name>CEC</LedgerChartOfAccounts_DS.Name> </GetGLAccount> <GetGLAccount> <MainAccount_DS.MainAccountId>999999</MainAccount_DS.MainAccountId> <MainAccount_DS.Name>Error account</mainaccount_ds.name> <LedgerChartOfAccounts_DS.Name>CEC</LedgerChartOfAccounts_DS.Name> </GetGLAccount> </GetGLAccount>]]></GetDataResult> </GetDataResponse> </soap:body> </soap:envelope> 40

41 9. GetBUDimension query:- Description : Returns all Business Unit dimension names for a given AX company GUID : Input parameters:- o Company name (string) o Business Unit dimension value (string) -- used for filtering. Return values:- o Business Unit dimension value (string) o Business Unit dimension name (string) Example:- Request XML is given below: <tem:guid> </tem:guid> <tem:argument>s@ou_4*</tem:argument> Response XML is given below: <soap:envelope xmlns:soap=" xmlns:xsi=" xmlns:xsd=" <soap:body> <GetDataResponse xmlns=" <GetDataResult><![CDATA[<?xml version="1.0" encoding="utf-8"?> <GetBUDimension> <GetBUDimension> <DimAttributeOMBusinessUnit_DS.Value>OU_4777</DimAttributeOMBusinessUnit_DS.Value> <DimAttributeOMBusinessUnit_DS.Name>Sales</DimAttributeOMBusinessUnit_DS.Name> </GetBUDimension> <GetBUDimension> <DimAttributeOMBusinessUnit_DS.Value>OU_4778</DimAttributeOMBusinessUnit_DS.Value> <DimAttributeOMBusinessUnit_DS.Name>Purchasing</DimAttributeOMBusinessUnit_DS.Name> </GetBUDimension> </GetBUDimension>]]></GetDataResult> </GetDataResponse> </soap:body> </soap:envelope> 10. GetDimension query:- 41

42 Description : Returns all the descriptions and values of a particular dimension for a given AX company where the financial dimension name is passed. GUID : Input parameters:- o Company name (string) o Dimension value (string) -- used for filtering o Dimension name (string) Return values:- o Description/Name of the dimension (string) o Value of the dimension (string) Example:- Request XML is given below: <tem:guid> </tem:guid> <!--Zero or more repetitions:--> <tem:argument>s@01*</tem:argument> <tem:argument>s@customdepartment</tem:argument> Response XML is given below: <soap:envelope xmlns:soap=" xmlns:xsi=" xmlns:xsd=" <soap:body> <GetDataResponse xmlns=" <GetDataResult><![CDATA[<?xml version="1.0" encoding="utf-8"?> <GetDimension> <GetDimension> <DimensionFinancialTag_DS.Description>Administration</DimensionFinancialTag_DS.Descrip tion> <DimensionFinancialTag_DS.Value>010</DimensionFinancialTag_DS.Value> </GetDimension> </GetDimension>]]></GetDataResult> </GetDataResponse> </soap:body> </soap:envelope> 42