Incoming Flat File Specifications
Create assignments
Assignments can be created using flat files with the Grade Export feature. An example of the flat file is provided below, along with the specifications and descriptions.
Note
The header row must include all fields listed below; however, only the required fields must be specified in a record.
Flat file example
courseId|name|instructions|anonymous|group|contentAreaName|available|colour|attempts|tracked|startDate|endDate|dueDate|points|gradeSchema|optionalData
GJTEST1|Assignment 2|assignment instructions|false|false|Assignments|true||1|false|2023-10-17|2023-10-31|2023-10-31|100.0|Schema1|MOD_CODE=2023MOD1:SESSION=8W1
File Specifications
The filename should end in .asg; for example, term2023_01.asg.
Field Header | Description | Required | Type and max size |
|---|---|---|---|
courseId | Batch Uid of the course where this assignment should be created or updated. | Yes | String (256 characters) |
name | Name of the assignment. | Yes | String (333 characters) |
instructions | Instructions for the assignment. | No | String (2000 characters) |
anonymous | Indicates whether the assignment is anonymous. Y/N | No | Boolean (Default N) |
group | Indicates whether the assignment is a group assignment Y/N | No | Boolean (Default N) |
contentAreaName | The name of the course menu content area in which the assignment will be created. For Ultra courses, this heading can be used to provision a subfolder and put content in the subfolder. The value has the format "parent@>@child" where "parent" is the name of the top-level (parent) folder and "child" is the name of the subfolder. If the subfolder already exists, the assignment will be added to the existing subfolder. If the subfolder does not exist, it will be created in the parent folder. | No | String (255 characters) Default "Assignments" |
available | Availability of assignments. Y/N | No | Boolean (Default N) |
colour | Color name or hex string value of the color of the assignment item. | No | String (10 characters) |
attempts | Number of attempts granted for the assignment. Use -1 for unlimited. | No | Integer (Default -1) |
tracked | Enable tracking for the assignment item. | No | Boolean (Default N) |
startDate | Display from date for the assignment. | No | Date formatted as specified in the Incoming Settings screen. No value specified as default. |
endDate | Display until date for the assignment. | No | Date formatted as specified in the Incoming Settings screen. No value specified as default. |
dueDate | Due date for the assignment. | No | Date formatted as specified in the Incoming Settings screen. No value specified as default. |
points | Points possible for the assignment. | No | Float (Default 100.0) |
gradeSchema | Grade schema applied to the assignment for Grade Center display. The provided string must match the name of a Grade Schema in the target course for the setting to be applied. | No | String (333 characters) Default behavior is score. |
optionalData | Key/value pairs with each set of pairs separated by a colon, and key/values separated by an equal sign. For example: key1=value1:key2=value2 Most commonly used to track unique values upon extraction for matching records with source systems. | No | String (2000 characters per key/value pair) |
Create Grade Center columns (calculated)
Grade Center calculated weighted columns can be created using flat files with the Grade Export feature. Columns and weights will need to be added manually in the Grade Center to the created calculated weighted column.
Note
The header row must include all fields listed below; however, only the required fields must be specified in a record.
Flat file example
courseId|name|description|duedate|points|gradeSchema|optionalData
GJTEST1|GC Calculated Grade||2023-10-30|10.0|Schema1|MOD_CODE=2023MOD1:SESSION=8W1
File specifications
The filename should end in .col; for example, term2023_01.col.
Field Header | Description | Required | Type and max size |
|---|---|---|---|
courseId | Batch Uid of the course where this grade column should be created or updated. | Yes | String (256 characters) |
name | Name of the grade column. This field is used for matching. | Yes | String (333 characters) |
description | Description of the grade column. | No | String (2000 characters) |
dueDate | Due date for the grade column. | No | Date formatted as specified in the Incoming Settings screen. No value specified as default. |
points | Points possible for the grade column. | No | Float (Default 100.0) |
gradeSchema | Grade schema applied to the grade column for display. The provided string must match the name of a Grade Schema in the target course for the setting to be applied. | No | String (333 characters) Default behavior is score. |
optionalData | Key/value pairs with each set of pairs separated by a colon, and key/values separated by an equal sign. For example: key1=value1:key2=value2 Most commonly used to track unique values upon extraction for matching records with source systems. | No | String (2000 characters per key/value pair) |
Create Grade Center columns (not calculated)
The purpose of this interface is to create or update gradebook columns.
Note
The header row must include all fields listed below; however, only the required fields must be specified in a record.
Flat file example
courseId|name|description|duedate|points|gradeSchema|optionalData
GJTEST1|GC Final Grade||2023-12-30|100|Schema1|MOD_CODE=2023MOD1:SESSION=8W1
File specifications
The filename should end in .colnc; for example, term2023_01.colnc.
Field Header | Description | Required | Type and max size |
|---|---|---|---|
courseId | Batch Uid of the course where this grade column should be created or updated | Yes | String (256 characters) |
name | Name of the grade column. This field is used for matching. | Yes | String (333 characters) |
description | Description of the grade column. | No | String (2000 characters) |
dueDate | Due date for the grade column. | No | Date formatted as specified in the Incoming Settings screen. No value specified as default. |
points | Points possible for the grade column. | No | Float (Default 100.0) |
gradeSchema | Grade schema applied to the grade column for display. The provided string must match the name of a Grade Schema in the target course for the setting to be applied. | No | String (333 characters) Default behavior is score. |
optionalData | Key/value pairs with each set of pairs separated by a colon, and key/values separated by an equal sign. For example: key1=value1:key2=value2 Most commonly used to track unique values upon extraction for matching records with source systems. | No | String (2000 characters per key/value pair) |
Set external grade columns (Original Course only)
The purpose of this interface is to set a column as the External grade column. To mark a column as external a grade column must be provisioned or created.
Note
The header row must include all fields listed below; however, only the required fields must be specified in a record.
Flat file example
courseId|name
GJTEST1|GC Final Grade
File specifications
The filename should end in .colext; for example, term2017_01.colext.
Field Header | Description | Required | Type and max size |
|---|---|---|---|
courseId | Batch Uid of the course where this grade column should be created or updated. | Yes | String (256 characters) |
name | Name of the grade column. This field is used for matching. | Yes. | String (333 characters) |
Create grade column values (not calculated)
The purpose of this interface is to create gradebook columns' values.
Note
The header row must include all fields listed below; however, only the required fields must be specified in a record.
Flat file example
courseId|userId|name|value
GJTEST1|User001|GC Final Grade|90
File specifications
The filename should end in .colncval; for example, term2023_01.colncval.
Field Header | Description | Required | Type and max size |
|---|---|---|---|
courseId | Batch Uid of the course where this grade column should be created or updated. | Yes | String (256 characters) |
userId | user_id of the user for whom this grade value should be created or updated | Yes | String (333 characters) |
name | Name of the grade column. This field is used for matching. | Yes | String (2000 characters) |
value | Value to be assigned. | Yes | String (2000 characters) |
Create grade schema
Grade schemas can be created using flat files with the Grades Journey services. Other files creating assignments or grade columns could depend on grade schema definitions in this file, but the data processor does not enforce a particular run sequence. Therefore, you should ensure grade schema data is processed before running other dependent data files.
Note
The header row must include all fields listed below; however, only the required fields must be specified in a record.
Flat file example
title|symbols|optionalData
Schema1|A=90:B=80:C=70:D=60:F=0|
File specifications
The filename should end in .sch; for example, term2023_01.sch.
Field Header | Description | Required | Type and max size |
|---|---|---|---|
title | Title of the grading schema | Yes | String (333 characters) |
symbols | Symbols in a list with (optional) lower bound, separated by colon. | Yes | String (2000 characters) |
optionalData | Key/value pairs with each set of pairs separated by a colon, and key/values separated by an equal sign. For example: key1=value1:key2=value2 Most commonly used to track unique values upon extraction for matching records with source systems. | No | String (2000 characters per key/value pair) |