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.
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 |
- Field Type
- string
- Description
- Required.
- The path from the root in the external storage where
documents are stored.
|
| externalDocStorageIdentifier |
- Field Type
- string
- Description
- Required.
- The ID of the external document storage.
|
| masterLabel |
- Field Type
- string
- Description
- Required.
- A user-friendly name for ExternalDocStorageConfig, which
is defined when the ExternalDocStorageConfig is
created.
|
| namedCredential |
- Field 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 |
- Field Type
- string
- Description
- The record type associated with the Reference
object.
|
| storageDriveType |
- Field Type
- StorageDriveType (enumeration of type string)
- Description
- Required.
- The external document storage drive.
|
| targetObject |
- Field Type
- TargetObject (enumeration of type string)
- Description
- The target object associated with the external document
storage.
Possible values are:
- All
- Contract
- DocumentTemplate
|
Declarative Metadata Sample Definition
The following is an example of a ExternalDocStorageConfig component.
The following is an example package.xml that
references the previous definition.
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.
j