These default mappings are supported for the TMF622 v4 resources:
| TMForum Field<div style="width:120px"></div> | Field Type<div style="width:120px"></div> | TMForum Description <br> <div style="width:120px"></div> | Is Mandatory by TMForum?<div style="width:120px"></div> | Salesforce Mapping<div style="width:120px"></div> | Salesforce Description<div style="width:120px"></div> | Is Mandatory for CPQ/EPC/TMF API Implementation? | Is Supported?<div style="width:120px"></div> | Prerequisites <br><div style="width:120px"></div> |
|---|---|---|---|---|---|---|---|---|
| id | String | A string. ID created on repository side (OM system). | Yes | Order.OrderNumber | Identifies the Product Orde. | Yes | Yes | NA |
| description | String | A string. Description of the product order. | No | Order.Description | Description of an order. | No | Yes | NA |
| externalId | String | A string. ID given by the consumer and only understandable by him (to facilitate his searches afterwards). | No | Order.OrderReferenceNumber | External id of an order. | No | Yes | NA |
| requestedCompletionDate | DateTime | A date time (DateTime). Requested delivery date from the requestor perspective. | No | Order.vlocity_cmt__RequestedCompletionDate__c | Requested completion date of an order. | No | Yes | NA |
| requestedStartDate | DateTime | A date time (DateTime). Order fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow seller to begin to operationally begin the fulfillment before a date. | No | order.vlocity_cmt__RequestedStartDate__c | Requested start date of an order. | Yes | Yes | NA |
| orderDate | DateTime | A date time (DateTime). Date when the order was created. | No | Order.createdDate | Created date of the order. | Yes | Yes | NA |
| channel | String | A list of related channels (RelatedChannel [*]). Related channel to another entity. May be online web, mobile app, social ,etc. | No | order.vlocity_cmt__OriginatingChannel__c | Originating channel of an order. | No | Yes | NA |
| note | String | A list of notes (Note [*]). Extra information about a given entity. | No | order.vlocity_cmt__Notes__c | Notes if any for an order. | No | Yes | NA |
| productOrderItem | List | A list of product order items (ProductOrderItem [1..*]). An identified part of the order. A product order is decomposed into one or more order items. | Yes | OrderItem | Items of an order. | Yes | Yes | Products of input payload should be present in salesforce for creation of an order. Products should have valid EPC setup and price list entries |
| relatedParty | List | A list of related parties (RelatedParty [*]). Related Entity reference. A related party defines party or party role linked to a specific entity. | No | Account | Account to which an order belongs to. | Yes | Yes | relatedParty should be present in input payload for creation of an order. ‘relatedParty[0]’ is considered as account details from the incoming request. This account is to be expected to be present in salesforce with incoming role as record type and name as account name and id as account number |
| No | vlocity_cmt__PriceList__c | Price List of an order. | Yes | Yes | A valid Pricelist name must be configured in the metadata(<br>TMForumPriceList) to add products to the cart. This pricelist should be a valid EPC setup in salesforce. | |||
| state | String | state of an order | No | order.Status | Status of an order. | No | Yes | NA |
productOrderItemResource
| TMForum Field<div style="width:120px"></div> | Field Type<div style="width:120px"></div> | TMForum Description <br> <div style="width:120px"></div> | Is Mandatory by TMForum?<div style="width:120px"></div> | Salesforce Mapping<div style="width:120px"></div> | Salesforce Description<div style="width:120px"></div> | Is Mandatory for CPQ/EPC/TMF API Implementation?<div style="width:120px"></div> | Is supported?<div style="width:120px"></div> |
|---|---|---|---|---|---|---|---|
| action | String | A string. Used to categorize the order from a business perspective that can be useful for the OM system. | Yes | OrderItem.vlocity_cmt__Action__c | Action. | Yes | Yes |
| id | Integer | ID of the product order item. | Yes | NA | Unique identifier of a product. | No | Yes |
| quantity | Integer | Quanity of a product order item. | No | OrderItem.Quantity | Quanity of an order product. | No | Yes |
| state | String | A product order item state type (ProductOrderItemStateType). State of the order item : described in the state machine diagram. | No | OrderItem.vlocity_cmt__FulfilmentStatus__c | State of the order product. | No | - |
| productOffering | Object | A product offering reference (ProductOfferingRef). A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information. | No | productOffering sub-resource | Order Product details. | Yes | - |
| productCharacteristic | List | A list of characteristics (Characteristic [*]). Describes a given characteristic of an object or entity through a name/value pair. | No | ProductCharacteristic sub-resource | Attributes details of the order product. | No | - |
| productOrderItemRelationship | List | A list of order item relationships (OrderItemRelationship [*]). | No | productOrderItemRelationship sub-resource | Optional child products of the root bundle. | No | - |
| itemPrice | List | A list of order prices (OrderPrice [*]). An amount, usually of money, that represents the actual price paid by the Customer for this item or this order. | No | itemPrice sub-resource | Pricing information of the OLI. | No | Yes |
| orderLineItemId | String | Salesforce Id of a particular product order item. | No | OrderItem.Id | Salesforce Id of a particular product order item. | Yes for some of the patch scenarios | Yes |
productOffering
| TMForum Field | TMForum Description <br><div style="width:120px"></div> | Is Mandatory by TMForum?<div style="width:120px"></div> | Salesforce Mapping<div style="width:120px"></div> | Salesforce Description<div style="width:120px"></div> | Is Mandatory for CPQ/EPC/TMF API Implementation? | Is Supported?<div style="width:120px"></div> |
|---|---|---|---|---|---|---|
| name | A string. Name of the related entity. | No | Product2.Name | Name of the account | No | Yes |
| id | A string. Unique identifier of a related entity. | No | Product2.ProductCode | ProductCode of the product | Yes | Yes |
RelatedParty
| TMForum Field<div style="width:120px"></div> | TMForum Description <br><div style="width:120px"></div> | Is Mandatory by TMForum?<div style="width:120px"></div> | Salesforce Mapping<div style="width:120px"></div> | Salesforce Description<div style="width:120px"></div> | Is Mandatory for CPQ/EPC/TMF API Implementation?<div style="width:120px"></div> | Is Supported?<div style="width:120px"></div> |
|---|---|---|---|---|---|---|
| name | A string. Name of the related entity. | No | Name | Name of the account. | Yes | Yes |
| href | An uri (Uri). Hyperlink reference. | No | TMF Account Url + Account.Id | TMF Product Ordering GET Url ending with Id field. | No | Yes |
| id | A string. unique identifier. | No | Account.AccountNumber | External id for the given account. | Yes | Yes |
| role | A string. Role played by the related party. | No | Account.RecordType.Name | Record type of the account. | Yes | Yes |
| @referredType | A string. The actual type of the target instance when needed for disambiguation. | No | Schema object name i.e "Account" | Entity type is account. | No | Yes |
| @type | A string. When sub-classing, this defines the sub-class Extensible name. | No | JSON representation type i.e "RelatedParty" | NA | Yes | Yes |
productOrderItemRelationship
This sub-resource contains details of optional child products in bundles and supports adding them directly under the parent product at the first hierarchy level.
| TMForum Field<div style="width:120px"></div> | TMForum Description<div style="width:120px"></div> | Is Mandatory by TMForum?<div style="width:120px"></div> | Salesforce Mapping<div style="width:120px"></div> | Salesforce Description<div style="width:120px"></div> | Is Mandatory for CPQ/EPC/TMF API Implementation?<div style="width:120px"></div> | Is Supported?<div style="width:120px"></div> |
|---|---|---|---|---|---|---|
| id | A string. Unique identifier. | No | Product2.ProductCode | External ID for the given account. | Yes | Yes |
| relationshipType | A string. The type of order item relationship. | No | Supported value - "bundles" | - | Yes | Yes |
ProductCharacteristic
note: Priority is given to OrderItem.AttributeSelectedValues__c , if the V2 model is disabled OrderItem.vlocity_cmt__JSONAttribute__c will be used.
| TMForum Field<div style="width:120px"></div> | TMForum Description<div style="width:120px"></div> | Is Mandatory by TMForum?<div style="width:120px"></div> | Salesforce Mapping<div style="width:120px"></div> | Salesforce Description<div style="width:120px"></div> | Is Supported?<div style="width:120px"></div> |
|---|---|---|---|---|---|
| name | A string. Name of the characteristic. | No | OrderItem.vlocity_cmt__JSONAttribute__c.attributeuniquecode__c | Attribute Unique code | Yes |
| value | An any (Any). The value of the characteristic. | No | OrderItem.vlocity_cmt__JSONAttribute__c.value__c<br> | Attribute Value | Yes |
| valueType | A string. Data type of the value of the characteristic. | No | OrderItem.vlocity_cmt__JSONAttribute__c.valuedatatype__c | Attribute Value type | Yes, only for JSONAttribute mapping |
itemPrice
| TMForum Field<div style="width:120px"></div> | TMForum Description<div style="width:120px"></div> | Is Mandatory by TMForum?<div style="width:120px"></div> | Salesforce Mapping<div style="width:120px"></div> | Salesforce Description<div style="width:120px"></div> | Is Supported?<div style="width:120px"></div> |
|---|---|---|---|---|---|
| priceAlteration | An amount, usually monetary, that adjusts the price of an order item. | No | priceAlteration sub-resource | - | Yes |
priceAlteration
| TMForum Field<div style="width:120px"></div> | TMForum Description<div style="width:120px"></div> | Is Mandatory by TMForum?<div style="width:120px"></div> | Salesforce Mapping<div style="width:120px"></div> | Salesforce Description<div style="width:120px"></div> | Is Supported?<div style="width:120px"></div> |
|---|---|---|---|---|---|
| name | A string. Name of the order item price alteration. | No | Name of time plan | - | Yes |
| priceType | A string. A category that describes the price such as recurring, one time and usage. | No | RecurringCharge__c or OneTimeCharge__c | - | Yes |
| price | A price (Price). Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration. | No | price sub-resource | - | Yes |
price
| TMForum Field<div style="width:120px"></div> | TMForum Description<div style="width:120px"></div> | Is Mandatory by TMForum?<div style="width:120px"></div> | Salesforce Mapping<div style="width:120px"></div> | Salesforce Description<div style="width:120px"></div> | Is supported?<div style="width:120px"></div> |
|---|---|---|---|---|---|
| percentage/absolute | A float. Percentage to apply for ProdOfferPriceAlteration. | No | - | AdjustmentMethod = Percent/Absolute | Yes<br> |
| @type | "price" | No | - | Hardcoded to price |
Yes |