Requests Overview Dashboard

Info: Bloomreach provides Enterprise support for this feature for Bloomreach Experience customers. The release cycle for this feature may differ from the core product release cycle.

When you install the dashboard (see Installation), the CMS displays a "Translation requests" entry under the "Extension" menu. This dashboard provides an overview of all translation requests stored in the repository.

The image above shows the dashboard in version 5.6.0. In versions earlier than 5.6.0, the filters on the left side are not available.

The dashboard lists translation requests, with each row representing a submitted request for a source document. The table includes the following columns:

• Document: A clickable link to the source document associated with the request.
• Submitted: The user who submitted the request and the date/time of submission.
• Connector: The short name of the connector used for the request.
• Updated: The date/time when the request was last updated. For completed requests, this indicates when the translation was submitted to the system.
• Translations: Displays the status of the request for each target language. Multiple target languages can be selected in a single request. This column shows:
  • A flag for the target language. Hovering over the flag displays the locale code.
  • A publication status icon if a translated document exists. Hovering over the icon shows 'Live', 'Offline', or 'Previous version live'.
  • A request status text indicating the progress: Queued, Submitted, Cancelled, Completed, or Error.
    • If the status is Error, hovering displays a detailed error message. From version 8.1.2, clicking the status opens an Error details modal. See Target-Level Translation Errors.
    • If the status is Completed, the text is a clickable link to the target document. An asterisk (*) after the link indicates a new completed translation within the current CMS session.
• Actions: Available actions depend on the request status:
  • Cancel: Available if the translation request was submitted to the external system and has not yet returned. This action requests cancellation from the external system.
  • Re-submit: Available if a translation request was previously cancelled. This action submits a new translation request for the specified target languages.
  • Delete: Available if the translation request was previously cancelled or is completed (i.e., returned from the external system). This action deletes the request from the repository without contacting the external system.

Note: The Cancel and Re-submit actions are unavailable if the configured connector does not support cancellations (for example, the LiveWords connector).

• Copy button: Allows you to copy a table row to the clipboard. The copied data may include additional attributes specific to the connector.

Rows That Fail to Load

Starting with version 8.1.0, if a job node is corrupt, incomplete, or otherwise unreadable, the dashboard no longer fails entirely. Instead, the affected row degrades gracefully:

• The row displays with an amber tint (amber left border, pale amber background, italic muted text) to distinguish it from normal rows.
• An amber Error badge with a warning icon appears. Hovering over the badge shows a summary; clicking it opens a modal with:
  • Job item ID and Document ID
  • The error type and message
  • Copy (copies all displayed information as plain text) and Close buttons

Note: This "Error" state is different from the Error request status described under Translations. The request status of Error covers two scenarios, both shown with the same hover text:

• The request did not reach the external system. Hovering shows: "The translation request has failed and did not reach the external system." This case is retried automatically by the RetryTranslationRequests scheduler job, up to the configured maxRetry attempts.
• The external system received the request but reported a failure. Hovering displays the connector's error message.

A degraded row or target indicates the dashboard could not read the job or target data from the repository. Hovering or opening the modal displays a data-corruption message (for example, "...could not be fully loaded - the...node may be corrupt or missing. Check the server log for details."). All three scenarios display "Error," but only repository corruption is a potential dashboard or UI issue. The other two indicate expected error handling for external integration or network failures.

Target-Level Translation Errors

From version 8.1.2, if an Error status appears for a target language, you can click it to open an Error details modal for that target. The modal displays:

• Document name, including the target locale (for example, "Sample document (de_DE)")
• Job item ID and Document ID
• The error type and message
• One additional detail row, depending on the cause (only one displays at a time):
  • Conflicting folder: A clickable link opens the conflicting folder in the content perspective. This works even when the CMS is served behind a reverse proxy that rewrites the external path prefix.
  • Import failure detail
  • Missing translation detail
  • Connector failure detail: Includes the failure reason from connectors such as ChatGPT and Star, which previously only reported a generic Error status.
• View document, Copy, and Close buttons

Targets That Fail to Load

Also from version 8.1.2, if a target's data cannot be read from the repository (for example, the node is corrupt or missing), the dashboard degrades gracefully. The affected target displays an amber Error badge, and clicking it opens the Error details modal with a message indicating the target's data could not be fully loaded.