This document touches on key concepts in the Lime CRM echo system that you need to be aware of when working with any kind of customizations in a solution. In order to keep information centralized and easier up-to-date, the documentation of add-ons and packages is based on this knowledge.
Please make sure to read the add-on's own documentation for all the specific information. We have all the different add-ons documentations linked here.
What is a solution, package and add-on?¶
Read more info here
How can I add a package as a dependency to a solution?¶
The install process is documented here.
Remember that an add-on can consist of more than a package, so make sure you cover all the installation steps in the add-on's own documentation.
How can I install a solution on-premise?¶
Check out this documentation.
What are the different kinds of configuration?¶
Read more here
What are LIP packages?¶
You can find a documentation for it here.
What is Lime Bootstrap?¶
Lime Bootstrap (also known as LBS) is a web framework for the Actionpad in the desktop client, so you can build your own customization. You can get further information on the topic here.
With the concept of object access you can define users permissions in great detail. Please check out this page for more on the topic.
Many third party integrations communicate with Lime CRM via our REST API and rely therefore on an API key. To create one, create a user of type integration in LISA and generate an API key for that user. When communicating with the API ensure that the key is included in the header of each request like this:
curl --location --request <METHOD> 'http://URL/TO/THE/ENDPOINT' \ --header 'x-api-key: <API KEY>'
What are common approaches for troubleshoots?¶
Often when something isn't working it's due to a certain request that returns an error. The first approach should always be to find more information about that. Therefore open the DevTools of your client and look for the failed request. Here an example for the webclient:
The URL of the request should give an idea of the responsible component (core platform or which package) and an error message, which can help you to figure out whether or not a misconfiguration on your side could be the cause of the problem. If that's not enough information (e.g. in the case of a 500 error code) you should look for logs. The fact that you see a failed request means that it had to be processed by the webserver, so that's the service for which you want to see the logs for.
The more difficult cases are when you notice that one of the background services is acting out. Some common examples
- you started an async task, but it keeps on pending (-> taskhandler)
- you added a new object and can't find it in the global search (-> search-indexer)
- your custom event handler isn't executed (-> eventhandler)
Then you need to look for logs of that specific service.
Log files on-premise¶
Similarly to the environment config files the logs are located per service on the platform.
For Windows, the location is
%programdata%\Lundalogik\LIME Pro Server\<service name>\logs.
For Linux, the location is
/etc/lime/<service name>, such as:
Log files in Cloud¶
In cloud logs are available via Kibana which is only accessible by Lime Technologies' employees. For troubleshooting instructions in Kibana check out this internal link.