Integrating with external systems

The translation add-on sends documents to an external system of translation agency.  

To support that, the external system has to have a suitable API and a connector (a Java class) has to be implemented and configured.

The Translations Add-on supports these integrations:

• GlobalLink (translations.com), see the GlobalLink connector documentation.
• LiveWords (livewords.com),  see the LiveWords connector documentation.

There is also a Tester Connector for test and demo purposes that does not go to an external system but can mirror back translation requests.

Format of the document

Document are sent to the external system in a generic XML format. The below example, for version 2.2.0, should be self-explanatory.

<document jobItemId="aec3aa3b.." [jcr:uuid of job item node]
          documentId="9e1c972d.." [jcr:uuid of the document handle]
          name="test1" [document handle node name)
          path="/content/documents/myhippoproject/news/test1"
          type="mynamespace:mytester" [JCR document type]
          translationId="b06571e2.." [hippotranslation:id of the document; link between translated documents]
          translationLocale="en" [hippotranslation:locale of the document]>
    <name>Test 1 Display Name</name>
    <mixinTypes>
        <mixinType>mix:versionable</mixinType>
        <mixinType>mix:referenceable</mixinType>
    </mixinTypes>
    <fields>
        <!-- regular string field -->
        <field isPropertyField="true" multiple="false" name="[mynamespace]:mystring" type="String">
            <value>Text</value>
        </field>
        <!-- multiple string field -->
        <field isPropertyField="true" multiple="true" name="[mynamespace]:mymultiplestring" type="String">
            <value>one</value>
            <value>two</value>
            <value>three</value>
        </field>
        <!-- compound rich text editor field -->
        <field name="[mynamespace]:myhippostd_html" type="hippostd:html">
            <value>&lt;p&gt;Extended HTML Lorem ipsum&amp;nbsp;&lt;/p&gt;</value>
        </field>
        <!-- primitive HTML field -->
        <field isPropertyField="true" multiple="false" name="[mynamespace]:myhtml" type="String">
            <value>&lt;p&gt;Simple HTML Lorem ipsum&amp;nbsp;&lt;/p&gt;</value>
        </field>
        <!-- text field -->
        <field isPropertyField="true" multiple="false" name="[mynamespace]:mytext" type="String">
            <value>Text Lorem Ipsum</value>
        </field>
        <!-- date field -->
        <field isPropertyField="true" multiple="false" name="[mynamespace]:mydate" type="Date"> 
            <value>2017-10-12T11:00:00.000+02:00</value>
        </field>
        <!-- integer number field -->
        <field isPropertyField="true" multiple="false" name="[mynamespace]:mylong" type="Long">
            <value>10</value>
        </field>
        <!-- decimal number field -->
        <field isPropertyField="true" multiple="false" name="[mynamespace]:mydouble" type="Double">
            <value>100.0</value>
        </field>
        <!-- compound link field -->
        <field name="[mynamespace]:myhippo_mirror" type="hippo:mirror">
            <value>9caea793-42b1-4f3e-a8e5-d58f810ce2ef</value>
        </field>
       <!-- docbase field -->
        <field isPropertyField="true" multiple="false" name="[mynamespace]:mydocbase" type="String">
            <value>64ab4648-0c20-40d2-9f18-d7a394f0334b</value>
        </field>
        <!-- boolean field -->
        <field isPropertyField="true" multiple="false" name="[mynamespace]:myboolean" type="Boolean">
            <value>true</value>
        </field>
    </fields>
</document>