TMF637 v4 Product Inventory Management - Outbound Notification

Use TMF637 Outbound Notification API to retrieve product inventory information. Outbound notifications are triggered for these events. They are triggered only for the parent entity (Asset entity).

/api/notification/productCreateEvent
/api/notification/productAttributeValueChangeEvent
/api/notification/productStateChangeEvent (status field)

The user must configure the notification framework to detect CDC events and invoke the relevant TMF Open API implementations that generate the event payloads and forward them to the target systems configured within the API.

This API has been tested with an external system using TMF-aligned customizations. It may not include all optional fields and may not work out-of-the-box with your system. Customizations will likely be required. We recommend a thorough evaluation to ensure it meets your specific needs.

Note

Available In

This API is available in the managed package.

Prerequisites

MuleSoft License required: MuleSoft Direct for Communications Cloud (add-on for Communications Cloud) or MuleSoft Anypoint Base Subscription.
Communications cloud license required: Communications Cloud Growth.
Lifecycle Management license with AssetLifecycleManagementAddon.
Org Perm check: IndustriesCPQService

Assumptions

The notification uses a fire-and-forget approach. Salesforce does not process or store the response in any objects. MuleSoft logs and tracks all received notifications.
In alignment with TMF v4 standards for event notifications, the system sends the same payload, which includes the full product resource and the supported related sub-resources, for all events.
Access to the target system is authenticated using the OAuth 2.0 Client Credentials grant type.
In case of failure when invoking the target system endpoint, the request is retried up to three times, with a two second interval between attempts.
TMF637 v4 Inbound API response may include optional fields. According to TMF specifications, if the outbound Event Notification payload contains unsupported optional parameters, the downstream system may reject it with a 4xx error. To avoid this, tailor the payload to include only the optional fields supported by the client.
Salesforce and MuleSoft do not have a centralized event hub configured by default. Customers are responsible for setting up their own event hub to manage subscribers. Outbound notifications are generated and sent directly to a single, client-defined target endpoint.

Below is a summary of the change events supported for the Asset entity, along with the required configuration to trigger them through the notification framework.

When configuring Object Integration Definitions, use the exact RelatedFieldName values listed in the table below.

Note

TMF Resource	Salesforce Entity	Scenario	changeEventType Supported	Notification Event Path	`RelatedFieldName`
Product	Asset	Creation of a new Asset	Create	`/api/notification/productCreateEvent`	”RelatedFieldName”:“vlocity_cmt__AssetReferenceId__c”
		Updates to attributes of an existing Asset record	Update	`/api/notification/productAttributeValueChangeEvent`	”RelatedFieldName”:“vlocity_cmt__AssetReferenceId__c”
		Updates to the Asset.Asset.vlocity_cmt__ProvisioningStatus__c attribute	Update	`/api/notification/productStateChangeEvent`	”RelatedFieldName”:“vlocity_cmt__AssetReferenceId__c”

Sample Outbound Notification Request

This is a sample payload sent to the target system endpoint for the event Type: ProductCreateEvent.

The event notification payload is same for all three events (ProductCreateEvent, ProductAttributeValueChangeEvent, ProductAttributeValueChangeEvent). The eventType value will differ between the three events.

Note

1{
2  "correlationId": "126-54f",
3  "description": "ProductCreateEvent illustration",
4  "domain": "Commercial",
5  "eventId": "125",
6  "eventTime": "2021-09-27T07:43:59.059Z",
7  "eventType": "ProductCreateEvent",
8  "priority": "1",
9  "timeOccurred": "2021-09-27T07:43:59.059Z",
10  "title": "ProductCreateEvent",
11  "event": {
12    "product": {
13  "isBundle": "false",
14  "isCustomerVisible": true,
15  "productSpecification": {
16      "id": "01tDp000000Ogk5IAC",
17      "name": "Cisco Firepower789"
18  },
19  "productOffering": {
20      "id": "01tDp000000OgkAIAS",
21      "name": "Cisco Firepower789"
22  },
23  "orderDate": "2019-05-03",
24  "productOrderItem": [
25      {
26          "productOrderId": "00000100",
27          "orderItemAction": "Add",
28          "orderItemId": "0000000001"
29      }
30  ],
31  "description": "new desc",
32  "id": "1b55a381-1782-56d6-a90a-2030798d6e4b",
33  "name": "TMForum",
34  "productSerialNumber": "xyz",
35  "startDate": "2024-05-05",
36  "status": "Active",
37  "relatedParty": [
38    {
39        "id": "CD451791",
40        "name": "Test Sh1",
41        "@referredType": "Account"
42    }
43  ],
44  "billingAccount": {
45      "id": "001Dp000002RdyXIAS",
46      "name": "TMForum"
47  },
48  "productPrice": [
49      {
50          "priceType": "One-time",
51          "price": {
52              "taxIncludedAmount": {
53                  "value": 0.00000
54              }
55          },
56          "name": "a3GDp000000LbKe"
57      }
58  ],
59  "productCharacteristic": [
60    {
61        "name": "B2CCmex_ATTR_DATA_CHAR",
62        "value": "25 GB",
63        "valueType": "Text"
64    },
65    {
66        "name": "B2CCmex_ATTR_HASDISCOUNT_CHAR",
67        "value": "false",
68        "valueType": "Checkbox"
69    },
70    {
71        "name": "B2CCmex_ATTR_MMS",
72        "valueType": "Number"
73    },
74    {
75        "name": "B2CCmex_ATTR_PAYMENT_OPTION_CHAR",
76        "value": "Prepaid",
77        "valueType": "Picklist"
78    },
79    {
80        "name": "B2CCmex_ATTR_SMS_CHAR",
81        "value": "500",
82        "valueType": "Text"
83    },
84    {
85        "name": "B2CCmex_ATTR_TANGIBLE_CHAR",
86        "value": "false",
87        "valueType": "Checkbox"
88    },
89    {
90        "name": "B2CCmex_ATTR_VOICE_CHAR",
91        "value": "500",
92        "valueType": "Text"
93    }
94  ]
95}
96}
97}

Outbound Event Notifications Field Mappings

TMF Field	TMF Type	Is it Mandatory ?	Supported	Mappings
id	string	No	TRUE	Mule correlation Id
eventId	string	No	TRUE	inputPayload.eventId
eventTime	string	No	TRUE	inputPayload.commitTimestamp as UTC
eventType	string	No	TRUE	`ProductCreateEvent` or `ProductAttributeValueChangeEvent` or `ProductStateChangeEvent`
correlationId	string	No	TRUE	inputPayload.correlationId
timeOccurred	string	No	TRUE	inputPayload.commitTimestamp as UTC
event.product	object	Yes	TRUE	TMF637v4 Inbound response payload

Notification Handling for Sub-Resources in TMF637

Sub-Resources with Parent-Mapped Attributes Fields from TMF sub-resources such as RelatedParty, BillingAccount and ProductCharacteristic are mapped to the parent Asset. Attribute change notifications must be configured on Asset and published to /api/notification/productAttributeValueChangeEvent. Separate configurations for these sub-resources are not required.
Sub-Resource Changes Leading to Asset Creation For the TMF sub-resource ProductOrderItem, actions such as Modify or Change of Plan create new Asset entities. Notifications for these events must be configured to /api/notification/productCreateEvent. Similarly, updates to Product Offering or Product Specification also trigger new orders and asset creations, requiring notifications to the same endpoint.