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.
CloudConvert API information
The CloudConvert connector uses the following:
Connect CloudConvert to Workfront Fusion connect-cloudconvert-to-workfront-fusion
To connect your CloudConvert account to Workfront Fusion, you need to obtain the API Key from your CloudConvert account.
-
Log in to your CloudConvert account and open your Dashboard.
-
Open the Authorization > API Keys section.
-
Click Create New API key.
-
Enter the name for the API key, enable the scopes you want to use, then click Create.
-
Copy the provided token and store it in a safe place.
-
In Workfront Fusion, start creating a scenario and open the CloudConvert module’s Create a connection dialog.
For instructions, see Create a scenario in Adobe Workfront Fusion.
-
Enter the token you saved in step 5, then click Continue to establish the connection.
CloudConvert modules and their fields 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.
Convert a file
Converts a file into a selected output format.
Create an Archive
Enables you to add one or multiple files to the ZIP, RAR, 7Z, TAR, TAR.GZ or TAR.BZ2 archive.
Merge Files
Merges at least two files into one PDF. If input files are not PDFs, they are automatically converted to PDF.
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.
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.
Delete a Job
This module deletes a job, including all tasks and data.
Get a Job
This module retrieves job details.
List Jobs
This module retrieves all jobs that have been run in your account.
New Job Event
Triggers when a job in your account or task is created, finishes, or fails.
- 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.
-
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.
Delete a Task
Delete a task, including all data.
Download a File
This module retrieves file name and file data from the specified task.
Get a Task
This module retrieves task details.
List Tasks
This module retrieves all tasks in your account based on filter settings.
Retry a Task
This module creates a new task, based on the settings (payload) of another task.
Other
Get My Info
Retrieves authenticated account details about the current user.
Make an API Call
Allows you to perform a custom API call.
Select the HTTP request method you need to configure the API call. For more information, see HTTP request methods in Adobe Workfront Fusion.
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.
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.
Add the query for the API call in the form of a standard JSON object.
For example: {"name":"something-urgent"}
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 troubleshooting
See the following table for possible errors and their solutions:
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
-
Click Select File and choose your sample MOV file.
-
Click the dropdown, next to Convert to and choose MP4.
-
Click the wrench icon.
-
Configure the MP4 compression settings as you see fit.
-
Click Convert.
-
Once the conversion is complete, click Download.
-
Review the converted video.
-
Repeat steps 1 to 8 until you have found the optimal conversion settings for step 5.
-
Choose mov for the input_format field.
-
Choose mp4 for the output_format field.
-
A list of all possible parameters like video_codec, crf, etc. will appear.
-
In Workfront Fusion 2.0, insert the CloudConvert > Convert a File module in your scenario.
-
Open the module’s settings.
-
Configure the module as shown below:
-
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.