Skip to content

Definition Changelog

You might find useful

0.24.7

Added an option to questionnaires to show the correctness of a questionnaire submission.

questionnaires.yml

  • added new optional field show_feedback

0.24.6

Added new object llm assessment for the free-form questions and email addresses. This object contains the following attributes:

  • persona or persona_path: The system prompt for the LLM defining the behaviour and persona of the LLM
  • assessment or assessment_path: Prompt with specific task context and instructions for assessment.

email.yml

  • added optional field llm_assessment to email addresses

questionnaires.yml

  • added optional field llm_assessment to free-form question

0.24.5

Added an option to specify a whitelist of file types that can be uploaded during an exercise.

config.yml

  • added field allowed_file_types

0.24.4

Allow empty answers for free-form questions.

questionnaires.yml

  • changed default value of min field to 0 on free-form questions, auto-free-form questions still have 1 as default and do not accept 0

0.24.3

Add optional fields and one required field to config.yml

config.yml

  • added required field name
  • added field exercise_type
  • added field instructor_required
  • added field license
  • added field language
  • added field goals
  • added field external_resources
  • added field authors
  • added field notes

0.24.2

Add show_exercise_overview field to config.yml. Shows the performance overview to trainees when the exercise is over.

config.yml

  • added field show_exercise_overview

0.24.1

Add delay field to questionnaires. Allows scheduling the sending of a questionnaire.

questionnaires.yml

  • added delay field to questionnaires

0.24.0

Changed how final field functions on milestones. It now finishes the exercise for the team when one of the final milestones is reached. For synchronous exercises, all teams must reach the final milestone for the exercise to stop

No format changes

0.23.3

Remove correct field length requirement from multiple-choice questions

questionnaires.yml

  • correct field now accepts 1 or more values (changed from 2 or more)

0.23.2

Add option to make a questionnaire repeatable. Removed requirement to have at least one of correct/incorrect fields specified in auto-free-form questions.

questionnaires.yml

  • added optional field repeatable to questionnaires

0.23.1

Add more links between definition objects and learning activities.

objectives.yml

  • added field tools to learning activities
  • added field injects to learning activities
  • added field addresses to learning activities
  • added field questionnaires to learning activities

0.23.0

Add names and display names to some objects.

injects.yml

  • added field display_name to injects

tools.yml

  • added field display_name to tools

questionnaires.yml

  • added required field name to questionnaires
  • changed field title to display_name on questionnaires

0.22.3

Add an optional field to questionnaires to allow submitting answers after the exercise has finished.

questionnaires.yml

  • added field post_exercise_submission to questionnaires

0.22.2

Add an optional internal drive feature. Files in the drive will be visible to everyone in the exercise. To add a drive, simply create a drive directory with files in the definition.

0.22.1

Add an option to specify that an email address is digitally signed.

email.yml

  • added field signed to email address

0.22.0

Add a field for instructor notes. Make overlay duration optional

common definitions

  • the overlay duration field is now optional

config.yml

  • added field instructor_notes

0.21.0

Allow multiple file attachments in content objects.

common definitions

  • removed field file_name from content objects
  • added field attachments to content objects

0.20.3

Add option to assign score to milestones.

milestones.yml

  • add optional field score to milestones

0.20.2

Add new question type for multiple-choice questions.

questionnaires.yml

  • add new question type multiple-choice

0.20.1

Add option to modify the tool usage button caption and specify minimum and maximum characters for free-form questions.

tools.yml

  • add optional field button_caption to tool

questionnaires.yml

  • add optional field min to free-form questions
  • add optional field max to free-form questions
  • add optional field min to auto-free-form questions
  • add optional field max to auto-free-form questions

0.20.0

Officially remove team visible milestones, including other related features.

milestones.yml

  • remove team_visible field
  • remove roles field

0.19.1

Add new question type for automatic free-form evaluation.

questionnaires.yml

  • add new question type auto-free-form

0.19.0

Replace all pseudo list fields to actual lists.

common definitions

  • change control activate_milestone field type from string to list of strings
  • change control deactivate_milestone field type from string to list of strings
  • change control roles field type from string to list of strings

objectives.yml

  • change objective tags field type from string to list of strings
  • change activity tags field type from string to list of strings

tools.yml

  • change tool roles field type from string to list of strings

milestones.yml

  • change file_names field type from string to list of strings
  • change roles field type from string to list of strings

questionnaires.yml

  • change radio question labels field type from string to list of strings

0.18.1

Add note to questions.

questionnaires.yml

  • add optional field note to question

0.18.0

Add option to tools to signify that they don't require an input. Change the type of default_response field.

tools.yml

  • add optional field requires_input to tool
  • change the type of default_response to content

0.17.2

Fixed embedding in email templates

No format changes

0.17.1

Allow embedding images and videos.

All content type fields now allow for embedding images/audio/video by using special syntax. See readme for more information.

0.17.0

Add support for markdown in questionnaires. Add missing field from tools.

questionnaires.yml

  • remove field description from questionnaire
  • add field content to questionnaire

tools.yml

  • add field category to tool

0.16.0

More definition enhancements.

config.yml

  • add field target_audience
  • add field prerequisites

objectives.yml

  • add field order to objectives
  • add field milestones to activities

milestones.yml

  • remove field activity

email.yml

  • add field subject to email templates

0.15.2

Allow exercise designers to add more information to the definition.

config.yml

  • add field description

objectives.yml

  • add field description to both objectives and activities

channels.yml

  • add field display_name
  • add field description

milestones.yml

  • add field display_name
  • add field description
  • add field tags

roles.yml

  • add field display_name
  • add field description

questionnaires.yml

  • add field description to questionnaire

0.15.1

Add confirmation button to info alternatives.

injects.yml

  • add field confirmation to info alternatives

0.15.0

Allow specifying open-ended questions in questionnaires.

questionnaires.yml

  • add field type to questions
  • add field related_milestones to free-form type questions
  • add field multiline to free-form type questions

0.14.0

Allow multiple info channels in a definition.

injects.yml

  • add field target that specifies info channel for the info injects

channels.yml

  • allow occurrence of multiple info channels

0.13.0

Enabled a more fine-grained control over milestone modifications for scale-based questions.

questionnaires.yml

  • remove field control in question objects
  • added field controls in question objects, which is a mapping of choice number to control. See definition documentation for more details.

0.12.1

Enable specification of roles in email type injects.

injects.yml

  • allow specifying roles in control blocks inside email type injects

0.12.0

Replace text field by content in Questionnaire questions. From now, the questions of questionnaires can be formatted via content.

questionnaires.yml

  • remove field text of questions
  • add field content to questions

0.11.0

Change the behavior of delay on injects. Whenever an alternative is delayed, the condition is now checked throughout the duration. If the condition becomes false, the inject is cancelled and a new alternative can be selected.

injects.yml

  • change behavior of delay field

0.10.0

Change the behavior of info alternatives. When an alternative contains no content, it will not create an action log.

injects.yml

  • change behavior of content field in info injects

0.9.1

Add option to specify initial state for milestones.

milestones.yml

  • add optional field initial_state

0.9.0

Removed manual injects. All injects are now considered to be automatic injects.

injects.yml

  • remove field auto

0.8.0

Add a new required concept called learning objectives. This concept must be included in all exercise definition.

objectives.yml

  • added new file

milestones.yml

  • add field activity

0.7.0

Add simple questionnaires.

channels.yml

  • add new channel type form

questionnaires.yml

  • added new file

0.6.1

Add overlay to injects.

injects.yml

  • add field overlay to info and email injects

0.6.0

Added a new concept called channels. This concept is saved in a new channels.yml file. See definition documentation for details.

config.yml

  • remove enable_email field
  • remove team_visible_milestones field, team visible milestones can now be specified without this flag

channels.yml

  • added this new required file

injects.yml

  • remove field hidden
  • rename field injects to alternatives
  • add field type to inject
  • specify new types of alternatives, see definition documentation for details.

tools.yml

  • remove old content, content_path, file_name fields
  • remove old milestone_condition, activate_milestone, deactivate_milestone, roles fields
  • add new fields content and control, see definition documentation for details.

email.yml

  • remove activate_milestone, deactivate_milestone fields from email address
  • add control field to email address
  • remove old content, content_path, file_name templates from email templates
  • remove activate_milestone, deactivate_milestone fields from templates
  • add new fields content and control to email templates, see definition documentation for details.

0.5.1

Allow using directories of files instead of single YAML files inside the definition.

0.5.0

injects.yml

  • add inject field subject

0.4.1

config.yml

  • remove team_file_upload field, the feature is now always enabled
  • remove custom_team_names field, team names have been removed from the definition, it is now a parameter when creating an exercise
  • remove team_count field, it is now a parameter when creating an exercise

teams.yml

  • temporarily removed from the definition

0.4.0

Introduce simplified syntax for activate_milestone and deactivate_milestone, which replaced the old field reach_milestone.

Instead of the old syntax from reach_milestone reminding logical condition, the new fields (de)activate_milestone have a simple enumeration of milestones, which could be separated by a comma, space, or comma followed by space.

injects.yml

  • inject field reach_milestone is replaced by fields activate_milestone and deactivate_milestone

tools.yml

  • response field reach_milestone is replaced by fields activate_milestone and deactivate_milestone

email.yml

  • email and template field reach_milestone is replaced by fields activate_milestone and deactivate_milestone

0.3.0

milestones.yml

  • add field final to milestones

0.2.0

Introduce support for markdown content in injects, tool responses and email templates.

Add new optional folder content to the definition file structure. This folder should contain markdown files which will be pointed to by content_path fields. Only one of the content, content_path fields can be set at the same time. If neither field is set, then the content is considered to be empty.

tools.yml

  • rename response field answer to content
  • add field content_path to responses

inject.yml

  • add field content_path to injects

email.yml

  • add field content_path to emails

0.1.1

email.yml

  • Add organization field to email addresses

injects.yml

  • Add organization field to inject categories

0.1.0

Initial version, no changes.