ServiceSetupAssistantSettings

Represents an organization’s Service Setup Assistant settings. The Service Setup Assistant can be used to set up a basic service console app.

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

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

ServiceSetupAssistantSettings values are stored in the ServiceSetupAssistant.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 

Introduced in API version 50.0.

Fields 

enableServiceSetupAssistant 

  • Type: boolean
  • Required: No
  • Description: Indicates whether the Service Setup Assistant is enabled (true) or not (false).

Declarative Metadata Sample Definition 

The following is an example of a ServiceSetupAssistantSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ServiceSetupAssistantSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3	<enableServiceSetupAssistant>true</enableServiceSetupAssistant>
4</ServiceSetupAssistantSettings>

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.