Events & Profiles
A rule expression consists of profiles, attributes, sub-attributes (if applicable), operators and expression values. Each event supports different profiles to write a rule expression. One profile can be used in multiple events. The following table provides the list of various profiles supported for each event.
EVENT | DESCRIPTION | EVENT PROFILE |
TransactionAdd | Transaction Add is a combination of transaction add, tracker and transaction finish events. Hence, this event is used for configuring actions on a new transaction, tracker and transaction complete events. | currentCustomer currentEvent currentStore currentTxn currentTrackerCondition currentTracker referrerCode tenderProfile CurrentLineItem |
DelayedAccrual | Credits points to customer account after a specific number of days | currentCustomer currentEvent currentStore program |
CustomerRegistration | This event is used to create rules and execute actions on customer registrations | currentCustomer currentEvent currentStore referrerCode |
PointsRedemption | This event is used for redeeming points and executing actions on points redemptions. Before executing this event, the system checks whether the points are redeemable. | currentCustomer currentEvent currentStore |
CouponRedemption | This event is used to execute actions on coupon redemption | currentCustomer currentEvent currentStore |
ReturnTransaction | This event is used to execute actions on transaction returns | currentCustomer currentEvent currentStore tenderProfile returnBill |
CustomerUpdate | This event is used to execute actions on profile updates | currentCustomer currentEvent |
TransactionUpdate | This event is used to execute actions on transaction updates | currentCustomer currentEvent currentStore currentTxn |
SocialConnect | This event is used to execute actions on social events (events through Social Connect) | currentCustomer currentEvent currentStore |
SlabUpgrade | This event is used to execute actions on tier upgrades | currentCustomer currentEvent currentStore currentTxn referrerCode tenderProfile |
PointsRedemptionReversal | Reversal of points redeemed for a transaction if the transaction is returned. | currentCustomer currentEvent currentStore organization program |
Profile Attributes
Each profile supports different attributes. You can use attributes along with their supported profiles. The following table provides the list of different attributes supported for each profile.
EVENT PROFILE | DESCRIPTION | ATTRIBUTES |
currentCustomer | Evaluate rules on the current customer that performed an activity | name firstname lastname externalId mobile slabName slabNumber currentPoints currentAllPoints lifetimePoints initialLifetimePoints initialCurrentAllPoints lifetimeNonRedeemablePoints currentNonRedeemablePoints lifetimePurchase initialLifetimePurchase initialSlabName initialSlabNumber initialCurrentPoints initialLifetimePoints joinDate customFieldValueIncludes customFieldValue Excludes clusterValueIncludes clusterValueExcludes numberOfVisits numberOfTxnsToday numberOfTxns avgSpendPerVisit avgBasketSize slabExpiryDate isLoyal hasInstoreProfile hasWeChatProfile doesProfileExists |
currentTxn | Evaluate actions based on the current transaction activity | value date notes number basketSize basketIncludes basketExcludes basketSum basketCount basketQty basketIncludesRegex basketExcludesRegex basketSumRegex basketCountRegex basketQtyRegex totalQty discount points customFieldValueIncludes customFieldValueExcludes |
currentStore | Evaluate actions based on the store at which the activity happened | name code |
Transaction Update (currentEvent) | Evaluate actions based on the store at which the activity happened | previousCustomField Value currentCustomField Value |
Social Connect (currentEvent) | Evaluate actions based on the activities of the customer through Social Networks | published On module channel type activity Channel Id actor Channel Id target Channel Id updated On title url visibility flowCode stepCode |
Points Redemption (currentEvent) | Evaluate actions based on the points redemption activity of the customer | pointsToRedeem redeemedOnBillNumber notes |
referrerCode | Evaluate actions based on the customer referral program | refereeRegCount refereeTransactionCount |
currentLineItem | Evaluate actions based on the line-items of the transaction activity | code value discount qty discPercentage rate description doesItemMatch |
tenderProfile | Evaluate actions based on the payment modes | code amount notes |
Customer Registration (currentEvent) | Evaluate actions based on the customer registration activity | currentUserSource eventType |
Coupon Redemption (currentEvent) | Evaluate actions based on the coupon redemption activity | redeemedCouponSeriesId redeemedCouponId |
returnBill | Evaluate actions based on the transaction redemption activity | amountPaidUsingPoints |
Tracker Condition (Transaction Add) | Evaluate actions based on the tracker condition | trackerId trackerConditionId trackedValue trackerCurrAggr numberOfVisits |
Customer Update (currentEvent) | Evaluate actions based on the customer profile update activity | previousName currentName previousFirstName currentFirstName previousLastName currentLastName previousMobile currentMobile previousEmail currentEmailTracker previousExternalId currentExternalId previousCustomFieldValue currentCustomFieldValue previousLoyaltyType currentLoyaltyType previousCustomFieldValue currentCustomFieldValue previousCustomFieldValueExists currentCustomFieldValueExists |
currentTrackerCondition | Evaluate actions based on the tracker conditions | noOfVisits tracked Value tracker Condition Name tracker Name tracker Condition Period trackerCurrAggr trackerInitialPrevAggr trackerPrevAggr |