White Paper Fabasoft Integration for Kofax Capture Fabasoft Folio 2017 R1 Update Rollup 2
Copyright Fabasoft R&D GmbH, Linz, Austria, 2018. All rights reserved. All hardware and software names used are registered trade names and/or registered trademarks of the respective manufacturers. No rights to our software or our professional services, or results of our professional services, or other protected rights can be based on the handing over and presentation of these documents. Fabasoft Integration for Kofax Capture 2
Contents 1 Introduction 4 2 Software Requirements 4 3 Integration of Kofax Capture into Fabasoft Folio 4 3.1 Installation of the MSI Package 4 3.2 Installation of Kofax Capture Export Connector 4 4 Example: Capture of Generic Contents 6 4.1 Create a New Batch Class 6 4.2 Create a New Document Class 8 4.3 Create a New Form Type 8 4.4 Define and Configure the Export Connector 9 4.5 Publish a Batch Class 12 4.6 Create and Process a New Batch 13 5 Example: Capture of PDF Contents 18 Fabasoft Integration for Kofax Capture 3
1 Introduction The Fabasoft Folio offers the possibility of an integration of Kofax Capture. Thereby scanned documents, or by Kofax Capture generated PDF documents can be imported to Fabasoft Folio. 2 Software Requirements System environment: All information contained in this document implicitly assumes a Microsoft Windows environment. Supported platforms: For detailed information on supported operating systems and software see the software product information on the Fabasoft distribution media. Descriptions in this document are based on the following software: Microsoft Windows Server 2016 Standard Microsoft XML Core Services 6.0 SP2 Kofax Capture 10.0.2 3 Integration of Kofax Capture into Fabasoft Folio 3.1 Installation of the MSI Package The following MSI package has to be installed on the client: Setup\ComponentsWeb\Client\FolioClientKofax.msi Note: The MSI package can also be found on the web server: http://<computername>/<virtual directory>/fscasp/content/lib/folioclientkofax.msi The fscvrl.inf (the export connector), fscvrl_fsc.inf (legacy export connector) and the fscvrl.dll file are copied into the Fabasoft\Folio\WebClient directory. Note: The legacy Fabasoft Components export connector fscvrl_fsc.inf can be used for existing batch classes that reference this connector. 3.2 Installation of Kofax Capture Export Connector In the administration tool of Kofax Capture the export connector can be installed, therefore perform the following steps: 1. Execute the command Start > All Programs > Kofax Capture 10.0 > Administration. Fabasoft Integration for Kofax Capture 4
2. On the Tools tab click Export Connectors. 3. In the following dialog select the Database Export Connector entry and click Add. 4. Navigate to the fscvrl.inf file in the Fabasoft\Folio\WebClient directory and click Open. 5. The Add Export Connectors dialog is opened. Select Fabasoft Folio and click Install. 6. The successful registration is viewed in a dialog box. Click OK and close the Add Export Connectors dialog. Fabasoft Integration for Kofax Capture 5
The Fabasoft Folio export connector has been added to the Export Connector Manager. The essential installation steps for the integration of Kofax Capture into Fabasoft Folio are finished. The following chapters show possible applications for the use of this integration. 4 Example: Capture of Generic Contents This example shows how to create generic contents and transfer those into Fabasoft Folio by using the integration of Kofax Capture. 4.1 Create a New Batch Class To create a new batch class, perform the following steps: 1. In the administration tool of Kofax Capture click the Kofax button and execute the Create Batch Class command. Fabasoft Integration for Kofax Capture 6
2. In the following dialog the Name and a Description for the new batch class can be defined. Note: The path for the Image folder has to be equal for all scan stations. 3. Click the Queues tab and select the Scan and the Export entries in the Available Queues field. Click Add to add these queues to the Selected Queues field. For this batch class the queues Scan and Export are selected. 4. Click OK. Fabasoft Integration for Kofax Capture 7
4.2 Create a New Document Class To create a new document class, perform the following steps: 1. Right-click the newly created batch class and click New Document Class. 2. In the following dialog the Name and a Description for the new document class can be defined. 3. Click OK. 4.3 Create a New Form Type To create a new form type, perform the following steps: 1. Right-click the newly created document class and click New Form Type. Fabasoft Integration for Kofax Capture 8
2. In the following dialog the Name and a Description for the new form type can be defined. 3. Click OK. 4.4 Define and Configure the Export Connector To define and configure the export connector, perform the following steps: 1. Right-click the newly created document class and click Export Connectors. 2. Select Fabasoft Folio in the Available Export Connectors field and click Add to add this export connector to the Assigned Export Connectors field. 3. An authentication of the user is performed in Fabasoft Folio. Note: The information for a connection to a Fabasoft Folio Web Service is read out form the Microsoft Windows Registry. Make sure, the HKEY_CURRENT_USER\Software\Fabasoft\StubManager entry is available. This entry is created by the Fabasoft Folio Client when opening a content object. Fabasoft Integration for Kofax Capture 9
4. After a successful log-in the following properties can be defined on the Release Definition tab. o Server URL In this field the URL of the Fabasoft Folio Web Service is defined (i.e. http://<computername><virtualdirectory>) o Object In this field a Fabasoft app.ducx Expression is defined that has to provide an object. Using this Fabasoft app.ducx Expression an already existing object can be established or a new object can be created. The global scope of the expression s evaluation contains a DICTIONARY with index values (rawvalues), whereby an identifier (key) is assigned to a value (value). Values are defined, e.g. in form of index fields of the document class. Note: For capturing of generic contents the object class Content (GENCONT@1.1:ContentObject) can be used. Using the following expression a new object of this object class is created: #GENCONT@1.1:ContentObject.COOSYSTEM@1.1:ObjectCreate()[2] o Links In this field links can be defined. Thereby variables, values or indices are assigned to properties of the created or determined object in Fabasoft Folio. Note: Ensure that each link works independently of the link order. The execution sequence may change arbitrarily. For the definition of these links Fabasoft app.ducx Expressions are used. For evaluating these expressions, the following values are available in the global scope: srcvalue (Value based on Index, Batch, Batch variable or Constant, this value is always a STRING) value (converted value after Value (Manipulation), if this is defined). o The following fields are available in the Links field, when creating a new entry: Destination In this field a Fabasoft app.ducx Expression is defined, which e.g. provides a property of the newly created or determined object in Fabasoft Folio, in which a value should be saved. Fabasoft Integration for Kofax Capture 10
Example: COODI@1.1001:scanid=::value ::value is calculated of Index, Batch, Batch variable or Constant, depends on the definition. ::value is the converted value of ::srcvalue. If no conversion is defined ::value is the same as::srcvalue. Value (Manipulation) In this field an optional Fabasoft app.ducx Expression can be defined, which converts/manipulates ::value. Index In this field a defined index value is entered. This value is defined in the properties of a document class in Kofax Capture in the Index Fields field. Example: Batch In this field a batch value can be defined. This value is defined in the properties of a batch class in Kofax Capture in the Batch Fields field. Example: Batch Variable In this field a predefined batch variable can be entered. Constant This field is used for defining any constant. o Initialization In this field initialization values for the created or determined object can be defined. o Finally In this field a Fabasoft app.ducx Expression can be defined that evaluates whether additional actions should take place with the created or determined object. Fabasoft Integration for Kofax Capture 11
5. Click the Contents tab. The following properties can be defined: o Image Type Select the desired image type. For example Multipage TIFF CCITT Group 4. o Content Property Path (Image) In this field you have to select the property, which specifies the content of the image. For example select the File property. 6. Click Next to save the settings. The configuration of the export connector is now completed. Note: To adjust or change these settings, select the export connector in the field of the assigned export connectors and click Setup. 4.5 Publish a Batch Class To publish a batch class, perform the following steps: 1. Right-click the created batch class and click Publish. 2. Click Validate to test the integrity of the batch class. 3. Completing the validation without errors, the batch class can be approved for use. Click Publish. Fabasoft Integration for Kofax Capture 12
Note: A published batch class is marked by a changed icon. When changing the batch class again, another publishing process is necessary. Close the administration tool of Kofax Capture. 4.6 Create and Process a New Batch The published batch class can be used for creating new batch tasks. Therefore perform the following steps: 1. Execute the command Start > All Programs > Kofax Capture 10.0 > Batch Manager. 2. Click the Kofax button and click Create Batch. 3. In this dialog the Name field of the new batch is predefined with the current time. The name of the batch can be changed. In the Description field a description for the new batch can be Fabasoft Integration for Kofax Capture 13
entered. 4. Click Save. 5. Click Close. The newly created batch has been added to the batch manager. To process the new batch, perform the following steps: 1. Click the Kofax button and click Process Batch. First the Scan program is opened, because when creating the batch class two queues have been defined ( Scan and Export ). Fabasoft Integration for Kofax Capture 14
2. In the Source field select the scanner. Select the Software Import entry, for importing already scanned documents that are stored in the file system. 3. Click Scan All, to initialize the scan process. Fabasoft Integration for Kofax Capture 15
4. The documents are viewed after the scanning process. 5. The scanned documents have to be prepared for the export. Right-click the images and click Create Document. Note: The command can be executed for multiple images at the same time or for each image separately. So the scanned documents can be grouped into more batches. For each batch an object is created in Fabasoft Folio. Fabasoft Integration for Kofax Capture 16
In this example all pages are stored in one document: 6. Click Close, to complete the scanning process. Click Yes to confirm the dialog. In the batch manager the batch is ready for the second step: the export. To continue with the export, perform the following steps: 1. On the Kofax button click Process Batch. 2. An authentication of the user is performed in Fabasoft Folio. The export occurs according to the configuration in the export connector (see chapter 4.4 Define and Configure the Export Connector ). Fabasoft Integration for Kofax Capture 17
5 Example: Capture of PDF Contents Kofax Capture provides the possibility to create documents in PDF format and transfer those documents into Fabasoft Folio. Perform the following steps to configure the capture of PDF contents: 1. Click Start > All Programs > Kofax Capture 10.0 > Administration. 2. Right-click a batch class and then click Properties. Note: For more information on creating a batch class see chapter 4.1 Create a New Batch Class. 3. Click the Queues tab. 4. In the Available Queues field, select the PDF Generator and the Export entry. Click Add to add the queue to the Selected Queues field. Fabasoft Integration for Kofax Capture 18
5. Click the Advanced tab. Under Import Options, select Allow import of edocument files. 6. Click OK. 7. Right-click a document class and then click Properties. Note: For more information on creating a document class see chapter 4.2 Create a New Document Class. Fabasoft Integration for Kofax Capture 19
8. Click the PDF tab and select Enable Kofax PDF generation. 9. Click OK. When defining the configuration for the export connector several settings can be made. To configure the export connector for capturing PDF contents perform the following steps: 1. Right-click the document class and then click Export Connectors. Fabasoft Integration for Kofax Capture 20
2. In the Assigned Export Connectors field, select the Fabasoft Folio entry. Click Setup. 3. An authentication of the user is performed in Fabasoft Folio. After a successful log-in the settings can be changed. Note: Additional information about the configuration of the export connector can be found in chapter 4.4 Define and Configure the Export Connector. 4. On the Release Definition tab, in the Object field, type a Fabasoft app.ducx Expression that creates a new or determines an existing PDF object. Example: #FSCACROBAT@1.1:PDFObject.COOSYSTEM@1.1:ObjectCreate()[2] 5. Click the PDF tab. Following settings can be defined: o PDF Object In this field a Fabasoft app.ducx Expression can be defined that returns a PDF object. In the global scope the variable relobj is defined that is computed with the Fabasoft app.ducx Expression defined in the Object field on the Release Definition tab. o PDF Initialization In this field initialization values for the created or determined PDF object can be defined. Fabasoft Integration for Kofax Capture 21
In the global scope of the Value field following variables are defined: context (extension of the content) cont (content of COOSYSTEM@1.1:content) In the global scope of the Destination field following variables are defined: context (extension of the content) cont (content of COOSYSTEM@1.1:content) value (value of the computed Value) o Finally (PDF) In this field a Fabasoft app.ducx Expression can be defined that evaluates whether additional actions should take place with the created or determined PDF object. In the local scope the PDF object is available. Example: To put the PDF object on the desk of the user following Fabasoft app.ducx Expression can be defined: COODESK@1.1:ShareObject(,,#COOSYSTEM@1.1:objchildren, coort.getcurrentuserroot()) 6. The batch class can now be published (see chapter 4.5 Publish a Batch Class ) and a new batch can be created and processed (see chapter 4.6 Create and Process a New Batch ). Fabasoft Integration for Kofax Capture 22