CloudConvert modules

In an Adobe Workfront Fusion scenario, you can automate workflows that use CloudConvert, as well as connect it to multiple third-party applications and services. The CloudConvert modules allow you to monitor and manage jobs, tasks, and import and export files in your CloudConvert account.

Adobe Workfront plan*

Pro or higher

Adobe Workfront license*

Plan, Work

Adobe Workfront Fusion license**

Workfront Fusion for Work Automation and Integration

Product Your organization must purchase Adobe Workfront Fusion as well as Adobe Workfront to use functionality described in this article.

Connect CloudConvert to Workfront Fusion

To connect your CloudConvert account to Workfront Fusion, you need to obtain the API Key from your CloudConvert account.

  1. Log in to your CloudConvert account and open your Dashboard.

  2. Open the Authorization > API Keys section.

  3. Click Create New API key.

  4. Enter the name for the API key, enable the scopes you want to use, then click Create.

  5. Copy the provided token and store it in a safe place.

  6. In Workfront Fusion, start creating a scenario open the CloudConvert module’s Create a connection dialog.

    For instructions, see Create a scenario in Adobe Workfront Fusion.

  7. Enter the token you saved in step 5, then click Continue to establish the connection.

CloudConvert modules and their fields

When you configure CloudConvert modules, Workfront Fusion displays the fields listed below. Along with these, additional CloudConvert 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.

Common tasks

Capture a Website

This action module captures a specified website and saves it in PDF, JPG, or PNG format.

You specify the URL of the website and other information, such as where you want the information stored.

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

Connection

For instructions about connecting your CloudConvert account to Workfront Fusion, see Connect CloudConvert to Workfront Fusion in this article.

URL Enter the URL of the website you want to capture.
Output Format Select whether you want to save the captured website in PNG, JPG, or PDF format.
File Name Enter a file name (including extension) for the target output file.
Headers

(Optional) Define request headers.

This is useful, for example, when the specified URL requires authorization.

Conversion and engine specific options

Specify conversion and engine specific options. To view available options, see the Cloud Convert API documentation for input_format and output_format.
Download a file

Enable this option if you also want to include file data in the module's output.

Convert a file

Converts a file into a selected output format.

Connection

For instructions about connecting your CloudConvert account to Workfront Fusion, see Connect CloudConvert to Workfront Fusion in this article.

Input file Select whether you want to upload a file using Workfront Fusion or provide the URL the file will be uploaded from.
Upload a file

Select a source file from a previous module, or map the source file's name and data.

Import a File from URL
  • URL

    Enter the URL of the file you want to convert.

  • Headers

    Define request headers (optional). This is useful, for example, when the specified URL requires the authorization.

Format Select whether you want to specify the input format of the file you want to convert. If not specified, the extension of the input file is used as the input format.
Input Format Select the current format of the file.
Output Format Select the target file format you want to convert the file to.
File Name Choose a filename (including extension) for the target output file.

Conversion and engine specific options

Specify conversion and engine specific options. To view available options, see the Cloud Convert API documentation for input_format and output_format.
Download a file

Enable this option if you also want to include file data in the module's output.

Create an Archive

Enables you to add one or multiple files to the ZIP, RAR, 7Z, TAR, TAR.GZ or TAR.BZ2 archive.

Connection

For instructions about connecting your CloudConvert account to Workfront Fusion, see Connect CloudConvert to Workfront Fusion in this article.

Input Files

Specify files you want to add to the archive.

Upload a File

Select a source file from a previous module, or map the source file's name and data.

Import a file from URL

URL

Enter the URL of the file you want to archive.

Headers

Define request headers (optional). This is useful, for example, when the specified URL requires the authorization.

Output Format

Select the target format of the archived file.

File name

Enter the file name (including extension) for the target output file.

Conversion and engine specific options

Specify conversion and engine specific options. To view available options, see the Cloud Convert API documentation for input_format and output_format.

Download a File

Enable this option if you also want to include file data in the module's output.

Merge Files

Merges at least two files into one PDF. If input files are not PDFs, they are automatically converted to PDF.

Connection

For instructions about connecting your CloudConvert account to Workfront Fusion, see Connect CloudConvert to Workfront Fusion in this article.

Input Files

Specify files you want to merge.

Upload a File

Select a source file from a previous module, or map the source file's name and data.

Import a file from URL

URL

Enter the URL of the file you want to archive.

Headers

Define request headers (optional). This is useful, for example, when the specified URL requires the authorization.

Output Format

Select the target format of the merged file.

File name

Enter the file name (including extension) for the target output file.

Conversion and engine specific options

Specify conversion and engine specific options. To view available options, see the Cloud Convert API documentation for input_format and output_format.

Download a File

Enable this option if you also want to include file data in the module's output.

Optimize a File

This action module optimizes and compresses a file in PDF, PNG, or JPG format.

You specify the file and the parameters for optimizing and storing it.

The module returns the ID of the file and any associated fields, along with any custom fields and values that the connection accesses. 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 CloudConvert account to Workfront Fusion, see Connect CloudConvert to Workfront Fusion in this article.

Input File Select whether you want to upload a file using Workfront Fusion or provide the URL from which the file will be uploaded.

Upload a File

Select a source file from a previous module, or map the source file's name and data.

Import a file from URL
  • URL: Enter the URL of the file you want to convert.
  • Headers: (Optional) Define request headers. This is useful, for example, when the specified URL requires authorization.
Optimization for

Select the optimization profile for specific target needs.

  • Web: Optimization for the web (Default)

    • Remove redundant and unnecessary data for the web
    • Down-sample, clip, and intelligently compress images
    • Merge and subset fonts
    • Convert colors to RGB
  • Print: Optimization for print

    • Remove redundant and unnecessary data for printing

    • Down-sample, clip, and intelligently compress images

    • Merge and subset fonts

    • Convert colors to CMYK

  • Archive: Optimization for archiving purposes

    • Remove redundant and unnecessary data for archiving

    • Intelligently compress images

    • Merge and subset fonts

  • Scanned images: Optimization for scanned images

    • Profile optimized for PDFs that mainly consist of raster images

    • Compress the images without significantly reducing the visual quality

  • maximal size reduction: Optimization for maximal size reduction

    • Use the maximal possible compression

    • Might reduce the visual quality

Input format Select the format of the input file you want to optimize.
File name

Enter a file name (including extension) for the target output file.

Conversion and engine specific options

Specify conversion and engine specific options. To view available options, see the Cloud Convert API documentation for input_format and output_format.

Download a file

Enable this option if you also want to include file data in the module's output.

Jobs

Create a Job (advanced)

This module creates a job. A job can be one or multiple tasks that are identified in the Name field and linked between each other using the Input field.

Connection

For instructions about connecting your CloudConvert account to Workfront Fusion, see Connect CloudConvert to Workfront Fusion in this article.

Input Files

Select whether you want to upload a file using Workfront Fusion, or provide the URL from which the file will be uploaded.

Upload a File

Select a source file from a previous module, or map the source file's name and data.

Import a File from URL

  • URL: Enter the URL of the file you want to process.
  • Headers: (Optional) Define request headers. This is useful, for example, when the specified URL requires authorization.

Tasks

Add tasks that will be performed within the job.

Please find the descriptions of the operations' fields in the corresponding section.

  • Execute a Command

    For more information on executing a command, see the CloudConvert API documentation.

  • Export a File to Temporary URL

    Specify the task name and input task name (e.g. Conversion).

Tag

Enter a tag. Tags are arbitrary strings to identify the job. They do not have any effect and can be used to associate the job with an ID.

Delete a Job

This module deletes a job, including all tasks and data.

NOTE

Jobs are deleted automatically 24 hours after they have ended.

Connection

For instructions about connecting your CloudConvert account to Workfront Fusion, see Connect CloudConvert to Workfront Fusion in this article.

Job ID

Enter or map the ID of the job you want to delete.

Get a Job

This module retrieves job details.

Connection

For instructions about connecting your CloudConvert account to Workfront Fusion, see Connect CloudConvert to Workfront Fusion in this article.

Job ID

Enter or map the ID of the job you want to retrieve details about.

List Jobs

This module retrieves all jobs that have been run in your account.

Connection

For instructions about connecting your CloudConvert account to Workfront Fusion, see Connect CloudConvert to Workfront Fusion in this article.

Status

Select the job status to filter returned jobs by.

Limit

Set the number of jobs Workfront Fusion 2.0 will return during one execution cycle.

New Job Event

Triggers when a job in your account or task is created, finishes, or fails.

NOTE
  • The job created by the Create a Job (advanced) module consists of several tasks.
  • The New Job Event trigger is also triggered when an individual task is created, has finished, or has failed.
Webhhook name Enter the webhook name.
Connection

For instructions about connecting your CloudConvert account to Workfront Fusion, see Connect CloudConvert to Workfront Fusion in this article.

Output Format Select whether you want to save the captured website in PNG, JPG, or PDF format.
Event Select whether the module is triggered when the job or task is created, finishes, or fails.
NOTE
  • If working with the Array Aggregator (e.g. you have many files in different formats to convert), use the I don’t know the input format option in the Add a task dialog. Otherwise the error is returned.

  • Linking tasks within the job (name > input, name > input,…):

    >

Tasks

Cancel a Task

This module cancels a task that has a status of waiting or processing.

Connection

For instructions about connecting your CloudConvert account to Workfront Fusion, see Connect CloudConvert to Workfront Fusion in this article.

Task ID

Enter or map the ID of the task you want to cancel.

Delete a Task

Delete a task, including all data.

NOTE

Tasks are deleted automatically 24 hours after they have ended.

Connection

For instructions about connecting your CloudConvert account to Workfront Fusion, see Connect CloudConvert to Workfront Fusion in this article.

Task ID

Enter (map) the ID of the task you want to delete.

Download a File

This module retrieves file name and file data from the specified task.

Connection

For instructions about connecting your CloudConvert account to Workfront Fusion, see Connect CloudConvert to Workfront Fusion in this article.

Task ID

Enter or map the ID of the task you want to download the file from.

Get a Task

This module retrieves task details.

Connection

For instructions about connecting your CloudConvert account to Workfront Fusion, see Connect CloudConvert to Workfront Fusion in this article.

Task ID

Enter or map the ID of the task you want to retrieve details about.

List Tasks

This module retrieves all tasks in your account based on filter settings.

Connection

For instructions about connecting your CloudConvert account to Workfront Fusion, see Connect CloudConvert to Workfront Fusion in this article.

Status

Select the task status to filter returned tasks by.

Job ID

Enter or map the Job ID to return only tasks within the specified job.

Operation

Enter the operation type to return only tasks with the specified operation.

Note: Use the List Possible Operations module to retrieve operations.

Limit

Enter or map the maximum number of records you want the module to return during each scenario execution cycle.

Retry a Task

This module creates a new task, based on the settings (payload) of another task.

Connection

For instructions about connecting your CloudConvert account to Workfront Fusion, see Connect CloudConvert to Workfront Fusion in this article.

Task ID

Enter or map the ID of the task you want to create a new task from.

Other

Get My Info

Retrieves authenticated account details about the current user.

Make an API Call

Allows you to perform a custom API call.

Connection

For instructions about connecting your [Fusion App] account to Workfront Fusion, see Create a connection to Adobe Workfront Fusion - Basic instructions

URL

Enter a path relative to https://api.cloudconvert.com/. For example: /v2/tasks

For the list of available endpoints, see the CloudConvert API v2 Documentation.

Method

Select the HTTP request method you need to configure the API call. For more information, see HTTP request methods in Adobe Workfront Fusion.

Headers

Add the headers of the request in the form of a standard JSON object.

For example, {"Content-type":"application/json"}

Workfront Fusion 2.0 adds the authorization headers for you.

Query String

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

For example: {“name”:“something-urgent”}

Body

Add the body content for the API call in the form of a standard JSON object.When using conditional statements such as if in your JSON, put the quotation marks outside of the conditional statement.

Example: List Tasks

The following API call returns all tasks from your CloudFront account:

URL: /v2/tasks

Method: GET

Matches of the search can be found in the module’s Output under Bundle > Body > data.

In our example, 6 tasks were returned:

Troubleshooting

See the following table for possible errors and their solutions:

Error

Next steps

The output file size exceeds the limit allowed for your scenario.

Please refer to file size limits.

You have exceeded the maximum conversion time.

The free CloudConvert plan offers 25 conversion minutes daily. If your usage exceeds the limit of the free plan, you may switch to a (prepaid) package or subscription.

Failed to read frame size: Could not seek to 1508. �/output/JLIADSA00137P0.mp3: Invalid argument.

This error is thrown e.g. when converting files from MP3 to WAV. Make sure that you have selected the correct region because it will find references to files but not only just the correct file.

RuntimeError:

Maximum number of repeats exceeded.

Locate the corresponding CloudConvert job in your CloudConvert dashboard's list of jobs and check the job's duration:

The CloudConvert > Convert a File module's timeout is set to 3 minutes. If the job's duration exceeds 3 minutes (possibly due to a temporary overload of the CloudConvert service), the module throws the above mentioned error.

In this case consider one of these options:

  • Enable the Allow storing of Incomplete Executions option in the scenario settings to store the incomplete executions for later manual resolution. Optionally you may attach an error handling route to the CloudConvert module with the Break directive to resolve the incomplete executions automatically.
  • Disable the Download a file option in the CloudConvert > Convert a file module. In this case the module will not wait for the conversion result. To obtain the conversion result, create a new scenario and use the CloudConvert > New Job Event trigger.

Example workflow for CloudConvert connector

INFO

Example: Converting a video from MOV to MP4 format

  1. Visit https://cloudconvert.com/video-converter

  2. Click Select File and choose your sample MOV file.

  3. Click the dropdown, next to Convert to and choose MP4.

  4. Click the wrench icon.

  5. Configure the MP4 compression settings as you see fit.

  6. Click Convert.

  7. Once the conversion is complete, click Download.

  8. Review the converted video.

  9. Repeat steps 1 to 8 until you have found the optimal conversion settings for step 5.

  10. Visit https://cloudconvert.com/api/v2/convert#convert-tasks

  11. Choose mov for the input_format field.

  12. Choose mp4 for the output_format field.

  13. A list of all possible parameters like video_codec, crf, etc. will appear.

  14. In Workfront Fusion 2.0, insert the CloudConvert > Convert a File module in your scenario.

  15. Open the module’s settings.

  16. Configure the module as shown below:

  17. Make sure to include all the settings in the Conversion and engine specific options field: for each setting from step 5, locate the corresponding parameter from step 13 and its corresponding value.

On this page