Available in PaperCut NG and PaperCut MF.

Automation and scripting

PaperCut NG/MF provides a detailed set of server commands and Web Services 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.'s. Use these services to automate common operations and management tasks. Some examples of where an administrator would use scripting/automation include:

  • Automate tasks such as backups and domain user/group synchronization.

  • Integrate account creation and management into existing scripts or processes.

  • Manage account balances and transactions outside the application.

The automation and scripting tools are written for software and script developers. It is expected that readers intending on using these tools are comfortable with developing system management and server monitoring programs.

The server-command and Web Services API's are included as standard with PaperCut NG/MF. More information on using these tools is detailed in Tools - database, server-command scripting, and APIs (Advanced) in Server commands (server-command) and The XML Web Services API.