Create a print script

Print scripts are segments of code that are run whenever a new print job arrives in the queue.

All of PaperCut MF's advanced scripts are written using JavaScript (also known as ECMA-262 ECMAScript... apparently). For more information about JavaScript, see:

• w3schools JavaScript Tutorial

• JavaScript.com

• JavaScript Function Definitions

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 by either Copying printer settings or using a common script.

Previous experience with scripting or programming is strongly recommended. However, PaperCut MF does provide a number of tools to assist with script development, including:

• A mini JavaScript editor with basic error checking and syntax highlighting.

• Quick access to a code cookbook containing dozens of best-practice recipes.

• Pre-canned "code snippets" demonstrating the use of key functions.

• Simple debugging tools such as logging and runtime error reporting.

To create a print script:

1. Click the Printers tab.

   The Printer List page is displayed.

2. Select a printer.

   The Printer Details page is displayed showing the Summary tab contents.

3. Click the Scripting tab.

4. Select the Enable print script checkbox.

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

   • Importing predefined recipes

   • Using snippets

   • Combining print scripts

   • Using common scripts

   You can also create a script from scratch if that's what you prefer.

6. Click Apply.

7. Test your script to make sure it works as you expect.

8. Copy the script to your production printers. As soon as you click Apply on the Scripting tab, your script will be live.

Importing predefined recipes

To use a recipe:

1. Click Import Recipe.

   A list of the predefined recipes is displayed. For example, the Discount for copying and scanning for staff recipe.

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.

Using snippets

Code snippets are small code fragments that demonstrate how to use the scripting API (inputs, functions, and methods). Consider using snippets as a base for adding functionality to your script.

To use a snippetCode snippets are small code fragments that demonstrate how to use the scripting API (inputs, functions, and methods).:

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.

Combining print scripts

If you have an understanding of JavaScript, you can combine parts of two or more print scripts.

A typical print script contains one printJobHook() function

PaperCut MF calls printJobHook once per print job. If you want to have two recipes called for a job, then you must call them both from one printJobHook() function.

A simple way to call recipe 2 after recipe 1 is:

1. Copy the first recipe into your script and rename its printJobHook to printJobHook1.

2. Copy the second recipe into your script and rename its printJobHook to printJobHook2.

3. Below the two renamed recipes (at the very end of the script text) add a printJobHook function that calls printJobHook1 then printJobHook2:

   function printJobHook(inputs, actions) { printJobHook1(inputs, actions); printJobHook2(inputs, actions); }

Troubleshooting a combined script

If your combined script does not work on your printer:

• Check that recipe 1 alone works on your printer. You can do this by saving the combined script in a text editor and re-importing recipe 1.

• Check that recipe 2 alone works on your printer. You can do this by saving the combined script in a text editor and re-importing recipe 2.

• Confirm that it makes sense to call recipe 2 after recipe 1.

If the combined script still does not work then there may be some JavaScript knowledge required. You should discuss your script with someone who knows JavaScript.

Using common scripts

Large organizations with advanced print scripting requirements might need to share common code between different print scripts. Use advanced scripting techniques to build these common libraries.

Writing a common script involves creating a single JavaScript file on your PaperCut MF Application ServerAn Application Server is the primary server program responsible for providing the PaperCut user interface, storing data, and providing services to users. PaperCut uses the Application Server to manage user and account information, manage printers, calculate print costs, provide a web browser interface to administrators and end users, and much more. with all of the functions you want to reuse. These functions are created much like they would in the Scripting window for a single printer.

To create a common print script file:

1. In a text editor (such as Notepad++) create a new file.

2. Save the file as print-script-common.js in the following folder:

   [PaperCut MF install path]\server\custom\

3. Create the script on a test printer, testing all variables of the script to ensure it works as intended.

4. Once your script is working and you are happy with how it’s running, add it to the print-script-common.js file.

   NOTE

   Functions in the print-script-common.js file cannot have the same name as a function in your print script.

5. Call this function in the print script by adding a line below the main function that calls the function in the print-script-common.js. In the example below, the function in print-script-common.js is called DuplexAndGrayScale.

   

6. Test that your print script works before deploying to a live printer.