Upgrading an Existing Installation¶

For some versions there might be manual steps that you need to do. They are listed below.

Upgrading to v2.7.0¶

Text Snippets are now available!

This is not a breaking change. However, for the optimal user experience, please adhere to the following instructions:

Add the following option to the option field textsnippet.textsnippetstatus:

option key Swedish English Danish Norwegian Finnish German Dutch

inactive Inaktiv Inactive Inaktiv Inaktiv Ei aktiivinen Inaktiv Inactief
Set the field textsnippet.text as required in LISA.
Set the field textsnippet.description as required in LISA.
In Lime Admin -> Settings - Email Integration -> Setup, press the Check installation button and run the installation. This should add one new field textsnippet.pinned and also update the view configuration for the Text Snippet table.
In Lime Admin -> Settings - Email Integration, under the Text snippet limetype mapping, map the pinned property and save the config.
If you are running Lime CRM in isolated cloud or on-premise, make sure that you have the limepkg-config-importer, limepkg-option-visualizer, and limepkg-status-flow packages installed.
Use the Config Importer to import this file. This will add config for Status Flow and Option Visualizer packages.
Create table policies according to these instructions.
Read up on how to use Text Snippets here.

Upgrading to v2.0.0¶

Add the Forwarding Action¶

Forwarding is now available!

Add the following promoted action to your Conversation view in Lime Admin:

{
    "id": "limepkg_email.forward",
    "label": "limepkg_email.forward",
    "icon": "forward_arrow",
    "params": {},
    "visibility": {
        "conditionID": "limeobject-matches-filter",
        "conditionParams": {
            "key": "firstmessagedate",
            "op": "!",
            "exp": null
        }
    }
}

Info

It is not possible to forward conversations that was created before this upgrade.

Database Structure Changes¶

There are some database structure changes that also need to be done at the same time as upgrading to this version.

On the limetype messagefollower, for the option field participationlevel, do the following two things:
1. Rename the option key normal to to. Also update all display texts according to the table below.
2. Add a new option with key from and set display texts according to the table below.
  
  option key Swedish English Danish Norwegian Finnish German Dutch
  
  to Till To Til Til Kohteeseen An Aan
  
  from Från From Fra Fra Kohteesta Von Van

Migrate Existing Conversations¶

From this version, how follower and messagefollower objects are handled is different. This will make pre-existing messages in pre-existing conversations look wrong when they show in Lime CRM who sent a certain message and who received it. New messages in pre-existing conversations will look correct.

The main idea is that the new version follow these rules:

Unique follower record per email address on each conversation.
One messagefollower record for each participant, i.e., not unique per email address.

Read up on the concept of our limetypes here.

If it is desired to fix the pre-existing messages, it is possible through manual actions.

Info

The following needs to be done on each pre-existing conversation.

Followers

Create a follower record for the monitored email account. (This card will be created automatically upon the next incoming or outgoing message in this conversation).
1. Set the email address.
2. Set the name.
3. All relation fields should be empty.
4. Participation level can just be left to the default value (this is not used anymore).
5. Set Subscribed = False.
6. Set Active = False.
Remove any duplicates on email address. This is typically only happening when you are testing the email functionality in Lime CRM by emailing with yourself. Perhaps these conversations can be neglected since they are then tests only?
Verify that each follower possesses a unique email address (it can not be empty).

Message Followers

For all incoming emails:
1. Create a messagefollower record for the monitored account.
  1. Set Participation level = "To".
  2. Set the Follower relation correctly.
For the automatic reply message:
1. Create a messagefollower record for the monitored account.
  1. Set Participation level = “From”.
  2. Set the Follower relation correctly.
Make sure there is a "From" messagefollower on all conversation messages. Update the participation level on them manually. This can be tricky to know if there are several with participation level "To" on the same message.
Remember: If the same email address has been used for different participation levels (for example both as To and From), then there should be one messagefollower record per participation level. This is typically only happening when you are testing the email functionality in Lime CRM by emailing with yourself. Perhaps these conversations can be neglected since they are then tests only?

Info

Please note that the conversation history in outgoing emails will continue to look correct even without the above manual changes.

Upgrading to v1.172.0¶

New properties (send_automatic_reply and max_email_age_for_auto_reply) have been added to the delegated accounts stored in the sys_data table in the database. Before upgrading, delete all email accounts.

Upgrading from Inbox/Comflow or Mail Gateway¶

The main issue addressed when upgrading from Inbox/Comflow or Mail Gateway is the transition period between using the old integration and the new one. However, it is also important to be aware of any customizations made to the current setups and make sure that they are compatible with Email Integration.

Info

For internal use, please also read the internal documentation here.

Upgrading from Inbox/Comflow¶

The first step, before installing Email Integration, is to make an assessment of any customizations made to Lime Inbox and their compatibility with Email Integration. This should be done by someone familiar with the Inbox setup and who has access to the Github repository in which the customer's customizations are located.

Recommended Steps for Transition¶

When migrating an existing Inbox installation to Email Integration there will be a transition period in which some tickets are still connected to the old inbox configuration, while new tickets are handled by the new Email Integration. During this time, the recommended method for handling emails is to use the Inbox configuration to process incoming emails that already have an Inbox Communication connected with a custom task. After installing the Email Integration as usual, follow these steps:

Install the custom task for handling Inbox tickets. This task will intercept all new emails read into Lime and check if they belong to an existing Inbox Communication in Lime. If any of them do, they will be read into Lime using the existing Lime Inbox setup. Those that don't will be read in as usual with Email Integration. In order for this to work, the dependency to Inbox needs to remain in the solution but inactivated so that only Email Integration reads the emails.
During the transition period, Inbox/Comflow will keep handling the old Inbox tickets until they are completed, while the Email Integration handles all new tickets. To help the user differentiate, variations on the helpdesk object can be created (given that there are no pre-existing variants), where all Inbox tickets keep the Inbox/Comflow web client appearance, while new Email Integration tickets will have the new appearance.

If your customer is moving from a Desktop client setup without Comflow, you need to figure out what instructions to give the users. They will not have a conversation to reply to, only the standard communication objects (depending on any customizations made to the Inbox setup).
Remove Inbox Inbox and the custom task should be disabled/removed after all the old tickets that was started using Inbox have been completed, as all new incoming tickets will be handled by Email Integration after this point. To completely remove Inbox:
- Remove or disable the custom task for handling Inbox messages
- Remove endpoints for handling Inbox messages and recovery.
- Remove other customer specific Inbox customizations.
To make sure users understand that Communication Flow can no longer be used once the package is removed, it's important to implement the read-only mode documented here. This can be configured at the time of the upgrade by entering the planned date for removal of inbox in the webadmin settings under Communication Flow –> Migration configuration.

Upgrading from Mail Gateway¶

For the upgrade from Mail Gateway to Email Integration it is necessary to first check the existing setup and way of working in Lime carefully. Please see the internal documentation for more information about this.

option key	Swedish	English	Danish	Norwegian	Finnish	German	Dutch
`to`	Till	To	Til	Til	Kohteeseen	An	Aan
`from`	Från	From	Fra	Fra	Kohteesta	Von	Van