Fischer's LMS connector only supports provisioning.

The Provisioning functionalities of this connector enable exporting and importing user accounts on a Canvas LMS system.

Provisioning Integration

Data Format	Export	Create	Modify	Delete	Trigger
User	Yes	Yes	Yes	Yes	No
Course	Yes	Yes	Yes	Yes	No
Account	Yes	No	No	No	No

Prerequisites

Ensure that these prerequisites are satisfied:

Canvas LMS or later is installed, configured, and running.
Create an Administrator account on the Canvas LMS system.
Generate an access token for an administrative account from the Canvas LMS system to establish a connection and has authority to manage accounts on the connected system.
User used to generate a token can manage or view account(s) only when added under the accounts or sub-accounts.

Creating the Connected System in the 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 Canvas LMS 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.
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 naame 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.
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.
Connection Information
Web Service URL	The web service url with the hostname to contact the Canvas Instance.
Access Token	The access token generated from the Canvas Instance after creating sub-accounts.
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.

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.
Click the Apply button to apply changes. The Category Association window displays.
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.
2. Click the Add button to associate the selected object categories to the connected system.
Click OK to accept selected categories.

See Copying, Modifying, and Deleting Connected Systems for additional information.

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 Canvas LMS 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.
ExecuteGIGAssociatedTaskAsynchronously	Property which controls execution mode for GIG associated tasks. If this property is true and the task connected system has GIG association, task is executed asynchronously. If this property is false, GIG associated tasks will execute asynchronously with a blocking call. This blocking call can result in timeout issues if the task takes more time than the SOAP call timeout. This property is ignored if there is no GIG association or task is executed from Studio.
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 Canvas LMS directory.
Search	The elements that display depend upon the Search operation selected: User Id - Enter a User Id to search a specific user. Account Id - Enter an accountId that the user belongs to. Course Id - Enter a courseId and/or a UserType. Note: Course Id is mandatory.
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.
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. See the Configure Attributes window on page 39 for additional information.

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.
1. Select the Include Time check box to add the timestamp with the date.
2. Select the 24 Hour or 12 Hour option button and then select the required date/time format
3. 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 Canvas LMS 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: Users, Accounts or Course.
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.
Audit Key	Select the attribute which is to need to
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.

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

Canvas LMS Connector Attributes

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)
M = Mandatory (attribute is required for this operation)

User Data Format

This table outlines the supported User attributes. Attributes that are mandatory (M) are required for user creation. For attributes such as enrollment->courseId or logins->loginId, mandatory applies only for the sub attributes, for example, a user can be created without an additional login.

Note: All attributes for users (except password) are exportable.

Name	Description	Multivalued	Create	Modify	Remove	Export	Mandatory
userId	Unique user Id generated as each user is created. This is mandatory when modifying/deleting a user or user enrollment(s)).	N	N	M	M	Y	Y
sisuser_id	SIS ID for the user’s account. To set this parameter, the authorized user must be able to manage SIS permissions. Note: On User export, only the sisUserId associated with the primary login (uniqueId) is exported even when the user has additional logins, each associated with different sisUserIds.	N	Y	N	N	Y	N
userName	Full name of the user. This name will be used by the teacher for grading. Note: When deleting userName, it deletes the sortableName value too.	N	Y	Y	Y	Y	N
accountId	ID of the account to which the user belongs. This is mandatory when the user is created and also when the user or user enrollment(s) are modified or deleted. On a user export with a filter set (using userId), the accountId value for the account where the user belongs will not be fetched.	Y	M	M	M	Y	Y
defaultEmail	Default e-mail value of the user (primary e-mail). If no value is specified, the default e-mail of the user will be set with the user’s uniqueId value, even if the pattern of the String provided for the uniqueId does not correspond to an e-mail (for example, User1234).	N	Y	N	N	N	N
CommunicationEmail	Additional e-mail addresses associated to the user. Multiple addresses can be associated to the user. Note: Provide the CommunicationEmail value only if it is different from defaultEmail.	Y	Y	N	N	N	N
sortableName	User's name as it will be displayed in discussions, messages, and comments. Note: On deleting sortableName , the current value is deleted and Canvas LMS will reset to the default format (lastName,firstName).	N	Y	Y	Y	Y	N
shortName	User's name as used to sort alphabetically in lists. Note: On deleting shortName, the current value is deleted and Canvas LMS will reset to the default format (the same as the full name).	N	Y	Y	Y	Y	N
uniqueId	Login of the user. This is mandatory when creating a user. Note: uniqueId (set during user creation) should not already exist on the Canvas LMS system; if it does, a message displays indicating that the 'uniqueId is already taken'.	N	M	Y	N	Y	Y
Original_uniqueId	Original uniqueId for rename operations. This is mandatory for rename operations.	N	N	M	N	N	Y
password	Password associated to the user.	N	Y	Y	N	N	N
timeZone	Time zone for the user. Allowed time zones are listed in The Ruby on Rails documentation.	N	Y	Y	Y	N	N
locale	User's preferred language as a two-letter ISO 639 -1 code. Current supported languages are English ("en") and Spanish ("es").	N	Y	Y	Y	N	N
birthdate	User's birth date (format: Jan 1 1975).	N	Y	N	N	N	N
sendConfirmation	Send user notification of account creation if set to 1.	N	Y	N	N	N	N
enrollment->courseId	Id of the existing course that the user is enrolled in. courseId is mandatory when: · The user created needs to be enrolled in an existing course. · The user course enrollment(s) are modified. · The user course enrollment(s) are deleted.	Y	M	M	M	Y	Y
enrollment-> courseSectionNames	Section(s) under a course that the user is enrolled in. courseSectionNames is mandatory when user course enrollment(s) are deleted. Note: The user always needs to be enrolled in section(s) under a course. If there are no existing sections under a course during user enrollment, Canvas LMS will create a default section with the same name as the course and enroll the user under that section.	Y	Y	Y	M	Y	Y
enrollment-> courseSectionId	Id of the section(s) that the user is enrolled in.	Y	Y	Y	Y	Y	N
enrollment-> enrollmentStatus	Status of enrollment(s). Canvas LMS will set it as 'active' by default on user enrollment. Attribute values can be conclude or delete. Note: This attribute is not used in user creation. When modifying user enrollment(s), the default status is delete and enrollments will be deleted. When deleting enrollment(s), conclude or delete can be specified. If none is specified, delete will happen by default.	Y	N	Y	Y	N	N
enrollment->type	User enrollment type under each course section(s). The attribute values can be StudentEnrollment, TeacherEnrollment, TaEnrollment, or ObserverEnrollment. If no value is provided, the user will be enrolled as type StudentEnrollment by default. Note: The user can be enrolled in the same course section as different types (student and teacher).	Y	Y	Y	Y	Y	N
enrollment-> enrollmentState	Enrollment state of the user in a course. Attribute values can be active or invite. If set to active, the user will be enrolled immediately. The default is invite, where the user will have to accept an invitation to enroll.	Y	Y	Y	Y	Y	N
enrollment-> limitPrivilegesToCourseS ecion	Teacher or TA enrollment will be restricted to the section given by courseSectionName.	Y	Y	Y	Y	Y	N
logins->loginId	User can have additional or multiple login(s). loginId is mandatory when: · The user created needs multiple logins. · The user is modified to have multiple logins.	Y	M	M	Y	Y	Y
logins->loginsPassword	Additional password(s) corresponding to additional login(s).	Y	Y	Y	Y	N	Y

Notes:

Canvas LMS does not support foreign or special characters in uniqueId.

enrollment->courseSectionNames attribute:
- Add: When enrolling a user to a course having section(s), if courseSectionNames is not
  provided, the user gets enrolled to the default courseSection (having the same name as the
  course).
- Modify (Replace): When modifying user enrollment(s), if courseSectionNames is not provided, the user will be enrolled to the default courseSectionName of the new course replacing all existing user enrollment(s).

enrollment->type attribute:
- Add: When enrolling a user to a course section, if type is not specified, the user will always be
  enrolled as the student (StudentEnrollment type) by default.
- Modify: If the user is enrolled in the selected course section as multiple types (both as student
  and teacher) and when modifying user enrollment(s), if type is not specified, the
  StudentEnrollment type always gets modified by default.
- Delete: If the user is enrolled in the selected course section as multiple types (both as student
  and teacher) and when deleting user enrollment(s), if type is not specified, the
  StudentEnrollment type always gets deleted by default.

When creating a user, the uniqueId and password attributes represent the login and password the
user has to use to connect to Canvas LMS. Those two attributes represent the primary credentials
of the user. Additional logins and password can be added and modified through the login->loginId
and login->loginsPassword attributes.
The rename operation requires an additional attribute Original_uniqueId, which specifies the
uniqueId of the entry being renamed. After a rename operation, the Original_uniqueId attribute will
have the existing uniqueId value and the uniqueId attribute will be set with the new value passed
in.

Course Data Format

This table outlines the supported Course attributes. This connector supports creation, modification, deletion, and export of both course and course enrollment attributes. Enrollments represent the link between a user and a course. Mandatory attributes (M) are required for course creation

Name	Description	Multivalued	Create	Modify	Remove	Export	Mandatory
accountId	Id of the account where the course is created. This is mandatory when the course is being created and when the course or user(s) enrolled under a course are modified or deleted.	N	M	M	M	Y	Y
courseId	Id of the course. This is mandatory when: · Enrolling user(s) to existing courses. · Modifying/deleting a course or user(s) enrolled under the course.	N	N	M	M	Y	Y
courseName	Name of the course. This is mandatory when creating a new course. Note: If the current value is deleted, Canvas LMS will set the course name as Unnamed Course by default.	N	M	Y	Y	Y	Y
courseCode	Course code for the course. Notes: · If not provided on course creation, Canvas LMS will set this value to the same value as courseName by default. · If the current value is deleted, Canvas LMS will set courseCode as the same value as courseName.	N	Y	Y	Y	Y	N
status	Course status. Attribute values can be conclude or delete. Note: This attribute can be used only when deleting a course. When set to conclude, the course will be completed, and when set to delete, the course will be deleted. if not specified, delete is set by default.	N	N	N	Y	N	N
startAt	Course start date in ISO8601 format (e.g., 2011-01-01T01:00Z).	N	Y	Y	Y	Y	N
endAt	Course end date in ISO8601 format (e.g., 2011-01-01T01:00Z).	N	Y	Y	Y	Y	N
License	Name of the licensing. It should be one of the following abbreviations (a descriptive name is included in parenthesis for reference): 'private' (Private Copyrighted); 'cc_by_nc_nd' (CC Attribution Non-Commercial No Derivatives); 'cc_by_nc_sa' (CC Attribution Non-Commercial Share Alike); 'cc_by_nc' (CC Attribution Non-Commercial); 'cc_by_nd' (CC Attribution No Derivatives); 'cc_by_sa' (CC Attribution Share Alike); 'cc_by' (CC Attribution); 'public_domain' (Public Domain). Note: On deleting the current value, Canvas LMS will set License to the default value (Private).	N	Y	Y	Y	N	N
isPublic	Set to true if course is public. If true, on deletion, it is set back to the default value false.	N	Y	Y	Y	N	N
publicDescription	A publicly visible description of the course.	N	Y	Y	Y	N	N
allowStudentWikiEdits	If true, students will be able to modify the course wiki.	N	Y	Y	N	N	N
allowStudentAssignment Edit	Set to true if students should be allowed to make modifications to assignments.	N	Y	Y	N	N	N
allowWikiComments	If true, course members will be able to comment on wiki pages.	N	Y	Y	N	N	N
allowStudentForumAttac hments	If true, students can attach files to forum posts. If true, on deletion it is set back to the default value false.	N	Y	Y	Y	N	N
openEnrollment	Set to true if the course is open enrollment.	N	Y	Y	N	N	N
selfEnrollment	Set to true if the course is self-enrollment.	N	Y	Y	N	N	N
restrictEnrollmentsToCou rseDates	Set to true to restrict user enrollments to the start and end dates of the course. If true, on deletion it is set back to the default value false.	N	Y	Y	Y	N	N
sisCourseId	Unique SIS identifier.	N	Y	Y	N	N	N
offer	If true, the course will be set as published and is available to students immediately. If true, on deletion it is set back to the default value false.	N	Y	Y	Y	N	N
enrollments->type	User enrollment type under each course section(s). The attribute values can be StudentEnrollment, TeacherEnrollment, TaEnrollment, or ObserverEnrollment. If no value is provided, the user will be enrolled as type StudentEnrollment by default. Note: The user can be enrolled in the same course section as different types (student and teacher).	Y	Y	Y	Y	Y	N
enrollmentStatus	Status of the enrollment. Canvas LMS will set it as 'active' by default on a user enrollment to the course section. Note: This attribute is not used in course creation. When modifying user(s) enrollment(s), the status is set as delete by default and the enrollment(s) will be deleted. When deleting enrollment(s), conclude or delete can be specified. If none is specified, delete will be used.	Y	N	Y	Y	N	N
enrollment-> enrollmentState	Enrollment state of the user in a course. The attribute can have values active or invite. If set to active, the user will be enrolled immediately. The default is invite, where the user will have to accept an invitation to enroll.	Y	Y	Y	Y	Y	N
enrollment-> courseSectionName	Section(s) under a course that the user is enrolled in. courseSectionName is mandatory when user(s) course enrollment(s) are deleted. Note: The user always needs to be enrolled in section(s) under a course. If there are no section(s) under a course on the user(s) enrollment, Canvas LMS will create a default section with the same name as the course and enroll the user(s) under that section.	Y	Y	Y	M	Y	Y
enrollment-> courseSectionId	ID of the course section to enroll the student in. If the section-specific URL is used, this argument is redundant and will be ignored.	Y	Y	Y	Y	Y	N
enrollment-> limitPrivilegesToCourseS ecion	Teacher or TA enrollment will be restricted to the section given by courseSectionName.	Y	Y	Y	Y	Y	N

Notes:

enrollment->type attribute:
- Add: When enrolling a user to a course section, if type is not specified, the user will always be
  enrolled as the student (StudentEnrollment type) by default.
- Modify: If user(s) are enrolled in the selected course section as multiple types (both as student
  and teacher) and when modifying user(s) enrollment, if type is not specified, the
  StudentEnrollment type always gets modified by default.
- Delete: If user(s) are enrolled in the selected course section as multiple types (both as student
  and teacher) and when deleting user(s) enrollment(s), if type is not specified, the
  StudentEnrollment type always gets deleted by default.

enrollment->courseSectionNames attribute:
- Add: When enrolling user(s) to a course having section(s), if courseSectionNames is not
  provided, the user gets enrolled to the default courseSection (having the same name as the
  course).
- Modify (Replace): When modifying user(s) enrollment, if courseSectionNames is not provided,
  user(s) will be enrolled to the default courseSectionName of the new course.

Account Data Format

This table outlines the supported Account attributes.

Name	Description	Multivalued	Create	Modify	Remove	Export
id	ID of the account.	N	NA	NA	NA	Y
name	Display name of the account.	N	NA	NA	NA	Y
rootAccountId	Root account Id.	N	NA	NA	NA	Y
parentAccountId	Parent Account Id of the account	N	NA	NA	NA	Y

Notes:

A filter based on an account name can be set on export, which then exports only the account
details related to that specific account.
Exporting accounts will list all the accounts that the user can view or manage (the user should be
the one used to generate the token).

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 Canvas LMS system from the Select System drop-down list:
In the Enter Lookup Prefix field, enter the prefix to be added to the Lookup fields.
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:

6.1. 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.
6.2. 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.

7. Select the Lookup Type from the drop-down list. The updated Configure Lookup window displays, for example:

User lookup will not fetch the accountId value where the user belongs.

8. 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.
9. Click OK.

Handling Multiple Sub Records on Import and Export

A user can have multiple enrollment attributes such as courseId, courseSectionName, enrollmentState, and type. A user can also have multiple login attributes such as loginId and loginsPassword. A course can have multiple enrollment attributes such as courseSectionName, useruniqueId, State, and type.

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 logins->loginId is provided the delimiter "*".
Click OK.