Documentation

Configuration

Below you will find details how each card works, set up options, and configuration. This set of cards comes deployed with a fourth global required reading card that links them all together. 

1. Required Reading Banner

Any page can display the required reading banner. To edit the page click "Set up cards" and then modify the template. Look for the "Required Reading" card in the Custom cards area. Ideally this card should go above the body in the center lane. However, you can place this anywhere you like.

Additionally, if body copy is long, you can place two versions of the same card on the same page. One before the body, and one afterwards. Clicking in one will affect the other. This prevents users from scrolling all the way to the top to confirm they have read the page. Users will continue to see the message "Confirm that you have read and understood this page" every time they return to the page until they click the "Yes I confirm" button.
 
required%20reading%20confirm.png
required%20reading%20confirmed.png

The copy can be modified globally for all instances of the card. Please contact helpdesk@thoughtfarmer.com if you would like to change the copy. When first added to a page all users of your intranet will see the message on the page. If you wish to configure this to only a subset of users for a specific page you may do so by adding the "Required Reading Configuration" card to the page.

2. Required Reading Configuration

By adding this card to a page you can configure which users must read the page. You only need this card if less than "All Registered Users" need to see the Required Reading confirmation message. Once added to the page only users with edit permissions will see it and can  modify it.
config.png

To change which users must read the page just click "Change", remove "All registered users", then start typing the names of users, groups, or security profiles. Once you have added all the users you need to just click save. The card should update with the new set of users and a count of all who are required to read.

As users start confirming you will also see a summary count of how many users have and have not confirmed. You may also reset the required reading from here as well. To get more detailed reporting on a per user level, you can use the Required Reading Report card.

3. Required Reading Report

If you add this card to any page with the Required Reading banner on it, you will see a detailed report showing a table with a list of all users required to read the page. This card will only show to users with edit permissions on any given page.  It will also show if they have confirmed and the date they confirmed.
 
rr_table.png

Additional options allow for sending emails to all confirmed users, (e.g. to thank them for their confirmation). You may also email all not confirmed users (e.g. to remind them to complete the task). 

Advanced configuration

It is possible to create a completely separate area where multiple required reading report cards are on the same page. You can set a different source for every instance of the Required Reading Report you add to this other page. This way you may create a dashboard that reports on several pages at once. To do this, use the card's configuration area to say which ThoughtFarmer page the card should pull data from.

For example, enter the following into the card's configuration area:
{ "sourceContentId": 123 }


Be sure to modify the 123 above with the content ID for the source page where you want to pull data from. You can locate the content ID of a page in the URL, for example in bold: https://community.thoughtfarmer.com/content/183747.

To modify the number of rows displayed per page of the report table, you can alter the pageSize configuration to the desired number. The default is set to 10.

For example, if you are also setting a sourceContentId:
{
"sourceContentId": 123,
"pageSize": 15
}

or else your custom pageSize configuration could look like this:
{ "pageSize": 15 }