Zanran Scaffolder

The Zanran Scaffolder extracts tables and text from PDF or image files. Tables are extracted as Excel or XML, text as XML. The Scaffolder is best for reports like financial statements, scientific papers, brokers reports... Initially, you can test your documents using the manual, anonymous, practice site: www.zanrandemoapi.com

Status: Preview

Tier: Premium

Version: 1.0

Actions:

Name	Summary
UploadDocument (file file, [Optional]integer startPage, [Optional]integer endPage, [Optional]string Coords)	Upload Document
GetStatus (string docname)	Get Status
DownloadFile-Xlsx (string docname)	Download results as Xlsx
DownloadFile-AllXml (string docname)	Download results as Zipped up Xml files
DownloadFile-Znr (string docname)	Download results as a Znr file

Triggers:

Name

Summary

Objects:

Name	Summary
file	file

Actions:

UploadDocument

Summary: Upload Document

Description: Upload Document

Syntax:

ZanranScaffolder.UploadDocument (file file, [Optional]integer startPage, [Optional]integer endPage, [Optional]string Coords)

Parameters:

Name	Type	Summary	Required	Related Action
file	file (file)	The document file to upload	True
startPage	integer (Start page)	Start page if analysing only a range	False
endPage	integer (End page)	End page if analysing only a range	False
Coords	string (Coords)	Coordinates of table to analyse (for processing a single page.) NOTE: this is a specialized requirement; if you wish to use this parameter, please contact us at helpdesk@zanran.com to ask how to proceed	False

Returns:

Type:string

GetStatus

Summary: Get Status

Description: Get the status of the document being uploaded - i.e. whether it is in the queue to be processed, being processed or has finished processing

Syntax:

ZanranScaffolder.GetStatus (string docname)

Parameters:

Name

Type

Summary

Required

Related Action

docname

string

(Document name without extension)

the original document file-name without the extension

True

Returns:

Type:string

DownloadFile-Xlsx

Summary: Download results as Xlsx

Description: Downloads the results of the table analysis as an Excel (Xlsx) document with separate worksheets for each table.

Syntax:

ZanranScaffolder.DownloadFile-Xlsx (string docname)

Parameters:

Name

Type

Summary

Required

Related Action

docname

string

(Document name without extension)

the original document filename without the extension

True

Returns:

Type:file

DownloadFile-AllXml

Summary: Download results as Zipped up Xml files

Description: Downloads a zip file containing the analysis results in Xml format (one Xml file per page)

Syntax:

ZanranScaffolder.DownloadFile-AllXml (string docname)

Parameters:

Name

Type

Summary

Required

Related Action

docname

string

(Document name without extension)

the original document filename without the extension

True

Returns:

Type:file

DownloadFile-Znr

Summary: Download results as a Znr file

Description: Downloads the results in the form of a Znr file which can then be viewed and edited by Pdf Workbench (a Zanran tool designed for this purpose)

Syntax:

ZanranScaffolder.DownloadFile-Znr (string docname)

Parameters:

Name

Type

Summary

Required

Related Action

docname

string

(Document name without extension)

the original document filename without the extension

True

Returns:

Type:file

file

Summary: file

Description: The document file to upload

Properties:

Name

Type

Summary