ExternalDocStorageConfig

Represents configuration, which admin makes in setup to specify the drive, path, and named credential to be used for storing documents on external drives.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type

This type extends Metadata metadata type and inherits fullName field.

File Suffix and Directory Location

ExternalDocStorageConfig components have the suffix .externalDocStorageConfig and are stored in the externalDocStorageConfigs folder.

Version

ExternalDocStorageConfig components are available in API version 57.0 and later.

Fields

documentPath

Type: string

Description: Required.

The path from the root in the external storage where documents are stored.

externalDocStorageIdentifier

Type: string

Description: Required.

The ID of the external document storage.

masterLabel

Type: string

Description: Required.

A user-friendly name for ExternalDocStorageConfig, which is defined when the ExternalDocStorageConfig is created.

namedCredential

Type: string

Description: Required.

The Named Credential associated with the External Document Storage Configuration. A named credential can be specified as an endpoint to simplify the setup of authenticated call outs.

recordType

Type: string

Description: The record type associated with the Reference object.

storageDriveType

Type: StorageDriveType (enumeration of type string)

Description: Required.

The external document storage drive. Possible value is MicrosoftOneDrive

targetObject

Type: TargetObject (enumeration of type string)

Description: The target object associated with the external document storage. Possible values are All, Contract, DocumentTemplate, Disclosure, or InfoLibraryExternalDocument

Declarative Metadata Sample Definition

The following is an example of a ExternalDocStorageConfig component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ExternalDocStorageConfig
3	xmlns="http://soap.sforce.com/2006/04/metadata">
4	<documentPath>/Salesforce/Contracts/</documentPath>
5	<externalDocStorageIdentifier>ExternalDocIdTest1234</externalDocStorageIdentifier>
6	<masterLabel>Contract_Contract_Lifecycle_Management</masterLabel>
7	<namedCredential>Salesforce</namedCredential>
8	<recordType>ContractLifecycleManagement</recordType>
9	<storageDriveType>MicrosoftOneDrive</storageDriveType>
10	<targetObject>Contract</targetObject>
11</ExternalDocStorageConfig>

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

1<?xml version="1.0" encoding="UTF-8"?>
2<Package
3	xmlns="http://soap.sforce.com/2006/04/metadata">
4	<fullName>ExternalDocStorageConfigObjectPackage</fullName>
5	<types>
6		<members>Contract_Contract_Lifecycle_Management</members>
7		<name>ExternalDocStorageConfig</name>
8	</types>
9	<version>57.0</version>
10</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.