Preferences Config

Introduction to managing Preference Configuration within DataGuard

🚧

WARNING

There are restrictions on particular actions related to Capture Templates and Capture Points (e.g. you can’t disable elements that are used in a Capture Template). If you experience issues these will need to be manually corrected through the UI.

The preferences configuration API is available here.

Overview

The above shows the initial UI screen. The Preferences are arranged in a list containing the ID, reference, label and created date associated with each item. The list is ordered by reference. The ID and the Reference fields have buttons for copying direct to the clipboard to assist with interaction with the system elsewhere.

Create Preferences

New Preferences can be added via the 'Create Preference' button in the upper right hand side of the screen. This will open a lightbox shown in the image below.

1. Add a label – this is what the user/customer will see in the capture point (e.g. "which topics are you interested in?")

2. Add a reference. This must be unique within the application, and you will get an error if you try to submit a duplicate.

3. Select a Type from Single Choice (only one option can be chosen by the user) or Multi Choice (one or more options can be chosen by the user). Single choice types are rendered as radio buttons in the DataGuard capture point default styling (editable), multiple choices are show as checkboxes.

4. Enter the choices that you want the user to see in the list. These are added individually. The reference will be automatically populated.

The 'Create Preference' button is inactive until the user has populated at least the Label and Reference fields and created a single Choice, as shown below.

Once the 'Create Preference' button is clicked the Preference is created and returning to the main screen the list has been updated to reflect the new item.

Edit Preferences

Existing preferences can also be updated via this UI by clicking on the ID you wish to change in the list. Clicking on the ID corresponding to the 'colour' reference for example would open another lightbox shown below.

After making any desired changes clicking the 'Update Preference' button will submit the Preference and return the user to the list view containing all updates.

🚧

References Edited via API (only)

Currently the reference used for a preference can not be edited via the UI once it has been saved. If you wish to amend a reference you will need to update it via the API, or create a new preference.