ShipRush
ShipRush Dashboard
Submit an Idea

Managing Automation Rules

Automation Rule Example

Below is an example of the Edit Automation Rule dialog, which is used to create an Automation Rule (or "rule"). The details for each field, checkbox, and other options are provided throughout this topic.


Creating an Automation Rule

Creating an Automation Rule can include the following:

  • Assign an Automation Rule Name and folder in which to store the Automation Rule

  • Enable or disable the Automation Rule

  • Identify the Automation Rule as a Favorite

  • Add Filters to restrict the application of the Automation Rule based on specific criteria

  • Add the Actions to be executed, if they match the Filter criteria


Tip: All enabled Automation Rules can be run using a single set of commands. See Running All Enabled Automation Rules.


To create an Automation Rule:

  1. Display the Settings - Automation Rules page (SETTINGS > ACCOUNT SETTINGS > Automation Rules).


  2. Click Add Automation Rule. The Edit Automation Rule dialog is displayed.


  3. Enter an Automation Rule Name.

  4. If needed, select a Folder in which to store the new Automation Rule. The Folder dropdown is available if Automation Rule folders have been created. Click here for instructions on creating folders for Automation Rules.

  5. To enable this Automation Rule once saved, select Rule Enabled.

  6. To identify this Automation Rule as a Favorite:

    • Select Favorite.

    • To assign an abbreviated name to this Favorite Automation Rule, enter a Shortcut name (up to three characters).

    • Select a color to categorize this Favorite Automation Rule.

    • On the Ready to Ship page, your Favorite Automation Rules are listed in a graphic with their shortcut text and color-codes (see example, below). To activate one of these Automation Rules, select one or more Orders/Shipments, and then click the Automation Rule in the graphic.


  7. Click Add New Filter. Select an option from one of these categories: Shipment, Package, Order, OrderItem, or Other. One or more fields may be displayed. A Filter restricts the application of the Automation Rule. Only the Actions in the Automation Rule that match your Filter criteria will be executed for the selected Orders/Shipments. Actions are explained further in this procedure.

  8. Select a qualifier for the Filter, such as "equals" or "not equal". Enter the applicable text (see the example, below). The text field is not available for the is empty qualifier.


  9. If the Automation Rule has multiple Filters, a fourth field may be displayed, depending on the selected Filter. In the example below, All is selected for this field. Select an option. All indicates that every Filter must apply in order for the specified Actions to be executed. Any indicates that only one or more of the Filters must apply in order for the specified Actions to be executed. Any 2 or Any 3 indicates that any two or three of the Filters must apply in order for the specified Actions to be executed.


  10. If needed, add additional Filters. See Automation Rules - Filters for more information on Filters.

  11. Click Add New Action, and then select an Action. There are five Action categories: Shipment, Package, International, Commodity, and Other. Depending on your selection, additional fields may be displayed for selecting a qualifier and/or entering matching text for the Action.



    Please note:

    • The Actions will be executed if they may match the Filter criteria. See Automation Rules - Actions for more information on Actions.

    • The Action "Set Shipping Account" (in the Shipping category) could be used when you get a new Shipping account and need to adjust multiple Automation Rules in order to use the Shipping account. For example, you have Set Account and Rate Shop Actions that reference account 123456. After a period, your shipping carrier changes your account number to 654321. Use Action "Set Shipping Account" to update all Automation Rules in one pass.

  12. As needed, add additional Actions. In an Automation Rule, multiple Actions are numbered and executed in the order listed (see graphic, below). The order sequence of the Automation Rules is important. For example, Shipping Service, Shipment Weight, and other aspects must be known or set before a Ship action can function properly. As needed, use the up/down arrow buttons (at left) to move the Action up or down in the list.


  13. Click Save. The Automation Rule is listed on the Settings - Automation Rules page.

Tip: To display a description of the Automation Rule, position the cursor on the information icon.


Creating a Master Automation Rule

To create a Master Automation Rule:

  1. Display the Settings - Automation Rules page (SETTINGS > ACCOUNT SETTINGS > Automation Rules).

  2. Click Add Automation Rule. The Edit Automation Rule dialog is displayed.


  3. Enter a Rule Name.

  4. Rule Enabled is selected by default. It is recommended that you de-select Rule Enabled.

  5. If you select Favorite, enter its Shortcut name, and then select a color to help identify this Favorite. See Adding an Automation Rule for details on those fields and options.

  6. Click Add New Action. On the dropdown, in the Other category, select Run Business Rule. An empty dropdown field is displayed:


  7. The empty dropdown contains the list of existing Automation Rules. Select the first Automation Rule to be run.

  8. Click Add New Action, select Run Business Rule, and then select the next rule to be run.

  9. Repeat the previous step until all needed Automation Rules have been added to the Master Automation Rule.

  10. The Actions are executed in the order listed. To move an Action up or down in the list, click the up or down arrow button (at left).


  11. Click Save.

Warning: As a best practice, Descartes recommends that you de-select Rule Enabled for a Master Automation Rule. This ensures that the Master Automation Rule is not run accidently when you use the Run All Enabled Rules option.

Note: A Master Automation Rule holds multiple Automation Rules. They will be listed under Actions in the Master Automation Rule and executed in the order listed. Also, Master Automation Rules can be set for Lights Out Automation.


Disabling, Enabling, Editing, Cloning and Deleting Automation Rules

To disable, enable, edit, clone, or delete an Automation Rule:

  1. Display the Settings - Automation Rules page (SETTINGS > ACCOUNT SETTINGS > Automation Rules).


  2. These options are available:

    • Disable/Enable: To disable or enable the Automation Rule, click disable or enable.

    • Edit: To edit the Automation Rule, click Edit. The fields and options for editing Automation Rules are covered in Adding an Automation Rule.

    • Delete: To delete the Automation Rule, click Delete.

    • Clone: To clone the Automation Rule, click Clone. The Automation Rule dialog is displayed. As needed, edit the fields. Click Save. The cloned Automation Rule is listed on the Settings - Automation Rules page and is marked cloned (see the example, below).


Tip: Using a single set of commands, multiple Automation Rules can be disabled, enabled, edited (in certain ways), cloned, or deleted. See Editing Multiple Automation Rules for details.


Managing Multiple Automation Rules Simultaneously

Multiple Automation Rules can be managed in several ways using a single set of commands. Options include:

  • Set Shipping Account

  • Replace Shipping Account

  • Create a Master Automation Rule

  • Move to a folder

  • Enable or disable

  • Delete

Do the following:

  1. Display the Settings - Automation Rules page (SETTINGS > ACCOUNT SETTINGS > Automation Rules).


  2. Select the checkbox for each Automation Rule that you want to manage. To select all Automation Rules, select the top checkbox.

  3. Click Edit Selected. The Bulk Edit Automation Rules dialog is displayed, listing the selected Automation Rules.


  4. Select an option in the Edit Action dropdown:

    • Set Shipping Account: Select a Shipping Account in the dropdown

    • Replace Shipping Account: Select a Shipping Account in the From and To dropdowns

    • Create "Master" Automation Rule: Create a Master Automation Rule with the Automation Rules listed in the dialog

    • Move to Folder: Select a folder for storing the selected Automation Rules. To add a folder for storing Automation Rules: 1) Go to Shipments > Ready to Ship. 2) On the Rules dropdown (top of screen), click the Add Automation Rule folder icon. 3) Enter the folder name, and then click Save.

    • Enable: Enables the selected Automation Rules

    • Disable: Disables the selected Automation Rules

    • Delete: Deletes the selected Automation Rules

  5. Click Continue. The Confirm Bulk Edit dialog is displayed.

  6. To accept your bulk edit, click Continue. The Settings - Automation Rules page is displayed, completing the process. If you created a new Master Automation Rule using this procedure, it is now listed on the Settings - Automation Rules page.


Warning: The bulk edit of Automation Rules cannot be undone.


Exporting Automation Rules

The Export Automation Rules function lists the details of the Automation Rules on a browser page.

Tip: You can share the URL in the browser's address or set the page as a Favorite in your browser.

To Export Automation Rules:

  1. Display the Settings - Automation Rules page (SETTINGS > ACCOUNT SETTINGS > Automation Rules).


  2. Click Export Automation Rules. The details of the Automation Rules are displayed on the browser page. For example:


  3. As needed, share the URL in the browser's address field or set the page as a Favorite in your browser.

  4. Click the browser's Back button to return to Descartes ShipRush Web.

Back to Top