PDF

Purpose¶

Generate PDFs from HTML files and merge PDFs.

Methods¶

Binding name: p6.pdf

fromHtml¶

Generates a PDF from an HTML string at location specified by targetUri. Returns the URI written to.

Syntax

String p6.pdf.fromHtml(String html[, String targetUri = null])

Warning

The CSS of the HTML must be version 2.1 max.

The targetUri must point to a local file (e.g. protocol file: only).

Tip

To use a temporary file, set null to the parameter targetUri

Example

Temporary file

p6.pdf.fromHtml("<b>Bold</b> text")

Specify the target

p6.pdf.fromHtml("<b>Bold</b> text", "p6file://${P6_DATA}/path/to.pdf")

merge¶

Merges PDFs specified in the List of sourceUris and write the result to targetUri. Returns the URI written to.

Syntax

String p6.pdf.merge(List<String> sourceUris[, String targetUri])

Warning

The targetUri must point to a local file (e.g. protocol file: only).

Tip

To use a temporary file, set null to the parameter targetUri

Example

Temporary file

p6.pdf.merge(["p6file://${P6_DATA}/path/pdf1.pdf", "p6file://${P6_DATA}/path/pdf2.pdf"])

Specify the target

p6.pdf.merge(["p6file://${P6_DATA}/path/pdf1.pdf", "p6file://${P6_DATA}/path/pdf2.pdf"], "p6file://${P6_DATA}/path/to.pdf")

parse¶

Parses the PDF file specified in the configuration map and calls the given closure with each row processed.

Syntax

void p6.pdf.parse(Map<String, Object> configuration, Closure rowNotify)

Example

def cnf = [
    area0: '402.89,17.24,550.29,64.89',
    area1: '30.6,346.29,195.95,150.07',
    pages: '1,2',
    uri: 'p6file://${P6_DATA}/00140_Facture Alfa.pdf'
]

p6.pdf.parse(cnf) { pageNumber, row ->
    println( pageNumber + ": " + row )
    if ( pageNumber == 2) false         // Returning false will halt page iteration
    else true
}

def cnf = [
    columns0: '0,25.0,71.3,180.53,462.91,504.42,535.45,585.68,643.15,714.6',
    uri: 'p6file://${P6_DATA}/00140_Facture Alfa.pdf'
]

p6.pdf.parse(cnf) { pageNumber, row ->
    println( pageNumber + ": " + row )
}

parseToList¶

Parses the PDF file specified in the configuration map returning the processed values as a List of Tuples (pageNumber, row).

Syntax

List<Tuple> p6.pdf.parseToList(Map<String, Object> configuration)

Parameter: configuration

Configuration Name	Description
`password`	(Optional) Password to use to decrypt the pdf
`spreadsheetDisabled`	(Optional) Force PDF not to be extracted using spreadsheet-style extraction (if there are ruling lines separating each cell, as in a PDF of an Excel spreadsheet). The default is true.
`areaFail`	(Optional) If a configured area does not select text on a page a P6Exception is thrown, unless this value is false. The default is true
`areaN`	(Optional) `N` is a zero based numeric. If no area(s) are given, the whole of each page will be used as the bounding area. All areas defined will be applied to each page specified. Area format is defined in ‘Points’ and can be identified using OSX Preview via ‘Rectangular Selection’ mode. A comma separated string is required: `'{top},{left},{width},{height}'`
`columnsN`	(Optional) `N` is a zero based numeric. A comma separated list of X coordinates of column boundaries.
`uri`	(Mandatory) The URI of the source PDF file to parse.
`pages`	(Optional) If not specified, all pages in the source file will be processed. A comma separated string list of page numbers is required.

Example

def cnf = [
    area0: '402.89,17.24,550.29,64.89',
    areaFail: false,
    uri: 'p6file://${P6_DATA}/00140_Facture Alfa.pdf'
]

def lstTuples = p6.pdf.parseToList(cnf)

lstTuples.each { tup ->
    println( tup.get(0) + ": " + tup.get(1) )
}

split¶

Copy pages from a source PDF file to a destination PDF file.

Syntax

void p6.pdf.split(Map<String, Object> configuration)

Parameter: configuration

Configuration Name	Description
`password`	(Optional) Password to use to decrypt the pdf
`keepAnnotations`	(Optional) true to retain any annotations in the destination (default: false)
`startPage`	(Mandatory) A one based numeric specifying the first page to copy to the new destination
`endPage`	(Mandatory) A one based numeric specifying the last page (and all pages in between) to copy to the new destination
`sourceUri`	(Mandatory) The URI of the source PDF file
`destinationUri`	(Mandatory) The URI of the destination PDF file. Destination will always be overwritten

Example

def cnf = [
    startPage: 3,
    endPage: 4,
    sourceUri: 'p6file://${P6_DATA}/00140_Facture Alfa.pdf',
    destinationUri: 'file:/tmp/page4.pdf'
]

p6.pdf.split(cnf)

sign¶

Sign the PDF file specified in the configuration map and write the result to the targetUri. Returns the URI written to.

Syntax

String p6.pdf.sign(Map<String, Object> configuration)

Warning

The targetUri must point to a local file (e.g. protocol file: only).

Tip

To use a temporary file, set null to the parameter targetUri

Parameter: configuration

Configuration Name	Description
`keyStoreUri`	(Mandatory) The URI of the KeyStore file (PKCS12)
`keyStorePassword`	(Optional) Password to open the KeyStore
`keyStoreAlias`	(Optional) Alias to use in the KeyStore. (First one will be used by default)
`uri`	(Mandatory) The URI of the source PDF file to parse.
`password`	(Optional) Password to use to decrypt the pdf
`tsa`	(Optional) URL of the TSA server to timestamp the signed file
`reason`	(Optional) The signature reason.
`targetUri`	(Optional) The URI of the target signed PDF file.

Example

def cnf = [
    keyStoreUri: 'file://${P6_DATA}/keystore.p12',
    keyStorePassword: '123456',

    uri: 'file://${P6_DATA}/source.pdf',
    reason: 'Signed on Platform6',
    targetUri: 'file://${P6_DATA}/signed.pdf'
]

println "Signed PDF path:" + p6.pdf.sign(cnf)

Tip

You can generate a p12 file for your tests using the command line:

openssl req -x509 -newkey rsa:1024 -keyout key.pem -out cert.pem -days 365
openssl pkcs12 -export -out keyStore.p12 -inkey key.pem -in cert.pem -name test