Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion cypress/e2e/admin-quiz_and_surveys.cy.js
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,6 @@ context('Admin: Generate Quiz and Surveys Screenshots', () => {
})

it('quiz runs table', () => {
cy.viewport(1500, 1800)
cy.visit('/administrator/quizzes/ShortScienceQuiz/runs')
cy.get('[data-cy="userFilterBtn"]')
cy.get('[data-cy="row0-userCell"]')
Expand Down
33 changes: 33 additions & 0 deletions cypress/e2e/admin.cy.js
Original file line number Diff line number Diff line change
Expand Up @@ -769,4 +769,37 @@ context('Admin: Generate Screenshots', () => {
cy.snap('component-notifications-dropdown', null, {clip: { x: 370, y: 0, width: 540, height: 550 }});
});


it('user overall progress', () => {
cy.intercept('/app/progress-metrics**').as('progressMetrics')
cy.visit('/administrator/users-progress');
cy.wait('@progressMetrics')

cy.get('[data-pc-name="headercell"] [data-pc-section="columntitle"]').contains('User')
cy.snap('page-users-overall-progress')

cy.get('[data-cy="confQuizExclusionBtn"]').click()
cy.get('[data-cy="confIncludedMetricsDialog"] [data-pc-section="sourcelistcontainer"] [data-pc-section="option"][aria-posinset="1"]').click()
cy.get('[data-cy="confIncludedMetricsDialog"] [data-pc-name="pcmovetotargetbutton"]').click()
cy.snap('component-configure-quiz-metrics-inclusions', '[data-pc-name="dialog"]')
});

it('global quiz runs', () => {
cy.intercept('/app/quiz-runs**').as('quizRuns')
cy.visit('/administrator/quiz-runs');
cy.wait('@quizRuns')
cy.get('[data-cy="quizRunsHistoryTable"] [data-cy="skillsBTableTotalRows"]')

cy.snap('page-global-quiz-runs')
});

it('global metrics page', () => {
cy.intercept('/app/overall-metrics/overallDistinctUsersOverTimeMetricsBuilder**').as('overallDistinctUsersOverTime');
cy.visit('/administrator/overall-metrics');
cy.wait('@overallDistinctUsersOverTime');

cy.get('[data-cy="overallMetricsProjectsCard"]').should('be.visible');

cy.snap('page-global-metrics')
});
})
29 changes: 29 additions & 0 deletions docs/dashboard/user-guide/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,35 @@ In addition to the skill metrics table, the page offers several useful filters t

Admins can also export the entire table to Excel format using the `Export All Rows` button located at the top right of the table.

## Global Metrics

To view Global Metrics, please navigate to `Projects -> Metrics`. These metrics will be for all of the projects and
quizzes that you are currently assigned as an administrator.

![page-global-metrics.png](../../screenshots/admin/page-global-metrics.png)

### Configuring Included Projects and Quizzes

There are times where you may have a number of projects, quizzes, and surveys that you do not want to include in the overall
progress page, metrics, and quizzes pages.

There is a very easy way to include or exclude projects and quizzes from your view. Please note that the configuration
buttons are within the projects and assessment information cards at the top of the page.

Clicking on the settings button will open a modal where you can select the projects and quizzes that you want to include
in the overall progress page, metrics, and quizzes pages.

For example, for quizzes and surveys:

![component-configure-quiz-metrics-inclusions.png](../../screenshots/admin/component-configure-quiz-metrics-inclusions.png)

Select one or more items to exclude or include, then use the controls in the middle to move the items between inclusion and exclusion lists.

::: tip
- Please note that these inclusion/exclusion settings are user-specific and will only apply to you.
- Please note that these settings apply to multiple pages, including the Global Metrics, Overall Users Progress and Global Quiz and Survey Runs.
:::

## Single Skill Metrics

The Single Skill Metrics Section provides detailed metrics for a specific skill, allowing admins to dive deeper into the performance and usage of that skill.
Expand Down
52 changes: 48 additions & 4 deletions docs/dashboard/user-guide/quizzes-and-surveys.md
Original file line number Diff line number Diff line change
Expand Up @@ -426,13 +426,15 @@ To track individual quiz/survey attempts, visit the **Runs** page (`Quizzes and
**Runs Table Features:**
- **User** - The user who attempted the quiz/survey
- **Status** - Current state: **Passed**, **Failed**, or **Needs Grading**
- **Runtime** - Time taken to complete the quiz/survey
- **Started** - Date and time when the attempt began
- **Results** - Number of correct answers out of total questions
- **Actions** - Delete button to remove the attempt
- **Runtime** - (Optional) Time taken to complete the quiz/survey
- **Results** - (Optional) Number of correct answers out of total questions

::: tip
The runs table can be filtered by user to find specific attempts.
::: tip Tips
- The runs table can be filtered by user to find specific attempts.
- To export quiz runs, click the `Export` button at the top of the table.
- Optional fields can be added and removed using the dropdown above the table.
:::

Click the **run details button** next to a user to view comprehensive information about that specific quiz/survey attempt.
Expand All @@ -443,6 +445,48 @@ Click the **run details button** next to a user to view comprehensive informatio
Quiz results will depict selected answer(s) and their correctness status. Survey results will simply display which answers were selected.
:::

## Global Runs

To view runs across all of the Quizzes and Surveys that you are an administrator for, please navigate to `Projects -> Quiz/Survey Runs`.

![page-global-quiz-runs.png](../../screenshots/admin/page-global-quiz-runs.png)

**Runs Table Features:**
- **User** - The user who attempted the quiz/survey
- **Name** - The name of the quiz/survey
- **Type** - Whether this is a quiz or survey
- **Status** - Current state: **Passed**, **Failed**, **In Progress**, **Completed** or **Needs Grading**
- **Started** - Date and time when the attempt began
- **Runtime** - (optional) Time taken to complete the quiz/survey
- **Results** - (optional) Number of correct answers out of total questions

::: tip Tips
- To export quiz runs, click the `Export` button at the top of the table.
- Optional fields can be added and removed using the dropdown above the table.
:::

### Configuring Included Quizzes

There are times where you may have a number of quizzes and surveys that you do not want to include in the overall
progress page, metrics, and quiz runs pages.

There is a very easy way to include or exclude quizzes and surveys from your view. Please note the configuration
button within the assessment information card at the top of the page.

Clicking on the settings button will open a modal where you can select the quizzes and surveys that you want to include
in the overall progress page, metrics, and quiz runs pages.

For example, for quizzes and surveys:

![component-configure-quiz-metrics-inclusions.png](../../screenshots/admin/component-configure-quiz-metrics-inclusions.png)

Select one or more items to exclude or include, then use the controls in the middle to move the items between inclusion and exclusion lists.

::: tip
- Please note that these inclusion/exclusion settings are user-specific and will only apply to you.
- Please note that these settings apply to multiple pages, including the Global Metrics, Overall Users Progress and Global Quiz and Survey Runs.
:::

## Skill Association

A Quiz/Survey association to an existing skill requires successful completion of that Quiz/Survey
Expand Down
2 changes: 1 addition & 1 deletion docs/dashboard/user-guide/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The ```Security``` menu item supports the administration of [Root](/dashboard/us
![Security Settings](../../screenshots/admin/page-settings-security.png)


To grant [Root](/dashboard/user-guide/users.html#root) or [Supervisor](/dashboard/user-guide/users.html#supervisor) privileges to a user, that user must have an existing account for the SkillTree Dashboard. User management will also prevent the removal of any permissions from the currently authenticated user.
To grant [Root](/dashboard/user-guide/users.html#root) privileges to a user, that user must have an existing account for the SkillTree Dashboard. User management will also prevent the removal of any permissions from the currently authenticated user.

## Email Settings
<requires-role role="Root" />
Expand Down
136 changes: 87 additions & 49 deletions docs/dashboard/user-guide/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
This section describes different types of dashboard users and their corresponding roles and permissions.
It will also touch on access management, and a way to view the Skill Display through your users' eyes.

## User Progress Table
## Project's Users

### User Progress Table

Easily track user progress in a specific project by visiting the User Progress Table, accessible via the
`Project -> Users` Page. This table provides a comprehensive overview of user performance, including:
Expand All @@ -18,7 +20,7 @@ Easily track user progress in a specific project by visiting the User Progress T
Please note that a user has to earn at least 1 point in order to show up in on the Users table.
:::

### Filters, Sorting And Export
#### Filters, Sorting And Export
The User Progress Table offers filtering, sorting, and export capabilities to help you analyze user performance. You can:

- Filter by user ID, first name, and last name using the User Filter
Expand All @@ -30,7 +32,7 @@ The User Progress Table offers filtering, sorting, and export capabilities to he
Note that the export will respect any currently applied filters.
:::

## Users Archive
### Users Archive

Users can be archived and restored in batches or individually. Archived users are excluded from project visualizations, metrics, and tables.

Expand All @@ -48,6 +50,85 @@ The archive can be viewed by clicking the `User Archive` button, located on the

To restore an archived user, simply click the `Restore` button for that user.

### Performed Skills

To see a history of a user's performed skill events please visit ``Project -> Users -> Select a User -> Performed Skills``.

![page-user-performed-skills.png](../../screenshots/admin/page-user-performed-skills.png)

Project administrators have the ability to remove individual, selected or all skill events.

* *To delete a single skill event:* click the delete button on the specific skill event row
* <em>To delete **ALL** skill events</em>: click the `Delete All` button on the top right of the table.
* To delete multiple skill events, select them and click the `Delete Selected` button

::: tip
If you remove **all** of the skill events then it will practically remove this user from this project
:::

### Individual User Skills Display

You can see what the skills profile and progress display would look like for a particular user by navigating to a specific user page in the dashboard - ``Project -> Users -> Select a User -> User's Display``.
This will allow you to see the project from the trainee's point of view. These displays depict the project skills profile and user's points at that exact moment.

::: tip
We suggest visiting the [Skills Display](/skills-client/#skills-display) view often while building a skill profile to better understand how your users will view the gamification profile and their progress.
Optionally you can also [Add Events Manually](/dashboard/user-guide/skills.html#manually-add-skill-event) to better understand the client display.
:::

If your gamification profile is utilizing [Skills Versioning](/dashboard/user-guide/skills.html#skills-versioning) then you can view
what the [Skills Display](/skills-client/#skills-display) would look like for a specific version by selecting a different version in the drop-down located on the top-right of the page.

::: tip
Project administrators can now easily export transcripts for users who have made progress in the project, providing a convenient way to manage training records. To download a user's transcript, follow these steps:

- Navigate to Project > Users
- Select the desired user (User's Display page)
- Click the `Download Transcript` button at the bottom of the page

This feature offers greater flexibility and convenience for managing training records, making it easier for project
administrators to track user progress and stay organized.
:::

## Overall Progress

The Overall Progress page provides a comprehensive overview of user performance across all projects, quizzes, and surveys that you administer.

To access the Overall Progress page, navigate to ``Projects -> Users``.

At the top of the page, you will find metrics about the Projects, Quizzes, Surveys, and Badges that you are currently an administrator for.

This is followed by a table of users and their overall progress. Each row in the table represents a user and their overall progress across all projects, quizzes, and surveys.

The table can be sorted by all columns. Each row can be expanded to view the details about that user's progress. The expanded row will show each project that the user made progress in, followed by all of the user's quiz and survey runs.

![page-users-overall-progress.png](../../screenshots/admin/page-users-overall-progress.png)

::: tip
You can also export raw table data to an Excel file by clicking the `Export` button at the top of the table.
:::

### Configuring Included Projects and Quizzes

There are times where you may have a number of projects, quizzes, and surveys that you do not want to include in the overall
progress page, metrics, and quizzes pages.

There is a very easy way to include or exclude projects and quizzes from your view. Please note the configuration
buttons within the projects and assessment information cards at the top of the page.

Clicking on the settings button will open a modal where you can select the projects and quizzes that you want to include
in the overall progress page, metrics, and quizzes pages.

For example, for quizzes and surveys:

![component-configure-quiz-metrics-inclusions.png](../../screenshots/admin/component-configure-quiz-metrics-inclusions.png)

Select one or more items to exclude or include, then use the controls in the middle to move the items between inclusion and exclusion lists.

::: tip Tips
- Please note that these inclusion/exclusion settings are user-specific and will only apply to you.
- Please note that these settings apply to multiple pages, including the Global Metrics, Overall Users Progress and Global Quiz and Survey Runs.
:::

## User Roles

Expand Down Expand Up @@ -83,55 +164,12 @@ Please visit [Project's Access Page](/dashboard/user-guide/projects.html#access)

### Root

The Root role is meant for administering the dashboard itself and not any specific project. Users with the Root role can view the Inception project.
Users with the Root role can also assign Supervisor and Root roles to other dashboard users.

Please visit the [Security Setting Section](/dashboard/user-guide/settings.html#security-settings) to learn how to assign this role.

### Supervisor
The Supervisor role allows users to manage Global Badges. Only users with the Root role can assign the Supervisor role.
The Root role is meant for administering the dashboard itself and not any specific project. Users with the Root role can view the Inception project.
Users with the Root role can also assign Root roles to other dashboard users.

Please visit the [Security Setting Section](/dashboard/user-guide/settings.html#security-settings) to learn how to assign this role.
Please visit the [Security Settings Section](/dashboard/user-guide/settings.html#security-settings) to learn how to assign this role.

</conditional>

## Skills Display / Client Display

You can see what the skills profile and progress display would like for a particular user by navigating to a specific user page in the dashboard - ``Project -> Users -> Select a User -> User's Display``.
This is the same exact pluggable [Skills Display](/skills-client/#skills-display) that you would be embedding into your application so it can provide the ability to view the [Skills Display](/skills-client/#skills-display) through that user's point of view.
The client display will depict the project skills profile and user's points at that exact moment.

::: tip
We suggest visiting the [Skills Display](/skills-client/#skills-display) view often while building a skill profile to better understand how your users will view the gamification profile and their progress.
Optionally you can also [Add Events Manually](/dashboard/user-guide/skills.html#manually-add-skill-event) to better understand the client display.
:::

If your gamification profile is utilizing [Skills Versioning](/dashboard/user-guide/skills.html#skills-versioning) then you can view
what the [Skills Display](/skills-client/#skills-display) would look like for a specific version by selecting a different version in the drop-down located on the top-right of the page.

::: tip
Project administrators can now easily export transcripts for users who have made progress in the project, providing a convenient way to manage training records. To download a user's transcript, follow these steps:

- Navigate to Project > Users
- Select the desired user (User's Display page)
- Click the `Download Transcript` button at the bottom of the page

This feature offers greater flexibility and convenience for managing training records, making it easier for project
administrators to track user progress and stay organized.
:::

## Performed Skills

To see a history of a user's performed skill events please visit ``Project -> Users -> Select a User -> Performed Skills``.

![page-user-performed-skills.png](../../screenshots/admin/page-user-performed-skills.png)

Project administrators have the ability to remove individual, selected or all skill events.

* *To delete a single skill event:* click the delete button on the specific skill event row
* <em>To delete **ALL** skill events</em>: click the `Delete All` button on the top right of the table.
* To delete multiple skill events, select them and click the `Delete Selected` button

::: tip
If you remove **all** of the skill events then it will practically remove this user from this project
:::
6 changes: 3 additions & 3 deletions docs/release-notes/skills-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ To obtain deployable artifacts please visit [Distributions](/dashboard/install-g

## 4.2
<release-date date="March 2026" />
- **Holistic User Progress Views** across all projects, quizzes, and surveys that you administer
- **[Holistic User Progress Views](/dashboard/user-guide/users.html#overall-progress)** across all projects, quizzes, and surveys that you administer
- Each user's overall progress is displayed across all projects, quizzes, surveys, badges, and global badges
- Ability to easily expand a single user's progress to see details of each project and all quiz and survey attempts
- Ability to filter and sort
- Ability to export overall progress to Excel
- **Global Quiz Runs Display**
- **[Global Quiz Runs Display](/dashboard/user-guide/quizzes-and-surveys.html#global-runs)**
- Display all quiz runs across all quizzes and surveys you administer
- Ability to export quiz attempts to Excel
- **Global Metrics** display all projects, quizzes, and surveys that you administer
- **[Global Metrics](/dashboard/user-guide/metrics.html#global-metrics)** display all projects, quizzes, and surveys that you administer
- **User-Driven Settings** added ability to exclude projects and quizzes from global user progress, global quiz runs, and global metrics
- **User Progress Display for Global Badges**
- Depicts progress across levels and skills configured for the Global Badge
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/admin/component-quiz-runs-table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/admin/page-global-metrics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/admin/page-global-quiz-runs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading