Configuration¶

This section describes how you configure Lime Survey. You need to configure Lime Survey in these places:

Runtime configuration
Web client views

Not familiar with configuration in Lime? Read more here.

Runtime configuration¶

The runtime configuration is configured in Lime Admin -> Addons -> Survey.

Tables and fields¶

Configure tables and fields for the integration.

Start by choosing the lime types for Survey, Formfield and Formresponse. The integration will now automatically suggest fields for the properties on each limetype. It can of course be changed if your database structure is different from the suggestions in the LIP package.

Enter the field name for which field holds the email address on the related limetype on formresponse. This will automatically attach the the related object to the form response if there is an email field in the formresponse data that matches a unique limetype with that email address. You can add more than one relation to the formresponse.

Multiple choice questions¶

Unlike other fields the checkbox field allow recipients to select multiple answers to a single question. This possibility requires special handling of the selected options and it can be configured in two ways in the addon. This setting is configured in Lime Admin.

1 - One response per selected option¶

The default behavior creates one form response per selected option for a checkbox field. It's suitable when it's important to be able to filter out certain option responses.

2 - One response for all selected options¶

This behavior concatenates the selected options(s) for a checkbox field into a single form response in Lime CRM. The option values are separated with a ','. This behavior somewhat limits the possibilities to filter out responses of certain options but has a cleaner presentation to the user.

Example config¶

Click here to open the config.

{
    "surveyLimetype": {
        "limetype": "survey",
        "propertyName": "name",
        "propertyDescription": "description",
        "propertyRegistrationUrl": "registration_url",
        "propertyBwSurveyId": "bw_surveyid",
        "propertyTotalRespondents": "total_respondents",
        "propertyFormfield": "formfield",
        "propertyFormresponse": "formresponse"        
    },
    "formfieldLimetype": {
        "limetype": "formfield",
        "propertyName": "name",
        "propertyLabel": "label",
        "propertyBwFormfieldId": "bw_formfieldid",
        "propertyFieldType": "field_type",
        "propertyDataType": "data_type",
        "propertyIsDeleted": "is_deleted",
        "propertySurvey": "survey",
        "propertyFormresponse": "formresponse"
    },
    "formresponseLimetype": {
        "limetype": "formresponse",
        "propertyBwFormresponseId": "bw_formresponseid",
        "propertyStrValue": "str_value",
        "propertyNumericValue": "numeric_value",
        "propertyResponseDate": "response_date",
        "propertyFormfield": "formfield",
        "propertySurvey": "survey",
        "propertyFormFieldId": "bw_formfieldid",
        "propertyDataType": "data_type",
        "relations": [
            {
              "emailField": "email",
              "relation": "person"
            }
        ],
        "multipleChoiceFormresponses": {
            "createFormresponsesForMultipleChoiceFields": true
        }
    }
}

Web client views¶

Survey¶

Import this JSON file as view configuration for the survey table.

Form Field¶

Import this JSON file as view configuration for the form field table.

Form Response¶

Import this JSON file as view configuration for the form response table.