tpm-promotion Component

Namespace

Events

Here’s the event payload structure.

onfocusedareachange

This event is triggered when a different area of the application is navigated to.

The possible values of area are:

• PROMOTION_PLANNING: This area identifies the Promotion Planning UI.
• PL_GRID: This area identifies the Promotion PL.

The possible values of section are:

• PROMOTION: Promotion level components section.
• TACTIC: Tactic level components section.

onisplgridfilteropenchange

This event is triggered when the P&L filters are opened (true) or closed (false).

onstatuschange

This event is triggered when the lifecycle state of the TPM promotion component changes. Status changes are triggered by lifecycle operations on the promotion record.

The possible values are:

• LOADING: The promotion is being loaded.
• VALID: The promotion is loaded and can be interacted with.
• SAVING: The promotion is being saved to the database.
• ERROR: An irrecoverable error has occurred.

oncalculationstatuschange

This event is triggered when the promotion grids are calculated or recalculated.

The possible values are:

• LOADING: The calculations are being processed, or the engine is loading.
• VALID: The calculations are completed and values can be requested
• ERROR: An irrecoverable error has occurred.
• DISABLED: Calculations Engine is disabled for the promotion.

oneditmodechange

This event is triggered when the edit mode changes for the page.

onselectedtacticidchange

This event is triggered when the focused tactic changes.

The possible values of are:

• null: No focused tactic found.
• A tactic ID: The ID of the focused tactic.

onpromotionchange

This event is triggered when the promotion attributes change.

The event value contains all the Promotion SObject attributes.

oneffectivecategorieschange

This event is triggered when the effective categories of the promotion change.

The event value contains an array of product IDs from the effective categories.

oneffectivebrandschange

This event is triggered when the effective brands of the promotion change.

The event value contains an array of product IDs from the effective brands.

ontacticschange

This event is triggered when the tactic attributes change.

The event value contains all the Tactic sObjects and their attributes.

ontacticfundschange

This event is triggered when the Tactic fund properties change.

The event value contains all the Tactic Fund sObjects and their attributes.

onpromotionattachmentlinkschange

This event is triggered when the properties of the Promotion Attachment link change.

Promotion attachment links are junction objects between a Promotion record and a Promotion Attachment Record.

The event value contains all the Promotion Attachment Link sObjects and their attributes.

onpromotionattachmentschange

This event is triggered when the properties of the Promotion Attachment sObject change.

Promotion Attachment records must be created before they can be linked to a promotion during the save process.

The event value contains all the Promotion Attachment Link sObjects and their attributes.

onpromotioncategorieschange

This event is triggered when the promotion categories change.

The event value is an array of Product2 IDs referencing Category records.

onsubaccountschange

This event is triggered when the promotion sub-accounts change.

onparticipatingcustomerschange

This event is triggered when the participating customers of a promotion change. The participating customers list is used to determine the customers the promotion is pushed to during the push process.

ontacticconditioncreationdefinitionschange

This event is triggered when the Tactic Condition Creation definitions for the tactics included in the promotion change.

The event value is an array of Tactic Condition Creation Definition sObject records and their attributes.

oncustomstatechange

This event is triggered when the custom state changes. Custom State is a special area of the promotion state where customers can set their custom structures that are processed and committed in Salesforce at the same time as the promotion.

onpromotionproductschange

This event is triggered when the promotion products change.

The event value is an array of all promotion product IDs.

onupliftpredictionavailablechange

This event is triggered when the uplift prediction availability changes. It indicates if the feature is enabled for the promotion.

onupliftpredictionenabledchange

This event is triggered based on whether the uplift prediction can be performed on the current promotion or not. It indicates possible errors with the promotion state that prevent uplift prediction from being executed.

onupliftpredictionprocessstatuschange

This event is triggered when the uplift prediction process state changes.

The possible values are:

• RUNNING
• IDLE

onmanualinputschange

This event is triggered when the promotion manual inputs change. The event payload contains an array of TPMManualInput instances being used for the TPM Grids.

onaclchange

This event is triggered when the edit access rights in the Access Control List (ACL) changes for a promotion or tactic. This event notifies about an ACL change. Get the actual value of an edit access right element using the isVisible and isEditable methods of the tpm-promotion class.

onkpivalidationschanges

This event is triggered when the promotion grids are calculated or recalculated, and validation KPIs are emitting error messages.

Example Implementation