Skip to content

The Translation provider model allows you to integrate with and extend translation manager to work with your translation company or service.

ITranslationProvider

To create a translation provider your code must implement the ITranslationProvider interface. This interface is used by Translation Manager to submit jobs via your provider, check for translations and transmit any content.

Main Methods

the ITranslationProvider interface has several methods that can be called by translation manager as needed. of these two events will do the bulk of the work in submitting and checking the status of any translation jobs.

Submit

The Submit event is called once a translation job has been created within Translation Manager. The job contains all the required information from the Umbraco site about the content that requires translation.

during the submission process, the provider is expected to extract this information from the job and submit it to the external translation service.

there are several helper classes within Translation Manager to assist with this most notably the XliffSerializer classes which can convert translation jobs to and from XLIFF format.

Check

Views

Translation Manager also can extend the views the user sees when using your translation provider - by default your provider can interact with the user at three locations :

Creation (pending)

when a user creates a translation job, either within the send to translation process or from the pending queue within translation manager - then the relevant provider pending view will be loaded into the page.

Typically at this point, providers may gather extra information (such as notes, or language style) - which can be packed into a translation jobs 'ProviderProperties' class and stored with the job.

After Submission (Submitted)

Once a translation job has been submitted - Translation manager will display the 'submitted' view of a provider as part of the submitted view within Umbraco.

Typically this view is used to provide a link to the translation service, (such as their online portal) - or any update text from the service that might be avalible.

Returned (Recevied)

Once a translation job has been completed by teh translation service the job status will move to received. at this point any information from the providers 'recevived' view will be displayed above the job.

Settings View

The settings view is shown within the settings section of translation manager - to allow the user to set and change any global provider settings (such as APIKeys or access URLs)