

Example Lime Admin Config

JSON

{
  "default": {
    "enabled": true,
    "configversion": 2,
    "consentsource": "newsletter",
    "consenttypemapping": {
      "consenttypemappings": [
        {
          "consenttype": 1001,
          "publications": [
            { "publication": 10 }
          ]
        },
        {
          "consenttype": 1002,
          "publications": [
            { "publication": 20 },
            { "publication": 30 }
          ]
        }
      ]
    },
    "optinsettings": {
        "enabled": true,
        "create_duplicates": false,
        "publications": [123, 256],
        "limetypesetting": {
            "name": "person",
            "email_field_name": "email",
            "fieldmappings": {
                "email": "email",
                "firstname": "firstname",
                "lastname": "lastname"
            }
        }
    },
    "linkclickenabled": true,
    "emailopeningenabled": true,
    "getrecipientsenabled": true,
    "objectcontent": [{
        "queryname": "coworker_query",
        "query": {
            "limetype": "coworker",
            "responseFormat": {
                "object": {
                    "_id": {
                        "_alias": "coworkerid"
                    },
                    "firstname": null,
                    "lastname": null,
                    "email": null,
                    "office": {
                        "visitingaddress1": null
                    }
                    }
            },
            "filter": {
                "op": "=",
                "key": "_id",
                "exp": "{0}"
            }
          }
        },
        {
        "queryname": "deals_query",
        "query": {
            "limetype": "deal",
            "responseFormat": {
                "object": {
                    "_id": {
                        "_alias": "dealid"
                    },
                    "name": null,
                    "value": null,
                    "coworker":{
                        "_id": {
                            "_alias": "coworkerid"
                        },
                        "firstname": null,
                        "lastname": null
                    },
                    "company":{
                        "name": null
                    }
                    }
            },
            "filter": {
                "op": "=",
                "key": "coworker._id",
                "exp": "{0}"
            }
          }
        }],
    "tables": {
      "campaign": {
        "name": "campaign",
        "campaigntypes": [
          {
            "type": "email"
          }
        ],
        "campaignstatuses": [
          {
            "status": "planned"
          },
          {
            "status": "ongoing"
          }
        ],
        "properties": {
          "campaignstatus": "campaignstatus",
          "consenttype": "consenttype",
          "mailing": "mailing",
          "name": "name",
          "participant": "participant",
          "type": "type"
        }
      },
      "consent": {
        "name": "consent",
        "properties": {
          "approved": "approved",
          "consenttype": "consenttype",
          "date": "date",
          "person": "person",
          "source": "source"
        }
      },
      "mailing": {
        "name": "mailing",
        "properties": {
          "mailingid": "mailingid",
          "subject": "subject",
          "campaign": "campaign",
          "recipient": "recipient",
          "senddate": "senddate",
          "sendoutlink": "sendoutlink",
          "statisticlink": "statisticlink"
        }
      },
      "linkclick": {
        "name": "linkclick",
        "properties": {
            "person": "person",  
            "mailing": "mailing", 
            "linkname": "linkname",
            "linkurl": "linkurl",
            "linkvalue": "linkvalue",
            "linkclicktime": "linkclicktime",
            "linkcategoryid": "linkcategoryid",
            "linkcategoryname": "linkcategoryname"
        }
      },
      "participant": {
        "name": "participant",
        "properties": {
          "campaign": "campaign",
          "person": "person"
        },
        "importfields": {
          "person": {
            "_id": null,
            "firstname": null,
            "lastname": null,
            "email": null,
            "company": {
              "name": null
            }
          }
        }
      },
      "person": {
        "name": "person",
        "properties": {
          "email": "email",
          "recipient": "recipient",
          "emailhardbounce": "emailhardbounce",
          "totaloptout": "totaloptout"
        }
      },
      "recipient": {
        "name": "recipient",
        "options": {
          "sendoutstatus": {
            "bounce": "bounce",
            "clicked": "clicked",
            "open": "open",
            "sent": "sent",
            "optout": "optout"
          }
        },
        "properties": {
          "mailing": "mailing",
          "person": "person",
          "sendoutstatus": "sendoutstatus"
        }
      },
      "emailopening": {
        "name": "emailopening",
        "properties":{
          "mailing": "mailing",
          "person": "person",
          "emailopeningtime": "emailopeningtime"
        }
      }
    }
  }
}

YAML

default:
    enabled: true
    configversion: 2
    consentsource: newsletter
    consenttypemapping:
        consenttypemappings:
        - consenttype: 1001
          publications:
          - publication: 10
        - consenttype: 1002
          publications:
          - publication: 20
          - publication: 30
    tables:
        campaign:
            name: campaign
            campaigntypes: # optional
            - type: email
            campaignstatuses: # optional
            - status: planned
            - status: ongoing
            properties:
                campaignstatus: campaignstatus
                consenttype: consenttype  # optional
                mailing: mailing
                name: name
                participant: participant
                type: type
        consent:
            name: consent
            properties:
                approved: approved
                consenttype: consenttype
                date: date
                person: person
                source: source
        mailing:
            name: mailing
            properties:
                mailingid: mailingid
                subject: subject
                campaign: campaign
                recipient: recipient
                senddate: senddate
                sendoutlink: sendoutlink
                statisticlink: statisticlink
        participant:
            name: participant
            properties:
                campaign: campaign
                person: person
            importfields: # modify this for your solution
                person:
                    _id: null
                    firstname: null
                    lastname: null
                    email: null
                    company:
                        name: null
        person:
            name: person
            properties:
                email: email
                recipient: recipient
                emailhardbounce: emailhardbounce # optional
                totaloptout: totaloptout # optional
        recipient:
            name: recipient
            options:
                sendoutstatus:
                    bounce: bounce
                    clicked: clicked
                    open: open
                    sent: sent
                    optout: optout
            properties:
                mailing: mailing
                person: person
                sendoutstatus: sendoutstatus