Checklist Widget Library Item

Overview

This library item displays like this on the “Dark” template. It displays differently with different templates.

The Checklist Component is available to be placed in a widget when ERX Core is installed. If Core is installed, then, when you insert the Checklist into a widget, it will behave as follows:

  • It displays checklist items. These are the records belonging to Erx Core’s Requirement Item Objects (“RIO”s). By default, these RIOs are defined in ERX Core:
    • Education History
    • Test Score
    • Admission Document
    • Recommendation
    And any other object may be defined as a RIO in ERX Core, provided it looks up to the Application or the Contact.
  • In order for a particular record to appear in the checklist, it must have a Status among those selected as “Pending” in the ERX Core Admin Panel:

  • The checkbox “Display to Applicant” must also be checked on each RIO record for it to appear in a checklist.
Here is the configuration wizard:

  • Multiple Checklists may be defined, because each one can be configured to display different “Categories” of checklist Items. As of ERX Core Summer 2019, RIOs have a multi-select picklist called “Category”. When you add the checklist widget from the library, you see the above screen, where you define which Categories of items to display.

With this feature, you can, for example, categorize RIO records as either “Application” or “Post Admit” and render one checklist that displays both categories while the candidate is applying, and, after the candidate is admitted, render another checklist that displays only the Post Admit category of items. You can have separate checklists for, e.g., Financial Aid requirement items, or Graduate Assistantship application items. You may add any categories you desire to the “Category” picklist.

Note:
For backward compatibility, if you do not select any categories in this dialog, then all RIO items will be displayed, provided their “Display to Applicant” checkbox is checked.
  • Each checklist item record has a field called “Portal Comments”. Text entered into this field will be displayed immediately beneath the name of the checklist item
    • You can control the style of the “Portal Comments” text by putting the portalComments CSS tag into the header of your template.
<style>
#portalComments{
Color:blue!important;
Font-weight:100;
font-family: 'Orienta', sans-serif;
}
</style>

Example Scenario: Display Two Checklist Widgets on the Same Page

If you would like to display two different Checklist Widgets on the same page (e.g., one to control a Portal User's in-progress items and one to control their completed items), create two separate Category labels in ERX Core. For example, you could configure the Category field to have values of “Application Item Pending” and “Application Item Complete” to define which items will display in which checklist.

Note:
If you have ERX Core, visit the ERX Core user guide for more information on configuring Checklist Items.
In FormBuilder, this configuration would look like the two screenshots below (the second one is annotated for your reference). From the Portal User perspective, this configuration would render on the page with the pending items in an "In Progress" widget and completed items in a "Completed" widget.



Tip:
To access the Update Configuration dialog, go to the FormBuilder Environment and Click the Widget Builder tab > Select the desired Widget > Click the Edit icon).
Label Description
A. Name Indicates the label on the back end for the checklist widget. Used for internal purposes only.
B. Widget What type of widget is in use from the widget library.
C. CSS Class Can be populated with a custom CSS class to control the look, feel, and overall styling of the widget.
D. Title The front end label a portal user would see when logged in and viewing the widget.
E. Category This is used to define which categories of items to display. See above for an example.

Clickable Checklist items

Three fields on Checklist Item objects can be leveraged to make a checklist item clickable:

  • “Allow Upload” checkbox (EnrollmentrxRx__Allow_Upload__c)
  • “Instructive Text” text field (EnrollmentrxRx__Instructive_Text__c)
  • "External URL" text field (EnrollmentRx_External_URL__c)

Populating these fields will make the checklist item into a hyperlink. When clicked, a window will open that contains a file upload widget (if “Allow Upload” has been checked), instructive text (if “Instructive Text” has been populated), or a link to an external URL (if "External URL" is populated). “Instructive text” can contain hyperlinks, if you wish to direct the user to an external website.

An additional field allows you to suppress the garbage can icon (the delete button) when the user is uploading a document, so that they cannot delete any file they upload:

  • “Disable Delete” checkbox (EnrollmentrxRx__Disable_Delete__c)
Uploads are stored as Salesforce Files (or Salesforce Attachments, but only if you are still using Salesforce Classic) and you can control this, as well as the file types and maximum size of files uploaded through checklist items using the “Checklist Configuration” button in the HOMEPAGE BUILDER tab of FormBuilder, as shown below.

Note:
Salesforce Files should be used in preference to Attachments, which are being phased out by Salesforce. Attachments are neither searchable nor editable in Lightning.
Which opens the Checklist Upload Configuration dialog:

External URL Examples

In 2023 Release 1 we introduced a new field, "External URL," which redirets your end users to an external page when they click a Checklist Item. This field must be configured in ERX Core.

Examples:

RIO record populated with an external URL:

Here's what this looks like on the front end: