Installation Instructions

Preparations

  • Check that the requirements are met.
  • Make sure that LIP is installed in order to easily install the add-on. If LIP is not installed, you need to manually download the LIP zip file and extract the files necessary from it.

Installation in Lime CRM

Base Version

This section describes what needs to be done in Lime CRM to set up the integration.

  1. Enter the VBA editor in the desktop client and run lip.Install "erpconnector-order" from the immediate window.
  2. Add ControlsHandlerOrder to the VBA Class Module GeneralControlsHandler, as shown in vba\GeneralControlsHandler.txt.
  3. Compile and save the VBA project.
  4. In LISA: Add the icons for order, orderrow, dealarticle, article and articlegroup. The icons are found in the folder lisa\icons in the LIP package. If you cannot find the tables in LISA, refresh the browser.
  5. In LISA: Add descriptive expressions for order, orderrow, dealarticle, article and articlegroup. The descriptive expressions are found in text files in the folder lisa\descriptives.
  6. In LISA: Add option queries for dealarticle.article and orderrow.article. The expressions are found in text files in the folder lisa\optionqueries.
  7. In LISA: Make sure the suggested VAT levels are set according to the country rules in the options on the fields orderrow.vat and article.vat (they share option lists, so updating one should fix the other). Standard levels for the different countries are found below.
  8. If BL Administration: In LISA: Create a text field of length 32 on the order table, called paymentterms.
  9. Either follow the instructions for "Without Backend" or "With Backend".

Suggested VAT levels: image

Without Backend

The only situation where this is to be used is in Lime CRM Shared Cloud.

  1. In LISA: Add SQL on update expressions for fields on tables orderrow and dealarticle. All expressions are found in text files in the folder lisa\sql_on_update.
  2. Configure the add-on according to the instructions here.

With Backend

This is required to be able to create orders in the Web Client.

  1. In the customer's solution: Add the limeobject-classes found in resources/limeobject_classes.
  2. Add limepkg-erp-order as a depency in your solution's pyproject.toml file.
  3. Build and deploy your solution.
  4. Configure the add-on according to the instructions here.

Valid VAT levels

Country VAT levels (default in bold)
Sweden 0, 6, 12, 25
Denmark 25
Norway 10, 15, 25
Finland 10, 14, 24

Including Customizations For Creating Orders Programmatically

If orders are to be created in Lime CRM from another limeobject.

  1. Set the const m_className at the top of the AO_ERPConnector_Order VBA module.
  2. Add code to GeneralExplorerHandler.m_Explorers_BeforeActiveExplorerChanged, as shown in the file vba\GeneralExplorerHandler.txt.
  3. Compile and save the VBA project.
  4. Copy the addon_erpconnector_order folder in the apps catalog to the subfolder apps in the Actionpad folder.
  5. In the index Actionpad, add the instantiation of the app (as shown below).
  6. Publish the Actionpads.
  7. Create Custom Endpoint (post) and add to the customer's solution. Here is where you add the customized logic. Make sure that it is registered as /create-orders/. See create_orders_template.py under resources. If the customer is a cloud-customer, change the request in app.js to a VBA-call instead and add your logic there.
<div data-app="{
    app: 'addon_erpconnector_order',
    config: {}
}"></div>

Installation of Syncify Service

This is managed by Syncify. Both for on-premise and cloud ERP systems.