Compliance - Form Gadgets

Overview

When creating a Template you have the option to add a number of form template gadgets to your form. These gadgets can be used to add a number of different types of collection tools within your template along with formatting and progressive display so you can add logic behind the information displayed to the user.  For more information on Progressive Disclosure please see the Compliance Cross Module - Form Gadgets / Progressive Disclosure article.

General Gadgets

Upon clicking the +Add Item option when editing/creating your template will provide a number of gadget options that you can select and add to your form template.  Some of these gadgets are general to all Core form modules, whereas, others are specific to Protocols. Below outlines the types of gadgets that can be added and the available options within each.

Section

Creates a labeled frame in your form where you can collect gadgets to help organize your form. 

Gadget Specific Settings: Only the Field Label displays in the Section gadget.  Field Long Label and Field Help do not display on the Section gadget. In Protocols fields included in a section do not have to be answered before the form is submitted for review or finalized. If you are building a form in a different Kuali Application this gadget may not impact if content is required.

If you uncheck the Show Wrapper option you can change the section to display as a heading within another section. This also creates an <h> hierarchy for use with accessibility software.

If you uncheck the Show Wrapper and Field Label Display on Form options you can create a completely invisible section. The gadgets within the section will display, but will not appear as though they are embedded in a section gadget. This allows users to setup progressive display rules that apply across several gadgets to streamline the configuration process. This also allows user to setup Progressive Display rules that include both Any and All logic.

Example: A protocol includes a question asking if there are children included in the research.  If the user answers yes then 12 followup questions display. Instead of setting up logic to check if children are included in the research on all 12 questions the logic is added to the Group gadget and all the questions about minor participants are added to the group.

Within the child questions there are several questions used to determine if a waiver of parental consent is appropriate. A question asking for justification of parental consent should display if ANY of these questions are answered yes AND if the child question is answered yes.  Since the child question logic is contained in the Group, the justification question only needs to check the waiver qualification questions.

Read Only Text

Allows you to add a block of read-only text. This can be used for instructional purposes to provide necessary information to the user. This gadget is often configured with Progressive Disclosure.

Horizontal Rule

This displays a block of read-only text with a horizontal line as a divider allowing the user to group gadgets visually within a section.

Text Input

Allows the user to enter free text in a single line format.

Gadget Specific Settings: Placeholder will display grey example text to display prior to inputting text.

Text Area

Allows the user to enter multiple lines of free text. The text area will expand vertically if needed based on the number of lines entered in the gadget when completing the form.

Gadget Specific Settings: Placeholder will display grey example text to display prior to inputting text.

Rich Text

Allows the user to enter rich text with with multiple lines. This gadget provides the user more formatting options including alignment, hyperlinks, font, bulleted and numbered lists, etc.  The text area will expand vertically if needed based on the number of lines entered in the gadget when completing the form.

Check Boxes

Checkbox gadgets display a number of predefined answers that a user must select from to answer the question. This gadget allows a user to select multiple answers.  It can also be configured to only have one answer if a required certification statement is needed.

Gadget Specific Settings: You can enter a number of answers that will display as options for the user to select. Progressive display referencing this gadget will look for the answer in a specific location in this configuration.  So answers can be revised without impacting progressive display. If they are reordered progressive display based on this gadget needs to be updated.

Radio Buttons

Radio button gadgets display a number of predefined answers that a user must select from to answer the question. This gadget only accepts a single answer 

Gadget Specific Settings: You can enter a number of answers that will display as options for the user to select. Progressive display referencing this gadget will look for the answer in a specific location in this configuration.  So answers can be revised without impacting progressive display, but if they are reordered progressive display based on this gadget needs to be updated.

Drop Down

This gadget provides an alternative to Radio Buttons. The user is presented with a number of pre-configured answers and can only select one answer. This gadget is useful when there is a large number of possible answers, and you don't want to take up a large amount of screen space.

Gadget Specific Settings: You can enter a number of answers that will display as options for the user to select. Progressive display referencing this gadget will look for the answer in a specific location in this configuration.  So answers can be revised without impacting progressive display, but if they are reordered progressive display based on this gadget needs to be updated.

Filtered Dropdown

Creates a drop down with options that are filtered based on responses to another gadget in the template. A Filtered Dropdown can be based on responses in a Dropdown gadget or a Radio Button gadget. If present in the main form it can only reference elements within the overall form but if it is in a list it can only reference items within the same list.

Example: Your institution's IRB form includes a list of Personal Health Information (PHI) sources. The first field in the list is a dropdown indicating if the source of PHI is within your university, or external. The second field is a filtered dropdown list.  If the user indicates the PHI Source is internal to the university the filtered dropdown lists several likely sources within the university, such as medical centers in the medical, dental, and nursing schools, and an Other option. If the user selects external in the first dropdown list then a number of options display indicating likely external sources such as "Biological Sample", "Mental Health Records", etc. and an Other option.

Gadget Specific Settings: The user can select the dropdown, or radio button gadget they want to base their display on. Once that gadget is selected each valid answer in the referenced gadget will display with an +Add Item button below it. The user can add the items that should display if the associated option is selected in the linked gadget. If an option should be available for more than one answer from the linked gadget it needs to be added under each selection.

Date Picker

This will present the user with a date field, and give them a date picker interface to select a date.  The date selector will allow the user to jump to a specific year, and then navigate been months in their selected year. When they first open the date picker it defaults to the current month.

Gadget Specific Settings: Placeholder will display grey example text to display prior to inputting a date.

Number Input

Text field that only allows integers (no characters). Up/Down arrows allow you to change the number without typing.

Gadget Specific Settings: Placeholder will display grey example text to display prior to inputting a number.

List 

Allows you to build a row of multiple gadgets to collect a series of fields that can be added to a form multiple times. Once a List is added to a template you can then use the +Add Item under the specific list to add gadgets to your list.

A List will look like the below when a user first opens their protocol form. The +Add Line or +Add Info will open the row up for edit on an inline list. It will open a dialogue window for completion on a dialog list.  Multiple rows can be added.

Gadget Specific Settings:

• Inline: The fields are editable within the table view - recommended for 3 or fewer fields. Progressive display cannot be used to hide fields in an inline list. Any field in an inline list with unfulfilled progressive display requirements will not fire validation when the form is submitted, but it will still display as an optional field in the list.
• Dialogue: Fields are completed in a popup dialogue window so it can accommodate more fields. Progressive display can be used on gadgets in a Dialog List. You can only reference other fields within the list when setting up this type of progressive display.  If you reference a gadget outside of your list in the progressive display of a gadget within a list it can cause errors when the user tries to add new entries to the list.
• Default Columns:  Will allow you to select which columns will display in the table view by default.  Individual users may change which columns display while they are in the form using the Columns button. Changes made this way will not impact the view for other users viewing the form. Please note that typically if Inline list is used you would want to display all columns. When new gadgets are added to a list they will be included in the selected Default Columns.

Country Dropdown

Creates a dropdown with a pre-populated list of all countries that exists.

Language Dropdown

Creates a dropdown with a pre-populated list of languages.

State/Province Dropdown

Creates a dropdown with a pre-populated list of US States and Canadian Provinces.

Training

Allows you to integrate training data into your compliance modules so users can view configured training completions when completing either a disclosure or protocol.  This can only be used if you have the monolith Kuali Research system implemented since it uses associated Training maintenance tables.  When adding the Training gadget the Options at the bottom correlate to the associated Training Code found in the maintenance table of Training; so that any options specified will display that training in either the disclosure or protocol.  Be aware, you must also have a record for the same value in the Training Modules table.  More information on setting up training in the maintenance table can be found in the Cross Module - Training Types and Person Training article.

For Protocols, you will need to add to the out of the box People section and then it will display when viewing the specific person; expired training will display red:

For COI, you can add the gadget to any section and it will display the configured training in that section of the form:

Protocol Specific Gadgets

Questionnaire Section

Creates a labeled frame in your form where you can collect gadgets to help organize information within your form.

Gadget Specific Settings: Only the Field Label displays for Questionnaire Section. Field Long Label and Field Help do not display for Questionnaire Section. Fields included in a Questionnaire Section must be answered before the document is submitted for review or finalized.

Funding Sources

Creates a lookup where you can enter a Proposal Development, Institutional Proposal, or Award ID listed in your Kuali Sponsored Projects instance and link your Protocol directly to the listed Kuali grant document. Each linked document will display the PI, Sponsor, Sponsor Type, Prime Sponsor, and Prime Sponsor Type.

Group

Note: This functionality has been replaced by using Section or Questionnaire Section and unchecking the Display on Form and Show Wrapper options. 

Personnel Researcher Roles 

This displays an Add button.  When the user presses the button hey are able to select a Research Role, as configured in the Researcher section of the Roles page of the Protocol template. This gadget is part of the Person list by default.

Personnel Contact Roles

This creates an Add button.  When the user presses the button hey are able to select a Contact Role, as configured in the Contact section of the Roles page of the Protocol template. This gadget is part of the Person list by default.

Researcher Roles Dropdown

This creates a dropdown list of the Research Roles, as configured in the Researcher section of the Roles page in the Protocol template.

Contact Roles Checkboxes

This creates a dropdown list of the Contact Roles, as configured in the Contact section of the Roles page in the Protocol template.

File Attachment

Allows you to search for or drag and drop a file to attach to your form.

Gadget Specific Settings: You can change the ‘Drag & Drop a file’ instructions or ‘Choose’ text that appears on the file browser button.

Person Typeahead

This gadget will automatically search for a person in your HR feed as the user types their name. Once the appropriate user displays in the dropdown they can be selected and will be stored in the field.

Gadget Specific Settings: Placeholder will display grey example text to display prior to inputting a user.

Unit Select

This gadget displays a dropdown list of all the units in your institution's Groups Hierarchy. As the user types the dropdown list will highlight the next entry that matches what the user has typed in. 

Adding a Gadget

When adding any gadget the below fields are available. The fields marked required must be completed:

• Field Label - Required - Will display as the field label in the form (if checked) but will display on reports by default as the header even if display as unchecked. Will also display in the gadget description in form designer when editing your form.
• Field Key - Required - The Field Key uniquely identifies the field within a particular form. Users can only set the field key once, when adding a gadget. The Field Key is what you will use to refer to the field in API calls and to find the correct field when you are establishing rules for behavior like progressive disclosure. Its length may not exceed 32 characters.  You can set yourself initially or if you save an entry without completing they system will assign one.
• Field Long Label - Optional - Is a longer description or explanation that includes rich text formatting and will display below the field label (if checked to display).
• Field Help - Optional - You can also use the Field Help data element to provide even more information to your users, and you can opt to display the help on the form. If you do not, an information icon will appear and users that need additional information can click that to obtain it.
• Field Width - Optional (defaults to Large) - Controls size/layout of gadget content text.  The options are: 
  X-Large/Large: Will display up to 1 item in the column across the page in normal display.
  Medium: Will display up to 2 items in a column across the page in a normal sized display (not minimized).
  Small: Will display up to 3 items in a column across the page in a normal sized display (not minimized).