Configuration¶

1. Configuration in Lime Admin¶

Open Lime admin -> Add-ons/Settings -> Newsletter -> Config Instance from the webclient.

newsletter-config-start

If you are ugrading from an older version of newsletter to newsletter 3.0 or later: try to save the config and fix possible errors.

If you are setting up a new customer:

Click Add item
Insert an unique Config instance name (It can be left as default for most cases)
Check Integration is enabled
Insert your Consent source. This needs to be one of the keys from the consent.source option field, if you installed the consent lip-package it should be newsletter.
Click Save
Set up the Required limetypes by selecting the corresponding limetypes for each limetype setting (Participant, Campaign, Person, Mailing and Recipient). Now the add-on will suggest properties for each limetype, change any properties that differs from the customer database and the lip-package.
Add your importfields under Participant limetype settings. This is the data that will be synced from participants in lime-crm to recipients in lime-marketing. Id and email are required for the integration to work but you can add how many fields you want. Remember that the property path starts from the participant object so to add the participant's person's company name you write person.company.name.
If you want to filter on which campaigns will be selectable from lime-marketing you can add campaign types and campaign statues under Campaign limetype settings.
Set up the Optional Limetypes (consent, linkclick and emailopening) if any of these tables should be used. Remember that linkclickenabled and emailopeningenabled must be activated to be able to use linkclick and emailopenings.
Set up Consenttype mapping by mapping consenttypes to Lime Marketing publication id's.
Optional: Set up Object content
Optional: Set up Optin settings
Save the config

It is possible to edit the config in the JSON view if you click show code editor.

An example of what a valid config may look like can be found HERE. Note: this code includes examples that you need to remove.

Before you proceed

Can you save the config?
Have you changed to config instance name from default? (Only do so if you haven't followed the default setup and if it's really necessary) In that case you need that name in the next step.

2. Set up cards and views in Lime Web client¶

This step is only necessary if Newsletter is supposed to be used from the Lime CRM Web Client.

Configure the views and cards for all tables added by the LIP package installation.

If you have the default setup you can copy the views found HERE. Then go to each card and switch to code view and paste it there.

Also show:

mailing as a relation on the campaign card.
consenttype as a field on the campaign card and table view.
total opt-out as a field on the person card and table view.
emailhardbounce as a field on the person card and table view.
recipient as a relation on the person card.
consent as a relation on the person card.
linkclick as a relation on the person card. Only if they are going to use the link click feature.
emailopening as a relation on the person card. Only if they are going to use the email opening feature.

2 - Add the integration in Lime Marketing¶

Log in to your Lime Marketing site and go to Administration -> Integrations and add a Lime CRM integration from the button in the top left corner.

Enter the URL to newsletter -> application webclient base URL + /newsletter.

The base URL is the webclient url/application name. Its the same URL as you find in the API docs up until/api.

Enter the API-key for the integration to use.

The Configuration page will look like this with quite a few validation errors and warnings. This is OK, fix the warnings by filling out the required information and click validate at the top left corner. It's really important that you get the URL and API key correct - we won't be able to give you any hints until it's correct.

Leave the configuration name empty unless you have changed the config name from default in Lime admin.

config_bizzan_1

The column settings are specified in the Lime CRM Admin config under importfields. All you need to do now is to map them to properties on the Newsletter recipient. The required ones are email and an id for the person in Lime CRM.

config_bizzan_2

Lastly you will be able to see your consent mappings from the Lime CRM Admin config listed here.

config_bizzan_3

6 - Verify¶

If everything is validating and no more errors are displayed you are ready to verify.

Create a test marketing activity in Lime CRM.
Add yourself as a participant.
Create a mail message in Lime Marketing.
Import the participant list from the marketing activity you just made in Lime CRM.
Send the email.
Open the email and click on some links.
Follow up the link clicks and email opening in Lime (if you have that configured)

7. Design customer templates¶

If everything works, you are done with the configuration. Now it's time to:

design the customer email template
edit the publication settings
configure the sending domain.

Follow the Newsletter Delivery instructions HERE. For Lime empolyees only.

If tables and fields don't follow default setup¶

The following steps are only necessary if the database does not follow the default setup or if you are using another table than person as recipients.

Things you need to change
- Tables and fields if they don't follow the default setup. All table names and fields are validated when saving the config so if there are any errors you'll be notified. newsletter-company-person

Using the company table instead of the person table¶

These fields needs to be changed to company instead of person in the config:

consent.person
participant.person
person.limetype
recipient.person

Sending newsletters to multiple Lime Objects¶

It's possible to have several configurations, for cases when you have an additional setup of tables, for example if you want to do send-outs to companies in addition to the standard persons.

The standard configuration is called default per default.

To have more than one configuration simply click Add item under Config instance in the left hand menu and set up the configuration following the steps above for setting up a new customer

Example Lime Admin Configuration¶

Here you have an example Lime Admin config that you can copy. It includes examples that you need to change for your configuration. Further down you also have default configuration for the tables and views for the tables added by the LIP-package. (Only necessary if newsletter is supposed to be used from the webclient).

{
    "name": "default",
    "enabled": true,
    "getrecipientsenabled": false,
    "consentsource": "newsletter",
    "required_limetypes": {
      "participant": {
        "person": "person",
        "campaign": "campaign",
        "importfields": [
          {
            "path": "person._id"
          },
          {
            "path": "person.email"
          }
        ],
        "limetype": "participant"
      },
      "campaign": {
        "name": "name",
        "participant": "participant",
        "mailing": "mailing",
        "campaignstatus": "campaignstatus",
        "type": "type",
        "campaigntypes": [],
        "campaignstatuses": [],
        "limetype": "campaign",
        "consenttype": "consenttype"
      },
      "person": {
        "email": "email",
        "recipient": "recipient",
        "limetype": "person"
      },
      "mailing": {
        "subject": "subject",
        "campaign": "campaign",
        "statisticlink": "statisticlink",
        "sendoutlink": "sendoutlink",
        "mailingid": "mailingid",
        "senddate": "senddate",
        "recipient": "recipient",
        "limetype": "mailing"
      },
      "recipient": {
        "person": "person",
        "mailing": "mailing",
        "sendoutstatus": "sendoutstatus",
        "limetype": "recipient"
      }
    },
    "optional_limetypes": {
      "linkclickenabled": false,
      "emailopeningenabled": false,
      "consent": {
        "approved": "approved",
        "source": "source",
        "date": "date",
        "consenttype": "consenttype",
        "person": "person",
        "limetype": "consent"
      },
      "linkclick": {},
      "emailopening": {}
    },
    "consenttypemapping": {
      "consenttypemappings": [
        {
          "publications": [
            {
              "publication": 1
            }
          ],
          "consenttype": 1001
        }
      ]
    }
  }

Click here to open the example config