A Live Integration between Dynamicweb and a remote system makes it possible to retrieve data from a remote system, e.g. live prices and stock levels – or to have the remote system handle order, discount, and/or shipping fee calculations in real time.
All of these requests are handled by the Live Integration add-in, and they are presented here mainly to allow you to test and debug using the Dynamicweb Connector TestTool.
A basic feature of the Live Integration is the ability to request customer-specific prices from a remote system. Technically, this happens on pageload whenever a price is rendered and the Enable live prices checkbox is checked in the add-in.
Two parameters are used to request customer-specific prices – ExternalUserId and/or AccessUserCustomerNumber.
|
Parameter |
Values |
Required |
Comments |
|
ExternalUserId |
An external id from the remote system |
No |
|
|
AccessUserCustomerNumber |
A value from |
Yes |
If user is anonymous, the value is set to the ERP Anonymous users key. This key must match a customer on the remote side. |
Standard request:
Standard response:
A customer statement PDF is a report of all entried in the customer’s account balance in NAV/Business Central. Basically, you submit a customerID, a start date and an end date to the remote system and revceive a pdf base64 string back which you must then handle on your end. This request is not implemented on any DW app by default but is made available for custom projects.
|
Parameter |
Value |
Required |
Comments |
|
customerID |
A valid ‘customer no’ in NAV/BC |
Yes |
The ‘customer no’ value is typically imported to the standard DW customer number field. |
|
startdate |
YYYY-MM-DD |
Yes |
|
|
enddate |
YYYY-MM-DD |
Yes |
|
Standard request:
Standard response:
This request returns a pdf base64 string response - if using the TestTool, the response is automatically opened in a pdf-viewer.
Standard request:
Standard response:
The GetList request is used to retrieve lists of various documents from the remote system – orders, invoices, and credit memos. These requests are transmitted to the remote system by the integration customer center. There are four parameters – they are:
|
Parameter |
Value |
Required |
Comment |
|
type |
Credit |
Yes |
In principle, the type parameter can take any custom value, in order to expose data from another table than the three standard types. This does however require an ERP developer to specify the XML reponse readable in Dynamicweb. |
|
customerID |
A valid ‘customer no’ in NAV/BC |
Yes |
The ‘customer no’ value is typically imported to the standard DW customer number field. |
|
requestAmount |
An integer |
No |
Used to control how many list items are returned per request. |
|
firstItem |
An integer |
No |
Used to control which list item is the first item in the current batch of list items. |
Standard requests:
Standard responses:
The GetItem request is sent to the remote system by the Integration Customer Center and is used to request specific orders from the order list requested by GetList.
Standard GetItem request:
Standard GetItem response:
When checking the xml that is being generated by the remote system, there are a few details you should be aware of:
- The EcomOrders and EcomOrderlines values in the "table" properties are expected by the Live Integration Project.
- If you add columns to either orders or order lines, they will automatically be available via tags in the templates for rendering the items and lists
- The communication between Dynamicweb and the remote system, and the conversion between the XML generated by the remote system and Dynamicweb tags, is handled by the Live Integration Project, in the internal class IntegrationCustomerCenterHandler - and can be customized there
When you parse the XML to build e.g. a list of files to download you can customize the file name of the downloaded file by adding &filename=invoice234.pdf to the download link.
|
Parameter |
Value |
|
type |
Credit |
|
id |
A valid ID of a document |
|
externalUserID |
An ID of the user in the remote system |
Standard request:
Standard response:
This request returns a pdf base64 string response - if using the TestTool, the response is automatically opened in a pdf-viewer.
The XML response in the integration customer center can be sorted by adding additional parameters to the request.
The parameters for sorting are sort (direction) and sortByField as in the example below.
Sort parameter values:
| Parameter value | Description |
| asc | sorts the response high to low / new to old |
| desc | sorts the response low to high / old to new |
If the parameter is not set the ICC defaults to sorting in a descending order.
Sort by field parameter values:
| Parameter value | Description |
| id | Sort by ID |
| shipdate | Sort by shipping date |
| duedate | Sort by due date |
| postingdate | Sort by posting date |
| totalamount | Sort by amount |
| totalamountincvat | Sort by amount including VAT |
| documentdate | Sort by document date |
If the parameter is not set the ICC defaults to sorting by order date.
As of version 1.2.0.40 of the Business Central Codeunit, the rounding precisions used by the codeunit to round both order lines and order totals are obtained from the General Ledger and Currency setup in Business Central. This means, that when the Live integration sends an order to Business Central, the following rounding rules are applied:
Orders in the local currency (LCY):
- Order lines are rounded to the precision defined in General Ledger, Unit-amount rounding precision (LCY)
- Order totals are rounded to the precision defined in General Ledger, Amount rounding precision (LCY)
Orders in currencies OTHER than LCY:
- Order lines are rounded to the precision defined for the specific currency in Currencies, Unit-amount rounding precision
- Order totals are rounded to the precision defined for the specific currency in Currencies, Amount rounding precision