TMF651 v4 Resource Mappings

Before using the TMF651 v4 resource mappings, refer to the following.

Constraints and Limitations

Agreement Specification

• The TMF resource AgreementSpecification is mapped to DocumentTemplate 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 in AgreementSpecification is unique. Two records with same name are stored with different version.
• The version in AgreementSpecification is auto-populated with increasing count for each unique name and is available in the GET method. The POST method does not support version.
• POST Method:
  • The relatedParty in AgreementSpecification is the owner. Only one relatedParty is supported in POST method.
  • The relatedParty in AgreementSpecification must be an existing user in the system. The user license must be Salesforce.
  • The type field Salesforce entity DocumentTemplate must have a picklist value of Web.
  • The TokenMappingType field in Salesforce entity DocumentTemplate must have a picklist value of JSON.
  • Validation only checks if the attachment and relatedParty (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 always Draft.
• 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.

Agreement

• To generate the endDate of a Contract/Agreement, include the attribute agreementTerm(term in months) in the POST payload. The response attribute completionDate will have the resulting endDate generated from startDate and agreementTerm attributes.
• Obligation startDate must be after the agreement startDate.
• These are patchable attributes: description, engagedParty, associatedAgreement,agreementSpecification,agreementItem`
• Filtering is supported for attribute name. Full word search only is supported.
• Attribute selection is supported for name.

Agreement Specification Resource

Sub-resources

attachment

relatedParty

Agreement

NOTE: In order to generate endDate as part of agreementPeriod add the field agreementTerm(term in months) in POST payload. Salesforce will use this field and startDate fields to calculate and populate the field completionDate.

AssociatedAgreement

ProductOffering

This is mapped to Salesforce entity: Sales Contract Line. A list of product offering references (ProductOfferingRef [*]). The list of product offerings referred by this agreement item.

TermOrCondition

This is mapped to Salesforce entity: Obligation. A list of agreement term or conditions (AgreementTermOrCondition [*]). Aspects of the agreement not formally specified elsewhere in the agreement and that cannot be captured elsewhere in a formal notation, or automatically monitored and require a more human level of management.

AgreementSpecificationRef

This is mapped to Salesforce entity: DocumentTemplate. An agreement specification reference (AgreementSpecificationRef). An AgreementSpecification represents a template of an agreement that can be used when establishing partnerships.

engagedParty

This is mapped to Salesforce entity: Account (associated Account of the Contract). A list of related parties (RelatedParty [1..*]). Related Entity reference. A related party defines party or party role linked to a specific entity.

NOTE: As the role field is a picklist, add configuration details for customer setup on what values must be used for initial setup.