This reference provides a complete listing of every condition, comparison operator, and action available in the OptimiDoc Rules Engine. Each entry includes a description and, where relevant, the rule contexts in which it can be used.
Screenshot: Rule editor — Conditions tab
Screenshot: Rule editor — Actions tab
Conditions Reference
Conditions determine whether a rule fires. When a rule has more than one condition, all of them must be satisfied (logical AND) for the rule's actions to execute. The fields offered on a given tab depend on the context; the table below shows every field and where it is available.
|
Condition |
Description |
Available In |
|---|---|---|
|
Login (Username) |
Matches the user's login name. Use Is / Is Not for an exact match, or Contains, Starts With, and Matches (Regex) for pattern matching. |
Login, Accept Job, Before Print, Release Job |
|
User's Group |
Matches users who belong to one or more selected groups. |
Login, Accept Job, Before Print, Release Job |
|
User |
Matches one or more specific user identities. |
Login, Accept Job, Before Print, Release Job |
|
Department |
Matches users assigned to a selected department. |
Login, Accept Job, Before Print, Release Job |
|
Device |
Matches a specific device or set of devices where the operation is taking place. |
Login, Before Print, Release Job |
|
Device tags |
Matches when the device where the operation takes place carries any of the selected tags. Choose one or more device tags with the entity picker, and use Is / Is Not as with other entity conditions. |
Login, Before Print, Release Job |
|
Job Title |
Matches the document or job name. Supports Contains, Starts With, and Matches (Regex). |
Accept Job, Before Print |
|
Queue |
Matches the print queue to which the job was submitted. |
Accept Job |
|
Date |
Matches a calendar date. Combine with Greater Than / Less Than to match jobs before or after a given date. There is no time-of-day matching. |
Accept Job |
|
Number of Pages |
Matches the page count of the job, optionally filtered by paper format (All, A4, A3, Letter, Legal) and colour mode (All, Colour, Black & White). |
Release Job |
|
Job Type |
Matches the type of operation — Copy, Print, or Scan. |
Release Job |
|
Current Consumption |
Matches the user's accumulated usage for the selected consumption property (Total, Print, Copy or Scan), compared with <, > or =. |
Login, Before Print, Release Job |
|
Job Consumption Estimate |
Matches the estimated cost or consumption of the job about to be printed. |
Before Print |
The Device tags condition is available from the release following 26.07. In 26.07 and earlier the rule editor did not offer it, so grouping devices relied on individual Device conditions.
Comparison Operators
Each condition uses one comparison operator. The editor automatically offers only the operators that make sense for the selected field's type, so you cannot build an invalid comparison.
|
Operator |
Typical Field Types |
Meaning |
|---|---|---|
|
Is |
Text, entities, enumerations |
Matches the value exactly. |
|
Is Not |
Text, entities, enumerations |
Matches anything except the value. |
|
Contains |
Text |
The value appears anywhere in the field. |
|
Starts With |
Text |
The field begins with the value. |
|
Matches (Regex) |
Text |
The field matches a regular expression. |
|
Greater Than |
Numeric (pages, consumption, estimate), date |
The field is greater than the value. |
|
Less Than |
Numeric, date |
The field is less than the value. |
|
Equal |
Numeric |
The field equals the value. |
Actions Reference
Actions define what happens when all conditions in a rule are satisfied. Each action is only available in specific contexts. Because evaluation is cumulative, several rules can contribute actions to the same job.
|
Action |
Description |
Available In |
|---|---|---|
|
Force Black & White |
Converts the print job to monochrome output, overriding the user's colour selection. |
Before Print |
|
Force Duplex |
Forces double-sided (long-edge) printing, overriding the user's simplex selection. |
Before Print |
|
Add Watermark |
Overlays configured watermark text across each page. Applies to PostScript jobs only. |
Before Print |
|
Reject Operation |
Blocks the current operation and displays an error message to the user. Flags the job for rejection but does not stop the remaining rules from being evaluated. |
Login, Accept Job, Before Print, Release Job |
|
Redirect to User |
Redirects the job to a different user's secure print queue. The original owner loses access to the job. |
Accept Job |
|
Redirect to Device |
Sends the job to a different printer than originally intended. Useful for load balancing or routing around a broken device. |
Before Print |
|
Save Job Preview |
Generates and stores a preview image of the job for auditing or review. |
Before Print |
|
Print All Jobs |
Automatically releases and prints all pending jobs in the user's secure print queue on login. |
Login |
|
Send Email Notification |
Sends a notification e-mail to the job owner, with a subject and message body you specify. |
Login, Accept Job, Before Print, Release Job |
|
Send Email To |
Sends an e-mail to a specified recipient address. Useful for alerting administrators or cost-centre managers. |
Login, Accept Job, Before Print, Release Job |
|
Run Script |
Executes a script or programme on the server, with the arguments you specify. |
Login, Accept Job, Before Print, Release Job |
All e-mail actions are delivered through the global mail server configured under Mail Configuration.
Practical Examples
Force Black and White for a Specific Group
|
Setting |
Value |
|---|---|
|
Context |
Before Print |
|
Condition |
User's Group Is "Interns" |
|
Action |
Force Black & White |
Reject Very Large Jobs at Release
|
Setting |
Value |
|---|---|
|
Context |
Release Job |
|
Condition |
Number of Pages Greater Than 200 |
|
Action |
Reject Operation |
Auto-Print All Jobs on Login
|
Setting |
Value |
|---|---|
|
Context |
Login |
|
Condition |
User's Group Is "SmallOffice" |
|
Action |
Print All Jobs |
Add Watermark to Confidential Documents
|
Setting |
Value |
|---|---|
|
Context |
Before Print |
|
Condition |
Job Title Contains "confidential" |
|
Action |
Add Watermark "CONFIDENTIAL" |
Alert a Manager When Consumption Exceeds a Threshold
|
Setting |
Value |
|---|---|
|
Context |
Release Job |
|
Condition |
Current Consumption Greater Than 1000 |
|
Action |
Send Email To "billing@example.com" |
Redirect Jobs from a Broken Printer
|
Setting |
Value |
|---|---|
|
Context |
Before Print |
|
Condition |
Device Is "Printer-Floor3-East" |
|
Action |
Redirect to Device "Printer-Floor3-West" |
Related articles