Skip to main content
pdf?stylesheet=default
Blackboard Help

Flat File - Incoming File Specifications

Create assignments

Assignments can be created using flat files with the Grades Journey services. A new assignment is created with every record, even if an assignment already exists with the same name. An example of the flat file is provided below, along with the specifications and descriptions.

The header row must include all fields listed below; however, only the required fields must be specified in a record.

Flat file example

Course_id|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|2013-10-17|2013-10-31|2013-10-31|100.0|Schema1||

File specifications

The filename should end in .asg; for example, term2017_01.asg.

Field Header Description Required Type and max size
Course_Id Course_id 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. No String (255 characters)

Default “Assignments”

Available Availability of the assignment.

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.

Y/N

No Boolean (Default N)
StartDate Display from date for the assignment. No Date formatted as specified in the Grades Journey Services settings page.

No value specified as default.

EndDate Display until date for the assignment. No Date formatted as specified in the Grades Journey Services settings page.

No value specified as default.

DueDate Due date for the assignment. No Date formatted as specified in the Grades Journey Services settings page.

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 Grades Journey services. Columns and weights will need to be added manually in the Grade Center to the created calculated weighted column. A new column is created with every record, even if a column already exists with the same name.

Flat file example

course_id|name|description|duedate|points|gradeSchema|optionalData

GJTEST1|GC Assignment 1||2014-6-30|10.0||MOD_CODE=

File specifications

The filename should end in .col; for example, term2017_01.col.

Field Header Description Required Type and max size
Course_Id Course_id 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 Grades Journey Services settings page.

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 comma, 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.

Flat file example

course_id|name|description|duedate|points|gradeSchema|optionalData

GJTEST1|GC Assignment 1||2014-6-30|10.0||MOD_CODE= GJTEST1:MAV_OCCUR=YR:AYR_CODE=2013/4:PSL_CODE=YR:MAP_CODE= GJTEST1:SEQ_RSEQ_Sequence=001:Assignment 1:assessment_ind=assessment

File specifications

The filename should end in .colnc; for example, term2017_01.colnc.

Field Header Description Required Type and max size
Course_Id Course_id 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 Grades Journey Services settings page.

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 comma, 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 external grade columns

The purpose of this interface is to create or update gradebook columns and mark it as External grade column. To mark a column as external a grade column must be provisioned or created.

Flat file example

course_id|name

GJTEST1|Grade Column name

File specifications

The filename should end in .colext; for example, term2017_01.colext.

Field Header Description Required Type and max size
Course_Id Course_id 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.

Flat file example

course_id|user_id|name|value

GJTEST1|User001|Grade Column name|Grade Value

File specifications

The filename should end in .colncval; for example, term2017_01.colncval.

Field Header Description Required Type and max size
Course_Id Course_id of the course where this grade column should be created or updated. Yes String (256 characters)
User_Id 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.

No String (2000 characters)
Value Value to be assigned. No 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.

Flat file example

title|symbols|optionaldata

OverrideSchema|A=93:B=85:C=70:D=65:F=0|

File specifications

The filename should end in .sch; for example, term2017_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. No String (2000 characters)
OptionalData Key/value pairs with each set of pairs separated by a comma, 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)