| Method | Description |
|---|---|
| Appends a comment to the job. This will be logged to the database and is available in the job logs and reports. If the job already has a comment (e.g. set by the user with the advanced client) then this will append to the existing comment. Parameters:
|
| Sets the cost of the print job. NOTE: If there are other cost adjustments configured (e.g. user cost overrides), these may further modify the job cost later in the job processing. Parameters:
|
|
Cancels the current print job so that it will not be printed. It will not log the cancelled job. To log the job use
|
|
Cancels the current print job and logs it under job logs. It can also add a comment to the job which is then available in the job logs and reports.
The script should typically exit using Parameters:
|
| Disables any client popups and account selection, and charges the job to the user's personal account. |
| Disables any client popups and account selection, and charges the job to the specified shared account. Parameters:
NOTE: The actions.job.chargeToSharedAccount action requires the double |
| Schedules the job to be redirected to the given printer queue. The job is redirected after it has completed processing (e.g. after print popups are acknowledged, filters are run, and the job is released from the hold/release queue). NOTE 1: Jobs should only be redirected between compatibles printers (e.g. those that support the same printer language and features). For more information see the section called “Requirements For Job Redirection (Load Balancing or Find Me Printing)”. NOTE 2: By default, once a job is redirected it will be printed on the destination queue. If you wish the job to be held at the destination queue, you must specify the option: allowHoldAtTarget:true. You may not run another script or use print popups at the destination queue. Parameters:
Example 1: Redirect to a printer named "server\Fast Printer".
actions.job.redirect("server\\Fast Printer");
Example 2: Redirect to a virtual queue named "server\Utility Room". The job will hold at the release station.
actions.job.redirect("server\\Utility Room",
{allowHoldAtTarget: true});
Example 3: Redirect to a virtual queue named "server\Utility Room", recalculating the cost based on the cost settings of the destination printer.
actions.job.redirect("server\\Utility Room",
{allowHoldAtTarget: true, recalculateCost: true});
NOTE 3: The actions.job.redirect() action requires the double |
| Allows this job to pass through the queue without being held in a hold/release queue. |
|
Holds this job in a hold/release queue that it was printed to. If the Parameters:
|
| Allows this job to pass through the queue without being denied by the configured print filters/restrictions. |
|
Convert this job to grayscale (if it is not already grayscale). The job's cost will be recalculated after conversion to grayscale. For more information and troubleshooting with job conversions please see the section called “Print Conversion Filters in Detail”. |
|
Convert this job to duplex (if it is not already duplex). The job's cost will be recalculated after conversion to duplex. For more information and troubleshooting please see the section called “Print Conversion Filters in Detail”. |
|
Change the number of copies in this job. E.g. change to print 4 copies instead of 1 copy. This should only be used to increase the copy count from 1, not to reduce the count or change in other ways. The job's cost will be recalculated after the number of copies has been changed. This feature may not be available for all print drivers. For more information and troubleshooting please see the section called “Print Conversion Filters in Detail”. Parameters:
Note: changing the number of copies is experimental and may not work on all devices. If you experience problems and the steps in the section called “Troubleshooting” do not assist, please contact support for assistance. |
| Changes the name of the document that will be logged in the database. Parameters:
|
| Changes the user associated with the job (i.e. the user will be logged as the user that printed the job). Parameters:
|
| Allows overriding which of a users' personal accounts to charge and in which order/priority. This can be useful when a printer can only be used when credit is available in a particular subset of user personal accounts (e.g. department allocated quotas). Only those accounts listed will be charged for the job. If credit isn't available in the listed accounts the jobs is denied. NOTE: This is only valid when Multiple Personal Accounts is enabled. See Chapter 33, Multiple Personal Accounts. Parameters:
Example: To allow the jobs to be only charge to the accounts "Science Department" and "Cash" (in that order)
actions.job.changePersonalAccountChargePriority(
["Science Department", "Cash"]);
|
| Disable print job archiving if it's been enabled for this job. |
|
Sets the watermark text for this job. Watermarking allows text to be added on each printed page, e.g. the date and name of the user who printed the job. NOTE: Using an empty string will disable the watermark, overriding a queue-level setting. Example: actions.job.setWatermark(""); Parameters:
For more information about watermarking and the replacement variables that can
be used in |
Table 18.7. Job Actions Script Reference (actions.job)
The client actions allow a script to send messages to the user client and prompt the user for a variety of questions. These require that the user is running the client software.
| Method | Description |
|---|---|
| Sends a message to the user. This message is typically displayed as a task tray popup on Windows. Unlike the prompt actions, the user does not need to acknowledge the message to allow the job to print. Parameters:
|
| Prompts the user with the message dialog that displays an OK button. Returns a string:
Parameters:
|
| Prompts the user with the message dialog that displays an OK and Cancel button. Returns a string:
Parameters:
|
| Prompts the user with the message dialog that displays a Print and Cancel button. Returns a string:
Parameters:
|
| Prompts the user with the message dialog that displays a Yes and No button. Returns a string:
Parameters:
|
| Prompts the user with the message dialog that displays a Yes, No and Cancel button. Returns a string:
Parameters:
|
| Prompts the user with the message dialog that prompts the user to enter text, and shows an OK and Cancel button. Returns a string:
Parameters:
|
| Prompts the user with the message dialog that prompts the user to enter a password, and shows an OK and Cancel button. User input will be masked. Note that this function simply masks user input - it does not perform any actual password authentication. Returns a string:
Parameters:
|
| Prompts the user with the message dialog that prompts the user to select from one or more choices from a drop-down list, and shows an OK and Cancel button. Returns a string:
Parameters:
|
|
Prompts the user with a dialog containing a multiple input field form. The dialog also shows OK
and Cancel buttons. The input fields and layout are defined using HTML with form elements. The
Parameters:
Use of |
Table 18.8. Client Actions Script Reference (actions.client)
All the client prompt options have an options parameter to customize the prompt behavior.
Some prompt types have additional options, but all prompt types have the following options:
dialogTitle(string) - The title of the dialog.dialogDesc(string) - The brief one-line description to complement the dialog title.hideJobDetails(boolean) - Used to hide the job details from the user. e.g. document name, printer name, pages, cost, etc. Default:false- the job details are displayed.timeoutSecs(number) - The number of seconds to wait for a response from the user. Once this time elapses, the prompt method returns"TIMEOUT". The default timeout is 5 minutes (300 seconds).questionID(string) - Uniquely identifies a question for a given print job and script. Once a user has responded to a prompt with a givenquestionID, the result will be remembered and the user will not be prompted again for this job. This is important as the print script may be called repeatedly if jobs are held awaiting prompts, popups or are held in a release queue. If thequestionIDis not provided, the question ID is automatically generated based on the prompt parameters (e.g. message, buttons, choices, etc).The
questionIDis rarely required, only in the following cases:If the same prompt/question is required multiple times for a single script, and the user must answer each time. Assigning a different
questionIDto each prompt will ensure that the user is re-prompted.If the message of a prompt changes with each call. e.g. if the message included the current time it would change each time the prompt was called. Another example is if the message includes the user's balance, this might change if they are printing multiple print jobs. Both of these would cause the multiple prompts to appear. Assigning a
questionIDwill avoid this re-prompting.When performing validation of user-entered text from a text prompt in a
whileloop. A uniquequestionIDshould be assigned with each loop iteration, otherwise the user will not be reprompted and an infinite loop will occur (PaperCut NG will detect this and cancel the script execution).
fastResponse(boolean) - When set totruePaperCut will enable fast response mode to retrieve the response to the client prompt more quickly. This is only useful when displaying a sequence of prompts, and will cause the next prompt to display more quickly.IMPORTANT: This setting is only useful when displaying a sequence of prompts. Care should be taken when enabling this option as it may cause increased load on the server.
You might also want to consider displaying a multi-input form instead of separate prompts. See
actions.client.promptForForm()for details.
The client prompts allow the administrator to display a message to the user and ask for user input. The dialog messages provide a subset of the most useful HTML formatting options. You can use them to make your message stand out and grab the user's attention.
Plain text formatting:
To use plain text formatting simply provide a standard JavaScript string as the message
parameter. To start a new line, use the new line character \n. e.g.
actions.client.promptOK("First line\n\nSecond line");
HTML formatting:
The dialogs messages HTML formatting that provides a large subset of the most useful HTML formatting options. So you can get creative and make your message stand out and grab the user's attention.
To enable HTML formatting, surround the message text in <html>
and </html> tags. Below is a very simple example that shows
the word bold in bold.
actions.client.promptOK("<html>This is <b>bold</b></html>");
The client dialogs support many of the commonly used HTML features/elements including:
Bold text -
<b>Colored text -
<span style='color: red'>Images -
<img src='http://host.com/image.jpg'>Line breaks -
<br>Font sizes -
<span style='font: 14px'>Bullet lists -
<ul> / <li>Numbered lists -
<ol> / <li>Horizontal rule -
<hr>Text Field Input -
<input name="comment">(only valid inactions.client.promptForForm)
The dialog below shows most of the formatting options outlined above. The code for this dialog is available in the "Show a dialog with HTML formatting" snippet.
Tip
To reference an image stored in the directory [app-path]/server/custom/web/my-image.jpg
use the HTML:
<img src='http://%PC_SERVER%/custom/my-image.jpg'>
The special substitution variable %PC_SERVER% is expanded to the name and port of your
active PaperCut server.
| Method | Description |
|---|---|
| Logs an informational message to the App. Log. Parameters:
|
| Logs an warning message to the App. Log. Parameters:
|
| Logs an error message to the App. Log. Parameters:
|
|
Logs a message to the server's text-based log file
( Parameters:
|
Table 18.9. Log Actions Script Reference (actions.log)
| Method | Description |
|---|---|
| Sends an email to an email address or username. Parameters:
|
| Sends an email to one or many email addresses or usernames. Parameters:
Example: to send an email to many email addresses or usernames
actions.utils.sendEmail(
["Administrator", "[email protected]"],
"Oh no!", "we're out of print credit!");
|
|
Saves a global value as a Parameters:
For more information using storage properties see the section called “User Defined Persistent Properties (Storage)”. |
| A convenience method to increment a global number value associated with a persistent custom-defined property. This operation is performed once the print script completes and the print-job is printed. Parameters:
For more information using storage properties see the section called “User Defined Persistent Properties (Storage)”. |
Table 18.10. Utility Actions Script Reference (actions.utils)
| Method | Description |
|---|---|
|
Saves a value on the user as a Parameters:
For more information using storage properties see the section called “User Defined Persistent Properties (Storage)”. |
| A convenience method to increment a number value on the user associated with a persistent custom-defined property. This operation is performed once the print script completes and the print-job is printed. Parameters:
For more information using storage properties see the section called “User Defined Persistent Properties (Storage)”. |
Table 18.11. User Actions Script Reference (actions.user)
| Method | Description |
|---|---|
|
Saves a value on the printer as a Parameters:
For more information using storage properties see the section called “User Defined Persistent Properties (Storage)”. |
| A convenience method to increment a number value on the printer associated with a persistent custom-defined property. This operation is performed once the print script completes and the print-job is printed. Parameters:
For more information using storage properties see the section called “User Defined Persistent Properties (Storage)”. |
Table 18.12. Printer Actions Script Reference (actions.printer)