Skip to main content

Connected mode

Configure the Pdftools software to validate the license keys partially offline using the connected mode, enabling the system to remain operational without a network connection for varied amount of time. The period in which you can validate the license keys offline differs depending on your license type and agreement with the Pdftools.

Full offline mode

You can also set up a full offline mode that lets you use Pdftools software offline for at least three months. For more details, review Full offline mode.

Conversion Service and LGS

The Conversion Service comes with the Licensing Gateway Service (LGS) preinstalled. You can skip the LGS installation step if you plan to use the LGS provided with the Conversion Service on the same machine. Installing the LGS on such a machine for the second time may render the Conversion Service unusable.

Don’t follow this page to set up the LGS with the Conversion Service. To set up the connected mode in the Conversion Service, review Licensing Gateway Service in the Conversion Service licensing documentation.

Install the LGS​

Install the Licensing Gateway Service (LGS) to enable partially offline configuration, download and install the package on a machine in your network that is connected to the internet.

  1. Download the LicensingGatewayService.msi package.
  2. Run the installer.

The installer also creates a Windows service that acts as an agent to regularly synchronize the LGS with the Pdftools Licensing Server.

Linux CLI naming

On Linux, the ptl CLI is part of the licgwy snap package. Invoke it as licgwy.ptl instead of ptl. All CLI examples on this page use ptl for brevity.

To create a shorter alias, run the following command with elevated privileges:

sudo snap alias licgwy.ptl ptl

On Windows, the CLI is always ptl. All CLI examples on this page use ptl for brevity.

Configure the LGS​

To configure the LGS:

  1. Find the LGS configuration file appsettings.json:

    For Windows, the file is in the installation folder, for example:

    C:\Program Files\Pdftools\Licensing Gateway Service\appsettings.json

    Example configuration file:

    {
      "LicensingServicePortNumber": 9999,
      "LogFilePath": "C:/logs/pdftls/log.txt",
      "LogRetentionDays": 7
    }

  2. You can configure these options:

    • Licensing Service Port number: Set the port number used by the service. The default value is 9999.
    • Log file path: Specify the desired path of the log files.
    • Log retention: Define the number of days the log files are kept.

  3. Restart the service after modifying the appsettings.json file for the changes to take effect.

  4. To ensure that the LGS can always connect to the Pdftools Licensing Server, add the service to the allowlist of any configured firewall.

caution

If the machine with the LGS becomes inaccessible, you can borrow a license key on another machine without returning it first. If you try to borrow the license key more than once in this situation, the license key is blocked.

You cannot use or return the blocked license key on any other machine. To reset the license key, contact Pdftools support. Review the Support page.

Configure a forward proxy​

If the LGS connects to the Pdftools Licensing Server through a forward proxy, configure the proxy settings in the appsettings.json configuration file.

To configure a forward proxy:

  1. Find the appsettings.json configuration file:

    For Windows, the file is in the installation folder, for example:

    C:\Program Files\Pdftools\Licensing Gateway Service\appsettings.json

  2. Add the ForwardProxy section with your proxy details:

    {
      "LicensingServicePortNumber": 9999,
      "LogFilePath": "C:/logs/pdftls/log.txt",
      "LogRetentionDays": 7,
      "ForwardProxy": {
        "Address": "PROXY_ADDRESS",
        "Username": "PROXY_USERNAME",
        "Password": "PROXY_PASSWORD",
        "BypassOnLocal": true
      }
    }

    Replace the following:

    • PROXY_ADDRESS: The forward proxy URL including port, for example http://proxy.example.com:8080.
    • PROXY_USERNAME: The username for proxy authentication. Leave empty for non-authenticated proxies.
    • PROXY_PASSWORD: The password for proxy authentication. Leave empty for non-authenticated proxies.

  3. Restart the service for the changes to take effect.

The following table describes the ForwardProxy properties:

PropertyDescription
AddressProxy address, for example http://proxy.example.com:8080.
UsernameUsername for proxy authentication. Leave empty for non-authenticated proxies.
PasswordPassword for proxy authentication. Leave empty for non-authenticated proxies.
BypassOnLocalWhether to bypass the proxy for local addresses. Defaults to true.

Use the CLI utility​

The LGS includes a command-line interface utility designed to manage and borrow license keys associated with your Pdftools products.

note

When you activate a license key in the LGS, it is linked to the machine where you activated it. If you install LGS on another machine, deactivate the license key so you can activate it again in the LGS.

Borrow a license​

Borrowing means adding license keys to the LGS to validate them for the machines in your local network automatically. To borrow a license, use the following command and include the license key:

ptl add LICENSE_KEY_VALUE

Replace LICENSE_KEY_VALUE with your license key.

When you run this command, a connection is opened between the LGS and the Pdftools Licensing Server to validate the license key for a period of time. The LGS lets you use multiple license keys at the same time.

info

In connected mode, you can use the same license key on multiple machines simultaneously. The LGS lets you validate license keys across as many machines as needed in your local network.

Check licenses and the service status​

To view all license keys added to the system, use the following command:

ptl list

To view the connection status between the LGS and the Pdftools Licensing Service, use the following command:

ptl status

Synchronize licenses​

To establish an active connection between the LGS and the Pdftools Licensing Server manually, use the command:

ptl sync

This command contacts the Pdftools Licensing Server and synchronizes usage using the cached data stored by the LGS.

Return a license​

To return a borrowed license, use the remove command. You must perform the step to return the license to the Pdftools Licensing Server before it can be added to another machine.

ptl remove LICENSE_KEY_VALUE

Replace LICENSE_KEY_VALUE with your license key.

caution

A license remains borrowed by a specific machine until it is returned, even if it becomes deactivated.

Return the license before another machine can borrow it.

To return all license keys added to the LGS, use the command:

ptl remove-all

LGS CLI commands​

To access a full list of available commands, use the ptl help command.

CommandDescription
ptl helpGet instructions on how to use the CLI with a full list of commands.
ptl versionGet the LGS version number.
ptl add LICENSE_KEY_VALUEAdd a new license key.
ptl remove LICENSE_KEY_VALUERemove a license key.
ptl remove-allRemove all license keys.
ptl statusCheck the licensing service status.
ptl listGet information about added license keys and for how long they are valid.
ptl syncConnect to Pdftools Licensing Server on demand (refreshes the time on all borrowed licenses).

Connected mode with Pdftools OCR Service​

If you configured the connected mode with the Pdftools OCR Service, update your worker nodes configuration. Follow the steps described in Configuration in connected mode and full offline mode section.