Custom Metadata

Get to know the custom metadata components for TMF620 API resources. Custom Metadata types enable you to create your own setup objects with records as metadata rather than data.

  • After an upgrade, ensure the Value and Default Valuefield values are updated as per the values in these tables. If any of the values aren't updated automatically, manually update the values as per the corresponding values in the table.
  • If any customer wants to restrict the OOB values available for the API, then Default Value field must be updated with the respective values. Because, the value of the Default Value field is takes precedence over the Value field value. We do not recommend changing the values of these two fields to different values.
    For example, if the customer wants to implement only GET and DELETE methods for TMF620 Catalog resource, then the Default Value field of the metadata record TMForumCatalogMethods must be changed to GET, DELETE instead of GET,POST, PATCH, DELETE.
Metadata NameDescriptionDefault ValueAvailable VersionIncluded in the CME managed package (Yes/No)
TMForumCategoryVIPNameInvoked by the GET Category API. See Extend Industry API section for modifications.TMF_TMForumCategory57.0Yes
TMForumCreateCategoryVIPNameInvoked by the POST Category API. See Extend Industry API section for modifications.TMF_TMForumCreateCategory56.0Yes
TMForumCategoryMethodsAllow or restrict one or more method names (comma-separated) by customer implementations among the out-of-box available methods.POST, GET, PATCH, DELETE56.0Yes
TMForumCategoryRequestDRData Mapper name that's used to map filtering parameters from TMF fields to Salesforce fields in the GET Category API.TMFTMForumGetCategoryInputResponse57.0Yes
TMForumPatchCategoryVIPNameInvoked by the PATCH Category API. See Extend Industry API section for modifications.TMF_TMForumPatchCategory56.0Yes
TMForumDeleteCategoryVIPNameMetadata used to store VIP Name for deleteCategory. Invoked by the DELETE Category API. See Extend Industry API section for modifications.tmf_TMForumDeleteCategory58.0Yes
Metadata NameDescriptionDefault ValueAvailable VersionIncluded in the CME managed package (Yes/No)
TMForumCatalogVIPNameInvoked by the GET Catalog API. See Extend TMF620 API section for modifications.TMF_TMForumCatalog57.0Yes
TMForumCreateCatalogVIPNameInvoked by the POST Catalog API. See Extend TMF620 API section for modifications.tmf_TMForumCreateCatalog56.0Yes
TMForumCatalogMethodsAllow or restrict one or more method names (comma-separated) by customer implementations among the out-of-box available methods.POST, GET, PATCH, DELETE56.0Yes
TMForumCatalogRequestDRDR name that's used to map filtering parameters from TMF fields to Salesforce fields in the GET Catalog API.TMFTMForumTransformGetCatalogInputResponse57.0Yes
TMForumPatchCatalogVIPNameInvoked by the PATCH Catalog API. See Extend Industry API section for modifications.TMF_TMForumPatchCatalog56.0Yes
TMForumDeleteCatalogVIPNameMetadata used to store VIP Name for deleteCatalog. Invoked by the DELETE Catelog API. See Extend Industry API section for modifications.tmf_TMForumDeleteCatalog58.0Yes
TMForumPriceListThe value of this metadata record is used as the pricelist for the catalog. Users can override the OOB value.B2C56.0Yes
Metadata NameDescriptionDefault ValueAvailable VersionIncluded in the CME managed package (Yes/No)
TMForumProductSpecificationVIPNameInvoked by the GET Product Specification API. See Extend TMF620 API section for modifications.TMF_TMForumProductSpecification56.0Yes
TMForumCreateProductSpecificationVIPNameInvoked by the POST Product Specification API. See Extend TMF620 API section for modifications.tmf_TMForumCreateProductSpecification56.0Yes
TMForumProductSpecificationMethodsAllow or restrict one or more method names (comma-separated) by customer implementations among the out-of-box available methods.POST, GET, PATCH, DELETE56.0Yes
TMForumProductSpecificationRequestDRDR name that's used to map filtering parameters from TMF fields to Salesforce fields in the GET and POST methods of the productSpecification API.TMFTMForumProductSpecificationRequestTransform56.0Yes
TMForumProductSpecificationResponseDRDR name that's used to map filtering parameters from Salesforce fields to TMF fields in the GET and POST methods of the productSpecification API.TMFTMForumProductSpecificationResponseTransform56.0Yes
TMForumProductSpecificationFiltersComma-separated fields that can be used as a filter to get a product specification using the GET productSpecification API.id, name, productNumber, lifecycleStatus, isBundle, version56.0Yes
TMForumProductSpecificationUseChildForBuIndicates whether to consider the incoming bundled product specifications as child product specifications of an incoming product specification (true) or not (false). With a default value as false, the incoming bundled product specifications are set to parent product specifications. The TMForumProductSpecificationUseChildForBu value is consistent for both GET and POST APIs.false56.0Yes
TMForumDeleteProductSpecificationVIPNameMetadata used to store VIP Name for Delete Product Specification. Invoked by the DELETE Product Specification API. See Extend TMF620 API section for modifications.TMF_TMForumDeleteProductSpecification58.0Yes
TMForumPatchProductSpecificationVIPNameInvoked by the PATCH Product Specification API. See Extend TMF620 API section for modifications.tmf_TMForumPatchProductSpecification58.0Yes
Metadata NameDescriptionDefault ValueAvailable VersionIncluded in the CME managed package (Yes/No)
TMForumProductOfferingVIPNameInvoked by the GET Product Offering API. See Extend TMF620 API section for modifications.tmf_TMForumCreateProductOffering56.0Yes
TMForumCreateProductOfferingVIPNameInvoked by the POST Product Offering API. See Extend TMF620 API section for modifications.tmf_TMForumCreateProductOffering56.0Yes
TMForumProductOfferingFiltersComma-separated fields that can be used as a filter to get a product offering using the GET productOffering API.id, name, lifecycleStatus, isBundle, isSellable, version56.0Yes
TMForumProductOfferingMethodsAllow or restrict one or more method names (comma-separated) by customer implementations among the out-of-box available methods.POST, GET, PATCH, DELETE56.0Yes
TMForumProductOfferingRequestDRDR name that's used to map filtering parameters from TMF fields to Salesforce fields in the GET and POST methods of the productOffering API.TMFTMForumProductOfferingInput56.0Yes
TMForumProductOfferingResponseDRDR name that's used to map filtering parameters from Salesforce fields to TMF fields in the GET and POST methods of the productOffering API.TMFTMForumProductOfferingResult56.0Yes
TMForumProductOfferingUseChildForBuIndicates whether to consider the incoming bundled product offerings as child product offerings of an incoming product offering (true) or not (false). With a default value as false, the incoming bundled product offerings are set to parent product offerings. The TMForumProductOfferingUseChildForBu value is consistent for both GET and POST APIs.false56.0Yes
TMForumDeleteProductOfferingVIPNameMetadata used to store VIP Name for DeleteProductOffering. Invoked by the DELETE Product Offering API. See Extend TMF620 API section for modifications.tmf_TMForumDeleteProductOffering58.0Yes
TMForumPatchProductOfferingVIPNameInvoked by the PATCH ProductOffering API. See Extend TMF620 API section for modifications.TMF_TMForumPatchProductOfferingPrice56.0Yes
TMForumPriceListThe value of this metadata record is used as the pricelist for the product offering. Users can override the OOB value.B2C56.0Yes
Metadata NameDescriptionDefault ValueAvailable VersionIncluded in the CME managed package (Yes/No)
TMForumProductOfferingPriceVIPNameInvoked by the GET Product Offering Price API. See Extend TMF620 API section for modifications.tmf_TMForumProductOfferingPrice57.0Yes
TMForumCreateProductOfferingPriceVIPNameInvoked by the POST Product Offering Price API. Allow or restrict one or more method names (comma-separated) by customer implementations among the out-of-box available methods.TMF_TMForumCreateProductOfferingPrice56.0Yes
TMForumProductOfferingPriceMethodsMetadata that's used to define the available methods for a product offering price.POST, GET, PATCH, DELETE56.0Yes
TMForumProductOfferingPriceRequestDRDR name that's used to map filtering parameters from TMF fields to Salesforce fields in the GET and POST methods of the productOfferingPrice API.TMFTMForumGetProductOfferingPriceInput57.0Yes
TMForumDeleteProductOfferingPriceVIPNameMetadata used to store VIP Name for deleteProductOfferingPrice. Invoked by the DELETE Product Offering API. See Extend TMF620 API section for modifications.tmf_TMForumDeleteProductOfferingPrice58.0Yes
TMForumPatchProductOfferingPriceVIPNameInvoked by the PATCH Product Offering Price API. See Extend TMF620 API section for modifications.TMF_TMForumPatchProductOfferingPrice56.0Yes
TMForumPriceListThe value of this metadata record is used as the pricelist for the product offering price. Users can override the OOB value.B2C56.0Yes
Metadata NameDescriptionDefault ValueAPIAvailable VersionIncluded in the CME managed package (Yes/No)
TMForumEnablePageInfoIndicates whether to enable the PageInfo and PageSize parameters in the response (true) or not (false).trueGET and POST methods of all APIs56.0Yes
TMForumREPageSizeApplies a set limit to query the related entities of a primary entity.2000GET and POST methods of all APIs56.0Yes
TMForumPageSizeApplies a set page limit to query the primary entity.50GET and POST methods of all APIs56.0Yes
TMForumDefaultAttributeCategoryReuses or creates the attributes of an incoming payload of product specifications or offerings. The attributes are grouped to the Vlocity attribute category. The TMForumDefaultAttributeCategory metadata value can be replaced depending on the business logic.TMForumPOST method of productSpecification and productOffering APIs56.0Yes
TMForumAllFieldstoQueryIndicates whether to fetch all fields in the queried object (true) or not (false).falseGET and POST methods of all APIs56.0Yes
TMForumExtraProductFieldstoQuerySpecifies the additional fields to use for the product2 sObject. By default, the TMForumExtraProductFieldstoQuery metadata isn’t included in the Salesforce Industries CME managed package.-GET method of productSpecification and productOffering APIs56.0No