Welcome > Integration > Import settings > Configure the import connection settings > Import sources > FoIP

FoIP

Integrate TotalAgility with Fax Over Internet Protocol (FoIP) import source to receive messages through FoIP.

Configure the properties of FoIP import source and click Save. The properties of FoIP import source are grouped under the following headings:

General

Field Description
Type Protocol for the import source. Select FoIP.
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)

Note

  • To normalize images and create pages for the images in Import (old behavior), the Normalize images and create pages option is enabled on upgrading TotalAgility from version 7.5.0 or lower. We recommend that you do not select this option for new process maps.

    For new process maps, keep this option clear (default). Use the Document conversion activity to normalize the images and then create pages for the images. You can also address issues such as scaling and orientation in the Document conversion activity and then use any Capture activities in your process map.

  • The Document conversion activity runs on the transformation server (scalable and optimized for heavy loads) that can manage the tasks of converting, splitting images and creating pages efficiently.

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.

Note 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.

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

Note 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

Field Description
Successfully imported
Format

One or more file formats for saving the successfully imported documents. Supported formats are:

  • File: Archives the message body in a text file and all attachments in separate files.

  • EML: Archives the message body and the attachments as a single EML file.

  • XML: Archive the message metadata in an XML file (custom Kofax format).

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 One or more file formats for saving the partially imported documents. Supported formats are:

  • File: Archives the message body in a text file and all attachments in separate files.

  • EML: Archives the message body and the attachments as a single EML file.

  • XML: Archive the message metadata in an XML file (custom Kofax format).

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 One or more file formats for saving the rejected/failed imported documents. Supported formats are:

  • File: Archives the message body in a text file and all attachments in separate files.

  • EML: Archives the message body and the attachments as a single EML file.

  • XML: Archive the message metadata in an XML file (custom Kofax format).

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

On the Job type list, select one of the following job types to associate an action with the FoIP server so that a job can be created at runtime.

Create new job(Default)

  1. On the Select a Process list, select a process or case.

    If the selected process or case map has any initialization variables, the parameters appear under Initialization variables.

  2. 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.

Create new case

  1. On the Case list, select a case map.

    If the selected case map has any initialization variables, the parameters appear under Initialization variables.

  2. Select an Expression type:

    • Regular: Enter an expression to extract the case reference from a subject in the Case ref field.

    • XSL: Enter an XML expression to extract the case reference from the XML data in the Case ref field.

    • None (default): Automatically uses the job ID as the case reference.

  3. Map the parameters to the initialization variables, using a dynamic or static value.

Create job in case

  1. On the Process list, select a process, case or case fragment.

    If the selected process, case or case fragment has any initialization variables, the parameters appear under Initialization variables.

  2. Select an Expression type:

    • Regular(default): Enter an expression to extract the case reference from a subject in the Case ref field.

    • XSL: Enter an XML expression to extract the case reference from the XML data in the Case ref field.

  3. Map the parameters to the initialization variables, using a dynamic or static value.