Configure Profile Sync between Wicket and Moodle

Ryan Knuth
Ryan Knuth
  • Updated

The user addresses and phone numbers saved in Moodle profiles are not accessible through the Moodle API. To sync these values with Wicket, custom fields will need to be created for the profiles, following these steps:

  1. Go to “User profile fields” located under the "Users > Accounts" sub-menu in the Site Administration section (/user/profile/index.php).

    moodle-user-profile-fields.png

  2. Click “Create a new profile category,” enter “Contact Information” as the Category name, then click “Save changes.”

    moodle-user-profile-fields-create-new.png

  3. Create the custom fields for contact information: The following fields will need to be created in the “Contact Information” section.
  • Phone Type
  • Primary Phone
  • Address Type
  • Street Address
  • Apt / Suite
  • City
  • State/Province Code
  • Zip/Postal Code
  • Country

    To create each field, click “Create new profile field” located at the bottom of the page and choose the corresponding type for each field:

    Phone Type

  • Type: Drop-down menu
  • Short name: phone_type
  • Name: Phone Type
  • Category: Contact Information
  • Menu options: home work mobile
  • Default value: mobile

    Primary Phone

  • Type: Text input
  • Short name: primary_phone
  • Name: Primary Phone
  • Category: Contact Information

    Address Type

  • Type: Drop-down menu
  • Short name: address_type
  • Name: Address Type
  • Category: Contact Information
  • Menu options: home work
  • Default value: work

    Street Address

  • Type: Text input
  • Short name: street_address
  • Name: Street Address
  • Category: Contact Information

    Apt / Suite

  • Type: Text input
  • Short name: appt_suite
  • Name: Apt / Suite
  • Category: Contact Information

    City

  • Type: Text input
  • Short name: city
  • Name: City
  • Category: Contact Information

    State/Province Code

  • Type: Text input
  • Short name: state_name
  • Name: State / Prov Code (2-digits)
  • Display Size: 2
  • Maximum Length: 2
  • Category: Contact Information

    Zip/Postal Code

  • Type: Text input
  • Short name: zip_code
  • Name: Zipcode
  • Category: Contact Information

    Country

  • Type: Text input
  • Short name: country_code
  • Name: Country
  • Category: Contact Information
  1. Lock user fields: To avoid potential duplication of data, some user data fields need to be locked so users won’t be able to edit them. Go to the “Manual accounts” page (admin/settings.php?section=authsettingmanual), under the "Plugins > Authentication" sub-menu in the Site Administration section.

    moodle-lock-user-fields.png

    In the “Lock user fields” section, choose “Locked” from the dropdown menu on the following fields, and click "Save changes."
  • City/Town
  • Country
  • Address
  • Phone
  • Mobile phone

The custom field configuration is now complete and ready for synchronization.

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Article is closed for comments.