This function takes an input file of various types and extracts textual information from it, which can be further processed. This API is the central heart that allows a wide variety of documents to be uploaded and decoded.

Use this API if you wish to decode and extract information from various document types, such as images, spreadsheets or PDF documents

Typically, this API is called by other functions to assist them. It can be called directly but the output it generates is designed to be consumed and further refined. It may also take a noticeable time to process. Depending on what type of file is loaded.

Related API: gds.documentgen.decode.file Analyses the file type (PDF, DOCX, PNG ...) but does not extract any content

Try it now

<form method="POST" action="/gnap/M/buck"
	target='xxx' enctype="multipart/form-data">

<input type='hidden' name='f3_s'
	value='gds.documentgen.extract.file'>

Input File <input type=file name='f110_s'>

<input type='submit' value='Execute'>
</form>

Select a file, such as Excel (xlsx), PDF, PNG, TIFF, JPG, BMP.... and the API will extract and decode it. Results will open in a new window

Input Specification

Output Specification

The output of this API is a structure describing both the document and optionally its decoded meaning.

<DATS>
  <DecodeMethods>1</DecodeMethods>
  <DATS>...</DATS>		- Array of FIFB blocks
  <DOCU>...</DOCU>		- Document fields
  <DOCC>...</DOCC>		- Cleaned document fields
  <GRID>...</GRID>		- Layout information
</DATS>

Top Level Fields

This function allows you to upload an Excel spreadsheet and the system will decode the contents and return a data packet with the contents. Excel is an advanced product and the representation of the spreadsheet will not contain all attributes and abilities; this function is primarily about extracting tables of information.

gds.documentgen.extract.file

This function allows you to upload a complete file and have the system attempt to decode it and the contents but without updating any part of the system. You can upload XLSX, JPEG, PNG, TIFF, GIF files. If the document is an image, the system automatically calls OCR routines to read the document first.

The invoice at the left shows an invoice that has been photographed and highlights the fields that the gds.documentgen.extract.file will attempt to decode. For clarity, only some fields are shown.

Call Arguments

Return Data

Several arrays of information are returned about the document, but these are limited to what can be gleaned without reference to your data. Essentially this function is reading the document but not applying any context awareness such as locating product names. If you wish to have context awareness call the function retailmax.elink.utility.document.decode which internally calls this function and then applies analysis to further decode the document

DOCU & DOCC Structure

This structure defines an document in terms of items found on the page, such as "date" or "invoce number". The DOCU structure is identical to the DOCC, the only difference is the DOCU contains raw data and the DOCC contains data that has been cleaned to what a reasonable person might do. For example, DOCU will report a number as 17.BB, while the DOCC might convert this to 17.88 DOCC may also use information from other scanned documents to complete its information. For example, a GST number that scans as "88-45Be~$y" may be presented as "88-458-126" in the DOCC

LINE Structure

This packet is a subtype of DOCU and DOCC. It holds the repeating lines on documents such as invoices and packing slips

AGNT Structure

This packet is a subtype of DOCU and is added by agent programs that created or altered this DOCU structure. The AGNT block allows program to see which programs and versions supplied information.

__DATE__ " " __TIME__