HelpSettings

Represents the org setting that changes the destination of help.salesforce.com to an alternative URL. Use this setting to deploy and retrieve the alternative Help URL.

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for details.

File Suffix and Directory Location

HelpSettings values are stored in the Help.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

Version

HelpSettings components are available in API version 68.0 and later.

Special Access Rules

To retrieve or deploy HelpSettings, users need the Customize Application permission. You can’t create or delete this component. HelpSettings isn’t supported in unlocked packages.

Fields

Field Name	Description
alternativeUrl	Field Type string Description The alternative URL that opens when users access Salesforce Help. The URL can contain up to 255 characters and must be a valid URL. If validation fails, deployment returns an INVALID_OPERATION error. If the element is omitted from a deployment, the existing URL doesn’t change. To clear the alternative URL, leave the field blank.

Declarative Metadata Sample Definition

The following is an example of a HelpSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<HelpSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <alternativeUrl>https://help.example.com/docs</alternativeUrl>
4</HelpSettings>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>Help</members>
5        <name>Settings</name>
6    </types>
7    <version>68.0</version>
8</Package>

Wildcard Support in the Manifest File

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide