Importing Enterprise Attributes into Quickstart
Overview
The Enterprise Attributes initiative provides a centrally managed dataset for organizing university content. The az_enterprise_attributes_import
module in Quickstart allows you to import and sync these attributes automatically.
📌 Enterprise Attributes API: Trellis API
How It Works
- Automatically imports attributes on installation, fetching and storing data immediately.
- Unpublishes removed attributes, ensuring the taxonomy reflects the current state of the API.
- Schedules automatic imports using cron, ensuring regular updates without manual intervention.
- Retrieves data from the API.
- Stores attributes as taxonomy terms in the az_enterprise_attributes vocabulary.
- Maintains hierarchy by mapping parent-child relationships.
- Provides an admin interface for configuration and manual imports.
Setup & Configuration
- Go to Configuration > Enterprise Attributes Import (
/admin/config/az-enterprise-attributes-import/settings
). - Enter the API Endpoint URL (Default:
https://api.trellis.arizona.edu/ws/rest/events/v1/enterprise-attributes
). - The module automatically imports attributes upon installation. Additional imports can be triggered by saving the settings form.
Managing Imported Data
- The vocabulary is locked by default via a setting in
az_core
, preventing manual modifications. - A custom field widget (
attributes_select
) is available for selecting allowed attributes on entity reference fields. - Imports are automatically scheduled via cron, keeping data up to date without manual effort.
- View and edit attributes under Structure > Taxonomy > Enterprise Attributes.
- The module automatically updates the data with each import and unpublishes any removed attributes to maintain consistency.
- Manual imports can be triggered by saving the settings form again.
Technical Details
- Custom Field Widget:
attributes_select
(Allows selecting allowed enterprise attributes in entity reference fields). - Migration ID:
az_enterprise_attributes_import
- Stored in:
taxonomy_term
(Vocabulary:az_enterprise_attributes
, provided byaz_core
) - Dependencies:
migrate
,migrate_plus
,migrate_tools
,migrate_queue_importer