Credential Summary Templates
Introduced in 10.10.0, Credential Summary Templates are used to configure the “Credential header” area of the Application Pathways Page.
On this page, the term “Credential” is synonymous with the system term “Discipline”
Executive Summary
The Application Pathways Page can display information about a Practitioner’s credentials, grouped by Credential (Discipline).
The header of each section can be configured to meet program-specific needs.
Credential Summary Templates are configured at Admin → Credentials → Credential Summary Templates.
Templates can be shared between multiple Credentials. The linkage is established from the Admin → Credentials → Edit Credential page.
Configuring the template
Credential Summary Templates use the Scriban template language. For full details on its syntax, please refer to its official language documentation.
The Credential Summary template has access to a PathwaysCredentialModel
that exposes information about the Credential and the associated Member Role
.
In addition to those data elements, the model also exposes some helper functions for rendering common elements of the summary.
Data properties
Category | Property | Purpose |
---|---|---|
Credential |
|
|
|
| |
|
| |
|
| |
Role |
|
|
|
| |
|
| |
|
| |
|
| |
Member Role | ||
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
Configuration / Other |
|
|
|
| |
|
|
Helper functions
Function | Purpose |
---|---|
| Renders the “Show Details” link that expands/collapses the Credential Description. |
| Renders the Credential Logo |
Customizing the default template
The default template is designed to support multiple different use cases, although you will need to make a copy of it before you can modify it.
Step | |
---|---|
1 | Create a copy of the default templateThe default template is controlled at the system level and cannot be directly modified. If you need to customize it, start by creating a copy. |
2 | Modify the “configuration variables” section of the templateYou can leave the The |
3 | Link your new template to the Credential(s) that should use itEdit the appropriate Credentials and choose your new template. |
Default template configuration variables
The default template starts with a code section like this:
{{
# =====================================================================
# What field to use as the due date? Supported values are "ROLE-END-DATE" and "_NONE"
DUE_DATE_FIELD = "ROLE-END-DATE"
... [truncated]
}}
The things in UPPER_CASE, such as SHOW_DESC_WHEN_USER_DOES_NOT_HAVE_ROLE
, are variables that you can modify to affect how the template behaves. The specific use cases that are supported are:
Template variable | Use case / instructions |
---|---|
| Controls which Attribute is used to calculate the “due date”.
|
STATUS_TO_DUE_DATE_LABELS = {
"Active" : "Expiration",
"Deceased" : "_NONE"
}
DEFAULT_DUE_DATE_LABEL = "Deadline" | Can be used to change the terminology used to refer to the “due date”, based upon For instance, you might want to call the due date the “Submission Deadline” for applicants, and the “Expiration Date” for active practitioners. To suppress the due date for one or more statuses, map them to “_NONE”. The |
NOT_ACTIONABLE = { "cssClass": "deadline-not-actionable", "color": "#444444", "icon": null, "iconTooltip": null }
DUE_DATE_CATEGORIES = [
{ "daysUntilGTE": 30, "cssClass": "deadline-ok", "color": "#fb952c", "icon": null, "iconTooltip": null },
{ "daysUntilGTE": 0, "cssClass": "deadline-looming", "color": "#b61e3a", "icon": "fas fa-stopwatch", "iconTooltip": "This date is coming soon" },
{ "daysUntilGTE": -30, "cssClass": "deadline-pastdue", "color": "#b61e3a", "icon": "fas fa-exclamation-triangle", "iconTooltip": "This date is in the past" },
{ "daysUntilGTE": -999999999, "cssClass": "deadline-oldnews", "color": "#444444", "icon": null, "iconTooltip": null }
] | Can be used to change the color used to display the due date, based on how far away the date is. For instance, you might want to display dates in red when past due, orange when due within 30 days, and green otherwise. This setting accepts one or more elements in an array. The array is examined sequentially, so these should be entered in descending value (e.g. the furthest future value listed first, the furthest past value listed last) For each date range you can control the CSS class that is applied (in case you have custom styles defined), the hex color code to display the date in, a FontAwesome icon to display, and the icon tooltip. |
Can be used to display a “Print Certificate” link for specific Each Role Status (that should display the print link) should be mapped to the ID of a Template Attribute that should be rendered. |