Skip to content

Commit 815464b

Browse files
LolaValenteLolaValente
authored
updated table and photo (#453)
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Restructured bulk-assignment CSV guidance into a clearer list-table format with standardized headings, updated image reference, expanded field definitions, and formatting improvements. * Added new visibility fields for completed/disabled assignments and clarified data types, possible values, and examples. * Added a January 2026 changelog note about a new Previous button appearing in guides when forward-only navigation is disabled. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent c05e1e1 commit 815464b

5 files changed

Lines changed: 97 additions & 87 deletions

File tree

‎source/img/batch-csv-test-run.png‎

10 KB
Loading

‎source/img/guides/screenshot-csv-bulk-template.png‎

65.1 KB
Loading

‎source/img/screenshot-csv-bulk-template.png‎

-69 KB
Binary file not shown.

‎source/instructors/getstarted/support/changelog.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ We do not report small bug fixes or issues that affect individual users, who we
1515

1616
**January 2026**
1717

18+
- `[F] [28th]`: A Previous button is now available in guides as long as :ref:`Forward Only Navigation <exam-proctoring>` is not enabled.
1819
- `[F] [14th]`: Added :ref:`Batch Assessment Update <batch-assessment-update>` to update assessment settings in bulk using a .xlsx file.
1920
- `[I] [7th]`: Add a way to :ref:`Enable or disable extensions on a course level <course-coach-settings>`.
2021

‎source/instructors/setupcourses/bulk-assignment-update.rst‎

Lines changed: 96 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -10,102 +10,111 @@ Bulk Assignment Update
1010
You have the ability to perform a bulk update for various assignment settings, including start date/time of the assignment, closing date/time of the assignment, action when assignment closes, due dates and penalties. For more information about these settings, see :ref:`Assignment Duration <assignment-duration>`, :ref:`Prime Assignment Containers <prime-assignment-containers>` and :ref:`Virtual Coach <enable-vc-bulk>` settings using a CSV file.
1111

1212

13-
Before you begin, make sure to download the csv template file. You can download the csv template file of your course from “Download Assignment Information” present in the “Assignment settings” in the “Bulk Settings area”. You can update the fields as per your requirement(s) and use that csv file to update the assignment settings.
14-
Here is a sample screenshot of the csv template:
13+
Before you begin, make sure to download the CSV template file. You can download the CSV template file of your course from “Download Assignment Information” present in the “Assignment settings” in the “Bulk Settings area”. You can update the fields as per your requirement(s) and use that CSV file to update the assignment settings.
14+
Here is a sample screenshot of the CSV template:
1515

1616

17-
.. image:: /img/screenshot-csv-bulk-template.png
18-
:alt: Sample csv Template
17+
.. image:: /img/guides/screenshot-csv-bulk-template.png
18+
:alt: Sample CSV Template
1919

2020

2121

22-
Things you should know about the csv template:
23-
22+
Things you should know about the CSV template:
2423
- Header names must be same as row 1 of above CSV
25-
- If the specific field is empty then the respective setting will not be updated
26-
- All field are case-insensitive so complete and COMPLETE are same
27-
- In the column 'assignment', instead of Assignment Name you can also use Assignment ID or LTI Integration URL of the assignment for the assignment identification (sometimes you may have multiple assignments with the same name so you can use these other unique identifiers to avoid any conflicts)
28-
29-
- Check out :ref:`Get the Course and Assignment ID <get-course-assignment-id>` to see how you can get the assignment ID.
30-
- Check out :ref:`LTI Integration Assignment URLs <lti-integration-assignment-urls>` to see how you can get LTI Integration URL of the assignment or you can export the LTI Integration URLs of all assignments in the course, see :ref:`Export LTI Settings <export-lti>`
24+
- If a specific field is empty then the respective setting will not be updated
25+
- All fields are case-insensitive so complete and COMPLETE are same
3126
- If :ref:`Prime Setting <prime-assignment-containers>` is not enabled for the assignment but the prime_time is defined in the CSV then the Prime setting will be enabled automatically
3227

3328

3429

3530

36-
**Here is a reference guide on how to update your csv template file:**
37-
38-
39-
+-------------------------------+---------------+------------------------+--------------------------------------------------------------------------------------+
40-
| Column Name | Data Type | Possible Values | Description |
41-
+===============================+===============+========================+======================================================================================+
42-
| name | text | assignment name(s) | The assignment name goes in this cell. |
43-
+-------------------------------+---------------+------------------------+--------------------------------------------------------------------------------------+
44-
| start_time | integer | mm/dd/yyyy h:mm XX | Specify the start time, date (m/d/year) and the time (h:mm) and identify if its |
45-
| | and text | 5/2/2025 9:11 AM | morning or night (XX). |
46-
+-------------------------------+---------------+------------------------+--------------------------------------------------------------------------------------+
47-
| closing_time | integer | mm/dd/yyyy h:mm XX | Specify the closing time, the date (m/d/year) and the time (h:mm) and identify if |
48-
| | and text | 05/26/2025 11:59 PM | its morning or night (XX). |
49-
+-------------------------------+---------------+------------------------+--------------------------------------------------------------------------------------+
50-
| closing_action | text | DISABLE_AND_COMPLETE, | Specify what action you want to take when the assignment closes. You currently |
51-
| | | DISABLE, COMPLETE | have 3 options: |
52-
| | | | |
53-
| | | | 1. Disable assignment and mark as complete |
54-
| | | | |
55-
| | | | 2. Disable assignment |
56-
| | | | |
57-
| | | | 3. Mark as complete |
58-
+-------------------------------+---------------+------------------------+--------------------------------------------------------------------------------------+
59-
| due_at | integer | mm/dd/yyyy h:mm XX | Specify the due date, the date (m/d/year) and the time (h:mm) and identify if its |
60-
| | and text | 05/23/2025 11:59 PM | morning or night (XX). |
61-
| | | | |
62-
| | | | Note: For more information about this setting please visit |
63-
| | | | :ref:`Assignment Duration <assignment-duration>` |
64-
+-------------------------------+---------------+------------------------+--------------------------------------------------------------------------------------+
65-
| mark_as_completed_on_due_date | text | TRUE, | Identify whether you would like the assignment to be marked completed on the due |
66-
| | | FALSE | date. |
67-
+-------------------------------+---------------+------------------------+--------------------------------------------------------------------------------------+
68-
| penalty_enabled | text | TRUE, | Identify if you want there to be a penalty for late submission of the assignment. |
69-
| | | FALSE | |
70-
+-------------------------------+---------------+------------------------+--------------------------------------------------------------------------------------+
71-
| deduction_interval | text | day, | If you have elected to have a penalty (penalty_enabled: TRUE), then in this cell |
72-
| | | hour | you identify if you want the deduction to be by hour or by day after the due date. |
73-
+-------------------------------+---------------+------------------------+--------------------------------------------------------------------------------------+
74-
| deduction_percent | integer | any whole number | If you have elected to have a penalty (penalty_enabled: TRUE), then in this cell |
75-
| | | | you identify the deduction percentage. If you want to deduct 5%, then you would |
76-
| | | | just put "5". |
77-
+-------------------------------+---------------+------------------------+--------------------------------------------------------------------------------------+
78-
| lowest_grade_percent | integer | any whole number | Identify the lowest possible grade a student can receive for this assignment. |
79-
| | | between 0 and 100 | |
80-
| | | | Note: For more information on penalty deductions, please |
81-
| | | | :ref:`Penalties <penalties>` |
82-
+-------------------------------+---------------+------------------------+--------------------------------------------------------------------------------------+
83-
| allow_regrade_request | text | TRUE, | Identify if you want to allow students to request for a regrade of their |
84-
| | | FALSE | assignment. |
85-
+-------------------------------+---------------+------------------------+--------------------------------------------------------------------------------------+
86-
| prime_time | integer | mm/dd/yyyy h:mm XX | Specify the Start Time when you want the containers available. |
87-
| | and text | 05/08/2025 06:44 PM | |
88-
| | | | Note: For more information about this setting, please visit |
89-
| | | | :ref:`Prime Assignment Containers <prime-assignment-containers>` |
90-
+-------------------------------+---------------+------------------------+--------------------------------------------------------------------------------------+
91-
| prime_count | integer | any whole number | In this cell you will specify the Number of Students that will start the |
92-
| | | | assignment at the same time. |
93-
| | | | |
94-
| | | | Note: For more information about this setting, please visit |
95-
| | | | :ref:`Prime Assignment Containers <prime-assignment-containers>` |
96-
+-------------------------------+---------------+------------------------+--------------------------------------------------------------------------------------+
97-
| coach_summarize_prompt | text | TRUE, | Identify whether the student can request a summary of the assessment prompt or not. |
98-
| | | FALSE | |
99-
+-------------------------------+---------------+------------------------+--------------------------------------------------------------------------------------+
100-
| coach_error_augmentation | text | TRUE, | Identify whether you want to provide more detailed explanations for error message |
101-
| | | FALSE | text on request. |
102-
+-------------------------------+---------------+------------------------+--------------------------------------------------------------------------------------+
103-
| coach_next_steps_hint | text | TRUE, | Identify whether the student can request hints for completing the assessment |
104-
| | | FALSE | requirements. |
105-
+-------------------------------+---------------+------------------------+--------------------------------------------------------------------------------------+
106-
107-
108-
Once you have updated/modified your csv template file now you are ready to bulk update the assignment settings.
31+
**Here is a reference guide on how to update your CSV template file:**
32+
33+
34+
.. list-table:: Assignment Configuration Fields
35+
:header-rows: 1
36+
:widths: 15 10 10 65
37+
38+
* - Column Name
39+
- Data Type
40+
- Possible Values
41+
- Description
42+
* - name
43+
- text
44+
- assignment name(s)
45+
- The name of the assignment.
46+
* - visibility_on_completed
47+
- text
48+
- READ_ONLY_WITH_RESUBMIT, READ_ONLY, NO_ACCESS, NO_ACCESS_UNTIL_GRADES_RELEASED
49+
- Access students have to a completed assignment.
50+
* - visibility_on_disabled
51+
- text
52+
- NO_ACCESS, READ_ONLY, NO_ACCESS_UNTIL_GRADES_RELEASED
53+
- Access students have to a disabled assignment.
54+
* - start_time
55+
- integer and text
56+
- mm/dd/yyyy h:mm AM/PM (e.g., 05/02/2025 9:11 AM)
57+
- Start date (mm/dd/yyyy), time (h:mm), and AM or PM.
58+
* - closing_time
59+
- integer and text
60+
- mm/dd/yyyy h:mm AM/PM (e.g., 05/26/2025 11:59 PM)
61+
- Closing date (mm/dd/yyyy), time (h:mm), and AM or PM.
62+
* - closing_action
63+
- text
64+
- DISABLE_AND_COMPLETE, DISABLE, COMPLETE
65+
- Actions to take when the assignment closes.
66+
* - due_at
67+
- integer and text
68+
- mm/dd/yyyy h:mm AM/PM (e.g., 05/23/2025 11:59 PM)
69+
- Due date (mm/dd/yyyy), time (h:mm), and AM or PM. For more information, see :ref:`Assignment Duration <assignment-duration>`.
70+
* - mark_as_completed_on_due_date
71+
- text
72+
- TRUE, FALSE
73+
- Marked completed on the due date.
74+
* - penalty_enabled
75+
- text
76+
- TRUE, FALSE
77+
- Penalty for late submission of the assignment.
78+
* - deduction_interval
79+
- text
80+
- day, hour
81+
- Penalty deduction interval
82+
* - deduction_percent
83+
- integer
84+
- any whole number
85+
- Penalty deduction percent
86+
* - lowest_grade_percent
87+
- integer
88+
- any whole number between 0 and 100
89+
- Lowest possible grade a student can receive for this assignment. Note: For more information on penalty deductions, please see :ref:`Penalties <penalties>`.
90+
* - allow_regrade_request
91+
- text
92+
- TRUE, FALSE
93+
- Allow students to request for a regrade of their assignment.
94+
* - prime_time
95+
- integer and text
96+
- mm/dd/yyyy h:mm AM/PM (e.g., 05/08/2025 6:44 PM)
97+
- Start time when you want the containers available. For more information, see :ref:`Prime Assignment Containers <prime-assignment-containers>`.
98+
* - prime_count
99+
- integer
100+
- any whole number
101+
- Number of students that will start the assignment at the same time. Note: For more information about this setting, please visit :ref:`Prime Assignment Containers <prime-assignment-containers>`
102+
* - coach_summarize_prompt
103+
- text
104+
- TRUE, FALSE
105+
- Student can request a summary of the assessment prompt.
106+
* - coach_error_augmentation
107+
- text
108+
- TRUE, FALSE
109+
- Provide more detailed explanations for error message text on request.
110+
* - coach_next_steps_hint
111+
- text
112+
- TRUE, FALSE
113+
- Student can request hints for completing the assessment requirements.
114+
115+
116+
117+
Once you have updated/modified your CSV template file, you are now ready to bulk update the assignment settings.
109118

110119
To bulk update the assignments settings, follow these steps:
111120

@@ -117,14 +126,14 @@ To bulk update the assignments settings, follow these steps:
117126
3. Select or drag and drop the CSV file in which you have defined all the required settings.
118127

119128
.. image:: /img/select-csv-batch-update.png
120-
:alt: Select csv Batch Update
129+
:alt: Select CSV Batch Update
121130

122131

123132
4. You will see the test result in the CSV Test Run section (you may also see the error messages if something is not correct in your CSV file)
124133

125134

126135
.. image:: /img/batch-csv-test-run.png
127-
:alt: Batch csv Test Run
136+
:alt: Batch CSV Test Run
128137

129138

130139
Click **Apply** to reflect these settings to your actual assignments settings

0 commit comments

Comments
 (0)