Skip to content
Blackbird docs

Drupal

View on Github

Drupal integration uses Translation Management Tool (TMGMT) jobs. Unlike CMS integrations that watch page changes, this app receives translation jobs already assembled by TMGMT. One job can contain fields from one or more pages or other Drupal content items.

TMGMT Blackbird module

Section titled “TMGMT Blackbird module”

Install and configure the TMGMT Blackbird module on your Drupal site. The module exposes translation jobs to Blackbird and receives translated job content.

Requirements

Section titled “Requirements”

The module requires Translation Management Tool (TMGMT).

Installation

Section titled “Installation”

Install the module as a contributed Drupal module. See Installing contributed modules for Drupal instructions.

Configuration

Section titled “Configuration”

Go to /admin/tmgmt/translators and configure the Blackbird translator.

  • Copy the translator API key. The same key is required when creating the Blackbird connection.
  • Enable Auto accept finished translations if completed translations should be accepted without manual review.

Translation workflow

Section titled “Translation workflow”

A TMGMT job is the content unit used by blueprint actions. Its Job ID becomes the unique content ID, and its target language becomes the content variant.

  1. Create a TMGMT translation job in Drupal and select Blackbird translator.
  2. Start the bird with On translation jobs requested.
  3. Pass the Job ID from the event to Download job content.
  4. Translate the downloaded content.
  5. Pass the translated content and job target language to Upload job content.

Connecting

Section titled “Connecting”
  1. Open Apps, search for Drupal, and select Add connection.
  2. Enter a connection name.
  3. Enter Drupal Base URL, for example https://drupal.example.com.
  4. Enter the API key copied from the Blackbird translator configuration.
  5. Select Connect and verify that the connection succeeds.

connection

Actions

Section titled “Actions”

Jobs

Section titled “Jobs”
  • Search jobs: Search translation jobs using optional filters.
    • Advanced settings:
      • State: Filter jobs by active, completed, or aborted state. Defaults to active jobs.
      • Target language: Filter jobs by target language.
      • Created after: Filter jobs created on or after the selected date and time.
  • Download job content: Download assembled content from a translation job.
    • Advanced settings:
      • File format: Select Original to download content without interoperability metadata. Default output includes metadata and stable field keys needed for content roundtrip.
  • Upload job content: Upload translated content to a translation job and output content with updated target metadata. Content and Target language are required. Target language must match the job configuration. Supports content produced from HTML, XLIFF 1, or XLIFF 2 workflows.
    • Advanced settings:
      • Job ID: Override the Job ID embedded in the content. Leave empty when the content still contains its original Job ID.

Events

Section titled “Events”

Translation jobs

Section titled “Translation jobs”
  • On translation jobs requested: Outputs newly requested translation jobs.
    • Advanced settings:
      • Target languages: Trigger only for jobs with selected target languages.

Error handling

Section titled “Error handling”

Errors include the status code and message returned by Drupal where available. Confirm the Job ID, target language, API key, and connection Base URL before retrying.

Example error message: Status code: 404, Error: Page not found | Blackbird Demo

Feedback

Section titled “Feedback”

Share feedback through Blackbird support channels or create an issue in this repository.