Reports
PDF.PrintToPDF
The =ArupCompute.PDF.PrintToPDF(... function takes a HTML file and converts it to PDF with an Arup-branded border, the arguments are:
| Argument | Type | Description |
|---|---|---|
| html | filepath | Filepath to HTML document that is to be read and then rendered to PDF. If the input text does not end with '.html' it will automatically be added. |
| filepath | Filepath to write the generated PDF document to. If the input text does not end with '.pdf' it will automatically be added. | |
| author | text | Author's name to be added to the Arup-brand border of the PDF. |
| overwrite | boolean | TRUE / FALSE value for whether an existing PDF at the chosen location should be overwritten with new information. |
PDF generation is a slow and intensive process that is done on a remote sever. It is possible to overwhelm the server with requests, preventing others from using the service.
Please try not to overwhelm the service - do you really need a PDF of your calculation report? Instead of creating PDFs for every row in your spreadsheet can you instead just print the worst case? This guidance shows how to setup an Excel sheet to only print the most important reports.
If you just want to see the report then the HTML output can be viewed by opening the file in a web browser such as Chrome.
PDF.Combine
The =ArupCompute.PDF.Combine(... function joins together multiple PDF files into one, the arguments are:
| Argument | Type | Description |
|---|---|---|
| outputPath | filepath | Filepath that the combined document will be saved. |
| inputPath1 | filepath | Filepath to first PDF to be combined. |
| inputPath2 | filepath | Filepath to second PDF to be combined. |
| inputPath3 .. 20 | filepath | (Optional) Filepaths to up to 18 more PDF files to be combined. |
Unlike the PDF printer this operation happens locally and so can be used liberally.
HTML.Combine
The =ArupCompute.HTML.Combine(... function joins together multiple HTML files into one, the arguments are:
| Argument | Type | Description |
|---|---|---|
| outputPath | filepath | Filepath that the combined document will be saved. |
| inputPath1 | filepath | Filepath to first HTML to be combined. |
| inputPath2 | filepath | Filepath to second HTML to be combined. |
| inputPath3 .. 20 | filepath | (Optional) Filepaths to up to 18 more HTML files to be combined. |