Introduction

Kingfisher provides a set of operations for processing PDF files, this includes splitting, extracting pages, extracting text and renaming of the files based on the content of the files. Kingfisher also provides the ability to set the security, metadata and other attributes of a PDF document.

What makes Kingfisher standout is the ability to perform split, extract and rename operations based on text or barcode found in zones or coordinates in a PDF page. Kingfisher can use Optical Character Recognition (OCR) to extract text data from Image PDF files or pages.

System Requirements

Requirement Value
Supported Operating Systems Windows 10 (64bit)
Windows Server 2012
Windows Server 2016
Windows Server 2019
Supported SharePoint Versions SharePoint Online (office 365)
SharePoint Server 2019
SharePoint Server 2016
SharePoint Server 2013
SharePoint Server 2010
Disk Space 450 Mb
.Net Framework 4.7.2

Installation

Kingfisher will require installation by a user with Administrator privileges.

The installation MSI will guide you through the process of setting up Kingfisher.

User Permissions

The logged in user for the User Interface (UI) and the service user require Full Control of the following folders under the Kingfisher installation folder:

  • Conditions

  • License

  • Logfiles

  • Status

  • Temp

In addition, the user(s) will require Full Control of the following files in the Bin folder:

  • Kingfisher.Config

  • Kingfisher.Service.exe.config

Service User

When Kingfisher is installed, the Kingfisher service logs on as the Local System account. This is generally suitable for installations where the files being processed are present on the installation machine, or are stored in SharePoint (online or on-premises).

Windows Server 2019 machines have slightly more restrictive permissions, ensure the service user can access the locations listed in 1.2.1.

If the files are to be referenced via Universal Naming Convention (UNC) paths, an account will need to be created that has the required permissions on those paths.

Log-on to the computer as a user with Administrator permissions.

Start the Services app either from the Control Panel or search from the Windows task bar for Services and launch the Services app.

Find the Aquaforest Kingfisher service and right click and select the Properties option.

Select the Log On tab

Enter the username and password and click on OK.

For the service to use the new credentials, it must be restarted. Right click on the Aquaforest Kingfisher service and select Restart.

Licensing and Purchasing

Please note - from 31 March 2022 Kingfisher is only available as a subscription product.

A subscription license will need to be renewed annually and comes with an SMC for the duration of the subscription.

When a license is purchased the relevant subscription license key will be issued for use with the product. This can be entered using the Options tab of the GUI. There is no need to download another version of the software.

The SMC includes support by email, telephone or by remote session, and includes free upgrades for the duration of the SMC.

Existing permanent Kingfisher 2.5 licenses will remain valid (and continue to function as permanent licences).

Additional Support and Maintenance Cover (SMC) for existing permanent licenses will continue to be available for version 2.5.

Trial licenses are fully functional, but all generated PDF files will have the Aquaforest trial stamps on them and text extraction is limited to the first three pages.

Version Breakdown

Standard Professional Server
Use Cases Smart PDF Splitting and Renaming. Smart PDF Page Extraction, Splitting and Renaming. Automated Smart PDF Page Extraction, Splitting and Renaming.
Split PDF by Content, Barcode or Page Ranges
Rename PDF by Content or Barcode
Extract PDF Pages by Content or Barcode
Includes Optical Recognition for processing Image PDF files
Graphical User Interface
Process Files in SharePoint
Extract PDF Text and Data to CSV, Excel or Text File.
Command Line Interface
Automated Scheduling
Number of Cores Supported 1 1 4