Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Document Template Update Input

Input representation to update a document template.

JSON example

1{
2  "isActive": "false",
3  "status": "Draft",
4  "documentGenerationMechanism": "ClientSide",
5  "extractOmniDataTransformName": "Extractor",
6  "mapperOmniDataTransformName": "Mapper",
7  "shouldDisplayUnmappedToken": "false",
8  "tokenList": "token1,token2,token3",
9  "tokenMappingMethodType": "ContextService",
10  "contextDefinitionName": "QuoteProposal",
11  "contextMappingName": "QuoteToContextMapping",
12  "customClassName": "QuoteBundleTransformer", 
13  "contextFilterName": "QuoteWithLargeQtyLineItems",
14  "contextTransformationName": "QuoteBundleTransformation",
15  "usageType": "Contract_Lifecycle_Management",
16  "contentDocumentId": "069xxxxxxxxxxxxxxx"
17}

Properties

Name	Type	Description	Required or Optional	Available Version
`contentDocumentId`	String	ID of the document associated with a document template.	Optional	60.0
`contextDefinitionName`	String	Name of the context definition that contains the mapping details used for extraction in the Context Service token mapping type.	Required if the tokenMappingMethodTypeproperty is set to `ContextService`.	64.0
`contextMappingName`	String	Name of the context mapping used for extraction in the Context Service token mapping type.	Required if the tokenMappingMethodTypeproperty is set to `ContextService`.	64.0
`contextFilterName`	String	Name of the context filter that’s used to filter, order, or limit the data extracted from the context service at run time. This property is available only when tokenMappingMethodType property value is `ContextService`.	Optional	66.0
`contextTransformationName`	String	Name of the context transformation that’s used to transform the data extracted from the context service at run time. This property is available only when tokenMappingMethodType property value is `ContextService`.	Optional	67.0
`customClassName`	String	Name of a custom Apex class that’s used to transform token data before document generation. This property is available only when tokenMappingMethodType property value is `ContextService`.	Optional	66.0
`documentGenerationMechanism`	String	Specifies the method for generating the document. Possible values are: `Client-side` `Server-side` The default value is `Client-side`.	Optional	60.0
`extractOmniDataTransformName`	String	Name of the OmniDataTransform bundle of the extract type.	Optional	60.0
`isActive`	Boolean	Indicates whether the document template is set to active (`true`) or inactive (`false`).	Optional	60.0
`mapperOmniDataTransformName`	String	Name of the OmniDataTransform bundle of the mapper type.	Optional	60.0
`shouldDisplayUnmappedToken`	Boolean	Indicates whether the document template unmapped tokens be displayed (`true`) or not (`false`).	Optional	60.0
`status`	String	Status to be set for the document template.	Optional	60.0
`tokenList`	String	List of tokens present in the document template.	Optional	60.0
`tokenMappingMethodType`	String	Processing method for data that can originate from the same source object. Possible values are: `ContextService` `OmniDataTransform` The default value is `ContextService`	Required	60.0
`usageType`	String	Usage type of the document template.	Optional	60.0

Salesforce Contracts

Document Template Update Input