On this page:
CONFIGURABLE ATTRIBUTES & SPECIAL FEATURES
Configurable Attributes
Configurable attributes are used to configure each Form Field to suit specific requirements. Some are unique to each individual Field while many are shared across multiple Form Fields.
To configure Form Field attributes, from the Form Edit page:
- Select the required Form Field as per instruction above
- Use the Edit Field screen on the left to configure the attribute as required (Refer to Definition of Configurable Attributes below)
Definition of Fields: Configurable Attributes
Most Configurable Attribute functionality is covered in the videos in the Definitions of Fields: Form Fields table on the Form Records page of this User Guide. Therefore only those items not covered previously are viewable here.
Configurable Attribute | Form Field | Definition |
---|---|---|
Reference ID | Multiple | Used to track which column corresponds to which field in the Form. Useful for repeated Fields or where fields have the same or similar labels such as 'Description' and long Forms are utilised. When used, the Reference ID will display in brackets the Form Records page as part of the field label as well as on Excel Reports. Note: Column Configuration may need to be adjusted for relevant fields to display. Refer to the Column Configuration section on the Introduction page of this User Guide for more details. |
Details | Multiple | Provide a label/ title for the field and additional instructions for Respondents if required. |
Required | Multiple | Select if the field is to be set to mandatory. Respondents will be able to save Form progress, but the Form Record status will remain on 'In Progress' until all mandatory fields are completed. |
Conditionally Display | Multiple | Checkbox, Radio Buttons and Dropdown Form Fields can be used to Conditionally Display the Form Field in the question directly following it (not available for use in Tables) For example, if 'other' is an option, an additional text field can be created so the Respondent must provide further detail. The text field will only be displayed if 'other' is selected. See the Conditionally Display section on this page of the User Guide for more details. |
Include Scoring | Dropdown Radio Button | Select if scoring is to be applied to the question. See the Scoring section on this page of the User Guide for more details. |
Editing Tools | Info | Information boxes allow for simple editing of text, as well as the insertion of tables and hyperlinks. |
Options | Dropdown Radio Button Checkbox | Populate all responses to be displayed in the Dropdown, Radio Button or Checkbox list. Click 'Add Option' to add more options and click the - to remove an option. |
Display Full Width | Table Grid | By selecting 'Display full width' the title/ label of the Table or Grid will display above the table. Note: if the Form is likely to be used on a mobile device, it is recommended to select this option to ensure it displays correctly. |
Header Label/ Background Colour | Form Fields within a Table | Use to adjust the text and background colour for Form Fields within Tables. |
Number of Columns/ Rows | Grid | Adjust the number of columns and rows to be applied to a Grid. |
Default to Current Date | Date | Select to have the current date automatically displayed. Respondents can adjust if required. |
Default to Current Time | Time | Select to have the current time automatically displayed. Respondents can adjust if required. |
Number of Options per Row | Radio Button | Adjust number to change display of Radio Button options. |
Populate From | Text Paragraph | Select to have data auto populated for the Respondent. Works together with the Data Source Form Field. See the Auto Population of Data section on this page of the User Guide for more details. |
Data Source | Data Source | Select the Data Source the Form is to gather data from. Asset Data Source When using Lucidity Asset as a Data Source, only selected Assets will appear in the selection list when completing the Form. In order to have particular Assets appear in the list, they must be of an Asset Type that has been specifically flagged to be included in the list displayed. For details on how to flag Asset Types, refer to the Settings page in the Lucidity Asset User Guide. See the Auto Population of Data section on this page of the User Guide for more details. |
Display | Data Source | Select which field from the Data Source is to be displayed. See the Auto Population of Data section on this page of the User Guide for more details. |
Apply a Filter? | Data Source | Select if Filters are to be applied to the Data Source displayed. See the Auto Population of Data section on this page of the User Guide for more details. |
Whole Numbers only? | Number | Select if only whole numbers (no decimals) are allowed for Numbers. |
Minimum / Maximum | Number | |
Display Column Total | Number Table | Select if the Number fields in the column of the Table are to be summed up and displayed. See Definitions of Fields: Edit Table - Table Column Total on this page of the User Guide for more details. |
Total | Number Table | Select if the Number fields in the row of the Table are to be summed up or multiplied. See Definitions of Fields: Edit Table - Table Row Totals & Multiply on this page of the User Guide for more details. |
Additional Fields
The ability to add an Action and/ or and Attachment to a Form will automatically appear once the form is Published. These will display to the Respondent in the 'Additional' section at the bottom of the Form.
Auto Population of Data
The Data Source field can be used to populate additional information automatically from the original source.
In order for this feature to work, the following two Form Fields are required:
- Data source
- Text
For example, Respondents may be required to select a Contracting Company, using Lucidity Contractor as the Data Source. Once selected, the Company's ABN (assuming this field is populated in Lucidity Contractor) could be set to automatically populate. (Note that if Lucidity Contractor is not available, Company Names can be modified via the Settings tab in Lucidity Access.)
To set the auto population of data, from the Edit Form page:
- Add Data Source as a new field to the Form
- Add Reference ID, Details and select 'Required' if applicable
- Refer to Definitions of Fields: Configurable Attributes on this page of the User Guide for more details
- Adding additional instructions for the Respondent will assist them populating the fields
- Select the relevant Data Source from the drop-down list
- In this example, Company has been selected
- In this example, Company has been selected
- Select the Field to be displayed from the drop-down list
- Note this will adjust dependant on the Data Source selected
- In this example, Name has been selected
- Some Data Source fields allow for a Filter to be applied. This means only criteria meeting the filter will be available for selection. If a Filter is required:
- Select 'Apply a Filter'
- Select the Filter required
- Tick which criteria must be met
- In this example, Company names will only be available for selection if their Company Status = Approved
- Add Text as a new field to the Form
- Add Reference ID, Details and select 'Required' as applicable
- Note: Required must be selected for this functionality to work
- Adding additional instructions for the Respondent will assist them populating the fields
- Select the 'Populate From' source
- All existing Data Sources in the Form will be available
- In this example Form, 3 Data Sources already exist for Employee Reporting Incident, as well as 1 each for Manager/ Supervisor and Contracting Company
- Contracting Company has been selected
- Select the relevant field in the second Populate From drop down
- This will relate to the initial selection
- In this example, as Contracting Company was selected initially, all fields relating to Company in Lucidity Contractor will be available. If 'Employee Reporting Incident' had been selected, all Employee fields in Lucidity HR would be available.
- ABN/ ACN has been selected
- Additional Text fields can be added if required to populate more information from the Data Source.
- In the example above, the Company's phone number and/ or email could be added
Conditional Display
Checkbox, Radio Buttons and Dropdown Form Fields can be used to Conditionally Display the Form Field in the question directly following it.
For example, if 'other' is an option, an additional text field can be created so the Respondent must provide further detail. The text field will only be displayed if 'other' is selected.
To set a field to Conditionally Display, from the Edit Form page:
- Add Checkbox, Radio Button or Dropdown as a new field to the Form
- In this example, Dropdown has been selected
- In this example, Dropdown has been selected
- Add Reference ID, Details and select 'Required' as applicable
- Refer to Definitions of Fields: Configurable Attributes on this page of the User Guide for more details
- Adding additional instructions for the Respondent will assist them populating the fields
- Add Options as required
- In this example, leave types have been listed
- Note the addition of 'Other' as an option. This will be used for the Conditional Display
- Add a new field to the Form
- In this example, Text has been selected
- Note there are multiple fields that allow for Conditional Display
- Add Reference ID, Details and select 'Required' as applicable
- Note required must be selected for this functionality to work
- Adding additional instructions for the Respondent will assist them populating the fields
- Select the Dropdown list for Conditional Display
- All existing Checkbox, Radio Button and Dropdown Fields in the Form will be available
- In this example Form, Leave Type has been selected
- Tick the Fields that will force the Conditional Display to open
- In this example, Other has been selected. This means this Text field will ONLY be displayed to the Respondent if they select a Leave Type of 'Other'
- Note more than 1 option can be selected
- The Conditional Display has now been applied, denoted by a visual indicator to the Administrator
Conditional Display
Multiple Conditional Displays can be added to build upon each other if required.
For example, when answering a question regarding Leave Type, the following workflow could be applied using Conditional Display.
Considerations:
- Conditional Display fields WILL NOT appear when viewing a Preview of a Form. In order to view, the Form must first be Published, and then accessed from the Form Records tab
- The Conditional Display feature is NOT available for use in Grids or Tables
Scoring
Scores will only be displayed on Forms that have scoring configured. There are two types of scoring configurations that can be applied from the Form Admin Page:
Entire Form | The total potential score is calculated by adding the maximum possible score for each Form Field within the Form that has scoring applied. The score is then the result for all selections made divided by the maximum possible score. Elements that have scoring but there was no selection are treated as '0' and contribute to the overall score. i.e. score will be based on every question where a score is applied, even if an answer is not provided. |
Responses Submitted | The total potential score is calculated by adding the maximum possible score for each element for which a selection has been made. The score is then the result for those selections, divided by the maximum possible for those Form Fields only. i.e. score will be based on every question where a score is applied, only if an answer is provided. |
Two Form Fields can have Scoring abilities:
- Dropdown
- Radio Button
Scoring is enabled by ticking 'Include Scoring' in the Form Edit screen.
In the example below, when Excellent is selected by a Respondent, a score of 5 will be applied. When Very Good is selected, a score of 4 is applied and so-on.
Scoring is calculated and displayed as a percentage and can be viewed on the screen as a Form is being completed, from the list of Records and from Excel Reports.
Scoring Weight
The total potential score is calculated by adding the maximum possible score for each Form Field within the Form where scoring is applied. For example, if there are three Form Fields within the Form that have scoring applied, and they each have a maximum possible score of 5, then the total possible score is 15. Each Form Field has equal weighting.
It is also possible to have unevenly weighted questions if required. This means the maximum scores for Form Fields can be different. For example, there may be three Form Fields within the Form that have scoring applied, and the maximum possible score is 5,5 and 10. In this scenario, the total possible score is 20. However, the Form Field that has the maximum of 10 will contribute 50% of the score outcome.