Required structure
This is the standard structure that the integration expects and needs to function properly, however every table
and field name can be configured in the Newsletter admin config.
In order to get the consent flow working you must have the relations to the campaign and person tables.
If you do not want to use consents you can hide the consenttype
and consent
table, but they must still exist in your database.
You must also have at least one consent type created.
Mailing
Field name |
Required |
Suggested local name(en/sv) |
Field type |
Description |
subject |
x |
Subject/Titel |
Text field |
The subject from the mailing (1024 characters) |
campaign |
x |
Marketing activity/Marknadsaktivitet |
relation (1:n campaign-mailing) |
Relation to the campaign, a campaign can have many mailings |
statisticlink |
x |
Statistics link/Statistiklänk |
Link field |
Hidden field used to hold statistic link from Lime Marketing (1024 characters) |
sendoutlink |
x |
Sendout link/Utskickslänk |
Link field |
Hidden field used to hold send out link from Lime Marketing, i.e the actual layout of the mail sent (1024 characters) |
htmlstatisticlink |
x |
Statistics/Statistik |
HTML-tab |
SQL-expression: mailing.[statisticlink]. Displays the content of the statistic link |
htmlsendoutlink |
x |
Sendout/Utskick |
HTML-tab |
SQL-expression: mailing.[sendoutlink]. Displays the content of the send out link |
mailingid |
x |
Newsletter ID |
Text field |
The mailing id from Lime Marketing, should be hidden |
senddate |
x |
Sent/Skickat |
Date |
The date when the mailing was sent |
recipient |
x |
Mailing recipient/Utskicksmottagare |
relation (1:n mailing-recipient) |
Relation tab to the recipients, a mailing can have many recipients |
linkclick |
|
Relation(1:n mailing-linkclick) |
Relation to linkclick, a mailing can have many linkclicks (Only add if using linkclick) |
|
emailopening |
|
Relation(1:n mailing-emailopening) |
Relation to emailopening, a mailing can have many emailopenings (Only add if using emailopening) |
|
Recipient
Field name |
Required |
Suggested local name(en/sv) |
Field type |
Description |
person |
x |
Person |
relation: (1:n person-recipient) |
Relation to the person, a person can have many recipients |
mailing |
x |
Mailing/E-postutskick |
relation: (1:n mailing-recipient) |
Relation to the mailing, a mailing can have many recipients |
sendoutstatus |
x |
Sendout status/Utskicksstatus |
Option list(sent, open, clicked, bounce, optout) |
Used to set status for the mailing. must contain correct option keys |
Marketing activity(Campaign)
Field name |
Required |
Field type |
Description |
name |
x |
Text field |
Name of the marketing activity |
type |
|
Option list |
Used to filter out the kind of campaigns to see in Newsletter |
campaignstatus |
|
Option list |
Used to filter out the status of campaign to see in Newsletter |
participant |
x |
Relation(1:n campaign-participant) |
The participants that will get the sendout |
mailing |
x |
Relation(1:n campaign-mailing) |
The mailing sent in Newsletter |
consenttype |
|
Relation(n:1 campaign-consenttype) |
Send mail to persons with a consent of this type |
Person
Field name |
Required |
Field type |
Description |
email |
x |
Link field |
Email to person IMPORTANT |
totaloptout |
|
Checkbox |
Shows if the person has done an optout in Newsletter, if set the person will not be included when importing campaign participants |
emailhardbounce |
|
Checkbox |
Shows if the person has a hard bounce in Newsletter |
recipient |
x |
Relation(1:n person-recipient) |
Relation to recipient, a person can have many recipients |
consent |
|
Relation(1:n person-consent) |
Relation to consent, a person can have many consents. |
participant |
x |
Relation(1:n person-participant) |
Relation to participant, a person can have many participants |
linkclick |
|
Relation(1:n person-linkclick) |
Relation to linkclick, a person can have many linkclicks (Only add if using linkclick) |
emailopening |
|
Relation(1:n person-emailopening) |
Relation to emailopening, a person can have many emailopenings (Only add if using emailopening) |
Participant
Field name |
Required |
Field type |
Description |
person |
x |
Relation(1:n person-participant) |
Relation to person(Can be changed to something else e.g Company) |
campaign |
x |
Relation(1:n campaign-participant) |
Relation to campaign |
Consenttype (Optional)
Field name |
Required |
Field type |
Description |
title |
x |
Text field |
Name of the consenttype |
consent |
x |
Relation(1:n consenttype-consent) |
Relation to consent |
campaign |
x |
Relation(1:n consenttype-campaign) |
Relation to campaign |
Consent (Optional)
Field name |
Required |
Field type |
Description |
person |
x |
Relation(n:1 consent-person) |
Relation to person |
consenttype |
x |
Relation(n:1 consent-consenttype) |
Relation to consenttype |
approved |
x |
checkbox |
Approved consent equals a Newsletter opt-in |
source |
x |
Option list |
Where did the consent come from |
Linkclick (Optional)
Field name |
Required |
Suggested local name(en/sv) |
Field type |
Description |
person |
x |
Person/Person |
Relation(n:1 linkclick-person) |
Relation to person (or other table connected to recipients) |
mailing |
x |
Mailing/Utskick |
Relation(n:1 linkclick-mailing) |
Relation to mailing |
linkname |
x |
Name/Namn |
string |
Name of the link (1024 characters) |
linkurl |
x |
URL/URL |
string |
the URL of the link (1024 characters) |
linkvalue |
x |
Value/Värde |
integer |
the value of the link |
linkclicktime |
x |
Click time/Tid för länkklick |
time |
the timestamp of the link click |
linkcategoryid |
x |
|
integer |
id of the link category (Should be hidden) |
linkcategoryname |
x |
Category/Kategori |
string |
name of the link category (1024 characters) |
Emailopening (Optional)
Field name |
Required |
Suggested local name(en/sv) |
Field type |
Description |
person |
x |
Person/Person |
Relation(n:1 emailopening-person) |
Relation to person (or other table connected to recipients) |
mailing |
x |
Mailing/Utskick |
Relation(n:1 emailopening-mailing) |
Relation to person (or other table connected to recipients) |
emailopeningtime |
x |
Opening time/Tid för öppning |
time |
the timestamp of the emailopening |