Eloqua connector
The BWX Eloqua connector creates translation projects in BWX from assets in Eloqua’s platform.
This article guides you through setting up the Eloqua configuration up to creating a project in BWX.
Getting Started
Step 1: Create Your Organizational Unit
If you haven’t done so already, please refer to our instructions to create your organizational unit.
Step 2: Configure your Organizational Unit
The connector needs the credentials to retrieve data from Eloqua. This configuration is done at the Organizational Unit level.
The configuration is created through the endpoint POST /api/v3/connector/eloqua/config which expects a request body in the following format:
{
"orgUnitUuid": "string",
"companyName": "string",
"username": "string",
"password": "string"
}orgUnitUuid- the UUID of the Org Unit you’re creating the configuration for. This information can be easily retrieved in the Org Unit’s URL:companyName- this is the company name used to access an Eloqua accountusername- Eloqua’s usernamepassword- Eloqua’s password. This is encrypted before being stored.
Step 3: Creating a translation project
Once the credentials configuration has been created, you’re set up to creating translation projects in Bureau Works.
The endpoint to create a project from Eloqua’s assets is POST /api/v3/connector/eloqua/sync. Its parameters are detailed in the table below.
Parameter | Type | Description | Required | Limitation |
|---|---|---|---|---|
orgUnitUUID | string | The UUID of the Organizational Unit under which the project will be created. This information is present in the URL of the Org. Unit. | 1 per call | |
contactUUID | string | The UUID of the Project's POC (contact) in BWX | 1 per call | |
configUUID | string | If specified, will fetch a specific config regardless of the Organizational Unit | 1 per call | |
ciTag | string | The identifier tag of the project in the Org. Unit. It defaults to |
| 1 per call |
reference | string | The name of the project that appears in our dashboard. It defaults to |
| 1 per call |
sourceLanguage1 | string | The source language of the assets to be translated. If none is provided, this is retrieved from the Org. Unit’s configuration. |
| 1 per call |
targetLanguages1 | list | The list of target languages the assets should be translated to. If none is provided, this information is retrieved from the Org. Unit's configuration. |
| Limited to target languages listed in BWX |
workflows | list | A list of workflows to use for all assets. If none is provided, the workflows will be inferred by our system for each file. |
| Limited to Workflows configured at your BWX Account level |
tags | list | List of tags to add to the project. |
| 10 tags per project at most |
type | string | The type of asset to fetch from Eloqua. Currently available values are:
| None | |
assetIds | list | List of asset IDs to fetch from Eloqua. These will be added to the asset ids found in directories listed in |
| 100 |
sourcePaths | list | List of full directory paths in Eloqua. All assets of the given |
| 1 Path per call |
skipSuffixes | list | List of suffixes that should be ignored when fetching the Eloqua emails |
| None |
skipHashCheck | boolean | Whether assets with the same content should be sent for translation again. This needs to be |
| None |
1 The code of the language is expected in these parameters. This information is available through the Languages endpoint on our documentation.
The Eloqua connector is not sending nested content for translation.
If an email has dynamic contents in it, these will not be pulled automatically.
This doesn’t mean that emails and dynamic contents cannot reside in the same translation project.
It’s allowed to repeat the ciTag attribute in different project creation requests.
Translating assets from a specific folder
The sourcePaths parameter expects a list of full directory paths. If this is provided, all the assets in the listed directories (and their subdirectories) will be considered for translation.
Take a look at the following example request:
{
"configUUID": "eloqua-config-uuid",
"contactUUID": "contact-person-uuid"
"orgUnitUUID": "org-unit-uuid",
"targetLanguages": ["es_es","pt_br"],
"workflows": ["TRANSLATION","REVIEW"],
"assetType": "EMAIL",
"sourcePaths": [
"/Email Group Root/BureauWorks_Test"
]
}This will create a translation project with all the emails located under /Email Group Root/BureauWorks_Test hierarchy.
This project will contain only the language Spanish (Spain) and the workflow TRANSLATION for all files.