Rule definition overview

Glossary

Term

Definition

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.

Triggers

Trigger

Description

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg 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 YSoft SafeQ Client notifications can only be triggered by this trigger.

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg Before job is released to the printer

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

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg On job's delivery to the printer

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

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg On user's login at terminal

When user authenticates at a YSoft SafeQ terminal.

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg On user's logout at terminal

When user logout at a YSoft SafeQ terminal.

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

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg On job status change

When status of user print job has changed.

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

Conditions

Job Conditions

Supported triggers

Notes

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg Job belongs to <user>

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg Job owner's username <is / is not / contains / does not contain / matches / does not match / starts with / ends with> <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


images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg Job belongs to user from <cost center>

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg Job owner's cost center number <equal to / not equal to / greater than / lesser than / greater or equal to / lesser 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 logout at terminal

  • On job status change


images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg Job is printed on <device>

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg Job is printed on device whose name <is / is not / contains / does not contain / matches / does not match / starts with / ends with> <text>

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


images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg 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.

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg 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.

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg Job title <is / is not / contains / does not contain / matches / does not match / starts with / ends with> <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.

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg Job has been sent to named queue <is / is not / contains / does not contain / matches / does not match / starts with / ends with> <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.

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg 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


images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg 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.

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg 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.

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg 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


images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg 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.

Job page conditions

Supported triggers

Notes

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg 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.

User status conditions

Supported triggers

Notes

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg 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 requires the following property to be enabled: displayPrintedPagesPricesOnTerminal

Per year/month in this condition means pages in a current calendar year or current month. E.g. from 1. January until today in case of the year condition or from 1. August until today in case it's August and month condition is selected.

The condition works with the statistical data:

  • the statistics get recalculated once in a hour by Management Server

  • the recalculated statistics get propagated from Management to SPOC once per hour (controlled by a system parameter refreshPrintedPagesInterval in the System Settings)

The amount of pages is not refreshed instantly, therefore the condition is suitable for a soft notification. But to limit user from printing beyond a specific limit, a Quota system needs to be used.

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg 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


images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg User authenticates at device group <group>

Triggers:

  • On user's login at terminal

Applicable to device groups and subgroups; if group selected, will be applied to all subgroups as well.

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg User authenticates at Spooler Controller group <group>

Triggers:

  • On user's login at terminal

Applicable to Spooler Controller groups; will be aplied to all belonging SPOCs.

Rules with this condition that were created prior to updating to build 66 or higher need to be recreated, the old ones will not work as expected.

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg User is not a member of the role <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

Rules with this condition that were created before release 6.0.69 need to be recreated, the old ones will not work as expected.

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg User is a member of the role <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

Time conditions

Supported triggers

Notes

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg 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


images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg 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


Actions

Transform Job Operations

Supported Triggers

Notes

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg 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

The watermark will be always in a predefined position. Printing in landscape mode will not change the watermark's position or rotation.

Watermarking feature is available for PCL and PostScript jobs only.

Only ISO Latin-1 and Latin-2 character sets are supported.

Variables can be used, see below for their definition.

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg Find <text> in PJL header and replace it with <text> (<Append/Do not append> the text when searched text is not found)

Triggers:

  • On job's delivery to the printer

When a match is found, whole line is replaced. Be sure to specify the pattern and the new value in the following format: "@PJL SET <HEADER>=<VALUE>"

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg <Convert / Do not convert> job to gray scale

Triggers:

  • On job's delivery to the printer


images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg <Convert / Do not convert> job to duplex

Triggers:

  • On job's delivery to the printer


images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg <Convert / Do not convert> job to simplex

Triggers:

  • On job's delivery to the printer


images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg Print job <number> times

Triggers:

  • On job's delivery to the printer


images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg 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.

Change processing workflow

Supported triggers

Notes

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg Re-queue the job to <queue>

Triggers:

  • On reception of job by YSoft SafeQ server

A direct queue can be selected from a list of existing direct queues.

Alternatively, a direct or shared queue name can be typed manually. In that case, variables can be used in the queue name (see below).

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg Redirect the job to the secure queue

Triggers:

  • On reception of job by YSoft SafeQ server

Used for redirecting the job from a direct (or shared) queue to the secure queue, so that it is held by the server and not printed immediately.

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg Reject print job

Triggers:

  • Before job is released to the printer


images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg Delete print job

Triggers:

  • On reception of job by YSoft SafeQ server


images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg Deny authentication on terminal

Triggers:

  • On user's login at terminal

User authentication is denied (after successful authentication).

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg Change job title to <text>

Triggers:

  • On reception of job by YSoft SafeQ server

Variables may be used in the text (see below).

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg Change job owner to <user>

Triggers:

  • On reception of job by YSoft SafeQ server


images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg Change job billing code to <billing code>

Triggers:

  • On reception of job by YSoft SafeQ server


images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg Set job as <favorite / not favorite>

Triggers:

  • On reception of job by YSoft SafeQ server


Notifications

General Notification Information

Supported triggers

Notes

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg Send e-mail with <subject> and content of <text> to job owner

Triggers:

  • all

Variables can be used, see below for their definition.

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg Send e-mail with <subject> and content of <text> to <user>

Triggers:

  • all

Variables can be used, see below for their definition.

images/s/-t6brkm/8803/3fowtp/_/images/icons/emoticons/check.svg Run external <script>

Triggers:

  • all

Executes any application, optionally passing some information as parameters.

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.

Variables

Some variables are not available for some triggers.

Variable

Description

[DEVICE_ID]

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

[DEVICE_IP]

IP Address of the device

[DEVICE_NAME]

Device Name as configured in YSoft SafeQ Management Service

[DEVICE_DESCRIPTION]

Device Description as configured in YSoft SafeQ Management Service

[DEVICE_LOCATION]

Device Location as configured in YSoft SafeQ Management Service

[DEVICE_EQUIPMENT_ID]

Device Equipment ID as configured in YSoft SafeQ Management Service

[DEVICE_SERVICE_AGREEMENT_ID]

Device Service Agreement ID as configured in YSoft SafeQ Management Service

[DEVICE_CONTACT_PERSON]

Device Contact Person as configured in YSoft SafeQ Management Service

[DEVICE_ZIP_CODE]

Device ZIP Code as configured in YSoft SafeQ Management Service

[DEVICE_BACKEND]

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

[DEVICE_SPOC_GUID]

GUID of the Spooler Controller managing the device

[DEVICE_SPOC_NAME]

Name of the Spooler Controller managing the device

[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_HOME_DIR]

User's home directory from the Identity Database

[USER_NOTE]

User's note from the Identity Database

[USER_OU_NUM]

User's cost center number from the Identity Database

[USER_ID]

Internal YSoft SafeQ Management Service unique ID of the user from the Identity Database

[JOB_ID]

Internal YSoft SafeQ Management Service job unique ID (not available during job reception)

[JOB_GUID]

Internal YSoft SafeQ Management Service job GUID (part of the filename in the JobStore folder in the spooler)

[JOB_TITLE]

Job Title

[JOB_SIZE]

Size of the print job (formatted for readability)

[JOB_SIZE_RAW]

Size of the print job (plain number in bytes for machine readability)

[JOB_PROJECT_ID]

Internal ID in YSoft SafeQ Management Service of the billing code selected for the job

[JOB_QUEUE]

Target print queue name

[JOB_STATUS]

Current job status

[JOB_STATUS_NUM]

Current job status as a numeric identifier

[JOB_NOTE]

Internal note generated by system

[JOB_ORIGIN]

IP address or hostname from where the job was received

[JOB_SPOOLER_HOSTNAME]

Hostname of the spooler that received the job

[JOB_SPOOLER_GUID]

GUID of the spooler that received the job

[JOB_SPOC_GUID]

GUID of the Spooler Controller that received the metadata of the job

[JOB_PAGES_BW]

Number of black and white pages in the job

[JOB_PAGES_COL]

Number of color pages in the job

[JOB_PAGES_BW_LARGE]

Number of large-format black and white pages in the job

[JOB_PAGES_COL_LARGE]

Number of large-format color pages in the job

[JOB_PAGES_LARGE]

Number of large-format pages in the job

[OP_DATE]

Current date and time

[DATE]

Current date

[TIME]

Current time

The Send e-mail notification sends message in plain text. Microsoft Outlook by default removes line breaks in plain text e-mails. If this issue occurs in your environment, disable the Remove extra line breaks in plain text message options in Microsoft Outlook:

images/download/attachments/21955689/Outlook.png