XML Ticket

An XML ticket is an XML file that contains the processing parameters for one or several image files. An XML ticket may be created by the user or by the Open API. An XML ticket must be located in the Input folder together with the images to be processed.

If an image is put to the Input folder without an XML ticket, it will be processed using the parameters specified for the workflow. If you need to process the image using parameters (e.g. recognition language, text type, etc.) different from those of the workflow, you must create an XML ticket and put it into the Input folder together with the image.

Note. For information on creating an XML Ticket, please refer to the Open API help.

Important! You must put the XML ticket into the Input folder first and then put the images connected with the XML ticket in this folder. Otherwise ABBYY FineReader Server may process the images separately from the XML ticket.

If you set on the 1. Input tab of the Workflow Properties dialog box the mask for file extensions to "*.xml", all files in the Input folder will be processed using the settings in the XML description file. If there is no XML description file, input files will not be processed and will remain in the Input folder. The program will only begin processing these files when you add an XML description file.

XML ticket structure is nearly identical to the structure of the XmlTicket object in the Open API. See the Open API help file for details.

You can see an XML scheme for an XML ticket in the XmlTicket.xsd file which can be found in the Bin subfolder of the ABBYY FineReader Server folder.

You can specify several images in the XML ticket and export their recognition results into a PDF file. To do this, list the names of the image files with the help of <InputFile> elements and set the OutputFileFormat attribute of the <ExportParams> object to "PDF." You can also specify the output file naming rule, Output folder and export profile. To specify the export profile, use the <Scenario> attribute. You can use one of the following profiles: Balanced, MaxSpeed, MaxQuality or MinSize. Choosing the export profile allows you to optimize a PDF file for quality, output file size or processing speed. By default the Balanced profile is used.

Note. Results of processing multiple input files are stored in XMLResult.InputFiles[0].OutputDocuments.

Attribute values must be explicitly specified.

For instance, to specify SMTP connection settings, set OutputFlowType="SMTP" and provide the required parameters in the <SmtpSettings> tag:

<XmlTicket>
 <InputFile Name="test.pdf"/>
 <ExportParams>
   <ExportFormat OutputFileFormat="MSWord" OutputFlowType="SMTP" EmailSelectionMethod="SendByList">
     <OutputLocation>101@abbyy.com</OutputLocation>
       <SmtpSettings PortNumber="25" ServerRequiresAuthentication="false" UseSsl="false">
         <ServerHostName>dcmail.abbyy.ru</ServerHostName>
         <SenderAddress>rstester@dcmail.abbyy.ru</SenderAddress>
         <Password></Password>
        </SmtpSettings>
   </ExportFormat>
 </ExportParams>
</XmlTicket>

Below follows an example of an XML ticket which defines the following processing parameters: input images SampleImage1.jpg and SampleImage2.jpg must be converted to a single PDF file, which must be then saved in the folder C:\Users\Public\ABBYY\ABBYY FineReader Server 14\Default Workflow\Output Folder.

<XmlTicket>
<InputFile Name = "SampleImage1.jpg"/>
<InputFile Name = "SampleImage2.jpg"/>
<ExportParams DocumentSeparationMethod="MergeIntoSingleFile">
   <ExportFormat OutputFileFormat="PDF" OutputFlowType="SharedFolder" Scenario="Balanced">
      <OutputLocation>C:\Documents and Settings\All Users\Application Data\ABBYY Recognition Server 14.0\Default Workflow\Output Folder</OutputLocation>
   </ExportFormat>
</ExportParams>
</XmlTicket>

The other samples of XML tickets you can find in the Samples folder (Start > Programs > ABBYY FineReader Server 14 > Samples > XML Tickets). There are samples for the following processing operations:

  • Merging several images into one output document with a customized name
  • Changing the recognition language
  • Changing the output file formats
  • Export of output files in a SharePoint library
  • Export of output files to an e-mail address
See also

Architecture of ABBYY FineReader Server

XML Result

11/29/2022 5:26:42 PM

Please leave your feedback about this article

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.