Skip to main content
pdf?stylesheet=default
Blackboard Help

Properties File

Prepare the Properties file first, as it allows you to customize the formatting and fields of the other three files. This file is required; in the very least, it must contain the required ‘version’ name-value pair. Entries containing multiple values must be comma-separated in the Properties file, even if you specify a different delimiter.

You can add comments in this file by preceding them with a number (#) sign.

To Create the Properties File

  1. Open your preferred text editor.
  2. In the first line, enter the required ‘version’ name-value pair: version=1.0
  3. In subsequent lines, add any optional name-value pairs you wish to define using the table below.
  4. Save the file with ISO-8859-1 character encoding and name it configuration.properties.

Name

Description

Required

Accepted Value(s)

version

Identifies this file for recognition by the Blackboard IM server.

yes

1.0

encoding

Character encoding for your data files.
Regardless of whether or not you enter a value, this Properties file must be saved with ISO-8859-1 character encoding.

By default, this is set to: UTF-8.

no

UTF-8
ISO-8859-1

delimiter

The single character used to separate the fields in your .csv data files.
Recommended values other than the default: semi-colon (;) or pipe (|).

By default, this is set to a comma (,).

no

Any single character

text_qualifier

Indicates if field values will be surrounded by a qualifying character. Programs such as Microsoft Excel sometimes place characters like double quotes around a field to ensure that it is processed.

By default, this field is blank.

no

Any single character

escaping_mode

Specifies the single character used before the text qualifier to escape (identify) qualified text. Qualified text may include line breaks.

If you do not wish to use the default, you can double up your text qualifier (if your qualifier is double quotes, type double quotes twice: "")

By default, this is set to: backslash.

no

backslash
doubled

membership_role_mapping.student

A comma-separated list of course role names at your institution that correspond to the Student role.

Example: undergrad,staff_member

no

Each individual role must be an alphanumeric string with a maximum of 64 characters

membership_role_mapping.ta

A comma-separated list of course role names that correspond to the Teaching Assistant role.

Example: assistant,grader

no

Each individual role must be an alphanumeric string with a maximum of 64 characters

membership_role_mapping.instructor

A comma-separated list of course role names that correspond to the Instructor role.

Example: teacher,professor

no

Each individual role must be an alphanumeric string with a maximum of 64 characters

institution_role_mapping.admin

A comma-separated list of institution role names that should receive Blackboard IM Administrator privileges.

Example: courseadmin,sysadmin

no

Each individual role must be an alphanumeric string with a maximum of 64 characters

institution_role_mapping.none

A comma-separated list of institution role names that should receive standard (non-administrator) privileges on the Blackboard IM server.

Example: guest,alumni

no

Each individual role must be an alphanumeric string with a maximum of 64 characters

date_format

The format for calendar dates in your data files.

By default, this is set to: yyyy-MM-dd.

no

Any string that conforms to Sun's SimpleDataFormat specification.

alias_[field name]

Allows you to customize any field name in the data files.

Example: alias_user_name=login_name

no

Maximum of 64 characters (alphanumeric, '+', '_', and '.')

max_error_count

Allows you to specify an acceptable number of data rows that contain errors before the files are rejected.

By default, this is set to: 0 (disabled).

no

Any integer.

0 to disable.

modification_threshold

Allows you to set an acceptable percentage of data changes (removals, updates, and modifications, but not additions) that, when reached, rejects the files.

By default, this is set to: 0 (disabled).

no

Any integer ranging
from 10 -70.

0 to disable.