Server upgrade

This page describes how to upgrade an existing Lime CRM Server installation. The upgrade procedure differs depending on the version of Lime CRM Server that is currently installed.

The installer application remembers the installation configuration (e.g. user and group information) specified from the last time it was run, however, no passwords are remembered so make sure you know the password for the user account that Lime CRM Server services are running under.

Follow these steps:

1. Back-up the database
2. Perform pre-upgrade preparations
3. Run the installer (limepro-server-<version>.exe).
4. Upgrade databases.
5. Install the solution (make sure that this is depending on the same crm-version that you just installed on the server, see pre-upgrade preparations) https://platform.docs.lime-crm.com/en/latest/on-premise/overview/#installing.
6. Re-enable Super Search if it was in use earlier.
7. Re-index the database (needed if the customer uses the web client)
8. If customer uses the web client, turn on and tune in new features. See section Tips for the web client…

Follow these steps to ensure that you're upgrade is successful:

Read up on the release notes for the server version you are upgrading to, and all the server versions you may be jumping over. Are there any things that will require special attention during the upgrade?

• Note: server version 2022.2.739 (2.308.3) and higher requires Lime CRM Desktop Client version of 10.18.962 or higher

• Upgrade version of lime-crm in the solution. https://platform.docs.lime-crm.com/en/latest/getting-started/managing-dependencies/#the-lime-crm-dependency.
• Generate build of new package. See more info here: https://platform.docs.lime-crm.com/en/latest/getting-started/packages-and-solutions/#using-github-actions.

If it doesn't exist a solution you need to create one. Instructions can be found here: https://platform.docs.lime-crm.com/en/latest/getting-started/lime-project/#starting-a-new-project.

Go through all the add-ons that are installed in the Lime CRM application. Check their documentation and see if there are new versions that could or MUST be installed. There are mainly two good reasons to also upgrade installed add-ons:

• The version that is installed for an add-on may not work anymore if the server is upgraded.
• Doing a server upgrade is the perfect time to also make sure the add-ons are up to date so the customer can enjoy the latest and greatest version of the Lime CRM software.

Check if Super Search is enabled in Lisa.

If you see that Lime CRM Webfront is having problems starting, it most probably is due to the fact the port 443 is already in use by another process. Open a command prompt, and run:

netstat -nao | findstr LISTEN

Ensure that there is no entry using port 443. These show up as 0.0.0.0:443, 127.0.0.1:443, [::]:443, or a specific IP-address followed by :443. If you see an entry like this, make a note of the process ID (PID) and see if you can find info about the corresponding process in Window's task manager. A PID of 4 means the System Process. We've seen the system process allocate port 443 if SQL Server Reporting Services is installed.

1. Open cmd/terminal/windows powershell (not Lime Pro Command Prompt).
2. Write ‘python -V’ and press enter key to see Python version.
3. Compare version with the one found here.
4. If not using latest compatible version. Run the Python installer and click “Upgrade Now”.

Stop the following Lime services:

1. Lime CRM Event Handler
2. Lime CRM Import Service
3. Lime CRM Scheduler
4. Lime CRM Search Engine
5. Lime CRM Search Indexer
6. Lime CRM Server Administration
7. Lime CRM Task Scheduler Service
8. Lime CRM Task Service
9. Lime CRM Webfront
10. Lime CRM Webserver

Run the installer (limepro-server-<version>.exe)

1. Open task manager, go to the details tab. 2. Stop all processes that has the name “pythonservice.exe” or “python.exe” 3. If this doesn't work, please contact support.

All Lime CRM databases that are to be used after the upgrade must be migrated to the latest revision of the database schema. This is done using limefu with the following command (from version 12.4):

limefu database upgrade --application "DATABASE DISPLAY NAME"

Install the solution (make sure that this is depending on the same crm-version that you just installed on the server, see pre-upgrade preparations) https://platform.docs.lime-crm.com/en/latest/getting-started/install-project/#installing-a-solution-on-premise.

If using the Lime CRM Web Client, the search index needs to be re-created or updated. Note that this might slow down the solution for the users, it is recommended to do this after work hours, especially if it is the first time or a big solution. This is done using limefu, see instructions under Views and index/Search index.

From Lime CRM Server 12.6, the file-API makes it possible to include the name of the document-file as a proper filename. When upgrading, already existing files do not have any filename, and if you want to set the filenames on the already existing files you need to run the following SQL-script. The script set the filename to the text in the field [description] on the document-table, but can be adjusted to suit the individual solution.

filename-migration-lime.zip

From Lime CRM Server 12.9, lime-views and some configuration is stored in the database instead of in files. To migrate existing lime-views and configurations, run the following script from the Lime CRM Command Prompt on the server.

python migrate_config.py <database name>

migrate_config.zip

Some tips:

• Don't manually delete directories and files if you're not really sure what the consequences are.
• Check out RabbitMQ cannot be started after an upgrade of Lime CRM or Lime CRM Server Installer may report that the installation failed or Installing Lime CRM Desktop Client on top of Lime CRM Server may cause problems or RabbitMQ may fail to start due to an invalid configuration file for specific symptoms

With Lundalogik Active Directory Integration it's possible to map an AD group to the database itself. This allows AD users to be added as Lime CRM users without giving them login permission.

Consider the following scenario:

The AD group Employees is currently mapped to the Lime CRM group Users with the auto-create option enabled in order to add them as users in Lime CRM using the synchronization feature. The reason for this is to get all employees into Lime CRM so that they can be assigned e.g. a helpdesk ticket even though they don't use Lime CRM themselves. Another AD group Lime CRM Users, containing all users that should be able to use Lime CRM is then included in the Distributed COM Users Windows group which controls login permissions. This means that all members of Employees will be imported, but those not in Lime CRM Users will not be able to log in.

Since authorization starting with Lime CRM Server version 12 no longer uses the Distributed COM Users group this means that the above setup will no work since all users in Employees will be able to log in to Lime CRM. To fix this some changes must be made to keep the previous behavior:

• The AD group Employees must be mapped to the database. This is done in the Security Overview in LISA.
• The AD group Lime CRM Users must be mapped to the Lime CRM group Users with auto-create activated.

Now everything will work in the same way as before, minus the extra complexity of the Distributed COM Users group.

• The new start page is turned on by default. Make sure it looks good and that all widgets (especially info tiles) have been moved to the new start page. https://platform.docs.lime-crm.com/en/latest/configuration/webclient/start-page/
• Over delivery: Add multiple start pages if you think your customer needs them.
• Over delivery: Remove unnecessary fields from create new dialogs. Calculated fields, read only field, “inactive” and more do not provide any value when creating new records. Take a minute or two to disable them on new in the card view of the most common lime type.
• Over delivery: Does you customer have a lime type that hold hundreds of thousands or even millions of records? Is there no need to have that lime type searchable? https://platform.docs.lime-crm.com/en/latest/services/indexer/#exclude-lime-types to make the index much smaller and reduce re-index time.