CustomHelpLinks

Initial Build

 2017.1.27

Module

 Admin

Current Setting Type

Text Box

Modules > Admin > System Options > Find System Option

Use this system option to define additional links to display on the Get Help pop-up on the NetForum Enterprise application as required by your association. The links added to this system option will display below the NetForumHelpLinks on the Get Help pop-up.

Current Setting

The current setting for CustomHelpLinks is used as follows:

Values: This system option can be set to any valid web links to display on the Get Help pop-up.

Use the following format to setup a custom link: Enter the name of the link, a pipe (|) character, the actual link, and then a semicolon (;)

For example: Community Brands| https://www.communitybrands.com;

Default Value: empty

Important! The limit for the system option value's textbox is 1000 characters. The system will truncate anything exceeding this limit.

Note: Following scenarios are handled differently:

  • If the link is not formatted as described above or an invalid link is added to the system option, the system will not display the link on the Get Help pop-up.

  • If the website names are duplicated, the system will display only the first link on the Get Help pop-up.

  • If links are duplicates and the website names differ, then the system will display both links on the Get Help pop-up.

Fields 

This system option includes the following fields:

Description: This field gives the description of the system option, including its use and default value.

Important! Do not modify the following fields after the system option is first created. Changing these fields after they have been used can invalidate existing data.

Category: This field sets the category (usually the module) where the system option is used.

Type: The Type field determines the display type of the Current setting field (Checkbox, DropDownList, or Textbox).

Values: The values field indicates the allowed values for the Current setting field.

Availability

Each system option includes the following availability settings:

Entity Level Option?: Select this check box to make this system option available on an entity level.

Visible To External Systems?: Select this check box to make this system option available in xWeb.