A brief introduction to the new standard for exchanging translation data. www.blog.ovidius.com www.dercom.de

1. What is COTI?
A brief introduction to the new standard for exchanging
translation data

2. COTI = Common Translation Interface

3. Common: not proprietary

4. Translation: the rendering of something into
another language
(dictionary.com)

5. Interface: a common boundary or interconnection between systems
(dictionary.com)

6. COTI: Standard for exchanging translation data
with a Translation Management System

7. Why?

8. Translation data is complex.

9. Everybody does it differently.

10. System integration is key.

11. Strong demand to increase flexibility and
capability of CMS/ TMS integration

12. Who?
The Association of German Editing and Content
Management Software System Designers

13. German vendors for Content Management Systems

14. How does it
work?

15. L3:Communication API
L2:Import and Export
L1:Translation
package
3 consecutive integration levels

16. Level 1: Translation package defined
Translation data is provided in the specified
package structure.

17. Level 2: automatic export and import
Translation packages are exchanged with the
TMS via the specified exchange folder
mechanism.

18. Level 3: Communication API
Translation packages are exchanged with the
TMS using the Communication API over SOAP.

19. Level 1
Translation packages

20. COTI translation package = ZIP-file with meta
file, translation files, reference files
and additional files

21. translation-COTI-specification_ 2009-11-13T10:39:35Z.coti
/4711_de-DE_en-GB/
/COTI.xml
/translation files/
/reference files/
/4711_de-DE_ru-RU/
/COTI.xml
/translation files/
/reference files/
A COTI package
multiple projects
in one package!

22. <coti version="1.0" level="1" ...>
<project name="4711" project-id="123" proposal="yes"
checkout-date= "2013-08-21T11:59:00Z" due-date= "" ...>
<subject>Subject</subject>
<translation source-language= "de-DE" targetlanguage= "en-GB" status="none|proof|final"/>
<meta name="CMS meta field" value="123"
description=""/>*
<files>...</files>
</project>
</coti>
Meta file COTI.xml

23. Meta file | COTI.xml
Describes the translation project.
References the project content.

24. Translation content
All files to be translated.
Can be anything, not only XML.

25. Reference content
Optional support material for the translator or
the TMS.
DTDs, Style sheets, templates, context material
(e.g. rendered output)

26. Level 2
How to exchange those COTI packages?

27. the CMS puts
untranslated/
packages here...
translated/
error/untranslated/
...and gets translated content
error/translated/
back, here
archive/untranslated/
archive/translated/
logs/TMS
logs/CMS
The COTI exchange folder

28. Level 3
Communication API

29. the “grown up” system integration

30. <e:Envelopexmlns:e="http://www.w3.org/2003/05/soapenvelope">
<e:Header>
<!-- Header data />
</e:Header>
<e:Body>
<!-- Body data />
</e:Body>
</e:Envelope>
SOAP v1.2 message
Here is where the COTI
payload goes

31. Binary content? MTOM
(SOAP Message Transmission Optimization Mechanism)

32. Content-Type: multipart/related;boundary=MIMEBoundary_5F0BF3DC11582467646222; type="application/xop+xml";
start="<0.urn:uuid:5F0BF3DC11582467646223@apache.org>";
start-info="text/xml";charset=UTF-8
--MIMEBoundary_5F0BF3DC11582467646222
content-type: application/xop+xml; charset=UTF-8; type="text/xml"; content-transfer-encoding: binary
content-id: <0.urn:uuid:5F0BF3DC11582467646223@apache.org>
<e:Envelope ...>
<e:Body>
<c:SampleRequest>
<xop:Include href="cid:1.urn:uuid:5F0BF3DC11582467646221@apache.org"/>
</c:SampleRequest>
</e:Body>
</e:Envelope>
--MIMEBoundary_5F0BF3DC11582467646222
content-type: text/plain content-transfer-encoding: binary
content-id: <1.urn:uuid:5F0BF3DC11582467646221@apache.org>
... binarydata ...
--MIMEBoundary_5F0BF3DC11582467646222--
MTOM MIME attachment

33. Authentication and Security? WS-Security;
Support of Username Token and X.509 profiles
is mandatory

34. <s:Security>
<s:UsernameToken>
<s:Username>TheName</s:Username>
<s:Password Type="s:PasswordDigest">
fj73h83jcG6SD5k98jsd7jgmn/yj0=
</s:Password>
<s:Nonce>5uW4ABku/m6/S5rnE+L7vg==</wsse:Nonce>
<wsu:Created xmlns:wsu=
"http://schemas.xmlsoap.org/ws/2002/07/utility">
2013-07-12T04:24:02Z
</wsu:Created>
</s:UsernameToken>
</s:Security>
WS-Secutity header with Username Token

35. <e:Envelope
xmlns:e="http://www.w3.org/2003/05/soap-envelope"
xmlns:c="http://www.DERCOM.de/COTI/2013/1.0/namespace">
<e:Header>
<c:COTIsessionId>345jkhjDHjk1Dl9HgelkDLK</c:COTIsessionId>
</e:Header>
<e:Body>
<!-- Body data -->
</e:Body>
</e:Envelope>
COTIsessionId authenticates an API call after
login()

36. Level 3 - CMS API
The interface of the CMS

37. SessionService
Login and logout from the CMS

38. NotificationService
TMS pushes updates for translation projects

39. ReportService
TMS pushes requested reports

40. this is where the music plays
Level 3 - TMS API
The interface of the TMS

41. SessionService
Login and logout from the TMS

42. InfoService
Request meta info from the TMS: version,
meta attributes, status of a project

43. ReportService
CMS requests reports

44. ProjectService
create and manage translation projects

45. DocumentService
upload and download documents

46. 1.
String CreateProject(byte[] cotiFile)
2.
String UploadDocument(String projectId, FileType
fileType, String fileRef, byte[] content)
3.
void StartProject(String projectId, String workflow)
4.
byte[] DownloadDocument(String documentId)
5.
void CloseProject(String projectId)
Lifecycle of a translation project in TMS API calls
(if all goes well)

47. Good to know
CreateProject and UploadDocument are
different operations for a reason: by sending
one document at a time, the interfaces scales.
Big documents can still be a problem though
and should be avoided.

48. And adoption of the standard? The
standardization process is currently in the
Request for Comments status.
The DERCOM members are committed to
implement all levels as soon as RfC phase
concludes.

49. Thank you!
Get the COTI spec: http://www.dercom.de/projekte
Twitter: #PRubarth