EMC Documentum Content Transformation Services Transformation Suite 7.2 Development Guide

98 Pages·2015·0.95 MB·English

® ®
EMC Documentum
Content Transformation Services
Transformation Suite
Version 7.2
Development Guide
EMC Corporation
Corporate Headquarters:
Hopkinton, MA 01748-9103
1-508-435-1000
www.EMC.com
Legal Notice
Copyright © 2002–2015 EMC Corporation. All Rights Reserved.
EMC believes the information in this publication is accurate as of its publication date. The information is subject to change
without notice.
THE INFORMATION IN THIS PUBLICATION IS PROVIDED "AS IS." EMC CORPORATIONMAKES NO REPRESENTATIONS
OR WARRANTIES OF ANY KINDWITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY
DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.
For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. Adobe and Adobe PDF
Library are trademarks or registered trademarks of Adobe Systems Inc. in the U.S. and other countries. All other trademarks
used herein are the property of their respective owners.
Documentation Feedback
Your opinion matters. We want to hear from you regarding our product documentation. If you have feedback about how we can
make our documentation better or easier to use, please send us your feedback directly at
Table of Contents
Preface ................................................................................................................................ 9
Chapter 1 Overview ..................................................................................................... 11
About Content Transformation Services ............................................................. 11
About the Content Transformation Services SDK............................................ 12
Contents of the SDK ................................................................................. 12
Content Transformation Services SDK Supportability ..................................... 13
Content Transformation Services integration with other applications ............... 13
Content Transformation Services architecture..................................................... 14
How Content Transformation Services works ................................................. 14
Plug-ins ........................................................................................................... 14
Plug-in framework ....................................................................................... 15
The rendition model through Content Transformation Services ........................... 16
Transforming objects......................................................................................... 17
How Content Transformation Services transform objects................................. 17
Content Transformation Services Local Service API ........................................ 19
Content Transformation Services Remote Service API ..................................... 19
Content Transformation Services SDK............................................................ 20
Tasks ........................................................................................................... 20
Chapter 2 Working with profles .................................................................................. 21
Understanding transformation profles .............................................................. 21
Reusing transformation profles..................................................................... 22
Profle types ................................................................................................. 22
System profles ......................................................................................... 22
User profles............................................................................................. 23
Command line fles................................................................................... 23
Invoking a profle ......................................................................................... 23
Enabling a user profle in Webtop or DAM..................................................... 24
Example of generation upon import............................................................... 24
Understanding command line fles .................................................................... 27
Content Transformation Services DTD ........................................................... 27
Chapter 3 Using the Content Transformation Services Local Service API ................... 31
How the Content Transformation Services Local Service API works..................... 31
Using the Content Transformation Services Local Service API ............................. 32
Prerequisites ................................................................................................ 32
Running the Content Transformation Services Local Service API ..................... 33
Making API calls .............................................................................................. 33
Using the Batch script ....................................................................................... 36
Content Transformation Services real-time SBO Java client setup ......................... 38
Chapter 4 Creating and installing plug-ins .................................................................. 43
EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Development Guide 3
Table of Contents
Prerequisites for creating a plug-in .................................................................... 43
Content Transformation Services installed and confgured for
repository .................................................................................................... 43
Creating a plug-in............................................................................................. 43
Creation process overview ............................................................................ 44
ICTSPlugin Interface..................................................................................... 44
Creating a profle.......................................................................................... 44
Testing and installing a plug-in.......................................................................... 44
Testing process overview .............................................................................. 45
Installing a plug-in ........................................................................................... 45
Installation process overview ........................................................................ 45
Import your profle....................................................................................... 45
Confguring the CTSPluginService.xml fle .................................................... 46
Chapter 5 Example: Creating a TEXT plug-in .............................................................. 47
Overview of example — TEXT Plug-in............................................................... 47
Identify the Transformation plug-in ................................................................... 48
Executing a profle............................................................................................ 48
Command line fle content ............................................................................ 49
convertToWindowsCRLF and others.................................................................. 50
extractProperties .............................................................................................. 52
Clean-up.......................................................................................................... 54
Logging ........................................................................................................... 56
Internationalization .......................................................................................... 57
Suggested approaches and helpful hints ............................................................ 57
XML confguration fles................................................................................. 57
JNI and Java-COM bridges............................................................................ 58
Client libraries.............................................................................................. 59
Error handling.......................................................................................... 59
Service and desktop interaction ................................................................. 59
Concurrency ............................................................................................ 60
JVM crash ................................................................................................ 60
Chapter 6 Example: Testing the TEXT plug-in ............................................................. 61
Classpath ......................................................................................................... 61
Parameters ....................................................................................................... 61
Working directory ............................................................................................ 61
Chapter 7 Example: Installing the TEXT plug-in .......................................................... 63
Chapter 8 Content Transformation Services Javadocs ................................................ 67
Viewing the Javadocs........................................................................................ 67
Appendix A TextPlugin.java ............................................................................................ 69
Appendix B Local Service API sample code ................................................................... 83
Appendix C Transformation profles ............................................................................... 89
to_WindowsText.xml ........................................................................................ 89
to_UnixText.xml ............................................................................................... 89
to_MacText.xml ................................................................................................ 90
4 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Development Guide
Table of Contents
Appendix D Command Line fles .................................................................................... 91
text_extract_properties_clf.xml .......................................................................... 91
to_WindowsText.xml ........................................................................................ 91
to_UnixText.xml ............................................................................................... 91
to_MacText.xml ................................................................................................ 92
Appendix E Confguration fles ....................................................................................... 93
text.xml............................................................................................................ 93
MP_Confg.dtd................................................................................................. 94
Appendix F TextProcessor.java ...................................................................................... 97
EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Development Guide 5
Table of Contents
List of Figures
Figure 1. Plug-in Framework............................................................................................... 16
Figure 2. The Transformation Process .................................................................................. 19
Figure 3. Transformation Service execution by Content Transformation Services API .............. 31
6 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Development Guide
Table of Contents
List of Tables
Table 1. Profle source and target formats ........................................................................... 21
EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Development Guide 7
Table of Contents
8 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Development Guide
Preface
This guide provides instructions for extending Content Transformation Services products through
web services and new profles to tailor transformation functionality to fulfll your organization’s
unique requirements.
This guide contains an overview of the Content Transformation Services architecture and the plug-in
framework. It highlights the API methods and provides instructions and examples for creating and
confguring new plug-ins.
This manual assumes that Content Transformation Services is successfully installed. EMC
Documentum Content Transformation Services Transformation Suite Installation Guide provides
information on installing Content Transformation Services products.
Intended Audience
This manual is intended for the person who is responsible for developing new transformation
plug-ins for Content Transformation Services products. The reader is assumed to have a basic
understanding of Java programming, XML, web service specifcations, and the fundamentals of
the Documentum platform.
Revision History
The following changes have been made to this document.
Revision History
Revision Date Description
February 2015 Initial publication.
EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Development Guide 9
Preface
10 EMC Documentum Content Transformation Services Transformation Suite Version 7.2 Development Guide