upload from hot folder

  • Last Post 15 October 2018
  • Topic Is Solved
Shams Shahriar Sharif posted this 25 January 2017

dear all,

when i am drop one pdf file into the hot folder location then abbyy upload those file automatically and create by default batch name like (Batch HF_ID14554) . how could  i create batch name as my recruitment file name EXAMPLE  ( my file name like "QCV00000000001" batch name must be like "QCV00000000001")

Attached Files

Order By: Standard | Newest | Votes
Ekaterina posted this 30 January 2017


You may use the “after batch created” event in the Event Handler tab in the Project properties to rename the created batch as desired.

Shams Shahriar Sharif posted this 30 January 2017


can you told me please which type of script (VBscript, Javascript, C#.net or Others) i will use and can you send me a example of script how could i write. 

Ekaterina posted this 31 January 2017


You may use any supported language but you should write all your scripts in one language only.

To write your script you should use the “Name” property of the IBatch object. You may see more details in this article: Appendix > Using scripts in ABBYY FlexiCapture > Scripts for customizing processing stages > Objects > IBatch

You may see the code samples here: Appendix > Using scripts in ABBYY FlexiCapture > Scripts for customizing processing stages > Sample scripts > Sample scripts for creating custom rules

Shams Shahriar Sharif posted this 01 February 2017


i am facing same type of problem. there have no batch create scripts.I need batch name as like my file name when upload from hot folder 

please give me a solution urgently.

Ekaterina posted this 01 February 2017


In the frame of CaptureDoc resource, we do not send custom code samples. For this purpose, you may contact your regional support.

Andrey posted this 01 February 2017

Hi, Ekaterina.

Can you give direction how I can reach filename from IBatch in "After batch created" script? I could not find.

Andrey posted this 01 February 2017

Found solution:

Create handler:


With script:



It will work only if you create batch from one file. Otherwise every page will replace the batch name, and last added page will defile the name.

Ekaterina posted this 02 February 2017

Hello Andrey,

Because the FlexiCapture program allows to combine different files to one document, you should take only one file name for renaming. For example, take the first file of the first document. For doing this you may create the new Scripting Stage in the Advanced Workflow (note that you need to choose the batch processing type) and use the following construction:

if (Documents.Count > 0)


string filename = Documents[0].Pages[0].ImageSourceFileSubPath.ToString();

Batch.Name = // create replace string based on filename here


Shams Shahriar Sharif posted this 06 February 2017




Ekaterina posted this 08 February 2017


Batch registration parameters can be accessed and modified by IBatch.Properties.Set/Get methods, please see the description here: Application Programming Interface (API) > References > Data Types > Batch 

KofiB posted this 08 February 2018

Hello Ekateriana,


Can you please share a sample script on extracting registration parameters like EmailSender from the batch. The sources you referenced are not clear enough and it will be helpful if you could just share a sample

Ekaterina posted this 22 February 2018


IBatch: : Properties.Set(string "parameter name") - to create a named parameter

string IBatch: : Properties.Get(string "parameter name") - to read a named parameter.


Here is the excerpt from the ABBYY FC11 Developer's Help about message header details:


Storing basic message header details in the registration parameters:


When you import images from an e-mail folder using the MAPI or POP3 server protocols, information about the message will be automatically added to the registration parameters of the batch you are creating. The following parameters are added: 

• fc_Predefined:EmailSubject 

The message's subject.

• fc_Predefined:EmailSender 

The message's name.

• fc_Predefined:EmailAddressee 

The message's name.

• fc_Predefined:EmailDate 

The date and time when the message was received.


 Note: If you don't want information about the message to be added to the batch's registration parameters, set the following registry key: 


[HKEY_CURRENT_USER\Software\ABBYY\FlexiCapture\11.0\Controller] "UseHotFolderSpecialParameters"="false". 


(The "Registration Parameters" article)

Sunil Edupuganti posted this 09 October 2018

Hi Ekaterina,

How to display the Recognized Vendor Name in place of Batch Name?

Ekaterina posted this 15 October 2018


Please see the answer on your question in this topic: