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 Lime CRM admin config for Automated Flows.
You should also add a relation to one or many related types on the automatedflowparticipant
table if you want the automatic population of property values to work. For example if you want the email property of a an automated flow to get its data from person.email there must exist a (1:n) relation between person
and automatedflowparticipant
.
automatedflow (Automated flow/Automatiserat flöde)
Field name |
Required |
Suggested local name(en/sv) |
Field type |
Description |
name |
x |
Name/Namn |
Text |
The name of the automated flow (256 characters) |
description |
x |
Description/Beskrivning |
Multi line text |
The description of the automated flow (512 characters) |
isrunning |
x |
Is started/Är startat |
Yes/No |
The status of the automated flow |
bw_automatedflowid |
x |
Flow Id |
Number |
The id of the automated flow in Lime Marketing (readonly/hide from user under admin) |
isdeleted |
x |
Is deleted/Är Borttaget |
Yes/No |
Is the flow deleted in Lime Marketing |
automatedflowproperty |
x |
Properties/Egenskaper |
relation (1:n automatedflow-automatedflowproperty) |
Relation to the automated flow property, an automated flow can have many properties |
automatedflowparticipantaction |
x |
None |
relation (1:n automatedflow-automatedflowparticipantaction) |
Relation to the automated flow participant action, an automated flow can have many participant actions (hidden) |
automatedflowparticipant |
x |
None |
relation (1:n automatedflow-automatedflowparticipant) |
Relation to the automated flow participant, an automated flow can have many participants |
automatedflowproperty (Flow property/Flödesegenskap)
Field name |
Required |
Suggested local name(en/sv) |
Field type |
Description |
automatedflow |
x |
|
relation: (1:n automatedflow-automatedflowproperty) |
Relation to the automated flow, an automated flow can have many properties |
bw_field |
x |
Field/Fält |
Text |
The property name from Lime Marketing (1024 chars, readonly) |
bw_propertyid |
x |
Property Id |
Number |
The id of the automated flow property in Lime Marketing (readonly/hide from user under admin) |
bw_fieldtype |
x |
Type/Typ |
Text |
The property type from Lime Marketing (1024 chars, readonly) |
bw_required |
x |
Required/Obligatoriskt |
Yes/No |
Is the property required (readonly) |
bw_unique |
x |
Unique/unik |
Yes/No |
Is the property part of the unique key (readonly) |
lime_field |
x |
Field to get data from/Fält att hämta data från |
Text |
The dot notated path to get data for the property ie person.company.name (1024 chars) |
hasvalidationerror |
x |
Has validation error/Har valideringsfel |
Yes/No |
Is the lime field set up correctly (readonly) |
validation_message |
x |
Type/Typ |
Multiline text |
Validation error are shown here for the lime field setting (1024 chars, readonly) |
automatedflowparticipantproperty |
x |
None |
relation (1:n automatedflowproperty-automatedflowparticipantproperty) |
Relation to the automated flow participant property, an automated flow property can have many participant properties (hidden) |
automatedflowparticipant (Flow participant/Flödesdeltagare)
Field name |
Required |
Suggested local name(en/sv) |
Field type |
Description |
automatedflow |
x |
Automated flow/Automatiserat flöde |
relation: (1:n automatedflow-automatedflowparticipant) |
Relation to the automated flow, an automated flow can have many participants |
bw_status |
x |
Status/Status |
Option |
The current status of the participant (readonly) spec |
isready |
x |
Execute the flow for the particpant/Exekvera flödet för deltagaren |
|
|
bw_nextstep |
x |
Next/current action/Nästa/nuvarande händelse |
Text |
The next action to be executed from Lime Marketing (1024 chars, readonly) |
bw_nextstep_time |
x |
Time for next action/Tidpunkt för nästa händelse |
Date and time with seconds |
When is the next action going to be reported from Lime Marketing (readonly) |
bw_automatedflowparticipantid |
x |
Participant Id/Deltagar Id |
Number |
The id of the participant in Lime Marketing (readonly/hide from user under admin) |
bw_validation_message |
x |
Error message/Felmeddelande |
Multiline text |
Errors when adding the particpant are shown here (1024 chars, readonly) |
automatedflowparticipantproperty |
x |
None |
relation (1:n automatedflowparticipant-automatedflowparticipantproperty) |
Relation to the automated flow participant property, an automated flow participant can have many participant properties |
automatedflowparticipantaction |
x |
None |
relation (1:n automatedflowparticipant-automatedflowparticipantaction) |
Relation to the automated flow participant action, an automated flow participant can have many participant actions |
linkclick |
|
Linkclick/Länkklick |
relation (1:n automatedflowparticipant-linkclick) |
Relation to linclick (Only add if using linkclick |
emailopening |
|
Email opening/E-postöppning |
relation (1:n automatedflowparticipant-emailopening) |
Relation to emailopening (Only add if using emailopening) |
automatedflowparticipantaction (Flow participant action/Flödesdeltagarhändelse)
Field name |
Required |
Suggested local name(en/sv) |
Field type |
Description |
automatedflow |
x |
Automated flow/Automatiserat flöde |
relation: (1:n automatedflow-automatedflowparticipantaction) |
Relation to the automated flow, an automated flow can have many actions (hidden) |
automatedflowparticipant |
x |
None |
relation (1:n automatedflowparticipant-automatedflowparticipantaction) |
Relation to the automated flow participant action, an automated flow participant can have many participant actions (hidden) |
bw_actionname |
x |
Name/Namn |
Text |
Name of the action executed in Lime Marketing (1024 chars, readonly) |
bw_actionid |
x |
Id |
Text |
Id of the action executed in Lime Marketing (40 chars, readonly) |
bw_actiondate |
x |
Date/Tidpunkt |
Date and time with seconds |
When was the action executed in Lime Marketing (readonly) |
bw_nextactiondate |
x |
Time for next action/Tidpunkt för nästa händelse |
Date and time with seconds |
When is the next action going to be executed from Lime Marketing (readonly) |
linkclick |
|
Linkclick/Länkklick |
relation (1:n automatedflowparticipantaction-linkclick) |
Relation to linclick (Only add if using linkclick |
emailopening |
|
Email opening/E-postöppning |
relation (1:n automatedflowparticipantaction-emailopening) |
Relation to emailopening (Only add if using emailopening) |
bw_actionstatus |
|
Action status |
option |
The status of the automatedflowparticipantaction (readonly) spec |
bw_actionstatusmessage |
|
Action status message |
Multiline text |
The status message will be shown here (1024 chars, readonly) |
automatedflowparticipantproperty (Flow participant value/Flödesdeltagarvärde)
Field name |
Required |
Suggested local name(en/sv) |
Field type |
Description |
automatedflowparticipant |
x |
None |
relation (1:n automatedflowparticipant-automatedflowparticipantproperty) |
Relation to the automated flow participant, an automated flow participant can have many participant properties |
automatedflowproperty |
x |
None |
relation (1:n automatedflowproperty-automatedflowparticipantproperty) |
Relation to the automated flow property, an automated flow property can have many participant properties |
value |
x |
Value/Värde |
Text |
The value for the particpant and a property (256 characters) |
automatedflowparticipant.bw_status
Key |
Suggested local name(en/sv) |
initialize |
Initialize/Initierar |
inprogress |
In progress/Pågående |
finished |
Finished/Klar |
failed |
Failed/Misslyckades |
optout |
Opt-out/Opt-out |
cancelled |
Cancelled/Avbruten |
automatedflowparticipantaction.bw_actionstatus
Key |
Suggested local name(en/sv) |
success |
Success/Exekverad |
fail |
Fail/Misslyckad |
Linkclick (Optional)
Field name |
Required |
Suggested local name(en/sv) |
Field type |
Description |
automatedflowparticipantaction |
x |
Flow participant action/Flödesdeltagarhändelse |
Relation(n:1 linkclick-automatedflowparticipantaction) |
Relation to automatedflowparticipantaction |
automatedflowparticipant |
|
Flow participant/Flödesdeltagare |
Relation(n:1 linkclick-automatedflowparticipant) |
Relation to automatedflowparticipant (Optional) |
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) |
You can add related fields that also exist as relations on automatedflowparticipant
. If the same relation exists and is set on the participant
it will also be set on the linkclick
. This is useful to get the person/company/etc relation automatically set so you get an overview of the link clicks on the person/company/etc card.
Emailopening (Optional)
Field name |
Required |
Suggested local name(en/sv) |
Field type |
Description |
automatedflowparticipantaction |
x |
Flow participant action/Flödesdeltagarhändelse |
Relation(n:1 emailopening-automatedflowparticipantaction) |
Relation to automatedflowparticipantaction |
automatedflowparticipant |
|
Flow participant/Flödesdeltagare |
Relation(n:1 emailopening-automatedflowparticipant) |
Relation to automatedflowparticipant (Optional) |
emailopeningtime |
x |
Opening time/Tid för öppning |
time |
the timestamp of the emailopening |
You can add related fields that also exist as relations on automatedflowparticipant
. If the same relation exists and is set on the particpant
it will also be set on the emailopening
. This is useful to get the person/company/etc relation automatically set so you get an overview of the email openings on the person/company/etc card.