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 custom metadata 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.
| Metadata Name | Description | Default Value | Available Version | Included in the CME managed package (Yes/No) |
|---|
| TMForumCategoryVIPName | Invoked by the GET Category API. See Extend Industry API section for modifications. | TMF_TMForumCategory | 57.0 | Yes |
| TMForumCreateCategoryVIPName | Invoked by the POST Category API. See Extend Industry API section for modifications. | TMF_TMForumCreateCategory | 56.0 | Yes |
| TMForumCreateCategoryMethods | Allow or restrict one or more method names (comma-separated) by customer implementations among the out-of-box available methods. This metadata is deprecated in Salesforce API version 58.0. | POST, GET | 56.0 | Yes |
| TMForumCategoryRequestDR | DataRaptor (DR) name that's used to map filtering parameters from TMF fields to Salesforce fields in the GET Category API. | TMFTMForumGetCategoryInputResponse | 57.0 | Yes |
| TMForumCategoryMethods | Allow or restrict one or more methods names by customer implementation among the out-of-the-box avaliable methods. | POST, GET, PATCH | 58.0 | Yes |
| TMForumPatchCategoryVIPName | Invoked by the PATCH Category API. See Extend Industry API section for modifications. | TMF_TMForumPatchCategory | 58.0 | Yes |
| Metadata Name | Description | Default Value | Available Version | Included in the CME managed package (Yes/No) |
|---|
| TMForumCatalogVIPName | Invoked by the GET Catalog API. See Extend TMF620 API section for modifications. | TMF_TMForumCatalog | 57.0 | Yes |
| TMForumCreateCatalogVIPName | Invoked by the POST Catalog API. See Extend TMF620 API section for modifications. | tmf_TMForumCreateCatalog | 56.0 | Yes |
| TMForumCreateCatalogMethods | Allow or restrict one or more method names (comma-separated) by customer implementations among the out-of-box available methods. This metadata is deprecated in Salesforce API version 58.0. | POST, GET, PATCH | 56.0 | Yes |
| TMForumCatalogMethods | Allow or restrict one or more method names (comma-separated) by customer implementations among the out-of-box available methods. | POST, GET, PATCH | 58.0 | Yes |
| TMForumCatalogRequestDR | DR name that's used to map filtering parameters from TMF fields to Salesforce fields in the GET Catalog API. | TMFTMForumTransformGetCatalogInputResponse | 57.0 | Yes |
| TMForumExtraCatalogFieldstoQuery | Specifies the additional fields to use for the catalog sObject. By default, the TMForumExtraCatalogFieldstoQuery metadata isn’t included in the Salesforce Industries CME managed package. | - | 57.0 | No |
| TMForumPatchCatalogVIPName | Invoked by the PATCH Catalog API. See Extend TMF620 API section for modifications. | TMF_TMForumPatchCatalog | 58.0 | Yes |
| Metadata Name | Description | Default Value | Available Version | Included in the CME managed package (Yes/No) |
|---|
| TMForumProductSpecificationVIPName | Invoked by the GET productSpecification API. See Extend TMF620 API section for modifications. | TMF_TMForumProductSpecification | 56.0 | Yes |
| TMForumCreateProductSpecificationVIPName | Invoked by the POST productSpecification API. See Extend TMF620 API section for modifications. | tmf_TMForumCreateProductSpecification | 56.0 | Yes |
| TMForumProductSpecificationMethods | Allow or restrict one or more method names (comma-separated) by customer implementations among the out-of-box available methods. | POST, GET, PATCH | 56.0 | Yes |
| TMForumProductSpecificationRequestDR | DR name that's used to map filtering parameters from TMF fields to Salesforce fields in the GET and POST methods of the productSpecification API. | TMF-TMForumProductSpecificationRequestTransform | 56.0 | Yes |
| TMForumProductSpecificationResponseDR | DR name that's used to map filtering parameters from Salesforce fields to TMF fields in the GET and POST methods of the productSpecification API. | TMF-TMForumProductSpecificationResponseTransform | 56.0 | Yes |
| TMForumProductSpecificationFilters | Comma-separated fields that can be used as a filter to get a product specification using the GET productSpecification API. | id, name, productNumber, lifecycleStatus, isBundle, version | 56.0 | Yes |
| TMForumProductSpecificationUseChildForBu | Indicates 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. | false | 56.0 | Yes |
| TMForumPatchProductSpecificationVIPName | Invoked by the PATCH productSpecification API. See Extend TMF620 API section for modifications. | tmf_TMForumPatchProductSpecification | 58.0 | Yes |
| Metadata Name | Description | Default Value | Available Version | Included in the CME managed package (Yes/No) |
|---|
| TMForumProductOfferingVIPName | Invoked by the GET productOffering API. See Extend TMF620 API section for modifications. | TMF_TMForumProductOffering | 56.0 | Yes |
| TMForumCreateProductOfferingVIPName | Invoked by the POST productOffering API. See Extend TMF620 API section for modifications. | TMF_TMForumCreateProductOffering | 56.0 | Yes |
| TMForumProductOfferingFilters | Comma-separated fields that can be used as a filter to get a product offering using the GET productOffering API. | id, name, lifecycleStatus, isBundle, isSellable, version | 56.0 | Yes |
| TMForumProductOfferingMethods | Allow or restrict one or more method names (comma-separated) by customer implementations among the out-of-box available methods. | POST, GET | 56.0 | Yes |
| TMForumProductOfferingRequestDR | DR name that's used to map filtering parameters from TMF fields to Salesforce fields in the GET and POST methods of the productOffering API. | TMF-TMForumProductOfferingInput | 56.0 | Yes |
| TMForumProductOfferingResponseDR | DR name that's used to map filtering parameters from Salesforce fields to TMF fields in the GET and POST methods of the productOffering API. | TMF-TMForumProductOfferingResult | 56.0 | Yes |
| TMForumProductOfferingUseChildForBu | Indicates 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. | false | 56.0 | Yes |
| Metadata Name | Description | Default Value | Available Version | Included in the CME managed package (Yes/No) |
|---|
| TMForumProductOfferingPriceVIPName | Invoked by the GET productOfferingPrice API. See Extend TMF620 API section for modifications. | TMF_TMForumProductOfferingPrice | 57.0 | Yes |
| TMForumCreateProductOfferingPriceVIPName | Invoked by the POST productOfferingPrice API. Allow or restrict one or more method names (comma-separated) by customer implementations among the out-of-box available methods. | TMF_TMForumCreateProductOfferingPrice | 56.0 | Yes |
| TMForumProductOfferingPriceMethods | Metadata that's used to define the available methods for a product offering price. | POST, GET, PATCH | 56.0 | Yes |
| TMForumProductOfferingPriceRequestDR | DR name that's used to map filtering parameters from TMF fields to Salesforce fields in the GET and POST methods of the productOfferingPrice API. | TMFTMForumGetProductOfferingPriceInput | 57.0 | Yes |
| TMForumPatchProductOfferingPriceVIPName | This defines the VIP name that handles the patch productOfferingPrice. | TMF_TMForumPatchProductOfferingPrice | 58.0 | Yes |
| Metadata Name | Description | Default Value | API | Available Version | Included in the CME managed package (Yes/No) |
|---|
| TMForumEnablePageInfo | Indicates whether to enable the PageInfo and PageSize parameters in the response (true) or not (false). | true | GET and POST methods of all APIs | 56.0 | Yes |
| TMForumREPageSize | Applies a set limit to query the related entities of a primary entity. | 2000 | GET and POST methods of all APIs | 56.0 | Yes |
| TMForumPageSize | Applies a set page limit to query the primary entity. | 50 | GET and POST methods of all APIs | 56.0 | Yes |
| TMForumDefaultAttributeCategory | Reuses 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. | TMForum | POST method of productSpecification and productOffering APIs | 56.0 | Yes |
| TMForumAllFieldstoQuery | Indicates whether to fetch all fields in the queried object (true) or not (false). | false | GET and POST methods of all APIs | 56.0 | Yes |
| TMForumExtraProductFieldstoQuery | Specifies 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 APIs | 56.0 | No |