Configuration¶
Web Client¶
In the parameter section of your action you can pass in parameters.
The parameters you can pass in are
**
parameter | type | required | comment |
---|---|---|---|
exclude | List | No | participantstatuses to exclude |
fullScreen | Boolean | Yes | true or false |
dividerParticipantList | Decimal | No | adjusts the height of the window |
queryLimit | Number | Yes | 0 = unlimited hits |
pageSize | Number | No | How many participants to show 'per page' in the dialog |
responseFormat | Dict | Yes | These are the limeproperties we fetch. _id is required (with alias) |
participantDescriptivePrimary | String | Yes | A string with merge codes to inject values. values you can inject need to be included in responseFormat |
participantDescriptiveSecondary | String | No | Same as above. |
The following config
{
"exclude": [
"decline",
"participated"
],
"fullScreen": false,
"dividerParticipantList": 2.5,
"queryLimit": 0,
"pageSize": 100,
"responseFormat": {
"object": {
"_id": {
"_alias": "idlimetype"
},
"name": "",
"email": "",
"postaladdress1": ""
}
},
"participantDescriptivePrimary": "%name% <%email%>",
"participantDescriptiveSecondary": "📍 %postaladdress1%"
}
...would result in:
...and the available participant statuses:
Desktop Client¶
Which limetypes can be added as participant is dictated in VBA: AO_AddToCampaign.OpenAddToCampaign.
If adding new allowed limetypes, they also have to be added as a relation to the participant card.
Autorelate¶
It is possible to configure so that specific relations automatically are added to the participant depending on which limetype the participant is created from.
Now works for both python and SQL!
- To user this automation, add the following to your application_comfig.yaml
In the above example, adding a contract as a participant would also add the contracts person and the persons company to the participant object. If creating a participant from a person, the persons company would also be added to the participant card.
NAME OF LIME APPLICATION: config: limepkg_add_to_campaign: sql: true autorelate: true relations: contract: "person.company" person: "company"