Version 5.9
In this Topic Show
The Approval Rules system is used to automate the order review and approval process. Approval rules can be applied to orders as they are imported from a shopping cart . As order volume increases, it becomes more time consuming to review each order to determine if it can be shipped immediately or not. By creating approval rules, the Order Manager can apply these rules at the time of order import and automatically approve, un-approve, or cancel orders. The system can also change shipping methods or apply an order state such as "on hold".
The form consists of three sections, If, Then and Action for Group. The If section has four sub-sections, Test Fields, Test Comparison Expressions, Value or comma delimited list, and Require. The first two sub-sections are not labeled in the actual form but are shown here in red text for instructional purposes. Refer to Figure1, below.
The list box labeled Test Fields shows the fields whose contents can be interrogated for specific values as defined in the remaining selections of the If... section of the form.
The Test Comparison Expressions box contains a list of expressions that can be used to conduct the comparison or "testing" of the data in the selected field. The possibilities are:
Includes
Equals
Doesn't Equal
Begins with
Is greater Than or Equal To
Is Less Than or Equal To
Is Between
Note: Every test field will not have all of these choices, and each comparison expression will have different choices in the Require: section.
The data that will be the object of the test should be entered in the Value or comma delimited list. Multiple values can be entered and should be separated by commas, using no spaces between the items in the list.
Choose one of the selections in the Require: sub-section of the form. The possible choices are:
Exact value entered - the data being tested must equal the value entered to return a result of True
Any of list - if the data being tested contains "ANY" of the items in the delimited list, the test will result in True. This is an implied "OR” situation. For example, if you want to use USPS to ship to destinations other than North America, you could set up a rule that says shipping country does not include “CA”, “US”, “MX” and you would specify “Any of List”, so that if the shipping country does not equal any of these entries, the rule will return a true result.
All of List - if the data being tested contains "ALL” of the items within the delimited list, the test will result in True. This is an implied "AND” situation. For example, if you wanted to approve all incoming orders that have a shipping method that contains “UPS” and “Day” (UPS Next Day, UPS 2nd Day, UPS 3 Day, etc.), you could set up a rule to say if Shipping Method Includes “UPS,Day” with All of List selected. This would only approve orders having a method containing both values in the shipping method. UPS Ground would be skipped.
Note: All of these choices are not necessarily available for all comparison expressions. Some comparisons do not have any option in the Require: sub-section.
The Then... section has four sub-sections, the first and third containing check boxes for the actions that can be taken by the program. The choices are:
Approve (sub-section 1)
Do not approve the order (sub-section 1)
Cancel the order (sub-section 1)
Set the shipping method to: (sub-section 1)
Set the order state to: (sub-section 3)
The second sub-section is only pertinent to the Set the Shipping Method to: action and the list of shipping methods will become active when that box is checked.
The fourth sub-section is only pertinent to the Set the order state to: action and the list of orders states will become active when that box is checked.
Figure 1: Add a New Rule screen
This section of the form will display the set of test values entered for a rule group. Use the [Create Rule Group] button to define a rule group after selecting an initial set of values in the If... and Then... sections.
Refer to Creating Approval Rule Groups, later in this article for more details.
Single Test Approval Rules allow the user to "test" a single field with one or more criteria, and if the criteria are met (the test is evaluated as True), perform the designated action. For example, a merchant might want to cancel any orders that require shipment outside of the US or cancel any orders with a Fraud Score that is too high.
The following example demonstrates how to set up a single-test approval rule that cancels any orders that require shipment outside of the US.
To access the Approval Rule system, go to Main Menu > Maintenance Menu icon > Setup Functions tab > and select [Approval Rules] from the list of activities.
Figure 2: Order Approval Rules screen
Click the [Add a New Rule] button. This will open the Add a New Rule screen.
Figure 3: Add a New Rule screen
Select [Destination Country] from the list of fields and conditions in the If... box.
Select [Doesn’t Equal] from the list of available comparison expressions in the middle box.
In the [Value or comma delimited list] text box, type in one or more choices for the US, such as "US," "United States," and "USA", etc. When entering more than one value, separate them by commas, no leading spaces. Enter the country code or codes as they are passed from the shopping cart or carts that are being used.
Note: When entering dollar values, do not include a dollar sign ($), likewise for weights, do not include the unit abbreviation.
Select the [Any of List] radio button to have any of the values entered constitute a match.
In the Then... list box:
check the [Cancel the Order] box, or if you prefer not to cancel, but instead want to force a manual review of the order, check the [Do not approve the Order] check box
check [Set the shipping method to:] box and select a shipping method in the list box below
check [Set the order state to:] box, and select an order state in the option list box.
Click [Save New Rule] to add the new Approval Rule.
Figure 4: Add a New screen - showing examples of comparison expressions for Test Field, Destination Country
The new rule will be displayed in the Order Approval Rules screen.
Figure 5: Order Approval Rules screen - displaying new rule
Click [Close] to exit the Add a New Rule dialog.
To delete an approval rule, click in the appropriate row under the list of Current Rules and click the [Delete] button.
To change the order in which the approval rules are applied to new orders, click on the up and down arrows to the right of the Current Rules table.
To exit the Order Approval Rules screen, click [Close].
It is possible to enter any number of Approval Rules, however, avoid using conflicting rules,such as one rule to un-approve the order and another to approve the order. When the action of an approval rule is "Do not approve the order," the Order Manager will not allow a subsequent rule to then "Approve" the order. Once an order meets the criteria to "Do not approve the order," it can only be approved manually.
Credit card transactions can only be processed automatically if an order is approved. If a credit card order does not meet the approval criteria you specify, the credit card is not charged when the order is imported.
If multiple rules are created that apply the same action based on different fields and criteria, the system assumes an implied "OR" when evaluating the list of approval rules.
For example, it is possible to have an approval rule that un-approves orders requiring shipment outside the US, another rule that un-approves order totals exceeding $500, and another rule that un-approves orders if the fraud scores are greater than or equal to a set of values. If any one of these tests are true, the order will be unapproved.
Figure 6: Order Approval Rules screen - showing the list of Current Rules for the previous example
The 5.803 Beta version of the Order Manager introduced the concept of a compound rule, which is referred to as an "approval rule group". An approval rule group allows the merchant to test multiple fields for different criteria using an implied "AND", so that the action is applied only if ALL criteria are True.
This example demonstrates how to set up an approval rule group that will cancel an order if it must be shipped outside of the US, AND the product total is greater than $500, AND the fraud score exceeds a certain value.
Go to the Main Menu > Maintenance Menu icon > Setup Functions tab > and select [Approval Rules] from the list of activities to open the Order Approval Rules screen.
Figure 7: Order Approval Rules screen before rules have been defined
Click the [Add a New Rule] button which will open the Add a New Rule screen.
Figure 8: Add a New Rule screen before a rule has been created
Select [Destination Country] from the list of fields and conditions in the If... box.
Select [Doesn’t Equal] from the list of available comparison expressions in the middle box.
In the [Value or comma delimited list] text box, type in one or more choices for the US, such as "US," "USA," "U.S.A," and "United States." When entering more than one value, separate them by commas with no spaces. Enter the country code or codes as they are passed from the shopping cart or carts that are being used.
Note: When entering dollar values, do not include a dollar sign ($), likewise, when entering weights do not include the unit abbreviation (lb, oz)
Select the [Any of List] radio button.
In the Then... list box, check the [Cancel the Order] check box.
Figure 9: Add a New Rule screen - reflecting the current example
Click [Create Rule Group]. Once this button is clicked, the criteria that was entered will appear at the bottom of the window, where Action for Group is displayed. The Create Rule Group button will no longer be visible and the Add Criteria button will become visible, allowing additional tests to added to the rule group.
IMPORTANT NOTE: Keep in mind that once a rule group is created, the Action taken by this group cannot be modified; test criteria can only be added or removed. If it is necessary to modify the action, delete the approval rule group and start over.
To add criteria to the approval rule group, select a new Field (e.g. MaxMind Fraud Score), comparative test (e.g., Is Greater Than or Equal To), and value (e.g., 5), and then click the [Add Criteria] button. Each new test added will appear at the bottom of the screen. If an incorrect test is added accidentally, select the errant entry at the bottom of the screen and click on the [Remove Rule] button.
Figure 10: Add a New Rule screen - reflecting the current example
When finished building the approval rule group, click the [Save] button to preserve the changes. Clicking the [Cancel] button will nullify any changes that have been made.
Click the [Close] button to close the Add a Rule screen and return to the Order Approval Rules screen.
Note: A Rule Group MUST have a minimum of one criteria test before the system will allow it to be saved. Also note that the name "Rule Group" appears in the first column (If this data) identifying this rule as a compound rule.
Figure 11: Order Approval Rules - showing 3 single approval rules and one rule group definition
To view the criteria entries for this approval rule group, click on the + sign to the left of Rule Group. This action will expand the criteria set assigned to the rule group.
Figure 12: Order Approval Rules screen - showing expanded Rule Group
The 5.9 version of the Order Manager introduced the ability to edit existing rules instead of having to delete a rule and then re-create it to make a change. Single-test rules can be edited directly and saved, while compound test rules (rule groups) can only be edited to the extent of removing and re-defining individual sets of criteria that are part of the group, rather than having to delete and re-define the entire rule group.
Keep in mind that an existing single-test rule cannot be converted to an approval rule group and approval rule groups cannot be converted to single-test rules, although an approval rule group can only have a single criterion.
The following example demonstrates how to edit an existing approval rule. In this example an approval rule that canceled orders with a product total of $500 or more, is changed so that it will cancel orders that have a product total $400 or more:
Go to the Main Menu > Maintenance Menu icon > Setup Functions tab > and select [Approval Rules] from the list of activities.
On the Order Approval Rules screen, select the [Product Total] rule and click [Edit Rule].
Figure 13: Order Approval Rules - Product Total rule is selected
If the approval rule is a single test rule, the criteria will automatically reload on screen. Make the necessary changes then click on the [Save New Rule] button. In the figure below, the value of the order has been changed from 500 to 400.
Figure 14: Edit a Rule screen - Product Total changed from 500 to 400
The modifications will be made to the existing approval rule.
Figure 15: Order Approval Rules screen - reflecting changes made to Product Total rule
If the approval rule is a compound rule (rule group), the criteria will be displayed at the bottom of the screen.
Figure 16: Edit a Rule screen - when a Rule Group has been selected for editing
To change the rule group's criteria, select the row of the criteria to be modified (at the bottom of the screen) and click the [Remove Rule] button.
Figure 17: Edit a Rule screen - Product Total criteria has been selected for deletion
To add the revised criteria, select the appropriate test field, comparison expression, and enter the new value. Click the [Add Criteria] button.
Figure 18: Edit a Rule screen - Product Total criteria has been deleted and will be re-added
When finished, click the [Save] button to preserve the changes. Click the [Close] button to exit the Add a New Rule screen and return to the Order Approval Rules screen.
To verify the changes that were made, click on the [+] sign next to the Rule Group to expand it and see the individual criteria tests.
Figure 19: Order Approval screen - displaying the change that was made to one of the criteria of a Rule Group
The column labeled "SPECIFICS", in Figure 19, contains rule detail data when Shipping Methods or Order States are the targets of an approval rule.
Created: 2/28/11
Go to Top