Upgrading an Existing Installation¶
An upgrade can either consist of upgrading the Lime side of the integration or the on-premise Syncify service, or both. Defining a checklist for an upgrade can therefore be a bit hard. The below should therefore be regarded as a guideline rather than a checklist. Also, the installation instructions should be read and used to relevant extent.
- Investigate which side(s) of the integration that should be updated.
- Syncify will manage the update for both their on-premise and services. Any upgrade on Lime side should be communicated with Syncify, so they can react accordingly.
- Check that all the current requirements are met. There may be new requirements since the last installation was made.
- If the previously installed version is of an earlier major version, check the section below for special instructions for your version bumps.
Upgrading to a New Major Version¶
When upgrading from a very old version of the ERP Connector, the following field might need to be added to the invoice
table.
Database Field Name | Field Type | Length |
---|---|---|
currency | Text field | 32 |
Upgrading to v9.9.y¶
Add this field to the invoicerow
table:
| Field | Field type | Invisible | Required | Default Value | NULL is permitted | Readonly |
|-|-|-|-|-|-|-|
| position | Integer | False | True | 1 | True | True |
Translations:
| Swedish | English | Danish | Norwegian | Finnish | German | Dutch |
|-|-|-|-|-|-|-|
| Position | Position | Position | Posisjon | Asema | Position | Positie |
Upgrading to v9.x.y¶
With version 9 turnover and sales trend calculations have been moved from SQL expressions to a scheduled task. Refer to the configuration page for more details.
- Remove the SQL expressions from the
company.erp_turnover_lastyeartodate
in Lisa. - Remove SQL on_update expressions from the following fields in Lisa:
company.erp_turnover_lastyear
company.erp_turnover_yearnow
- Add the
company.erp_salestrend
andcompany.erp_ytdgrowth
properties by running the LIP package or the addon installer. - Rename the username of your
erpsync
user toerpsync@lime
. - Select the
erpsync@lime
user as the Sync user in Lime Admin. - Enable scheduled task in the application config.
- If on-premise: Restart the Task Handler service.
- If isolated cloud: Deploy your solution with the
limepkg-erp-connector
updated to v9.x.y. Make sure theerpsync@lime
user exists, before you deploy. - Verify after one night that the scheduled task ran by looking for
limepkg_erp_connector.sales_trend.tasks.calculate_sales_trend
in the Task Handler logs. Kibana query for cloud customers:docker.hostname : "taskhandler-<CONTAINER-ID or 'shared'>.1.*" and job: "task-handler" and message : "limepkg_erp_connector.sales_trend.tasks.calculate_sales_trend"
Upgrading to v8.x.y¶
v8 has a totally rewritten code base and works in a different way than previous versions. It is essentially a new installation. So it is a good idea to go through the installation instructions. Below, the main actions that need to be taken in Lime CRM are listed. Updates are done in co-operation with Syncify. Refer to the installation and configuration pages for more detailed instructions when needed.
Preparation: (For on-premise ERP systems) Make sure the customer has .NET v4.7.2 or later installed on the server where the Syncify sync service is installed. Upgrading .NET is done by the customer or their IT partner. It requires a server restart, which means it is most often performed after office hours.
- Add the dependency to the python package
limepkg-erp-connector
in your solution or update it if you already have it. - Rename the field
company.erpid
tocompany.erp_id
. - Rename the HTML tab
company.erpconnector_graph
tocompany.erp_connector_graph
. - Update the SQL on update for
invoice.customerid
in LISA. - Add new fields. Use the LIP package or set the technical page for which field properties to set.
- Add the field
company.erp_status
. - Add the field
company.erp_firstsynced
. - Add the field
company.erp_errormessage
.
- Add the field
- Mass update all companies that have a value in
company.erp_id
and set theircompany.erp_status
tosynced
. The mass update can be done in either client. In the desktop client remember to change thecompany.erp_status
field temporarily toreadonly=False
in Lisa first. - Remove old LBS apps and the instantiation from the company Actionpad.
- Install new LBS apps and add new instantiation in the company Actionpad.
- If you are using ERP Master: Upgrade that to the latest version and move the setting
m_sErpSystem
from the old ERP Connector VBA module to the new ERP Master VBA module. - Update the VBA module.
- If using in Lime CRM Desktop Client: Update the VBA code to instantiate the invoice overview graph.
- Delete all localizations from the
localize
table having the owneraddon_erpconnector
with the exception of the three having the following code:copypostaltoinvoiceaddress
q_overwrite_invoiceaddress
i_address_readonly
- Delete old configuration from Lime Admin (if any) and reconfigure.
- Add the web component to the company card if the web client is to be used.
Upgrading to v7.x.y¶
Add the field company.erp_lastsynced
.
Upgrading to v6.x.y¶
Add the field invoice.conversionrate
. Make sure to handle a migration from the ERP system to fill this field in Lime CRM on existing customers.
Upgrading to v5.x.y¶
Add the field company.emailinvoice
. Make sure to handle a migration from the ERP system to fill this field in Lime CRM on existing customers.
Upgrading to v4.x.y¶
This version was considered a breaking change since we introduced support for Lime CRM web client. There is no special action that is needed if you upgrade to this version besides configuring it for the web client.
Upgrading to v3.x.y¶
In major version 3, new fields where introduced (see Changelog. Therefore, upgrading to (or past) this version requires some special care. Updates are done in co-operation with Syncify.
- Create new fields in Lime CRM (preferably through LIP).
- Follow normal upgrade procedure.
- Migrate data to the new address fields.
- For Visma.Net: Syncify migrates the invoice address in Visma.Net
- For other ERP systems: Copy Lime CRM
postal address
to Lime CRMinvoice address
. This can be done by using the SQL script in the fileresources\Upgrade to v3.x.y.sql
in the GitHub repository.
- Set the new relation between
company
andinvoice row
by using the SQL script in the fileresources\Upgrade to v3.x.y.sql
in the GitHub repository.
Warning
If the customer is in the Lime CRM cloud and you wish to use the prepared SQL script, you need to download the database, run the SQL script and upload it again.