User Tools

Site Tools


You are not allowed to perform this action
fadmin_customsettings

Custom Settings

Custom settings are values that you want to have available that are not normally held as part of fSeries. These are then accessible using the Setting function, and so can be used, for example, within your DSDs.

A custom setting must have a key and a name. The key must not already exist as a standard fSeries setting or a setting required by any of your data gatherers (often custom gatherers will require specific settings to be added to the list of fSeries settings; it is not necessary to add them here as they will be discovered and added automatically).

By default the format is text but you can specify one of the following alternatives:

  • Boolean (Yes/No) - held as true/false
  • Number
  • Select List (see below)
  • Text Area (multi-line)

If you choose Select List you will be asked to add a list of valid values from which the administrator may choose.

A help text may be added which will be displayed on the Settings page under the entry as a guide.

Finally, specify which areas of fSeries (if any) the setting is relevant to. This makes it easier for the administrator to find it in the Settings page.