Skip to content

Installation instructions

Preparations

Before you start the installation:

  • Have you ordered a Lime Marketing site?

  • Have you or the sales rep sent out the Newsletter Form?

    On-prem only: - Can we access the webclient externally?

What the customer needs to prepare or answer:

  • What sending domain do they want?
  • How do they work with consent and do they want to work with consent in Lime?

Installation

For installations in shared cloud, go to step 3.

1. Add lime-newsletter as a dependency to your solution

Run:

poetry add lime-newsletter

If they do not have limepkg_consent dependency, run:

poetry add limepkg_consent

2. Build and deploy your solution

3. Install LIP package

Now it's time to set up the required tables and fields required for lime-newsletter. The tables and fields are not required to have to the same naming as in this documentation but the relation between the tables must be the same. The table and field names are then configured in Lime Admin if they differ from the default.

If they have LIP installed, install the LIP package in the following order:

  1. consent - Only tables and permissions are required.
  2. lime-newsletter - In the Immediate Window in the VBA editor of the Desktop Client, run lip.Install "newsletter" or download the latest LIP package from the releases page and run lip.InstallFromZip.

If they do not have LIP installed you can set up the required fields manually by following this specification.

Before you proceed: Finish the installation and configuration of consent.

Info

It's important that you use a lime-newsletter LIP package matching the installed version on the Lime-server. If that release of lime-newsletter does not contain a LIP package asset use the first LIP package you can find in a previous version of lime-newsletter.

If you have made any changes to the default tables and field setup, be prepared to configure the changes in Lime admin later.

Make sure that the option fields campaign.type, campaign.campaignstatus have key values (some older core databases were lacking this).

4. Configure in LISA

Add the following fields manually in LISA

Person table

database field type Swedish English Danish Norwegian Finnish Dutch
totaloptout yes/no Avregistrerat från utskick Total optout Afmeldt fra udsendelse Avmeldt fra utsendelse Poistettu postituslistalta Uitgeschreven van mailing
emailhardbounce yes/no E-post studsat Email hard bounce E-mail afvist E-post ble returnert Sähköposti pomppii E-mail teruggestuurd

Marketing activity/campaign table

database field type Swedish English Danish Norwegian Finnish Dutch
consenttype 1:n relation Samtyckestyp Consent type Type samtykke Type samtykke Suostumuksen tyyppi Uitgeschreven van mailing

Check that all option fields have key values.

Add SQL expression

  • Add the SQL expression on mailing.htmlsendoutlink and mailing.htmlstatisticlink. The SQL expressions are found in text files in the folder lisa\sql_expressions in the LIP package.

Field label

Set field label = "Name" on:

  • mailing.subject
  • consenttype.title

Desktop client (only)

This step is only necessary if Newsletter is supposed to be used from the Lime CRM Desktop Client. If webonly, continue to the next step.

  • Add the icons for the tables mailing, emailopening, linkcklick and recipient. The icons are found in the folder lisa\icons. If you cannot find the tables in LISA, refresh the browser.
  • Add descriptive expressions for mailing, emailopening, linkcklick and recipient. The descriptive expressions are found in text files in the folder lisa\descriptives.
  • If your Lime CRM application already has an Actionpad for the marketing activity/campaign card: Add the code below to the campaign.html Actionpad. Otherwise, create an actionpad with the same database name as your marketing activity table and add the code.
    <button class="btn btn-lime btn-info" data-bind="openURL: 'https://app.bwz.se/customer/', text:'Open Lime Marketing', icon: 'fa-paper-plane-o'"></button>

Adjust the URL to your customers Lime Marketing site.

Create an API user

An API key in Lime CRM will be used at a later stage of the integration setup, make sure that the user for that API key has the correct permissions in the database.

  1. Create a Newsletter integration group in LISA.
  2. Create the API user in LISA with the following settings:
  3. Add the API user to the Newsletter integration group.
  4. Save the API key, it will be used later.

Don't know how to create an API user? Follow instructions here.

Create policies

  1. Create new table policies for tbl_mailing, tbl_recipient, tbl_linkclick and tbl_emailopening, and set the following permissions for normal users.
Policy name R W A D Apply to
tbl_mailing • mailing table
tbl_recipient • recipient table
tbl_linkclick • linkclick table - If link clicks are being used
tbl_emailopening • emailopening table - If email openings are being used
  1. Set the correct permissions for the Newsletter integration group on each table policy. The group will need read permissions to all tables used by the integration. Then, apply these policies on the corresponding tables.
Policy name R W A D Apply to
tbl_person • • • person table
tbl_campaign • campaign table
tbl_company • company table
tbl_participant • participant table
tbl_mailing • • • mailing table
tbl_recipient • • • recipient table
tbl_linkclick • • • linkclick table - If link clicks are being used
tbl_emailopening • • • emailopening table - If email openings are being used
tbl_consenttype • consenttype table
tbl_consent • • • consent table
fld_consenttype • consenttype field on consent table

5. Configuration

If you use person as recipient, continue with the configuration.

Otherwise, have a look at the instructions bellow.

The following step is only necessary to read if you are using another table than person as recipients,

Using the company table instead of the person table

If you want to use any type other than person as a mailing recipient you will need to add both read and write permissions for that table, e.g. company. If the import fields specify getting data from other tables than person you need to set read permissions on those affected as well (even if person is your mailing recipient).

Generally, every relation to the person table must be replaced with a relation to the company table instead. A few mandatory fields must also be added to the company table.

In LISA you must do the following:

  • On the consent card, create a relation to company.
  • On the participant card, create a relation to company.
  • On the company card you need to do a few things:
  • Create a relation (tab) to recipient.
  • Create the following fields:
    • email,
    • emailhardbounce
    • totaloptout - not needed if using the consent table
    • Choose which fields to use as replacement for firstname and lastname. companyname can be used on both.
  • On the recipient table, verify that the relation to company was properly created.