Activation procedure for pdfToolbox CLI

Step by step instructions on how to activate callas pdfToolbox CLI.

Background

To use any callas product on a computer, you need to activate it first. This is true if you have bought a license key but also if you want to run the trial software. This article explains how the normal activation procedure for callas pdfToolbox CLI and DeviceLink Add-on Server works and which steps you have to go through.

Instructions

Activation code request

Open a terminal window and change to your pdfToolbox CLI installation directory.

Command

./pdfToolbox --keycode [--aws] <name> <company> <licenseCode>

Parameters

  • name: Name of license (e.g. "Registered User").
  • company: Name of company (e.g. "User's company").
  • licenseCode: License key obtained from the registration card or the License.pdf provided by callas or the reseller.
    To make a request for a trial version, please use the keyword "trial" (for a pdfToolbox trial version) or "trialaddon" (for a DeviceLink Add-on trial version) for this parameter.
  • aws: For installation on Amazon Web Services (using Windows, Linux 32bit and 64bit).

The textual output of --keycode has to be send via e-mail to the e-mail address named in the text in order to receive an activation code from the registration server.

Activation

After having received the automatical reply e-mail to the activation request, save the attached license file to the file system.

Command

./pdfToolbox --activate <activation file>

Parameters

  • license file: Full path to the Activation PDF.

NOTE: If your SPAM filter has removed the attachment, you can create a new empty text file and copy all lines from the e-mail that are starting with an "@" into the text file. Save it as a UTF-8 encoded plain text file with the name “Activation.txt". This text file can now be used in the exact same fashion as described above for the Activation PDF.

NOTE: It is necessary to activate the received license file to get a permanent valid license file.

NOTE: The license file received from the activation server must be activated within the timeframe listed in the license file.

NOTE: The activated license file will be stored in the user-preferences when the normal activation (command above) is used. To create an activated license file at a custom location, just use the following command: ./pdfToolbox --activate <activation file> -o=<path to result folder/License.txt>.

NOTE: pdfToolbox CLI is searching for the license file at various folders:

  • User-preferences-folder of actual user.
  • Next to the pdfToolbox CLI binary.
  • Cachefolder (if set).
  • User-preferences-folder for all users (shared).

NOTE: In order to activate pdfToolbox CLI for all user accounts of one machine, save the activated license file next to the pdfToolbox binary. This file must be named "Activation.pdf". The activated license file will be stored in the user-preferences when the normal activation (command above) is used. To create an activated license file at a custom location, just use the following command: ./pdfToolbox --cachefolder=<directory> --activate License.txt>.

This ensures that the license is placed inside the appropriate subfolder (which is by itself stored underneath the given cachefolder, e.g. <cache folder>\callas software\callas pdfToolbox CLI <version>). The license will not be stored in the user preferences when using this command only.

NOTE: When using UNIX-based-systems the environment variable "CALLAS_SYSTEM_PREFERENCES" the path of the standard "/usr/share/callas software/callas pdfToolbox CLI" can be changed: "CALLAS_SYSTEM_PREFERENCES=tmp" would result in the searchpath: "/tmp/callas software/callas pdfToolbox CLI". It is highly recommended to use the option --cachefolder instead.


Deactivation

As the activation (and the resulting license file) is bound to the hardware. It is necessary to deactivate a license on one machine before an activation takes place on the new machine.

Command

./pdfToolbox --deactivate <activation code>

Parameters

  • activation code: Unique identifier for each license.

NOTE: The respective license will be removed from the system.

NOTE: To complete the deactivation, the output of the command has to be sent manually to the activation server by e-mail. The activation code for all license are listed using the status command: ./pdfToolbox --status.