Smart Seller Manager

August 10, 2017

Please, verify your rules with tech team to make be sure that they are right and written in a performant way

Objective

Smart Seller Manager is a Rule Engine used to automate operational tasks usually done by the Seller account management team. A flexible construct of rules consisting of events, conditions and actions allow for automation of complex tasks affecting sellers, their order items or their products.

Critical KnowledgeIf you want to enable Smart Seller Manager on Staging/Live Systems, please raise a TMLSD ticket. The parameters that need to be enabled is: core/smart_seller_management/enabled and in order to use and manage tags as well as display them to Sellers please also enable the Tag Manager.

It is recommended to enable the feature first on a staging system before enabling it on Live.

For setting up the rules, please also raise a ticket with the according rules.

Contents

1 Objective
- 1.1 Manual
2 Terminology
3 Operators
- 3.1 Actions
  - 3.1.1 Disclaimer:
4 Rule Setup
5 Deferred Actions
- 5.1 Sample Rule Setup
6 Troubleshooting hints

Manual

The attached file contains a summary of the Smart Seller Management feature and the best way to setup rules.

Smart Seller Manager Manual

A more up to date version can be read online.

Terminology

Status

A rule can either be disabled or enabled. This defines whether the rule is being executed or not. A disabled rule can be activated again it will be executed next time it is triggered.

Trigger

The trigger determines the underlying automation logic for the invoking the execution of a rule. The trigger Event allows users to attach a rule to the occurrence of a state that can happen randomly at any time such as Order Item Imported or Order Item Returned. A Scheduled type of rule is triggered regularly according to a configured time (under Scheduler) and attached to an entity (under Scheduled for either seller, order item or product).

If “Scheduled” is selected as type the Schedule needs to be configured as follows:

Scheduled for

This defines which entity is used to measure the time passed. For example: Do we check every time 1 hour passes for an order item or do we check in the beginning of every month for a Seller?

Scheduler

Here the time intervals or general timing for the Schedule has to be configured by selecting the desired expression.

Examples:

Every week on every day of the week at 18 hours and 30 minutes
Every week on every day of the week at 18 hours and 30 minutes
Every month on the 1st at 18 hours and 20 hours and 00 minutes
Every hour at 5 minutes past the hour
If “Event” is selected as type the event needs to be further specified in the following:

Event

The event specifies when a rule will be triggered the current events available are:

SalesOrderItemReturned
SalesOrderItemImported
SalesOrderItemCanc
SellerRatingUpdated

The first part of the event name describes the context of the event for example: Sales Order Item, Seller or Product. The second part describes the actual event for example: When Sales Order Item is Returned the rule is executed and the conditions are checked.

Contexts

Contexts define the entity space to which a rule is applied this is needed to display the available parameters in conditions and possible actions in order to create a working rule. This means all areas a rules condition or actions should be applied to have to be selected in the context field. The following contexts are currently available (depending on whether Cron or Event were selected as type):

Account Statements Groups
Order
Order Item
Order Item Precalculated Transactions
Order Item Transactions
Product
Product Quality Control
Product Statistics
Seller
Seller Rating
Seller Statistics
Seller Watchlist (deprecated)
Seller Tags
Seller Tiering

Condition

Once the event for the rule happened the condition is checked to determine whether the correlated action has to be triggered. If the condition ends up being true then the rule with its actions is applied.

Classification of available conditions

F – Functions – if it is a function then you need to add “()”. For example, Timing.now(), Timing.now().format(“Y-m-d”)
I – Integer
B – Boolean
S – String
O – Object
D – Decimal

+-Globally Available

Group	Attribute	Description	Classification	Example
Timing	Timing.weekdaySunday	The numerical representation of Sunday (0)	I	Timing.weekdaySunday == false
	Timing.weekdayMonday	The numerical representation of Monday (1)	I	Timing.weekdayMonday == true
	Timing.weekdayTuesday	The numerical representation of Tuesday (2)	I	Timing.weekdayTuesday or Timing.weekdayMonday == true
	Timing.weekdayWednesday	The numerical representation of Wednesday (3)	I	orderItem.status == orderItemStatuses.pending and Timing.weekdayWednesday
	Timing.weekdayThursday	The numerical representation of Thursday (4)	I
	Timing.weekdayFriday	The numerical representation of Friday (5)	I
	Timing.weekdaySaturday	The numerical representation of Saturday (6)	I
	Timing.now	Returns the current time in seconds	F	Timing.now().diff(orderItem.readyToShipAt) > 2880
	Timing.startedAt	Returns the time when the script started	F	Timing.startedAt().diff(orderItem.readyToShipAt) > 2880
	Timing.parse	Converts the given textual object to a time object. To see what can be used please refer to this link	F	Timing.parse(“7 days ago”)
	Timing.isWeekend	Is the given time a weekend for the Seller or in general if Seller Id was not provided	F	Timing.isWeekend =! true
	Timing.isHoliday	Is the given time a holiday for the Seller or in general if Seller Id was not provided	F	Timing.now().isHoliday
	Timing.beginningOfThisDay	Returns the beginning of this day time	F
	Timing.beginningOfThisWeek	Returns the beginning of this week time	F
	Timing.beginningOfThisMonth	Returns the beginning of this month time	F
	Timing.beginningOfThisYear	Returns the beginning of this year time	F
Available for all Timing functions mentioned above	Timing. … .format	Formats the Timing Object according to a defined format, by default that is Y-m-d\TH:i:s for available formats please check here	F	Timing.now().format(“Y-m-d”)
	Timing. … .year	Full numeric representation of a year in 4 digits	F
	Timing. … .month	Returns the numeric representation of a month from 1 to 12	F
	Timing. … .day	Returns the numeric representation of the day of a month from 1 to 31	F
	Timing. … .week	Returns the number of the week of a year	F
	Timing. … .weekday	Returns the numeric representation of the day of the week from 0 (Sunday) to 6 (Saturday)	F
	Timing. … .hour	Returns the numeric representation of the hour of the day from 0 to 23	F
	Timing. … .diff	The difference between the current timing object and provided parameter in seconds. If the parameter is earlier than the object, the result is positive	F	Timing.now().diff(orderItem.readyToShipAt) > 129600
	Timing. … .addDays	Adds an amount of days	F
	Timing. … .addWeeks	Adds an amount of weeks	F
	Timing. … .addMonths	Adds an amount of months	F
	Timing. … .addYears	Adds an amount of years	F
	Timing. … .subDays	Subtracts an amount of days	F
	Timing. … .subWeeks	Subtracts an amount of weeks	F
	Timing. … .subMonths	Subtracts an amount of months	F
	Timing. … .subYears	Subtracts an amount of months	F
Math	Math.ceil	Rounds up fractions	F
	Math.round	Returns the rounded value of a value to specific precision	F
	Math.floor	Rounds fractions down	F
	Math.abs	Absolute value	F
	Math.max	Find highest value	F	Math.max(10)
	Math.min	Find lowest value	F	Math.min(1)
Category	Category.isInSubtree	Checks if a category is in a subtree	F	Category.isInSubtree (12)
PendingTransactions	PendingTransactions.countPendingTransactionsBySeller	Returns the amount of pending transactions of the Seller with the given account statement group. The parameters are: SellerId (I required), accountStatementGroupId (I optional), startDate (TimingObject optional), endDate (TimingObject optional)	F	PendingTransactions.countPendingTransactionsBySeller(seller.id,accountStatementGroups.get(“Customer Compensation for Bad Quality Items”).id,Timing.parse(“7 days ago”),Timing.now()) > 0
Transactions	Transactions.countTransactionsBySeller	Returns the amount of transactions of the Seller with the given account statement group. The parameters are: SellerId (I required), accountStatementGroupId (I optional), startDate (TimingObject optional), endDate (TimingObject optional)	F	Transactions.countTransactionsBySeller(seller.id,accountStatementGroups.get(“Customer Compensation for Bad Quality Items”).id,Timing.parse(“7 days ago”),Timing.now()) > 0
Order item Shipment Types	orderItemShipmentTypes.cossDocking	Returns cross-docking shipment type for an order item	I	orderItem.shipmentType == orderItemShipmentTypes.cossDocking
	orderItemShipmentTypes.dropShipping	Returns dropshipping shipment type for an order item	I
	orderItemShipmentTypes.ownWarehouse	Returns own warehouse shipment type for an order item	I
Order Item Statuses	orderItemStatuses.pending	Returns pending status of item	S
	orderItemStatuses.shipped	Returns shipped status of item	S
	orderItemStatuses.canceled	Returns cancelled status of item	S
	orderItemStatuses.failed	Returns failed status of item	S
	orderItemStatuses.delivered	Returns delivered status of items	S
	orderItemStatuses.readyToShip	Returns ready to ship status of item	S

+-Event: Seller Rating Updated / Cron Type: Seller

Context	Attribute	Classification	Description	Example
Seller	seller.id	Internal Seller Center ID of Seller	I	Timing.isWeekend(Timing.now(),seller.id) == false
	seller.shortCode	Seller identifier aka Seller Shortcode or Seller Id	S
	seller.age	Seller age on the platform since registration in days	I	seller.age > 30
	seller.hasTag	Checks whether the given seller has tags assigned	B	Timing.isWeekend(Timing.now(),seller.id) == false and seller.hasTag() == true
	seller.hasAssignedTags	The name of the tag assigned to a Seller	F	seller.hasAssignedTags([“Tag1″,”Tag2”]) == true
	seller.email	Seller email	S
	seller.taxClass	Seller tax class which is either local or international	S	seller.taxClass = international
	seller.currentTier	The representation of the current Seller tier	S
Seller Rating	sellerRating.rating	Seller ranking, a value between 0.00 and 5.00	D	sellerRating.rating =! 0
	sellerRating.hasRating	Whether the Seller has a rating	B	sellerRating.rating =! 0 and sellerRating.hasRating
	sellerRating.cancellationRate	Check the Seller’s cancellation rate, a value between 0.00 and 1.00 representing a percentage	D	sellerRating.cancellationRate = 0.1
	sellerRating.hasCancellationRate	Whether the Seller has a cancellation rate	B
	sellerRating.returnRate (not implemented)	Check the Seller’s return rate, a value between 0.00 and 1.00 representing a percentage (not implemented)	D
	sellerRating.hasReturnRate (not implemented)	Whether the Seller has a return rate (not implemented)	B
	sellerRating.readyToShip24hRate	Check the Seller’s ready to ship 24hr rate, a value between 0.00 and 1.00 representing a percentage	D
	sellerRating.hasReadyToShip24hRate	Whether the Seller has a ready to ship 24hr rate	B
	sellerRating.shipped24hRate	Check the Seller’s pending to shipped in 24hr rate, a value between 0.00 and 1.00 representing a percentage	D
	sellerRating.hasShipped24hRate	Whether the Seller has a pending to shipped in 24hr rate	B
	sellerRating.shipped48hRate	Check the Seller’s pending to shipped in 48hr rate, a value between 0.00 and 1.00 representing a percentage	D
	sellerRating.hasShipped48hRate	Whether the Seller has a pending to shipped in 48hr rate	B
	sellerRating.shipOnTimeRate	Check the Seller’s ship on time rate, a value between 0.00 and 1.00 representing a percentage	D
	sellerRating.hasShipOnTimeRate	Whether the Seller has a ship on time rate	B
	sellerRating.averageRating	Checks the Seller’s average rating over the past 3 months	D
	sellerRating.hasAverageRating	Whether the Seller has an average rating	B
Seller Statistics	sellerStatistics.itemsSold	Number of gross items sold over the last D days	D
	sellerStatistics.averageItemsFulfilled	Average value of (Items sold – items cancelled) daily, calculated over a number of days with min. one order, over the last 2 weeks	D
	sellerStatistics.itemsForPeriod	Amount of (items sold – items cancelled) over the last M calendar months	I
Seller Tags	sellerTags.productsAmount	Amount of products which are tagged for the current seller	I	sellerTags.productsAmount > 1
	sellerTags.hasProducts	Whether the seller has products which are tagged or not	B	sellerTags.hasProducts == true
	sellerTags.orderItemsAmount	Amount of order items which are tagged for the current Seller	I	sellerTags.orderItemsAmount < 10
	sellerTags.hasOrderItems	Whether the Seller has order items on which are tagged or not	B	sellerTags.hasOrderItems < 10
Seller Tiering	tiering.has	Checks if tier with given name exists	F
	tiering.get	Returns a tier by a given name	F	(seller.age == 0 or seller.age >= tiering.get(“argent”).getAttr(“sellerAge”))
	tiering.get.name	Tier context name (system name)	S
	tiering.get.displayName	Tier display name (human readable)	S
	tiering.get.hasAttr	Check if an Attribute for a tier with given name exists	F
	tiering.get.getAttr	Returns an attribute of a tier by given name	F	(seller.age == 0 or seller.age >= tiering.get(“argent”).getAttr(“sellerAge”))
Account Statement Groups	accountStatementGroups.has	Checks if an account statement group with a given name exists, required parameter is a string with the name	F	accountStatementGroups.has (“Commission”)
	accountStatementGroups.get	Returns an account statement group with a given name, required parameter is a string with the name	F	accountStatementGroups.get (“Commission”)
	accountStatementGroups.id	Returns an account statement group with a given account statement group Id	I
	accountStatementGroups.name	Returns an account statement group with a given human readable account statement group name	S
	accountStatementGroups.transactionTypeId	Returns an account statement group with a associated transaction type Id	U

+-Event: Sales Order Item Imported / Returned / Cron Type: Sales Order Item

Context	Attribute	Classification	Description	Example
Seller	seller.id	Internal Seller Center ID of Seller	I	Timing.isWeekend(Timing.now(),seller.id) == false
	seller.shortCode	Seller identifier aka Seller Shortcode or Seller Id	S	seller.shortCode == “TH435”
	seller.age	Seller age on the platform since registration in days	I	seller.age > 10
	seller.hasTags	Checks whether the given Seller has tags assigned	B	seller.hasTags == true
	seller.hasAssignedTags	The name of the tag(s) assigned to a sellers	F	seller.hasAssignedTags([“Tag1″,”Tag2”])
	seller.email	Seller email	S
	seller.taxClass	Seller tax class which is either local or international	S	seller.taxClass == “international”
	seller.currentTier	The representation of the current Seller tier	S
Seller Rating	sellerRating.rating	Seller ranking, a value between 0.00 and 5.00	D	sellerRating.rating > 2
	sellerRating.hasRating	Whether the Seller has a rating	B
	sellerRating.cancellationRate	Check the Seller’s cancellation rate, a value between 0.00 and 1.00 representing a percentage	D
	sellerRating.hasCancellationRate	Whether the Seller has a cancellation rate	B
	sellerRating.returnRate	Check the Seller’s return rate, a value between 0.00 and 1.00 representing a percentage	D
	sellerRating.hasReturnRate	Whether the Seller has a return rate	B
	sellerRating.readyToShip24hRate	Check the Seller’s ready to ship 24hr rate, a value between 0.00 and 1.00 representing a percentage	D
	sellerRating.hasReadyToShip24hRate	Whether the Seller has a ready to ship 24hr rate	B
	sellerRating.shipped24hRate	Check the Seller’s pending to shipped in 24hr rate, a value between 0.00 and 1.00 representing a percentage	D
	sellerRating.hasShipped24hRate	Whether the Seller has a pending to shipped in 24hr rate	B
	sellerRating.shipped48hRate	Check the Seller’s pending to shipped in 48hr rate, a value between 0.00 and 1.00 representing a percentage	D
	sellerRating.hasShipped48hRate	Whether the Seller has a pending to shipped in 48hr rate	B
	sellerRating.shipOnTimeRate	Check the Seller’s ship on time rate, a value between 0.00 and 1.00 representing a percentage	D
	sellerRating.hasShipOnTimeRate	Whether the Seller has a ship on time rate	B
	sellerRating.averageRating	Checks the Seller’s average rating over the past 3 months	D
	sellerRating.hasAverageRating	Whether the Seller has an average rating	B
Seller Statistics	sellerStatistics.itemsSold	Number of gross items sold over the last D days	D
	sellerStatistics.averageItemsFulfilled	Average value of (Items sold – items cancelled) daily, calculated over a number of days with min. one order, over the last 2 weeks	D
	sellerStatistics.itemsForPeriod	Amount of (items sold – items cancelled) over the last M calendar months	I
Seller Tags	sellerTags.productsAmount	Amount of products which are tagged for the current Seller	I
	sellerTags.hasProducts	Whether the Seller has tagged products or not	B
	sellerTags.orderItemsAmount	Amount of order items which are tagged for the current Seller	I
	sellerTags.hasOrderItems	Whether the seller has tagged order items or not	B
Seller Tiering	tiering.has	Checks if tier with given name exists	F
	tiering.get	Returns a tier by a given name	F
	tiering.get.name	Tier context name (system name)	S
	tiering.get.displayName	Tier display name (human readable)	S
	tiering.get.hasAttr	Check if an Attribute for a tier with given name exists	F
	tiering.get.getAttr	Returns an attribute of a tier by given name	F
Account Statement Groups	accountStatementGroups.has	Checks if an account statement group with a given name exists, required parameter is a string with the name	F
	accountStatementGroups.get	Returns an account statement group with a given name, required parameter is a string with the name	F	accountStatementGroups.get(“Customer Compensation for Bad Quality Items”)
	accountStatementGroups.id	Returns an account statement group with a given account statement group Id	I
	accountStatementGroups.name	Returns an account statement group with a given human readable account statement group name	S
	accountStatementGroups.transactionTypeId	Returns an account statement group with a associated transaction type Id	U
Order	order.id	Seller Center internal order id	I
Order Item Precalculated Transactions	orderItemPrecalculatedTransactions.hasByGroup	Whether an order item has a precalulated transaction in the given account statement group. The account statement group needs to be defined as string.	F
	orderItemPrecalculatedTransactions.getSumByGroup	Returns the sum of all order item with precalulated transaction in the given account statement group. The account statement group needs to be defined as string.	F
Order Item Transactions	orderItemPrecalculatedTransactions.hasByGroup	Whether an order item has a precalulated transaction in the given account statement group. The account statement group needs to be defined as string.	F
	orderItemPrecalculatedTransactions.getSumByGroup	Returns the sum of all order item with precalulated transaction in the given account statement group. The account statement group needs to be defined as string.	F
Product	product.id	Internal Seller Center Id of the product	I
	product.sku	Product SKU	S
	product.productSetId	Product set Id	I
	product.primaryCategoryId	Product primary category Id	I
	product.hasTag	Whether a product is tagged	B
	product.hasAssignedTags	Checks if tag mentioned in the function are assigned to the given product	F	product.hasAssignedTags([“tag 1″,”tag 2”])
	product.qcStatus	The product quality control status of a product	S
	product.rejectReason	The reason a product was rejected from quality control	S
Product Statistics	productsStatistic.returnRate	Provides option to check the return rate of a product	D
	productsStatistic.rejectionRate	Provides option to check the rejection rate of a product	D
	productsStatistic.dailySales	Amount of order items which were created on that day	I
Product Quality Control	productQc.rejectReason	Project quality reject reason list	A	(“reason 1” in productQc.rejectReasons) or (“reason 2” in productQc.rejectReasons)

+-Cron Type: Product

Context	Attribute	Classification	Description	Example
Seller Tiering	tiering.has	Checks if tier with given name exists	F
	tiering.get	Returns a tier by a given name	F
	tiering.get.name	Tier context name (system name)	S
	tiering.get.displayName	Tier display name (human readable)	S
	tiering.get.hasAttr	Check if an Attribute for a tier with given name exists	F
	tiering.get.getAttr	Returns an attribute of a tier by given name	F
Account Statement Groups	accountStatementGroups.has	Checks if an account statement group with a given name exists, required parameter is a string with the name	F
	accountStatementGroups.get	Returns an account statement group with a given name, required parameter is a string with the name	F	accountStatementGroups.get(“Customer Compensation for Bad Quality Items”)
	accountStatementGroups.id	Returns an account statement group with a given account statement group Id	I
	accountStatementGroups.name	Returns an account statement group with a given human readable account statement group name	S
	accountStatementGroups.transactionTypeId	Returns an account statement group with a associated transaction type Id	U
Product	product.id	Internal Seller Center Id of the product	I
	product.sku	Product SKU	S
	product.productSetId	Product set Id	I
	product.primaryCategoryId	Product primary category Id	I
	product.hasTags	Whether a product has tags assigned Critical KnowledgeWatchlist will be replaced by tags managed by the Tag Manager feature by the end of Q3 2017	B
	product.hasAssignedTags	Checks if tag mentioned in the function are assigned to the given product	F	product.hasAssignedTag([“tag1″,”tag2”])
	product.qcStatus	The product quality control status of a product	S
	product.rejectReason	The reason a product was rejected from quality control	S
Product Statistics	productsStatistic.globalReturnRate	Provides option to check the global return rate of a product	D
	productsStatistic.rejectionRate	Provides option to check the rejection rate of a product	D
	productsStatistic.dailySales	Amount of order items which were created on that day	I
	productStatistic.numberOfGlobalReturns	Returns the number of times a product has been returned calculated over the same time as the globalReturnRate
Product Quality Control	productQc.rejectReason	Project quality reject reason list	A	(“reason 1” in productQc.rejectReasons) or (“reason 2” in productQc.rejectReasons)

Operators

+-Arithmetic Operators

+ (addition)
- Example: In transaction generation you may put as net value “orderItemTransactions.getSumByGroup(accountStatementGroups(“Commission”)) + 100″ add 100 to sum of all commissions for an order item
– (subtraction)
- Example: In transaction generation you may put as net value “orderItemTransactions.getSumByGroup(accountStatementGroups(“Commission”)) – 100″ subtract 100 from sum of all commissions for an order item
* (multiplication)
- Example: In transaction generation you may put as net value “orderItemTransactions.getSumByGroup(accountStatementGroups(“Commission”)) * -1″ change sign (to negative) for sum of order item commissions
/ (division)
- Example: In transaction generation you may put as net value “orderItemTransactions.getSumByGroup(accountStatementGroups(“Commission”)) / 10″ divide sum of order item commissions by 10
% (modulus)
- Example: (Timing.now().year % 4 ) == 0 // Leap year
** (pow)
- Example: In transaction generation you may put as net value “orderItemTransactions.getSumByGroup(accountStatementGroups(“Commission”)) ** 2″ raise to power of 2 sum of order item commissions

+-Comparison Operators

== (equal)
- Example: sellerRating.hasGlobalCancellationRate == true
=== (identical)
- Checks that both comparing side has same value and same type (boolean/string/integer, etc..), seller.taxClass === ‘local’
!= (not equal)
- Example: orderItem.shipmentType != OrderItemShipmentTypes.dropShipping
!== (not identical)
- In addition of checking values, the operator also compares for types (boolean/string/integer, etc..), orderItem.returnReason !== “Quality – item counterfeit”
< (less than)
- Example: seller.age < 30
> (greater than)
- Example: Timing.now().diff(orderItem.createdAt) > 25200 – if order item was created more than 7 hours ago
<= (less than or equal to)
- Example: seller.age <= 30
>= (greater than or equal to)
- Example: seller.age >= 30
matches (regex match)
- Example: “1020202” matches “/([0-9]+)/g”

+-Logical Operators

not or !
- Example: !Timing.isHoliday(Timing.now(),seller.id)
and or &&
- Example: seller.taxClass == ‘global’ and orderItem.status == OrderItemStatuses.readyToShip
or or ||
- Example: seller.taxClass == ‘global’ and orderItem.status || OrderItemStatuses.readyToShip

+-String Operators

~ (concatenation)
- Example: “Seller has ” ~ sellerTags.productsAmount ~ ” of products tagged”

+-Array Operators

in (contain)
- Example: seller.shortCode in [‘NG101Y9′,’NG10A0F’]
not in (does not contain)
- Example: seller.shortCode not in [‘NG101Y9′,’NG10A0F’]

+-Numeric Operators

.. (range)
- Example: seller.age in 18..45

Actions

A rule can be linked to a multitude of actions that are executed after the rules condition is checked and applied to the context for which the rule was configured. Currently the following actions are available:

+-AddOrderItemTag/AddProductTag/AddSellerTag

This action allows to add tags which have been previously configured in the Tag Manager to Sellers, Products or Order Items. Tags on Order Item or Product level are exposed to Sellers as described further in the Tag Manager documentation.

To assign a tag to an entity just select tag name from the dropdown for the action, the expiry time of the tag will be displayed in the list. The expiry countdown begins as soon as the tag was assigned to the entity.

To link to tagged products simply use: [sellercenter url]/product/index/tagged

To link to tagged order items use: {development on going}

+-SaveTieringData

Saves tiering data for later use

+-SendEmail

SendEmail sends the values for placeholders to a selected email template. The parameters must be labelled according to the ones defined in UMS and the Email template needs to exist under “Content Management” “Email Setup”.

The format in order to define the placeholder values is: {“UMSPlaceholderName1”: valueYouWantToSend; “UMSPlaceholderName2”: valueYouWantToSend}

Example: {“Link”:”https://sellercenter.jumia.ci/report/transaction-overview?fromDate=”~ Timing.parse(“7 days ago”).format(“Y-m-d”)~”&toDate=”~Timing.now().format(“Y-m-d”)~”&transactionTypeIds=73″}

+-SetDailyOrderLimit

SetDailyOrderLimit sets a Seller’s DOL to an in the rule defined value

+-SetPendingOrderLimit

SetPendingOrderLimit sets a Seller’s POL to an in the rule defined value

+-SetPendingToShippedOrderLimit

SetPendingToShippedOrderLimitsets a Seller’s PTSOL to an in the rule defined value

+-SetProductToAuthorized

SetProductToAuthorized moves products which have the Status unauthorized back to the status they had prior to that

+-SetProductToNotAuthorized

SetProductToAuthorized moves products into the unauthorized status (see here for more information on the Set Product to Unauthorized Feature)

+-UpdateSellerTier

Increases the Seller Tier by one Tier as defined in the Seller Tiering feature setup (see here for more information on the Seller Tiering Feature)

+-Generate Pending Transaction

Generate a pending transaction which needs to be manually approved by an admin. This action uses the feature Pending Transactions and follows the same process. The following parameters are to be filled:

Account statement group
- Define group to show in account statement
- One of the Account statement groups listed in Transaction Rule Engine (/admin/transaction-rule_account-statement-groups)
Reference
- Define reference entity ID of the transaction, depends on Account statement group
- important to fill in correctly in order to maintain Transaction consistency
- Relates to the reference of an Account statement group (ACG) above
- Suggestion on which Reference to fill in:
  - ACG reference: sales_orderitem => Reference: orderItem.id

Outcome

Define which kind of transaction should be generated

Net value of transaction

Define the calculation to get the amount of the transaction

NET value of a transaction either as a number (42.50) or as an expression (potential example: orderItem.unitPrice)

VAT value

Define the value or the formula to get the VAT amount of the transaction

Absolute value of the VAT, not a percentage

0 (zero) can be used for no VAT value

Number or expression as same as NEW value above

WHT value

Define the value or the formula to get the WHT amount of the transaction

Absolute value of the WAT, not a percentage

0 (zero) can be used for no WHT value

Number or expression as same as NEW value above

Unique transaction identifier
- Define system-wise unique array of identifiers of transaction, ex. {‘key’: ‘id-‘ ~ seller.id, …} with double quotes, all keys and values must be string_
- Unable to render embedded object: File (/images/icons/emoticons/warning.png) not found. important to maintain the uniqueness of transactions in the system
- Transaction Rule Engine defines the unique a transaction as a transaction with unique values describing the Transaction, we can provide these values in this field
- The value is optional and when it’s left empty, TRE will not check the uniqueness of generated transaction
- Array can only contain key and values with a type of string
- Account statement group is automatically added into the array of values in background, no need to add it again
- Examples:
  - {“sellerId”: “seller-” ~ seller.id} transaction with given ACG will be created only one for the seller
  - {“weekNumber”: 42} Action execution will failt – 42 is not a string
  - {“weekNumber”: “week-” ~ 42} transaction with given ACG will be created only one in this week, regadless seller ID
  - {“seller”: “seller-” ~ seller.id, “weekNumber”: “week-” ~ week.number, “rule-id”: “rule-” ~ rule.id} transaction will be generated only one for given seller in given week by given rule

+-Generate Transaction

Creates a transaction for a seller according to the defined parameters. The following parameters are to be filled:

Account statement group
- Define group to show in account statement
- One of the Account statement groups listed in Transaction Rule Engine (/admin/transaction-rule_account-statement-groups)
Reference
- Define reference entity ID of the transaction, depends on Account statement group
- important to fill in correctly in order to maintain Transaction consistency
- Relates to the reference of an Account statement group (ACG) above
- Suggestion on which Reference to fill in:
  - ACG reference: sales_orderitem => Reference: orderItem.id

Unique transaction identifier
- Define system-wise unique array of identifiers of transaction, ex. {‘key’: ‘id-‘ ~ seller.id, …} with double quotes, all keys and values must be string_
- Unable to render embedded object: File (/images/icons/emoticons/warning.png) not found. important to maintain the uniqueness of transactions in the system
- Transaction Rule Engine defines the unique a transaction as a transaction with unique values describing the Transaction, we can provide these values in this field
- The value is optional and when it’s left empty, TRE will not check the uniqueness of generated transaction
- Array can only contain key and values with a type of string
- Account statement group is automatically added into the array of values in background, no need to add it again
- Examples:
  - {“sellerId”: “seller-” ~ seller.id} transaction with given ACG will be created only one for the seller
  - {“weekNumber”: 42} Action execution will failt – 42 is not a string
  - {“weekNumber”: “week-” ~ 42} transaction with given ACG will be created only one in this week, regadless seller ID
  - {“seller”: “seller-” ~ seller.id, “weekNumber”: “week-” ~ week.number, “rule-id”: “rule-” ~ rule.id} transaction will be generated only one for given seller in given week by given rule

Disclaimer:

Pay attention when creating logical expression as for example order items can always be in only one state. A condition ignoring this will result in a non executable rule or an unexpected error.

Rule Setup

#	Description	Image
1	Navigate to Administration > Seller > Smart Seller Manager and select Add to add a new rule
2	Enter a Rule Name and a Description
3	Select a Trigger for the rule either: Event for things that occur in a certain place during a particular interval of time Scheduled for scheduled executions of rules
4	If you selected Event as Type next the Event itself needs to be specified either: Sales Order Item Imported Sales Order Item Returned Sales Order Item Canceled Seller Rating Updated
5	If you selected Scheduled as Type Scheduled for needs to be selected next. This means which the entity the schedule is referring to. For example: “Every day at 6.00 pm for a Seller” or “Every day at 6.00 pm for an Order Item”The selection has to be made between: Seller Order Item Product
6	To configure the schedule please adjust the Schedule field as required
7	For both rule types its mandatory to select a context. The context defines which Conditions are available as rule conditions and action parameters please refer to the “Context” paragraph to understand which contexts are needed for which conditions.
8	Next its possible to add the rule to a rule group this is an optional field which allows to easier understand which rules are thematically related. A rule group needs to be set up prior to it being selected here.
9	The Execute After Hours field allows rules to be configured to either execute immediately, by leaving it empty, when the condition is met or is executed after the hours configured in the field.
10	Through the Priority Order the priority of the rule within the group is defined. If the rule is not part of a group the priority is not taken into consideration and not shown.
11	Enter the condition that needs to be fulfilled in order to trigger the action for the rule. The action can use all: F – Functions I – Integer B – Boolean S – String O – Object D – Decimal defined in “Contexts”.
12	After the rule configuration is saved the next step is to add Actions that are executed when the event occurs and the condition is met. The available actions are explained under Actions in this document. After all actions have been added click Save Changes to submit the changes. The rule will not be active until it was enabled and published.
13	In order to activate the rule it needs to be enabled and published from the Administration > Seller > Smart Seller Manager overview

Deferred Actions

#	Description	Image
1	Navigate to Administration > Seller > Smart Seller Manager > Deferred Actions
2	All rules related actions which were configured to be “Put into the the queue” will appear in the deferred actions table when the rule is triggered and the condition is true.
3	Actions in the queue are automatically executed after the configured time but they can be manually suppressed by clicking Edit and Suppress Action. The action will then be excluded for the particular context. If the rule runs again the action needs to be suppressed again if required.

Sample Rule Setup

Rule Group	Rule Name	Description	Type	Contexts	Defer	Condition	Action
Late Fulfilment Education	Add Tag to Pending Items	Assign a tag (“Late Fulfilment”) to order items every day at 6am which are pending and will be go over the defined SLA time in the next 48 hours	Scheduled Schedule for: Seller Schedule: Every day at 6am	orderItem, orderItemStatuses, orderItemShipmentTypes, seller	No	orderItem.shipmentType == orderItemShipmentTypes.dropShipping and Timing.isWeekend(Timing.now(),seller.id) == false and Timing.isHoliday(Timing.now(),seller.id) == false and orderItem.status == orderItemStatuses.pending and Timing.now().diff(orderItem.createdAt) >172800 and Timing.now().weekday() != Timing.weekdayMonday	AddToWatchlist entityType: “order_item” expire_hours: 20 reason: “Late Fulfillment – Pending to RTS”
Late Fulfilment Education	Send warning popup for order items on Watchlist	Tags Sellers as target of warning popup sent on regular basis.	Scheduled Schedule for: Seller Schedule: Every day at 6am	seller, sellerWatchlist	No	sellerWatchlist.hasOrderItems == true	AddSellerTag the tag needs to be created before in Tag Manager. The tag needs to have the expiration set up. the popup warning is sent manually to all tagged Sellers using News
Late Fulfilment Education	Send preventive e-mail for order items on Watchlist	Sends warning email every day at 7am to Sellers who have order items on watchlist at a defined point in time	Scheduled Schedule for: Seller Schedule: Every day at 6am	seller, sellerWatchlist	No	sellerWatchlist.hasOrderItems == true	Send Email emailTemplateTypeName: “late_fulfillment_preventive_report” emailTemplateValuesArray: {“nbOrderItemsWL”:sellerWatchlist.orderItemsAmount, “url_to_sc_pending”:”https://sellercenter.jumia.ci/order/index/index/filteredStatus/18″, “url_to_sc_rts”:”https://sellercenter.jumia.ci/order/index/index/filteredStatus/84″}
Late Fulfilment Education	Cancel pending order items	Cancels all order items which are on Watchlist and still pending (have not been processed) at 10pm	Scheduled Schedule for: OrderItem Schedule: Every day at 10pm	seller, sellerWatchlist	No	sellerWatchlist.hasOrderItems == true and orderItem.status == OrderItemStatuses.pending	Set Order Item to Canceled Cancelation Reason: Late Fulfilment Description: Your order items were cancelled due to late fulfilment

Troubleshooting hints

There may be a need to understand why certain rules were not triggered nor executed. Fortunately, Smart Seller Manager comes with extensive logging, through Kibana. We recommend to use the following queries as an investigation / troubleshooting pattern:

– To find if and when the cronjob was triggered:

venture:jumia AND country:eg AND context.rule_name:”Generate Pending Transactions for OOS based on Tag” AND message:”execution attempt”

– To find if and when some rules passed a condition:

venture:jumia AND country:eg AND context.rule_name:”Generate Pending Transactions for OOS based on Tag” AND message:”condition fulfilled”

The message log from the query above will contain an identifier called “context.smart_id” that can be reused later to find the very same entity and follow its lifecycle through the different steps and actions.

– To see which actions were executed:

venture:jumia AND country:eg AND context.smart_id:4009824056 AND message:”Action executed”