Skip to content

Commit 415ffcb

Browse files
authored
Merge pull request #370 from NationalSecurityAgency/5_0_features
5 0 features
2 parents e4e14eb + 351173b commit 415ffcb

9 files changed

Lines changed: 254 additions & 34 deletions

File tree

‎docs/dashboard/install-guide/config.md‎

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -782,9 +782,9 @@ Generally gc logging is only enabled in development deployments.
782782

783783
### HttpStore
784784
When deploying more than 1 instance of ``skills-service`` HttpSession must be persisted centrally.
785-
SkillTree supports storing HttpSession in Postgres via JDBC or in Redis.
785+
SkillTree supports storing HttpSession in PostgreSQL via JDBC.
786786

787-
**Option 1:** HttpStore persisted in PostgreSQL (Recommended)
787+
Configure HttpStore persistence in the shared SkillTree PostgreSQL database:
788788
```properties
789789
spring.session.store-type=jdbc
790790
spring.session.jdbc.initialize-schema=always
@@ -793,21 +793,6 @@ spring.session.jdbc.initialize-schema=always
793793
server.servlet.session.timeout=
794794
```
795795

796-
**Option 2:** HttpStore persisted in Redis
797-
```properties
798-
spring.session.store-type=redis
799-
spring.data.redis.host=localhost
800-
spring.data.redis.password=
801-
spring.data.redis.port=6379
802-
803-
# Optional: Flush mode
804-
spring.session.redis.flush-mode=on_save
805-
# Optional: Stores session namespace to use for the keys
806-
spring.session.redis.namespace=spring:session
807-
# Optional: can specify duration suffix but if omitted then it defaults to seconds
808-
server.servlet.session.timeout=
809-
```
810-
811796
### https SSL (Pass Auth Mode Only)
812797
<Content path="/dashboard/install-guide/common/ssl-props.md"/>
813798

‎docs/dashboard/install-guide/prodInstall.md‎

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,4 +78,49 @@ If ``User Info Service`` utilizes 2-way SSL then add the following client authen
7878

7979
## Version 5 Migration Guide
8080

81-
TBD - Describe the steps to upgrade from version 4 to 5
81+
skills-service version 5.0 introduces changes to database migrations, skills-client compatibility, and HTTP session storage. Review the requirements below before upgrading and coordinate the service deployment with any client application and configuration updates.
82+
83+
For existing installations, complete the database migrations in version 4.6 before deploying version 5.0. Upgrade integrated applications to skills-client **3.6.5 or later** at the same time, and switch Redis-backed HTTP session storage to JDBC if applicable.
84+
85+
### Database Migration: Liquibase to Flyway
86+
87+
Starting with version 5.0, SkillTree uses Flyway instead of Liquibase to manage database schema migrations. Existing installations must complete the version 4.6 database migrations before upgrading to version 5.0 so that the database has the required Liquibase migration history.
88+
89+
For an existing installation running a version earlier than 4.6:
90+
91+
1. Upgrade skills-service to version 4.6 using the existing SkillTree database.
92+
2. Allow version 4.6 to start successfully and complete its database migrations.
93+
3. Upgrade skills-service to version 5.0 using that same database.
94+
95+
If your installation is already running version 4.6 and its database migrations have completed, you can proceed with the upgrade to version 5.0.
96+
97+
Before Flyway runs its migrations, SkillTree checks the existing Liquibase migration history for the required version 4.6 migration record. If that record is missing, the upgrade is blocked with the following error:
98+
99+
```text
100+
In the 5.0 major release, the Liquibase database migration library was replaced with Flyway. To ensure a proper database schema migration, you must first upgrade to the 4.6 release before upgrading to 5.0
101+
```
102+
103+
If you encounter this error, run version 4.6 against the database and allow its migrations to complete before retrying the version 5.0 upgrade.
104+
105+
New installations without a Liquibase `databasechangelog` table do not require the intermediate upgrade to version 4.6.
106+
107+
### Upgrade Integrated skills-client Applications
108+
109+
Applications that integrate with SkillTree using [skills-client](/skills-client/js.html) must use skills-client version **3.6.5 or later** when skills-service is upgraded to version **5.0**.
110+
111+
Coordinate any required client application upgrades with the skills-service 5.0 deployment so that all integrated applications use a compatible skills-client version at the same time.
112+
113+
### Migrate Redis HttpStore to JDBC
114+
115+
Version 5.0 removes Redis support for HTTP session storage (HttpStore). If your installation stores sessions in Redis, switch to JDBC-backed session storage in the shared SkillTree PostgreSQL database when upgrading skills-service.
116+
117+
Replace `spring.session.store-type=redis` with the following configuration on every skills-service instance:
118+
119+
```properties
120+
spring.session.store-type=jdbc
121+
spring.session.jdbc.initialize-schema=always
122+
```
123+
124+
Remove the Redis session configuration properties, including `spring.data.redis.host`, `spring.data.redis.password`, `spring.data.redis.port`, `spring.session.redis.flush-mode`, and `spring.session.redis.namespace`. Continue using `server.servlet.session.timeout` to configure session duration, if needed.
125+
126+
Existing Redis sessions are not transferred to the JDBC session store, so users will need to sign in again after the switch. See [HttpStore configuration](/dashboard/install-guide/config.html#httpstore) for JDBC session settings.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Administrators can allow participants to download video and audio files directly from the player's control bar. Downloads are disabled by default and configured separately for each media item, including media attached to skills, quiz questions, and survey questions.
2+
3+
To enable downloads:
4+
5+
1. Open the skill's **Audio/Video** page, or click **Add Audio/Video** next to a quiz or survey question.
6+
2. Upload a file or configure an external media URL.
7+
3. Turn on **Allow Downloads**.
8+
4. Click **Save and Preview** to save the setting and verify that the download button appears in the player.
9+
10+
The setting applies to both video and audio, whether uploaded to SkillTree or hosted externally. For externally hosted media, the browser and external server determine whether the file is saved directly or opened in a new tab.
11+
12+
To remove the download button, turn off **Allow Downloads** and save the settings. Selecting a new upload or switching between upload and external-link modes resets this setting to disabled; enable it again if you want the replacement media to be downloadable.
13+
14+
Downloading a file does not count as watching or listening to it and does not award playback-based skill credit.

‎docs/dashboard/user-guide/projects.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -318,6 +318,8 @@ Skills can be copied individually or in batches from one project to another. To
318318

319319
Once the copy operation is initiated, you will be guided through the process of selecting a destination project and subject or skill group.
320320

321+
The destination can be a hidden subject or a skill group within a hidden subject. Copied skills are created as hidden so you can prepare and review the content before making it available to trainees. See [Copying Skills into Hidden Subjects](/dashboard/user-guide/skills.html#copying-skills-into-hidden-subjects) for the workflow and visibility details.
322+
321323
::: tip
322324
After copying skills, the new skills become independent of the originals, and any changes made to the originals will not affect the copied skills.
323325
:::

‎docs/dashboard/user-guide/quizzes-and-surveys.md‎

Lines changed: 155 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,12 @@ A quiz is a knowledge check composed of multiple questions with a passing requir
4444
or can be executed independently. Associating a Quiz to an existing skill will require successful completion of that Quiz
4545
in order to earn the skill and its points. In the case of a quiz, then the quiz serves as the skill's knowledge check.
4646

47-
Quizzes support three types of questions:
48-
- ``Multiple Choice`` - Single correct answer
49-
- ``Multiple Answers`` - Multiple correct choices; all must be selected to earn credit
50-
- ``Input Text`` - Free-form text response, graded by quiz administrators
51-
- ``Matching`` - Match items from one list with their correct matches in another list
47+
Quizzes support five types of questions:
48+
- [Multiple Choice](#multiple-choice-questions) - Single correct answer
49+
- [Multiple Answers](#multiple-answers-questions) - Multiple correct choices; all must be selected to earn credit
50+
- [Input Text](#input-text-questions) - Free-form text response, graded manually or with AI when configured
51+
- [Matching](#matching-questions) - Match items from one list with their correct matches in another list
52+
- [Fill-in-the-Blank](#fill-in-the-blank-questions) - Enter missing words or phrases; answers are automatically graded against the accepted answers configured for each blank
5253

5354
To administer a quiz click `Manage` button for that quiz on the `Quizzes and Surveys` page.
5455

@@ -73,6 +74,118 @@ Use the `Preview` button on the top left below the Quiz name in order to see wha
7374
Did you know, you can use **SkillTree's AI Assistant** to generate quiz questions, [Learn more](/dashboard/user-guide/ai-assistant.html#ai-powered-single-quiz-question-generation)
7475
:::
7576

77+
### Multiple Choice Questions
78+
79+
Multiple Choice questions let participants select one answer from a list of options. This question type is available for both quizzes and surveys. Quiz answers are automatically graded; survey responses have no correct or incorrect answer.
80+
81+
To create a Multiple Choice question:
82+
83+
1. Click `Question +`, or edit an existing question.
84+
2. Select `Multiple Choice` from the question type dropdown.
85+
3. Enter the question text and at least two answer options under **Answers**.
86+
4. For a quiz, check exactly one correct answer on the left. For a survey, enter the options without selecting a correct answer.
87+
5. Save the question and use `Preview` to check how it appears to participants.
88+
89+
For example:
90+
91+
```text
92+
Question: Which planet is closest to the Sun?
93+
Options: Mercury, Venus, Earth, Mars
94+
Correct answer: Mercury
95+
```
96+
97+
Participants can select only one option. On a quiz, selecting the configured correct answer earns credit for the question.
98+
99+
### Multiple Answers Questions
100+
101+
Multiple Answers questions let participants select more than one option. This question type is available for both quizzes and surveys. Quiz answers are automatically graded; surveys collect selections without grading them.
102+
103+
To create a Multiple Answers question:
104+
105+
1. Click `Question +`, or edit an existing question.
106+
2. Select `Multiple Answers` from the question type dropdown.
107+
3. Enter the question text and at least two answer options under **Answers**.
108+
4. For a quiz, check two or more correct answers on the left. For a survey, enter the options without selecting correct answers.
109+
5. Save the question and use `Preview` to check how it appears to participants.
110+
111+
For example:
112+
113+
```text
114+
Question: Which of these are primary colors of light? Select all that apply.
115+
Options: Red, Green, Blue, Yellow
116+
Correct answers: Red, Green, Blue
117+
```
118+
119+
On a quiz, participants must select all correct options and no incorrect options to earn credit for the question; partial credit is not awarded. On a survey, participants select one or more options that apply to them.
120+
121+
### Input Text Questions
122+
123+
Input Text questions let participants write a free-form response instead of choosing from predefined options. This question type is available for both quizzes and surveys. Quiz responses require [manual grading](#manual-answer-grading) or [AI grading](#ai-powered-grading) when configured; survey responses are collected without grading.
124+
125+
To create an Input Text question:
126+
127+
1. Click `Question +`, or edit an existing question.
128+
2. Select `Input Text` from the question type dropdown.
129+
3. Enter the question text, including any instructions about what the response should cover.
130+
4. Save the question. You do not need to enter answer options; the disabled text area in the editor represents the participant's response field.
131+
5. Use `Preview` to check how it appears to participants.
132+
133+
For example:
134+
135+
```text
136+
Question: Explain how you would identify and report a phishing email.
137+
```
138+
139+
For manually graded quizzes, administrators mark each response as correct or wrong after submission. If AI grading is enabled for the question, the configured AI grader evaluates the response. Unlike Fill-in-the-Blank questions, Input Text responses are not automatically checked against a list of accepted words or phrases.
140+
141+
### Matching Questions
142+
143+
Matching questions ask participants to match terms with their corresponding values, such as definitions, categories, or related concepts. This question type is available for quizzes, not surveys, and is automatically graded.
144+
145+
To create a Matching question:
146+
147+
1. Click `Question +`, or edit an existing quiz question.
148+
2. Select `Matching` from the question type dropdown.
149+
3. Enter the question text with instructions about what participants should match.
150+
4. Under **Answers**, enter at least two pairs, with a term on the left and its matching value on the right. Use the `+` and `-` buttons to add or remove pairs.
151+
5. Provide text for both parts of every pair. Terms must be unique, and matching values must also be unique.
152+
6. Save the question and use `Preview` to check how it appears to participants.
153+
154+
For example:
155+
156+
```text
157+
Question: Match each country with its capital.
158+
Pairs:
159+
France -> Paris
160+
Japan -> Tokyo
161+
Canada -> Ottawa
162+
```
163+
164+
Each configured pair defines a correct match; you do not need to check correct-answer boxes. Participants must match every pair correctly to earn credit for the question; partial credit is not awarded.
165+
166+
### Fill-in-the-Blank Questions
167+
168+
Fill-in-the-Blank questions let participants complete a statement by entering missing words or phrases directly into the question. This question type is available for quizzes, not surveys, and does not require manual or AI grading.
169+
170+
To create a Fill-in-the-Blank question:
171+
172+
1. Click `Question +`, or edit an existing quiz question.
173+
2. Select `Fill In the Blank` from the question type dropdown.
174+
3. Insert a sequence of two or more underscores, such as `___`, wherever an answer should go in the question text. Each sequence creates one blank.
175+
4. Enter the correct answer for each blank in the corresponding field under **Answers**, in the order the blanks appear in the question.
176+
5. To accept more than one answer for a blank, separate the alternatives with a semicolon (`;`).
177+
6. Save the question and use `Preview` to check how it appears to participants.
178+
179+
For example:
180+
181+
```text
182+
Question: The capital of France is ___, and the capital of the United States is ___.
183+
Answer for blank 1: Paris
184+
Answer for blank 2: Washington, D.C.;Washington DC;Washington
185+
```
186+
187+
A question must contain at least one blank, and every blank must have a configured answer. Participants must fill in every blank before submitting the quiz. Answers are matched against the configured alternatives without regard to capitalization or leading and trailing spaces. All blanks must be answered correctly to earn credit for the question; partial credit is not awarded.
188+
76189
### Answer Hints
77190

78191
When creating a question, quiz administrators can configure helpful answer hints, which are displayed next to the
@@ -125,6 +238,10 @@ Similarly to videos, users can embed audio clips into their quizzes using the `A
125238

126239
<Content path="/dashboard/user-guide/common/audio.md"/>
127240

241+
#### Video and Audio Downloads for Quiz
242+
243+
<Content path="/dashboard/user-guide/common/media-downloads.md"/>
244+
128245
### Manual Answer Grading
129246

130247
If a quiz has at least 1 ``Input Text`` question then after a quiz taker submits an attempt a quiz administrator will be able to grade the answers for the ``Input Text`` questions.
@@ -319,10 +436,10 @@ When associated to a skill, the survey is a method to gather feedback about that
319436
pieces of important data related to the skill.
320437

321438
A Survey currently supports four types of questions:
322-
- ``Multiple Choice`` - question will only allow a single choice to be selected
323-
- ``Multiple Answers`` - one or more choices are required to be selected
324-
- ``Text Input`` - a freeform answer text is required
325-
- ``Rating`` - a star-based rating question with an ability configure between 3 and 10 stars
439+
- [Multiple Choice](#multiple-choice-questions) - Select a single option
440+
- [Multiple Answers](#multiple-answers-questions) - Select one or more options
441+
- [Input Text](#input-text-questions) - Provide a free-form text response
442+
- [Rating](#rating-questions) - Select a star-based rating on a scale of 3 to 10 stars
326443

327444
To administer a survey click the `Manage` button for that survey on the `Quizzes and Surveys` page.
328445

@@ -344,6 +461,27 @@ Please use the Answer's dropdown to select the type.
344461
Use the `Preview` button on the top left below the Survey name in order to see what the survey will look like to your users.
345462
:::
346463

464+
### Rating Questions
465+
466+
Rating questions collect feedback using a star-based scale. This question type is available for surveys, not quizzes. Responses are collected without grading.
467+
468+
To create a Rating question:
469+
470+
1. Click `Question +`, or edit an existing survey question.
471+
2. Select `Rating` from the question type dropdown.
472+
3. Enter the question text and explain what the low and high ends of the scale represent.
473+
4. Select a **Scale** from 3 to 10 stars. The default is 5 stars; no answer options are required.
474+
5. Save the question and use `Preview` to check how it appears to participants.
475+
476+
For example:
477+
478+
```text
479+
Question: How useful was this training? Rate from 1 star (not useful) to 5 stars (very useful).
480+
Scale: 5
481+
```
482+
483+
Participants select a rating from one star up to the configured maximum. There is no correct or incorrect rating.
484+
347485
### Slide Deck for Survey
348486

349487
SkillTree enables seamless integration of PDF-based slide decks directly into surveys, allowing you to enhance training
@@ -382,6 +520,10 @@ Similarly to videos, users can embed audio clips into their surveys using the `A
382520

383521
<Content path="/dashboard/user-guide/common/audio.md"/>
384522

523+
#### Video and Audio Downloads for Survey
524+
525+
<Content path="/dashboard/user-guide/common/media-downloads.md"/>
526+
385527
### Survey Settings
386528

387529
A Survey has customization parameters, to customize a survey please navigate to ``Quizzes and Surveys -> Survey -> Settings`` page.
@@ -526,6 +668,10 @@ A quiz/survey administrator can easily view which skills the quiz/survey is asso
526668
to the Skills page in that particular quiz/survey (``Quizzes and Surveys -> Quiz/Survey -> Skills ``)
527669
![Quiz Skills Page Screenshot](../../screenshots/admin/page-quiz-skills.png):
528670

671+
The **Associated Skills** table lists each skill's project ID, name, and skill ID. Use the **Skill Filter** to find skills by name. For projects you can administer, the project ID and skill name link to their administration pages.
672+
673+
For projects you cannot administer, a **Contact** button appears next to the project ID. Click **Contact**, enter a message, and click **Send** to email that project's administrators. This lets quiz and survey administrators coordinate changes to associated training content with the administrators who manage it.
674+
529675
## Access
530676

531677
The Quiz/Survey Access page supports adding or removing Quiz Administrators. To add and remove Administrators

0 commit comments

Comments
 (0)