The Program report offers an overview of a pre-defined learning program—like compliance training or new hire training. This guide explains how to create a Program report using Advanced Configuration.
- User Types
- Any user with access to the report builder (Global Admins, Area Admins, and some Users) can configure a Program report.
- Pricing
- Available on CLO, and Enterprise.
- Expertise
- Experts can use advanced configuration.
Program Report Advanced Configuration
The activity, people and dates filters and report text of the Program report can be configured using simple configuration as they can for all reports. In addition, the Program report can be further configured using Advanced Configuration. Each Program report’s configuration object has a program property which contains a program configuration object. The properties of that object are outlined in the table below.
|
Property |
Explanation |
Example |
|
name |
The name of the program |
Widget 5000 Sales Training |
|
primaryPathId |
The id of the primary path for the program. Currently the Program report only displays data about one learning path. |
widget-5000-sales |
|
learningPaths |
An array of learning path objects representing the paths associated with the program. Currently the Program report only displays data about one learning path as identified by the primary path id. |
[
{..learning path..}
]
|
|
workflows |
An array of workflow objects representing the workflow associated with the program. |
[
{..workflow..},
{..workflow..},
{..workflow..}
]
|
|
competencies |
An array of competency objects representing the competencies associated with the program. |
[
{..competency..},
{..competency..},
{..competency..},
{..competency..},
{..competency..},
{..competency..}
]
|
|
dataOrigins |
An array of data source objects representing the data sources associated with the program. |
[
{..data source..},
{..data source..},
{..data source..}
]
|
|
assessments |
An array of assessment objects representing the assessments, tests and quizzes associated with the program. |
[
{..assessment..},
{..assessment..},
{..assessment..},
{..assessment..},
{..assessment..},
]
|
Learning Paths - Advanced Configuration
A program includes a primary path made up of milestones. The program configuration includes an array of learning path objects as described above. Learning path objects have the following properties:
|
Property |
Explanation |
Example |
|
type |
The object type. Always ‘learningPath’. |
learningPath |
|
name |
Name of the learning path to be displayed. |
Widget 500 Sales Training |
|
ordered |
Determines how the milestone visualization displays. If false, will display the percentage of people who have completed the milestone, regardless of other milestones. If true, will display the percentage of people currently on that step. |
false |
|
id |
Id of the learning path. |
widget-5000-sales |
|
steps |
An array of step and step collection objects representing the milestones of the learning path. |
[
{..step..},
{..step..},
{..step collection..},
{..step..},
{..step collection..},
]
|
Please note: if a set of milestones is not always completed in the same order, setting the 'ordered' property to ‘true’ can distort the results and lead to negative percentages for steps that are commonly skipped or completed out of order.
Workflows - Advanced Configuration
Workflows represent a series of small steps that make up a single workflow within the Program. They are configured in a similar way to paths, except that there can be any number of workflows but only one primary path.
Workflow configuration objects have the following properties:
|
Property |
Explanation |
Example |
|
type |
The object type. Always ‘workflow’. |
workflow |
|
name |
Name of the workflow to be displayed. |
Create New Product Order |
|
id |
Id of the workflow. |
new-product-order |
|
steps |
An array of step and step collection objects representing the tasks within the workflow. |
[
{..step object..},
{..step object..},
{..step collection object..},
{..step object object..},
{..step collection object..}
]
|
|
sessionType |
The type of session. Use “registration” if workflow attempts each have a different registration. Use “activityId” if workflow attempts each have a different activity id. Workflows where the learner can have multiple attempts at the workflow with the same registration and activity id are not supported. |
registration |
|
stepsRequiredForCompletion |
Which steps within the workflow need to be completed in order for the workflow to be considered complete. Either “all” of the steps or just the “finalStep”. |
all finalStep |
|
exitStep |
The step, which when completed, indicates that the workflow has been completed by the learner. Contains a step object. |
{..step object..}
|
|
timeLimitSeconds |
The number of seconds within which the workflow must be completed from when any step is first completed. |
3600 |
|
scoreActivityId |
The activity id used to determine the learner’s score for the workflow. |
http://example.com/customerservice/score |
Please note: The first step completed should be the first step of the workflow, but learners may deviate from that path. Their time limit starts after they complete any step, even if it is not the first.
Competencies - Advanced Configuration
Competencies represent demonstrations of competence within a program. They are configured in a similar way to paths, but visualized very differently:
- A program might be expected to have many competencies but only one primary path.
- Steps that make up a competency should be thought of more as criteria; there is no expectation that they will be completed in a particular order.
- The score achieved when completing a competency is significant and is used to determine the learner’s proficiency in that competency. Weighting can be applied to steps to account for differences in difficulty of activities demonstrating competence.
Competency configuration objects have the following properties:
|
Property |
Explanation |
Example |
|
type |
The object type. Always ‘competency’. |
competency |
|
name |
Name of the competency to be displayed. |
Widget 500 Demonstrations |
|
id |
Id of the competency. |
widget-5000-demo |
|
steps |
An array of step and step collection objects representing the criteria for achieving the competency. |
[
{..step..},
{..step..},
{..step collection..},
{..step..},
{..step collection..},
]
|
|
stepWeights |
Contains a step weights object defining the weights that should be applied to each step when calculations the competency score. Properties of the step weights object are the names of steps and the values are the weightings. Weightings should add up to 1 in total. |
{
"Articulating": 0.25,
"Investigating": 0.75
}
|
Steps and Step Collections - Advanced Configuration
Paths and competencies both contain arrays of steps and step collections. Step collections are used to require the learner to complete a configurable number of actions from a given list. For example a learner might have to pass 2 out of 3 quizzes in order to complete the milestone. Step collections have the following properties:
|
Property |
Explanation |
Example |
|
type |
The object type. Always ‘collection’. |
collection |
|
name |
Name of the step collection. If this is a top level step, this name is displayed as a program milestone. |
Complete pre-training e-learning module |
|
completeThreshold |
The number of steps within the collection that need to be completed in order for the collection to be considered complete. |
2 |
|
exemptPersonCustomIds |
A list of custom ids of people who are exempt from completing this step. Exempt people/steps are not counted in completion percentages. |
["alice@example.com", "bob@example.com"] |
|
exemptGroupCustomIds |
A list of custom ids of groups who are exempt from completing this step. Exempt people/steps are not counted in completion percentages. |
["Region: West", "Region: South"] |
|
steps |
An array of step and step collection objects (collections can be nested). |
[
{..step..},
{..step..},
{..step collection..},
{..step..},
{..step collection..},
]
|
| targetScoreForCompletion |
A minimum score on the matched statement (score as part of the .result property) in order for the step to be considered complete. |
80 |
| requiredMatchCount |
The minimum number of matching statements (times the person did something) before the step is considered complete. If undefined, this value is 1, but when this is set it can be greater than 1. |
3 |
Steps have the following properties:
|
Property |
Explanation |
Example |
|
type |
All steps should have a type of ‘match’. |
match |
|
name |
Name of the step. If this is a top level step, this name is displayed as a program milestone. Steps don’t have ids, so make sure the name of the step is unique. |
Complete pre-training e-learning module |
|
filter |
Filter to be matched. If the filter contains one or more statement for each learner, then that learner is considered to have completed the step. |
See advanced filters. |
Assessments - Advanced Configuration
The assessments property determines which assessments are listed for the program. It contains an array of assessment filter objects with the following properties:
|
Property |
Explanation |
Example |
|
name |
The name of the assessment as it should be displayed in this Program report. |
E.g. if the full name of an assessment is “Program X: Module 1 Assessment”, then it might be called simply “Module 1” in the assessments section of the Program X Program report. |
|
activityId |
The activity id of the assessment to use. |
http://example.com/activities/example-assessment |
Data Origin - Advanced Configuration
The dataOrigins property determines which data sources are listed for the program. It contains an array of data source filter objects with the following properties:
|
Property |
Explanation |
Example |
|
name |
The name of the data source as it should be displayed in this Program report. |
Coaching App |
|
filter |
Filter used to match data source data. |
See advanced filters. |
Additional Advanced Configuration Options
|
Property |
Explanation |
Example |
|
hideDuration |
Hides the "Average Time to Complete this Program" data point in the top part of the Program report when set to true |
true |
|
hideActivities |
Hides the "Activities" section when set to true |
true |
|
hideGroups |
Hides the "Groups" section when set to true |
false |
|
hidePeople |
Hides the "People" section when set to true |
true |
|
hideInteractions |
Hides the "Total Interactions" section when set to true |
false |
|
hideContributingSystems |
Hides the "Contributing Systems" section and the "Contributing Systems" column from every program report page when set to true |
true |
|
flattenGroups |
In the "Groups" section, makes group names not clickable when set to true |
false |
