Skip to main content
pdf?stylesheet=default
Blackboard Help

XML User Data <PERSON>

XML User Data Elements
XML Construction Description
<EXTENSION> <X_BB_SYSTEMROLE> The user's administrative role, describing the user's level of system administration privilege. The role of none has no system administration or Course creation privileges associated with it, and is the most commonly assigned role.
The following numeric values are acceptable:
0 – System Administrator
1 – System Support
2 – Course Creator
3 – Account Administrator
4 – None
5 – Course Support
6 – User
7 – Observer
8 – Guest
9 – Integration (No GUI access)
10 – Portal Administrator
If one is not given the system defaults to none.
<SOURCEDID> <ID> A unique identifier for a user at the Institution This ID is provided by the Institution and is not displayed to users.
Blackboard strongly recommends that the key data be a permanent, non-changing identifier for each user. An example of a good key is a permanent Student ID assigned when the person applies to the Institution. The database cannot merge data between distinct accounts.
String. Max length 64. Multi-byte characters accepted.
Not Null, External Key
<EXTENSION> <X_BB_REPLACEMENTKEY> This field is used only on the rare occasions when a users EXTERNAL_PERSON_KEY changes.
String. Max length 64. Multi-byte characters accepted.
n/a The name of the company for which the user works.
String. Max length 100. Multi-byte characters accepted.
<SOURCEDID> <USERID> The username used to log into Blackboard Learn. The user name must be unique.
String. Max length 50. Multi-byte characters accepted.
Not Null
<EXTENSION> <X_BB_PASSWORD> The password used to log into Blackboard Learn. On insert, if a password is not included, the password defaults to the username (Unless it is not owned by the Institution).
Must be sent MD5 encoded if the encrypt.password property is set to N. The Snapshot controller available with Blackboard Learn is set to handle MD5 encryption.
String. Max length 32. Multi-byte characters accepted. If Multi-byte characters are used, the encrypt.password property must be set to N.
The IMS 1.1 standard uses <USERID password= > to express a password.
<EXTENSION> <X_BB_StudentID> Generic identifier field. This is a display only field.
String. Max length 100. Multi-byte characters accepted.
<EMAIL> The email address of the user. Blackboard recommends that user_email is not null. Sending email without the From field populated can cause problems.
String. Max length 100
<ADR> <STREET> The first line of the address of the user.
String. Max length 100. Multi-byte characters accepted.
<ADR> <STREET> The second line of the address of the user.
String. Max length 100. Multi-byte characters accepted.
<DEMOGRAPHICS> <GENDER> The gender of the user.
0 - unknown
1 - female
2 - male
<DEMOGRAPHICS> <BDAY> The users birth date in yyyymmdd format.
Date
<NAME> <N> <PREFIX> The title that the user prefers to use.
String. Max length 100. Multi-byte characters accepted.
<ADR> <LOCALITY> The city name corresponding to the users address.
String. Max length 50. Multi-byte characters accepted.
<ADR> <REGION> The state or province name corresponding to the user's address.
String. Max length 50. Multi-byte characters accepted.
<ADR> <PCODE> The users ZIP or Postal Code.
String. Max length 50. Multi-byte characters accepted.
n/a The name of the department or sub-section where the user works.
String. Max length 100. Multi-byte characters accepted.
<ADR> <COUNTRY> The country name corresponding to the user's address.
String. Max length 50. Multi-byte characters accepted.
<TEL> <TEL teletype="0"> The phone number associated with the user. The following numeric values are acceptable for teletype:
0 - Home phone
1 - Home fax
2 - Work phone
3 - Work fax
4 - Mobile phone
5 - Home phone (secondary)
6 - Work phone (secondary)
String. Max length 50. Multi-byte characters accepted.
<NAME> <N> <GIVEN> The users given first name.
String. Max length 100
Not null. Multi-byte characters accepted.
<EXTENSION> <X_BB_PUBLIC_INDICATOR> Determines if the users personal information will be displayed in the User Directory. Values may be Y for yes, or N for no.
Char(1). Y/N
<EXTENSION> <X_BB_AVAILABLE> User account availability within the user interface. If set to no, the user account will appear in gray to the Administrator and Instructors. The user will not be able to log into the system. Values may be Y for yes, or N for no.
Char(1). Y/N
<EXTENSION> <X_BB_ADDRESS_INDICATOR> Determines if the user's home address will be displayed in the User Directory. Values may be Y for yes, or N for no. If a value is not provided the default is no.
Char(1). Y/N
<EXTENSION> <X_BB_EMAIL_INDICATOR> Determines if the user's email address will be displayed in the User Directory.
Values may be Y for yes, or N for no. If a value is not provided tv
Char(1). Y/N
<EXTENSION> <X_BB_CONTACT_INDICATOR> Determines if home phone, fax or cell phone numbers will be displayed in the User Directory.
Values may be Y for yes, or N for no. If a value is not provided the default is no.
Char(1). Y/N
<EXTENSION> <X_BB_WORK_INDICATOR> Determines if work contact information (company, department, title, phone, fax) will be displayed in the User Directory. Values may be Y for yes, or N for no. If a value is not provided the default is no.
Char(1). Y/N
<NAME> <N> <OTHER> The user's given middle name.
String. Max length 100. Multi-byte characters accepted.
<EXTENSION> <X_BB_INSTITUTION_ROLE> The user's Primary Institution Role, which determines the user's view of the Portal Modules and Academic Web Resources.
The following numeric values represent a role:
0 - Student
1 - Faculty
2 - Staff
3 - Alumni
4 - Prospective Student
5 - Guest
6 - Other
7 - Observer
9 through 20 - additional default roles
The IMS 1.1 standard supports the <INSTITUTIONROLE> element.
<EXTENSION> <X_BB_ROW_STATUS> The following numeric values set the record state to:
0 - Enabled: Normal access to the record.
1 - Disabled: Record is visible in some areas of the UI, but may not be changed or accessed.
2 - Deleted: Record is scheduled to be removed.
<EXTENSION> <X_BB_DATASOURCE_KEY> Key used to establish grouping of user elements.
Passed as a string. Multi-byte characters accepted.
<EXTENSION> <X_BB_CARD_NUMBER> Identifier for a Campus Card used with Blackboard Transact.
Passed as a string or as an encrypted string depending on the encrypt.card.number property.
<EXTENSION> <X_BB_LOCALE> Identifier for the preferred user language pack. The value is expressed as xx_XX, for example, the French language pack is represented by fr_FR.
<ADR> The user's address.
<X_BB_COMPANY> The company name.
<DEMOGRAPHICS> Demographics of the user.
<X_BB_COMPANY_DEPARTMENT> The user's department.
<X_BB_EDUCATION_LEVEL> The user's education level.
<PWENCRYPTIONTYPE> The type of password encryption on the user's account.
<FAMILY> The family name of the user. This is also considered the user's last name.
<INSTITUTIONROLE> The user's institution role.
<INSTITUTIONROLETYPE> The user's institution role type.
<X_BB_INTERNAL_ID> The user's internal identification.
<X_BB_JOB_TITLE> The user's job title.
<N>  
<NAME> A field used for part of the user's name.
<OTHER> A field which can be used for the user's middle name.
<PASSWORD> The user's password.
<PERSON>  
<PRIMARYROLE> The user's primary institution role.
<X_BB_SETTINGS> The user's settings.
<SYSTEMROLE> The user's system role.
<SYSTEMROLETYPE> The user's system role type.
<SUFFIX> A field which can be used for the user's name suffix.
<X_BB_PORTALROLE>  
<TEL> The user's telephone number.
<X_BB_WEBPAGE> The user's web page.
<X_BB_LMSINTEGRATION_ROLE> The user's LMS integration role.