<< Click to Display Table of Contents >> Navigation:  Zetadocs Installation Guide > Zetadocs Server Installation > Zetadocs Server Configuration Options

 

Zetadocs Capture Essentials comes with two Document Queues setup a standard, a Sales and a Purchase Document Queue, with other custom queues available with Zetadocs Capture Plus.

 

To configure the Zetadocs Server to communicate with the document queues, these first need to be configured.

 

Note: When outputting files into the Batchsplit folder, make sure these are not streamed into the folder as Zetadocs Server will pick the file before its complete and it might deplete the Zetadocs OCR Engine license count.

 

Creating the Document Queue Network Folders

Each document queue requires a network folder. This folder is used to place captured documents for processing and conversion, and you must provide users with the relevant permissions to access this folder. For optimal use of the software, you should ensure that no process is locking or regularly accessing the files.

 

1. Create the required folders

 

• • e.g. Sales Document Queue
  • e.g. Purchase Document Queue

 

Note: Each folder name must be unique and must not start with the same work.

 

2. View its Properties and ensure the Share this Folder checkbox is checked.
3. Select the Permissions button and assign the necessary permissions:

 

 

4. Make sure that the files will be dropped into the folder as entire files.
5. For better performance, please consider adding the folder path to the white list of any file management process (i.e. anti-virus, synchronization software... ).

 

The Zetadocs Server Configuration File

The Zetadocs Server settings are modified using a Config.xml file, this is located in the Zetadocs Server installation location.

 

This is usually C:\Program Files (x86)\Zetadocs Server\Document Converter.

 

You can open this file in a text editing program such as Notepad.exe.

 

The Config.xml file contains settings which govern how documents are captured and added to document queues. It consists of instructions for each document queue configured and more general options for capturing documents.

 

We will go through those options relevant to an Essentials install in the order they appear. Users can leave  the default values unchanged for any options not described as Essentials.

 

Example

In the example below:

 

• There is a Sales and a Purchase Document Queue each inside its own <DocsQ> </DocsQ>tags.
• The general Zetadocs Server settings are below that. These Server settings apply to all queues.

 

In this section, we will go through the document queue specific options identifying what the options do and providing suggestions for recommended defaults. Please go through each in turn to ensure your system is configured properly.

 

<?xml version="1.0" encoding="utf-8"?>

<Config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

 

 <docsQueue>

    <DocsQ Description="Sales Document Queue" Location="\\User specified queue location\Sales Document Queue\" OnlineFolderLocation="Sales Document Queue">

     <EnableOcrForQueue>true</EnableOcrForQueue>

     <EnablePDFTextExtractionToFile>false</EnablePDFTextExtractionToFile>

     <BatchScanSplitType>Barcode</BatchScanSplitType>    

     <BatchScanPageInterval>1</BatchScanPageInterval>                            

     <BatchScanBarcodePrefix></BatchScanBarcodePrefix>                      

     <BatchScanBarcodeDeleteSplitPage>false</BatchScanBarcodeDeleteSplitPage>

     <FilenamePrefix></FilenamePrefix>    

  </DocsQ>

   

   <DocsQ Description="Purchase Document Queue" Location="\\User specified queue location\Purchase Document Queue\" OnlineFolderLocation="Purchase Document Queue">

     <EnableOcrForQueue>true</EnableOcrForQueue>      

     <EnablePDFTextExtractionToFile>false</EnablePDFTextExtractionToFile>

     <BatchScanSplitType>Off</BatchScanSplitType>                                

     <BatchScanPageInterval>1</BatchScanPageInterval>                                  

     <BatchScanBarcodePrefix></BatchScanBarcodePrefix>                          

     <BatchScanBarcodeDeleteSplitPage>false</BatchScanBarcodeDeleteSplitPage>

     <FilenamePrefix></FilenamePrefix>        

   </DocsQ>

 

 </docsQueue>

 

 <PDFQuality>Better</PDFQuality>

 <EnableOcr>true</EnableOcr>

 <StellentTimeOut>10</StellentTimeOut>

 <StellentBypassPDF>true</StellentBypassPDF>

 <LogLevel>Error</LogLevel>                                                      

 <LogToFile>true</LogToFile>

 <LogToEventLog>false</LogToEventLog>

 <EnableBarcodeDetection>true</EnableBarcodeDetection>

 <EnableQrProcessing>false</EnableQrProcessing>

 <GetBatchTimeForQueueing>10000</GetBatchTimeForQueueing>

 <GetRootTimeForQueueing>10000</GetRootTimeForQueueing>

 <OnlineArchivingEnabled>true</OnlineArchivingEnabled>

 <OnlineArchiveLocation>https://examples.sharepoint.com/sites/yourcollection</OnlineArchiveLocation>

 <UploadRetries>2</UploadRetries>

</Config>

 

The Zetadocs Server Config.xml file is Case Sensitive

WARNING: When setting the various options, please ensure that you copy the exact casing shown here. Failing to do so may prevent the server from working as intended.

 

Specifying Document Queue Locations in the Zetadocs Server

• Items added into the Document Queue folders will be processed and converted to PDF/A format.
• Document Queue folders should be folders on the local machine where the Zetadocs Server is installed.
• The folder should then be shared on the network for Document Queue users to access.  

 

Sample Code

<DocsQ Description="Sales Document Queue" Location="\\User specified queue location\Sales Document Queue\" OnlineFolderLocation="Sales Document Queue">

 

Options

 

Enable OCR For Queue

• This option allows you to turn OCR on/off per queue so that you only use it when needed.
• If you don't have the Zetadocs OCR Engine installed then you should leave this as false.

 

Sample Code:

<EnableOcrForQueue>true</EnableOcrForQueue>

 

Options

 

Batch Scanning Settings

• Each document queue can be configured to use only one type of splitting method when processing batches of documents.
• Select from the options below depending on how you wish to split batches, if at all.

 

Sample Code:

<BatchScanSplitType>Off</BatchScanSplitType>    

 

Options

 

Configuring the Page Interval

This value determines the page interval number to be used when processing a document using the PageInterval splitting method described above.

 

Sample Code

<BatchScanPageInterval>1</BatchScanPageInterval>    

 

Options

• The page interval can be any positive whole number value (integer) e.g. 1,2,5,10,20 etc. The batch will then be split into documents each that number of pages.
• For those not using page interval splitting, we recommend adding the value 1, as this will be ignored unless the BatchScanSplitType has been set to PageInterval.

 

File Name Prefix

• It is often useful to be able to identify which Document Queue a document originated from following the conversion and queue processing.
• The file name prefix settings allows you to prefix all files processed by a queue. For example, a prefix setting of “SDQ_” in the Sales Document Queue would result in a document “Sample.doc” becoming “SDQ_Sample.pdf” after conversion to PDF.

 

Sample Code

<FilenamePrefix></FilenamePrefix>

 

Options

• The default is no prefix.
• To set a prefix put the appropriate prefix in the setting for the desired queue.
• We recommend that the prefix value be less than 10 characters and the following characters are not allowed:

 

# % & * : < > ? / { | } ~ " '

 

General Capture Options

The general capture options for the Zetadocs Server are located at the bottom of the config.xml and contain the options listed below. These are applied to all captured documents regardless of the document queue settings.

 

Adjusting the PDF Quality

The quality of the PDFs the Zetadocs Server produces during conversion can be adjusted to meet your requirements of file size, quality and conversion speed.

 

Sample Code

<PDFQuality>Better</PDFQuality>

 

Options

 

StellentTimeOut Option

Stellent is a component that helps with PDF conversion. This setting determines the duration Zetadocs will wait before assuming it has a problem and aborting the conversion.

 

Sample Code

<StellentTimeOut>10</StellentTimeOut>

 

Options

We recommend that this setting is left at its current default of 10.

 

StellentBypassPDF Option

This option causes the Zetadocs Server to bypass PDF files added to the conversion folder rather than convert them again. They are instead simply copied to the converted folder, which can result in the Server operating more quickly on a given batch of documents.

 

Note: The PDF files may not be in the specific PDF/A format generated by the Server.

 

Sample Code

<StellentBypassPDF>true</StellentBypassPDF>

 

Options

 

Adjusting the Logging Level

The logging level options can normally be left set to error, with the other options only used in troubleshooting and support cases.

 

Sample Code

<LogLevel>Error</LogLevel>      

 

Options

 

Specifying the Log Location

The Zetadocs Server log can be set to save to a file and/or the event log. This is done using the two options <LogToFile> and <LogToEventLog>. Using these options is is possible to set Zetadocs to log to either a file or the event log or neither.

 

The Zetadocs Server log file is written to:

 

C:\Users\pgreen\AppData\Local\Temp\Zetadocs\

 

Sample Code

 <LogToFile>true</LogToFile>

 <LogToEventLog>false</LogToEventLog>

 

The above code would result in the log being kept in Zetadocs Server log file.

 

Options

Each of the can be set to either true or false, we recommend that you have one or the other forms of logging active at all times.

 

Batch Queuing Time

This setting determines the duration (in milliseconds) Zetadocs will wait before assuming it has a problem and aborting the conversion, when converting files in the Batch Split folder

 

Sample Code

<GetBatchTimeForQueueing>10000</GetBatchTimeForQueueing>

 

Options

We recommend that this setting is left at its current default of 10000.

 

Root Queuing Time

This setting determines the duration (in milliseconds) Zetadocs will wait before assuming it has a problem and aborting the conversion, when converting files in the document queue's root folder

 

Sample Code

<GetRootTimeForQueueing>10000</GetRootTimeForQueueing>

 

Options

We recommend that this setting is left at its current default of 10000.

 

Online Archiving Enabled

This setting determines if the files will be uploaded to the specified SharePoint site.

 

Sample Code

<OnlineArchivingEnabled>true</OnlineArchivingEnabled>

 

Options

This setting must be set to true for Document Queues in the Cloud.

 

Online Archive Location

This setting determines the SharePoint site that the document queue files will be uploaded to.

 

Sample Code

<OnlineArchiveLocation>https://examples.sharepoint.com/sites/yourcollection</OnlineArchiveLocation>

 

Options

This should already have been entered after successfully running the Zetadocs Server Configuration Tool

 

Upload Retries

This setting determines the number of retry attempts that will be made when uploading files to SharePoint, before moving on to other files.

 

Sample Code

<UploadRetries>2</UploadRetries>

 

Options

We recommend that this setting is left at its default value of 2.

 

Starting the Zetadocs Document Converter Service

Save the updated Config.xml file when you have finished making your changes. To implement the changes you have made, you need to start the Zetadocs Server.

 

To start the Zetadocs Server:

 

1. Go to Start > Run. Then enter Services.msc.
2. Scroll to Zetadocs Document Converter.
3. Right click on Zetadocs Document Converter, and select properties, and then the Log On tab.
4. Enter in the username and password forthe account you are currently logged in as and click Ok.
5. Start the Zetadocs Document Converter Service..

 

Next Step

That completes the Document Queue Options for a single document queue, this process should be repeated for all subsequent queues before continuing on to the Zetadocs Document Queue Settings in Business Central.