Custom Portal Settings

Administrators with advanced SQL experience can implement custom settings for the Vista Web portal.

Important: This topic is intended for users who are experienced with SQL and SQL testing. Any modifications to standard stored procedures and objects related to custom portal settings are not supported by Trimble Viewpoint's customer support team.

To create a custom setting, use a SQL client to insert your custom setting code directly into the Config table of the KDS-HRIM database. Custom settings will appear in Admin > Portal Settings > User Defined > General Configuration. There is no user interface for creating these settings.

Custom portal settings should not be used to store any sensitive data such as usernames or passwords, as they do not support encryption.

See the definitions below for details about important columns in the Config table.

Config Table Column Definitions

ConfigName

A unique name to identify the setting.

ConfigDescription

A useful description that displays when the user selects the setting.

ConfigDataType

The data type of the setting. This attribute supports several values:

  • Lookup: A portal lookup, represented as a lookup dropdown on the portal settings page.
  • Text: A simple text value, represented as a text box on the portal settings page. There is no character limit.
  • Bit: A true/false value, represented as a checkbox on the portal settings page. A value of 1 is checked and 0 is unchecked.
  • Color: An HTML color value, represented as a color wheel on the portal settings page.
  • Date: A date value, represented as a calendar picker on the portal settings page.
  • Usergroup: A portal user group, represented as a user group dropdown on the portal settings page. Users will be able to select an existing group or create a new one.
  • Attachment: An existing Vista DM Attachment Type, represented as an attachment type dropdown on the portal settings page.
  • Dropdown: A simple drop down type with hard-coded values, represented as a dropdown on the portal settings page. Dropdown values are defined in the ConfigBuilderTypes field with the pattern: DatabaseValue1,DisplayValue1|DatabaseValue2,DisplayValue2|etc.
  • Textarea: A larger text value, represented as a text area control on the portal settings page. There is no character limit.
  • Int: A numeric value, represented as a text box on the portal settings page.
  • Rich: A rich text value, represented as a rich text editor on the portal settings page.
ConfigValue

The value of the portal setting as selected by the user from the portal settings page.

ValidationRegex

A regular expression that is used to validate the setting when saved.

DateAdded

The date/time when the portal setting was added.

ModifiedByName

The name of the user who last modified the setting in the Portal Settings page.

ConfigSubCatg

Set this attribute to 111 for all custom settings.

IsPreRelease

Set this attribute to 0 for all custom settings.

DateLastModified

The date/time of the last setting value update made in the Portal Settings page.

IsAdvanced

Set this to 1 to only display the portal setting when a user selects Show Advanced Settings.

ConfigBuilderTypes

This is used by the Dropdown value of the ConfigDataType attribute, as explained above.

ExcludeFromWeb

Set this attribute to 1 for all custom settings.

MobileSetting

Set this attribute to 0 for all custom settings.

AvailableFromAnonymous
Set this to 1 to display this setting to non-logged in users. This attribute is used to implement custom settings in pages that can be viewed without being logged in, such as the Login or Career pages.
Note: It is recommended to set this attribute to 0 for custom settings.

The following columns are not supported by custom settings and must have a null value:

  • ConfigBuilderFormat
  • ConfigBuilderLabels
  • ConfigBuilderRegex
  • ConfigValueBin
  • DefaultConfigValue