Importing/updating a session (with a new group)

For information on how to create a CSV file, see Importing data using a CSV file.

Linking a session to a delivery

1. In the Bulk import data window, select Download CSV templates.

2. In your downloads, open sessions-with-delivery-in-new-groups.csv.

3. In the CSV file, populate each selection field with your information according to the entities defined in each column (in the top row of the template table).

Sample CSV format for importing a session with a new group:

session_deliveryId,group_name,group_description,group_active,session_name,session_timezone,session_startDate,session_endDate,session_submissionDate,session_waitingPageDate,session_securitySettings,session_reviewSettings,session_testRunnerAccessibilityPlugins,session_testRunnerSessionPlugins,session_reportSettings,session_readAloud,group_organizationId
MyDeliveryID,Group B,Grade 10 Math,TRUE,Session 3,Europe/Warsaw,2023-01-01T12:00:00Z,2023-12-31T12:00:00Z,2024-1-31T12:00:00Z,2022-12-1T12:00:00Z,"requireFullscreen,preventRightClickAndKeyboardShortcuts,preventScreenshot","enableTTReview","contrast,contrastToolOptions,customPointer,customPointerOptions,font,fontToolOptions,zoom","studentReport","print",content-based,root

The top line (or row) designates the entities for which you will enter values in the corresponding fields below.

Entities

Mandatory

• session_deliveryId

  • References an existing delivery.

  • Entering a value in this field is mandatory when creating a session.

  • This value can be updated until any test execution is started.

• session_name

  • The name used to identify the session in TAO Portal.

  • Entering a value in this field is mandatory when creating or updating a session.

• group_name

  • References a new group.

  • Entering a value in this field is mandatory when creating a session.

  • The assigned group (name) cannot be updated for an existing Session via CSV import. The CSV import report will display an error if the user tries to do so.

• group_organizationId

  • The organizational unit (inside the hierarchy) where the group is assigned.

  • This field is mandatory. If no value is added, the default assignment is root.

  • This field is case-sensitive.

Available

• group_description

  • A description of the new group.

• group_active

  • To create an enabled (active) or disabled (inactive) group.

  • If left empty, the default value is Active (TRUE). Add FALSE to flag the group as inactive.

  • If the numeric values 1 and 0 are used, they are automatically converted to true and false and will send a warning to the log file.

• session_description

  • A description of the session.

• session_timezone

  • The timezone in which the session will take place. It is used to interpret the date/time entered above.

  • If no timezone is selected, the default timezone of your TAO Portal will apply.

  • To view the list of available timezones:

    1. Select CREATE SESSION on the top-right of the table in the Sessions management window.

    2. In the Create Session form, view the list under Timezone.

  • A value for this field should be entered in the following format:

    • Europe/Berlin

    • America/New_York

• session_startDate

  • The date (aka Open date) when the session becomes available to test takers in the assigned group. This it is not mandatory. If left blank, the session is available as soon as it has been created.

  • The format of the start date should be based on the following example:

    • 2023-01-01T11:00:00.000Z, where the date is January 1, 2023 at 11am.

• session_endDate

  • The date (aka Close date)  when the session is no longer available to test takers in the assigned group. Any ongoing session will continue to run after this date until the test-taker submits, or until the auto submit is executed (if configured, see the option below).

  • Selecting a close date is not mandatory. If left blank, the session is available without any time limit.

  • The format of the end date should be based on the following example:

    • 2023-12-31T12:00:00.000Z, where the date is December 31, 2023 at 12pm.

• session_submissionDate

  • Any started but not submitted session will be automatically submitted on this date.

  • The format of the submission date should be based on the following example:

    • 2024-1-31T12:00:00.000Z, where the date is January 1, 2024 at 12pm.

• session_gradesNotificationStartDate

  • The date test takers will be notified when a session they have completed is graded and they can view their results. For information on restrictions for this date, see Email notification options > Notify test takers when the session results are available in Creating a session.

  • The format of the end date should be based on the following example:

    • 2023-12-31T12:00:00.000Z, where the date is December 31, 2023 at 12pm.

• session_waitingPageDate

  • This field designates when sessions with a future open date will display as Upcoming in the My Sessions tab (for test takers).

  • If you want all test takers to land on a waiting page before starting the test simultaneously, define this field with a date later than session_startDate. If it is not defined or is not later than session_startDate, then it has no effect and they will start test execution as soon as they launch the session.

  • The format of the waiting page date should be based on the following example:

    • 2022-12-1T12:00:00.000Z, where the date is December 1, 2022 at 12pm.

• session_testRunnerNotification

  • Determine which session events will trigger an email notification to be sent to enrolled test takers (if email notifications are enabled for your organization).

  • If the numeric values 1 and 0 are used, they are automatically converted to true and false for that field.

• session_securitySettings

  • Security options control the behavior of the test at runtime, particularly in relation to authorization to start a session, and test takers restrictions during a session

  • In this field, add TRUE in each column for the settings you want to enable. Leaving the value empty removes the feature.

    • requireFullscreen

      • This option forces the test-taker to go into fullscreen mode and will prevent them from moving to any other tab or windows.

    • preventRightClickAndKeyboardShortcuts

      • This option disables actions like copy/cut-paste, tab switching, open bookmarks, open developer mode, and many others.

    • requireAuthorization_pauseTestOnExist

      • This option pauses a session after any forbidden activity. A proctor is required to resume the session.

      • This option is only available when requireFullscreen is enabled.

    • preventScreenshot

      • This option disables the capability to take screenshots.

    • requireAuthorization

      • This option requires the test taker to wait for the proctor to authorize the state of the session before starting their test

  • If the numeric values 1 and 0 are used, they are automatically converted to true and false and will send a warning to the logfile.

• session_securitySettings_disableCommandsConfig

  • Disable certain keyboard commands.

  • Use the numeric value 1 or 2 for true or false respectively.

  • For shortcutWhitelist_shortcut and shortcutWhitelist_platform, add which platform specific short cuts should be disabled, and which platform they apply to. Add text to both of these fields, with a line | separating each shortcut/platform (no spaces).

• session_reviewSettings

  • In this field, add TRUE in each column for the settings you want to enable. Leaving the value empty removes the feature.

    • enableTTReview_showCorrectAnswers

      • This option shows test takers the correct answer on top of their own answers.

    • enable_TTReview_showScores

      • This option permits test takers to view the scores of the group.

    • enableTTReview

      • This option enables the capability to review the test as it was submitted, showing all the answers provided by the test taker.

    • enableTTReview_autoReviewAfterSessionFinished

      • Enabling this option allows test takers to review the session immediately after submitted it. The test taker will be redirected to the session review upon submission.

      • This setting requires enableTTReview to be set to true.

  • If the numeric values 1 and 0 are used, they are automatically converted to true and false respectively and will send a warning to the logfile.

• session_testRunnerAccessibilityPlugins

  • The Accessibility options control which supplementary tools will be available to test takers during a session. For more information on each accessibility option, see the Accessibility options in Creating a session.

  • In this field, provide the accessibility tools you want to activate as a list in quotes (with each setting separated by a comma):

    • contrast

    • contrastToolOptions

    • customPointer

    • customPointerOptions

    • font

    • fontToolOptions

    • zoom

• session_testRunnerSessionPlugins

  • In this field, adding "print" hides the option to print during the session (if allowing printing was configured at the test level).

    • If a value is not provided, by default the option to print is not hidden.

• session_reportSettings

  • In this field, adding “studentReport" allows test takers to view a report of their performance.

• session_scoreSettings

  • startDate: The start date for the session to be open to scorers. Provide a value as a date in ISO 8601 format (for example, 2025-02-16T23:59:59Z).

  • endDate: The end date for when the session closes to scorers. Provide a value as a date in ISO 8601 format (for example, 2025-02-16T23:59:59Z)

  • reviewStartDate: If read-behind is enabled (see below), this field is the start date of the review portion of the read behind scoring process. Provide a value as a date in ISO 8601 format (for example, 2025-02-16T23:59:59Z)

  • reviewEndDate: The date the session closes for reviewers. Provide a value as a date in ISO 8601 format (for example, 2025-02-16T23:59:59Z)

  • readBehind: Enable read behind scoring for the session. Enter 0 to disable and 1 to enable.

  • readBehindPercentage: The percentage of tests the score reviewer will view for read-behind scoring. Add a numeric value (such as 50 for 50% of tests).

  • anonymous: Designate if scorers and score reviewers should be anonymous. Enter 0 to disable, enter 1 to enable.

• session_testRunnerReviewSettings

  • autoReview: Enter 1 to automatically start the review right after finished session. This displays the test review to the test taker immediately upon submitting the test. The session will also appear in Finished Sessions once the test taker has exited out of the review.

  • showUnShuffled: Enter 1 to enable. If enabled, responses display in their original order (regardless of whether item shuffling is enabled) during test review sessions by session administrators.

  • spellchecker_providerId: Designate that the test taker’s browser native spellcheck will be used, or disable spellcheck for test takers. Enter either native or disabled.

• session_readAloud

  • When enabled, this tool acts as a screen reader in the defined language of the current question. By default, this option is content based and will be available only during specific interactions.

  • In this field, provide one of the following values:

    • "content-based"

    • "always-enabled" (overrides configuration at the test level)

    • "always-disabled" (overrides configuration at the test level)

• session_waitingPageTitle: Add a title for the session waiting page (if enabled by session_waitingPageDate, see above).

Updating a session in an existing group

1. You can update any entities/values when updating a session via CSV import.

2. If a value in a column is left blank, the corresponding value is removed (if it is not mandatory, otherwise it will trigger an error).

3. If a value in a column has a new value, it will replace the previous value.

4. If the column is removed, the existing value will be kept.