The BWX WordPress connector (WPC) creates translation projects in BWX from assets in a WordPress server.
This article assumes your WPC has been configured properly and will guide you through creating a project in BWX.
Creating a translation project with WPC
The endpoint to create a translation using WPC (https://dev.bureauworks.com/#4e54d0dc-d489-4480-afe4-0a403d78db45 ) accepts quite a few parameters. They are detailed in the table below.
|The UUID of the Organizational Unit under which the project will be created. This information is present in the URL of the Org. Unit.
The UUID of the Project's POC (contact) in BWX
|If specified, will fetch a specific config regardless of the Organizational Unit
|The identifier tag of the project in the Org. Unit. It defaults to
The name of the project that appears in our dashboard. It defaults to
|The source language of the assets to be translated. If none is provided, this is retrieved from the Org. Unit’s configuration.
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.
|A list of workflows to use for all assets. If none is provided, the workflows will be inferred by our system for each file.
|List of tags to add to the project.
|The type of asset to fetch from WordPress
|List of asset ids to fetch from WordPress. If this is empty, all assets of the given will be considered for translation
|Used to include assets whose link matches any entry in this array. Has no effect if
|Assets whose links match elements of this array will not be considered for translation. Has no effect if
wpIds is provided
|If set to
true, will create entries regardless of their previous statuses. Default is
|Whether assets with the same content should be sent for translation again. This needs to be
true if a previous project containing the assets was marked as
CANCELLED. Default is
code of the language is expected in these parameters. This information is available through the
Languages endpoint on our documentation - https://dev.bureauworks.com/#27de623d-564e-4a38-827b-1d1570a53f7e
Type is required so the connector knows what to look for.
wpIds is not empty, then
wpExcludePaths will not be taken into account.
Also, the execution will fail if the type of any page provided in
wpIds doesn’t match the
Including specific pages
wpPaths parameter expects a list of paths. If this is provided, only the assets listed will be considered for translation.
Take a look at the following example request:
This will create a project to translate the assets with the following slugs:
Every page whose slug contains the
/blog/museumtext. You can use the wildcard character only at end of strings.
This project will contain only the language
Spanish (Spain) and the workflow
TRANSLATION for all files.
Excluding specific pages from translation
wpExcludePaths parameter expects a list of paths. If this is provided, the assets listed will not be considered for translation.
This parameter is similar to
wpPaths, so the wildcard character is also available here.
wpExcludePaths takes precedence over
This means that if the slug of a page matches values from both lists, the page will not be considered for translation.