Custom storage strings

When you configure a destination in KC Plug-In, you can map some of the document metadata to document and folder fields of a Kofax Capture batch class.

However, only a subset of document metadata is available for use with the user interface. All metadata is available in Kofax Capture as custom storage strings (for documents and folders).

Custom storage strings can be read via the Kofax Capture API and could be used, for example, in an export connector or in custom scripts.

Most custom storage strings are available for each document and for each folder. Refer to the Description column for exceptions.

Custom storage string

Description

ED_CSS_KfxOriginatorService

The service name of the originator. In case of fax, FAX and, in case of email, EMAIL.

ED_CSS_KfxOriginatorNumber

The fax number of the originator (caller ID) or originator email (mime-header/from/mailbox/address) for POP3/SMTP mail.

ED_CSS_KfxOriginatorName

The full name of the message originator. For faxes, this is the TSI. For SMTP and POP3, it is the originator display name (mime-header/from/mailbox/displayname).

ED_CSS_KfxRecipientService

The service name of the recipient. In case of fax, FAX and, in case of email, EMAIL.

ED_CSS_KfxRecipientNumber

The recipient fax number (called party number) or email address (for SMTP, it is the first active email recipient, for POP3, the mailbox user name).

ED_CSS_KfxRecipientName

The full name of the message recipient. For POP3, this is the mailbox display name.

ED_CSS_KfxMessageCorrelation

The correlation information of the message (for internal use).

ED_CSS_KfxMessageID

The unique ID of the message given by the Message Connector on message arrival.

ED_CSS_KfxMessageSubject

The subject of the message. For faxes, this is "Fax from" + TSI.

ED_CSS_KfxMessageReceptionTimeCreated

MAIL: The time when the Message Connector retrieved the message.

FAX: The time when the fax server received the message.

ED_CSS_KfxMessageReceptionCallerId

The number of the sending fax machine. (Optionally available for FoIP, Biscom, KCS)

ED_CSS_KfxMessagePages

The number of fax pages in the message.

ED_CSS_KfxMessageDeliveryType

The type of delivery of the message. Reserved for future use. Currently static string "TO".

ED_CSS_KfxMessageDeliveryPriority

The priority of the message. Reserved for future use. Currently static value "1".

ED_CSS_KfxMessageDeliverySuspectedDupli

Reserved for future use. Currently static value "0".

ED_CSS_KfxMessageReceptionTimeReceived

The reception time of fax.

ED_CSS_KfxRoutingNumber

The meaning of this message field is different for various inputs

  • FAX: Extension (called-party-number)

  • SMTP: Active email recipient

  • POP3/IMAP: Mailbox user name

  • FOLDER: Full path to the imported file

  • WEBSERVICE: Empty string

ED_CSS_KfxMessageTimePosted

Only available for email messages. This field contains the date and time when the message was sent.

ED_CSS_KfxRecipientsTo

Comma separated list of "To" recipients.

ED_CSS_KfxRecipientsCc

Comma separated list of "Cc" recipients.

ED_CSS_KfxRecipientsBcc

Comma separated list of "Bcc" recipients.

ED_CSS_Batchname

The name of imported Kofax Capture batch.

ED_CSS_Batchclass

The batch class name of imported Kofax Capture batch.

ED_CSS_Import-Date-Short

The import date in the form YYYY-MM-DD.

ED_CSS_Import-Date-Long

The import date in the form YYYY-MM-DDTHH-MM-SS.

ED_CSS_KfxImportFolderName

Folder name of the sub folder from which messages are polled.

Example, if the polling folder is "Inbox" and sub folder is "sub1", then the field will contain "Inbox/sub1".

ED_CSS_Batch-Id

The batch ID of the imported Kofax Capture batch.

ED_CSS_VRS-Error

The VRS error description in the case of VRS error. (Document only)

ED_CSS_OriginalFileName, ED_CSS_OriginalFileNamePageNr

For documents, this string stores the full path of the original content file. This string is available when you enable "Include original content" in the Destination configuration and "Originals import mode" is set to "Save to disk".

For folder, this string stores the full path of the saved EML file. This string is available when you enable "Include complete message as EML file" in the Destination configuration and "Originals import mode" is set to "Save to disk".

PageNr is the page number of the first page of the related converted document in Kofax Capture. For example:

  • ED_OriginalFilename1: C:\..\Images\00000CC4\200\ 1_original.tif

  • ED_OriginalFilename3: C:\..\Images\00000CC4\200\ 3_original.tif

ED_CSS_DocPerAttachment

The document creation mode used for import (Document only):

  • True: One document per each attachment

  • False: One document per message

KfxMessageNumberOfPagesImportedForBatch

The number of pages in the files imported from a folder. The number of pages is calculated using the following rules:

  • Each image file is split into pages, and each individual page is counted as one page.
  • Each non-image document (including PDF files) imported as an eDocument file is counted as one page.
  • Each PDF file imported as a TIFF file is split into pages, and each individual page is counted as one page.

For fax, this is the number of fax pages in the message.

KfxMessageNumberOfRemovedBlankPages

The number of blank pages removed from the documents at the time of VRS processing.