Page tree

Use the menu items in the File menu to open rule sets in Rule Builder or Rule Debugger; create, rename, and delete rule sets and groups; enable, disable, pause, and resume rule sets; import and export rule sets; and hot swap rule sets.

 

New Rule Set

Opens Rule Builder so that you can create a rule set.


Open

Opens the selected rule set in Rule Builder.
If the rule set is enabled or read-only, a dialog box appears, asking you to choose whether to open a copy of the rule set or open the rule set in read-only mode. You cannot change a rule set that is enabled or read-only.


Debug

Opens the selected rule set in Rule Debugger so that you can view the rule set's execution history and determine at which point, and why, a particular execution encountered problems.


New Group

Creates a new group, or folder, in the Rule Set Library list.

The location of the new group depends on the what is currently selected:

    • If a group is selected, the new group appears inside the selected group.
    • If no group is selected, the new group appears in the root Rule Sets group.

 

Rename

Modifies the selected rule set or group.
If a rule set is enabled, you cannot rename it.


Delete

Delete the selected rule set or group from the Rule Set Library list.


Get Info

Use to display details about the selected elements. When you select this menu item, the Get Info dialog box appears.


Enable

Makes a rule set available for execution.

If you are working with system rule sets (indicated by the word System in the window title bar):

    • You are prompted to type your user name and password. After you do, the rule set is enabled for the system, and it appears in the Enabled Rule Sets list.
    • You cannot enable rule sets that are enabled for any job.

If you are working with job rule sets (indicated by the job name in the window title bar):

    • The rule set is enabled for the job that you are in, and it appears in the Enabled Rule Sets list.
    • You can enable rule sets that are enabled for other jobs, but not rule sets that are enabled for the system.

Tip: You can select more than one rule set.

 

Resume

Resumes a paused rule set so that it listens for trigger events. This option does not appear in the menu until you select a rule set that is paused.


Disable

Disables the selected rule set, making it no longer available for execution:

    • If you are working with system rule sets (indicated by the word System in the window title bar), you are prompted to enter your user name and password. After you do, the rule set is disabled for the system.
    • If you are working with job rule sets (indicated by the job name in the window title bar), the rule set is disabled for the job that you are in.

This setting applies only to enabled rule sets. After a rule set is disabled it no longer appears in the Enabled Rule Sets list.
Tip: To disable a job rule set for multiple jobs, use Disable In instead of using Disable.


Disable in

Disables the selected job rule set, making it no longer available for execution in one or more jobs.
Opens the Disable Rule Set dialog box where you can select the jobs for which you want to disable the rule set:

    • In all jobs where it is enabled
    • In selected jobs
      If you select this option, select one or more jobs from the list of all jobs where the rule set is enabled.

Applies only to enabled job rule sets, not to system rule sets. After a rule set is disabled, it no longer appears in the Enabled Rule Sets list.


Hot Swap

Enables the rule set that is selected in the Rule Set Library list, replacing an already-enabled rule set.
Opens the Hot Swap Rule Set dialog box, where you select the enabled rule set that you want to replace.

If you are working with system rule sets (indicated by the word System in the window title bar):

    • You are prompted to type your user name and password. After you do, the rule set is enabled for the system, and it appears in the Enabled Rule Sets list.
    • You can hot swap only when the selected rule set is not already enabled for any job or for the system.

If you are working with job rule sets (indicated by the job name in the window title bar):

    • In the Hot Swap Rule Set dialog box, indicate the jobs in which you want the new rule set to replace the already-enabled rule set.
    • You can hot swap only when the selected rule set is not already enabled for the system.

Tip: You can select multiple rule sets to be hot-swapped.


Pause

Stops an enabled rule set. If the rule set is executing when you pause it, it finishes the process underway but no longer listens for trigger events.
Useful for making changes to a rule set, or hot-swapping it.
When you want the rule set to trigger again, select File > Resume.


Stop All Processing

Stops an executing rule and disables the rule set.


Import

Creates one or more rule sets from an exported .xml or .zip file.
Useful for copying rule sets between Prinergy systems.


Export

Saves one or more rule sets to a compressed export file with the .zip file extension.
Useful for copying rule sets between Prinergy systems.


Close Window

Closes the current window, but does not quit Workshop.

  • No labels