ÃÛ¶¹ÊÓƵ

DocumentationWorkfrontWorkfront Guide

ÃÛ¶¹ÊÓƵ Lightroom modules

Last update: Thu Dec 05 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User

In an ÃÛ¶¹ÊÓƵ Workfront Fusion scenario, you can automate workflows that use ÃÛ¶¹ÊÓƵ Lightroom, as well as connect it to multiple third-party applications and services.

If you need instructions on creating a scenario, see Create a scenario.

For information about modules, see Modules in ÃÛ¶¹ÊÓƵ Workfront Fusion.

Access requirements

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

ÃÛ¶¹ÊÓƵ Workfront plan*
Pro or higher
ÃÛ¶¹ÊÓƵ Workfront license*
Plan, Work
ÃÛ¶¹ÊÓƵ Workfront Fusion license**
Workfront Fusion for Work Automation and Integration
Product
Your organization must purchase ÃÛ¶¹ÊÓƵ Workfront Fusion as well as ÃÛ¶¹ÊÓƵ 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 ÃÛ¶¹ÊÓƵ Workfront Fusion licenses, see [ÃÛ¶¹ÊÓƵ Workfront Fusion] licenses(/workfront-fusion/get-started/license-automation-vs-integration.html?lang=en)

Prerequisites

Before you can use the ÃÛ¶¹ÊÓƵ Lightroom connector, you must ensure that the following prerequisites are met:

  • You must have an active ÃÛ¶¹ÊÓƵ Lightroom account.

ÃÛ¶¹ÊÓƵ Lightroom API information

The ÃÛ¶¹ÊÓƵ Lightroom connector uses the following:

Base URL
https://lr.adobe.io
API tag
v1.17.128

Create a connection to ÃÛ¶¹ÊÓƵ Lightroom

To create a connection for your ÃÛ¶¹ÊÓƵ Lightroom modules:

  1. Click Add next to the Connection box.

  2. Fill in the following fields:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 layout-auto html-authored no-header
    Connection name Enter a name for this connection.
    Environment Select whether you are connecting to a production or non-production environment.
    Type Select whether you are connecting to a service account or a personal account.
    Client ID Enter your ÃÛ¶¹ÊÓƵ Client ID. This can be found in the Credentials details section of the ÃÛ¶¹ÊÓƵ Developer Console
    Client Secret Enter your ÃÛ¶¹ÊÓƵ Client Secret. This can be found in the Credentials details section of the ÃÛ¶¹ÊÓƵ Developer Console

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

ÃÛ¶¹ÊÓƵ Lightroom modules and their fields

When you configure ÃÛ¶¹ÊÓƵ Lightroom modules, Workfront Fusion displays the fields listed below. Along with these, additional ÃÛ¶¹ÊÓƵ Lightroom 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 ÃÛ¶¹ÊÓƵ Workfront Fusion.

Other

Health check

This action module retrieves a Lightroom server version ID, proving whether the Lightroom service is currently running.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Lightroom, see Create a connection to ÃÛ¶¹ÊÓƵ Lightroom in this article.
Credentials

If you want to supply specific credentials to ensure that a specific server is running, click Add item and enter the credentials.

Authorization headers are added automatically.

Retrieve user catalog metadata

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Lightroom, see Create a connection to ÃÛ¶¹ÊÓƵ Lightroom in this article.
Credentials

If you want to supply specific credentials to ensure that you can access the correct user account, click Add item and enter the credentials.

Authorization headers are added automatically.

Assets

Create an asset original file

This action module creates and uploads an original file for an asset.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Lightroom, see Create a connection to ÃÛ¶¹ÊÓƵ Lightroom in this article.
Catalog ID
Enter or map the ID of the catalog that contains the asset.
Asset ID
Enter or map the ID of the asset that you want to create and upload a file for.
Length of content in bytes
Enter or map the length of the content in bytes.
Byte range
Enter or map the byte range for the request, including first and last bytes and entity length as defined in RFC 2616. Should be included only when the data is too large to be uploaded in a single call.
Content type
Select the content type for the new file.

Create an asset

This action module creates a new asset with initial metadata and import information.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Lightroom, see Create a connection to ÃÛ¶¹ÊÓƵ Lightroom in this article.
Catalog ID
Enter or map the ID of the catalog where the asset will be created.
Asset ID
Enter or map the ID of the new asset.
Asset type
Select whether the asset is an image or a video.
Datetime user created
Enter or map a date with the format YYYY-MM-DDT00:00:00-00:00.
Datetime user updated
Enter or map a date with the format YYYY-MM-DDT00:00:00-00:00.
Date captured
Enter or map a date with the format YYYY-MM-DDT00:00:00-00:00.

Create an asset external XMP develop setting file

This action module supports two workflows. The first workflow is to upload the external XMP develop settings file for the asset. The second workflow is to create an external XMP develop settings file by copying from another asset’s external xmp develop setting file.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Lightroom, see Create a connection to ÃÛ¶¹ÊÓƵ Lightroom in this article.
Length of content in bytes
Enter or map the length of the content in bytes.
Upload new or copy XMP/develop file
Select whether you are uploading a new file, or copying a file from an existing asset.
Catalog ID
Enter or map the ID of the catalog that contains the asset.
Asset ID
Enter or map the ID of the asset that you want to upload or copy a file to.
Link to XMP/develop file

Enter or map a link to the file you want to upload or copy.

This file must be JSON if copying a file, or XML if uploading a file.

Generate renditions for an original file

This action module asynchronously generate renditions for an original file.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Lightroom, see Create a connection to ÃÛ¶¹ÊÓƵ Lightroom in this article.
Rendition Type(s) (semi-colon separated)

Enter the rendition type for the rendition you want to create. If entering more than one type, separate them with a semicolon (;).

Possible types:

  • fullsize
  • 2560
Length of content in bytes
Enter or map the length of the content in bytes.
Catalog ID
Enter or map the ID of the catalog that contains the asset.
Asset ID
Enter or map the ID of the asset that you want to create a rendition of a file for.

Get a catalog asset

This action module retrieves information about a single asset in a catalog. The catalog must be owned by the user whose credentials are represented in the connection used in this module.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Lightroom, see Create a connection to ÃÛ¶¹ÊÓƵ Lightroom in this article.
Catalog ID
Enter or map the ID of the catalog that contains the asset.
Asset ID
Enter or map the ID of the asset that you want to retrieve information for.

Get the latest asset external XMP develop setting file

This action module retrieves the most recent asset external XMP setting file.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Lightroom, see Create a connection to ÃÛ¶¹ÊÓƵ Lightroom in this article.
Catalog ID
Enter or map the ID of the catalog that contains the asset.
Asset ID
Enter or map the ID of the asset associated with the XMP develop setting file.

Get the latest asset rendition

This action module retrieves the latest asset rendition of the specified type.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Lightroom, see Create a connection to ÃÛ¶¹ÊÓƵ Lightroom in this article.
Catalog ID
Enter or map the ID of the catalog that contains the asset.
Asset ID
Enter or map the ID of the asset associated with the XMP develop setting file.
Rendition type
Select the type of rendition that you want to retrieve.

Retrieve assets

This action module retrieves assets owned by the by the user whose credentials are represented in the connection used in this module.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Lightroom, see Create a connection to ÃÛ¶¹ÊÓƵ Lightroom in this article.
Catalog ID
Enter or map the ID of the catalog that contains the asset.
Starting timestamp
Enter or map a timestamp. The module returns records that have been updated after this time stamp.
Return assets captured before

Enter a date with the format YYYY-MM-DDT00:00:00. The module returns results captured before this date.

This field cannot be used with the field Return assets captured after.

Maximum number of returned assets
Set the maximum number of assets that Workfront Fusion will return during one execution cycle. This number must be less than or equal to 100.
SHA256 Hash value of original file
Hide assets that are inside stacks?"
Asset subtype values
Asset IDs
Enter or map up to 100 asset IDs, separated by commas.
Types of assets to exclude
Select if you want to exclude complete or incomplete assets. To include all assets, leave this field blank.
Group values
Name values
Favorite status

Albums

Add assets to an album

This action module adds one or more assets to the specified album. You can add up to 50 assets in one execution cycle.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Lightroom, see Create a connection to ÃÛ¶¹ÊÓƵ Lightroom in this article.
Catalog ID
Enter or map the ID of the catalog that contains the album that you want to add assets to.
Album ID
Enter or map the ID of the album that you want to add assets to.
Assets
For each asset that you want to add to the album, click Add item and enter the following fields.
Asset ID
Enter or map the ID of the asset you want to add to the album
Is this asset an album cover?
Select whether you want this asset to be displayed as the image that represents the album.
Order
Metadata
Enter or map any metadata you want to include with the asset. This must be a single text string with a maximum length of 1-24 characters.
Remote ID
Enter an identifier for the asset.

Create an album

This action module creates a new album in Lightroom.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Lightroom, see Create a connection to ÃÛ¶¹ÊÓƵ Lightroom in this article.
Catalog ID
Enter or map the ID of the catalog where you want to create an album.
Album ID
Enter or map an ID for the new album.
Subtype
Select the subtype for the album.
API key
Enter the API key of the service that is creating the album.
Datetime user created
Enter or map a date with the format YYYY-MM-DDT00:00:00-00:00Z.
Datetime user updated
Enter or map a date with the format YYYY-MM-DDT00:00:00-00:00Z.
Album name
Enter or map a name for the new album.
Cover ID
Enter or map the ID of an asset to use as the cover of this album.
Remote ID
Enter an identifier for the asset.
Created date
Enter or map a date with the format YYYY-MM-DDT00:00:00-00:00Z.
Updated date
Enter or map a date with the format YYYY-MM-DDT00:00:00-00:00Z.
Is the album deleted?
Enable this option if the externally affiliated content was deleted.
URL of location to edit affiliated content
If there is a URL where users can edit content of this album, enter the URL here.
URL of location to view affiliated content
If there is a URL where users can view content of this album, enter the URL here.

Delete an album

This action module deletes an album.

The deleted album must have been created by the same client app that is now deleting it, and it must be of subtype project or project_set.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Lightroom, see Create a connection to ÃÛ¶¹ÊÓƵ Lightroom in this article.
Catalog ID
Enter or map the ID of the catalog that contains album you want to delete.
Album ID
Enter or map the ID of the album you want to delete.
Delete child albums?
Select whether you want to delete child albums of the deleted album.

Get an album

This action module retrieves the specified album

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Lightroom, see Create a connection to ÃÛ¶¹ÊÓƵ Lightroom in this article.
Catalog ID
Enter or map the ID of the catalog that contains album you want to retrieve.
Album ID
Enter or map the ID of the album you want to retrieve.

List assets of an album

This action module retrieves a list of assets in the specified album.

Retrieve albums

This action module retrieves a list of albums in the specified catalog.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Lightroom, see Create a connection to ÃÛ¶¹ÊÓƵ Lightroom in this article.
Catalog ID
Enter or map the ID of the catalog that contains albums you want to retrieve.
Subtypes
Enter or map the ID of the album you want to retrieve.
Name of album to precede current results
If you are paginating your results, enter or map the name of the last album on the preceding page.
Maximum number of returned albums
Set the maximum number of assets that Workfront Fusion will return during one execution cycle. The default value for this field is 100.This module may return more albums than this limit if multiple albums at the limit boundary have the same name_after value.

Update album

This action module updates the specified album.

The updated album must have been created by the same client app that is now updating it, and it must be of subtype project or project_set.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Lightroom, see Create a connection to ÃÛ¶¹ÊÓƵ Lightroom in this article.
Catalog ID
Enter or map the ID of the catalog that contains album you want to update.
Album ID
Enter or map the ID of the album you want to update.
Other fields
For descriptions of other fields in this module, see Create an album in this article.
recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43