Functionalities
This connector supports both identity and Provisioning.
The Identity functionalities of this connector enable you as an Identity administrator to configure Moodle 2 as a connected system and then make Identity users part of the Moodle 2 system. This enables the user or Identity administrator to reset Moodle 2 account passwords.
The Provisioning functionalities of this connector enable exporting and importing user accounts on a Moodle 2 system.
Identity Integration
Product Feature |
Supported |
|---|---|
Test Connection |
Yes |
Validate User |
Yes |
Enable/Disable User |
No |
Reset Password |
Yes |
*Expire Password (with Date) |
No |
*For Password expiration, include details such as immediate, future, or both.
Provisioning Integration
Product Feature |
Supported |
User Account |
|
Create user account |
Yes |
Modify user account |
Yes |
Delete user account |
Yes |
Export user accounts |
Yes |
Lookup Users |
Yes |
Assign Profile Item |
Yes |
Assign Course |
Yes |
Assign Group |
Yes |
Course |
|
Create Course |
Yes |
Update Course |
No |
Delete Course |
Yes |
Export Course |
Yes |
Group |
|
Create Group |
Yes |
Update Group |
Yes |
Delete Group |
Yes |
Create Category |
Yes |
Assign User |
Yes |
Unassign User |
No |
Category |
|
Create Category |
Yes |
Modify Category |
Yes |
Delete Category |
Yes |
Export Category |
Yes |
Prerequisites
Ensure that these prerequisites are satisfied:
- Moodle 2 Version 3 or 2.4 is installed, configured, and running.
- REST Web Service access.
- Create a dedicated Web Service user
- Give this user all the capabilities required
- Create a Web Service "Service"
- Create a token for this user (see Setup Moodle 2 Web Service below.)
Setup Moodle 2 Web Service
Required: A running Moodle 2.x installation.
Here are two complete guides:
- Moodle official documentation: http://docs.moodle.org/24/en/
How_to_create_and_enable_a_web_service - Joomla documentation (Similar process, but instead of XML-RPC, we are using REST) HYPERLINK "http://www.joomdle.com/wiki/Preparing_Moodle_20" \l
"Setting_up_Moodle_Web_services" http://www.joomdle.com/wiki/
Preparing_Moodle_20#Setting_up_Moodle_Web_services
Create User
We are going to create a dedicated user for the web service and will use this user to make every Web Service calls.
-
Go to the administration panel, create a new user, in the advanced properties, set his authentication as "web service". Setting web service as authentication will make sure that this user cannot be used for anything else other than web service access.
Note: Do not use your administrator or an existing user. It would be a good idea to create a user dedicated to execute Fischer’s calls to the web service.
Set User Permissions - To attribute the new user some permissions, we need to create a new role. To do so, go to Site Administration ► Users ► Permissions ► Define Roles, and click Add a new Role.
Then in Context Types, select System.
In the capability table, allow Use REST Protocol, and every operation that you are going to use. It is recommended to give minimal rights to reduce security risks.
Assign the user to the new role
- Go to Users ► Permissions ► Assign System Roles, and associate the new role to the web service user.
- When this is done, enable the web services and access. You can have an overview of the steps by accessing Site Administration ► Plugins ► Web services ► Overview.
- Enable Web Services.
Enable Protocol
We are using REST.
Create a new dedicated service
-
Add a "service" to define what our connector can call inside Moodle,
-
Create the new service by going to Site Administration ► Plugins ► Web services ► External Services.
Add functions to the service
- After creating the service, you will be prompted to add functions to it. Select all the functions you are going to use.
Add Authorized user for the service
Assign the dedicated web service user to the new service as an authorized user.
- To do so, go to Site Administration ► Plugins ► Web services ► External services.
- Click on Authorized users for the new service and add the web service user you created previously.
Create token
The finall step is to create a token that will be used in the connector configuration page.
Go to Site Administration ► Plugins ► Web services ► Manage tokens, and click on Add.
Select the user and service we created, and click Save.
You can also add an IP restriction to make sure this token is only used from this IP address and you can add a token expiration.
Click Save.
On the next page, you will see the newly created token. You can copy this token:
Creating the Connected System
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 Moodle 2 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 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 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. Enable Transfer of Accounts
Select to make the connected system Transfer of Accounts enabled (default: cleared).
Connection Information Web Service URL URL to the REST Web Service in Moodle. Please use HTTPS, since all information is going to be sent to this URL.
Web Service Token
Dedicated Web Service user Token, used to authenticate against the REST Web Service. This token is used for user provisioning. It is similar to a service account except that the token is a single value and it is used by the connector for all provisioning operations.
Replace “example.com” with the address of the Moodle server. Rest of the URL is static and should not need to change.
Login URL
URL to be used for user authentication in Identity. The service query parameter indicates which service to use to authenticate the user in identity. Reason for exposing this as an additional parameter is that the REST Web Service does not provide any means to authenticate a user given their id and password. Hence, we have to use a different URL to perform this operation. This is documented in HYPERLINK "http:// docs.moodle.org/dev/Creating_a_web_service_client" \l "How_to_get_a_user_token" http://docs.moodle.org/dev/ Creating_a_web_service_client#How_to_get_a_user_token.
Moodle Version Select the Moodle 2 version.
Password Expiration Support Expiration Options For Admin/OBO User Password Reset Specify the password expiration: None or Immediate.
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, theses messages may display:
Message: Connection from Provisioning to the connected system was established successfully.
Message: Connection from Identity to the connected system was established successfully.- If unsuccessful, these messages may display:
Error: Failed to establish connection from Provisioning 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.
Error: Failed to establish connection from Identity to the connected system.
-
(Optional) To select owners of the system, click the System Owner Add button. The Connected System Owner Search page displays:
-
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.
To add additional system owners, click the Add button.
-
- 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:
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.
Click the Add Association button to associate the selected object categories to the connected system.
Click the Back button to return to the Connected System View page. The new connected system displays in the list.
See Copying, Modifying, and Deleting Connected Systems for additional information.
Studio
- Log in to the Workflow and Connectivity Studio and click Connectivity ► Add Systems on the menu bar. The Add Connected Systems window displays.
- Select the Moodle 2 connected system from the Type drop-down list. The default values display.
-
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. Description The description of the 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: - 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.
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. Enable Transfer of Accounts
Select to make the connected system Transfer of Accounts enabled (default: cleared).
Connection Information Web Service URL URL to the REST Web Service in Moodle. Please use HTTPS, since all information is going to be sent to this URL.
Web Service Token
Dedicated Web Service user Token, used to authenticate against the REST Web Service. This token is used for user provisioning. It is similar to a service account except that the token is a single value and it is used by the connector for all provisioning operations.
Replace “example.com” with the address of the Moodle server. Rest of the URL is static and should not need to change.
Login URL
URL to be used for user authentication in Identity. The service query parameter indicates which service to use to authenticate the user in identity. Reason for exposing this as an additional parameter is that the REST Web Service does not provide any means to authenticate a user given their id and password. Hence, we have to use a different URL to perform this operation. This is documented in HYPERLINK "http:// docs.moodle.org/dev/Creating_a_web_service_client" \l "How_to_get_a_user_token" http://docs.moodle.org/dev/ Creating_a_web_service_client#How_to_get_a_user_token.
Moodle Version Select the Moodle 2 version.
Password Expiration Support Expiration Options For Admin/OBO User Password Reset Specify the password expiration: None or Immediate.
- Click the Connect button to test the Connection Information:
- If successful, one or both of these messages may display:
Connection from Studio to the connected system was established successfully.
- If unsuccessful, one or both of these messages may display:
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.
-
Click the Apply button to apply changes. The Category Association window displays.
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.
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 Identity
Perform these procedures to configure the connector:
- Connector Details for Identity
- Identity Password Management
Connector Details for Identity
Field |
System Attribute |
|---|---|
| Login ID | username |
| Account ID | id |
Identity Password Management
See User Management for details on password management.
Using the Connected System for Provisioning
Perform these procedures to configure the connector:
- Configuring for Export
- Configuring for Import
- Connector Details for Provisioning
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 Moodle 2 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: User, Course or CourseCategory. 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
- 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
- AllAttributes - Performs a full export of all attributes that contain a
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 If this property is True, GIG associated tasks will execute asynchronously. ExportMode Select the type of data to export:
- FullExport - Exports all
- DeltaExport - Exports changed, mandatory, or all attributes, depending on the DeltaExportMode property
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 scope and return specific results (see Set Filter Examples below).
-
Search operation Select the operation of the filter. This represents the attribute name for searching the Moodle 2 directory.
Search Select one of the following search criteria for the Search operation:
- userId - Get the user with this
- idnumber - Get the user with this
- username - Get the user with this
- UserInfo - Select an attribute as filter criteria (e.g., username, city, department, email, etc.), and then enter a value for the selected criteria. Note: Only literal values are assigned for
Filter Syntax Displays the filter syntax used to retrieve entries from the Moodle 2 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
3. (Optional)Select the Attributes tab.
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. |
| Reset Schema | Resets the schema definition to the default schema prepackaged with the IdM Suite, plus any global variable added. |
4. (Optional) Select the Appearance tab to change how the Connected System object displays in the Design pane.
5. 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
Format Displays the Format Date window to specify a date/time format to be applied to the selected date type attribute, for example, whenChanged. During export, the attribute’s value is converted to the specified format. See the Format Date steps below for additional information.
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. See the Configure Attributes window on page 39 for additional information. - From the Attribute Selection tab, select attributes to export.
- (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 checkbox 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 Moodle 2 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: User, Course or CourseCategory. 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.
ExecuteGIGAssociatedTaskAsynchronously If this property is True, GIG associated tasks will execute asynchronously. 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 (default), the connector accepts multi-level attributes in a folded state.
Notes: * accountDN, Id, and login id 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. Check for attribute-level auditing. If auditing is enabled and these attributes below are checked, Provisioning will log all events for auditing purposes.
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. 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).Audit Key Select the attribute to associate with the Audit Key.
- 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 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.
Connector Details for Provisioning
Connector Attributes
The items in the Export, Create, Modify, and Delete columns have these meanings:
- Y = Yes (the attribute is supported for this operation)
- N = No (attribute is not supported for this operation)
- Highlighted cells show differences in operations
User Attributes
Name |
MultiValued |
Description |
Create | Modify |
Delete |
Export |
Mandatory |
|---|---|---|---|---|---|---|---|
address |
N |
Address |
N |
N |
N |
Y |
N |
aim |
N |
AIM ID |
N |
N |
N |
Y |
N |
auth |
N |
Choose an authentication method (see Authentication Methods) |
Y |
Y |
Y |
Y |
N |
city |
N |
City/town |
Y |
Y |
Y |
Y |
N |
confirmed |
N |
Active user: 1 if confirmed, 0 otherwise |
N |
N |
N |
Y |
N |
country |
N |
Home county code of the user, such as AU or CZ |
Y |
Y |
Y |
Y |
N |
courses _ courseId |
Y |
Course Id (depends on the course identifier selected) |
Y |
Y |
N |
Y |
Y |
|
courses _ courseRoles |
Y |
Course Roles |
Y |
Y |
N |
Y |
Y |
|
courses _ courseSuspend |
Y |
Set to 1 to suspend the enrollment |
Y |
Y |
N |
N |
N |
|
courses _ courseTimeStart |
Y |
Timestamp when the enrollment starts |
Y |
Y |
N |
N |
N |
|
courses _ courseTimeEndt |
Y |
Timestamp when the enrollment ends |
Y |
Y |
N |
N |
N |
|
customFields _ customFieldName |
Y |
The name of the custom field |
Y |
Y |
N |
Y |
Y |
|
customFields _ customFieldShortName |
Y |
The shortname of the custom field |
N |
N |
N |
Y |
N |
|
customFields _ customFieldType |
Y |
The type of the custom field - text field, checkbox... |
N |
N |
N |
Y |
N |
|
customFields _ customFieldValue |
Y |
The value of the custom field |
Y |
Y |
N |
Y |
Y |
department |
N |
Department |
N |
N |
N |
Y |
N |
description |
N |
User profile description, no HTML |
Y |
Y |
Y |
Y |
N |
descriptionFormat |
N |
Description format (See below) |
Y |
Y |
Y |
Y |
N |
N |
A valid and unique email address. |
Y |
Y |
Y |
Y |
Y |
|
firstAccess |
N |
First access to the site (0 if never) |
N |
N |
N |
Y |
N |
firstName |
N |
First name |
Y |
Y |
Y |
Y |
Y |
fullName |
N |
Full name |
N |
N |
N |
Y |
N |
groups _ attached- CourseId |
Y |
Course Id to which the group is tied |
Y |
Y |
N |
Y |
Y |
groups _ groupId |
Y |
Group Id (Depends on the GroupIdentifier selected) |
Y |
Y |
N |
Y |
Y |
icq |
N |
ICQ ID |
N |
N |
N |
Y |
N |
id |
N |
Internal Id |
N |
Y |
Y |
Y |
N |
idNumber |
N |
Id Number |
Y |
Y |
Y |
Y |
N |
institution |
N |
Institution |
N |
N |
N |
Y |
N |
interests |
N |
User interests (separated by commas) |
N |
N |
N |
Y |
N |
lang |
N |
Preferred language |
N |
Y |
Y |
Y |
N |
lastAccess |
N |
Last access to the site (0 if never) |
N |
N |
N |
Y |
N |
lastName |
N |
Surname |
Y |
Y |
Y |
Y |
Y |
mailFormat |
N |
Mail format code is 0 for plain text, 1 for HTML etc. |
Y |
Y |
Y |
Y |
N |
msn |
N |
MSN ID |
N |
N |
N |
Y |
N |
Original_username |
N |
Original Username for remaining |
N |
Y |
Y |
N |
N |
password |
N |
Password |
Y |
Y |
Y |
N |
Y |
phone1 |
N |
Phone |
N |
N |
N |
Y |
N |
phone2 |
N |
Mobile Phone |
N |
N |
N |
Y |
N |
|
preferences _ preferenceType |
Y |
The name of the preference |
Y |
N |
N |
Y |
N |
|
preferences _ preferenceValue |
Y |
The value of the preference |
Y |
N |
N |
Y |
N |
profileImageUrl |
N |
Current picture |
N |
N |
N |
Y |
N |
profileImageUrlSmall |
N |
Current picture thumbnail |
N |
N |
N |
Y |
N |
skype |
N |
Skype ID |
N |
N |
N |
Y |
N |
theme |
N |
Theme name such as "standard", must exist on server |
Y |
Y |
Y |
Y |
N |
timezone |
N |
Timezone |
Y |
Y |
Y |
Y |
N |
url |
N |
Web page |
N |
N |
N |
Y |
N |
userName |
N |
Username |
Y |
Y |
Y |
Y |
Y |
yahoo |
N |
Yahoo ID |
N |
N |
N |
Y |
N |
Authentication Methods
These are the default authentication methods for Moodle 2.
Displayed Name |
Internal Name |
CAS server (SSO) |
cas |
External database |
db |
Email-based self-registration |
|
FirstClass server |
fc |
IMAP server |
imap |
LDAP server |
ldap |
Manual |
manual |
Moodle Network authentication |
mnet |
NNTP server |
nntp |
No login |
nologin |
No authentication |
none |
PAM (Pluggable Authentication Modules) |
pam |
POP3 server |
pop3 |
RADIUS server |
radius |
Shibboleth |
shibboleth |
Web services |
webservice |
Format Options
Format Number |
Format |
0 |
Moodle |
1 |
HTML |
2 |
Plain |
3 |
Markdown |
Course Attributes
|
Name |
Multi-valued |
Description |
Create |
Modify |
Delete |
Export |
Mandatory |
categoryId |
N |
Category Id |
Y |
N |
N |
Y |
Y |
categoryIdSortOrder |
N |
Sort order into the category |
N |
N |
N |
Y |
N |
completionNotify |
N |
1: yes 0: no |
Y |
N |
N |
Y |
N |
completionStartOnEnrol |
N |
1: begin tracking a student’s progress in course completion after course enrollment. 0: does not |
Y |
N |
N |
Y |
N |
courseFormatOptions ► courseFormatOption Name |
Y |
course format option name |
Y |
N |
N |
Y |
N |
courseFormatOptions ► courseFormatOption Value |
Y |
course format option value |
Y |
N |
N |
Y |
N |
defaultGroupingId |
N |
default grouping id |
Y |
N |
N |
Y |
N |
enableCompletion |
N |
Enabled, control via completion and activity settings. Disabled, not shown in activity settings |
Y |
N |
N |
Y |
N |
forceTheme |
N |
name of the force theme |
Y |
N |
N |
Y |
N |
format |
N |
course format: weeks, topic, social, site,... |
Y |
N |
N |
Y |
N |
fullName |
N |
Full Name |
Y |
N |
N |
Y |
Y |
groupMode |
N |
no group, separate, visible |
Y |
N |
N |
Y |
N |
groupModeForce |
N |
1: yes, 0: no |
Y |
N |
N |
Y |
N |
|
groups ► groupDescription |
Y |
group description text |
Y |
Y |
Y |
Y |
N |
|
groups ► groupDescriptionFormat |
Y |
description format (See below) |
Y |
Y |
Y |
Y |
N |
|
groups ► groupEnrolmentKey |
Y |
group enrol secret phrase |
Y |
Y |
Y |
Y |
N |
groups ►_ groupId |
Y |
group Internal Id |
N |
Y |
Y |
Y |
N |
groups ► groupName |
Y |
multilang compatible name, course unique |
Y |
Y |
Y |
Y |
N |
hiddenSections |
N |
(deprecated, use courseformatoptions) How the hidden sections in the course are displayed to students. |
Y |
N |
N |
Y |
N |
firstName |
N |
First name |
Y |
Y |
Y |
Y |
Y |
fullName |
N |
Full name |
N |
N |
N |
Y |
N |
groups ► attached- courseId |
Y |
Course Id to which the group is tied |
Y |
Y |
N |
Y |
Y |
groups ► groupId |
Y |
Group Id (Depends on the GroupIdentifier selected) |
Y |
Y |
N |
Y |
Y |
icq |
N |
ICQ ID |
N |
N |
N |
Y |
N |
id |
N |
Internal Id |
N |
Y |
Y |
Y |
N |
idNumber |
N |
Id Number |
Y |
Y |
Y |
Y |
N |
institution |
N |
Institution |
N |
N |
N |
Y |
N |
interests |
N |
User interests (separated by commas) |
N |
N |
N |
Y |
N |
lang |
N |
Preferred language |
N |
Y |
Y |
Y |
N |
lastAccess |
N |
Last access to the site (0 if never) |
N |
N |
N |
Y |
N |
lastName |
N |
Surname |
Y |
Y |
Y |
Y |
Y |
mailFormat |
N |
Mail format code is 0 for plain text, 1 for HTML etc. |
Y |
Y |
Y |
Y |
N |
msn |
N |
MSN ID |
N |
N |
N |
Y |
N |
Original_username |
N |
Original Username for remaining |
N |
Y |
Y |
N |
N |
password |
N |
Password |
Y |
Y |
Y |
N |
Y |
phone1 |
N |
Phone |
N |
N |
N |
Y |
N |
phone2 |
N |
Mobile Phone |
N |
N |
N |
Y |
N |
|
preferences ► preferenceType |
Y |
The name of the preference |
Y |
N |
N |
Y |
N |
|
preferences ► preferenceValue |
Y |
The value of the preference |
Y |
N |
N |
Y |
N |
profileImageUrl |
N |
Current picture |
N |
N |
N |
Y |
N |
profileImageUrlSmall |
N |
Current picture thumbnail |
N |
N |
N |
Y |
N |
skype |
N |
Skype ID |
N |
N |
N |
Y |
N |
theme |
N |
Theme name such as "standard", must exist on server |
Y |
Y |
Y |
Y |
N |
timezone |
N |
Timezone |
Y |
Y |
Y |
Y |
N |
url |
N |
Web page |
N |
N |
N |
Y |
N |
username |
N |
Username |
Y |
Y |
Y |
Y |
Y |
yahoo |
N |
Yahoo ID |
N |
N |
N |
Y |
N |
Import Data Format
The User data format can create, modify, and delete Moodle users. The data source configuration property SubRecordsInFoldedState must be set to accept sub records in a folded state.
Available Lookups
Type |
Name |
Arguement |
Description |
User |
getByUserId |
User Id |
Get user corresponding to User Id. |
User |
getByUserInfo |
Criteria, Value |
Get user matching criteria and value |
User |
getByCourse |
Course Id |
Get Users enrolled in course matching Course Id |
User |
getByCourseAnd Capabilities |
Course Id, Capabilities |
Get Users enrolled in course matching Course Id that have matching capabilities |
User |
getByGroup |
Group Ids |
Return users enrolled in Groups matching Groups Id |
Course |
course_getByCourseId |
Course Id |
Return course corresponding to Course Id |
Course |
course_getByUserId |
User Id |
Return courses in which user with User Id is enrolled. |
At export time, you can also use lookups as filter by going through the connector configuration window.
Lookup Data
To find existing users and return specific attribute values for users, 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 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 Moodle 2 system from the Select System drop-down list:
In the Enter Lookup Prefix field, enter the prefix to be added to the Lookup fields.
Select the Lookup Type from the drop-down list. Only User is currently supported.
-
Click the Fields Pick button to select the attributes to be fetched after a successful lookup. The
Lookup Configuration window displays:
Select the attribute(s) from the Selected Attributes list that require a date and/or time format, and click the Format 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.
- Click the Filter Build button, and then from the Set Filter window, generate the search filter, for example
Lookups can be performed using these variables: userid, idnumber, username, and UserInfo. See Set Filter for a description of this window -
Click OK. 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.