Creating an import profile
To add an import profile, click Project → Image Import Profiles… in the main window. In the dialog box that opens, you can create new import profiles or edit, remove, or copy existing ones. You can create a new import profile with the help of the Import Profile Wizard, which can be run by clicking New… in the Image Import Profiles dialog box. When the wizard prompts you, select an import source (e.g. a scanner or a Hot Folder).Creating an import profile for a scanner
- Select Scanner as the import source.
Important! The scanner must be connected. To connect the scanner correctly, consult the documentation supplied with the scanner. Be sure to install all of the software supplied with the scanner. - Configure the image scanning options:
- Style of the settings dialog Choose how the program will interact with the scanner:
- FlexiCapture Scanner Settings: The Scanner settings dialog box of ABBYY FlexiCapture will be used. Click the Settings… button to configure scanning options. If you select the Show scanner settings before scanning option, then the Scanner settings dialog box of ABBYY FlexiCapture will appear prior to scanning when you select this import profile.
- Scanning Options: The dialog box of the scanner driver will be used. You will not be able to change the scanning options when creating an import profile, but the Scanner settings dialog box will appear each time you start scanning an image.
- Specify whether you want to scan one or multiple images at a time.
- Style of the settings dialog Choose how the program will interact with the scanner:
- Configure the image pre-processing options.
- If required, change the default name of the import profile and add a comment.
Creating an import profile for a Hot Folder or a mail box
- Select Hot Folder as the import source. Select the type of your Hot Folder:
- Local folder or LAN folder
Note: You can use environment variables to specify the path to the import directory. Environment variables can contain the whole path or a part of it, e.g. <Env:import>/subfolder_name. - MAPI (mailbox)
- POP3 server
- IMAP server
- SFTP server
- FTP server
- Microsoft Graph Mail API
- Local folder or LAN folder
Important! To be able to add images from a Hot Folder, the user must have read and write privileges for that folder.
To set up import from a MAPI mailbox
To set up import from a MAPI mailbox
- An e-mail account must be configured on the computer.
- The Operator Station or the Processing Station must be run under the user account that is used for accessing the mailbox.
Note: Microsoft Outlook has to be started under this user account on the given computer at least once before the import profile is set up. The bitness of Microsoft Outlook has to be the same as the bitness of ABBYY FlexiCapture 12, e.g. if you are using the 64-bit version of ABBYY FlexiCapture 12, you will need to use the 64-bit version of Microsoft Outlook.
Note: We recommend that you use Outlook 2016 when importing to FlexiCapture 12 using the MAPI protocol. Later versions of Outlook are not supported. - Click Browse… and select the desired mail box.
- The Operator Station or the Processing Station must be run under the user account that is used for accessing the mailbox.
To set up import from a POP3 server
To set up import from a POP3 server
-
Specify the address of your POP3 server (e.g. pop.server.com).
- Click Settings… and in the dialog box that opens, enter the user name and password required to access the messages on the server.
- Under Type of encrypted connection, select one of the following:
-
None – The connection will not be encrypted. Use this option for connections over an unsecured port.
- SSL – The connection will always be encrypted.
- Auto – The connection will be encrypted if a secured port is specified and will not be encrypted if no port is specified.
To set up import from an IMAP server
To set up import from an IMAP server
-
Specify the address of the IMAP server (e.g. imap.server.com).
- Click Settings… In the dialog box that opens, enter a valid user name. Select one of the following authentication options:
-
Use OAuth 2.0 authentication. Opens an OAuth 2.0 authentication dialog in the browser. When connecting to the server for the first time, a login and password are required. The browser will then close automatically.
- Define authentication parameters. Lets you enter a password for the specified user name.
- Under Type of encrypted connection, select one of the following:
-
None – The connection will not be encrypted. Use this option for connections over an unsecured port.
- SSL – The connection will always be encrypted.
- TLS – The connection will always be encrypted.
- Auto – The connection will be encrypted if a secured port is specified and will not be encrypted if no port is specified.
- Click Browse… and select a subfolder inside the mailbox.
To set up import from an SFTP/FTP server
To set up import from an SFTP/FTP server
- Specify the address of the SFTP/FTP server. If you are using a non-standard port to connect to the server, please specify it after the address using the following format: sftp://address:port/ or ftp://address:port/
-
Click Settings… and in the dialog box that opens, enter the user name and password required to access the messages on the server.
- Click Next. If you are setting import from an SFTP server, you will see a public key validation dialog box.
To set up import via the Microsoft Graph Mail API
To set up import via the Microsoft Graph Mail API
-
In the Network Settings dialog box, click Sign in…This will launch the OAuth 2.0 Authorization Wizard.
- Click the link in the OAuth 2.0 Authorization Wizard to sign in to your Microsoft account. The browser will then close automatically.
Note: Sometimes, after confirmation of authorization is received, the authentication is denied with the following error message: Flow failed. Failure info/error: Connect to token endpoint failed (for more information, see Microsoft Graph API connection error).
- Click the link in the OAuth 2.0 Authorization Wizard to sign in to your Microsoft account. The browser will then close automatically.
- Grant the required permissions to the application (for more information, see Importing images using Microsoft Graph Mail API).
-
Navigate back to the Network Settings window and click OK.
- To select an available subfolder inside the mailbox, click Browse… in the Import Profile Wizard.
- Specify the image loading options:
- Check Hot Folder every Select this option and enter a regular time period for the program to check the Hot Folder for new images. If a mail box is selected as a Hot Folder, the program will check it for new e-mails after the first e-mail has been imported. If there are new e-mails in the mail box and free CPU cores are available on the computer where the Processing Server is installed, all the new e-mails will be imported one by one until the mail box is empty. The next check on the mail box will be performed at the end of the time period specified in this box.
Note: To import images from Hot Folders, you must (Distributed) enable Hot Folder processing for your project in the Administration and Monitoring Console (click Settings → Projects). (Standalone) select the Autochecking option for the profile in the (Standalone) Image Import Profiles dialog box. - In Batch Settings, select one of the following options to specify a batch to which new images should be added:
- Add images to current batch Select this option to add images from the Hot Folder to the current batch.
- Add images to specified batch Select this option and then select a batch name from the drop-down list to add images to a specific batch.
- Create new batches for imported images automatically Select this option to create batches for new images automatically. Each time the Hot Folder is checked (the time interval can be specified in Check Hot Folder every), one or several batches will be created, and images from the Hot Folder will be added to those batches according to the rule you specify in this dialog box.
In the Batch type field, specify the batch type. If required, specify the batch registration parameters (click Registration parameters…) and modify the batch priority in the Priority field.
Note: If import tasks are processed on the Processing Server, the Create new batches for imported images automatically option must be selected. The Add images to current batch and Add images to specified batch options can be used only if images are imported on the Project Setup Station, or if you are using a standalone edition of ABBYY FlexiCapture.
- Attach mail to batch (only for a POP3 server Hot Folder)
Select this option if you want to attach an e-mail message file in EML format to the newly created batch. Attached e-mail messages can be downloaded and opened using an e-mail client. For details, see User attachments. - In the Number of files to add drop-down list, select one of the following options, which determine the number of files to add to an existing or a newly created batch:
- According to description file Files will be added according to a description file. To specify the name and type of the description file, click the Settings… button. For details, see Description file.
Note: To set up import from a mail box using a description file, add the XML description file as an e-mail attachment.
- According to description file Files will be added according to a description file. To specify the name and type of the description file, click the Settings… button. For details, see Description file.
- Check Hot Folder every Select this option and enter a regular time period for the program to check the Hot Folder for new images. If a mail box is selected as a Hot Folder, the program will check it for new e-mails after the first e-mail has been imported. If there are new e-mails in the mail box and free CPU cores are available on the computer where the Processing Server is installed, all the new e-mails will be imported one by one until the mail box is empty. The next check on the mail box will be performed at the end of the time period specified in this box.
- All files All files from the Hot Folder will be added. Files from subfolders will be ignored.
- From subfolder Files will be added from subfolders whose names comply with a naming scheme. Click Settings… to specify a naming scheme.
Note: An asterisk (*****) indicates any string of characters; a question mark (?) indicates any single character.
Note: Rename a subfolder according to your naming scheme only after all the required files have been copied to it. Otherwise, file access conflicts may occur. - Several files Several files will be added. To specify the number of files, click the Settings… button and enter a number or a range. Files from subfolders will be ignored.
Note: If you specify a certain number of files, e.g. 5, and there are only 4 files left in the Hot Folder, these files will not be imported. If you specify a range, e.g. 1-5, the remaining 4 files will be imported.
Note: When using the Microsoft Graph Mail API, only one e-mail message is imported per each import task. Importing messages in parallel is not supported — import tasks are carried out one by one on each Processing Station. - Single file One file will be added.
- Attached to the letter All the files attached to the e-mail message will be added.
Note: New images are added to the batch according to their file names in ascending order. - Message bodies and attachments Both the attached files and the message bodies will be added.
- Select the appropriate option from the If no files are found, log the following drop-down list:
- Error,
- Warning,
- Information
- Configure image pre-processing options. You can select the Use image processing options from batch type option to apply the document separation and image processing settings specified for the batch type.
- The Profile Wizard will prompt you to specify options for Hot Folder cleanup after import. Successfully imported images can be either deleted or moved to another folder. Images that have been processed with errors (e.g. if the file is corrupt or there has been a network error) can be either left in the Hot Folder or moved to another folder.
Note: Avoid keeping in the Hot Folder images that have been processed with errors. It may want to keep such images in the Hot Folder if:- images are imported manually (note that during automatic export, a corrupted file in the Hot Folder may prevent the other files in the Hot Folder from being processed);
- Hot Folder processing is often interrupted due to an unstable network connection.
- If required, change the default name of the import profile and add a comment.