Skip to main content

Adobe Workfront Connector Architecture

This article provides a technical explanation of how Smartling’s Adobe Workfront Connector works behind the scenes. It is for informational purposes only; for setup instructions, please refer to Setting Up Your Adobe Workfront Connector.

Integration architecture and APIs

High-level components diagram

high-level-components-diagram.png

Components diagram

components-diagram.png

Permissions for the integration user

The Smartling connector interacts with the Workfront API, so the user created for the integration configuration should have the necessary permissions. In a nutshell, the user should be an Administrator. The connector's functionality can be divided into four categories:

Below, we will go over each category in detail.

Initial configuration

The connector uses a "push" approach, in which Workfront notifies the integration of changes to Workfront Projects/Tasks. When you connect to a Smartling project for the first time, the integration creates a new subscription. The subscription can be removed or recreated if you disconnect the Smartling project or change its configuration.

The UI allows you to create a new custom form in Workfront to speed up your initial configuration. This form can be modified or removed.

Endpoints:

  • Subscriptions - Required permissions: System Administrator

    • GET /attask/eventsubscription/api/v1/subscriptions

    • POST /attask/eventsubscription/api/v1/subscriptions

    • DELETE /attask/eventsubscription/api/v1/subscriptions/{id}

  • Custom Forms

    • POST /internal/qslist

    • GET /internal/customForms/field/{id}

    • POST /internal/customForms/saveField

Start translation

The connector gathers information about the WorkFront Project/Task that has been requested for translation. It also verifies that the requester has permission.

Endpoints:

  • Projects

    • GET /attask/api/v18.0/project/{id}?fields=$FIELDS

    • POST /attask/api/v18.0/project/search?fields=$FIELDS

    • PUT /attask/api/v18.0/proj/{id}?fields=$FIELDS

  • Users

    • GET /attask/api/v18.0/user/{id}?fields=$FIELDS

Upload/download document

A list of all endpoints used to download source documents from Workfront and upload translated documents back.

Endpoints:

  • Documents

    • GET /attask/api/v18.0/document/{id}?fields=$FIELDS

    • POST /attask/api/v18.0/document/search?fields=$FIELDS

    • GET /internal/document/download?ID={id}

    • POST /attask/api/v18.0/upload

    • POST /attask/api/v18.0/document

    • POST /attask/api/v18.0/docv

  • Folders

    • GET /attask/api/v18.0/documentFolder/{id}?fields=$FIELDS

    • POST /attask/api/v18.0/documentFolder/search?fields=$FIELDS

    • POST /attask/api/v18.0/documentFolder

Progress status and notifications

The connector creates a set of tasks "Tracking Smartling" with predefined custom forms. Additionally, it continuously mirrors data from the Smartling TMS to these tasks.

For major events, the integration adds notes to the "Updates" tab.

Endpoints:

  • Tasks

    • GET /attask/api/v18.0/task/{id}?fields=$FIELDS

    • POST /attask/api/v18.0/task/search?fields=$FIELDS

    • POST /attask/api/v18.0/task?fields=$FIELDS

    • PUT /attask/api/v18.0/task/{id}?fields=$FIELDS

  • Notes

    • POST /attask/api/v18.0/note

Related Articles
Did this answer your question?