close

Filter

loading table of contents...

Blueprint Developer Manual / Version 2107

Table Of Contents

Blueprint Developer Manual

Copyright CoreMedia GmbH © 2022

CoreMedia GmbH

Altes Klöpperhaus, 5. OG

Rödingsmarkt 9

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.

December 20, 2022

1. Preface
1.1. Audience
1.2. Typographic Conventions
1.3. CoreMedia Services
1.3.1. Registration
1.3.2. CoreMedia Releases
1.3.3. Documentation
1.3.4. CoreMedia Training
1.3.5. CoreMedia Support
1.4. Working with CoreMedia Content Cloud
1.4.1. Getting an Overview
1.4.2. Learning about Components
1.4.3. Working with the GUI
1.4.4. Operating the System
1.4.5. Extending the System
1.5. Change Chapter
2. Overview of CoreMedia Content Cloud
2.1. Components and Architecture
2.1.1. Content Management Environment
2.1.2. Content Delivery Environment
2.1.3. Shared Components
2.1.4. User Management
2.1.5. Communication Between the Components
2.2. CoreMedia Blueprint Sites
3. Getting Started
3.1. Prerequisites
3.1.1. Developer Setup
3.1.2. Test System Setup
3.1.3. Additional Software for eCommerce Blueprint only
3.2. Quick Start
3.2.1. Building the Workspace
3.2.2. Docker Compose Setup
4. Blueprint Workspace for Developers
4.1. Concepts and Architecture
4.1.1. Maven Concepts
4.1.2. Blueprint Base Modules
4.1.3. Application Architecture
4.1.4. Structure of the Workspace
4.1.5. Project Extensions
4.1.6. Application Plugins
4.2. Configuring the Workspace
4.2.1. Removing Optional Components
4.2.2. Configuring the Workspace
4.2.3. Configuring Local Setup
4.2.4. In-Memory Replacement for MongoDB-Based Services
4.3. Build and Run the Applications
4.3.1. Starting Applications using IntelliJ IDEA
4.3.2. Starting Applications using Maven
4.3.3. Local Docker Test System
4.4. Development
4.4.1. Using Blueprint Base Modules
4.4.2. Extending Content Types
4.4.3. Developing with Studio
4.4.4. Developing with the CAE
4.4.5. Customizing the CAE Feeder
4.4.6. Adding Common Infrastructure Components
4.4.7. Handling Personal Data
5. CoreMedia Blueprint - Functionality for Websites
5.1. Overview of eCommerce Blueprint
5.2. Overview of Brand Blueprint
5.3. Basic Content Management
5.3.1. Common Content Types
5.3.2. Adaptive Personalization Content Types
5.3.3. Tagging and Taxonomies
5.4. Website Management
5.4.1. Folder and User Rights Concept
5.4.2. Navigation and Contexts
5.4.3. Settings
5.4.4. Page Assembly
5.4.5. Overwriting Product Teaser Images
5.4.6. Content Lists
5.4.7. View Types
5.4.8. CMS Catalog
5.4.9. Teaser Management
5.4.10. Dynamic Templating
5.4.11. View Repositories
5.4.12. Client Code Delivery
5.4.13. Managing End User Interactions
5.4.14. Images
5.4.15. URLs
5.4.16. Vanity URLs
5.4.17. Content Visibility
5.4.18. Content Type Sitemap
5.4.19. Robots File
5.4.20. Sitemap
5.4.21. Website Search
5.4.22. Topic Pages
5.4.23. Search Landing Pages
5.4.24. Theme Importer
5.4.25. Tag Management
5.5. Localized Content Management
5.5.1. Concept
5.5.2. Administration
5.5.3. Development
5.6. Workflow Management
5.6.1. Publication
5.6.2. Translation Workflow
5.6.3. Deriving Sites
5.6.4. Synchronization Workflow
6. Editorial and Backend Functionality
6.1. Studio Enhancements
6.1.1. Content Query Form
6.1.2. Call-to-Action Button
6.1.3. Media Player Configuration
6.1.4. Displayed Date
6.1.5. Library
6.1.6. Bookmarks
6.1.7. External Preview
6.1.8. Settings for Studio
6.1.9. Content Creation
6.1.10. Create from Template
6.1.11. Site-specific configuration of Document Forms
6.1.12. Open Street Map
6.1.13. Site Selection
6.1.14. Upload Files
6.1.15. Studio Preview Slider
6.1.16. Uploading Content to Salesforce Marketing Cloud
6.2. CAE Enhancements
6.2.1. Using Dynamic Fragments in HTML Responses
6.2.2. Image Cropping in CAE
6.2.3. RSS Feeds
6.3. Elastic Social
6.3.1. Configuring Elastic Social
6.3.2. Displaying Custom Information in Studio
6.3.3. Adding Custom Filters for Moderation View
6.3.4. Emails
6.3.5. Resend Registration Confirmation Mail from Studio
6.3.6. Curated transfer
6.3.7. reCAPTCHA
6.3.8. Sign Cookie
6.4. Adaptive Personalization
6.4.1. Key Integration Points
6.4.2. Adaptive Personalization Extension Modules
6.4.3. CAE Integration
6.4.4. Studio Integration
6.5. Third-Party Integration
6.5.1. Optimizely
6.5.2. Open Street Map Integration
6.5.3. Google Analytics Integration
6.5.4. Salesforce Marketing Cloud Integration
6.6. Advanced Asset Management
6.6.1. Product Asset Widget
6.6.2. Replaced Product and Category Images
6.6.3. Extract Image Data During Upload
6.6.4. Configuring Asset Management
7. Reference
7.1. Content Type Model
7.2. Link Format
7.3. Predefined Users
7.4. Database Users
7.5. Cookies
Glossary
Index

List of Figures

2.1. System Overview
4.1. CoreMedia CMS's Four-Tier Architecture
4.2. CoreMedia CMS's Shared, Application-Specific, and Global Workspaces
4.3. Backend Tier Workspace Dependencies
4.4. Middle Tier Workspace Dependencies
4.5. CoreMedia Extensions Overview
4.6. The new sample studio plugin
4.7. The sample studio plugin with plugin class and descriptor
5.1. Calista (Experience-led) start page for different devices: desktop, tablet, mobile
5.2. Hybris (commerce-led) start page for different devices: desktop, tablet, mobile
5.3. Chef Corp. start page for different devices: desktop, tablet, mobile
5.4. Dynamic list of articles tagged with "Vegetables"
5.5. Taxonomy Administration Editor
5.6. Taxonomy Property Editor
5.7. Taxonomy Studio Settings
5.8. Navigation in the Corporate Site
5.9. The page grid editor and the Hero placement
5.10. An inheriting placement
5.11. A locked placement
5.12. The layout chooser combo box
5.13. Layout Variant selector
5.14. CMS Catalog Settings
5.15. Default view and teaser view of an Article
5.16. Content Type Sitemap
5.17. Robots.txt settings
5.18. Channel settings with configuration for Robots.txt as a linked setting on a root page
5.19. Selection of a sitemap setup
5.20. Search Configuration Settings document
5.21. Generated topic page for topic "Professionals"
5.22. The topic pages administration in Studio
5.23. Settings document for topic pages
5.24. A Search Result for a Topic Page
5.25. Tag Management Configuration
5.26. Multi-Site Interdependence
5.27. Locales Administration in CoreMedia Studio
5.28. Derive Site: Setting site manager group
5.29. Site Indicator: Setting site manager group
6.1. Content Query Form
6.2. Call-to-Action-Button editor
6.3. Call-to-Action button in teaser view
6.4. Video Options panel in the DocumentForm of a Video content
6.5. Displayed Date editor
6.6. Setting a Custom Date
6.7. Image Gallery Creation Button
6.8. Image Gallery Creation Dialog
6.9. Library List View
6.10. Bookmarks
6.11. External Preview
6.12. New content menu on the favorites toolbar
6.13. New content dialog
6.14. New content dialog for pages
6.15. New content dialog as button on a link list toolbar
6.16. New content dialog menu on a link list toolbar
6.17. Create from template dialog
6.18. OpenStreetMap Property Editor
6.19. The site selector on the preference tab
6.20. The upload files dialog
6.21. The slider of the Studio Preview
6.22. SFMC Uploadable Properties Setting
6.23. Conditions in Personalized Content and Customer Segment documents
6.24. Defining artificial context properties using Customer Personas
6.25. Selecting Customer Personas to test Personalized Content and User Segment documents
6.26. Example for an Open Street Map integration in a website
6.27. Product image gallery in HCL Commerce delivered by the CMS
6.28. Assign a product to a picture
6.29. Define Product Image URLs in Management Center
6.30. Screenshot from Adobe Photoshop for a Picture containing XMP Data
6.31. Picture linked to XMP Product Reference
6.32. Configuration of the download portal
6.33. Taxonomy for assets
7.1. CoreMedia Blueprint Content Type Model - CMLocalized
7.2. CoreMedia Blueprint Content Type Model - CMNavigation
7.3. CoreMedia Blueprint Content Type Model - CMHasContexts
7.4. CoreMedia Blueprint Content Type Model - CMMedia
7.5. CoreMedia Blueprint Content Type Model - CMCollection
7.6. A basic absoluteUrlPrefixes Struct
7.7. A complete absoluteUrlPrefixes Struct
7.8. An initial absoluteUrlPrefixes Struct

List of Tables

1.1. Typographic conventions
1.2. Pictographs
1.3. CoreMedia manuals
1.4. Changes
3.1. Overview of minimum / recommended Hardware requirements
4.1. Packages request mapping
4.2. Optional modules and blueprints
4.3. Blueprint Extensions and Dependencies
4.4. Add-ons and the dependent extensions
4.5. Database Settings
4.6. Studio Configuration Properties for In-Memory Store
4.7. Content type model dependencies
4.8. Parameters of the settings* methods
5.1. Overview of Content Types for common content
5.2. Commerce Content Types
5.3. Overview Commerce Content Properties
5.4. Overview Common Content Properties
5.5. CMMedia Properties
5.6. CMTaxonomy Properties
5.7. Additional CMLocTaxonomy Properties
5.8. CMLinkable Properties for Tagging
5.9. Properties of CMLinkable for Settings Management
5.10. Collection Types in CoreMedia Blueprint
5.11. CMS Catalog: Maven parent modules
5.12. Properties of CMTeasable
5.13. Properties of CMTemplateSet
5.14. Client Code - Properties of CMAbstractCode
5.15. Properties for Visibility Restriction
5.16. Brand website search settings
5.17. Page Grid Indexing Spring Properties
5.18. Options of the import-themes tool
5.19. Suggested Users and Groups for multi-site
5.20. Properties of the Site Model
5.21. Placeholders for Site Model Configuration
5.22. Example for server export and import for multi-site
5.23. Translation Workflow Properties
5.24. XLIFF Properties
5.25. Publishing documents: actions and effects
5.26. Publishing folders: actions and effects
5.27. Predefined publication workflow definitions
5.28. Predefined publication workflow steps
5.29. User options.
5.30. Attributes of GetDerivedContentsAction
5.31. Attributes of CreateTranslationTreeData
5.32. Attributes of FilterDerivedContentsAction
5.33. Attributes of GetSiteManagerGroupAction
5.34. Attributes of ExtractPerformerAction
5.35. Attributes of AutoMergeTranslationAction
5.36. Attributes of AutoMergeSyncAction
5.37. Attributes of CompleteTranslationAction
5.38. Attributes of RollbackTranslationAction
6.1. Upload Settings
6.2. Root Channel Context Settings
6.3. Context Settings for Every Channel
6.4. Mail Templates
6.5. Adaptive Personalization's main Maven module in detail
6.6. Adaptive Personalization contexts configured for CoreMedia Blueprint
6.7. Predefined SearchFunctions in CoreMedia Blueprint
6.8. Settings for Open Street Map Integration
6.9. Path segments in the image URL
7.1. CapBlobHandler
7.2. CodeHandler
7.3. ExternalLinkHandler
7.4. PageActionHandler
7.5. PageHandler
7.6. PageRssHandler
7.7. PreviewHandler
7.8. StaticUrlHandler
7.9. TransformedBlobHandler
7.10. Global groups
7.11. Global users
7.12. Site specific groups for Salesforce Commerce
7.13. Site specific users for Salesforce Commerce
7.14. Site specific groups for SAP Commerce
7.15. Site specific users for SAP Commerce
7.16. Site specific groups for HCL Commerce
7.17. Site specific users for HCL Commerce
7.18. Site specific groups Brand web presence
7.19. Site specific users Brand web presence
7.20. Database Users

List of Examples

4.1. Dependencies for a CoreMedia application
4.2. Setting an environment property in web.xml
4.3. Setting an environment property in the context configuration
4.4. Specify the extension point
4.5. plugin.properties
4.6. com.acme.myplugin.MyPluginConfiguration
4.7. com.acme.myplugin.MyExtension
4.8. PluginA plugin.properties
4.9. PluginABeansForPluginsContainer
4.10. PluginABeansForPlugins
4.11. PluginAConfiguration
4.12. PluginB plugin.properties
4.13. PluginBConfiguration
4.14. PluginA plugin.properties
4.15. SomeExtensionPointForA
4.16. PluginAConfiguration
4.17. PluginB plugin.properties
4.18. PluginBConfiguration
4.19. SomeExtensionPointForAImpl
4.20. my-plugin-7.8.9.json
4.21. Remove CoreMedia Elastic Social Extension
4.22. Remove CoreMedia Adaptive Personalization Extension
4.23. Example for Adaptive Personalization Content in Blueprint
4.24. Remove CoreMedia eCommerce Extension
4.25. Remove CoreMedia Corporate Extension
4.26. Remove CoreMedia Product Asset Management Extension
4.27. The Spring Bean Definition for the Map of Settings Finder
4.28. Adding Custom Settings Finder
4.29. Business Logic API
4.30. Settings Address Adapter
4.31. Address Proxy
4.32. POM file of a new Studio module
4.33. Dependency for JMX
4.34. Register the MBeans
4.35. Use Tomcat remote connector server
4.36. Use Tomcat remote connector server with authentication
4.37. Adding the Base Component
4.38. Adding custom stub classes
5.1. Pagegrid example definition
5.2. A robots.txt file
5.3. robots.txt file generated by the example settings
5.4. A sitemap file
5.5. A sitemap index file
5.6. Usage of import-themes
5.7. Multi-Site Folder Structure Example
5.8. Site Folder Structure Example
5.9. XML of locale Struct
5.10. SiteModel in editor.xml
5.11. Versioned Master Link in editor.xml
5.12. CMLocalized
5.13. CMTeasable
5.14. XLIFF fragment
5.15. Transforming to Translation Items
5.16. Function to Determine Locales
5.17. Exporting XLIFF
5.18. Importing XLIFF
5.19. Importing XLIFF
5.20. Example for CapTranslateItemException
5.21. TranslatePropertyTransformer for XHTML
5.22. Example for CapXliffExportException
5.23. PropertyExportHandler for XHTML
5.24. XhtmlToXliffConverter
5.25. XHTML Example Input
5.26. XHTML as XLIFF Example Output
5.27. XliffXhtmlPropertyImportHandler
5.28. XliffToXhtmlConverter
5.29. Attribute Export
5.30. XHTML Example Input (Attributes)
5.31. XHTML as XLIFF Example Output (Attributes)
5.32. XLIFF Validation Error
5.33. Custom XLIFF XSD
5.34. Custom XLIFF XSD (Bean)
5.35. Importing Translatable Attributes
5.36. Importing Non-Translatable Attributes
5.37. Example for a customTranslationWorkflowDerivedContentsStrategy
5.38. translatableExpressions Configuration Example
5.39. Usage of GetDerivedContentsAction
5.40. Usage of CreateTranslationTreeDataAction
5.41. Usage of FilterDerivedContentsAction
5.42. Usage of GetSiteManagerGroupAction
5.43. Usage of ExtractPerformerAction
5.44. Usage of AutoMergeTranslationAction
5.45. Usage of AutoMergeSyncAction
5.46. Usage of CompleteTranslationAction
5.47. Usage of RollbackTranslationAction
6.1. Using the content query form
6.2. Add content creation dialog to link list with quickCreateLinkListMenu
6.3. Predicate Example
6.4. Predicate Customizer Example
6.5. Dynamic Include Link Scheme Example
6.6. Dynamic Include Handler Example
6.7. Root Channel Context Settings
6.8. Root Channel Context Settings
6.9. Context Settings for Every Channel
6.10. Rendition Publication Configuration
7.1. Configuration of URL prefix type

Search Results

Table Of Contents
warning

Your Internet Explorer is no longer supported.

Please use Mozilla Firefox, Google Chrome, or Microsoft Edge.