Understand Infinity integration parameter mapping
Commerce subscribes to particular events in the Storefront which are then tracked and bound with related methods. Infinity parameters are mapped in these related prototype methods with Commerce data.
A site page containing the Infinity tag loads an Infinity script through a "require" dependency. Commerce then subscribes to particular Infinity events to be tracked and bound with specific methods. The Commerce data is then mapped with Infinity parameters in the methods and this is sent to Infinity for collection. The available Commerce/Infinity parameter mappings are the following:
Note: If for some data field a provided parameter is not available in
Infinity, you can create custom parameters as
"wt.z_<yourName>
."
Table 6-1 Commerce/Infinity parameter mappings
Event | Event Details | Data tracked | Infinity Parameters |
---|---|---|---|
USER_PROFILE_UPDATE_SUCCESSFUL |
Published when the user profile is updated. When the REST call for profile update is a success, it publishes an event. |
|
|
USER_PROFILE_UPDATE_SUBMIT |
Published from Published from Published from the Customer Profile widget via the
widget's Published from Header widget via the widget's
Published from the Checkout Registration widget via
the widget's |
|
|
USER_LOGOUT_SUBMIT |
Published from the Logon Registration widget
(Login-Registration-v2 -> |
|
|
USER_LOGIN_SUCCESSFUL |
Published from user.js when a user
login is successful or a SAML callback is successful.
|
|
|
USER_LOGIN_SUBMIT |
Published from Login-Registration-v2 ->
|
|
|
USER_AUTO_LOGIN_SUCCESSFUL |
Published from user.js when the user
autologin is successful.
|
|
|
SEARCH_RESULTS_UPDATED |
Published from If the search request is a success then it publishes with the search results otherwise it publishes with an error message. |
|
|
PRODUCT_VIEWED |
Published from the Product Details widget when a product is viewed from PDP or quick view. |
|
|
PRODUCT_ADDED_TO_PURCHASE_LIST_SUCCESS |
Published from Purchase Lists widget
(add-to-purchase-list -> element.js) when an
item is added to the purchase list.
|
|
|
PAYMENT_AUTH_SUCCESS |
Published from payment-auth-response view model when the response from the paymentAuthResponse endpoint returns the state of payment accepted and the order status has not failed. |
|
|
PAYMENT_AUTH_DECLINED |
Published from payment-auth-response view model when the response from paymentAuthResponse endpoint returns a state like "removed" or when a payment is authorized but the order failed. |
|
|
PAGE_CHANGED |
Published from It publishes with pageEventData such as page, pageId, path, pageRepositoryId, etc. |
|
|
ORDER_SUBMISSION_SUCCESS |
Published from the order.js view
model when the order details of the initial order created during
checkout with PayPal/PayU is fetched.
If the transaction is done via PayU and the status is settled/approved, this event is published. Published from the
Published from the |
|
|
ORDER_SUBMISSION_FAIL |
Published from the Published from the CyberSource Payment Authorization widget if there is an error while generating the signature in a payment iFrame. |
|
|
ORDER_COMPLETED |
Published from the
Published from the Published from the Split Payments widget when the order state is either pending approval or a template (i.e., the order is a scheduled order) or pending scheduled order approval. |
|
|
COUPON_APPLY_SUCCESSFUL |
Published from the cart view model when a cart is updated from the server after a coupon is applied successfully. |
|
|
CHECKOUT_SHIPPING_METHOD |
Published from the Published from the Cart Shipping widget when a shipping option is reset or if a shipping address and shipping method has changed. |
|
|
CHECKOUT_SAVE_SHIPPING_ADDRESS |
Published from order.js view model
with the shipping address when the Place Order button is
clicked.
|
|
|
CHECKOUT_REGISTER_USER |
Published from the Checkout Order Details widget when all validations for creating the order have passed. |
|
|
CART_UPDATE_QUANTITY |
Published in the Shopping Cart widget with the
commerceItemId when the Quantity Update button
is clicked.
|
|
|
CART_REMOVE_SUCCESS |
Published from cart.js when an item
is removed from the cart view model. It is also published with a
product commerce id.
Published from |
|
|
CART_ADD_SUCCESS |
Published from The cart is updated when the REST call is made to fetch the current profile order and price information to refresh the cart data. |
|
|
ADD_TO_QUICK_ORDER |
Published from the product-add-to-quick-order element when adding to a quick order and the button is clicked. |
|
|
- All methods are prototypes, so, if you want to add more parameters, you can extend them.
- If for some reason a data field is not provided in Infinity, you
can create custom parameters in the following format so that :
wt.z_<yourParameterName>
the Oracle Infinity platform will start to record it. - Some events are published from provided widgets which earlier did not publish any relevant data. These have since been changed to publish relevant information. If you are not using the provided widgets in any case, you must publish similar data in the events. These widgets include ORDER_SUBMISSION_SUCCESS (Split Payments widget), PRODUCT_ADDED_TO_PURCHASE_LIST_SUCCESS (Purchase List widget), USER_PROFILE_UPDATE_SUBMIT (Shopper Details, Address Book, and Update Password widget), and CART_REMOVE_SUCCESS. It is necessary, then, to take the latest changes accordingly. If you are publishing any of the events listed in the table and not publishing relevant data similar to the ones provided, you need to provide updates to correct this.
- The Infinity
viewmodel.js
depends on theORA_ANALYTICS_READY
event on DOM (published by the Infinity JS) to initialize the Infinity API. Refer to your Infinity Administrator to turn on theREADY EVENT
the tag for the same.
For more complete details on using Infinity and its capabilities, refer to the Oracle Infinity documentation.