Accessed via the Portals Control Panel, the Custom Field Filter (CFF) manager allows you to create new CFFs and manage existing CFFs.
A Custom Field Filter allows you to map a single search field used by the Weblink Search API to one or more Custom Fields.
These Custom Fields can be either Learning Path or Course Template fields.
Once mapped, developers can make use of those fields as documented within the developer portal: https://developer.getadministrate.com/docs/api#CustomFieldFilter
Creating a CFF
CFFs are created per portal. First navigate to the Portal via Control Panel -> Portals:
Select the Weblink Portal and you will be shown a list of the currently configured CFFs.
Select "Add Filter" to create a new Filter:
Label: The label that will be used for the CFF. This should be a name that would make sense to an end user who may be presented with this field. For example, "Food option"
Type: The type of field that will be presented to the learner. This should be either Text, Checkbox or Multichoice. The type selected here will determine which custom fields can be mapped below.
Mappings - One or more Custom Fields can be mapped. The Custom Fields section of the Control Panel is used to manage these fields.
Source: Determine whether the mapped custom field is associated with a Course Template or a Learning Path
Field: The Custom Field that will be mapped. Note that the options here will be limited to the fields that are the same type as selected earlier.
To view the CFFs for a given Portal, a user must have the
Portal - View permission.
To add, edit or delete CFFs for a given portal, a user must have the
Portal - Edit permission.