Field Definition Derived Field Settings

These settings control the value stored in a Field in an object.

The software will automatically set the value depending on the setting used.

Note

All derived Fields are read only and cannot be edited by users.

Template Driven File Derived Field

Note

At the moment only Submission Data Definitions support this setting

This can only be applied to File fields. It allows you to select a Template that can be merged with an object from the current Data Definition. The output of the Template will be saved as a file, in the selected format, to the Field every time the object is saved. The data will be filtered for each object, so that the field will not contain any data from other objects.

Example

We have Submissions 0001 and 0002. We add this setting for a field and select a template where the data has a list of Submissions. When we normally generate a Report using this template it will have all the Submissions, so both 0001 and 0002 will be included. Using this setting, Submission 0001's field will have a file generated from the template with data that only includes Submission 0001.

Warning

It is your responsibility to ensure that the template does not include secondary data that those who have access to the object should not see, or such a field is hidden to anyone who should not have access to the information provided by the output of the template.
For example, a Submitter has access to their Submissions and you could have a template that includes the Reviews for the current Submission. Then the Submitters will be able to see the output of the template, regardless of it containing sensitive data from the Reviews.

Note

The merging with templates is only done when the owner object is saved, but not for changes to secondary data. Using the above example, when a Review is saved, the output of the template in Submission field, containing data from the Review, will not be regenerated.

Note

A file will be generated each time the object is saved or refreshed. Enable the Allow File Overwrite setting and set Range to maximum of 1 to only keep the latest version.

Note

The merging with templates is done as a background job, so after saving the object it might take a short while until the file is created.

Template Driven Derived Field

Note

At the moment only Submission Data Definitions support this setting

This can only be applied to text Fields. It allows you to select a Template that can be merged with an object from the current Data Definition. The output of the Template will be saved as the text value of the Field every time the object is saved. The data will be filtered for each object, so that the field will not contain any data from other objects.

The output will vary for each Data Type:

Data Type Changes to the output
Single Line Text HTML tags and line breaks removed
Single Line Rich Text No changes. Please ensure your template will be rendered as a single line
Multi Line Text HTML tags removed
Multi Line Rich Text No changes

Note

When HTML tags are removed we convert <br/> and remove everything else. Complex layouts, for example lists and tables, will be lost.

Note

For the best results when using this setting with non rich text fields please consider creating specific templates that contain no HTML.

Example

We have Submissions 0001 and 0002. We add this setting for a field and select a template where the data has a list of Submissions. When we normally generate a Report using this template it will have all the Submissions, so both 0001 and 0002 will be included. Using this setting, Submission 0001's field will have it's value generated from the template with data that only includes Submission 0001.

Warning

It is your responsibility to ensure that the template does not include secondary data that those who have access to the object should not see, or such a field is hidden to anyone who should not have access to the information provided by the output of the template.
For example, a Submitter has access to their Submissions and you could have a template that includes the Reviews for the current Submission. Then the Submitters will be able to see the output of the template, regardless of it containing sensitive data from the Reviews.

Note

The merging with templates is only done when the owner object is saved, but not for changes to secondary data. Using the above example, when a Review is saved, the output of the template in Submission field, containing data from the Review, will not be regenerated.

Note

The merging with templates is done as a background job, so after saving the object it might take a short while until the text is updated.

Comments