TMF651 Resource Mappings
Before using the TMF651 resource mappings, refer the following.
- Required Platform license: Contract Management.
- Required Addon: ContractManagementAddon, DocGenDesigner.
- Enable Salesforce Contracts on the org.
- Required Org permissions: ContractMgmt, DocGen, and CommsCloud.
- The TMF resource
AgreementSpecification
is mapped toDocumentTemplate
entity. This requires OrgPerm - DocGen and addon license DocGenDesigner. - Following additional fields are used on the core
Contract
entity by enabling the ContractMgmt OrgPerm.ContractType
PreviousContract
ParentContract
name
- The
name
inAgreementSpecification
is unique. Two records with same name are stored with different version. - The
version
inAgreementSpecification
is auto-populated with increasing count for each unique name and is available in the GET method. The POST method does not supportversion
. - POST Method:
- The
relatedParty
inAgreementSpecification
is the owner. Only onerelatedParty
is supported in POST method. - The
relatedParty
inAgreementSpecification
must be an existing user in the system. The user license must beSalesforce
. - The
type
field Salesforce entityDocumentTemplate
must have a picklist value ofWeb
. - The
TokenMappingType
field in Salesforce entityDocumentTemplate
must have a picklist value ofJSON
. - Validation only checks if the
attachment
andrelatedParty
(user) exists in the system. - The API user must have CLM Admin User and PSL Contract Life Cycle Management User permission set.
- The
lifecycleStatus
value in the response is alwaysDraft
.
- The
- Two or more
AgreementSpecification
cannot have same attachment. - Attribute selection and filter is supported for first level attribute
name
. - Filtering on the
name
is only with ‘Full word’. Prefix search is not supported. - Attribute selection is supported for valid fields. In case invalid fields are provided then a list of all items with identifier is displayed.
- The
attachment
is patchable attribute. Non-patchable attributes are sent in the payload are ignored.
TMF Field | TMF type | TMF Definition property | Is Mandatory as per TMForum? | Is Supported | Supported Methods property | SF Definition property | SF mapping |
---|---|---|---|---|---|---|---|
href | String | Reference of the agreement specification | No | Yes | Not supported in PATCH, DELETE payloads. This is present in GET, POST response. | URI of the DocumentTemplate | - |
id | String | Unique identifier of the agreement specification | No | Yes | Not supported in PATCH, DELETE payloads. This is present in GET, POST response. | Unique identifier of the Salesforce DocumentTemplate record | SF id |
lifecycleStatus | String | Indicates the current lifecycle status | No | Yes | Picklist. This will have value of 'Draft' after POST. Supported in GET, POST payloads. | Specifies the status of the document template | Status |
name | String | Name of the agreement specification | Yes | Yes | Supported in GET, POST payloads. | Name of the DocumentTemplate | Name |
@type | String | Type of TMF resource | No | Yes | Not supported in GET, POST, PATCH, DELETE payloads. This is present in POST response. | Type of the TMF Entity e.g. AgreementSpecification | - |
attachment | List | An attachment by value or by reference. An attachment complements the description of an element, for example through a document, a video, a picture | Yes | Yes | Minimum one attachment is required. Supported in GET, POST, PATCH payloads. | Specifies the Content Document associated with DocumentTemplate | Content Document Entity |
relatedParty | List | Related Entity reference. A related party defines party or party role linked to a specific entity | No | Yes | Supported in GET, POST payloads. | Owner of the DocumentTemplate | User |
TMF Field | TMF type | TMF Definition property | Is Mandatory as per TMForum? | Is Supported? | Supported Methods | SF Definition | SF mapping |
---|---|---|---|---|---|---|---|
attachmentType | String | Attachment type such as video, picture. | No | Yes | Supported in GET response | Type of the ContentDocument | FileType |
href | String | URI for this Attachment | No | No | Supported in GET response | URI of the ContentDocument | |
id | String | Unique identifier for this particular attachment | Yes | Yes | Supported in GET, POST, PATCH payloads. | Id of the ContentDocument | SF id |
mimeType | String | Attachment mime type such as extension file for video, picture and document. | No | Yes | Supported in GET response | Specifies the mimetype of the ContentDocument | FileExtension |
name | String | The name of the attachment | No | Yes | Supported in GET, POST payloads. | Title of the ContentDocument | Title |
TMF Field | TMF type | TMF Definition property | Is Mandatory as per TMForum? | Is Supported? | Supported Methods | SF mapping |
---|---|---|---|---|---|---|
id | String | Unique identifier of a related entity | No | Yes | Supported in GET, POST payloads. | SF id of the user |
name | String | Reference of the related entity. | No | Yes | Supported in GET, POST payloads. | name of the User |