Workfront Connector - Curator configuration

Updated on December 9th, 2022

Table of Contents

X

This document describes how to configure Workfront Connector in Curator.

Pre-Requisites

You should have all of the relevant software installed as follows: Curator deployment with Workflow Agent and a Workfront system and have obtained the license for the connector. The license will give you a MySQL configuration script to set the Curator metadata and views for lookup and a Workflow Agent flow.

Curator metadata

The default deployment utilizes the data contract as in the table below.

Open MySQL Workbench connection to Curator Server's database, find the provided script SendToWorkfrontWebPage.sql and select Run MySQL Script. The script will create the required metadata and views, but not assign the rights to workgroups as these are site-specific, the default group Editors may be used if appropriate.

Using Curator System Administrator you need to allow a workgroup of users to have Read access for all of the Curator metadata in the table below and Write access for the Curator Metadata Names in bold.
 
The second half of the data contract resides in a custom form template in Workfront and its configuration is described in Workfront connector - Workfront templates and forms

The names in Workfront must conform with the case and exact string. The metadata where values are provided in the final column are enumerations. If an additional value is required it must be first added in the Curator before it can be added into the custom form template in Workfront. The metadata marked with * are controlled from Workfront and are read-only in the Send To Workfront view in Curator. The metadata with ** are metadata used by the Curator system to create productions also directly from Curator Apps.

Curator Metadata Display Name Curator Metadata Name
Workfront Metadata Values where metadata is an Enumeration

Workfront Project Name *


Name


Workfront ID * 

WorkfrontId

ID


Assigned To * 


User.Name


Target Due Date *


Planned Completion Date


User Estimated Completion Date

WorkfrontUserEstimatedCompletionDate

Commit Date


Priority *

WorkfrontPriority

Priority

Highest; High; Medium; Low; Lowest

Confidence

WorkfrontConfidence

Confidence %


Project Owner * 


Name


Marketing Brief * 

WorkfrontMarketingBrief

Marketing Brief


Commentary

WorkfrontCommentary

Commentary


Percentage Complete

WorkfrontPercentComplete

Percent Complete


Status

WorkfrontStatus

Status

in Curator:   Pending; In Progress; On Hold; Complete; 
in Workfront: PEN; INP; ONH; CPL 

Effort

WorkfrontEffort

Hours


Production Type * ** 


Production Type

Premiere;  After Effects

Production * **


Production

Sports; Enterprise; Creative

Format  * **


Format

Episode; Pilot; Promo

Output Destination  * **


Destination

Website; Broadcast Playout; Social

Final Asset

WorkfrontFinalAsset

Final Asset



Delete

Curator Gateway

For the Workfront integration, a client for Workflow Agent needs to be declared as a client in Curator giving it the name Workfront Agent.

  • Root URI - the address of your Workflow Agent deployment including port number e.g. http://example.worklfowagent.server:1880/
  • Required Roles - to restrict the visibility of Workflow Agent's GUI - ADMIN, ADMIN (READ ONLY)
  • Grant Types - Client Credentials and Hybrid 
  • Allowed Resources  - Device Director API, Curator Gateway API, Process Engine API and Curator Server API.

You will require the Workflow Agent client's Id and Secret available after these are saved as above for configuration of the Workfront flows in the Workflow Agent instance. For Workflow Agent's configuration, see Workfront Connector - Workflow Agent configuration.


Send To Workfront webpage needs to be declared as a client in Curator, configured as follows. 

  • Root URI - the address of the SendToWorkfront webpage on the IIS server where deployed e.g. https://curator.example.server/SendToWorkfront
  • Launch Path Template - {?assetId}
  • Required Roles - set if you want to limit users who will be able to launch and operate the Send To Workfront webpage
  • Grant Types - Implicit
  • Allowed Resources - Curator Gateway API, Process Engine API, Curator Server API
  • Description - "Workfront update application launched from Curator web app" or similar

You will require the Send To Workflow client's Id to configure the webpage. For webpage's deployment and configuration, see Workfront Connector - Send To Workfront.

Delete

Process Engine

Required Prerequisites - Curator 3.3.1 or newer
- Edit and Publish and Process Engine API modules 


Make sure you have the Edit and Publish and Process Engine API modules installed in Process Engine. Check in the Modules tab after logging in to Process Engine monitor. Process Engine API should be included by default, although some older versions do not include it. The Edit and Publish module provides necessary automation for Curator's media edit capability.

Install Workfront module, this will generate a set of MediaStores for configuration

You need to set up the MediaStore declaring the Process Engine workflows which will deliver the Workfront updatesIf you haven't created this during Workflow Agent installation this should be configured now following the Workflow Agent Installation Guide - Configuration in Curator Process Engine steps using the MediaStore name WORKFRONT-UPDATE-PRODUCTION with the key-value pairs as in the table below. Values specific to this integration are in bold. 

DeviceProfile     Workflow Agent
DeviceGroup Workfront
MediaStoreDescription     This is a transfer destination for the update Workfront plugin
SendCollection     True
SourceRequired False
StoreType Dynamic
Workflow Spawn - Send to Workflow Agent
WorkflowAgentWorkflowName Workfront - Update Workfront

There are further MediaStores created which will be required for additional configurations in Phase 2 of Workfront release.
Delete

Device Director

To enable the connector using Workflow Agent to communicate with the rest of the Curator system, you will need to set it up as a device in Device Director if you haven't during Workflow Agent installation following the Workflow Agent Installation Guide - Configuration in Curator Device Director steps. Use Workfront Agent as the name of the new device for your deployment of Workflow Agent and Workfront as the name of the group containing that deviceMake sure you already have or add a default Workflow Agent profile (Generic Device).

Delete



Troubleshooting


Was this article helpful?