Profiles Integration

[tadean]

Motivation

It would be convenient if there were a way to import data about a given person from Profiles, since this data already exists. This feature is intended to make it easier for sites with large numbers of faculty to import person data.

Proposed Resolution

Describe the solution you'd like

Provide an import form where Person data can be imported via netid from profiles integration.

[danahertzberg]

Next Steps - Phase 1 Detail

Phase 1 provides a minimally invasive integration with UA Profiles. It only pulls in data that maps cleanly to existing fields in AZ Person and doesn't require any updates to any of the existing views or view displays.

Necessary Configuration Pages

• A page for Administrators to enter a Profiles API key.
• A page for Content Administrators to enter a list of NetIDs to import from UA Profiles.
  • If any of the NetIDs listed are not associated with existing Persons, new Person nodes will be created.
  • If any of the NetIDs listed are already associated with existing Persons, those Person nodes will be updated with info from the Profiles API. All Editable fields will be left alone (Should this be a configuration option?), all Uneditable fields will be overwritten. Help text should explain this.

Field Mapping:

• Profiles API value → az_person fields
• First Name (givenname) → field_az_fname
  • Editable: False
• Last Name (surname) → field_az_lname
  • Editable: False
• Profile Picture (photo_url) → field_az_media_image
  • Editable: Need decision (We will likely receive requests to make this field editable, but there is a lot of benefit to being able to update this in one place and have it propagate. Note: The current documentation for editing your profile does not include steps to update your profile picture and most faculty profiles are missing a photo.)
• Titles (Titles[].desc) → field_az_titles
  • Editable: True
  • Reorder: True
• NetID (netid) → field_az_netid
  • Editable: False
• Email (email) → field_az_email
  • Editable: False
• Phone (phone[].number) → field_az_phones
  • Editable: False
• Address The address data from the Profiles API includes multiple components that need to be combined for proper display:
  • Street Address (office[].fq_office)
  • City (location[].city)
  • State (location[].state)
  • Zip Code (location[].zip)

These components will be concatenated to form a single field_az_address field to match the existing structure of the "Person" content type.

Note: If the Profiles API is updated to include an option to not display addresses, we will want the ability to either remove this data or not display it.

• Biography (Bio.desc) → field_az\body
  • Editable: True
• Degrees (Degrees[]) → field_az_degrees
  • Editable: Need decision
• Job Titles (Titles[].desc) → field_az_titles
  • Editable: True
  • Reorder: True

Testing & Validation:

Define test cases to verify successful data import, including validation for data integrity.

• Basic Field Import Test: Import a test NetID and confirm all mapped fields (e.g., first name, last name, email) appear correctly in the "Person" content type.
• Edit-ability Test: Ensure that fields marked as "editable" remain unchanged when the Profiles API is updated, while "non-editable" fields are overwritten.
• Address Concatenation Test: Verify that address components are correctly concatenated into field_az_address.
• Update Test for Existing Records: Test updating an existing "Person" profile using the same NetID to ensure fields are updated according to the editability rules.
• Ensure that API access issues are non-destructive: Test that data on a site is not updated or deleted in the case that the API is unreachable or fails to return results.