Rule

Set of associated triggers, conditions, actions and notifications

Trigger

Defines action that triggers the execution of rule - when the conditions are evaluated.

Condition

Is reviewed when rule is triggered. Evaluates whether action should be performed. When more conditions are defined for specific rule, all of them must be met in order for rule to do action.

Action

Action is something the system does, typically with a print job. Happens when rule is triggered and conditions are met.

Notification

Information to end user, manager, administrator or external system about successful execution of rule - it was triggered and conditions were met.

On reception of job by YSoft SafeQ server

Print Job Reception from user workstation or print server.
This is where you can affect how the job will be processed by the system, e.g., redirect the job to a different queue.

The SafeQ Client Notifications can only be triggered by this trigger.

Before job is released to the printer

Before print job is released to a device managed by SafeQ.
This is where you can reject the job.

On job's delivery to the printer

Print job delivery to a device managed by SafeQ
This is where you can apply changes to the job, such as conversion to black&white.

On user's login at terminal

When user authenticates at a SafeQ Terminal.

On user's logout at terminal

When user logout at a SafeQ Terminal

Rule containing this trigger cannot have any actions, only notifications.

On job status change

When status of user print job has changed

Rule containing this trigger cannot have any actions, only notifications.

Job belongs to <user>

Triggers:

• On reception of job by YSoft SafeQ server

• Before job is released to the printer

• On job's delivery to the printer

• On user's logout at terminal

• On job status change

Job belongs to user with <role>

Triggers:

• On reception of job by YSoft SafeQ server

• Before job is released to the printer

• On job's delivery to the printer

• On user's login at terminal

• On user's logout at terminal

• On job status change

Job belongs to user from <cost center>

Triggers:

• On reception of job by YSoft SafeQ server

• Before job is released to the printer

• On job's delivery to the printer

• On user's logout at terminal

• On job status change

Job is printed on <device>

Triggers:

• Before job is released to the printer

• On job's delivery to the printer

• On user's login at terminal

• On user's logout at terminal

• On job status change

Job is printed on printer with type

Triggers:

• Before job is released to the printer

• On job's delivery to the printer

• On user's logout at terminal

• On job status change

At least one type needs to be specified (Devices > Tools > Printer types), otherwise this condition is disabled.

Job is printed on device from <group / ORS>

Triggers:

• Before job is released to the printer

• On job's delivery to the printer

• On user's login at terminal

• On user's logout at terminal

• On job status change

At least one group must be specified (Devices -> Items -> Add new group), otherwise this condition is disabled.

Job title <contains / matches> <text>

Triggers:

• On reception of job by YSoft SafeQ server

• Before job is released to the printer

• On job's delivery to the printer

• On user's logout at terminal

• On job status change

Text can be in the form of a regular expression to detect various patterns. See Regular Expressions for pattern building information.

Job has been sent to named queue <contains / matches> <queue_name>

Triggers:

• On reception of job by YSoft SafeQ server

• Before job is released to the printer

• On job's delivery to the printer

• On user's logout at terminal

• On job status change

Text can be in the form of a regular expression to detect various patterns. See Regular Expressions for pattern building information.

Job has been sent to queue type <direct / secured / shared>

Triggers:

• On reception of job by YSoft SafeQ server

• Before job is released to the printer

• On job's delivery to the printer

• On user's logout at terminal

• On job status change

Job <has / has not> set a <system tag>

Triggers:

• On reception of job by YSoft SafeQ server

• Before job is released to the printer

• On job's delivery to the printer

• On user's logout at terminal

• On job status change

Setting a system tag (using the "Mark job with tag" action) in one rule doesn't affect other rules because all conditions are evaluated at the beginning.

Job <has / has not> set a <user tag>

Triggers:

• On reception of job by YSoft SafeQ server

• Before job is released to the printer

• On job's delivery to the printer

• On user's logout at terminal

• On job status change

Setting a user tag (using the "Mark job with tag" action) in one rule doesn't affect other rules because all conditions are evaluated at the beginning.

Job file size <equal to / not equal to / greater than / lesser than / greater or equal to / lesser than or equal to> <number> <B / KB / MB / GB / TB>

Triggers:

• On reception of job by YSoft SafeQ server

• Before job is released to the printer

• On job's delivery to the printer

• On user's logout at terminal

• On job status change

Job has <status>

Triggers:

• On reception of job by YSoft SafeQ server

• Before job is released to the printer

• On job's delivery to the printer

• On user's logout at terminal

• On job status change

Only notification can be executed on this condition.

If Job contains <more than, equal to, less than, between> <x> [<all,b/w,color>] pages [with paper size <large, small>]

The rule requires enabled job parser.

Total amount of <all pages per month / BW pages per year / etc.> by job owner is <equal to / not equal to / greater than / less than / greater or equal to / less than or equal to> <number>.

Triggers:

• On reception of job by YSoft SafeQ server

• Before job is released to the printer

• On job's delivery to the printer

• On user's login at terminal

• On user's logout at terminal

• On job status change

This rule is not applied before first statistics are processed (processing of statistics is run approximately every hour)

This rule requires the following property to be enabled: displayPrintedPagesPricesOnTerminal

Outcome of authentication on terminal <equal to / not equal to> success

Triggers:

• On reception of job by YSoft SafeQ server

• Before job is released to the printer

• On job's delivery to the printer

• On user's login at terminal

• On user's logout at terminal

• On job status change

Current <day of week / day of month> is <equal to / not equal to / greater than / lesser than / greater or equal to / lesser than or equal to> <day in week / day in month>

Triggers:

• On reception of job by YSoft SafeQ server

• Before job is released to the printer

• On job's delivery to the printer

• On user's login at terminal

• On user's logout at terminal

• On job status change

Current time is <equal to / not equal to / greater than / lesser than / greater or equal to / lesser than or equal to> <time>

Triggers:

• On reception of job by YSoft SafeQ server

• Before job is released to the printer

• On job's delivery to the printer

• On user's login at terminal

• On user's logout at terminal

• On job status change

Add watermark <text> to each page. Add it to <position> of the page, rotate it by <number>° and use font with <size> and <color>

Triggers:

• On job's delivery to the printer

Watermarking feature is available for PCL and PostScript jobs only.

Only ISO Latin-1 and Latin-2 character set is supported.

Variables can be used, see below for their definition.

Find <text> in PJL header and replace with <text> (or append when searched text is not found)

Triggers:

• On job's delivery to the printer

Replaces text in PJL header with given text. If not found, it is added instead.

<Convert / Do not convert> job to grayscale

Triggers:

• On job's delivery to the printer

<Convert / Do not convert> job to duplex

Triggers:

• On job's delivery to the printer

<Convert / Do not convert> job to simplex

Triggers:

• On job's delivery to the printer

Print job <number> times

Triggers:

• On job's delivery to the printer

Mark job with <tag>

Triggers:

• On reception of job by YSoft SafeQ server

This action will not affect the evaluation of tag conditions in subsequent rules because all conditions are evaluated before any rules are executed.

Re-queue the job to <queue>

Triggers:

• On reception of job by YSoft SafeQ server

Valid for direct queue only.

Reject print job

Triggers:

• Before job is released to the printer

Delete print job

Triggers:

• On reception of job by YSoft SafeQ server

Deny authentication on terminal

Triggers:

• On user's login at terminal

User authentication is denied (after successful authentication).

Queue the job to user's VIP Shared queue

Triggers:

• On reception of job by YSoft SafeQ server

Valid only for users with existing VIP shared queues.

Send e-mail with <subject> and content of <text> to job owner

Triggers:

• all

Variables can be used, see below for their definition.

Send e-mail with <subject> and content of <text> to <user>

Triggers:

• all

Variables can be used, see below for their definition.

Run external <script>

Triggers:

• all

Executes any application, optionally passing some information as parameters. See Using the Rule Definition wizard for more details.

Example of input: C:\script.bat [USER_EMAIL] [JOB_STATUS] (This will execute a script.bat located on a C drive with 2 parameters).

Variables can be used, see below for their definition.

Send YSoft SafeQ Client notification to job owner

Triggers:

• On reception of job by YSoft SafeQ server

Requires job to be submitted by YSoft SafeQ Client

Shows popup to user

Notification is defined in HTML, therefore hyperlinks can be used.

Variables can be used, see below for their definition.

Please see Rule based engine Client notification - setup and usage for more details.

[DEVICE_ID]

Internal SafeQ unique ID of the involved device (printer, mfp)

[DEVICE_IP]

IP Address of the device

[DEVICE_NAME]

Device Name as configured in SafeQ

[DEVICE_BACKEND]

Data Delivery Method as configured in SafeQ (e.g., TCP/IP Raw, LPR, IPP)

[USER]

Owner of the job in the format "Name Surname (login)"

[USER_NAME]

User's first name from the Identity Database

[USER_SURNAME]

User's surname from the Identity Database

[USER_LOGIN]

User's login from the Identity Database

[USER_EMAIL]

User's email address from the Identity Database

[USER_ID]

Internal SafeQ unique ID of the user from the Identity Database

[JOB_ID]

Internal SafeQ job unique ID

[JOB_TITLE]

Job Title

[JOB_SIZE]

Size of the print job

[JOB_QUEUE]

Target print queue name

[JOB_STATUS]

Current job status

[JOB_NOTE]

Internal note generated by system

[JOB_FILENAME]

Subdirectory and filename where the job is spooled

[DATE]

Current date

[TIME]

Current time