® ® EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Administration Guide EMC Corporation Corporate Headquarters: Hopkinton, MA 01748-9103 1-508-435-1000 www.EMC.com Legal Notice Copyright © 2002–2016 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 ................................................................................................................................ 11 Chapter 1 Content Transformation Services Overview ................................................ 13 Content Transformation Services ....................................................................... 13 CTS Documents................................................................................................ 14 How CTS Documents works ......................................................................... 14 How CTS Documents creates PDF renditions ............................................. 14 How CTS Documents creates HTML renditions.......................................... 15 Installed components.................................................................................... 16 CTS Documents plug-ins............................................................................... 16 CTS Media ....................................................................................................... 17 Installed components.................................................................................... 17 CTS Media plug-ins ...................................................................................... 18 CTS Audio-Video ............................................................................................. 19 Installed components.................................................................................... 19 CTS Audio-Video plug-ins ............................................................................ 19 XML Transformation Services............................................................................ 19 How XML Transformation Services works ..................................................... 20 How XML Transformation Services creates PDF renditions ......................... 20 How XML Transformation Services creates HTML renditions...................... 21 How XML Transformation Services creates CHM renditions ....................... 22 XML Transformation Services plug-in ............................................................ 23 Installed components.................................................................................... 23 Content Transformation Services transformations............................................... 24 Automated transformations .......................................................................... 24 Generating thumbnails ............................................................................. 26 Generating storyboards............................................................................. 26 Generating low-resolution renditions......................................................... 26 Extracting media properties ...................................................................... 27 Extracting XMP metadata.......................................................................... 27 User transformations .................................................................................... 27 User transformation profles...................................................................... 29 Chapter 2 Administering and Confguring Content Transformation Services through Documentum Administrator ........................................................... 31 Starting and stopping the Content Transformation Services Administration Agent....................................................................................... 32 Chapter 3 Confguration and Administration Tasks and Tips ...................................... 35 General confguration and administration tasks.................................................. 35 Starting and stopping Content Transformation Services .................................. 35 Adding or removing repositories using Content Transformation Services confgurator .................................................................................... 36 Confguring separate Content Transformation Services instances to handle real-time and asynchronous requests .................................................. 36 EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Administration Guide 3 Table of Contents Integrating a Streaming Server with Content Transformation Services.............. 37 Prerequisites ............................................................................................ 37 Setting up a Streaming Server.................................................................... 37 Setting up streaming storage areas............................................................. 38 Setting default_storage for the format objects ............................................. 38 Finding fle format names ..................................................................... 39 Windows Media formats....................................................................... 39 Real Media formats............................................................................... 39 Darwin formats .................................................................................... 40 Flash formats ....................................................................................... 40 Ensuring Streaming Server access to storage areas ...................................... 40 Creating mount points or VirtualDirectory................................................. 40 Setting the storage area’s base_url attribute ................................................ 41 Testing the Streaming Server ..................................................................... 42 Real Helix on Windows......................................................................... 42 Defning fle formats and DOS extensions ...................................................... 43 Confguring Inbox notifcations ..................................................................... 44 Inbox notifcation behavior........................................................................ 45 Changing the Content Transformation Services user ....................................... 46 Confguring multiple domains for Content Transformation Services products ...................................................................................................... 46 Changing the administrator password ........................................................... 47 Using the Content Transformation Services Reporting Tool ............................. 48 Enabling and disabling the Content Transformation Services Reporting Tool ......................................................................................... 48 Viewing the Content Transformation Services Reporting Tool report ............ 49 Managing the transformation queue .............................................................. 50 Viewing transformation requests in the queue............................................ 50 Changing a queue item’s priority ............................................................... 51 Viewing details of a queue item................................................................. 51 Deleting a pending queue item.................................................................. 52 Confguring additional queue management felds....................................... 53 Confguring the queue pre-processor mechanism ........................................... 53 Controlling how quickly programs time out ................................................... 54 Caching Content Transformation Services capabilities on startup..................... 54 Setting logging appenders............................................................................. 55 Enabling performance and throughput logging .............................................. 56 Processing requests for local content .............................................................. 56 Confguring Content Transformation Services for BOCS or ACS ...................... 56 Confguring queue management for BOCS installations .................................. 58 Load balancing servers ................................................................................. 58 Confguring Content Transformation Services Load Balancer ...................... 59 Confguring the Server for SSL Mode............................................................. 60 Automating thumbnail or proxy creation for custom formats .......................... 61 Performing bulk transformation requests for documents ................................. 61 Improving the performance of Content Transformation Services...................... 62 Content Transformation Services clean up job................................................. 63 Job confguration options .......................................................................... 64 Content Transformation Services job Log4j confguration ............................ 64 Changing the hostname of the Content Transformation Services server machine ............................................................................................. 65 Resolving issues with email content containing double byte characters ............ 65 PDF compliance not working ........................................................................ 66 Confguring WebServices in a single sign-on environment .............................. 66 Confguration tasks specifc to CTS Documents .................................................. 66 Creating thumbnails and storyboards for MSG assets ..................................... 66 Confguring the Doc10 plug-in ...................................................................... 67 Confguring Doc4 Plug-in for Dynamic XFA PDF Forms ................................. 70 4 EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Administration Guide Table of Contents Controlling the size of PDF renditions............................................................ 70 PDF customization ....................................................................................... 71 TRANSFORMATION ............................................................................... 71 SETTINGS ........................................................................................... 71 MSWORDSETTINGS........................................................................ 72 TOC ................................................................................................ 72 HEADER ......................................................................................... 74 FOOTER .......................................................................................... 75 MARKUP......................................................................................... 76 HYPERLINKS .................................................................................. 78 NOTES ............................................................................................ 79 PDFSETTINGS ................................................................................. 80 PAGE............................................................................................... 81 BOOKMARKS.................................................................................. 82 FONTEMBEDDING ......................................................................... 83 OPENSETTINGS .............................................................................. 84 PAGECONTENTSCALING............................................................... 85 OPTIMIZE ....................................................................................... 87 PDFVERSION .................................................................................. 87 JPEGIMAGECOMPRESS .................................................................. 87 SECURITY ....................................................................................... 88 MSEXCELSETTINGS........................................................................ 90 EXCELPDFSETTINGS ...................................................................... 90 EXCELBOOKMARKS....................................................................... 90 MSPPTSETTINGS ............................................................................ 91 PPTPDFSETTINGS........................................................................... 91 METADATAELEMENTS................................................................... 91 METADATAELEMENT .................................................................... 91 Generating a specifc number of storyboard renditions.................................... 92 Adding a signature page ............................................................................... 93 Creating PDF renditions and enabling thumbnail and storyboard renditions on import .................................................................................... 93 Rich media enabling formats ..................................................................... 93 Creating a PDF rendition on import........................................................... 94 Registering formats to enable thumbnails and storyboards.......................... 96 Customizing printing and rendition output.................................................... 97 Saving PDF Text fles ................................................................................ 97 Storing PDF metadata ............................................................................... 98 Confguring for rendition replacement....................................................... 99 Confguring change tracking ......................................................................... 99 Transferring document attributes................................................................. 100 Transferring document attributes to PDF and embedding metadata................................................................................................ 100 Viewing the attributes in the PDF rendition.............................................. 102 Confguring HTML renditions in fuid layout............................................... 102 Confguration tasks specifc to CTS Media........................................................ 102 Confguring the PowerPoint2 plug-in........................................................... 102 Managing PowerPoint registration............................................................... 104 Confguring a primary CTS Media instance.............................................. 105 Confguring a secondary CTS Media instance........................................... 106 Selecting a colorspace ................................................................................. 106 Generating the background color for thumbnails from transparent PDF fles .................................................................................................... 107 Improving the quality of JPEG image fles converted from SVG format........................................................................................................ 108 Confguring the Image3 plug-in................................................................... 108 ICC profles............................................................................................ 108 COM Server parameters.......................................................................... 109 EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Administration Guide 5 Table of Contents Pixel cache parameters............................................................................ 109 Timeout confguration ............................................................................ 109 Confguration tasks specifc to CTS Audio-Video.............................................. 110 Confguring Content Server required for large video fles.............................. 110 Creating different default preview formats on import of video fles ............... 111 Confguration tasks specifc to XML Transformation Services ............................ 111 Confguring flters ...................................................................................... 111 Adding product names to the product flter ............................................. 112 Confguring other DITA flters................................................................. 113 Using inclusion mode for DITA flters ..................................................... 116 Confguring other DocBook flters ........................................................... 116 Confguring XTS with custom style sheets.................................................... 118 Confguring XTS to transform XML content ................................................. 120 Confguring a custom XSLT processor.......................................................... 121 Chapter 4 Profles and Profle Modifcation ............................................................... 125 Understanding Profles ................................................................................... 125 What are profles ........................................................................................ 125 System profles ....................................................................................... 125 Register Profle................................................................................... 126 Register profle for xCP clients (register_xcp.xml) ............................. 127 Register profle for D2 (register_d2.xml)........................................... 127 Register profle for Legacy clients (register_legacy.xml) .................... 127 Register profle for specifc clients.................................................... 127 Enabling and disabling clients on a per-repository basis.................... 127 User profles........................................................................................... 128 Enabling a user profle in a rich media enabled client ............................ 129 Chaining and sequencing profles ........................................................ 129 Command-line fles .................................................................................... 130 Content Transformation Services DTD ......................................................... 130 Modifying Transformation Profles .................................................................. 133 Getting started ........................................................................................... 133 Locating the profles ............................................................................... 133 Understanding the modifcation procedure .............................................. 134 Disabling processing on import ................................................................... 134 Disabling a process for all imported fles .................................................. 135 Disabling all processing for specifc fle formats........................................ 136 Disabling a process for a specifc fle format ............................................. 137 Changing dimensions of image renditions.................................................... 137 Chaining and sequencing profles ................................................................ 138 Chaining................................................................................................ 139 Understanding the structure of a chained transformation...................... 139 Creating a chained transformation....................................................... 141 Sequencing ............................................................................................ 143 Understanding the structure of a sequenced transformation .................. 143 Creating a sequenced transformation................................................... 145 Adding a rendition description to imported fles .......................................... 148 Changing the order that plug-ins are invoked............................................... 149 Modifying profles for different object types ................................................. 150 Using custom object types ....................................................................... 150 Confguring the PowerPoint slide object on import ................................... 151 Confguring formats in PowerPoint assembler .............................................. 152 Modifying the XMP plug-in ........................................................................ 154 Extracting XMP metadata to custom attributes ........................................ 154 Embedding XMP metadata from custom attributes to the content ............. 154 Modifying audio and video renditions ......................................................... 155 Creating a PDF rendition with Bates stamping on import .............................. 155 6 EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Administration Guide Table of Contents Testing a modifed profle............................................................................ 157 Using DQL in Profles ..................................................................................... 158 The dql attribute value syntax ..................................................................... 158 DQL guidelines .......................................................................................... 158 DQL query examples .................................................................................. 158 Querying the r_object_id attribute ............................................................... 159 Troubleshooting ............................................................................................. 160 Why are there no XML profles appearing in my profle folders? ................... 160 Why is my modifed user profle not appearing in the interface?.................... 160 How do I "uncomment” text in XML fles? ................................................... 160 Modifed profles did not load successfully .................................................. 162 Using a profle description bigger than 192 bytes .......................................... 162 Restart the Content Transformation Services product if profles are modifed .................................................................................................... 163 Profles Installed with Content Transformation Services products ...................... 163 CTS Documents profles.............................................................................. 163 CTS Media profles ..................................................................................... 169 CTS Audio-Video profles ........................................................................... 173 XML Transformation Services transformation profles................................... 174 Plug-ins Installed with Content Transformation Services................................... 175 Chapter 5 Creating a Content Transformation Services WebServices Activity ...................................................................................................... 177 Chapter 6 Troubleshooting ........................................................................................ 181 Troubleshooting tips for Content Transformation Services products................... 181 Storing the intermediate output of chain profle to docbase ........................... 181 Preserving temporary or intermediate fles to debug a problem ..................... 182 Error events and log fles............................................................................. 182 A transformation request fails ..................................................................... 183 A profle error occurs.................................................................................. 183 Cannot add a rendition to a particular format............................................... 184 If Content Transformation Services server cannot communicate to the repository............................................................................................. 184 Content Transformation Services fails to function ......................................... 185 Content Transformation Services Administration Agent gives AGENT_INACCESSIBLE message............................................................... 185 Content Transformation Services fails to transform any document to PDF (using Tools->Transform) that is imported to a web cabinet as WebPublisher admin user ....................................................................... 186 Content Transformation Services is not responsive after a set of transformations .......................................................................................... 186 Manual re-confguration of Content Transformation Services instance if the repository is deleted .............................................................. 187 Profle modifcations................................................................................... 188 Rendition failures due to expired login tickets .............................................. 189 Content Transformation Services Queue Item Cleanup — Pre-Processing delay................................................................................... 189 After restarting Content Server, Content Transformation Services throws a "server communication failure” exception ...................................... 189 Users with version permission get Inbox notifcation on legacy transformations .......................................................................................... 190 Transparency in PNG renditions lost for Illustrator fles ................................ 190 Preserving ICC profles during transformations............................................ 190 Text wrapping problems with large double byte characters ........................... 191 Embedding metadata for date datatype other than default ............................ 191 EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Administration Guide 7 Table of Contents Troubleshooting storyboard issues generated by the PDFStoryboard plug-in............................................................................... 191 Resolving issues with email content containing double byte characters................................................................................................... 191 Performance degradation due to add_rendition_properties settings............... 191 Appendix A Formats supported by CTS Documents .................................................... 193 Appendix B Formats supported by CTS Media ............................................................. 197 Appendix C Formats supported by CTS Audio-Video ................................................... 201 Appendix D Formats supported by XTS ........................................................................ 205 Appendix E Audio and Video Codecs ........................................................................... 207 8 EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Administration Guide Table of Contents List of Figures Figure 1. Processing a request for a PDF rendition in CTS Documents.................................... 15 Figure 2. Processing a request for an HTML rendition in CTS Documents Server .................... 16 Figure 3. Typical CTS Documents installation....................................................................... 16 Figure 4. Typical CTS Media installation .............................................................................. 18 Figure 5. Typical CTS Audio-Video installation .................................................................... 19 Figure 6. XML Transformation Services processing a request for a PDF rendition ................... 21 Figure 7. XML Transformation Services processing a request for an HTML rendition.............. 22 Figure 8. XML Transformation Services processing a request for a CHM rendition.................. 23 Figure 9. Typical XML Transformation Services installation................................................... 24 Figure 10. The registration process ........................................................................................ 25 Figure 11. The transformation process ................................................................................... 28 Figure 12. Throughput ......................................................................................................... 62 Figure 13. Content Transformation Services resource usage .................................................... 63 EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Administration Guide 9 Table of Contents List of Tables Table 1. Sample extracted media properties for Content Transformation Services .................. 27 Table 2. Documentum format mapping .............................................................................. 44 Table 3. Inbox notifcation behavior for admin and regular users ......................................... 45 Table 4. Formats Supported by the Doc10 Plug-in ............................................................... 70 Table 5. Documentum format mappings for Content Transformation Services ...................... 94 Table 6. Attribute mapping arguments ............................................................................. 101 Table 7. Pixel cache parameters for Image3 plug-in ........................................................... 109 Table 8. CTS Documents profles...................................................................................... 163 Table 9. CTS Media profles ............................................................................................. 170 Table 10. CTS Audio-Video profles ................................................................................... 173 Table 11. XML Transformation Services user profles .......................................................... 175 Table 12. Plug-ins installed with Content Transformation Services products ......................... 175 Table 13. Process Variables ................................................................................................ 178 Table 14. Process Data Parameters ..................................................................................... 179 Table 15. Document Transformations Supported for Source and Target Formats ................... 193 Table 16. Capabilities Supported for Document Formats ..................................................... 194 Table 17. Media Transformations Supported for Source and Target Formats ......................... 197 Table 18. Capabilities for Supported Media Image Formats ................................................. 198 Table 19. Audio and Video Transformations Supported for Source and Target Formats ......................................................................................................... 201 Table 20. Capabilities Supported for Audio and Video Formats ........................................... 203 Table 21. XTS Transformations Supported for Source and Target Formats............................. 205 Table 22. Audio and Video Codecs Supported for Input Formats ......................................... 207 Table 23. Audio and Video Codecs Supported for Output Formats ...................................... 209 10 EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Administration Guide