Requirements¶
In order for the mail add-on to Outlook to work properly, the following requirements must be fulfilled.
Lime CRM¶
- Lime CRM Server 12.22 or above is needed in order to use the REST API.
- The customer's Lime CRM REST API must be accessible from the mail add-on service that is run on Lime Technologies's servers.
- An API user must be created together with a valid API key.
- To use the free-text search features when connecting person/company/deal, Lime CRM Server 13.0 or later is required.
Outlook and Exchange¶
The add-on requires the following to work properly on different Outlook platforms.
| Platform | Requirement |
|---|---|
| Outlook 2013 or Outlook 2016 for Windows | Exchange 2013 SP1 or above, Exchange Online, Outlook.com account or Office 365 |
| Outlook 2016 for Mac | Exchange 2013 SP1 or above, Exchange Online, Outlook.com account or Office 365 |
| Outlook for iOS | Exchange Online, Outlook.com account or Office 365 |
| Outlook for Android | Outlook.com or Office 365 commercial account |
| Web browser | Exchange Online, Outlook.com account or Office 365 |
| Outlook Web Mail | Exchange 2013 SP1 or above, Exchange Online, Outlook.com account or Office 365 |
For updated list of platforms and requirements, check Microsoft:
- https://support.office.com/en-us/article/Using-add-ins-in-Outlook-com-or-Outlook-on-the-web-a5672109-e4f3-4119-abea-72323e9653cf
- https://docs.microsoft.com/en-us/office/dev/add-ins/outlook/add-in-requirements
Please note that the Outlook add-in won't work if the client is configured to use POP3 or IMAP!
Database structure¶
The add-ins are adapted to fit the main structure of the Lime CRM Base solution v 2.0 or higher. This means that the database must have a specific structure for the add-ins to work properly. The structure includes specific tables and fields with specific table names/labels and field names. If any changes has to be done to fulfill the database requirements, this is done through the admin tool for Lime CRM (LISA). The fields on the todo table needed for synchronizing calendar appointments are included from Base Solution v. 7.4.
Tables¶
The following tables are needed in order to use the mail add-on:
| Table | Database name |
|---|---|
| Person | person |
| Company | company |
| Deal | deal, business or project (table label must be "Project") |
| Document | document |
| Todo | todo |
| History | history |
| Coworker | coworker |
This means that you MUST have separated tables for to-do and history.
If you use one table for both to-dos and history, then these need to be split in order to use the add-on.
Person table¶
The following fields and field names for the person table must be available in order to use the mail add-ins.
| Field | Field type | Field name | Description |
|---|---|---|---|
| First name | text | firstname | First name of the contact person sending the e-mail |
| Last name | text | lastname | Last name of the contact person sending the e-mail |
| Name | text | name | The contact person's full name |
| link | The contact person's e-mail address | ||
| Phone | text | phone | The contact person's phonenumber |
| Company | relation | company | Link to company |
Company table¶
The following fields and field names for the company table must be available in order to use the mail add-ins.
| Field | Field type | Field name | Description |
|---|---|---|---|
| Company name | text | name | Name of the company |
| Postal address 1 | text | postaladdress1 | This field or "Visiting address 1" is needed |
| Postal zipcode | text | postalzipcode | This field or "Visiting zipcode" is needed |
| Postal city | text | postalcity | This field or "Visiting city" is needed |
| Visiting address 1 | text | visitingaddress1 | This field or "Postal address 1" is needed |
| Visiting zipcode | text | visitingzipcode | This field or "Postal zipcode" is needed |
| Visiting city | text | visitingcity | This field or "Postal city" is needed |
| Complete postal address | text | fullpostaladdress | This field or "Complete visiting address" is needed |
| Complete visiting address | text | fullvisitingaddress | This field or "Complete postal address" is needed |
| Homepage | link | www | The field is used for matching contactpersons e-mail address to company |
Deal table¶
The following fields and field names must be available in order to use the mail add-ins.
| Table | Table label | Name |
|---|---|---|
| Deal | Project | deal, project or business |
| Field | Field type | Field name | Description |
|---|---|---|---|
| Deal name | text | name, dealname, projectname or businessname | Used for connecting note to deal |
| Company | relation | company | Used for connecting deal to company |
Document¶
The following fields and field names must be available in order to use the mail add-ins.
| Field | Field type | Field name | Description |
|---|---|---|---|
| Comment or Description | text | label needs to be "Description" | Text describing the document. Is set to the subject of the email |
| Document type | option | type | Not mandatory, but if the field exists, it needs to be required and there needs to be a option "E-mail" (see below) |
| Company | relation | company | Link to the company that the person is connected to |
| Person | relation | person | Link to the person sending/receiving the e-mail |
| Coworker | relation | coworker | Link to the coworker sending/receiving the e-mail |
| Deal | relation | deal, business or project | Link to the deal that is selected when saving the note (must match deal table name) |
Document types needed (mapped on option key):
| Option | Option key |
|---|---|
Todo table¶
The following fields and field names must be available in order to use the mail add-on.
| Field | Field type | Field name | Description |
|---|---|---|---|
| Subject | text | subject | Is set to "Follow-up" |
| Person | relation | person | Link to the person sending/receiving the e-mail |
| Coworker | relation | coworker | Link to the coworker sending/receiving the e-mail |
| Starttime | datetime | starttime | Is set to + 24 hours from when the e-mail was saved in Lime CRM |
| Endtime | datetime | endtime | (Only needed for calendar items) Is set to the endtime of the calendar item |
| Notes | text | note | Is set to "Follow-up e-mail" |
| Company | relation | company | Link to the company that the person is connected to |
| Deal | relation | deal, business or project | Link to the deal that is selected when saving the note (must match deal table name) |
To fully use the calendar synchronization feature, the following fields are needed:
| Field | Field type | Field name | Description |
|---|---|---|---|
| Location | text (512) | location | Set to "Location" in the Outlook calendar appointment |
| Calendar ID | text (1024) | calendarid | Outlook calendar ID |
| Calendar status | option | calendarstatus | Used to visualize if the todo is synced with Outlook |
Calendar status options needed (mapped on option key):
| Option | Option key |
|---|---|
| [empty] | empty |
| Active | active |
| Changed | changed |
| Deleted | deleted |
History table¶
The following fields and field names must be available in order to use the mail add-ins.
| Field | Field type | Field name | Description |
|---|---|---|---|
| Date | datetime | date | Date for the history note |
| Coworker | relation | coworker | Link to the coworker sending/receiving the e-mail |
| Type | option | type | Type of history note - is set to either "Received e-mail" or "Sent e-mail" (see below) |
| Person | relation | person | Link to the person sending/receiving the e-mail |
| Notes | text | note | Make sure the length is set to max (set length to 0). The history note will be truncated with ... if the email doesn't fit. |
| Company | relation | company | Link to the company that the person is connected to |
| Deal | relation | deal, business or project | Link to the deal that is selected when saving the note (must match deal table name) |
| Document | relation | document | Link to the e-mail (if saved as a document) |
History types needed (mapped on option key):
| Option | Option key |
|---|---|
| Received e-mail | receivedemail |
| Sent e-mail | sentemail |
Coworker table¶
The following fields and field names must be available in order to use the mail add-ins.
| Field | Field Type | Field name | Description |
|---|---|---|---|
| First name | text | firstname | First name of the coworker receiving/sending the e-mail |
| Last name | text | lastname | Last name of the coworker receiving/sending the e-mail |
| link | The coworker's e-mail address |
Other requirements¶
E-mail addresses¶
All Lime CRM users that want to use the mail add-ons need a valid e-mail address on their coworker card in Lime CRM. The e-mail address is needed to map the user who saves the e-mail as a note in Lime CRM to the right coworker in Lime CRM.