Custom Help Domain

The Custom Help Domain operates like the Help Domain, however it has an added benefit: it can be combined with the Help URL function to create custom help links for Custom Objects (excludes Built-in or CRM objects).

The following sections describe typical situations and the result when a user clicks the Help icon in a Custom Object.

How the Custom Help Domain and Help URL Work

• The platform automatically checks for http/https protocols; If they are not present, they are prefixed to the Help URL
• The custom Help URL can be an Absolute URL or it can be combined with the Custom Help Domain as a Relative URL:

• Absolute URL Example

Custom Help Domain	not applicable (When the Help URL is specified as an absolute URL, this value is ignored)
Help URL for an Inventory object	http://www.mydomain.com/help/inventory
Result: Click the Help icon in the Inventory object to invoke help at: http://www.mydomain.com/help/inventory

• Relative URL Example

Custom Help Domain	www.customhelp_mydomain.com
Help URL for an Inventory object	inventory
Result: Click the Help icon in the Inventory object to invoke help at: http://www.customhelp_mydomain.com/inventory

The Effect of Custom Help Domain and Help URL Settings

Both the Custom Help Domain and the Help URL are optional. These examples describe how user help is provided when these values are specified or omitted.

• Custom Help Domain and Help URL are specified

  All the specified Help URLs for Custom Objects are treated as relative to Custom Help Domain if they do not start with http:// or https://

Example:

Custom Help Domain	www.customhelp_mydomain.com
Help URL	inventory
Resulting help URL for the object is: http://www.customhelp_mydomain.com/inventory

Example:

Custom Help Domain	www.customhelp_mydomain.com
Help URL	http://myhelpdomain.com/inventory Because the http:// is specified in the Help URL, the Custom Help Domain information is not used
Resulting help URL for the object is: http://myhelpdomain.com/inventory

• Custom Help Domain is not specified

  The Custom Help URLs for objects are treated as complete URLs and are used to display help

Example:

Custom Help Domain:	n/a
Help URL	http://myhelpdomain.com/inventory
Resulting help URL for the object is: http://myhelpdomain.com/inventory

• Custom Help Domain and Help URL are not specified

  A generic help URL is formed using the 'Help Domain' field in Service Provider Settings.

Example:

Custom Help Domain:	n/a
Help URL:	n/a
Resulting help URL for the object: Reverts to the default Help Domain