Article last updated on the 15th of February, 2024.
The contents of this article may be subject to change due to ongoing development of WorkPoint Automate.
The Convert selected Documents to PDF step takes a set of documents and converts them into one of the supported PDF formats.
The step can e.g. be run from the "Send to" menu in a document library, or from a My Tools button.
This step can also be used to combine multiple documents into one PDF document. This can be done using the settings in the "Combine" tab.
In the following image, a process includes simply the Convert selected documents to PDF step:
The process can then be run from the Documents library of an entity, such as a client or case, using the documents selected in the library.
The following image shows the settings for the Convert selected Documents to PDFs step:
Step specific properties
| Parameter name | Type | Required | Description |
|---|---|---|---|
| Options | |||
| Destination Business Module | String | Yes | Use this field to select the business module of the destination entity. |
| Destination Entity Id | Integer | Yes | Use this field to define the ID of the destination entity. |
| Destination Library | String | Yes | Use this field to define the destination library on the destination library. |
| Destination Folder | String | No | Use this field to select a destination folder for the converted document(s). |
| Output exists behavior | String | Yes | Use this field to select what to do if a file with the same name as a converted document already exists. Options are:
|
| PDF format | String | Yes | Use this field to select the output PDF format. Options are:
|
| Load source property values | Boolean | No | Use this field to define if this step should use the values from the step input when creating PDFs. This setting is not applicable in Combine Files Mode. |
| Add page numbers | Boolean | No | Use this field to define whether this step should add page numbers to the document(s) being converted. The page numbers added by this setting will appear in the bottom center of the document as white numbers on a black background. |
| Version | String | No | Use this field to define if a version number should be inherited from the source to the converted PDF. Options are:
|
| Options | |||
| Combine Files | Boolean | No | Use this field to define if the documents being processed by this step should be combined into a single PDF document. |
| Combined file properties | Object | No | If "Combine Files" is set to "Yes", use this field to define an object which provides the properties of the PDF output file. Typically, an Item form object is used in this field. |
| Add Index | Boolean | No | Use this field to define if the first page in the combined PDF file should include an Index. The Index contains information about which documents were merged into the resulting PDF. |
| Add source information | Boolean | No | Use this field to define if the Index in the PDF should include a direct link to the documents combined into the resulting PDF. |
|
Async | |||
| Async | Boolean | No | Select this option if you want to run the process in asynchronous operation. |
| Callback Url | String | No | Option for Callback Url. |
| Callback Headers | String | No | Option for Callback Headers. |
Notes
The minimum information required for the Converts selected Documents to PDFs to work the objects being passed into the step input field must contain the following properties:
- List ID
- URL to the site
- File names
- Item IDs
Comments
0 comments
Please sign in to leave a comment.