Skip to content

Help

Jump to bottom
mgobat edited this page Jun 4, 2024 · 10 revisions

Table of Contents

  • Introduction
  • API Keys
  • Additional Help/Information
  • Running as a Windows Service
  • Running with a Single Configuration File for All Users
  • Log Files

Introduction

The Alma Print Daemon is an Alma extension that helps you to automatically print letters and slips from the Alma Print Queues. With this new print daemon extension there is no need to use email based printing. It will also automatically update itself when new versions are available for easy management and upkeep.

API Keys

You must have an API Key with read permission for the Configuration area and read/write permissions for the Task-Lists area. Note that each API key may be used for only one environment. If you wish to run the Alma Print Daemon on your Sandbox, you need a API key for that environment. If you wish to run the Alma Print Daemon on Production, you need an API key for that environment. These instructions assume you wish to create an API key for each environment, Sandbox and Production.

  1. From the Ex Libris Developer Network click “Build - My APIs”
  2. Under "API Keys" click “Manage Keys”.
  3. Click “Add API Key”
  4. Name your key with a relevant name, for example "Alma Print Daemon - Sandbox".
  5. Click "Add Permission".
  6. Select "Configuration" for the "Area" dropdown.
  7. Select "Sandbox" in the "Env" dropdown.
  8. Select the "Read-only" radio button.
  9. Click "Add Permission" again.
  10. Select "Task-lists" for the "Area" dropdown.
  11. Select "Sandbox" in the "Env" dropdown.
  12. Select the "Read/write" radio button.
  13. Click the "Save" button.

To create an API key for your Production environment, repeat the above steps starting at 3, replacing "Production" for "Sandbox" in steps 4, 7, and 11.

You will need to copy the API key to provide it in the "Configuration" dialog for the Alma Print Daemon. Be sure you copy the correct API key for the environment you wish to use. The Alma Print Daemon may only be run against a single environment at a time per workstation.

This version of the Alma Print Daemon may be run as a Windows application, like previous versions, or installed as a Windows Service using nssm (https://nssm.cc/).

Running as a Windows Service (requires at least version 2.0.0)

To use as a Windows Service:

  1. Download and install nssm, https://nssm.cc/download.
  2. From the command line, run nssm: nssm install AlmaPrintDaemon
  3. Enter, or navigate to, the Alma Print Daemon binary in the "Path" field. eg: C:\Program Files\alma-print-daemon\alma-print-daemon.exe
  4. Enter the "Startup directory" for the application. Normally, this will be the directory in which the Alma Print Daemon resides.
  5. Enter "service" in the "Arguments" field.
  6. Enter a name for the service in the "Service name:" field. eg: AlmaPrintDaemon
  7. Click the "Details" tab.
  8. Enter any information relevant to your standards and select a "Startup type".
  9. Click the "Log on" tab.
  10. Click the "This Account" radio button, and enter a valid Account, Password, and Confirm Password.
  11. Click "Install service"

Running with a Single Configuration File for All Users (requires at least version 2.2.0)

To run with a single configuration file for all users:

  1. When running the installation package, select the "Anyone who uses this computer (all users)" radio button when prompted to "Choose Installation Options".
  2. Create a globalConfiguration.json file in the installation directory. This file should specify the directory into which you will place the global configuration file. It is specified as the "globalConfigPath" element. Example:{"globalConfigPath": "c:\\APDGlobalConfiguration"} The backslash character must be preceded by an escape character.
  3. All users expected to read and update the global configuration for the Alma Print Daemon must have read/write access to the directory specified as the globalConfigPath in the globalConfiguration.json file.
  4. Copy your master alma-print-config.json into the directory specified in your globalConfiguration.json file.
  5. The Alma Print Daemon will indicate that a global configuration is in use by including "Using Global Configuration" in the application's title bar.
  6. If the globalConfiguration.json file does not exist, or if it specifies a non-existent directory for the globalConfigPath, the Alma Print Daemon will revert to using user-specific configuration files. The absence of "Using Global Configuration" in the application's title bar indicates a user-specific configuration is in effect.
  7. Note that when the Alma Print Daemon is re-installed, its directory contents will be erased. Please backup your globalConfiguration.json file before re-installing, and restore it afterwards.

Log Files

In a single-user configuration, log files are stored in C:\Users\USER_NAME\AppData\Roaming\alma-print-daemon, where USER_NAME is the currently logged in user id.

In a global configuration, the log files are stored in the location specified in the globalConfiguration.json file in the installation directory.

Additional Help/Information

For additional information about implementing the Alma Print Daemon, click here.

Clone this wiki locally