Upgrading an Existing Installation

Upgrading from version 6.x -> 7.x

Version 7.0.0 introduces a new way to configure the addon-manual-sms integration between Lime CRM and Lime-Marketing. The integration now follows the same stucture as lime-newsletter, addon-lime-event and all other Lime-Marketing add-ons. When upgrading to this version you need to add the addon-manual-sms endpoint in an existing or new Lime CRM Integration under Administration -> Integrations in the Lime-Marketing application.

You can easily migrate an existing integration from the old "Webhook subscription" to the new Lime CRM integration by clicking the Select Webhook subscription button under the Migrate settings header on the integration settings page. Here you will be able to pick your existing Webhook subscription and the endpoint URL and API-key will be copied to the Lime CRM integration automatically.

Do not forget to synchronize the integration settings by clicking the "Syncronize to Lime CRM" button.

After migrating, verify the Lime Marketing settings in the appconfig for publication_id and mobilenumber_property_name.

Upgrading from version 5.x -> 6.x

Version 6.0.0 adds the displayname field to SMS-sendouts. You will need to run the addon-installer or add it manually in LISA/Database designer to add the new field to the database as well as the webclient views. If you are using the desktop client you need to install the LIP package to get the localizations, then you need to copy the files from the LIP folder to the actionpad folder.

If you add the field manually, create it on the smssendout limetype with these settings:

Setting	Value
Name	displayname
Field type	String (text)
Length	64

After adding the field, map it in the Lime Admin config (Limetypes Configuration) and make sure the config can be saved.

Upgrading from version 4.x -> 5.x

No actions needed, but from this version you can install the addon with the Addon Installer (Settings -> Addon Manual SMS -> Setup in Lime Admin).

Upgrading from version 3.x -> 4.x

Version 4.0.0 adds support for a preselected sender per template. You need to:

• Add a new field templatesender to the smstemplate limetype (manually in LISA/Database designer or via LIP/Addon installer). If it is missing or misspelled the sender defaults to empty. When adding it manually use these settings:

Setting	Value
Name	templatesender
Field type	String (text)
Length	64

• Webclient: add the webcomponent lwc-addon-manual-sms-template-sender-picker to the templatesender field on the smstemplate card. If you use the Addon Installer this is handled for you — it replaces the webclient views with ones that already include this webcomponent.
• After adding the field, map the preselected-sender property in the Lime Admin config. It is required — make sure it is set so the config can be saved.

Upgrading older versions

Note

Before version 3.0.0 there were no validation of the config. After upgrading and running the config migration the validation will be skipped once to be able to keep the invalid config in the database. Save the config and you will now see possible validation errors.

Re-install the LIP package or add new fields manually in LISA.

Update the VBA and Bootstrap files for the desktop client.

Make sure that the config can be saved in Lime Admin.

Note

From version 1.7.0 there is support for using the app config, please migrate from environment config to app config if applicable.

Note

When upgrading from the original VBA/desktop-only versions (pre 2.0.0), the legacy smsuser table is no longer used and can be removed.