lib_fill_odt_pdf

ODFToolkit and PDF library

For more technical informations : documentation

• Installation
• Sequences
  • clean_outputs
  • demo_u_fill_odt
  • demo_u_fill_pdf
  • demo_u_fill_table_odt
  • fill_odt
  • fill_pdf
  • getInstalledFonts
  • init_config
  • u_create_odt
  • u_fill_odt
  • u_fill_pdf
  • u_read_odt
  • u_read_pdf

Installation

1. In your Convertigo Studio use File->Import->Convertigo->Convertigo Project and hit the Next button

2. In the dialog Project remote URL field, paste the text below:

   Usage	Click the copy button
   To contribute	lib_fill_odt_pdf=https://github.com/convertigo/c8oprj-lib-odftoolkit.git:branch=1.9.6_full_styles
   To simply use	lib_fill_odt_pdf=https://github.com/convertigo/c8oprj-lib-odftoolkit/archive/1.9.6_full_styles.zip

3. Click the Finish button. This will automatically import the lib_fill_odt_pdf project

Sequences

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
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'
max_time	Define the maximum time in millisecond before deleting the file. Default is 86400000ms (24h). Only works if 'all' is 'false'
target

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_table_odt

Demo sequence to fill an ODT template file.

fill_odt

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

variables

name	comment
date	Date
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
objet	Subject
output_filename	Output ODT file name (without extension). '.doc' is automatically added to filename to be opened by Ms Word or OpenOffice.
signature	Signature. Absolute Image file path.
texte	Main Body Text

fill_pdf

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

variables

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

getInstalledFonts

Get installed Fonts

init_config

Auto start sequence to install some required fonts for Docker Linux Platform.

u_create_odt

Create a new Text document with a table.

variables

name	comment
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>" } ]>
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). 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
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.
markers	Structured array as follow : [ { "tag": "<tag name in template file to replace with 'value' key>", "type": "<tag type. 'image', 'string', 'span' (font styles), 'table' and 'tableh' (title row) supported>", "style": "<Font styles for span or table cells. Look at demo_u_fill_odt for syntax>" "value": "<replacement string or image absolute path>" } ]>
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). 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
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.
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>" } ]>
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.

variables

name	comment
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>" } ]>
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). Place your template file in .//read folder. It will output the following structure : { "array": [ { "name": "", "value": "", "type": "PDF Form type" }, ...]

variables

name	comment
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.