Integration with your source control system

Compatibility

As the integration with your source control system uses Beebox hotfolder, it makes Beebox compatible with all source control system. Including Subversion, GIT, Team Foundation Server, ...

Needed configuration

As every integration is different depending of the operation of your software, this guide will help you to understand how you could integrate Beebox hotfolder with your source control system, yet you might need to adapt it to your setup and needs.

First of all, you need:

To create a regular Beebox project
- In General, configure the parsers according to the source code you use.
  - If you are using XML files, do not forget to configure the XPath of the translatable content.
- In automation, do not forget to enable file change detection.

Take a look at this guide about file copy and hot folders to understand the settings and customize your setup.

Localisation process

Pull your source code to Beebox hotfolder

Once your Beebox project is ready, you need to decide the way you want to pull your source code into the Beebox input folder.

It can be triggered:

Manually, by copying the files into the folder
Automatically, using a script triggered via:
- Windows Scheduler (once a day-month, on a specific event, ...)
- Your own application (API, service, ...)

Script example

POWERSHELL

cd C:\Beebox\MY_PROJECT_UID\in
git clone http://my_username:my_password@my_server_address/my_project_path.git

Trigger or wait for the translation

Depending of your needs, you might either choose to use Beebox CLI or wait for the automation to deliver the translated files.

Using Beebox CLI

This solution might be correct if you want to include Beebox in your build process. As a synchronous operation, the files are generated immediately but not necessarily fully translated.

Beebox CLI is located at C:\Program Files\Wordbee\Beebox\Server\BeeboxCmd.exe

Using Beebox Automation

This asynchronous solution allows you to publish your localized website once you are sure it is fully localized.

Beebox automatically runs according to the configured frequency and generates the translated files when they are ready.

To check the translation status of your project, you can either:

Use the Beebox UI
Use the API - Get translation status call
Enable the JSON status file under Automation.

Commit and push your translation code, or use it immediately

Once processed, the translated files are generated into the Beebox output folder.

Commit and push

You can also register your git repository in this folder to push your content back to another branch, for example.

Again, this operation could be performed either:

Manually, by copying the files
Automatically, using a script triggered via:
- Windows Scheduler (do not forget to check the status first)
- Your own application (API, service, ...)
- Your build system

Did you know you could also configure Beebox to override the source files under the Hot folders settings ?

This solution is very useful if you want to push your translations to the same branch of your control system.

Use the code immediately

If your application needs to be built before being deployed, then you could easily compile the code using the freshly generated files.

Then, you do not need to push the translated files into your version control system.

Frequent questions

My source code changed, what to do now ?

You just need to pull your branch as described in the first step of the localisation process. Beebox will detect the changed files and will send them for translations again if needed.