Using the Rule Definition wizard

About

images/download/attachments/21955230/info_icon.jpg

The Rule Definition wizard is used for creating RBE rules.

You use the wizard to specify triggers (when rule is executed), conditions (validating whether action is made), actions (what to be done) and notifications (who and how should be informed about execution of rule). Please see available items in Rule-based Engine: rule definition.

 

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/warning.svg This page describes the Rule Definition wizard in the YSoft SafeQ 5.0 Web Interface. Information and screen descriptions may vary depending on your YSoft SafeQ configuration and/or license.

At a Glance

 

Displaying and using the Rules list

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg  In the YSoft SafeQ Web Interface, select Rules > Rules.

On this page, you can manage print job rules and access the Rules Definition wizard.

  images/download/attachments/21955614/rule_based_lis.png


The Rules page includes the following information

  • Name – Name of the rule

  • Conditions – Conditions print jobs must meet in order for YSoft SafeQ to apply the rule

  • Action – Action that will be applied if conditions are met


Icons in the Rules list:

  • images/download/attachments/21955614/drag_and_drop_rule.png  - Drag and move the rule in the list. Multiple rules can apply to the same print job. 

  •  images/download/attachments/21955614/enabled_rule.png - Enable the rule.

  •  images/download/attachments/21955614/disabled_rule.png  - Disable / deactivate the rule.

  • images/download/attachments/21955614/delete_rule.png  - Delete the rule.

 

Rule Definition wizard panel

 

Wizard dialog is divided to the two basic panels:

 

  • Panel (1) lists available Conditions, Actions and Notifications that can be used to create new rule.

    • You can use links in header (3) or buttons in toolbar (4) to switch between available Conditions, Actions or Notifications.

 

  • Panel (2) describes your rule.

 

To create new rule, first enter name of the rule, then click on Conditions, Actions or Notification to add them to Rule panel. Trigger option limits which Actions, Conditions and Notifications can be added to the rule because they need specific triggers to work. When you have finished defining your rule, click on Save button (5) to save rule.

 

images/download/attachments/21955615/rbe1.png

 

 

Add condition, action or notification

Click on Conditions, Actions or Notification name in first panel to add it to your rule. Some items can be added to rule multiple times (it remains in left panel when added to rule), some of them only once (it is removed from left panel when added to rule).

If item is grayed (6) out, it means that specific item (Condition, Action or Notification) is not available for currently selected Trigger (7) or could not work with some of the selected Conditions, Actions or Notification.


In order to perform Actions, ALL defined conditions must be met.

images/download/attachments/21955615/rbe2.png

 

 

Set Conditions, Actions or Notification attributes that accepts multiple values

Some attributes accepts multiple values. These attributes are displayed in purple color (4). You can add another value by clicking on purple text. List with all values is displayed in popup dialog and you can add another item by clicking on the Add link (2) or remove one of the items by clicking on it (8).

All values in multiple attribute are linked with OR logical conjunction. This means that one of the values must apply to Condition to be evaluated as successful.

 

Remove condition/action

To remove Conditions, Actions or Notification from rule, hover your mouse about unwanted item. Cross icon (1) will be displayed on the left side of the item. Click on this icon to remove item from rule.

 

 

For example of Rule Definition wizard usage, please see Example of Rule Definition Wizard usage.

For definition of specific conditions, please see Rule-based Engine: rule definition.

 

 

Creating a printing rule

To create a new rule, click images/download/attachments/21955614/createnewautoreport.png .
The Rule Definition wizard opens.

 

Fill in unique name of rule.

Define trigger - when rule will be executed. For list of triggers and their options, please see Rule-based Engine: rule definition.

 

 

Setting conditions for the rule

On the Rule Definition wizard Conditions tab, specify the conditions print jobs must meet in order for YSoft SafeQ to apply the rule.

In the Job Conditions list, click a condition to select it.

The condition appears on right side of wizard and might need additional information to be defined.

 

images/download/attachments/21955614/RBE_Conditions_-_new.png

 

 

 

For definition of specific conditions, please see Rule-based Engine: rule definition.

Setting actions of the rule

On the Rule Definition wizard Actions tab, specify the actions the rule will do if defined conditions are met.
 

images/download/attachments/21955614/RBE_Actions_-_new.png

 

For more detailed information about actions, see Rule-based Engine: rule definition. 

Setting notification options for the rule

On the Rule Definition wizard Notifications tab:

If you want YSoft SafeQ to send a notification after it modifies a print job because of a rule, specify the type of notification.

If you do not want YSoft SafeQ to send notifications, do not do anything on this tab.

images/download/attachments/21955614/RBE_Notifications_-_new.png

 

For more detailed information about actions, see Rule-based Engine: rule definition. 

 

Click Save to save the rule and add it to the Rules list.