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.

XML Ticket structure is nearly identical to the structure of the XmlTicket object in the Open API. Most object properties have corresponding XML attributes, and the objects themselves have corresponding XML elements.

Important! Enumeration constants are specified without prefixes, for example:

RTFSynthesisMode = "PlainText"

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.

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.

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.

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.0\Default Workflow\Output Folder.

<InputFile Name = "SampleImage1.jpg"/>
<InputFile Name = "SampleImage2.jpg"/>
<ExportParams DocumentSeparationMethod="MergeIntoSingleFile">
   <ExportFormat OutputFileFormat="PDF" OutputFlowType="SharedFolder">
      <OutputLocation>C:\Users\Public\ABBYY\ABBYY FineReader  Server 14.0\Default Workflow\Output Folder</OutputLocation>

See also

Com-based API: XmlTicket Object, XML Result

Web Services API: XmlTicket Object, XML Result

26.03.2024 13:49:49

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.