Version 3.150
[Date: 23 Juli 2024]

Development

Breaking changes in barcode recognition module
We updated our barcode library, which affects how the barcode recognition modules work. This change should have a minimal impact on most users and commonly used barcode types. However, you must test all workflows that use barcode recognition modules to ensure the selected recognition mode setting still works for your specific situation. If barcodes are not recognized after upgrading, try changing the recognition mode to the setting for lower quality barcodes, which should improve recognition quality and accuracy.

Option to acknowledge problems
We added an option to acknowledge problems (warnings and errors). Right-click on a warning or error to acknowledge the problem. When all problems are acknowledged, the job no longer shows that it contains errors or warnings

Multi-language support
Multi-language support to the OCR (Tesseract) module

Read Image module
Support for tiled TIFFs to the Read Image module

OCR tutorial
Extend OCR tutorial

Fixes

OCR Tesseract module
- Fix incorrect encoding of text when using the plain text output channel of the OCR (Tesseract) module

Send API Request module
- Fix entities processed counter of Send API Request module

Third-Party component maintenance

Third-Party component
- Update Aspose.BarCode to 24.5.0
- Update Pdfium.Net.SDK to 4.90.2704

Version 3.140
[Date: 22 November 2023]

Development

A new PDF Extract Images module
- This module extracts text from a searchable PDF containing a selectable text layer. The module can output the extracted text as a plain text file via the plain text output channel.

The OCR module has a new property named “Write OCR result to metadata”
- Once enabled, the module will write the OCR result in plain text format to a metadata field. This metadata can then be easily accessed from macros in downstream modules

The Text Classification module and the Named Entity Recognition module have a new Plain text hook. ”
- The hook's return value is utilized for classification tasks, eliminating the need for a plain text input object. This can be useful, for example, if you want to categorize objects based on plain text stored in a metadata field or as index value

In the cockpit we added an File > Close workflow menu item to close an active workflow. ”
- If there are unsaved changes, the user will receive a prompt to save them or discard them if desired

Increase the time-out for the SQL command that deletes finished batches
- The time-out is increased from 30 seconds to 10 minutes and make the amount configurable

Fixes

Rasterize PDF module
- Fix a problem where modules working with a lot of objects, such as the Rasterize PDF module that rasterizes a large PDF into single page output, result in an error when suspending the task/batch. See also Task suspension failed
Macro repository
- Functions exported from the macro repository now retain their indentation

Third-Party component maintenance

Third-Party component
- Update Aspose.BarCode to 23.10.0
- Update Aspose.Pdf to 23.10.0
- Update Pdfium.Net.SDK 4.87.2704

Version 3.130
[Date: 1 November 2023]

Development

A new affordable OCR module using the opensource Tesseract>

A new Image conversion module which converts images to PDF

A new PDF conversion module which converts PDFs to other PDF formats

A new PDF Extract Text module
- The PDF Extract Text module extracts text from a searchable PDF containing a selectable text layer. The module can output the extracted text as a plain text file via the plain text output channel. The module can also write the extracted text to a metadata field. This way, the text can be easily accessed from macros in downstream modules.

Support for certificate authentication for the Send API request module
- Add a Certificate path property to the Send API Request module that configures the path to a certificate file that is presented by the module (client) to the server

Fixes

MRC Compression
- Fix MRC Compression module not updating the extension to .pdf in the DocYard.FileInfo.FileName metadata field

Form Designer app
- Fix incorrect resolution of imported PDFs in the Form Designer app, Imported PDFs are now rasterized to a bitmap at a resolution of 300 dpi

Cockpit
- Fix incorrect selected job in client and jobs panel after closing a job properties window that was opened with a double-click on the job

Third-Party component maintenance

Third-Party component
- Update Pdfium.Net.SDK to 4.85.2704

Version 3.12.0
[Date: 15 December 2022]

Development

Enhancements batch creation mode
- Add a simple batch creation mode that creates batches from scratch (i.e. not dependent on folders, CSV, etc.). Great for creating batches starting with an Email Import module

Enhancements Email Import module
- Add a login attempts property to the Email Import module that configures the maximum number of attempts to re-login after a failed attempt before an error is reported. Useful if you don't want to get an immediate error on a short and temporary network or email server interruption

Enhancements DocYard Cockpit
- Add shortcut-keys for some common Cockpit actions:
Layout workflow: Ctrl+R (reformat)
Clear status view: Ctrl+W (wipe)
Normal zoom: Ctrl+0
Zoom to fit: Ctrl+1
Zoom in: Ctrl+=
Zoom out: Ctrl+-
Copy master log messages to clipboard: Ctrl+Shift+C

Enhancements reboot procedure
- Add the recommended reboot procedure to the documentation
- Add two sample Windows PowerShell modules that provide some high-level cmdlets that facilitate scripting the reboot procedure

Fixes

Data Warehouse
- Fix missing pre- and post processing data in data warehouse

DocYard Cockpit
- Fix scrolling of large workflows without having to zoom to fit first

Version 3.11.0
[Date: 13 October 2022]

Development

Enhancements Email Import module
- Make the Email Import module compatible with Microsoft Outlook (365) accounts for which multi-factor authentication is enabled and/or for which basic authentication is disabled by using IMAP and OAuth2 (client credential flow)

Fixes

Email Import module
- Fix crash of Module Manager when manually ending a batch that uses the Email Import module with permanent monitoring enabled

Barcode Recognition modules
- Fix "Barcode recognition failed" error when barcode contains an invalid XML character

Version 3.10.0
[Date: 31 August 2022]

Breaking changes

- We move the recognition of Codablock F barcodes from the 2D to the 1D Barcode Recognition module. If you use Codablock F barcodes you must replace the 2D Barcode Recognition module with the 1D Barcode Recognition module
- To simplify the use of the barcode recognition modules, we replace a number of advanced configuration options with a new recognition mode property. With this property you can choose a recognition mode that controls the balance between accuracy and speed. The default settings should work for regular quality barcodes, but you must test all workflows that use barcode recognition modules to determine if these settings still work for your specific situation
- If you are using the 2D Barcode Recognition module, you must request a new license (for which there is no additional charge).

Development

Enhancements Email Import module
- Add option to stop the 'permanent' monitoring mechanism of the Email Import module by defining a cron schedule

Enhancements Send API Request module
- Add option to disable automatic redirects in the Send API Request module (3xx status code)
- Add option to disable certificate validation in the Send API Request module

Enhancements DocYard platform
- Replace the barcode recognition engine with Aspose.BarCode
- Refresh DocYard module icons

Fixes

Send API Request module
- Fix "Processing data objects failed" error when the Send API Request module receives no content from the API (204 status code)

Data Warehouse
- Fix "The specified @job_name ('Extract and Transform for Data Warehouse') does not exist" error which could occur when using the DocYard data warehouse feature in conjunction with Microsoft SQL Server
- Fix the log rotation of data warehouse logs

Version 3.9.0
[Date: 16 May 2022]

Development

Enhancements Send API Request module
- Add option to send bodies in form data format with the Send API Request module
- Add option to send files as form data with the Send API Request module
- Add option to send bodies in form URL-encoded format with the Send API Request module
- Add PATCH, HEAD, and OPTIONS HTTP methods to the Send API Request module
- Add a received data output channel to the Send API Request module that can be used to import the response from an API into the workflow

Third-Party component maintenance

Born Digital
- Upgrade to Callas pdfEngine SDK v13.1.586

PDF rendering tool
- Update Pdfium.Net.SDK to 4.67.2704

Fixes

- Fix processing of XPS file
- Fix resuming a suspended tasks with modules that have permanent monitoring enabled

Version 3.8.0
[Date: 17 January 2022]

Development

Changed Read Image module
- The Read Image module now only reads bitmap images. We've disabled the ability to read PDF files with this module. Using the Rasterize PDF module to convert PDF files to bitmap images was already the recommended way. So there is a good chance that you will use the Rasterize PDF module in existing workflows for this, but this should be checked to make sure that your workflow still works properly after upgrade

Changed Rasterize PDF module
- The Rasterize PDF module now always renders PDF files to bitmap images using the configured rendering resolution. The module will no longer try to determine the resolution itself. You must make sure you've set the rendering resolution to the desired dpi

New PDF rendering tool
- Replaced the PDF rendering tool with Pdfium.Net.SDK v4.65.2704

Third-Party component maintenance

Born Digital
- Upgrade to Callas pdfEngine SDK v13.0.578

Fixes

Send API Request module
- Fixed an issue where the Send API Request module produced an error when using $object in a macro at batch start. Customers using the following workaround do not need it anymore and may safely remove it:
if(!$object){
return ""
}


Processing empty email subjects
- Fixed an issue where an empty email subject resulted in an error in the Email Import module

Read Image module
- Fixed an issue where the Read Image module produced an error because DocYard was dependent on the Microsoft Visual C++ 2010 Service Pack 1 Redistributable Package while it wasn't included

Version 3.7.0
[Date: 6 October2021]

Development

Tutorials are added to the documentation site
- Named entity recognition tutorial
- Data warehouse tutorial

Fixes

Windows Server 2012 R2 compatibility
- Fixed incompatibility of DocYard AI with Windows Server 2012 R2 (introduced in DocYard 3.5.0)

PostgreSQL collation compatibility
- Fixed incompatibility of the DocYard installer, feature 'Data warehouse', with PostgreSQL collation other than Dutch language

Version 3.6.0
[Date: 31 August 2021]

Development

New: documentation site
- The separate PDF manuals are merged into a single documentation site that can be viewed in your browser
- A shortcut to the new documentation site can be found in the Start menu
- Added a new Hello world tutorial
- Added new Update instructions

Third-Party component maintenance

Imaging libraries
- Updated Zstd to version 1.5.0

Version 3.5.0
[Date: 2 August 2021]

Development

New: Named Entity Recognition module
- This new module uses a trained machine
  learning model to recognize various types
  of named entities in a text document
- Language models can be downloaded
   and installed by using the new DocYard
   AI application

New: Data warehouse
- Finished batches and all associated information
  relevant for business intelligence tooling can
  now be automatically copied to the
  DocYard data warehouse
- The DocYard data warehouse makes it easy
  to use a business intelligence tool like
  Microsoft Power BI on DocYard data
- Transferring finished batches from the production
  database to the data warehouse database
  improves DocYard production performance

Retention policy for batches
- Option to automatically delete finished batches
- Option to copy finished batches to the new
  DocYard data warehouse

Form design
- Option to add multiple values to a form design
  during runtime in the form of a dictionary

DocYard AI
- Improved communication between the DocYard
  Module Manager and the DocYard AI Engine
  service by utilizing a new API

Third-Party component maintenance

Imaging libraries
- Upgrade libtiff to version 4.3.0
- Upgrade zstd to version 1.4.9

Fixes

Rasterize PDF module
- Fixed a rare situation where the Rasterize PDF
  module gave an "Unsupported data or corrupted
  file" error

Train Model module
- Fixed the issue where the Train Model module
  kept on training while the batch was already
  aborted or reset

Cockpit
- Fixed the issue with the drag and drop job import
  where DocYard incorrectly requested a workflow
  instead of a job

Version 3.4.0
[Date: 1 November 2020]

Development

Interactive Clients
- The Quality Assurance Client is now
   a 64 bit application
- The PDF Quality Assurance Client is now
  a 64 bit application
* A new license is required.
   Without it the client will be
  "Waiting for data..." forever
  after connecting to a work package
* The new license is a technical
  issue, no extra costs are charged

Cockpit
- Import, export, copy, paste, drag,
  drop or delete multiple jobs

Third-Party component maintenance

Barcode
- Upgrade to QS Barcode SDK version 5.0.1.245

Born Digital
- Upgrade to Callas PdfEngineSdk 11.1.544

Imaging libraries
- Upgrade Ghostscript to version 9.52
- Upgrade giflib to version 5.2.1
- Upgrade jpeglib to version 9d
- Upgrade libpng to version 1.6.37
- Upgrade libtiff to version 4.1.10
- Upgrade zlib to version 1.2.11

External dependencies
- DocYard is not dependent on any
  legacy Microsoft Visual C++
  Redistributables anymore

Fixes

Born Digital Conversion module
- Configuration property 'Timeout till
  abort (seconds)' stops the processing
  of a file when this timeout is exceeded
- A timeout or error in the processing
  of a file stops all affected applications
- Configuration file setting memoryOptimization
  false can prevent lengthy processing
  of the first document in the batch

Born Digital Conversion module
- Barcode recognition in large images,
  such as blueprints

Born Digital Conversion module
- Processing e-mails with group email addresses
  no longer gives an error
- A problem with corrupt attachments in
  exported MSG files has been solved

Version 3.3.0
[Date: 1 April 2020]

Development

Send API Request
- New configuration property Body Type
- Upload documents to an external Web API

Form Designer, Form Validator
- Zoom in at the mouse location:
  [Ctrl]+[MouseWheel]
- Pan the form: [Ctrl]+[Drag]
- Move redaction fields by dragging
- New Form Validator configuration
  property: Display Dimension Maximum
- Seperate Form Designer and Form
  Validator installation features

DocYard Cockpit
- Job properties dialog shows the Start
  Batches option - also after the job is aborted

Third-Party component maintenance

Born Digital
- Upgrade to Callas PdfEngineSdk 10.2.509

Email Import, Rasterize Email
- MailKit and MsgKit replace ComponentPro
- Server type POP3 available again in the
  Email import module
- Problems with special characters in email
  subject and body solved

PostgreSQL
- Upgrade to PostgreSQL 12.0 (x64)
- Upgrade to psqlODBC 12.0
- See section Upgrade to PostgreSQL 12
  on page 18 of the user manual

OCR, Freeform Recognition
- Upgrade to ABBYY FineReader Engine 11.1.19.102

Fixes

Scheduling
- Resume after Pause does not freeze
  workflows with interactive clients anymore

Version 3.2.5
[Date: 1 July 2019]

Development

A new PDF Extract Images module>
- This module extracts text from a searchable PDF containing a selectable text layer. The module can output the extracted text as a plain text file via the plain text output channel.

The OCR module has a new property named “Write OCR result to metadata”>
- Once enabled, the module will write the OCR result in plain text format to a metadata field. This metadata can then be easily accessed from macros in downstream modules

The Text Classification module and the Named Entity Recognition module have a new Plain text hook. ”>
- The hook's return value is utilized for classification tasks, eliminating the need for a plain text input object. This can be useful, for example, if you want to categorize objects based on plain text stored in a metadata field or as index value

In the cockpit we added an File > Close workflow menu item to close an active workflow. ”>
- If there are unsaved changes, the user will receive a prompt to save them or discard them if desired

Increase the time-out for the SQL command that deletes finished batches>
- The time-out is increased from 30 seconds to 10 minutes and make the amount configurable

Fixes

Rasterize PDF module>
- Fix a problem where modules working with a lot of objects, such as the Rasterize PDF module that rasterizes a large PDF into single page output, result in an error when suspending the task/batch. See also Task suspension failed
Macro repository >
- Functions exported from the macro repository now retain their indentation

<h3>Third-Party component maintenance</h3>

<em><strong>Third-Party component</strong></em>
- Update Aspose.BarCode to 23.10.0
- Update Aspose.Pdf to 23.10.0
- Update Pdfium.Net.SDK 4.87.2704

Version 3.2.4
[Date: 8 March 2019]

Development

Text Classification Module
- Built in Item Assignment
- Built in Synchronization
- Post Prediction hook
- Certainty Treshold property
- IsCertain metadata field
- Uncertain Classifications output channel

Cockpit
- The Task Activity tab now prefixes the name of
  each task with that of its job
- Status options drop down menu with Task Activity
  Filter that restricts the Task Activity
  view to specific tasks

Track & Trace
- Barcodes can be printed for both automatically
  generated and manually set item identifications

Fixes

- Invalid Operation exception in the
  Rasterize Email module
- Reverted POP3 support for the Email Import
  Module to prevent IMAP bugs

General

- Windows Server 2019 supported

Version 3.2.3
[Date: 5 December 2018]

Development

New: Text Classification with
Artificial Intelligence (AI) technology

- DocYard AI Engine Service
- Train Model module. Train a model from training
  data using machine learning. This trained model is
  needed by the Text Classification module
- Text Classification module. Predict the category of
  text documents using machine learning
- Sample text classification dataset and
  workflow templates
- A separate DocYard Text Classification Manual

Other
- Improvement of the GUI of
  Form Fields in the Form Designer
- POP3 support for the Email Import Module

Return to top

Fixes

- Fix for the Job Reports Generator
- Various small bug fixes
- Decreasing the loading time of the Form Validator

Version 3.2.2
[Date: 9 November 2018]

Development

- Improvements in the Anonymizer Module
- Quality Assurance Client saves personal window settings
- Improvement of the loading time of the
  Quality Assurance Client
- Various other small improvements
  Quality Assurance Client
- Modification of the Module List in the Cockpit
- FormValidator Rectangular Zoom Feature
- Ability to zoom in at A0 drawings in the FormValidator
- Various other improvements FormValidator

Return to top

Fixes

- Fix for Microsoft SQL Server
- Bug fix of the Email Rasterizer
- The total item type counters for job reports
  use the start- and end date filters
- Workflow templates updated
- Fix in the 2D (QR) Barcode module
- FormDesigner small fixes

Version 3.2.1
[Date: 26 September 2018]

Development

- A new FormDesigner content constraint 'IndexValue'
  provides a reference to a regular expression hook
  in the FreeForm Recognition module
- The new FormDesigner constraint option 'Many Search'
  allows for finding all occurrences of a search
  expression on a page
- The Cockpit & Clients installer now includes the
  Form Validator

Return to top

Fixes

- The index fields are shown in the Goods Received -
  and Track and Trace Clients again
- The documentation concerning the 2D
  (QR) Barcode Module is extended
- Jobs and workflows with euro signs (€) and
  umlauts of 3.0 workflows can be imported
  correctly

Version 3.2.0
[Date: 1 August 2018]

General

- New module Anonymizer. This module can remove OCR text
  from selected areas
- Microsoft SQL Server fix
- Updated the QS-Barcode Library to latest version 5.0.0.231
- The used ABBYY FineReader format is version 10
- DocYard comes with a new set of European ABBYY languages
- Barcode Printing in the Goods Received- and the Track and Trace client
- Automatic extension recognition in the File System Export module
  for EML and MSG files
- DocYard is built by the Visual Studio 2017 compiler
- The target framework of DocYard is .NET Framework 4.7.1

DocYard Web Service
- A RetrieveFile requests without an OutputDirectory metadata key
  attribute now reports a D0012 error before the
  batch starts
- A RetrieveFile request without metadata attribute now reports a
  D0012 error before the batch starts
- Removed the obsolete ExternalWeb Client section in
  DocYardWebService.exe.config
- A RetrieveFile request without metadata attribute now reports a
  D0012 error before the batch starts

Return to top

Version 3.1.5
[Date: 29 March 2018]

Development

- Email Importer Module bug fix for MSG Outlook Item creation
- The Installer as well as DocYard Cockpit show an error if the
  version of PowerShell is not high enough
- Various small bug fixes

Return to top

Version 3.1.4
[Date: 23 March 2018]

DocYard Web Service adaptations

- The WebExport module sends StoreResult request that
  contains all information of the preceding
  RetrieveFile request
- The ReportError request that the WebImport
  module sends if a batch finishes by an error contains
  all information of the preceding
  RetrieveFile request

Return to top

Fixes

- Module FileSystemExport does not throw an
  error anymore when property File extension is not set
- The Cockpit stays responsive after batches are filtered
- DocYard is able to read bitmaps that have a
  transparency layer

Log Rotation for the Module Manager

- Like Master.log the log of the ModuleMagers can
  be configured with a MaxLogFileSize and a
  ';MaxLogFileCount
- Sample file C:\Program Files (x86)\
  DocYard\DocYard\Samples\ModuleManagerConfig.xml
  contains these new settings

Version 3.1.2
[Date: 22 February 2018]

General

- Improved the visualization of email objects
  in the Quality Assurance Module
- The Create Compound Module is now able to create
  an Email Hierarchy with bodies and attachments
- The PDF Rasterize Module is now able to
  render damaged PDF files
- Fixed importing DocYard 3.0 and
  earlier Macro Repositories
- Various small improvements and bugfixes

Return to top

Extended functionality of the Email Import Module

- Capability of creating dedicated Email objects
- Enhanced permanent monitoring feature
- Included the most recent API of ComponentPro
  Mail-expert

Extended functionality of the Email Rasterize Module

- Creates a well-readable email header layout
- Able to render emails with text formatting
  and embedded images

Version 3.1.1
[Date: 15 January 2018]

Development

- Web service workflows start with Web Service
  Import and end with Web Service Export
- Using the Web Import and Web Export modules
  requires a package license for each of them
- DocYard aborts conversions that exceed
  the time-out specified by the request
- DocYard reports errors in any module of
  the workflow back to the DocYard web service
- Performance improvements Batch Tree View,
  by limiting the amount of batches listed
- Remark: DocYard-Update instructions section
  "Completing the Server Update" point 4
  must be executed to make this option work

Return to top

New job configuration that will run an HTTP web service for converting documents that communicates asynchronous with customer services

- Jobs have a new batch creation option
  "From a Web Service"
- New module Web Service Import
- New module Web Service Export
- The new product DocYard Web Service forms the
  interface between Web Service jobs and customer
  web services. It comes in a separate delivery

Version 3.1.0.783
[Date: 12 September 2017]

General

- Extra features added to the Email Import module
  to limit retrieved emails and more
- The Born Digital conversion modules have a fix
- Minor fix for the 1D Barcode Recognition Module

Return to top

Version 3.1.0
[Date: 30 June 2017]

<h3>Development</h3>

<em><strong> Breaking changes in barcode recognition module</em>
We updated our barcode library, which affects how the barcode recognition modules work. This change should have a minimal impact on most users and commonly used barcode types. However, you must test all workflows that use barcode recognition modules to ensure the selected recognition mode setting still works for your specific situation. If barcodes are not recognized after upgrading, try changing the recognition mode to the setting for lower quality barcodes, which should improve recognition quality and accuracy.

<em><strong> Option to acknowledge problems </em>
We added an option to acknowledge problems (warnings and errors). Right-click on a warning or error to acknowledge the problem. When all problems are acknowledged, the job no longer shows that it contains errors or warnings

<em><strong>Multi-language support </em>
Multi-language support to the OCR (Tesseract) module
<em><strong> Read Image module </em>
Support for tiled TIFFs to the Read Image module
<em><strong> OCR tutorial</em>
Extend OCR tutorial

<h3>Fixes</h3>

<em><strong>OCR Tesseract module></em>
- Fix incorrect encoding of text when using the plain text output channel of the OCR (Tesseract) module
<em><strong> Send API Request module></em>
- Fix entities processed counter of Send API Request module

<h3>Third-Party component maintenance</h3>

<em><strong>Third-Party component</strong></em>
- Update Aspose.BarCode to 24.5.0
- Update Pdfium.Net.SDK to 4.90.2704