COREMEDIA CONTENT CLOUD Studio Developer Manual Studio Developer Manual Studio Developer Manual | Copyright CoreMedia GmbH © 2021 CoreMedia GmbH Ludwig-Erhard-Straße 18 20459 Hamburg International All rights reserved. No part of this manual or the corresponding program may be reproduced or copied in any form (print, photocopy or other process) without the written permission of CoreMedia GmbH. Germany Alle Rechte vorbehalten. CoreMedia und weitere im Text erwähnte CoreMedia Produkte sowie die entsprechenden Logos sind Marken oder eingetragene Marken der CoreMedia GmbH in Deutschland. Alle anderen Namen von Produkten sind Marken der jeweiligen Firmen. Das Handbuch bzw. Teile hiervon sowie die dazugehörigen Programme dürfen in keiner Weise (Druck, Fotokopie oder sonstige Verfahren) ohne schriftliche Genehmigung der CoreMedia GmbH reproduziert oder vervielfältigt werden. Unberührt hiervon bleiben die gesetzlich erlaubten Nutzungsarten nach dem UrhG. Licenses and Trademarks All trademarks acknowledged. September 19, 2021 (Release 2104) COREMEDIA CONTENT CLOUD ii Studio Developer Manual | 1. Introduction ........................................................................... 1 1.1. Audience .................................................................... 2 1.2. Typographic Conventions ................................................. 3 1.3. CoreMedia Services ........................................................ 5 1.3.1. Registration ...................................................... 5 1.3.2. CoreMedia Releases ............................................. 6 1.3.3. Documentation .................................................. 6 1.3.4. CoreMedia Training ............................................. 10 1.3.5. CoreMedia Support ............................................. 10 1.4. Changelog ................................................................. 12 2. Overview ............................................................................. 13 2.1. Architecture ............................................................... 14 2.2. Technologies ............................................................. 16 3. Deployment ......................................................................... 18 3.1. Connecting to the Repository ............................................ 19 3.2. Control Room Configuration ............................................. 20 3.3. Remote Dynamic Packages Configuration .............................. 21 3.4. Basic Preview Configuration ............................................. 23 3.5. Editorial Comments Database Configuration .......................... 24 3.6. Development Setup ...................................................... 29 4. Quick Start .......................................................................... 30 4.1. Setting Up the Workspace and IDE ....................................... 31 4.2. Building Studio ........................................................... 32 4.3. Creating a Simple Studio Client Extension .............................. 33 5. Concepts and Technology ......................................................... 38 5.1. Ext JS Primer .............................................................. 39 5.1.1. Components ..................................................... 41 5.1.2. Component Plugins ............................................. 41 5.1.3. Actions .......................................................... 42 5.2. Ext JS with ActionScript and MXML ..................................... 43 5.3. Client-side Model ........................................................ 48 5.3.1. Beans ........................................................... 49 5.3.2. Remote Beans .................................................. 51 5.3.3. Issues ........................................................... 52 5.3.4. Operation Results .............................................. 53 5.3.5. Model Beans for Custom Components ....................... 54 5.3.6. Value Expressions ............................................. 55 5.4. Remote CoreMedia Objects ............................................. 64 5.4.1. Connection and Services ...................................... 64 5.4.2. Content ......................................................... 65 5.4.3. Workflow ........................................................ 67 5.4.4. Structs .......................................................... 67 5.4.5. Types and Property Descriptors ............................... 69 5.4.6. Concurrency .................................................... 70 5.5. Web Application Structure ............................................... 71 5.6. Localization .............................................................. 72 5.7. Multi-Site and Localization Management ............................... 75 5.8. Jobs Framework ......................................................... 76 5.8.1. Defining Local Jobs ............................................ 76 COREMEDIA CONTENT CLOUD iii Studio Developer Manual | 5.8.2. Defining Remote Jobs ......................................... 76 5.8.3. Executing Jobs ................................................. 78 5.8.4. Visualizing Jobs ................................................ 78 5.9. Further Reading .......................................................... 80 6. Using the Development Environment ............................................. 81 6.1. Configuring Connections ................................................. 82 6.2. Build Process ............................................................. 84 6.3. IDE Support ............................................................... 88 6.4. Debugging ................................................................ 89 6.4.1. Browser Developer Tools ....................................... 89 6.4.2. Debugging Tips and Tricks .................................... 92 6.4.3. Tracing Memory Leaks ......................................... 97 7. Customizing CoreMedia Studio ................................................... 105 7.1. Studio Plugins ............................................................ 107 7.2. Localizing Labels ........................................................ 117 7.3. Document Type Model .................................................. 120 7.3.1. Localizing Types and Fields ................................... 120 7.3.2. Customizing Document Forms ............................... 121 7.3.3. Image Cropping and Image Transformation ................. 127 7.3.4. Enabling Image Map Editing .................................. 130 7.3.5. Disabling Preview for Specific Document Types ............. 131 7.3.6. Excluding Document Types from the Library ................ 131 7.3.7. Client-side initialization of new Documents ................. 132 7.4. Customizing Property Fields ............................................ 134 7.4.1. Conventions for Property Fields .............................. 134 7.4.2. Standard Component StringPropertyField ................... 135 7.4.3. Compound Field ............................................... 139 7.4.4. Complex Setups ............................................... 141 7.4.5. Customizing RichText Property Fields ....................... 142 7.5. Hiding Components on Content Forms ................................ 156 7.5.1. Code Customization for the HideService ..................... 156 7.5.2. Studio Logging ................................................ 160 7.5.3. Configuration Options ......................................... 160 7.6. Coupling Studio and Embedded Preview .............................. 162 7.6.1. Built-in Processing of Content and Property Metadata ............................................................. 162 7.6.2. Using the Preview Metadata Service ......................... 162 7.7. Storing Preferences ..................................................... 166 7.8. Customizing Central Toolbars .......................................... 167 7.8.1. Adding buttons to the Favorites Toolbar ..................... 167 7.8.2. Providing default Search Folders ............................ 168 7.8.3. Adding a Button with a Custom Action ....................... 170 7.8.4. Adding a Button to the Apps Menu ........................... 171 7.8.5. Adding Disapprove Buttons ................................... 172 7.9. Managed Actions ........................................................ 173 7.10. Adding Shortcuts ....................................................... 175 7.11. Inheritance of Property Values ......................................... 176 7.12. Customizing the Library Window ....................................... 177 7.12.1. Defining List View Columns in Repository Mode ............. 177 COREMEDIA CONTENT CLOUD iv Studio Developer Manual | 7.12.2. Defining Additional Data Fields for List Views .............. 178 7.12.3. Defining List View Columns in Search Mode ................ 178 7.12.4. Configuring the Thumbnail View ............................. 179 7.12.5. Adding Search Filters ........................................ 180 7.12.6. Make Columns Sortable in Search and Repository View .................................................................. 182 7.13. Studio Frontend Development ......................................... 184 7.13.1. Blueprint Studio Theme ...................................... 184 7.13.2. Studio Styling with Skins ..................................... 187 7.13.3. Styling of Custom Studio Components ..................... 190 7.13.4. Icons / CoreMedia IconFont