Hebrew Language Support for PitStop XML Reports

What this article covers

This article explains how to enable and configure automatic translation support for PitStop XML reports within PDF Profile Settings.
You’ll learn what’s included in this update, which settings to adjust, and how to verify that localized (including Hebrew) text displays correctly in your production reports.

About this feature

Previously, PitStop XML reports could only display English or Latin-based characters, meaning localized messages from pre-flight or profile checks were not always readable.

This enhancement introduces automatic translation support for PitStop XML output — including full Hebrew character support.
When enabled, the system translates the XML text content into the configured language so reports remain clear and usable for non-English operators and clients.

What’s included

• New XML Translation Support option added to PDF Profile Settings

• Ability to translate all XML report content, including non-Latin scripts (e.g., Hebrew)

• Automatic character-encoding handling to prevent corrupted text

• Integration with external translation services via API key

Key settings

• XML Translation Support
  Located in Admin → PDF Profiles → Profile Settings.
  Enables automatic translation for PitStop XML report text.

• API Key
  Required if you use an external translation service.
  Enter this in the same settings area to authorize translations.

• Language Selection
  Controlled by your storefront’s default language or configured per profile.

Use cases

• International production environments: Ensures operators in non-English markets can review PitStop errors and pre-flight messages in their native language.

• Client-facing reports: Present pre-flight feedback in the same language as the customer’s storefront.

• Localization testing: Validate that generated PitStop XML files retain full readability for right-to-left scripts such as Hebrew.

Step-by-step implementation

Step 1 – Access PDF Profile Settings

1. Go to Admin → PDF Profiles.

2. Select the profile you want to modify and click Edit.

3. Locate the Profile Settings section.

Step 2 – Enable XML translation

1. Find the XML Translation Support toggle.

2. Enable the setting to activate translation for PitStop XML reports.

Step 3 – Enter your API key (if required)

1. If you are using an external translation service, locate the API Key field.

2. Enter the key provided by your translation service or administrator.

3. Save changes.

Step 4 – Verify translation

1. Generate a new PitStop XML report using the modified profile.

2. Open the report and confirm that all text, including Hebrew characters, appears translated and readable.

3. Validate that no encoding errors or missing symbols are present.

Step 5 – Test with multiple languages (optional)

• Switch your storefront’s language to another supported option (e.g. French, German, Hebrew).

• Run another test to confirm correct translation output for each language configuration.

Tips & best practice

• Always test new translations in a staging environment before enabling them in production.

• Keep your API key secure — avoid sharing or embedding it in scripts.

• Confirm that the PitStop profile name and XML encoding remain UTF-8 to preserve character integrity.

• When generating client-facing reports, ensure the storefront and PitStop report language align for consistency.