Statements fed from a service - FedStatements

Component displaying statements

Component properties

Eximee Designer property	Attribute name in the Source	Description
Grouping statements by required status (section Styling)	groupByRequired	Option for grouping statements by required and not required. If the option is selected, the master checkbox will be visible, and selecting it will affect selection of required statements. Default value 'false'. Statement sorting should be done on the service side.
Grouping all statements (section Styling)	groupAll	Option for grouping all statements. If the option is selected, the master checkbox will be visible, and selecting it will affect selection of all statements. Default value 'false'.
-	masterCheckboxDescriptionKey	Translation key containing the master checkbox label

Note! If both grouping options are selected: groupByRequired and groupAll, only the Grouping all statements option will be taken into account.

More information about component properties: Common component properties

The statements list is populated from the service. The service must expose one endpoint whose content is a JSON defining the structure of the statements. The JSON object here is an array of statements, where each statement is described by attributes:

Attribute	Description
id	unique statement identifier, which will be returned in the component value
content	statement content
description	optional statement description visible after expansion
required	statement requirement, false by default
showMoreTextLabel	optional attribute allowing overriding the text of the button expanding the statement description
showMoreInPopup	flag indicating whether the statement description should be shown in a popup instead of the default expansion, false by default

Service examples

Sample result of a service returning 4 statements:

[
    {
        "id": 1,
        "content": "required, no description Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
        "required": true
    },
    {
        "id": 3,
        "content": "required, with description Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
        "description": "Description 3 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
        "required": true
    },
    {
        "id": 5,
        "content": "optional, with description in popup Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
        "description": "Description 5 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
        "showMoreInPopup": true,
        "required": false
    },
    {
        "id": 10,
        "content": "link in title <a href=\"http://google.pl\" target=\"_blank\">Link</a>"
    }
]

Example of a script service returning configuration from the example above:

function callService(context) {

    const statements = [
        {
            "id": 1,
            "content": "required, no description Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
            "required": true
        },
        {
            "id": 3,
            "content": "required, with description Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
            "description": "Description 3 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
            "required": true
        },
        {
            "id": 5,
            "content": "optional, with description in popup Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
            "description": "Description 5 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
            "showMoreInPopup": true,
            "required": false
        },
        {
            "id": 10,
            "content": "link in title <a href=\"http://google.pl\" target=\"_blank\">Link</a>"
        }
    ];

    return [{ output: JSON.stringify(statements) }];
}

When the component is fed by a script service, the result passed to the parameter output should be a text containing JSON with the list of statements. You should not return the JavaScript array directly as output, e.g. output: statements.

Correct format: return [{ output: JSON.stringify(statements) }];

Platform translation keys

Key	Description	Default value
iew.rollable.roll	Button label for collapsing the additional statement description	Collapse
iew.fed.statements.content.toggle	Button label for expanding the additional statement description, or displaying a popup with this content	Expand

Demo request: demoFedStatements