Advanced scripting (print scripting)

Create a print script

Print scripts are segments of code that are run whenever a new print job arrives in the queue. The script is defined using the concept of a "hook". A hook is a JavaScript function (e.g. function printJobHook(inputs, actions) { }) that is called for each new job. Your print script defines this method, its behavior, and its actions.

All scripts are defined on a per printer basis allowing each printer to have its own logic (although you can share/copy a common script between printers, see Copy printer settings).

To create a print script:

1. Click the Printers tab.

   The Printer List page is displayed.

2. Select a printer.

   The Printer Details - Summary page is displayed.

3. Click the Scripting tab.

4. Select the Enable print script checkbox.

5. Create your script in one of the following ways:

   • import a predefined recipe (script)
   • write your own script using snippets

6. Click Apply.

Recipes

Recipes demonstrate best practice and should be considered as a starting point for development of your own scripts.

To use a recipe:

1. Click Import Recipe.

   A list of the predefined recipes is displayed. For example, the Print Policy Enforcement (warnings & automatic conversion) recipe:

   • discourages single-sided printing

   • discourages printing of emails in color

   • discourages printing of web pages in color

   • discourages printing of emails that have more than one page

   

2. Click Import next to the recipe you want to use.

   A confirmation prompt is displayed.

3. Click OK.

The recipe replaces what is currently in your script.

4. Click Apply.

Snippets

Code snippets are small code fragments that demonstrate how to use the scripting APIApplication Programming Interface (API) is a set of routines, protocols, and tools for building software and applications. An API expresses a software component in terms of its operations, inputs, outputs, and underlying types, defining functionalities that are independent of their respective implementations, which allows definitions and implementations to vary without compromising the interface. (inputs, functions, and methods). Consider using snippets as a base for adding functionality to your script.

To use a snippet:

1. Place your cursor in the position you want to insert the snippet.

2. Click Insert Snippet at Cursor.

   A list of code snippets is displayed. For example, the Test if job is color snippet provides the code to check if a print job is being printed in color. This could be used as part of a script to perform an action on all color print jobs.

   

3. Click insert next to the snippet you want to use.

   A confirmation prompt is displayed.

4. Click OK.

The snippet is added to your script.

5. If required, you can modify the code to suit your needs.

6. Click Apply.

Error messages

Error messages are classed into two groups:

• Syntax errors—these are detected and displayed when a script is applied. The script does not save until all syntax errors are addressed.

  

• Runtime errors—these are errors that only occur when a script is executed for a print job. Runtime errors are also listed on the Scripting tab in red. Refresh the page to see runtime errors. Runtime errors are also logged and are displayed on the App Log tab.

  

Where possible the error message indicates the line number on which the error was found and the relevant line is highlighted.