Platform Explorer / Nuxeo Platform 11.3

Operation PDF.ExtractInfo (PDF: Extract Info)

Description

Extract the info of the PDF stored in xpath and put it in the fields referenced by properties. properties is a key=value list (one key-value pair/line, where key is the xpath of the destination field and value is the exact label (case sensitive) as returned by the PageExtractor (see this operation documentation). If there is no blob or the blob is not a PDF, all the values referenced in properties are cleared (set to empty string, 0, ...).
Operation id PDF.ExtractInfo
Category Document
Label PDF: Extract Info
Requires
Since

Parameters

Name Description Type Required Default value
properties properties no  
save boolean no true 
xpath string no file:content 

Signature

Inputs document, documents
Outputs document, documents

Implementation Information

JSON Definition

{
  "id" : "PDF.ExtractInfo",
  "label" : "PDF: Extract Info",
  "category" : "Document",
  "requires" : null,
  "description" : "Extract the info of the PDF stored in <code>xpath</code> and put it in the fields referenced by <code>properties</code>. <code>properties</code> is a <code>key=value</code> list (one key-value pair/line, where <code>key</code> is the xpath of the destination field and <code>value</code> is the exact label (case sensitive) as returned by the PageExtractor (see this operation documentation). If there is no blob or the blob is not a PDF, all the values referenced in <code>properties</code> are cleared (set to empty string, 0, ...).",
  "url" : "PDF.ExtractInfo",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ {
    "name" : "properties",
    "description" : null,
    "type" : "properties",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "save",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "true" ]
  }, {
    "name" : "xpath",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "file:content" ]
  } ]
}