Skip to main content

wxrks - AEM Connector

Install and configure the wxrks AEM connector to send Adobe Experience Manager content for translation, project by project or in bulk with the Bulk Translation Wizard.

The wxrks AEM Connector is a custom Adobe Experience Manager Translation Framework connector: it lets you send pages, assets, and content fragments from AEM straight into wxrks for translation, and pulls the finished translations back into the right language copies once they're done.

💡 Who is this for? This guide is for the AEM administrator or developer who installs and configures the connector inside Adobe Experience Manager. Generating the wxrks API credentials used in Step 5 requires a wxrks Account Admin — coordinate with one if you don't hold that role yourself.


Step 1: Access the CRX Package Manager

  1. Open your AEM instance.

  2. Navigate to the "Tools" menu.

  3. Select "Deployment" and then "Packages". This will open the CRX Package Manager.

Group 1 (1).png

Step 2: Upload the Package

1. You can download the latest version of our package from the AEM Connector's GitHub Packages page. The connector targets AEM 6.5 SP21 or later (on-premises or Adobe Managed Services); check with your wxrks contact if you're on AEM as a Cloud Service.

Frame 1.png

2. Click on "Upload Package".

3. The following will be displayed:

4. The package contains the code necessary for creating and executing translation projects in wxrks.

5. The wxrks AEM Connector will appear in the package list.


Step 3: Install the Package

1. Click "Install" to start the installation process.

2. In the "Install Package" dialog, advanced settings are available but not needed for default installation.

3. After successful installation, a green marker will indicate the connector is ready to use.


Step 4: Create Translation Configuration Folders

1. Open the "Tools" menu, then go to "General" and select "Configuration Browser".

2. Click on "Create" to create a new folder.

3. Name the folders and click "Create". It is recommended to create a separate folder for each organizational unit you plan to use, in case you have multiple project types/requirements or work with multiple Translation Agencies.


Step 5: Create the wxrks Cloud Service Configuration

1. Select the Tools menu, then go to Cloud Services and choose wxrks AEM Connector.

2. Open the “Conf” folder, select the folder you want to use, and click on "Create".

3. Choose the wxrks AEM Connector from the drop-down menu.

4. Enter a title for the configuration—preferably using the name of the Organizational Unit or translation agency that will be responsible for translating the content.

5. Fill in the connection fields:

  • wxrks URL — your workspace's URL (for example https://app.wxrks.com).

  • API ID and API Key — generated from a wxrks Account Admin's own Profile > Security tab. See Authenticating with the wxrks API for the full walkthrough.

  • Workflows — loaded live from your wxrks account; select at least one.

  • Language Mapping (optional) — maps AEM locale codes to wxrks language codes when they don't already match one-to-one, for example en=en_us,pt=pt_br.

6. Click on "Test configuration" to verify. A message, "API Key verification passed. Configuration is valid" will confirm a successful setup.


Step 6: Native single-page translation project

This is AEM's built-in per-page flow: one translation project per page, per language, with no consolidation. It's the fastest way to test the connector end to end, and still the right choice for a one-off page. If you regularly need to translate many pages and languages at once, use the Bulk Translation Wizard in Step 8 instead — it wraps this same underlying flow but lets you group everything into far fewer wxrks projects.

1. On the AEM homepage, click on Projects and then Create, to create a Translation Project.

2. Under the Basic tab, add a Title for the project.

3. Then, on the Advanced tab:

a) Add a name to the configuration.

b) Select the Target Language.
c) Enter the path to the folder where the configuration was created.

The content for that language will be automatically routed to the respective Organizational Unit in wxrks based on the configuration you selected.

d) Select Human Translation, which should automatically change the provider to wxrks as your Translation Provider for Human Translation.

e) Unselect the options to Automatically Promote and Approve the translations unless this is expected.

4. Click on Create to complete the project creation.

5. Click on Open to open the project and submit translation jobs.

Note: According to AEM 6.5, each project should have only one target language. It is recommended to create one translation project per iteration, with jobs having a single target language.
Each job in AEM maps 1x1 to a project in wxrks.

For a complete reference on Translation Project management, please visit this link.


Step 7: Submitting jobs for translation

1. From the Project created, click on Add.

2. Select Translation Job and Submit, to create a new translation job.


​3. Back to the Project, on the Translation job just created, click on the ... button.


​4. Now, click Add and select the type of assets you will submit for translation.

5. On this screen, select the pages/campaigns you want to add to the translation job.

6. Back to the translation job, make sure that any Image, Metadata or dictionaries are removed from the translatable file list since they do not contain editable content for translation and may interfere with the automation and completion of the localization process.

7. Once you are all set with the content selection, go back to the main page of your translation job and click on the following button and then Request scope.

8. This will create a translation project in wxrks in Draft status, and on AEM, the status will change to Scope Requested.

Once all files are parsed in wxrks, wxrks will automatically calculate the costs and change the status to Pending*. On AEM, the status of the job will change to Scope Completed.

*The automated cost calculation and status transition require the Quote automation feature to be activated in wxrks and a price list associated with the Organizational unit

9. Click the appropriate button on the translation job screen (refer to the screenshot), then select Start.

This will approve the project in wxrks* and change the status on AEM to Commited for Translation

*If the project is manually approved in wxrks, you must still start the job in AEM; otherwise, AEM will not be able to pull the translated content once it is completed

10. Once all content is fully translated - meaning: All files are fully translated, and all segments are confirmed in the last workflow step in wxrks - AEM will pull the content automatically in a few minutes (make sure to refresh the page on AEM to update the status).

*The project below has just one workflow step (translation), so once it was fully completed, AEM pulled the translated content. If additional workflow steps were available (Review, ICR, Proofreading, etc) AEM would have pulled the content only once all those workflows were fully completed

After the translated content is pulled by AEM, the status on AEM will transition to Ready for Review (unless auto-approval is turned on).

11. The next step is to accept or reject the translations in AEM.
AEM also allows the content to be previewed in context, if necessary.

a) Click on the ... button on the translation job to access the file list.

b) You can then select a page from the list and Preview this page and/or Accept/Reject it.

12. Rejected pages will add a tag to the Work Unit in wxrks so it can be reassigned to the translator for edition

13. Approved pages are considered as Completed on AEM and can no longer be modified.

Once all pages in a translation job are approved, the translation job status will change to Approved on AEM, and in wxrks, the project status will change to Delivered, completing this translation job.


Step 8: Bulk Translation Wizard (send many pages and languages at once)

The native flow above creates one AEM project per page, per language — fine for a single page, but a large content push (many pages, several languages) quickly turns into a wall of separate projects to track, both in AEM and in wxrks. The Bulk Translation Wizard solves this: it's a picker inside AEM that lets you select many pages and languages at once, then consolidates them into as few wxrks projects as you choose.

Open it from Tools > wxrks > Bulk Translation, or navigate directly to /apps/cq/translation/bulkwizard.html on your AEM instance.

🖼️ [SCREENSHOT PLACEHOLDER: The Bulk Translation Wizard's Settings and Content screen in AEM, showing the Operation, Project grouping, and content-picker fields. This is a screen inside AEM's own admin interface — this project has no AEM instance to capture it against; an AEM administrator with access to a live instance should supply a current screenshot.]

Settings

  • OperationNew translation for a first-time send (locales that already have a language copy are skipped automatically, so re-running the wizard is safe), or Re-translate to push updates into locales that already exist. Re-translated content lands in an AEM Launch rather than overwriting the live language copy directly — promote the Launch from AEM's Projects console when it's ready to go live.

  • Project grouping — controls how many wxrks projects your submission becomes:

Grouping

Result in wxrks

One project for the whole submission

A single wxrks project holds every page and every language.

One project per language

One wxrks project per target language, holding all the selected pages.

One project per group

One wxrks project per content group you defined in the wizard, holding all its languages.

One project per group and language

The most granular option — no consolidation, same as the native flow above.

A Submission name (optional) becomes part of the wxrks project name, and you'll also confirm the Source Language and the wxrks Cloud Config Path (the configuration you created in Step 5).

Content to translate

Add one or more groups. In each group, pick the pages or sections you want to send — picking a section includes its whole subtree — and choose that group's target languages. Add as many groups as you need, then click Submit to wxrks.

Tracking progress

After you submit, AEM commits the selected content in the background; a progress bar in the wizard tracks this and finishes at "Submitted to wxrks." Each resulting AEM project is tagged so it's identifiable in wxrks, and from there the delivery, review, and pull-back steps work exactly like the native flow in Steps 6-7: AEM polls wxrks for status, pulls the finished translation once it's ready, and you accept or reject it from AEM's translation project screen.

Did this answer your question?