-
Notifications
You must be signed in to change notification settings - Fork 0
Setup and Configuration
Upon activating the UCF Degree CPT Plugin, you should configure your plugin settings in the WordPress admin, under Settings > UCF Degree.
Enables the REST API route /degrees/ using the WP REST API.
You should enable this setting if you intend on using the UCF Degree Search Plugin in conjunction with this plugin.
The base URL of the UCF Search Service API. Should end with /api/v1/ with trailing slash. This value must be set for Search Service writebacks to take effect.
Unless you're testing against a local or development version of the UCF Search Service, this value should always be https://search.cm.ucf.edu/api/v1/.
The API key used to access the Search Service API. This is required for all API calls and must be set for Search Service writebacks to take effect.
Additional query parameters to pass to the Search Service's program list view when importing degrees. You do not need to pass your API key as a param here. This value can be left blank.
This value should be structured as a valid query param string, e.g. a=something&b=another-thing.
When checked, a degree's post content value will be written to the UCF Search Service as a program description when that degree is saved. The post content will be saved as a description object in the Search Service using the description type assigned via the "Description Type" plugin option.
Enabling description writebacks to the Search Service allows for other users using the Search Service to easily access your site's custom degree description. Enabling this setting is not required and is disabled by default.
The description type to set when writing degree descriptions to the Search Service. You should always designate a description type that is specific to your site. Available description types are set via the Search Service and must be added by a Search Service administrator.
If you see an error message instead of a dropdown list of description types, ensure your Search Service Base URL and API Key are valid, and reload the plugin options page. If you still don't see any results, try clearing your site's transient data, or try again after the cached transient data expires (24 hrs).
When checked, a degree's permalink will be written to the UCF Search Service as a program profile when that degree is saved. The permalink will be saved to a program profile object in the Search Service using the program profile type assigned via the "Profile Type" plugin option.
Enabling profile writebacks to the Search Service allows for other users using the Search Service to easily reference the location of your site's individual degree information. Enabling this setting is not required and is disabled by default.
The profile type to set when writing program profiles to the Search Service. You should always designate a profile type that is specific to your site. Available profile types are set via the Search Service and must be added by a Search Service administrator.
If you see an error message instead of a dropdown list of profile types, ensure your Search Service Base URL and API Key are valid, and reload the plugin options page. If you still don't see any results, try clearing your site's transient data, or try again after the cached transient data expires (24 hrs).