Fischer's Blackboard lean 9 Connector support both Identity and Provisioning. The Identity functionalities of this connector enable you as an Identity administrator to configure Blackboard Learn 9 as a connected system and then make Identity users part of the Blackboard Learn 9 system. This enables the user or Identity administrator to reset Blackboard Learn 9 account passwords. This also enables you to enable and disable user accounts.
The Provisioning functionalities of this connector enable exporting and importing user accounts on a Blackboard Learn 9 system.
Functionalities
Identity Integration
| Product Feature | Supported |
|---|---|
| Authenticate | Yes |
| Validate User | Yes |
| Enable/Disable User | Yes |
| Reset Password | Yes |
| Expire Password Immediately | No |
| Expire Password by Date | No |
Provisioning Integration
| Data Format | Export | Create | Modify | Delete | Trigger |
|---|---|---|---|---|---|
| User | Yes |
Yes | Yes | No | No |
| Course | Yes |
Yes | Yes | No | No |
| Group | Yes |
Yes | Yes | No | No |
| PortalRole | Yes |
Yes | Yes | No | No |
Prerequisites
Ensure that these prerequisites are satisfied:
- Blackboard Learn 9 or later is installed, configured, and running.
- An administrator account that can be used to establish a connection and has authority to manage accounts on the connected system.
Configuring the Building Blocks
The connector has two parts. One is the Java part, which is included in the Identity and Provisioning installation. The second part is a Blackboard building block extension in the form of a war file that has to be uploaded to the Blackboard Server as shown below.
- Access Blackboard through an administrator account. The Administrator Panel displays.
- From the System Admin tab, under the module Building Blocks, click Building Blocks:
Select Installed Tools. The currently installed building blocks are listed.
-
Click the Upload Building Blocks button and browse to the .war file on the IdM Suite Software folder\Connectors\BlackBoard.
Note:If you are using Blackboard 9 SP7 or earlier, use the file FII_BB_Connector_1.0.war.
-
If you are using Blackboard 9 SP7 or earlier, use the file FII_BB_Connector_1.0.war.If you are using Blackboard 9 SP8 or later, use the file FII_BB_Connector_1.1.war.
- Select FII_BB_Connector.war. This new Fischer International Identity Building Block will now be listed, but is inactive by default:
- Select Available in the Availability drop-down list. The Make Building Block Available page displays the access permissions that the Building Block needs.
Click the Approvebutton to approve the access permissions. The Building Block will run.
- Click the Settings button on the Fischer International Identity Building Block row:
A page displays to configure the connector:
- Copy and paste the information from the fields to the Identity Administration ► Connected System Details page.
Creating and Managing the Connected System
Connected system can be managed from both Admin UI and Workflow and Connectivity studio. The step by step explanation to create is provided in the following sub sections. Clicking on the connected system from the listing page(admin UI)/selecting the desired system and clicking on View button(Studio) will take you to a detail page where you can can manage the connected system.
Create from Admin UI
- Log in to Identity Administration and click the Systems tab.
- On the Connected System View page, click the Add button and select the Blackboard Learn 9 connected system from the Type drop-down list. The Connected System Details page displays the default values:
-
Enter the desired information:
Definition Supported Connectors
Displays whether the connected system is Identity only, Provisioning only, or both. Password Policy
Displays the name of the password policy associated with the connected system. Connected System Group
Displays the name of the system group that includes this connected system.
Note: If a password policy is associated with a connected system and then the connected system is placed in a group, the group’s password policy will override the connected system’s password policy. The password policy will be removed from the connected system.Type
Select the connected system type. Locale
Select the preferred language (default: English). Locale specific information such as Display Name and Description can be added only while modifying the connected system. Name
The name for this connected system. Note: The name cannot be modified later. Display Name
The display name of the new connected system. Description
The description of the connected system. Associated With
Select how the connector associated with this system will run:
- Server (default) - Runs locally on the Provisioning/Identity Server.
- Global Identity Gateway - Runs remotely on a Global Identity Gateway cluster member. Note: Only GIG clusters that have at least one registered and enabled member will display in this list. See the appendix Using the Global Identity Gateway with Connected Systems for additional information.
Password Reset By
Enables administrators to configure password management functions normally available to Users and OBO (On Behalf Of) Users:
- OBO User Only - Connected system and account association information is displayed only in Self-Service user management (for OBO Users). OBO Users can reset passwords for accounts on this connected system. Administrators can perform all user management functions for this connected system (e.g., enable/disable, validate, associate user, and password reset). End users will not see their accounts on this connected system in Self-Service and Kiosk; therefore, they cannot reset passwords for accounts on this connected system.
- Users and OBO User - Connected system and account association information is displayed in Self-Service password reset, Self-Service - Kiosk, and Self-Service user management. Self-Service users, Kiosk users, and OBO Users can reset passwords for accounts on this connected system. Administrators can perform all user management functions for this connected system (e.g., enable/disable, validate, associate user, and password reset).
- External - Connected system and account association information is not displayed in Self-Service password reset, Self-Service - Kiosk, and Self-Service user management. Self-Service users, Kiosk users, and OBO Users cannot reset passwords for accounts on this connected system.
Note: When user management configuration enables OBO Users to perform password resets, this definition must be set to OBO User Only or Users and OBO User. For connectors that support Provisioning only, there is no password reset capability.
Provisioning Option
Select the provisioning option:
- Automated (default) - The connected system functions as a normal connected system; there are no restrictions.
- Administrative - The connected system cannot be used as an object in a workflow.
Enable HPAM Support
Select to make the connected system HPAM enabled (default: cleared). Note: This can only be set for systems that support Identity.Connection Information Host
The IP address or host name of the server (e.g., 10.102.200.20 or localhost). Port
The port number of the service running. Path to Building Block
The path depends of the Blackboard Server and Building Block name provided by the configuration page (default: /webapps/fii-connector-BBLEARN/). Service Account Name
The name of the administrative user account used to connect to the server. Service Account Password
The administrative user password. Use HTTPS
Specifies SSL protection. This is required in a production environment, as both administrative and user passwords are transmitted in plain text.
Note: The certificate used by the Blackboard Server has to be trusted. See the guide Configuring SSL for additional information about enabling SSL.
System Owner
Add or Remove users assigned as the owners of the system. Displays the Connected System Owner Search page for selecting users. The HPAM column indicates whether the system owner is authorized to use the HPAM feature. The Approvers column indicates whether the system owner is an approver in the approval process. Add PswdPolicy / Remove PswdPolicy
Adds/removes a password policy to/from this connected system. If the connected system is associated with a Connected System Group, the buttons will be unavailable - all password policy assignments are defined at the group level (refer to Admin UI _ Systems _ Groups option). -
Click the Test Connection button to test the Connection Information:
- If successful, one or both of these messages may display:
Message: Connection from Studio to the connected system was established successfully.
Message: Connection from Identity to the connected system was established successfully.- If unsuccessful, one or both of these messages may display:
Error: Failed to establish connection from Studio to the connected system.
Error: Failed to establish connection from Identity to the connected system.
Note: If the connection fails, additional messages may display providing more information regarding the failure, and additional information may be posted to the Provisioning and Identity logs. - (Optional) To select owners of the system, click the System Owner Add button. The Connected System Owner Search page displays:
5.1. Select the owners and then click the Select button. The system owner displays under the
System Owner section:
Note: More than one user can be assigned as an owner.
5.2. To add additional system owners, click the Add button.
6. On the Connected System Details page, click the Add button to save the configured connected system. The Object Category Association page displays a list of categories that are already associated and/or can be selected to add additional associations to this connected system:
6.1. Select one or more available object categories or provide search criteria and click the Search button to find specific categories to select. If there are no available categories to select, proceed to Step 7.
6.2. Click the Add Association button to associate the selected object categories to the connected system.
7. Click the Back button to return to the Connected System View page. The new connected system displays in the list.
Creating from Studio
1. Log in to the Workflow and Connectivity Studio and click Connectivity Add Systems on the menu bar. The Add Connected Systems window displays.
2. Select the Blackboard Learn 9 connected system from the Type drop-down list. The default values display:
3. Enter the desired information:
| Definition | |
Type |
Select the connected system type. |
Name |
The name for this connected system. Note: The name cannot be modified later. |
Display Name |
The display name of the new connected system. |
Supported Connectors |
Displays whether the connected system is Identity only, Provisioning only, or both. Only connectors that support Provisioning are available here. |
Associated With |
Select how the connector associated with this system will run:
|
| Password Rest By |
|
Enable HPAM Support |
Select to make the connected system HPAM enabled (default: cleared). Note: This can only be set for systems that support Identity. |
| Connection Information | |
| Host | The IP address or host name of the server (e.g., 10.102.200.20 or localhost). |
| Port | The port number of the service running. |
| Path to Building Block | The path depends on the Blackboard Server and Building Block name provided by the configuration page (default: /webapps/fii-connector-BBLEARN/). |
| Service Account Name | The name of the administrative user account used to connect to the server. |
| Service Account Password | The administrative user password. |
Use HTTPS |
Specifies SSL protection. This is required in a production environment, as both administrative and user passwords are transmitted in plain text. Note: The certificate used by the Blackboard Server has to be trusted. See the guide Configuring SSL for additional information about enabling SSL. |
| System Owner | Add or Remove users assigned as the owners of the system. Displays the Connected System Owner Search page for selecting users. The HPAM column indicates whether the system owner is authorized to use the HPAM feature. The Approvers column indicates whether the system owner is an approver in the approval process. |
| Add PswdPolicy / Remove PswdPolicy | Adds/removes a password policy to/from this connected system. If the connected system is associated with a Connected System Group, the buttons will be unavailable - all password policy assignments are defined at the group level (refer to Admin UI _ Systems _ Groups option). |
4. Click the Connect button to test the Connection Information:
- If successful, this message displays:
Connection from Studio to the connected system was established successfully. - If unsuccessful, this message displays:
Failed to establish connection from Studio to the connected system.
Note: If the connection fails, additional messages may display providing more information regarding the failure.
5. Click the Apply button to apply changes. The Category Association window displays.
5.1. Select one or more object categories from the Available Categories list or enter a category name and click the Search button to find a specific category to select. If there are no available categories to select, proceed to Step 6.
5.2. Click the Add button to associate the selected object categories to the connected system.
6. Click OK to accept selected categories.
Using the Connected System for Provisioning
Perform these procedures to configure the connector:
- Configuring for Export
- Configuring for Import
- Connector Details for Provisioning
- Lookup Data
Note: If the number of records to be processed exceeds one thousand, we recommend configuring the workflow to use bulk mode, which lowers the memory consumption of the system by streaming data to files. Because data is streamed for every task, performance of the workflow execution will be decreased due to increased read-write operations. See the Workflow and Connectivity Studio document for details on how to configure bulk mode.
Configuring for Export
Perform these procedures to configure the connector for data export:
- Configuring the Export Connector
- Configuring the Export Link
From the Workflow and Connectivity Studio, select the Blackboard Learn 9 UserExport workflow listed under the projects folder.
If a workflow does not already exist, create an export workflow. See Workflow and Connectivity Studio for details on creating export workflows.
Configuring the Export Connector
- In the Design pane, double-click the export object (the first workflow object after the Start object). The Configure Data Source window displays:
-
From the Configure Plug-in tab, set these properties as required:
Associated Connected System
Select the connected system from the list. The export operation will be done from this connected system.Data Formats
Select the type of data format to use: Profiles (default) or ChangeLog.DeltaExportMode Select the type of attribute to export if a change takes place (this works in conjunction with ExportMode when DeltaExport is selected):
- OnlyChangedAttributes - Performs a partial export of only the changed attributes from the last time the query was run.
- ChangedAndMandatoryAttributes (default) - Performs a partial export of both changed and mandatory attributes from the last time the query was run. Mandatory attributes are exported whether they have been changed or not.
- AllAttributes - Performs a full export of all attributes that contain a value.
DynamicConnectedSystem
Select the global variable to use as the dynamic connected system name. This works in conjunction with DynamicConnectedSystemOption when GlobalVariable is selected.DynamicConnectedSystemOption
Select how to control Dynamic System Support (DSS):- None - There will not be any Dynamic System Support.
- Transaction-SystemName - The value of the Transaction-SystemName attribute in data will be used as the dynamic connected system. The connected system name must be passed as the value of the attribute Transaction-SystemName; if it is missing in data, the operation will fail.
- GlobalVariable - Select a global variable to use as the dynamic connected system name from the property DynamicConnectedSystem.
ExportMode
Select the type of data to export:- FullExport - Exports all attributes.
- DeltaExport - Exports changed, mandatory, or all attributes, depending on the DeltaExportMode property setting.
Filter
Specify search criteria to determine the objects to be exported from the container specified in ExportDN. Use the Set Filter button that becomes active to create a filter. See "Set Filter" on page 34 for additional information.FoldSubRecords
If set to TRUE, sub records are folded and returned as attributes.Note: Hover the pointer over a property to view its description.
Set Filter
Setting the filter is a means to narrow the search scope and return specific results:
Description Search operation
Select the operation of the filter. This represents the attribute name for searching the Blackboard Learn 9 directory. Search attributes
The elements that display depend upon the Search operation selected:
- User Name - Enter a userName.
- BatchUid - Enter a batchUid.
- Id - Enter an id.
- CourseId - Enter a courseId.
- CourseMembershipId - Enter a courseMembershipId.
- GroupId - Enter a groupId.
- PortalRoleId - Enter a portalRoleId.
- Key Select the key to search.
- Operator - Select the logical operator.
- Value - Enter a value for the selected search criteria.
- Date - Enter the date, or click the calendar icon to the right of this field.
- Use paging - Check this box to use paging during operations that involve large amounts of data.
Filter Syntax
Displays the filter syntax used to retrieve entries from the Blackboard Learn 9 Server and to build the export list.
Edit Filter Manually - Check this box to manually edit the filter in the Filter Syntax to build complex filters. -
(Optional) Select the Attributes tab. Only standard attributes display:
Modify schema attributes using these buttons.Description Add
Adds additional attributes to the list. The Add New Attribute dialog displays.Export
Exports the schema list to an XML file.Import
Imports the schema list from an XML file.Refresh Schema
Dynamically discovers the schema from the target LDAP system. It also includes local as well as global attributes added in the Studio.Reset Schema
Resets the schema definition to the default schema prepackaged with the IdM Suite, plus any global variable added. - (Optional) Select the Appearance tab to change how the Connected System object displays in the Design pane.
- Click OK to save any changes and return to the Workflow and Connectivity Studio window.
Configuring the Export Link
-
In the Design pane, double-click the export link between the export object (the first workflow object after the Start object) and the Data Mapper object. The Configure Link window displays:
Description Source Attributes
Select the attributes to export.Selected Attributes
Displays default attributes and those attributes that have been selected from the Source Attributes.
Notes: The check boxes are used only for delta export operations. These checked attributes will always be exported whether they were changed or not. Usually, the attributes that are selected as mandatory attributes help in identifying or verifying an entry when completing mapping functions.Advanced Settings
Displays the Configure Attributes window for configuring advanced settings for attributes. - From the Attribute Selection tab, select attributes to export.
Usually, these attributes that are selected (mandatory attributes) help in identifying or verifying an entry when completing Data Mapper functions.
-
(Optional) Click the Format button to specify a date/time format to be applied to the selected date type attribute. The Format Date window displays.
Select the Include Time check box to add the timestamp with the date.
Select the 24 Hour or 12 Hour option button and then select the required date/time format
Click OK to save the selected format. The Configure Link window displays.
- Click OK to save any changes and return to the Workflow and Connectivity Studio window.
- Deploy the workflow by selecting Deploy ► New Deployment. See the Workflow and Connectivity Studio documentation for details of deployment options.
- Manage and run the deployed workflow from the Admin UI ► Server tab. See the Identity Suite Administration documentation for details.
Configuring for Import
Perform these procedures to configure the connector for data import:
- Configuring the Import Connector
- Configuring the Import Link
From the Workflow and Connectivity Studio, select the Blackboard Learn 9 UserAdd, UserModify, or UserDelete workflow listed under the projects folder.
If a workflow does not already exist, create an import workflow. See the Workflow and Connectivity Studio documentation for details on creating import workflows.
Configuring the Import Connector
- In the Design pane, double-click the import object (the last workflow object). The Configure Data Source window displays:
-
From the Configure Plug-in tab, set these properties as required:
Associated Connected System
Select the connected system from the list. The import operation will be done to this connected system.Data Formats
Select the type of data format to use: Profiles (default) or ChangeLog.DynamicConnectedSystem
Select the global variable to use as the dynamic connected system name. This works in conjunction with DynamicConnectedSystemOption when GlobalVariable is selected.DynamicConnectedSystemOption
Select how to control Dynamic System Support (DSS):- None - There will not be any Dynamic System Support.
- Transaction-SystemName - The value of the Transaction-SystemName attribute in data will be used as the dynamic connected system. The connected system name must be passed as the value of the attribute Transaction-SystemName; if it is missing in data, the operation will fail.
- GlobalVariable - Select a global variable to use as the dynamic connected system name from the property DynamicConnectedSystem.
See the Dynamic System Support appendix in the Workflow and Connectivity Studio document for additional information.
Id *
Enter the attribute that contains the value used to uniquely identify the user account user ID on the connected system.loginId *
Enter the attribute that contains the value used to uniquely identify the user account login ID on the connected system.SubRecordsInFoldedState
When set to TRUE, the connector accepts multi-level attributes in a folded state.Notes:
* accountDN, Id, and loginId are used by the Provisioning Policy and IdentityHub features to populate the ACCOUNT_DN, ACCOUNT_ID, and ACCOUNT_USERNAME columns of the FISC_USER_ACCOUNT table of the Product database. See the ‘Provisioning Policy’ and ‘Provisioning Using the IdentityHub’ chapters of the Identity Suite Administration Guide for details.
Hover the pointer over a property to view its description. (Optional) Select the Attributes tab. Only standard attributes display:
Modify schema attributes with the buttons.- (Optional) Select the Appearance tab to change how the Connected System object displays in the Design pane.
- Click OK to save any changes and return to the Workflow and Connectivity Studio window.
Configuring the Import Link
-
In the Design pane, double-click the import link between the Data Mapper object and the import object (the last workflow object). The Configure Link window displays:
Source Attributes
Select the attributes to import.Selected Attributes
Displays default attributes and those attributes that have been selected from the Source Attributes. Note: The default attributes are those that are commonly used to create a new user.Format Displays the Format Date window to specify a date/time format to be applied to the selected date type attribute, for example, when Changed. During export, the attribute’s value is converted to the specified format.
Notes:- The Format button is only enabled for date attributes.
- The Refresh Schema button on the Configure Data Source window’s Attributes tab must be used to refresh the schema and enable the Format button for date attributes.
Advanced Settings
Displays the Configure Attributes window for configuring advanced settings for attributes. Under the Encrypted column, check the box of any attribute that needs to be encrypted.
Under the Diff With Target column, check the box of any attribute to update using differencing (DiffWithTarget, AddDiffWithTarget, and RemoveDiffWithTarget). From the Attribute Selection tab, select attributes to import.
(Optional) Select the Appearance tab to change how the link displays in the Design pane.
- Click OK to save any changes and return to the Workflow and Connectivity Studio window.
- Deploy the workflow by selecting Deploy ► New Deployment. See the Workflow and Connectivity Studio document for details of deployment options.
- Manage and run the deployed workflow from the Admin UI ► Server tab. See the Identity Suite Administration Guide for details.
Connector Details for Provisioning
Configuration import properties Id and loginId are used by the Provisioning Policy and IdentityHub features to populate the ACCOUNT_ID and ACCOUNT_USERNAME columns of the FISC_USER_ACCOUNT table of the Product database. See the ‘Provisioning Policy’ and ‘Provisioning Using the IdentityHub’ chapters of the Identity Suite Administration Guide for details.
This table shows the default attributes specified for these properties for the connected system:
Configuration Import Properties
| Identity Property | System Attribute |
|---|---|
| id | Username |
| login id | Username |
Dataformats and Supported Operations
This connector supports creation, modification, deletion, and export of user attributes. As users can be enrolled in multiple courses, groups, and secondary portal roles, the connector also supports creation, modification, and deletion of courseMembership, groupMembership, and userRole attributes as indicated in this table
The items in the Export, Create, Modify, and Delete columns have these meanings:
- Y = Yes (attribute is supported for this operation)
- N = No (attribute is not supported for this operation)
| DataFormat Name | Operation | Description | ||||
|---|---|---|---|---|---|---|
| Add | Modify | Delete | ||||
| Add | Replace | Delete | ||||
User |
Y |
Y |
Y |
Y |
Y |
Add - Adds a new user (optionally, these attributes can be used to manage the user’s memberships and roles):
Modify (Add) - Adds additional basic user information (mobile number), adds/enrolls the user to more courses, groups, and portalRoles [the user gets new courseMembership, groupMembership, or userRole]. Modify (Replace) - Modifies user basic information (home phone number, Student ID, etc.) and subtype attributes (courseMembership->role, courseMembership->enrollmentDate). Modify (Delete) - Deletes user basic information (fax number), course, or portal role information [removes users' courseMembership, groupMembership, or portalRole attributes]. Delete - Deletes the user and all associated sub attributes (courseMemberships, groupMemberships, and userRoles). |
Course |
Y |
Y |
Y |
Y |
Y |
Add - Adds new course(s) to which users can enroll [users get new courseMembership]. Modify (Add) [retain existing course enrollments] - Adds/enrolls users to course(s) [users get new courseMemberships]. Modify (Replace) - Replaces course information (Description, enrollmentStartDate, enrollmentEndDate) and courseMembership attributes of the users’ enrolled course. Does not replace any existing course or course enrollments. Modify (Delete) - Deletes user(s) from an enrolled course (removes courseMembership of users’ enrolled course). Delete - Deletes course(s) [removes all associated group(s) and course enrollments]. |
Group |
Y |
Y |
Y |
Y |
Y |
Add - Adds new group(s) to a course and adds all or some users to group(s) [users get new groupMembership(s)]. Modify (Add) [retain existing group assignments] - Adds users to group(s) defined for enrolled courses (users get new groupMemberships). Modify (Replace) - Replaces group information (Description, Title) and users groupMembership attributes. Does not replace any existing group or group assignments. Modify (Delete) - Delete user(s) from a group(s) [removes users’ specific groupmembership(s)]. Delete - Deletes group(s) associated with a course [removes all associated groupMembership(s)]. |
PortalRole |
Y |
Y |
Y |
Y |
Y |
Add - Adds new secondary portalRole and assigns user(s) to the portalRole [users get new userRole(s)]. Modify (Add) [retain existing secondary portal roles] - Assigns users to portalRole(s) [users get new userRole(s)]. Modify (Replace) - Replaces portalRole information (Description, roleName) and users’ userRole attributes. Does not replace any existing secondary portal roles or role assignments. Modify (Delete) - Deletes users from a portalRole (removes users’ specific userRoles). Delete - Deletes portalRoles [removes all associated userRoles]. |
User Data Format
The following table outlines the supported user attributes. Attributes that are mandatory are required for user creation. For attributes (such as courseMembership -> courseMembershipId, groupMembership -> groupMembershipId, and userRole -> userRoleID), mandatory applies only for the sub attributes, for example, a user can be created without a portalRole.
Note: All attributes for users (except password) are exportable.
Supported Attributes
| Name | Personal Info | Description | Multi-Valued | Create | Modify | Remove | Mandatory |
|---|---|---|---|---|---|---|---|
batchUid |
N |
Used by the integration component to uniquely mark records for automatic updating/processing through the bridge. |
N |
Y |
Y |
Y |
N |
businessFax |
N |
Business fax. |
N |
Y |
Y |
Y |
N |
businessPhone1 |
N |
Business phone. |
N |
Y |
Y |
Y |
N |
businessPhone2 |
N |
Second business phone. |
N |
Y |
Y |
Y |
N |
cardNumber |
N |
Card number. |
N |
Y |
Y |
Y |
N |
city |
N |
City. |
N |
Y |
Y |
Y |
N |
company |
N |
Company. |
N |
Y |
Y |
Y |
N |
country |
N |
Country. |
N |
Y |
Y |
Y |
N |
department |
N |
Department. |
N |
Y |
Y |
Y |
N |
emailAddress |
N |
E-mail address. |
N |
Y |
Y |
Y |
N |
familyName |
N |
Last name. |
N |
Y |
Y |
Y |
Y |
givenName |
N |
First name. |
N |
Y |
Y |
Y |
Y |
homeFax |
N |
Home fax number. |
N |
Y |
Y |
Y |
N |
homePhone1 |
N |
Home phone number. |
N |
Y |
Y |
Y |
N |
homePhone2 |
N |
Second home phone number. |
N |
Y |
Y |
Y |
N |
userId |
N |
User ID. |
N |
N |
N |
N |
NA |
jobTitle |
N |
Job title. |
N |
Y |
Y |
Y |
N |
lastLoginDate |
N |
Last login date. |
N |
Y |
Y |
Y |
N |
middleName |
N |
Middle name. |
N |
Y |
Y |
Y |
N |
mobilePhone |
N |
Mobile phone number. |
N |
Y |
Y |
Y |
N |
password |
N |
User password (hashed in MD5…). |
N |
Y |
Y |
Y |
Y |
state |
N |
State. |
N |
Y |
Y |
Y |
N |
street1 |
N |
First line of street address. |
N |
Y |
Y |
Y |
N |
street2 |
N |
Second line of street address. |
N |
Y |
Y |
Y |
N |
systemRole |
N |
System role (see Enumeration below). |
N |
Y |
Y |
Y |
N |
title |
N |
User title. |
N |
Y |
Y |
Y |
N |
userName |
N |
Username (must be unique). |
N |
Y |
Y |
Y |
Y |
webPage |
N |
Web page. |
N |
Y |
Y |
Y |
N |
zipCode |
N |
Zip code. |
N |
Y |
Y |
Y |
N |
birthdate |
Y |
Birth date. |
N |
Y |
Y |
Y |
N |
CDRomDriveMac |
Y |
N |
Y |
Y |
Y |
N |
|
CDRomDrivePC |
Y |
N |
Y |
Y |
Y |
N |
|
educationLevel |
Y |
Level of education. |
N |
Y |
Y |
Y |
N |
gender |
Y |
Gender (male / female / unknown). |
N |
Y |
Y |
Y |
N |
isAvailable |
Y |
Set if the user is available (used to enable / disable a user). |
N |
Y |
Y |
Y |
N |
isInfoPublic |
Y |
Specify if this user information is public. |
N |
Y |
Y |
Y |
N |
portalRoleId |
Y |
Primary portal role ID. |
N |
Y |
Y |
Y |
N |
locale |
Y |
Specify a locale for this user. |
N |
Y |
Y |
Y |
N |
showAddContactInfo |
Y |
Show this user contact information. |
N |
Y |
Y |
Y |
N |
showAddressInfo |
Y |
Show this user address information. |
N |
Y |
Y |
Y |
N |
showEmailInfo |
Y |
Show this user e-mail information. |
N |
Y |
Y |
Y |
N |
showWorkInfo |
Y |
Show this user work information. |
N |
Y |
Y |
Y |
N |
studentId |
Y |
Student ID. |
N |
Y |
Y |
Y |
N |
courseMembership -> courseId |
Y |
ID of the course associated. |
Y |
Y |
N |
N |
Y |
courseMembership -> childCourseId |
Y |
ID of the course this course inherits. |
Y |
Y |
Y |
Y |
N |
courseMembership -> enrollmentDate |
Y |
Date of the enrollment in this course. |
Y |
Y |
Y |
Y |
N |
|
courseMembership -> hasCartridgeAccess |
Y |
Has cartridge flag. |
Y |
Y |
Y |
Y |
N |
courseMembership -> courseMembershipId |
Y |
ID of the courseMembership. |
Y |
N |
N |
N |
NA |
courseMembership -> includedInRoster |
Y |
IncludedInRoster flag. |
Y |
Y |
Y |
Y |
N |
courseMembership -> introduction |
Y |
Introduction. |
Y |
Y |
Y |
Y |
N |
courseMembership -> isCourseMembership Available |
Y |
Is the courseMembership available. |
Y |
Y |
Y |
Y |
N |
courseMembership -> notes |
Y |
Notes associated to the course. |
Y |
Y |
Y |
Y |
N |
courseMembership -> personalInfo |
Y |
Personal information associated with this courseMembership. |
Y |
Y |
Y |
Y |
N |
courseMembership -> receiveEmail |
Y |
Flag if receiving e-mail. |
Y |
Y |
Y |
Y |
N |
courseMembership -> role |
Y |
User role in the course. |
Y |
Y |
Y |
Y |
N |
groupMembership -> groupId |
Y |
Group ID. |
Y |
Y |
N |
N |
Y |
groupMembership -> groupMembershipId |
Y |
groupMembership ID. |
Y |
N |
N |
N |
NA |
groupMembership -> groupRoleIdentifier |
Y |
Role of the user in the group. |
Y |
Y |
Y |
Y |
N |
userRole -> userRoleId |
Y |
User role ID. |
Y |
N |
N |
N |
NA |
userRole -> portalRoleId |
Y |
Portal role ID. |
Y |
Y |
N |
N |
Y |
System Role
These values can be defined.
| Name | Description |
|---|---|
ACCOUNT_ADMIN |
Account administrator role. |
CARD_OFFICE_ADMIN |
Manages the front-end settings (tabs, modules, etc.) for portal-ecommerce functionality. |
COURSE_CREATOR |
Course creator role. |
COURSE_SUPPORT |
Course support role. |
DEFAULT |
Default role is USER. |
ECOMMERCE_ADMIN |
Manages the back end settings for portal-ecommerce functionality. |
GUEST |
Guest role. |
INTEGRATION |
This role is private, used only for special processes that interact for data integration authentication. |
LMS_INTEGRATION_ADMIN |
Manages the front-end portal-ecommerce functionality related to purchases. |
NONE |
No explicit role. |
OBSERVER |
Observer role. |
PORTAL |
Portal administrator role. |
STORE_ADMIN |
Manages the front-end portal-ecommerce functionality related to purchases. |
SYSTEM_ADMIN |
System administrator role. |
SYSTEM_SUPPORT |
System support role. |
USER |
Normal user role. |
Course Data Format
This connector supports creation, modification, deletion, and export of both course and course membership attributes. courseMembership represents the link between a user and a course. Mandatory attributes are required for course creation.
Note: All attributes in a course are exportable.
| Name | Description | Muti-valued | Create | Modify | Remove | Mandatory |
|---|---|---|---|---|---|---|
absoluteLimit |
Absolute storage limit for this course. |
N |
Y |
Y |
Y |
N |
allowGuests |
Allow guests flag for this course. |
N |
Y |
Y |
Y |
N |
allowObservers |
Allow observers flag for this course. |
N |
Y |
Y |
Y |
N |
batchUid |
Batch uid associated with this course. |
N |
Y |
Y |
Y |
N |
associatedCourseId |
Course Id associated with this course. |
N |
Y |
N |
N |
Y |
description |
Description associated with this course. |
N |
Y |
Y |
Y |
N |
durationType |
Returns the duration type for this course. Specifies the intended length of the course (see Enumeration below). |
N |
Y |
Y |
Y |
N |
endDate |
Date on which this course will/has end(ed). |
N |
Y |
Y |
Y |
N |
enrollmentAccessCode |
Enrollment access code associated with this course. |
N |
Y |
Y |
Y |
N |
enrollmentEndDate |
Date on which enrollment in this course ends. |
N |
Y |
Y |
Y |
N |
enrollmentStartDate |
Date on which enrollment in this course starts. |
N |
Y |
Y |
Y |
N |
enrollmentType |
Enrollment type for this course (see Enumeration below). |
N |
Y |
Y |
Y |
N |
fee |
Fee (cost) for this course. |
N |
Y |
Y |
Y |
N |
hasDescriptionPage |
Has description page flag for this course. |
N |
Y |
Y |
Y |
N |
courseId |
Primary key. |
N |
N |
N |
N |
|
institutionName |
Institution name associated with this course. |
N |
Y |
Y |
Y |
N |
isAvailable |
Availability flag for this course. |
N |
Y |
Y |
Y |
N |
isLocaleEnforced |
Enforced locale flag for this course. |
N |
Y |
Y |
Y |
N |
isLockedOut |
Locked out flag for this course. |
N |
Y |
Y |
Y |
N |
isNavCollapsible |
"is navigation collapsible" flag for this course. |
N |
Y |
Y |
Y |
N |
locale |
Locale of this course object. |
N |
Y |
Y |
Y |
N |
navColorBg |
Background color used for rendering the navigation links that display on the left hand side of the course page. |
N |
Y |
Y |
Y |
N |
navColorFg |
Foreground color (color of text) used for rendering the navigation links that display on the left hand side of the course page. |
N |
Y |
Y |
Y |
N |
numDaysOfUse |
Number of days this course can be used. |
N |
Y |
Y |
Y |
N |
paceType |
Returns the pace type for this course. Defines the intended educational pace set for this course. This is simply a descriptive attribute and does not affect any system behavior (see Enumeration below). |
N |
Y |
Y |
Y |
N |
serviceLevelType |
The service level type for this course (see Enumeration below). |
N |
Y |
Y |
Y |
N |
showInCatalog |
Show in catalog flag for this course. |
N |
Y |
Y |
Y |
N |
softLimit |
Soft storage limit for this course. |
N |
Y |
Y |
Y |
N |
startDate |
Date on which this course will/has start(ed). |
N |
Y |
Y |
Y |
N |
title |
Title associated with this course. |
N |
Y |
Y |
Y |
Y |
uploadLimit |
Upload storage limit for this course. |
N |
Y |
Y |
Y |
N |
courseMembership -> childCourseId |
ID of the course this course inherits. |
Y |
Y |
Y |
Y |
N |
courseMembership -> enrollmentDate |
Date of the enrollment in this course. |
Y |
Y |
Y |
Y |
N |
courseMembership -> hasCartridgeAccess |
Has cartridge flag. |
Y |
Y |
Y |
Y |
N |
courseMembership -> courseMembershipId |
ID of the courseMembership. |
Y |
N |
N |
N |
N |
courseMembership -> includedInRoster |
IncludedInRoster flag. |
Y |
Y |
Y |
Y |
N |
courseMembership -> introduction |
Introduction. |
Y |
Y |
Y |
Y |
N |
courseMembership -> isCourseMembershipAvailable |
Is the courseMembership available. |
Y |
Y |
Y |
Y |
N |
courseMembership -> notes |
Notes associated to the course. |
Y |
Y |
Y |
Y |
N |
courseMembership -> personalInfo |
Personal information associated with this courseMembership. |
Y |
Y |
Y |
Y |
N |
|
courseMembership -> receiveEmail |
Flag if receiving e-mail. |
Y |
Y |
Y |
Y |
N |
courseMembership -> role |
User role in the course. |
Y |
Y |
Y |
Y |
N |
courseMembership -> userId |
User ID associated to the course. |
Y |
Y |
N |
N |
Y |
Note: The Course data format represents both a course and an organization; they are similar data types. To find out if the current object is an organization, check that the serviceLevelType is set to COMMUNITY.
Enumeration
These values can be defined:
| Name | Description |
|---|---|
durationType |
|
CONTINUOUS |
Course is active on an ongoing basis. |
DATE_RANGE |
Course is only intended to be available between specific date ranges. |
DEFAULT |
Default: CONTINUOUS. |
FIXED_NUM_DAYS |
Course is only available for a set number of days. |
enrollmentType |
|
DEFAULT |
|
EMAIL_ENROLLMENT |
Instructors have the ability to enroll users, and students can e-mail requests to the instructor for enrollment. |
INSTRUCTOR_LED |
Enrollment tasks for the course can only performed by the instructor. |
SELF_ENROLLMENT |
Instructors have the ability to enroll users, and students can also enroll themselves in the course. |
paceType |
|
DEFAULT |
Default: INSTRUCTOR_LED. |
INSTRUCTOR_LED |
Course is intended to be led by an instructor. |
SELF_PACED |
Students use the course at their own speed. |
serviceLevelType |
|
COMMUNITY |
|
DEFAULT |
|
FULL |
|
REGISTERED |
|
SYSTEM |
|
TEST_DRIVE |
|
Group Data Format
A group is attached to one and only one course. This connector supports creation, modification, deletion, and export of both group and group membership attributes. groupMembership represents the link between a user and a group. Mandatory attributes are required for group creation.
Note: All attributes of Group are exportable
| Name | Description | Muti-valued | Create | Modify | Remove | Mandatory |
|---|---|---|---|---|---|---|
courseId |
Sets the course ID value for this group. |
N |
Y |
Y |
Y |
Y |
description |
Sets the description of this group. |
N |
Y |
Y |
Y |
N |
groupId |
Group ID (Primary key). |
N |
N |
N |
N |
NA |
isAvailable |
Sets whether this group is available. |
N |
Y |
Y |
Y |
N |
isChatRoomAvailabl e |
Sets whether the chat room should be enabled for this group. |
N |
Y |
Y |
Y |
N |
isDiscussionBoardA vailable |
Sets whether the discussion board should be enabled for this group . |
N |
Y |
Y |
Y |
N |
isEmailAvailable |
Sets whether e-mail should be enabled for this group. |
N |
Y |
Y |
Y |
N |
isTransferAreaAvaila ble |
Sets whether the transfer area should be enabled for this group. |
N |
Y |
Y |
Y |
N |
isAllowEditToGroup |
N |
Y |
Y |
Y |
N |
|
isCustomizable |
Indicates whether students can customize the group space or not. |
N |
Y |
Y |
Y |
N |
isGroupSet |
Group Set should not have direct enrollment, they define the default properties to be applied to all of the sub-groups, which actually contain the enrollment. |
N |
Y |
Y |
Y |
N |
isSelfEnrolledAllowe d |
Specifies if this group allows self-enrollment. |
N |
Y |
N |
Y |
N |
isShowSignUp |
If false, the sign-up option will not be shown on the main student group listing page, but only on content item links. |
N |
Y |
Y |
Y |
N |
isSignUpOnly |
Indicates the group is not open (i.e., the user can sign in and the group is listed in the group listing, but it cannot be entered). |
N |
Y |
Y |
Y |
N |
isWithForum |
This is a field used to map a variable in the groups_cr stored process. |
N |
Y |
Y |
Y |
Y |
maximumEnrollment |
N |
Y |
Y |
Y |
N |
|
modifiedDate |
Sets the last modified date for this IBbObject. |
N |
Y |
Y |
Y |
N |
setId |
N |
Y |
Y |
Y |
N |
|
tabId |
N |
Y |
Y |
Y |
N |
|
title |
Sets the title associated with this group. |
N |
Y |
Y |
Y |
Y |
groupMembership -> groupMembershipId |
groupMembership ID. |
Y |
N |
N |
N |
N |
groupMembership -> courseMembershipI d |
courseMembership Id (associating a user and the course containing the group). |
Y |
Y |
N |
Y |
Y |
|
groupMembership -> role |
Role of the user in the group. |
Y |
Y |
Y |
Y |
N |
Notes:
- The isSelfEnrolledAllowed attribute cannot be modified. When the attribute value is switched from TRUE to FALSE, the sign-up sheet still displays. When switching from FALSE to TRUE, an existing sign-up sheet is needed, which can be defined from the connector, so this attribute cannot be modified.
- groupMembership -> role may only have the value BB_PARTICIPANT.
PortalRole Data Format
An user can have one (and only one) primary portal role, but multiple secondary portal roles. This connector supports creation, modification, deletion, and export of both portalRole and userRole attributes. userRole represents the link between a user and a secondary portal role. Mandatory attributes are required for portalRole creation.
Note: All attributes of portalRole are exportable
| Name | Description | Muti-valued | Create | Modify | Remove | Mandatory |
|---|---|---|---|---|---|---|
description |
N |
Y |
Y |
Y |
N |
|
isGuest |
N |
Y |
Y |
Y |
N |
|
isRemovable |
N |
Y |
Y |
Y |
N |
|
isSelfSelectable |
N |
Y |
Y |
Y |
N |
|
portalRoleId |
Primary key. |
N |
N |
N |
N |
NA |
roleID |
Sets the role ID value. |
N |
Y |
Y |
Y |
Y |
roleName |
Sets the name string value for this portalRole. |
N |
Y |
Y |
Y |
Y |
userRole -> userRoleId |
User role ID. |
Y |
N |
N |
N |
NA |
userRole -> userId |
User ID. |
Y |
Y |
N |
Y |
Y |
Lookup Data
To filter data, use the Data Mapper rule Lookup Data
-
Log in to the Workflow and Connectivity Studio and double-click the Data Mapper object on the Design pane. The Configure Data Mapper window displays.
Select the Lookup Data rule under the Mapping Rule column and then click the Source Value.
The Configure Lookup window displays.-
Select the Blackboard Learn 9 system from the Select System drop-down list:
. - In the Enter Lookup Prefix field, enter the prefix to be added to the Lookup fields. See "Set Filter" for a description of this window.
-
Click the Filter Build button, and then from the Set Filter window, generate the search filter, for example:
-
Click the Fields Pick button to select the attributes to be fetched after a successful lookup. The Lookup Configuration dialog displays:
Select the attribute(s) from the Selected Attributes list that require a date and/or time format and click the Format button. The Format Date window displays.
-
Select the Include Time check box to use a date and time format. Select the required date/ time format for your target database (shown above) and then click OK.
-
Select the Lookup Type from the drop-down list. The updated Configure Lookup window displays, for example:
- Select the Exit as Mapper Task Failed on Lookup Failure check box to exit the task with Failed status on lookup failure. It will not process the succeeding entries and will ignore the already processed entries and will not return any data. This is selected by default.
- Click OK.
Handling Multiple Sub Records on Import and Export
A user can have multiple courseMembership, multiple groupMembership, and multiple userRole attributes. A course can have multiple courseMembership, one group, and multiple groupMembership attributes.
Setting multiple sub records on import in the Configure Data Mapper window
- From the Workflow and Connectivity Studio, double-click the Data Mapper object on the Design pane. The Configure Data Mapper window displays.
-
For setting the index on the Target Value, click the attribute under Target Value. The Select Data Elements window displays the attribute selected:
Click the Sub Entr... (Sub Entry Index) button. The Set Data Index / Select Condition Attributes window displays. Click the Literal option and enter the index value:
Click OK.
Setting multiple sub records on export in the Configure Data Mapper window
- From the Workflow and Connectivity Studio, double-click the Data Mapper object on the Design pane. The Configure Data Mapper window displays.
The multi-valued attribute is converted to single-valued separated by a designated delimiter, for example, the multi-valued attribute courseMembership-->role is provided the delimiter "-".
- Click OK.