24Checklist Manual

24Checklist Manual

Table of Contents

1. Install 24Checklist app & assign permission sets.

Make sure you have properly installed the 24Checklist app and assigned the appropriate permission sets. If not, please check the 24Checklist Installation Manual first.

2. Open the 24Checklist app via the App Launcher.

After installing the app, you can open the 24Checklist manager via the App Launcher.  This is the app that will allow you to define new checks and checklists, as well as to specify when these checklists should be presented to users.

24Checklist app launcher

3. Create individual checks

A checklist consists of one or more checks. So in order to create a checklist, you must first create individual checks. 

Go to the Checks tab within the 24Checklist app and click “New” on the top right.

 
24Checklist check

General Settings

 

  1. Name: Name of the check

  2. Type:

    1. Free Input: Select this input type in case the input is to be stored in a generic object.

    2. Update Field: The check will update the field of a record as defined below.

    3. Update Related List Records: Select this input type in case the check needs to update multiple records.

  3. Generate x times:  Generate this check X times within each checklist that contains this check.

  4. Applicable Object: Set the API name of the object in case this check can only be applied on a specific object. Leave blank in case the check can be applied on any object. The Applicable Object parameter is mandatory in case the check aims to update a Field, see general settings, Type. 

  5. Applicable Field: Field that has to be updated based on the input given by the user for this check. 

  6. Launch even when:

    1. Check generated: Launch a Salesforce platform event when the check has been generated within a specific checklist.

    2. Check confirmed: Launch a Salesforce platform event when the user has completed and confirmed the check.

 

Timer Settings

Timer settings allow you to define time sensitive checks, i.e. checks that need to be completed within a preset time frame. Leave this section blank in case timer settings do not apply to this check.

 

  1. Timer Type

    1. Count Down: counter decreases

    2. Count Up; counter increases

  2. Launch Timer:

    1. Immediately: the timer is launched as soon as a checklist is instantiated that contains this check. 

    2. After Predecessor confirmation: A predecessor is a check that has to be completed before this check can be completed. The timer for this check will be started when the predecessor check has been completed. 

  3. Threshold Timer: Periodic time interval, expressed in minutes, within which check has to be completed periodically. When no input is provided prior to the expiration of the timer, the timer will turn red. 

  4. Threshold Timer Input Behaviour: This parameter governs the behaviour once the threshold timer has been exceeded: 

    1. EnableInputExceeded: Allow the user to complete the check even when the timer has been exceeded.

    2. DisableInputExceeded: Do not allow the user to complete the check when the timer has been exceeded.

    3. StartInputWhenExceeded: Allow the user to provide input only after the timer threshold has been exceeded. 

  5. Show Timer: Check this box in case you want the timer to be visible to the user.

  6. Launch threshold breach event: Create a Salesforce platform event in case the timer threshold has been exceeded and a user input has not been entered.

 

Input Settings

  1. Input Type:

    1. Checkbox: Create a check with a checkbox.

    2. Input Field: User can enter free text.

    3. Rich Text: User can enter rich text. 

    4. Picklist: Choose input from a dropdown list.

    5. Numeric: The input should be a numeric value.

  2. Input Placeholder: Depending on the Input Type, the Input Placeholder will have a different meaning. For:

    1. Checkbox: The Input Placeholder is the label for the checkbox

    2. Input field: The Input Placeholder is a placeholder value presented to the user.

    3. Richt text: The Input Placeholder is a placeholder value presented to the user.

    4. Picklist: The Input Placeholder defines the picklist items. Use a different line for each picklist item.

Ranges

 

Apply a range check on the input field, if the input falls outside the range, a Salesforce platform event is generated. In order to use the Range functionality, the Input Type must be set to numeric.

  1. From: lower bound of the input range.

  2. To: upper bound of the input range. 

 

Description

  • Description: Additional  description of the check to be shown to the user.

Additional documentation: Additional  description of the check to be shown to the user.

4. Create a checklist

Once you have created one or multiple checks, you can create a checklist that groups these checks.

 

  1. Checklist Name: Mandatory, name of the checklist.

  2. Applicable Object: Defines the Salesforce object onto which the checklist will be visible. 

  3. Show Progress Indicator: Check that decides whether to show a progress indicator when a user is completing the checklist.

  4. Launch Event When: Launch a Salesforce Platform Event when the checklist has been completed.

  5. Apply Filter: Filters can be used to decide whether a checklist should be shown to the user, based on a set of rules. 

    1. All: Apply all Checklist Filter Rules (see Checklist Filter Rules section below). If all Checklist Filter Rules are met, the checklist will be shown to the user.

    2. Any: Apply any of the Checklist Filter Rules (see Checklist Filter Rules section below). If any of the Checklist Filter Rules are met, the checklist will be shown to the user.

    3. Custom: Apply the Customer Filter Logic. If the Custom Filter Logic is true, the checklist will be shown to the user.

  6. Custom Filter Logic: Only use when ‘Custom’ has been selected in Apply Filter. Determines under what conditions a Checklist should be presented to the user.

 

5. Apply checklist filter rules and assign checks

Checklist filter rules

Rules are combined in filters that govern when checklists are shown to users, see Step 4 “Create a Checklist”.

  1. Checklist: Name of the checklist to which the rule applies.

  2. Rule row: Number of the rule to be used in Custom Filter Logic.

  3. Tested Field: API name of the field onto which the filter should apply.

  4. Filter type:

    1. Value: compare against a value.

    2. Field: compare against a value specified in another field.

  5. Operator: Logical operator to be applied to the field.

  6. Filter Value

    1. Value: Enter the value against which the logical operator applies. 

    2. Field:  enter the API name of the field against which value the logical operator applies. This can be a field of either the Applicable Object (as defined in the checklist) or a Field of a Related Object. In the latter case, also specify the ‘Related Object’ and ‘Lookup Field’ inputs below.

  7. Related object:  Specify the related object in case the ‘Tested Field” should be compared against a field in a related object.

  8. Lookup field: The lookup field links the Related Object with the Applicable Object (as defined in the checklist definition).

 

Assign Checks

Use assign checks to assign checks to a checklist:

  1. Sort Order: Check will be displayed to the user in ascending order.

  2. Checklist: Name of the checklist to which you are assigning a check. 

  3. Check: Picklist, name of the check to be assigned to the checklist.

  4. Predecessor: Checklist check number (you get a picklist) of  the check that needs to be completed before this check can be completed. Use the Predecessor in case you want to enforce an order in which the checks are completed, else leave blank.

6. Validate the checklist as a user

 

The final step is to validate the resulting checklist as a user.