Following 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="messageBody">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,
 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.

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 the selected representations of the message body (original, PDF, TIF).

The attachments parameter contains all the selected representations of the attachments (original, PDF, TIF).

Attachment class properties

Rejecting messages from script

You can perform checks and reject messages with scripts that implement the IDocumentScript2 interface. To reject a message, throw an exception of the type ScriptException with the desired description as an argument. The description is then displayed in the Message Connector Monitor.

Ignoring messages from script

You can perform checks and ignore messages with scripts that implement the IDocumentScript2 interface. To ignore a message, throw an exception of the ScriptIgnoreMessageException type with the desired description as an argument. In order to work correctly, ScriptIgnoreMessageException needs to be thrown from the function ManageMessageFiles. Optionally, when throwing the exception, you can also select not to send a notification and not to archive the message by passing false as value for doNotifyArchive in the exception constructor. Similar to reject, ignore causes the message not to be imported into Kofax Capture. The difference is however, that ignore will send a positive confirmation back to Message Connector and provides the option to turn off archiving and notifications for such messages.