Adding a Kingfisher job as a Nutrient document automation server step (legacy integration)

Table of contents

    Adding a Kingfisher job as a Nutrient document automation server step (legacy integration)

    Kingfisher is a PDF data extraction tool that uses the text or barcode information found in PDF pages to perform different operations like:

    • Renaming PDF files based on text matching or barcode information
    • Splitting PDF files based on text matching or barcode information
    • Extracting pages from PDF files based on text matching or barcode information
    • Extract content from PDF files to TXT or CSV files Nutrient Document Automation Server is a document processing product designed to fit into an organization's document workflow. It can process and convert a variety of different types of document including TIFF images, Microsoft Office documents and HTML pages, convert those documents to searchable PDFs and perform a variety of other customizable activities. Nutrient Document Automation Server has the infrastructure to run jobs in an automated fashion, these include “watched folders” and “scheduled tasks.”

    Business problem

    The table below shows you an overview of the features provided in the two products.

    Nutrient Document Automation serverKingfisher
    Rename files based on text match/barcode in a location on a pageNoYes
    Split files based on text match/barcode in a location on a pageNoYes
    Extract PDF pages files based on text match/barcode in a location on a pageNoYes
    Extract data from PDF files to a CSV fileNoYes
    Extract text from a PDF file to a text fileYesYes
    Convert all files to PDF (kingfisher only processes PDF)YesNo
    Deleting input files after job finishesYesNo
    Moving/copying input files to an archive folderYesNo
    Scheduling of jobs/email alertsYesNo
    Product linksNutrient document automation serverkingfisher

    A scenario exists where a user will want to perform the operations provided by kingfisher while taking advantage of the document workflow architecture of Nutrient Document Automation Server. As a result, we have made it very easy to integrate the two products together.

    Integrating Nutrient Document Automation Server and Kingfisher

    To integrate the two products, you will have to perform the steps below:

    • Create kingfisher Job and save it.
    • Add and configure the “Kingfisher Job” step on Nutrient Document Automation Server

    Creating a Kingfisher job

    The image below shows a pdf file with a Barcode in the top left corner of the pages. We are going to create a kingfisher job to rename all the files in an input folder to the value of the Barcode.

    Before starting, make sure you are using a version of Kingfisher that is the same or higher than “1.1.170907”

    Click the “add new job” button

    This will launch the “Create new Job Wizard” shown below

    Click next to enter the “job definition”

    Set up the job as shown in the table below

    PropertyValue
    Source and destinationUse a placeholder value here; this is because Nutrient Document Automation Server will provide the source and destination folders at run time.
    Location detailsSelect “tree”, you can control whether you pick up folders or trees from the Nutrient document automation server job.
    Select operationSelect “rename PDF file”. then select “rename based on barcode” in the subsection.
    Rename optionsSelect the “use the first barcode found” radio button since we only have one barcode per page.
    Click next to go to the “file naming” tab

    Kingfisher gives you the ability to add different variables to your output file name, for this example we will use “%VALUE1 percent_%DATE%” which is the value of the Barcode extracted and the current date.

    Click next until you reach the “finish” tab

    We will skip the “Advanced Settings” Tab in this example. You can use this tab to provide extra settings for the job like metadata, security and OCR setting. The finish tab will show you the summary of the job you just created

    Click the “save job” button to create a new job.

    As you can see you have successfully created a job with Job ID “10000”

    These steps show you how to create a simple Kingfisher job, you can visit this link below for some sample videos on how to create more advanced jobs in kingfisher. king-video.asp

    Add the Kingfisher job to Nutrient Document Automation Server

    Before starting, make sure your version of Nutrient Document Automation Server is higher or same as version 4.1

    Create a new job

    To do this navigate to the “Job Manager” tab and click on the “Create New” button

    Enter the job details in the “designer tab”
    PropertyValue
    Source and destinationUse the real source and destination folder
    Job stepSelect the plus sign “+” next to the “advanced” label under “designer task”. this will show you a few job steps, select “kingfisher job”
    Kingfisher job IDUnder the step properties, enter the job id of the kingfisher job we setup in the previous section.
    Extract textAdd an “extract text from PDF” step to the job. this is to demonstrate that kingfisher can work with other Nutrient document automation server steps in a multistep job.

    Save and run your new job

    Review the job outputs

    The diagram below shows a side by side comparison of “Source” and “Destination” Folders.

    Remarks

    This blog shows you a very basic scenario where you will need to integrate Kingfisher and Nutrient Document Automation Server, you will need to learn how to use the two products to fully maximize their potential. Use the links below to find out more about Kingfisher and Nutrient Document Automation Server

    Resource nameLink
    Nutrient Document Automation Server product pagedocument-automation-server
    Nutrient Document Automation Server reference guideautobahndx.PDF
    Nutrient Document Automation Server cookbookautobahn dx cookbook.PDF
    Nutrient Document Automation Server videosadx_video_tutorial.htm
    Nutrient blogsHTTPS://www.Nutrient.io/blog/
    Kingfisher product pagekingfisher.asp
    Kingfisher reference guidekingfisher.PDF
    Kingfisher videos*king-video.asp
    Neil Pitman

    Neil Pitman

    Explore related topics

    FREE TRIAL Ready to get started?