DocumentationWorkfrontWorkfront Guide

Workfront Proof modules

Last update: Thu Nov 21 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User

In an Adobe Workfront Fusion scenario, you can automate workflows that use Workfront Proof, as well as connect it to multiple third-party applications and services.

This is useful if you need to execute tasks currently not supported in proofing within Workfront or in Workfront Proof, such as updating proofs based on certain events and searching for a proof’s recipients.

The Workfront Proof connector does not count against the number of active apps available to your organization. All scenarios, even if they use only the Workfront Proof app, do count against your organization’s total scenario count.

If you need instructions on creating a scenario, see Create a scenario in Adobe Workfront Fusion.

For information about modules, see Modules in Adobe Workfront Fusion.

Access requirements

You must have the following access to use the functionality in this article:

Adobe Workfront plan*
Pro or higher
Adobe Workfront license*
Plan, Work
Adobe Workfront Fusion license**

Current license requirement: No Workfront Fusion license requirement.

Or

Legacy license requirement: Workfront Fusion for Work Automation and Integration, Workfront Fusion for Work Automation

Product

Current product requirement: If you have the Select or Prime Adobe Workfront plan, your organization must purchase Adobe Workfront Fusion as well as Adobe Workfront to use functionality described in this article. Workfront Fusion is included in the Ultimate Workfront plan.

Or

Legacy product requirement: Your organization must purchase Adobe Workfront Fusion as well as Adobe Workfront to use functionality described in this article.

To find out what plan, license type, or access you have, contact your Workfront administrator.

For information on Adobe Workfront Fusion licenses, see Adobe Workfront Fusion licenses.

Workfront Proof information

The Workfront Proof connector uses the following:

API version
v21.3.0
API tag
v1.8.92

Connect Workfront Proof to Workfront Fusion

You can create a connection to your Workfront Proof account directly from inside a Workfront Fusion module.

  1. In any Workfront Fusion module, click Add next to the Connection field

  2. 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 name Enter a name for the connection
    connections.environmentType Select whether this is a Production environment, or a non-production environment such as Preview or Sandbox.
    connections.authenticationType Select whether this is a Service account or a Personal account.
    Email / Username Enter username for your Workfront Proof account.
    Password Enter the password for your Workfront Proof account.
    Tenant ID

    Note: Customers that do not use BYOK must leave this field blank.

    Enter the Tenant ID for this account. If you need help finding your Tenant ID, contact Workfront Customer Support.
    Domain Extension

    Enter the extension for the URL you use to access your account.

    Example: com or eu
    Production, Preview, or Custom Environment Select a connection to a production, preview, or a custom environment.

  3. Click Continue to save the connection and return to the module

Workfront Proof modules and their fields

When you configure Workfront Proof modules, Workfront Fusion displays the fields listed below. Along with these, additional Workfront Proof fields might display, depending on factors such as your access level in the app or service. A bolded 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 in Adobe Workfront Fusion.

Triggers

Watch Proofs

This scheduled trigger module executes a scenario when someone creates or makes a decision on a proof.

The module returns a list of all of the records it finds during the period you specify, along with their types. It also returns the values of the fields you specify. If the module found decisions made on the proof, it includes both the previous and the current values, in separate fields. You can map this information in subsequent modules in the scenario.

This happens on a regularly scheduled interval that you specify.

You must have sufficient permissions to access the proof or proofs in Workfront Proof in order to retrieve this information.

When you are configuring this module, the following fields display.

Connection
For instructions about connecting your Workfront Proof account to Workfront Fusion, see Create a connection to Adobe Workfront Fusion - Basic instructions.
Record Type
Select the type of Workfront Proof record that you want the module to watch.
Outputs
Select the information you want included in the output bundle for this module.
Limit
Enter or map the maximum number of records you want the module to return during each scenario execution cycle.

Watch for PDF Summary

This instant trigger module executes a scenario when someone creates a PDF summary for a proof.

A webhook is required in this module.

The module returns all standard fields associated with the proof, along with any custom fields and values that the connection accesses. It also creates a new event subscription for PDF summaries and outputs the content from the “pdf_url” attribute sent in the payload. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection
For instructions about connecting your Workfront Proof account to Workfront Fusion, see Create a connection to Adobe Workfront Fusion - Basic instructions.
Webhook
You can select an existing webhook or create a new one. For more information, see Instant triggers (webhooks) in Adobe Workfront Fusion.
Limit
Enter or map the maximum number of records you want the module to return during each scenario execution cycle.

Watch Proof Activity

This trigger module executes a scenario whena specified activity occurs on a proof proof.

The module returns all standard fields associated with the proof, along with any custom fields and values that the connection accesses. It also creates a new event subscription for PDF summaries and outputs the content from the pdf_url attribute sent in the payload. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection
For instructions about connecting your Workfront Proof account to Workfront Fusion, see Create a connection to Adobe Workfront Fusion - Basic instructions.
Activity type
Select whether you want to watch any new decision (including proof status changes), or overall proof status changes only.
Limit
Enter or map the maximum number of records you want the module to return during each scenario execution cycle.

Actions

Create Proof

This action module creates a new proof or a new version of a proof in Workfront Proof.

You specify the parameters for the new proof and the source proof if you are creating a new version.

The module returns the ID of the new proof or proof version.You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection
For instructions about connecting your Workfront Proof account to Workfront Fusion, see Create a connection to Adobe Workfront Fusion - Basic instructions.
Proof Type

Specify whether you want the proof that is created to have a basic workflow or an Automated Workflow.

Then fill out the fields that display for the proof type you chose. For example, if you chose Automated Workflow, fill out the Workflow Stages field to configure the stages.

Allow original file to be downloaded
Select whether you want to allow the original file that the proof was created from to be downloaded.
Classic Proof Viewer
Select whether you are using the Classic Proof Viewer.
Combine all files into single proof
Enable this option to combine all files into a single multi-page proof.
Create a new proof version
Select this option if you want the module to create a new version of an existing proof. Then, in the Existing Proof ID field that displays, map or enter the unique ID of the proof.
Custom Link Label
Enter or map a label for the custom proof link.
Custom Link URL
Enter or map the URL for the custom link.
Default email notifications for subscribers

Type one of the following numbers to indicate which of the following default email notification settings you want to use for the proof that is created.

  • 1 - All new comments and replies
  • 2 - Replies to my comments
  • 3 - Daily summary
  • 4 - Hourly summary
  • 5 - Decisions only
  • 9 - Disabled
Disable Excel Summary
Select whether you want to disable the ability to download proof comments to an Excel file.
Disable PDF Summary
Select whether you want to disable the ability to download proof comments to a PDF file.
Disable Subscription Email
Select whether you want to disable the subscription email for this proof.
Enable Embed Player
Select whether you want to enable the embedded player for this proof.
Enable Subscriptions
Select whether people who are not participants are allowed to subscribe to the proof.
If you select this option, you can also select the Default Role for subscribers, as described in this table.
Enable Subscriptions Validation
Select whether you want to enable subscription email validation. If this is enabled, the subscriber must click a link in an email to access a proof.
Enable Team URL
Select whether you want the proof that is created to hide or show the team URL.
File Hash or File Hashes
Add the ID of the file or files from which you want to create a proof or proofs.
File Names
Add the file name or names for the proof that is created This is a required field.
Lock proof when all required decisions are made
Specify whether you want the proof that is created to lock after all required decisions are made.
Notify recipients about this proof
Select an option to indicate whether you want recipients notified when the proof is created.>
Proof name
Type a name for the proof that is created This is a required field. Use a pipe symbol (|) to separate names for multiple proofs.
Proof owner ID
Enter or map the ID of the proof owner. If this field is left blank, the proof owner is set to the current user.
Reference ID
Enter the reference ID for the proof.
Require electronic signature
Select whether you want to require an anyone who makes a decision on a proof to submit an electronic signature.
Require login

Specify whether you want the proof that is created to require a login.

This is the same as the Login Required setting explained in Configure Proof Settings in Workfront Proof

Resolution ID
Enter the ID of the resolution you want to use for your proof. For a list of resolution IDs, see the Workfront Proof API documentation.
SWF
Enter the type of SWF proof.
Show [item]
For each item, select whether you want to show it in the proof.
Workspace ID
Enter the ID of the workspace you want to create the proof in.
Recipients
Add the email addresses of the recipients you want for the proof that is created .
Deadline

Specify the deadline you want for the proof that is created. Use the following date format:

YYYY-MM-DD hh:mm

Custom API Call

This action module lets you make a custom authenticated call to the Workfront Proof API. This way, you can create a data flow automation that can’t be accomplished by the other Workfront Proof modules.

The module returns the status code, headers and body. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection
For instructions about connecting your Workfront Proof account to Workfront Fusion, see Create a connection to Adobe Workfront Fusion - Basic instructions.
Method
Set the action for the API call. For available actions, see the Proof API documentation.
Body (XML)

Add the body content for the API call in the form of a standard JSON object.

Note:

When using conditional statements such as if in your JSON, put the quotation marks outside of the conditional statement.

INFO
Example:

Download Proof

This action module downloads the source file of a particular proof that you identify using its ID.

You specify the proof’s ID.

The module returns the content of the source file used to create the proof.You can map this information in subsequent modules in the scenario.

You must have sufficient permissions to access the record in Workfront Proof in order to retrieve this information.

When you are configuring this module, the following fields display.

Connection
For instructions about connecting your Workfront Proof account to Workfront Fusion, see Create a connection to Adobe Workfront Fusion - Basic instructions.
Proof ID
Type the unique ID of the proof, found on the Proof Details page. For more information, see Manage Proof Details in Workfront Proof.

Read a Record

This action module reads data from a single proof in Workfront Proof.

You specify the proof’s ID and the information you want from the proof.

The module returns the values of the fields you choose for the proof, along with their types. You can map this information in subsequent modules in the scenario.

You must have sufficient permissions to access the record in Workfront Proof in order to retrieve this information.

When you are configuring this module, the following fields display.

Connection
For instructions about connecting your Workfront Proof account to Workfront Fusion, see Create a connection to Adobe Workfront Fusion - Basic instructions.
Record Type
Select whether you want to read a proof, proof comments, or proof reviewers.
Outputs
Select the information you want included in the output bundle for this module.
ID
Enter or map the unique Workfront Proof ID of the record that you want the module to read.

Request PDF Summary

This action module requests the PDF summary for a particular proof in Workfront Proof.

You specify the proof’s ID.

The module returns PDF summary information. You can map this information in subsequent modules in the scenario.

You must have sufficient permissions to access the record in Workfront Proof in order to retrieve this information.

When you are configuring this module, the following fields display.

Connection
For instructions about connecting your Workfront Proof account to Workfront Fusion, see Create a connection to Adobe Workfront Fusion - Basic instructions.
Proof ID
Enter the unique Workfront Proof ID of the proof for which you want to request a PDF summary.
Callback URL
Enter or map the URL where you want the PDF summary sent.
Possible error
  • Error: “You do not have privilege to perform this request. The stage must contain at least one recipient.”
  • Solution: Make sure you are not the only one assigned to the stages of the workflow. There must be another user assigned to the stages of the workflow.

Update Proof

This action module updates an existing proof in Workfront Proof.

You specify the proof’s ID and record type and what fields you want to include in the output.

The module returns any standard fields associated with the record, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

You must have sufficient permissions to access the record in Workfront Proof in order to retrieve this information.

When you are configuring this module, the following fields display.

Connection
For instructions about connecting your Workfront Proof account to Workfront Fusion, see Create a connection to Adobe Workfront Fusion - Basic instructions.
Proof ID
Type the unique ID of the proof, found on the Proof Details page. For more information, see Manage Proof Details in Workfront Proof.
Deadline

Specify the deadline you want for the proof that is created. Use the following date format:

YYYY-MM-DD hh:mm

Default email notifications for subscribers

Select which of the following default email notification settings you want to use for the proof that is created.

  • All new comments and replies
  • Replies to my comments
  • Daily summary
  • Hourly summary
  • Decisions only
  • Disabled
Default Role
Select the default role for the proof.
Disable Subscription Email
Select whether you want to disable the subscription email for this proof.
Enable Subscriptions
Select whether people who are not participants are allowed to subscribe to the proof.
If you select this option, you can also select the Default Role for subscribers, as described in this table.
Enable Subscriptions Validation
Select whether you want to enable subscription email validation. If this is enabled, the subscriber must click a link in an email to access a proof.
Enable Team URL
Select whether you want the proof that is created to hide or show the team URL.
Lock proof when all required decisions are made
Specify whether you want the proof that is created to lock after all required decisions are made.
Message
Enter or map a message that you want to accompany the proof.
Proof ID
Enter or map the ID of the proof you want to update.
Proof Name
Enter or map the name of the proof you want to update.
Require login

Specify whether you want the proof that is created to require a login.

This is the same as the Login Required setting explained in Configure Proof Settings in Workfront Proof

Show Versions Like
Select whether you want to show a link to other versions of this proof.
Subject
Enter or map the subject of the proof

Upload File

This action module uploads a file for use with the Create Proof module in Workfront Proof.

The module returns a hash ID for the uploaded file. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection
For instructions about connecting your Workfront Proof account to Workfront Fusion, see Create a connection to Adobe Workfront Fusion - Basic instructions.
Source file
Select a source file from a previous module, or map the source file's name and data.

Searches

List Workflow Templates

This search module lists all available workflow templates.

Connection
For instructions about connecting your Workfront Proof account to Workfront Fusion, see Create a connection to Adobe Workfront Fusion - Basic instructions
Outputs
Select the information you want included in the output bundle for this module.
Limit
Enter or map the maximum number of templates you want the module to return during each scenario execution cycle.

This search module looks for records in an object in Workfront Proof that match the search query you specify.

The module returns the proof’s ID if it’s searching for a proof. Or it returns the recipients’ user IDs, emails, names, positions, and email aliases, if it is searching for recipients.You can map this information in subsequent modules in the scenario.

You must have sufficient permissions to access the record in Workfront Proof in order to retrieve this information.

When you are configuring this module, the following fields display.

Connection
For instructions about connecting your Workfront Proof account to Workfront Fusion, see Create a connection to Adobe Workfront Fusion - Basic instructions.
Search for

Select the type of record you want the module to search for.

  • Proof

    Enter the Proof Name of the proof you want to search for.

  • Recipient

    Enter the email address of the recipient you want to search for.

Result Set
Indicate whether the module will search for All Matching Records or only the First Matching Record.
Sort By
Select the field that you want to sort results by.
Sorting Direction
Select whether you want to sort results ascending or descending.

List Workflow Templates

This search module lists all available workflow templates.

Connection
For instructions about connecting your Workfront Proof account to Workfront Fusion, see Create a connection to Adobe Workfront Fusion - Basic instructions.
Outputs
Select the information you want included in the output bundle for this module.
Limit
Enter or map the maximum number of templates you want the module to return during each scenario execution cycle.
recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43