Importing a battery via CSV
Batteries can be launched on the TAO Portal by assigning an existing battery to a session via CSV import.
For information on how to create a CSV file, see Importing data using a CSV file.
A simple way to create a CSV file for launching a battery is to download a premade template (and changing the delivery ID field to a field for the battery ID). Complete the following steps:
In the Bulk import data window, select Download CSV templates.
In your downloads, open
sessions-with-delivery-in-existing-groups.csv
.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). For batteries, change the first column name from
session_deliveryId
tosession_batteryId
.
Sample CSV file format for importing a session with an existing battery and group:
session_batteryId,group_name,session_name,session_timezone,session_startDate,session_endDate,session_submissionDate,session_waitingPageDate,session_securitySettings,session_reviewSettings,session_waitingPageDate,session_testRunnerAccessibilityPlugins,session_testRunnerSessionPlugins,session_reportSettings,session_readAloud
MyBatteryID,Group B,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
The top line (or row) designates the entities for which you will enter values in the corresponding fields.
Entities
Mandatory
session_batteryId
The ID of an existing battery, which can be retrieved from the list in the main Batteries interface.
Entering a value for this field is mandatory.
group_name
References an existing 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.
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.
Available
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:
Select CREATE SESSION on the top-right of the table in the Sessions management window.
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 in which email notifications (if enabled) with results will be sent (rather than as soon as results are available). For more information on enabling email notifications, see Customizing an account in the TAO Portal.
The format of this date should be based on the following example:
2024-1-31T12:00:00.000Z
, where the date is January 1, 2024 at 12pm.
session_waitingPageDate
The date in which the waiting page is available for test takers.
The format of this date should be based on the following example:
2024-1-31T12:00:00.000Z
, where the date is January 1, 2024 at 12pm.
session_testRunnerNotification
: For more information on enabling email notifications, see Customizing an account in the TAO Portal.In the following fields, add
TRUE
in each column for the settings you want to enable. Leaving the value empty removes the feature:onSessionCreate
If email notifications are enabled, this option will notify test takers when a session assigned to their group is created.
onResultAvailable
If email notifications are enabled, this option will notify test takers when their session results are available.
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
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
disableCommandsConfig_canCopy
This option allows users to copy using keyboard shortcuts. If this option is not enabled,
preventRightClickAndKeyboardShortcuts
will prevent all keyboard shortcuts, including copy.
disableCommandsConfig_canPaste
This option allows users to paste using keyboard shortcuts. If this option is not enabled,
preventRightClickAndKeyboardShortcuts
will prevent all keyboard shortcuts, including copy.
disableCommandsConfig_canDragAndDrop
This option allows users to drag and drop using keyboard shortcuts. If this option is not enabled,
preventRightClickAndKeyboardShortcuts
will prevent all keyboard shortcuts, including drag and drop.
disableCommandsConfig_ShortcutWhitelist_shortcut
Use this option in combination with disableCommandsConfig_ShortcutWhitelist_platform to list out allowed keyboard shortcuts.
List this value as each keyboard command separated by a vertical bar. Example:
Meta+C|Meta+V
(for Mac).
disableCommandsConfig_ShortcutWhitelist_platform
Use this option in combination with disableCommandsConfig_ShortcutWhitelist_shortcut to list the platform on which the listed keyboard shortcuts are valid.
List this value as each platform according to the commands listed in disableCommandsConfig_ShortcutWhitelist_shortcut, which each platform separated by a vertical bar. Example:
Mac|Mac
(for keyboard shortcutsMeta+C|Meta+V
listed above).
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_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.
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_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"
(including quotations) allows test takers to view a report of their performance.
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 (including quotations):
"content-based"
"always-enabled"
(overrides configuration at the test level)"always-disabled"
(overrides configuration at the test level)