Configuration 
KCIC 
Advanced Email and Fax Administrator's Guide 
21
When a field is mapped to a Kofax Capture field, it will be automatically populated with the 
proper value. 
The message fields mapping can be configured in KC Plug-In, for each destination. Refer to 
Configuring Destination for Imported Messages. 
Message field 
Description 
KfxOriginatorService 
The service name of the originator. In case of fax FAX and in case 
of email EMAIL. 
KfxOriginatorNumber 
The fax number  of the originator (caller ID) or originator email 
(mime-header/from/mailbox/address) for POP3/SMTP mail. 
KfxOriginatorName 
The full name of the message originator. For faxes, this is the TSI. 
For SMTP and POP3, it’s the originator display name (mime-
header/from/mailbox/displayname). 
KfxRecipientService 
The service name of the recipient. In case of fax FAX and in case 
of email EMAIL. 
KfxRecipientNumber 
The recipient fax number (called party number) or email address 
(for SMTP it’s the first active email recipient, for POP3 the 
mailbox user name). 
KfxRecipientName 
The full name of the message recipient. For POP3, this is the 
mailbox display name. 
KfxMessageCorrelation 
The correlation information of the message (for internal use). 
KfxMessageID 
The unique ID of the message given by the Message Connector 
on message arrival. 
KfxMessageSubject 
The subject of the message. For faxes, this is ―Fax from ― + TSI. 
KfxMessageReceptionTimeCreated 
The time when the Message Connector retrieved the message 
represented in UTC format. 
KfxMessagePages 
The number of fax pages in the message. 
KfxMessageDeliveryType 
The type of delivery of the message. Reserved for future use. 
Currently static string ―TO‖. 
KfxMessageDeliveryPriority 
The priority of the message. Reserved for future use. Currently 
static value ―1‖. 
KfxMessageDeliverySuspectedDupli 
Reserved for future use. Currently static value ―0‖. 
The message extension fields are reserved for future versions. 
Pdf to tiff converter open source c# - application SDK tool:C# PDF Convert to Tiff SDK: Convert PDF to tiff images in C#.net, ASP.NET MVC, Ajax, WinForms, WPF
Online C# Tutorial for How to Convert PDF File to Tiff Image File
www.rasteredge.com
Pdf to tiff converter open source c# - application SDK tool:VB.NET PDF Convert to Tiff SDK: Convert PDF to tiff images in vb.net, ASP.NET MVC, Ajax, WinForms, WPF
Free VB.NET Guide to Render and Convert PDF Document to TIFF
www.rasteredge.com
application SDK tool:C# PDF Text Extract Library: extract text content from PDF file in
it is feasible for users to extract text content from source PDF document file the following C# example code for text extraction from PDF page Open a document
www.rasteredge.com
application SDK tool:C# PDF Page Extract Library: copy, paste, cut PDF pages in C#.net
Online C# source code for extracting, copying and pasting PDF The portable document format, known as PDF document, is of file that allows users to open & read
www.rasteredge.com
KCIC 
Advanced Email and Fax Administrator's Guide 
23
Chapter 4 
Operation and Maintenance 
Message Connector Status Monitor 
Kofax Capture Import Connector – Advanced Email and Fax – Message Connector provides a 
monitoring interface with the following main functions: 
Sending test messages 
Viewing messages in storage 
Managing failed messages 
Monitoring Message Connector status 
Sending Test Messages 
Use this section if you want to verify the functionality of the KCIC – Advanced Email and Fax – 
Message Connector by sending a test fax or email. Both tests work by sending a message in a 
loop (Message Connector -> Message Connector). KC Plug-In will then import the message to 
Kofax Capture. 
To send a test fax 
Launch Message Connector Monitor from the Start menu (Programs | Kofax | KCIC – 
Advanced Email and Fax). 
On the menu, click Test Fax. 
In the ―Number to Dial‖, type a number. For a test message this can be any number. 
Click Send Fax. 
Check for ―Server returned ok‖. 
On the menu, click Outbound | Processed. After some time you will find the sent fax. 
Optionally, you can click Inbound | Pending and view the message there, if the KCIC – 
Advanced Email and Fax – KC Plug-In service is not running. Otherwise, you will find the test 
fax in Inbound | Processed. 
To send a test email 
Launch Message Connector Monitor from the Start menu (Programs | Kofax | KCIC – 
Advanced Email and Fax). 
On the menu, click Test Email. 
In the To field, type an email address. For a test message this can be any email address. 
Click Send Email. 
Check for ―Server returned ok‖. 
Viewing Messages  
Use this section if you want to view messages that are still located in the storage of the KCIC – 
Advanced Email and Fax – Message Connector. 
application SDK tool:C# PDF File Merge Library: Merge, append PDF files in C#.net, ASP.
Free online C#.NET source code for combining multiple PDF pages together in .NET framework. Combine scanned images to PDF, such as tiff, jpg, png, gif, bmp
www.rasteredge.com
application SDK tool:C# PDF: PDF Document Viewer & Reader SDK for Windows Forms
in different display formats, and save source PDF file using file to a specified path in C# WinForms application visible page in the currently open PDF document
www.rasteredge.com
Chapter 4 
24
KCIC 
Advanced Email and Fax Administrator's Guide 
To view messages 
Launch Message Connector Monitor from the Start menu (Programs | Kofax | KCIC – 
Advanced Email and Fax). 
On the menu, go to any of the storage folders (inbound or outbound). 
Select the message and click View/Save 
Email messages are available as EML files and can be displayed with Outlook Express or 
Windows Live Mail or any other mail client that supports EML. Fax messages are available in 
multipage TIFF format (a special viewer might be required to view this format properly). 
Note  You can also view EML files in Microsoft Outlook. In Outlook 2007, please follow these 
instructions: http://support.microsoft.com/kb/956693
. Outlook 2010 can open these files 
without any additional effort. 
Managing Failed Messages Manually 
Use this section if you want to manually manage messages that could not be delivered to Kofax 
Capture. Depending on the Keep Failed configuration, problematic messages can be found either 
in the storage folder Inbound | Active | Failures or Inbound | Processed | Failures.  
In particular, it is important to monitor the Inbound | Active | Failures folder, as messages in 
this folder can potentially fill in the entire storage. 
To reactivate messages 
Launch Message Connector Monitor from the Start menu (Programs | Kofax | KCIC – 
Advanced Email and Fax). 
On the menu, click Inbound | Active | Failures. 
You can view the contents of a message to investigate the problem (click View/Save  ). 
Then either reactivate the message 
or to delete it  . A reactivated message is moved 
back to the Inbound | Active folder. A deleted message is moved to folder Inbound | 
Processed | Failures. 
Messages in the Inbound | Processed | Failures folder are already marked for deletion. When the 
storage gets too full, these messages are lost. However, as long as they are available, you can 
attempt to rerun them, i.e., create a copy of the message in the Inbound | Active folder (as if it 
had just arrived). 
To rerun messages 
Launch Message Connector Monitor from the Start menu (Programs | Kofax | KCIC – 
Advanced Email and Fax). 
On the menu, click Inbound | Processed | Failures. 
You can view the contents of a message to investigate the problem (click View/Save  ). 
You cannot delete these messages; they are already deleted. However, you can try to rerun the 
message  . A copy of this message is created in the Inbound | Active folder. 
Monitoring the Status of the Message Connector 
Use this section if you want to display the status of the KCIC – Advanced Email and Fax – 
Message Connector and its internal components. 
application SDK tool:C# Create PDF from OpenOffice to convert odt, odp files to PDF in
Best C# OpenOffice to adobe PDF file converter SDK for Visual Online source code for C#.NET class. Description: Convert to PDF/TIFF and save it on the disk.
www.rasteredge.com
application SDK tool:VB.NET PDF Annotate Library: Draw, edit PDF annotation, markups in
Decode source PDF document file into an in-memory object, namely 2.pdf" Dim outputFilePath As String = Program.RootPath + "\\" Annot_8.pdf" ' open a PDF file
www.rasteredge.com
Operation and Maintenance 
KCIC 
Advanced Email and Fax Administrator's Guide 
25
To display the status 
Launch Message Connector Monitor from the Start menu (Programs | Kofax | KCIC – 
Advanced Email and Fax). 
On the menu, click Status. 
In the right Monitor for MC frame, you can see the status of the KCIC – Advanced Email and 
Fax – Message Connector. 
Log Files 
KCIC – Advanced Email and Fax provides log files that can help with troubleshooting. Log files 
are stored in the application / program data folder of all users. The exact path (<path>) depends 
on the operating system: 
C:\Documents and Settings\All Users\Application Data\Kofax\KCIC-AEF (Windows Server 
2003 and Windows XP) 
C:\ProgramData\Kofax\KCIC-AEF (Windows Server 2008, Windows Vista and later) 
To configure logging in KCIC – Advanced Email and Fax – Message Connector 
Launch Message Connector Configuration from the Start menu (Programs | Kofax | KCIC – 
Advanced Email and Fax). 
Click Advanced to display additional configuration options. 
Edit the settings in the Advanced tab. 
The default values (TraceLevel 10 and MessageTraceSize 1) provide basic trace information 
(that is often sufficient) without negatively impacting performance. Troubleshooting values 
(TraceLevel 40 and MessageTraceSize 100000) provide lot of information; these are more 
suitable when duplicating error situations in controlled environment. 
Refer to Message Connector Help for more information about the parameters. 
Find log files in <path>\MC\log. 
Click Save, then click ―Exit and restart service‖. 
To configure logging in KCIC – Advanced Email and Fax – KC Plug-In 
Go to the folder <path>\KC Plug-In\logconfig. 
Open the file log4net.config in a text editor. 
Edit the line starting with ―<level value=‖. Use ―INFO‖ for normal operation; use ―DEBUG‖ 
for troubleshooting. 
Find log files in <path>\KC Plug-In\log. 
Restart the KC Plug-In service to make the changes effective. 
application SDK tool:C# PDF Convert to Text SDK: Convert PDF to txt files in C#.net
RasterEdge.XDoc.Office.Inner.Office03.dll. RasterEdge.XDoc.PDF.dll. RasterEdge.XDoc. PowerPoint.dll. RasterEdge.XDoc.TIFF.dll. using RasterEdge.XDoc.Converter;
www.rasteredge.com
application SDK tool:C# PDF Convert to Jpeg SDK: Convert PDF to JPEG images in C#.net
Open source codes can be added to C# class. When using RasterEdge PDF to JPEG converter library control SDK, C# developers may customize the names of all
www.rasteredge.com
application SDK tool:VB.NET PDF File Split Library: Split, seperate PDF into multiple
Separate source PDF document file by defined page range in VB.NET class application. Divide PDF file into multiple files by outputting PDF file size.
www.rasteredge.com
KCIC 
Advanced Email and Fax Administrator's Guide 
27
Chapter 5 
Scripting Interface 
The KC Plug-In module contains a custom scripting interface that allows customizing how 
messages are imported into Kofax Capture. This is done via C# scripts. When configured, scripts 
run just before the content is imported into Kofax Capture and can modify or add field values or 
alter the binary content of the files, discard or add new binary content, or do any other alteration 
to the message fields or content. Additionally, scripts can e.g. make a call to a database to validate 
or look up data and then add looked up values to document or batch fields, or if desired abort 
message import and inform the Message Connector that a message has been rejected. 
The KC Plug-In module can use: 
scripts to create specific batch names 
custom document scripts to perform specific actions on the message fields or content before 
the message is imported into Kofax Capture.  
In addition to the KC Plug-In, a scripting DLL and a sample Visual Studio 2008 project are 
provided. These enable you to create, run, and test your scripts in Visual Studio before you 
deploy them to the KC Plug-In. Please note that the provided DLL is only for making debugging 
easier, neither the DLL nor Visual Studio are required to create scripts. Scripts do not have to be 
compiled before deployment. You can also create scripts in any text editor. 
The sample project is located in: 
<programs>\Kofax\KCIC-AEF\KC Plug-In\ScriptSample (assuming default installation) 
The scripts, though written in C#, do not need to be compiled. You just have to configure the 
path to your script source file in the KC Plug-In configuration. When the plug-in starts, it will 
build the script on the fly and run it before your messages are imported or to get a batch name 
just before the batch is created. 
The batch naming script has to implement a special IBatchNameFormatter interface. If an error 
occurs in the script, the connector writes the error to a log file and the default batch naming 
configured in the batch class is used. If the script is not configured the default batch name 
configured in the Kofax Capture batch class is used. 
The custom document script has to implement a special IDocumentScript2 interface. It runs just 
before a message is imported into Kofax Capture. In the script, you can make any desired 
changes to the document content. 
Adding References to Your Scripts 
To add a reference to an assembly that is already in path, add a line beginning with //GAC: 
followed by the DLL names delimited by comma as a first line to your script. 
//GAC:System.Data.dll 
To add references to any other assemblies, add a line beginning with //ref: followed by the full 
paths to your DLLs delimited by comma as a second line to your script. 
//ref:c:\temp\myref1.dll,c:\temp 2\myref2.dll, c:\temp 3\myref3.dll 
Chapter 5 
28
KCIC 
Advanced Email and Fax Administrator's Guide 
IBatchNameFormatter Interface Definition 
This is the definition of the IBatchNameFormatter interface: 
using System; 
using System.Collections.Generic; 
using System.Text; 
using Kofax.KCS.ImportConnector.Messages; 
namespace Kofax.KCS.ImportConnector.Scripting 
public interface IBatchNameFormatter 
string GetBatchName(ReadonlyMessage[] msg); 
The ReadonlyMessage[] array contains all the messages that are part of a batch. If it is a single 
message batch, then the array contains only 1 message at position 0. All the properties and fields 
values are read-only. You cannot change any of those values using this interface. You can use any 
of the defined Kofax Capture variables, e.g. ―{Sequence Number}‖. Kofax Capture variables are 
translated to Kofax Capture values. (Please refer to the Kofax Capture documentation for more 
information about Kofax Capture variables). 
The returning string from the function is the actual batch name.  
Important: If you write custom batch naming scripts you should pay attention that the batch 
names must be unique, otherwise the batch creation in Kofax Capture will fail. 
ReadonlyMessage properties: 
Property Name 
Type 
Description 
Fields 
IDictionary 
<string, string> 
The collection of Key-Value pairs containing field names in 
the key values and the field values in the value values. 
The collection contains the standard message fields listed 
below and any extension fields if they are defined in Message 
Connector. 
(Message fields are information that Message Connector 
delivers with each message. 
Message extension fields are currently not provided by 
Message Connector and should not be used. They are reserved 
for future use.) 
Standard message fields are described in section Message 
Fields. 
IDocumentScript2 Interface Definition 
This is the definition of the IDocumentScript2 interface: 
public interface IDocumentScript2 
/// <summary> 
/// Called before the import content and import order is determined 
/// Body and attachment content and import order can be manipulated in this function  
/// </summary> 
/// <param name="message">A read-only instance of the message being imported</param> 
/// <param name="messageBody">The list of the received message bodies.</param> 
/// <param name="attachments">The list of the received attachments.</param> 
/// <param name="extension">Reserved for future use.</param> 
void ManageMessageFiles(ReadonlyMessage message, 
Scripting Interface 
KCIC 
Advanced Email and Fax Administrator's Guide 
29
List<Attachment> messageBody, 
List<Attachment> attachments, 
object extension); 
/// <summary> 
/// Called before a document is imported into KC 
/// </summary> 
/// <param name="indexFields">The list of index fields defined in the configured 
document class.  
/// If document class not defined this will be empty.</param> 
/// <param name="folderFields">The list of folder fields defined in the configured 
folder class.  
/// If folder class not defined this will be empty.</param> 
/// <param name="batchFields">The list of batch fields defined in the configured 
batch class.</param> 
/// <param name="messageBody">The list of the received message bodies.</param> 
/// <param name="attachments">The list of the received attachments.</param> 
/// <param name="extension">Reserved for future use.</param> 
void BeforeDocumentImport(IDictionary<string, string> indexFields, 
IDictionary<string, string> folderFields, 
IDictionary<string, string> batchFields, 
List<Attachment> messageBody, 
List<Attachment> attachments, 
object extension); 
/// <summary> 
/// Called before a message is imported into KC 
/// </summary> 
/// <param name="indexFields">The list of index fields defined in the configured 
document class.  
/// If document class not defined this will be empty.</param> 
/// <param name="folderFields">The list of folder fields defined in the configured 
folder class.  
/// If folder class not defined this will be empty.</param> 
/// <param name="batchFields">The list of batch fields defined in the configured 
batch class.</param> 
/// <param name="messageBody">The list of the received message bodies.</param> 
/// <param name="attachments">The list of the received attachments.</param> 
/// <param name="extension">Reserved for future use.</param> 
void BeforeMessageImport(IDictionary<string, string> indexFields, 
IDictionary<string, string> folderFields, 
IDictionary<string, string> batchFields, 
List<Attachment> messageBody, 
List<Attachment> attachments, 
object extension); 
}  
If defined, the ManageMessageFiles function implementation is run before the import content 
and import order is determined. Here you can manipulate the import content: add new content, 
discard content, and change existing content. You can discard binary content by setting a 
DoImport flag of the binary content to false to skip the import of that attachment or body. 
If defined, the BeforeDocumentImport function implementation runs before each Kofax Capture 
document is created. 
If defined, the BeforeMessageImport function implementation runs before each message is 
imported into Kofax Capture. 
The input parameters for the BeforeDocumentImport and BeforeMessageImport methods are the 
list of all folder, document and batch field values, the list of all message bodies, and the list of all 
attachments. Here you can manipulate batch, folder, and document field values. The list of 
bodies and attachments are only for reading in these functions. You cannot change the import 
content. If you need to manipulate the import content this should be done in 
ManageMessageFiles. 
The indexFields parameter contains a key-value pair list containing all the index fields defined 
for the used document class. If a document class is not configured or if there are no index fields 
defined, this will be empty. The key property contains the index field name and the value 
property contains the index field value. 
Chapter 5 
30
KCIC 
Advanced Email and Fax Administrator's Guide 
The folderFields parameter contains a key-value pair list containing all the folder fields defined 
for the used folder class. If a folder class is not configured or if there are no folder fields defined, 
this will be empty. The key property contains the folder field name and the value property 
contains the folder field value. 
The batchFields parameter, similar to the indexFields and folderFields parameter contains a key-
value pair list containing all the batch fields defined for the used batch class. If there are no batch 
fields defined, it is empty. The key property contains the batch field name and the value property 
contains the batch field value. 
The messageBody parameter contains all selected representations of the message body (original, 
PDF, TIF). 
The attachments parameter contains all selected representations of the attachments (original, 
PDF, TIF). 
Attachment class properties: 
Property Name 
Type 
Description 
Extension 
String 
The extension of the received file 
LongOrBinaryFileName 
String 
The file name of the received attachment/body. The connector 
first looks for the long file name, if it does not exist, then it takes 
the binary file name, which is the short file name. 
HierarchicalPosition 
String 
MC hierarchical position of the file. 
DoImport 
Bool 
By default it is true. If you set this value to false in your script, 
this attachment/body will not be imported into Kofax Capture 
Content 
Byte [] 
The binary content of a body/attachment. If it is text, then it is 
encoded using the default Windows encoding for on the 
computer where the connector runs. 
DocConversionError 
String 
If there was a document conversion error for this document, this 
property will contain the description of the error 
IsOriginal 
Bool 
Indicates if a file is an original file or a converted file 
IsImage 
Bool 
Indicates if it is an image or another file format 
IsOriginalEml 
Bool 
Indicates if it is the EML representation of the original message 
Documents you may be interested
Documents you may be interested