Import settings

You can configure TotalAgility to receive documents through POP3, IMAP, SMTP, MS Graph, fax servers, folder and Exchange Web Services. Each external system has configuration settings that create TotalAgility processes when business documents are received.

Note Import settings are only available for TotalAgility on-premise; Import settings are available in the Azure environment only via the on-premise Integration Server.

You can configure the import source settings on the TotalAgility Integration Server in the same way as you would do in TotalAgility on-premise. When the event is raised on the Integration Server, the action is executed on Azure.

Active import sources or passive import connection settings are supported.

Active import sources

The active import sources run as services within TotalAgility to accept messages sent from external systems. You can only configure one import source type for each import connection.

Active import sources include:

  • Simple Mail Transfer Protocol (SMTP)

  • Fax Over Internet Protocol (FoIP)

When you configure the import connector for email, you can create a document directly using the email body. The mime type of the resulting document is determined by the email format (text, RTF, HTML):

  • If the email body is formatted as text, you can perform classification or extraction on that document. After performing image processing on the document, you can view the document in any of the Capture Client activities.

  • If the email body is formatted as RTF, provide customization to convert the RTF document to a supported format prior to submitting to a capture activity.

  • If the email body is formatted as HTML, after processing image on the document, you can perform classification or extraction on the document or view the document in any of the Capture Client activities.

Passive import sources

Passive import sources are polled by TotalAgility to retrieve messages. You can configure one or more import connections with a Message Connector. Each import connection contains settings for the Message Connector and one or more import sources.

Passive import sources settings include:

  • Post Office Protocol (POP3)

  • Internet Message Access Protocol (IMAP)

  • Exchange Web Services (EWS)

  • MS Graph

  • Fax

  • File

Metadata for all import sources

See the following table for metadata available for all import sources.

Metadata

IMAP/EWS/POP3/SMTP/ MS Graph

External Fax Server/FoIP

File

Archive Folder

Path to store the archived messages.

Note This is not applicable to the {Process-ID} field.

Path to store the archived messages.

Note This is not applicable to the {Process-ID} field.

Path to store the archived messages.

Note This is not applicable to the {Process-ID} field.

Error information

The description of the error in case of a partially or not imported file.

The description of the error in case of a partially or not imported file.

The description of the error in case of a partially or not imported file.

Error Level

The status of an imported file; 0=imported, 1=partially imported and 2=not imported.

The status of an imported file; 0=imported, 1=partially imported and 2=not imported.

The status of an imported file; 0=imported, 1=partially imported and 2=not imported.

Fax Extension

The fax extension to which the fax has been originally sent.

Fax User

The fax user to which the fax has been originally sent.

File Path

Folder path of the file.

File Name

File name

From, To, Body, Bcc and CC

Components of an email.

Components of an EML or MSG file.

From Fax Number

The fax number from which the fax has been sent.

Message Import Folder

Folder or the sub folder name from where the messages are polled. For example, if the polled folder is "Inbox" and sub folder is "sub1", then this field contains Inbox/sub1.

Import Source Address

The mail box name configured in TotalAgility. For example, the final routed email address for SMTP email.

The fax number configured in TotalAgility. For example, the extension number for FoIP.

The watch folder name configured in TotalAgility.

Import Source Type

EMAIL

FAX

FOLDER

Import Source Recipients

The comma delimited list of To and CC recipients.

Original fax number.

The watch folder name configured in TotalAgility.

Input Source Type

The type of input source. For email, it is POP3, IMAP, SMTP, or EWS.

The type of input source. For fax, it is BISCOM, RightFax or KCS.

The type of input source. For file import, it is folder.

Message Attachment List

The file names of the message attachments delimited by ';'.

The file names of the documents delimited by ';'.

Message Correlation

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

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

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

Message Delivery Priority

The priority of the message. Reserved for future use.

Set to static value 1.

The priority of the message. Reserved for future use.

Set to static value 1.

The priority of the message. Reserved for future use.

Set to static value 1.

Message Delivery Type

The delivery type of the message. Reserved for future use.

Set to static string TO.

The delivery type of the message. Reserved for future use.

Set to static string TO.

The delivery type of the message. Reserved for future use.

Set to static string TO.

Message General File Name

The file name of the document. For fax server, this returns the server internal file name of the fax message.

Message ID

The unique ID assigned by the Message Connector to a message on arrival.

The unique ID assigned by the Message Connector to a message on arrival.

The unique ID assigned by the Message Connector to a message on arrival.

Message Original Recipients

Contains a list of the original recipients as specified by the fax originator.

Message Originator Name

The full name of the message originator. For SMTP/POP3/EWS/IMAP, it is the originator's display name (mime-header/from/mailbox/displayname).

The full name of the message originator. For faxes, this is the TSI.

The full name of the message originator. For SMTP/POP3/EWS, it is the originator's display name (mime-header/from/mailbox/displayname).

Message Originator Number

The originator email (mime-header/from/mailbox/address) for POP3/SMTP/EWS mail.

The fax number of the originator (caller ID).

The watch folder name configured in TotalAgility including the file name.

Message Originator Service

EMAIL

FAX

FOLDER

Message Owner Reference

The mime-header or message ID of emails.

The server-specific message ID.

The mime-header or message ID of EML or MSG files.

Message Reception Caller Id

The fax number of the sending fax machine.

Message Importing Error

If the message is rejected by TotalAgility, it contains the error message.

If the message is rejected by TotalAgility, it contains the error message.

If the message is rejected by TotalAgility, it contains the error message.

Message Reception Time Created

The time when message was retrieved by the Message Connector.

Note For emails, we recommend to use the Message Reception Time Received field.

  • Biscom/Right Fax: The start time of fax reception.

  • KCS: The time when the fax server started receiving the message.

Note For Biscom and Right Fax, the Message Reception Time Created and Message Reception Time Received fields return the same value. We recommend to use the Message Reception Time Received field.

The time when message was retrieved by the Message Connector.

Note For folder, we recommend to use the Message Reception Time Received field.

Message Reception Time Received

The time when message was retrieved by the Message Connector.

  • Biscom/Right Fax: The start time of fax reception.

  • KCS: The time when the fax server finished receiving the message.

The time when message was retrieved by the Message Connector.

Message Recipient Name

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

The full name of the message recipient.

The full name of the message recipient in EML or MSG file.

Message Recipient Service

The service name of the recipient. For email import, it is EMAIL.

The service name of the recipient. For fax import, it is FAX.

The service name of the recipient. For file import, it is FOLDER.

Message Routing Number

  • SMTP: Active email recipient.

  • POP3/IMAP/EWS: Mailbox user name.

The extension or called party number.

Full path of the imported file.

Message Suspected Duplication

Reserved for future use. Set to static value 0.

Reserved for future use. Set to static value 0.

Reserved for future use. Set to static value 0.

Pages

The number of fax pages in the message.

Time Created

Note If you are currently using this field, we recommend to use the Message Reception Time Created field.

The date and time when the message was retrieved.

The time when the fax server received the message.

Time Posted

The date and time information of an incoming message. If the message does not contain date and time information, TotalAgility uses the current date and time.

XML DATA

The root XML document, that is, the complete XML document that has been recognized as an XML type (usually the first XML document in the email or the first XML document in the folder or the XML document that has been used as trigger file).

Subject

Subject of an email.

Subject of an EML or MSG file.

Message MetaData Xml

All available metadata of the incoming message.

Note If you use this metadata, you do not need to map any other metadata.

All available metadata of the incoming document.

Note If you use this metadata, you do not need to map any other metadata.

All available metadata of the incoming file.

Note If you use this metadata, you do not need to map any other metadata.

See also: