External fax server
Integrate TotalAgility with external fax servers such as RightFax, Kofax Communication Server (KCS) and Biscom so that it can receive documents through Fax after you configure the import connection settings.
Configure the properties of import source and click Save.
The properties of POP3 import source are grouped under the following headings:
General
Field | Description |
---|---|
Type | Protocol for the import source. Select External fax server. |
Display name | Name for the import source. |
Active | By default, the import source is active. |
Error Handling | |
Message Connector service timeout | Timeout value for message processing. This value sets the timeout when calling the Message
Connector service. (Default: 1200 seconds (20 minutes). This value is suitable for processing most messages.)
To avoid timeout for messages with longer processing time, increase the timeout value. Maximum allowed value is 86400 seconds (24 hours.) |
Advanced
Field | Description |
---|---|
Normalize images and create pages | Normalizes the incoming image files to TIFF and create pages. (Default: Clear)
|
Include complete message as EML file | Imports an EML file same as the original email including attachments. (Default: Clear) |
Include complete message as MSG file | Imports an MSG file same as the original email including attachments. |
Skip import for files of size (bytes) less than | Enter a valid file size. TotalAgility skips the conversion of files with file size less than specified in this field. (Default is 0, which means this field is ignored. |
Extract referenced MSG/EML files |
Allows the import of the nested emails and EML/MSG files along with their attachments. By default, TotalAgility allows the import of the main email and all types of attached emails in EML/MSG format. This is also applicable to the EML and MSG files which are referenced in the XML files. This option is selected when upgrading TotalAgility from a lower version. In case of an XML import, enabling the "Extract referenced MSG/EML" option when "Import content" is set to "Only body" is not a valid scenario. |
Fax users to monitor
Field | Description |
---|---|
Fax server type | Select one of the following types:
|
Poll cycle in seconds | When should the import connector check for new documents on the mail server. (Default: 5) |
Host | Host name of the fax server. |
User name | User name of the fax server. |
Password | Password of the fax server. |
Test fax server | Verify the connection between the import connector and fax server. |
Operation mode | |
Single/Multi instance |
Select how to poll the fax server.
|
|
|
Fax users to monitor |
|
|
Removes a specific user in the Selected items box. |
Remove all |
Removes all the users in the Selected items box. |
VRS processing
Field | Description |
---|---|
Scan/VRS profile |
Name of the Scan/VRS profile. |
Apply scan/VRS profile to eDocuments | Applies the selected Scan/VRS profile to the documents. (Default: Clear) |
Notification settings
Send notification emails to the configured email addresses when the document import process is partially successful or failed.
Field | Description |
---|---|
Reject notification recipient list |
The email addresses to which you want to send the notifications. Delimit each email addresses with a semicolon. |
Include complete email message as attachment |
Attaches the original message (in EML format) to the notification mail. (Default: Clear) |
Remove email attachments | When
Include complete email message as attachment is selected, by default,
the original email is attached to the notification email. To include the original email without attachments to the notification
mail, select
Remove email attachments. Default: Clear
When "Remove email attachments" is selected and if the original email does not contains body, an empty email is generated. |
Message from |
The email address of the sender. |
Send a test notification email |
Verifies whether the recipient list have received the emails by sending a test mail. |
Document archiving
Configure one or more file formats for saving the successfully imported, partially imported or rejected or failed documents.
Scenarios when a message may be partially imported
-
"Normalize non-PDF e-documents to PDF/A" is enabled and incoming message contains a file which cannot be normalized, such as DAT file.
-
A fax is partially received (fax with a reception error.)
-
Documents for which the PDF/A normalization failed.
-
"Normalize non-PDF e-documents to PDF/A" and "Normalize incoming PDF documents to PDF/A" are enabled, and an email with an attached password protected file is ingested through Message Connector.
-
“Unpack archives” is selected in Message Connector configuration, and an email with an attached password protected file is ingested through Message Connector.
-
The message attachment has document conversion errors.
A document with conversion errors is imported as original file and is available in the workflow. Conversion of any non-supported document (.dat,.xyz,.psz) fails with document conversion error.
Scenarios when a message import may fail
-
"Normalize non-PDF e-documents to PDF/A" and “Concatenate multiple PDF files” are enabled, and the incoming message contains a BIN/DAT file as attachment.
-
"Normalize non-PDF e-documents to PDF/A", "Normalize incoming PDF documents to PDF/A" and “Concatenate multiple PDF files” are enabled, and an email with an attached password protected file is ingested through Message Connector.
-
When the XML fields are mapped to the TotalAgility fields and “Map XML fields to TotalAgility fields and reject on mismatch” is enabled, and there is some difference in the fields specified in the XML file.
-
"Normalize non-PDF e-documents to PDF/A", "Normalize incoming PDF documents to PDF/A" and “Concatenate multiple PDF files” are enabled, and an email with an attached password protected file is ingested through Message Connector.
-
“Unpack archives” is selected in Message Connector configuration, "Normalize non-PDF e-documents to PDF/A" and “Concatenate multiple PDF files” are enabled in TotalAgility Designer, and an email with an attached password protected file is ingested through Message Connector.
-
Any of the message attachment content is null.
-
The process map is not available for an import source.
Field | Description |
---|---|
Successfully imported | |
Format |
Supported formats for successfully imported documents are:
|
Archive folder |
Path of a local folder (such as, C:\Archive) or a network folder to store the successfully imported documents. |
Test archive folder |
Tests whether the archive the folder is configured correctly. |
Subfolder and file prefix |
The name of the subfolder and prefix for the archived files. You can also add predefined Fields as subfolder name and filename prefix. The value of these variables is populated at the time of saving the archived files. If you do not add the "\" character in the field, all the fields are appended to the archived file names. For example, if you add {OK}\{Process-ID}, the files are stored in OK folder with process ID appended to the filename. |
Partially imported | |
Format | Supported formats for partially imported documents are:
|
Archive folder |
Path of a local folder (such as, C:\Archive) or a network folder to store the partially imported documents. |
Test archive folder | Tests whether the archive the folder is configured correctly. |
Subfolder and file prefix |
The name of the subfolder and prefix for the archived files. You can also add predefined Fields as subfolder name and filename prefix. The value of these variables is populated at the time of saving the archived files. If you do not add the "\" character in the field, all the fields are appended to the archived file names. For example, if you add {PARTIAL}\{Process-ID}, the files are stored in PARTIAL folder with process ID appended to the filename. |
Rejected/Failed | |
Format | Supported formats for rejected or failed documents are:
|
Archive folder |
Path of a local folder (such as, C:\Archive) or a network folder to store the failed/rejected documents. |
Test archive folder | Tests whether the archive the folder is configured correctly. |
Subfolder and file prefix |
The name of the subfolder and prefix for the archived files. You can also add predefined Fields as subfolder name and filename prefix. The value of these variables is populated at the time of saving the archived files. If you do not add the "\" character in the field, all the fields are appended to the archived file names. For example, if you add {REJECTED}\{Process-ID}, the files are stored in REJECTED folder with process ID appended to the filename. |
Associated actions
Associate an action with the import source so that a job can be created at runtime for the Successfully imported, Partially imported and Rejected/Failed documents.
On the Job type list, Create new job is selected by default.
-
On the
Process list, select a process or case.
If the selected process or case map has any initialization variables, the parameters appear under Initialization variables.
For rejected/failed or partially imported documents, only the metadata of the documents is passed to the relevant processes. When configuring such process maps, you can then map the metadata. Additionally, in case of rejected/failed documents, the original content of an EML is added as a document to the Job. - To map the parameters to the initialization variables, on the Mapping list of the initialization variable, select a dynamic value or click and enter a static value.