۶Ƶ PDF Services
With the ۶Ƶ Workfront Fusion ۶Ƶ PDF Services, you can extract data from a PDF file, or generate a new PDF file from data you supply. In addition, you can convert a variety of file types to PDFs, or PDFs to other file types. PDF Services also allow you to combine, compress, or read metadata for a PDF file, as well as control password protection on the file.
For instructions on creating a scenario, see the articles under Create scenarios: article index.
For information about modules, see the articles under Modules: article index.
For information on the API used for PDF Services, see .
Security considerations when using ۶Ƶ PDF Services
The ۶Ƶ PDF Services can read, convert, or modify your files, but neither ۶Ƶ nor Workfront Fusion store your files or data. This means that:
- You maintain control over your files, including their security
- You do not need to have an ۶Ƶ storage or cloud storage account to use the PDF Services.
Access requirements
You must have the following access to use the functionality in this article:
| table 0-row-2 1-row-2 2-row-2 3-row-2 layout-auto html-authored no-header | |
|---|---|
| ۶Ƶ Workfront package | Any |
| ۶Ƶ Workfront license |
New: Standard Or Current: Work or higher |
| ۶Ƶ Workfront Fusion license** |
Current: No Workfront Fusion license requirement. Or Legacy: Workfront Fusion for Work Automation and Integration |
| Product |
New:
Or Current: Your organization must purchase ۶Ƶ Workfront Fusion. |
For more detail about the information in this table, see Access requirements in documentation.
For information on ۶Ƶ Workfront Fusion licenses, see ۶Ƶ Workfront Fusion licenses.
Prerequisites
To create an OAuth Server-to-Server connection, you must add the ۶Ƶ PDF Services API in your ۶Ƶ Developers Console. When adding the API, select the OAuth Server-to-Server option.
For instructions, see In the ۶Ƶ developer documentation.
۶Ƶ PDF Services API information
The ۶Ƶ PDF Services connector uses the following:
Create a connection to ۶Ƶ PDF Services
To create a connection for your ۶Ƶ PDF Services modules:
-
In any ۶Ƶ PDF Services module, click Add next to the Connection box.
-
Fill in the following fields:
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 layout-auto html-authored no-header Connection type Select whether you want to create a server-to-server connection or a JWT connection. Connection name Enter a name for this connection. Client ID Enter your ۶Ƶ Client ID. This can be found in the Credentials details section of the ۶Ƶ Developer Console.
For instructions locating credentials, see in the ۶Ƶ developer documentation.
Client Secret Enter your ۶Ƶ Client Secret. This can be found in the Credentials details section of the ۶Ƶ Developer Console.
For instructions locating credentials, see in the ۶Ƶ developer documentation.
Technical account ID (JWT only) Enter your ۶Ƶ Technical account ID. This can be found in the Credentials details section of the ۶Ƶ Developer Console.
For instructions locating credentials, see in the ۶Ƶ developer documentation.
Organization ID (JWT only) Enter your ۶Ƶ Organization ID. This can be found in the Credentials details section of the ۶Ƶ Developer Console.
For instructions locating credentials, see in the ۶Ƶ developer documentation.
Meta scopes (JWT only) Enter any meta scopes needed for the connection. Private key If you have selected a JWT connection, enter the private key that was generated when your credentials were created in the ۶Ƶ Developer Console.
To extract your private key or certificate:
-
Click Extract.
-
Select the type of file you are extracting.
-
Select the file that contains the private key or certificate.
-
Enter the password for the file.
-
Click Save to extract the file and return to the connection setup.
-
-
Click Continue to save the connection and return to the module.
۶Ƶ PDF Services modules and their fields
When you configure PDF Services, Workfront Fusion displays the fields listed below. Along with these, additional fields might display, depending on factors such as your access level in the app or service. A bold title in a module indicates a required field.
If you see the map button above a field or function, you can use it to set variables and functions for that field. For more information, see Map information from one module to another.
- Combine PDF files
- Compress PDF files
- Convert document to PDF file
- Convert HTML to PDF file
- Convert image to PDF file
- Convert PDF to document
- Convert PDF to image
- Extract Text / Table
- Generate document
- Linearize a PDF file
- Make a custom API call
- OCR for PDF file
- Page manipulation
- PDF accessibility auto-tag
- PDF file properties
- Protect PDF file
- Remove protection of a PDF file
- Split a PDF file
Combine PDF files
This action module takes multiple PDF files and combines them into a single PDF file. For example, this module could combine all of the documents in a Workfront project into a single PDF upon completion of the project.
Select the connection to use for this module.
For instructions on creating a connection to ۶Ƶ PDF Services, see Create a connection to ۶Ƶ PDF Services in this article.
You can use an aggregator module to gather documents to combine into a PDF, or you can add the documents manually.
We recommend using an Array Aggregator module to aggregate output from a previous module. By using an aggregator, you do not need to know the names, locations, or numbers of files to combine. Using an aggregator is therefore much more flexible and scalable than manually entering the documents to be combined.
To use the Combine PDF files module with an aggregator, you must enable mapping on the Documents field.
In this example, the Read Related Records module identifies documents associated with a project, and the Download Documents module downloads each one. All of the PDFs are aggregated into an array, which is passed into the Combine PDF files module.
You can also enter documents manually.
For each document to include in the combined PDF:
-
Click Add a Document
-
In the Source file field, select the module that outputs the document you want to include, or map the source file's name and data.
-
(Optional) If you want to include only certain pages from the source file, for each page range that you want to add, click Add item in the Pages field, then enter the first and last pages of the page range to include, and click Add. You can include more than one page range from a single document.
-
Click Add.
Compress PDF files
This action module takes a PDF file and compresses it. This can be useful for conserving bandwidth or memory.
Convert document to PDF file
This tool converts a document to a PDF file. The source file must be one of the following document formats:
- DOC
- XLS
- PPT
- TXT
- RTF
Convert HTML to PDF file
This tool converts an HTML file to a PDF file.
Convert image to PDF file
This tool converts an image to a PDF file.
Convert PDF to document
This tool converts a PDF file to a document. You can select one of the following formats for the output file.
- DOC
- DOCX
- PPTX
- XLSX
- RTF
Convert PDF to image
This tool converts a PDF to an image in PNG or JPEG format., which is then output as a list or combined into a ZIP.
If output as a ZIP, the PDF is converted into one image per page, and each image ends with the page number. The image files are then combined into a ZIP file.
For example, a file called “TestFile” with 8 pages would produce 8 images, named “TestFile_1” through “TestFile_8.” The module’s output is a ZIP file containing the 8 images.
Extract Text / Table
This action module allows you to extract data from a PDF file. The module outputs individual text elements, such as a paragraph or the text in a single cell of a table.
Generate document
The Generate document module is a powerful way to create a PDF that contains data you select. You can format it by using a Microsoft Word template, or by providing data in JSON format.
For more information on the ۶Ƶ PDF Services Generate document functionality, see the in the ۶Ƶ Document Services documentation.
Use the Generate document module with a Microsoft Word template
To use the Generate document module with a Microsoft Word template, you must first create the template. For instructions, search for “Create a template” in the Microsoft Office documentation.
Fill in the Generate document module fields as follows:
Select the connection to use for this module.
For instructions on creating a connection to ۶Ƶ PDF Services, see Create a connection to ۶Ƶ PDF Services in this article.
Select a source file from a previous module, or map the source file's name and data.
This source file is the Microsoft Word template that the module uses to generate the new PDF.
We recommend creating a project in Workfront for the Microsoft Word templates that you use in Workfront Fusion. You can then use the Workfront > Download document module to pull the appropriate template into your scenario.
Select the format for the generated document.
-
PDF
-
DOCX
For each value tag in your template that you want to replace with text, fill in the following:
-
Key
Enter a key. In the template, the key is the text shown in the value tag. For example, if you want to place text in the value tag
{{name}}, enternamein the key field. -
Value Type
Select whether the data in the value field is a value, an object, or an array of objects.
-
Value
Enter or map the text that you want to appear in the generated document in place of the value tag.
Use the Generate document module with JSON
To use the Generate document module with JSON, fill in the fields as follows:
Linearize a PDF file
This tool linearizes a PDF document to create a web-optimized PDF document. A linearized PDF document can be viewed page-by-page without needing to download the entire document.
Make a custom API call
This action module a custom HTTP request to the PDF Services API.
Select the connection to use for this module.
For instructions on creating a connection to ۶Ƶ PDF Services, see Create a connection to ۶Ƶ PDF Services in this article.
Add the headers of the request in the form of a standard JSON object.
For example, {"Content-type":"application/json"}
Workfront Fusion adds the authorization headers automatically.
Add the query for the API call in the form of a standard JSON object.
For example: {"name":"something-urgent"}
For each field that you want to add to the API call, click Add item and enter the field's key and optional value.
Note:
When using conditional statements such as if in your JSON, put the quotation marks outside of the conditional statement.
OCR for PDF file
This tool performs Optical Character Recognition (OCR) on a file and produces a PDF.
Page manipulation
This module allows you to selectively rotate or delete pages in a PDF document. For example, you can change portrait view to landscape view or remove certain pages from the PDF document.
PDF accessibility auto-tag
This action module creates a PDF that is tagged for accessibility use cases. It also creates an optional Microsoft Excel report that lists problems and suggests fixes.
PDF file properties
This tool extracts basic information about the document, such as:
- Page count
- PDF version
- Whether the file is encrypted
- Whether the file is linerarized
- Whether the file contains embedded files
Protect a PDF file
This tool secures a PDF document with a user or owner password. It also sets restrictions on certain features like printing, editing, and copying in the PDF document. You select the type of content to be encrypted and the encryption algorithm.
Remove protection of a PDF file
This tool removes security (password protection) from a PDF document.
Split a PDF file
This action module splits a PDF document into multiple smaller documents. You specify whether to split it by number of files, pages per file, or page ranges.