Help Center

Menu

Set or update a results page configuration option

Results page configuration keys are managed from the results page configuration editor.

This is accessed from the results page management screen, by selecting edit results page configuration from the customize panel.

The configuration key editor opens allowing you to add, remove, edit, publish and unpublish configuration keys.

Adding a key

  1. Click the add new button.

  2. Start typing the key name into the parameter key field. If the key is a built-in key it will appear in the auto-complete menu and can be selected from the list. If the key is a custom or plugin key then you will need to type in the complete key name, and then click the item in the dropdown once the key name is fully entered.

  3. (Optional) Select an environment if applicable.

  4. Fill in the remaining fields. Some fields will be populated by default values which can then be edited. The fields will vary depending on the type of key. Some allow you to select predefined values, others require you to enter a value into the text input box.

  5. Save the key by clicking the save icon, or select the save all button to save all edits.

  6. Publish the key by clicking the publish button, or select the publish all button to publish all unpublished changes.

Editing a key

If you edit any plugin configuration keys that have a * in the key name (e.g. plugin.*.version) you must first unpublish the key before making any changes.

  1. Locate the key you wish to edit in the list of configured keys.

  2. Click on the row to edit the key.

  3. Update the values as desired.

  4. Save the key by clicking the save icon, or select the save all button to save all edits.

  5. Publish the key by clicking the publish button, or select the publish all button to publish all unpublished changes.

You can preview your changes by searching against the preview version of your results page from the results page management screen search box, but changes won’t be visible on your live search until you have published the changes.

Deleting or reverting a key

A key is removed by either resetting it to the default value (if it’s a built-in key) or deleting it (if it is a custom or plugin key).

  1. Locate the key you wish to remove in the list of configured keys.

  2. If the key is published you need to first unpublish the key by clicking the unpublish button.

  3. Click on either the delete () or revert () icon to remove or reset the key to the default value.

  4. A dialog box opens. Either click the delete or revert button depending on if you are deleting or resetting a value to the default.

See also