Configuration

Lime Inform Configuration

From Name on Emails

Configured in Lime Inform, can be configured for each sendlist.

Information

From Address on Emails

The from address is not possible to configure.

Lime CRM Configuration

This section describes how you configure Lime Inform. You need to configure Lime Inform in Lime Admin:

• Participant configuration
• Campaign configuration
• Create note config
• Complete config

Participant Config

• campaign is the main object that is displayed in Lime Inform as Campaign
• participant is the object that is displayed in Lime Inform as Recipient

Config title	Description
Campaign limetype	The limetype that represents the main object. (limetype)
Contact object path	The path from the campaign limetype to the location where contact information can be found. (relation_participant_object)
Contact limetype	The limetype that represents the object for contact information. Required to set fields for contact information. (participant_limetype)
Contact properties
Mobilephone field	Field that contains mobile phone, can be empty.
Phone field	Field for phone. Can be the same as mobilephone field.
Email field	Field for email.
Description field	Field for description. Usually set to name.

Example of lime-admin config to retrieving participants

{
    "participant_properties": {
        "mobilephone": "mobilephone",
        "phone": "phone",
        "email": "email",
        "description": "name",
    },
    "participant_filter": {},
    "campaign_limetype": "campaign",
    "relation_participant_object": "participant.person",
    "participant_limetype": "person"
}

Campaign config

Config title	Description
Campaign object	The limetype that represents the campaign object.
Title field	The limeproperty that gets displayed as title in Lime Inform.
Limeproperty used for filtering campaigns	Limeproperty of type option that is used if we need to filter campaigns sent to Lime Inform
Included types	Select the options that are available from Lime Inform.

Example of lime-admin config to retrieving campaigns

{
    "campaign_properties": {"title": "name"},
    "campaign_filter": {},
    "campaign_limetype": "campaign"
}

Create note config

Config title	Description
Provider	Type of notification (Text message or Email message).
Notification limetype	The limetype that represents the notification.
Notification field	Limeproperty of the notification limetype that represents the note field.
Relation notificatoin - participant limetype*	Relation from notification limetype to participant limetype (Contact limetype).
Default message for notification	Default text that will be used if no text is provided from Lime Inform
Note type property	Limeproperty of the notification limetype that represents an option field.
Note type property	Limeproperty of the notification limetype that represents an option field.

Example of lime-admin config to create notes

{
  "smsmessage": {
        "note_type_field": {
            "type_option": {"type": "comment"},
            "option": "type",
        },
        "limetypeNotification": "history",
        "notificationField": "note",
        "note": "Inform sendout",
    },
    "emailmessage": {
        "note_type_field": {
            "type_option": {"type": "comment"},
            "option": "type",
        },
        "limetypeNotification": "history",
        "notificationField": "note",
        "note": "Inform sendout",
    },
    "participant_limetype": "person",
}

Complete config

{
  "campaign_text": {},
  "campaign_properties": {
    "title": "name"
  },
  "campaign_filter": {
    "key": "status",
    "op": "=",
    "exp" "ongoing"
  },
  "text": {},
  "participant_text": {},
  "participant_properties": {
    "mobilephone": "mobilephone",
    "phone": "phone",
    "email": "email",
    "description": "name"
  },
  "participant_filter": {},
  "smsmessage": {
    "note_type_field": {
      "type_option": {
        "type": "comment"
      },
      "option": "type"
    },
    "limetypeNotification": "history",
    "notificationField": "note",
    "note": "Postback from Inform"
  },
  "emailmessage": {
    "note_type_field": {
      "type_option": {
        "type": "comment"
      },
      "option": "type"
    },
    "limetypeNotification": "history",
    "notificationField": "note",
    "note": "Postback from Inform"
  },
  "campaign_limetype": "campaign",
  "relation_participant_object": "participant.person",
  "participant_limetype": "person"
}