Product Specification Resource Mappings

Constraints and Limitations

Before using the TMF620 product specification resource mappings, refer to the following.

While creating product specification, the record type is always product and not class.
While creating product specification, the status is always active and isActive is true.
While creating product specification, the life cycle status is always Draft.
While creating bundle product specification relationships the incoming parent product specifications already exist in the EPC. If the parent product does not exist in the Salesforce CRM database then it results in failure.
While creating product specification relationships the incoming relationship types are expected to be configured in EPC in advance.
While creating product specification relationships the incoming related product specifications already exist in the EPC. If the related product(s) not exist in the Salesforce CRM database then it results in failure.
The GlobalKey__c is used as the ID for the product specification resource and the sub-resource.
Custom metadata with label TMForumProductSpecificationUseChildForBu, decides the behaviour of BundledProductSpecification node. Default value is false, which means parent product specification to which the given product specification belongs to will be treated as the bundleProductSpecification. IP / DR will have mappings to reflect the parent product specification. Changing the value to false replaces the parent with the child product specification.
Manually you have to change the mappings for the BundledProductSpeicification node. This change will have impact on all the APIs such as GET, POST, and PATCH.
EPC product validation rules are applicable for both POST and PATCH.
BundledProductSpecification - Incoming id and name of this node can only be matched with global key and name of the product. This is cannot be customized to change the matching criteria or to add additional matching criteria(s).
productSpecificationRelationship - Incoming id and name of this node can only be matched with global key and name of the product. This is cannot be customized to change the matching criteria or to add additional matching criteria(s).

TMF Field	Type	Description	Salesforce Mapping	Salesforce Description	Prerequisite	Is mandatory?
href	string	Specifies a unique reference of the catalog.	TMF product specification URL + Product2.Id	Specifies the GET URL of the TMF product specification that ends with the ID field.	NA	No
description	string	Specifies the details of the product specification.	Product2.Description	Describes the product.	NA	No
name	string	Required. Specifies the name of the product specification.	Product2.Name	Specifies the name of the product.	Name attribute is required in the payload to create productSpecification.	Yes
productNumber	string	Specifies the identification number assigned to uniquely identify the specification.	Product2.ProductCode	Specifies the product code.	NA	No
lifecycleStatus	string	Specifies the current lifecycle status.	Product2.IsActive, Product2.vlocity_cmt__Status__c	Product2. IsActive field specifies the active status flag. Product2.Status__c field specifies the status of a product.	If lifecycleStatus is set to ‘Active’ in the payload, vlocity_cmt__IsActive__c is set as true, else false.	No
attachment	array	Specifies a list of attachment references or values (AttachmentRefOrValue [*]). Supplements the description of an element, such as a product, through videos or pictures.	vlocity_cmt__VlocityAttachment__c	Specifies the product attachments.	NA	No
validFor: startDateTime	object	Specifies the period for which the catalog is valid.	Product2.vlocity_cmt__EffectiveDate__c, Product2.vlocity_cmt__FulfilmentStartDate__c, Product2.vlocity_cmt__SellingStartDate__c, Product2.vlocity_cmt__VersionStartDateTime__c	Specifies the start dates of the validity period.	NA	No
validFor: endDateTime	object	Specifies the period for which the catalog is valid.	Product2.vlocity_cmt__EndDate__c, Product2.vlocity_cmt__EndOfLifeDate__c, Product2.vlocity_cmt__SellingEndDate__c, Product2.vlocity_cmt__VersionEndDateTime__c	Specifies the end dates of the validity period.	NA	No
version	string	Specifies the product specification version.	Product2.vlocity_cmt__VersionLabel__c	Specifies the version number of the product specification.	NA	No
bundledProductSpecification	array	Specifies a type of product specification that belongs to a grouping of product specifications made available to the market. A bundled product specification inherits all attributes of a product specification.	vlocity_cmt__ProductChildItem__c	Specifies the product child relationship.	NA	No
targetProductSchema	object	Specifies the reference object to the schema and type of a target product, which is described by the product specification.	Product2.vlocity_cmt__ObjectTypeId__c	Specifies the object type of a product.	NA	No
productSpecificationRelationship	array	Specifies migration, substitution, dependency, or exclusivity relationship between product specifications.	vlocity_cmt__ProductRelationship__c	Specifies the product relationships.	NA	No
isSellable	boolean	Indicates whether the product offer can be sold standalone (true) or within a bundle only (false).	Product2.vlocity_cmt__IsOrderable__c	Specifies if the product can be ordered or not.	NA	No
relatedParty	Related Party reference	A related party defines the party or party role linked to a specific entity.	Account	Specifies the account related to the product specification.	The account specified in the payload must exist in the Salesforce org.	No

TargetProductSchema Subresource Mappings

TMF Field	Type	Description	Salesforce Mapping	Salesforce Description	Prerequisite	Is mandatory?
@type	string	Specifies the Class type of the target product.	vlocity_cmt__ObjectClass__c.Name	Specifies the name of the Object Class.	NA	Yes

RelatedParty Subresource Mappings

TMF Field	Type	Description	Salesforce Mapping	Salesforce Description	Is mandatory?	Prerequisite
name	string	Specifies the name of the related party.	Account.Name	Specifies the name of the account.	Yes	NA
href	string	Specifies the hyperlink reference of the related party.	TMF Account URL + Account.Id	Specifies the GET URL of the TMF catalog that ends with the ID field.	No	NA
id	string	Specifies the unique identifier of the related party.	Account.AccountNumber	Specifies the external ID for the specified account.	Yes	NA
role	string	Specifies the role played by the related party.	Account.RecordType.Name	Specifies the record type of the account.	No	NA
			sObject	Specifies the sObject used for the related party. ‘Account’ is assigned as the default related party..	Yes	NA
			sObjectField	Specifies the key field used to get the related party record. ‘vlocity_cmt__VendorAccountId__c’ is the default value.	Yes	NA

Attachment Subresource Mappings

TMF Field	Type	Description	Salesforce Mapping	Salesforce Description	Is mandatory?	Prerequisite
name	string	Specifies the name of the attachment.	vlocity_cmt__VlocityAttachment__c.Name	Specifies the name of the attachment.	Yes	NA
description	string	Describes the content of the attachment.	vlocity_cmt__VlocityAttachment__c.vlocity_cmt__Description__c	Describes the attachment.	No	NA
href	string	Specifies the URI of the attachment.	TMF Attachment URL + VlocityAttachment.Id	Specifies the GET URL of the TMF attachment that ends with the ID field.	No	NA
id	string	Specifies the unique identifier of the attachment.	vlocity_cmt__VlocityAttachment__c.vlocity_cmt__AttachmentId__c	Specifies the ID of the attachment.	No	NA
url	string	The Uniform Resource Locator, which is a web page address and a subset of URI.	vlocity_cmt__VlocityAttachment__c.vlocity_cmt__UrlLong__c	Specifies the URL of the attachment.	No	NA
attachmentType	string	Specifies the attachment type, such as a video or a picture.	vlocity_cmt__VlocityAttachment__c.vlocity_cmt__ContentType__c	Specifies the content type, such as a picture, a video, or a file.	No	NA

BundledProductSpecification Subresource Mappings

TMF Field	Type	Description	Salesforce Mapping	Salesforce Description	Prerequisite	Is mandatory?
href	string	Specifies the hyperlink reference of the product specification.	TMF Attachment URL + Product2.Id	Specifies the GET URL of the TMF product specification that ends with the ID field.	NA	No
id	string	Specifies a unique identifier of the product specification.	vlocity_cmt__ProductChildItem__c.vlocity_cmt__ParentProductId__r. vlocity_cmt__GlobalKey__c	Specifies the external ID of the parent product.	Product with the specified ID and Name must exist in the system.	Yes
name	string	Specifies the name of the product specification.	vlocity_cmt__ProductChildItem__c.vlocity_cmt__ParentProductId__r.Name	Specifies the name of the parent product.	Product with the specified ID and Name must exist in the system.	Yes
lifecycleStatus	string	Specifies the current lifecycle status.	vlocity_cmt__ProductChildItem__c.vlocity_cmt__ParentProductId__r.lifecycleStatus	Specifies the current lifecycle status.	NA	No

ProductSpecificationRelationship Subresource Mappings

TMF Field	Type	Description	Salesforce Mapping	Salesforce Description	Is mandatory?	Prerequisite
name	string	Specifies the name of the related entity.	vlocity_cmt__ProductRelationship__c.vlocity_cmt__ProductId__r.Name	Specifies the name of the related product.	Yes	NA
id	string	Specifies a unique identifier of the product specification relationship.	vlocity_cmt__ProductRelationship__c.vlocity_cmt__ProductId__r. vlocity_cmt__GlobalKey__c	Specifies the external ID of the related product.	Yes	NA
href	URI	Specifies the hyperlink reference of the product specification relationship.	TMF Attachment URL + Product2.Id	Specifies the GET URL of the TMF product specification that ends with the ID field.	No	NA
relationshipType	string	Specifies the type of relationship, such as migration, substitution, dependency, or exclusivity.	vlocity_cmt__ProductRelationship__c.vlocity_cmt__RelationshipType__c	Specifies the relationship type. The expected values must be configured in Salesforce CRM before invoking the resource.	No	NA

ProductSpecCharacteristic Subresource Mappings

TMF Field	Type	Description	Salesforce Mapping	Salesforce Description	Prerequisite	Is mandatory?
name	string	Specifies a word, term, or phrase by which the characteristic specification is known and distinguished from other characteristic specifications.	vlocity_cmt__Attribute__c.Name, vlocity_cmt__AttributeAssignment__c.Name, vlocity_cmt__Picklist__c.Name	Specifies the name of the attribute and attribute assignment.	NA	Yes
description	string	Describes the CharacteristicSpecification object.	vlocity_cmt__Attribute__c.vlocity_cmt__Description__c	Describes the attribute.	NA	No
valueType	string	Specifies a type of value that the characteristic can accept, such as numeric and text.	vlocity_cmt__Attribute__c.vlocity_cmt__ValueDataType__c, vlocity_cmt__Picklist__c.vlocity_cmt__DataType__c	Specifies the external ID of the related product.	NA	Yes
productSpecCharacteristicValue: value	array	Defines a set of attributes, each of which can be assigned to a corresponding set of attributes in a ProductSpecificationCharacteristic object.	vlocity_cmt__Attribute__c.vlocity_cmt__Value__c, vlocity_cmt__PicklistValue__c.Name	Specifies the value of the attribute.	NA	Yes
			vlocity_cmt__AttributeCategory__c	Specifies the category of the attribute.	The Attribute Category specified in the custom metadata TMForumDefaultAttributeCategory, must be present in the Salesforce org.	No