Skip to content

Latest commit

 

History

History
488 lines (406 loc) · 15.5 KB

project.md

File metadata and controls

488 lines (406 loc) · 15.5 KB

lib_fill_odt_pdf

ODFToolkit and PDF library

Connectors

void

Transactions

void

does nothing

Sequences

clean_outputs : Clean the generated files from the 'outputs' or 'read' directories

clean_outputs

Clean the generated files from the 'outputs' or 'read' directories. Can be used in a Convertigo scheduled job to automate the process. Variables : 'max_time' => delete only files older than x ms. 'all' => Delete all files in folder even in a max_time is defined. 'target' => if value is 'fill' searches for files in 'outputs' folder else in 'read' folder.

Variables

name comment
RequestableVariable all Set value to 'true' to directly delete all files whatever last modified date they have. Default is 'false', it only deletes files older than 'max_time'
RequestableVariable max_time Define the maximum time in millisecond before deleting the file. Default is 86400000ms (24h). Only works if 'all' is 'false'
RequestableVariable target

demo_u_fill_odt : Demo sequence to fill an ODT template file

demo_u_fill_odt

Demo sequence to fill an ODT template file.

demo_u_fill_pdf : Demo sequence to fill an ODT template file

demo_u_fill_pdf

Demo sequence to fill an ODT template file.

fill_odt : Fills an ODT template file (Deprecated)

fill_odt

Fills an ODT template file (Deprecated). Place your template files in .//templates/odf folder.

Variables

name comment
RequestableVariable date Date
RequestableVariable input_filename Input ODT template file name to fill (without extension, '.doc' is automatically added but format is ODT and can be opened as a Ms Word file or OpenOffice). Put your templates in /templates/odf
RequestableVariable objet Subject
RequestableVariable output_filename Output ODT file name (without extension). '.doc' is automatically added to filename to be opened by Ms Word or OpenOffice.
RequestableVariable signature Signature. Absolute Image file path.
RequestableVariable texte Main Body Text

fill_pdf : Fills a PDF template file (deprecated)

fill_pdf

Fills a PDF template file (deprecated). Place your template file in .//templates/pdf folder.

Variables

name comment
RequestableVariable date Date
RequestableVariable input_filename Input PDF template file name to fill (without extension, '.pdf' is assumed). Put your templates in /templates/pdf
RequestableVariable objet Subject
RequestableVariable output_filename Output PDF file name (without extension). '.pdf' is automatically added to filename.
RequestableVariable signature Signature. _ Image file. Can be an aboslute path file or relative to project (.//) or workspace (./). _ B64 string.
RequestableVariable texte Main Body Text

u_create_odt : Create a new Text document with a table

u_create_odt

Create a new Text document with a table.

Variables

name comment
RequestableVariable markers Structured array as follow :

[ { "tag": "<tag name in template file to replace with 'value' key>", "type": "<tag type. 'image' or 'string' supported>", "value": "<replacement string or image absolute path>" } ]>

RequestableVariable output_filename Output ODT file name (without extension). '.odt' is automatically added to filename to be opened by Ms Word or LibreOffice.

u_fill_odt : Fills an ODT template file (Universal)

u_fill_odt

Fills an ODT template file (Universal). Place your template files in .//templates/odf folder. It will output an attachment structure and if you call it with .bin requester it will trigger a download in the client Browser.

Variables

name comment
RequestableVariable input_filename ODT input template file name to fill. Can be an absolute path or a relative Convertigo path: ".//" is relative to the project's path. "./" is relative to the workspace path.
RequestableVariable markers Structured array as follow :

[ { "tag": "<tag name in template file to replace with 'value' key>", "type": "<tag type. 'image' or 'string' supported>", "value": "<replacement string or image absolute path>" } ]>

RequestableVariable output_filename ODT output file path. Can be an absolute path or a relative Convertigo path: ".//" is relative to the project's path. "./" is relative to the workspace path.

u_fill_pdf : Fills a PDF template file (Universal)

u_fill_pdf

Fills a PDF template file (Universal). Place your template file in .//templates/pdf folder. It will output an attachment structure and if you call it with .bin requester it will trigger a download in the client Browser.

Variables

name comment
RequestableVariable input_filename PDF input file path. Can be an absolute path or a relative Convertigo path: ".//" is relative to the project's path. "./" is relative to the workspace path.
RequestableVariable markers Structured array as follow :

[ { "tag": "<tag name in template file to replace with 'value' key>", "type": "<tag type. 'image' or 'string' supported>", "value": "<replacement string or image absolute path>" } ]>

RequestableVariable output_filename PDF output file path. Can be an absolute path or a relative Convertigo path: ".//" is relative to the project's path. "./" is relative to the workspace path.

u_read_odt : Dev sequence to read a table from a Text Document

u_read_odt

Dev sequence to read a table from a Text Document.

Variables

name comment
RequestableVariable markers Structured array as follow :

[ { "tag": "<tag name in template file to replace with 'value' key>", "type": "<tag type. 'image' or 'string' supported>", "value": "<replacement string or image absolute path>" } ]>

RequestableVariable output_filename Output ODT file name (without extension). '.odt' is automatically added to filename to be opened by Ms Word or LibreOffice.

u_read_pdf : Reads a PDF file (Universal)

u_read_pdf

Reads a PDF file (Universal). Place your template file in .//read folder. It will output the following structure : { "array": [ { "name": "", "value": "", "type": "PDF Form type" }, ...]

Variables

name comment
RequestableVariable input_filename PDF input file name to read the technical fields name and value. Can be an absolute path or a relative Convertigo path. ".//" is relative to the project's path. "./" is relative to the workspace path.