Developers
cancel
Showing results for 
Search instead for 
Did you mean: 

DXM Developer Knowledge Base

Crownpeak Digital Experience Management (DXM) Content Xcelerator℠

At Crownpeak, we have always needed to perform maintenance operations on a customers' content - this is all part of the service. Historically, this was manual talk - brittle and troublesome, but acceptable with caution.

Around a year ago, we re-constructed our demonstration experience, to give birth to Surety, a fictional Insurance Company. The Surety website allows us to showcase much of the Crownpeak capabilities, across all products, in a single location. However, what caused us a bit of a headache was how to deploy multiple versions of Surety across customer, prospect, Sandbox, Engineering, Support & Customer Success DXM Instances - and then do it all again when a new version of Surety was released (every one-to-two-months).

The answer - to build an export and import tool. Crownpeak already had all of the plumbing that we needed, with RESTful APIs to perform CRUD operations against content - we just needed to bring it all together.

Welcome, Crownpeak Digital Experience Management (DXM) Content Xcelerator℠ - a tool designed to export and re-import content out of and back into DXM CMS Instances.

Content Xcelerator℠ is built as a Microsoft Windows Forms Application, in a wizard-style, to guide a DXM Administrator through the process of exporting Assets, Templates, Library Files, Personalization, Publishing Packages & Properties and Workflows into an intermediary XML format (the "manifest"). Content Xcelerator℠ can then be used to re-deploy the same manifest into a different path within the same or separate DXM Instance - allowing the rapid-provisioning of cloned content within DXM.

content-xcelerator-import-assetsContent Xcelerator℠ has been built to operate across all content within DXM, thereby making it generic to all use-cases - not only the movement of Surety. We even provide manifests for other reference architectures - see our GitHub integration page for eCommerce provider, commercetools.

commercetools Integration Repo for Crownpeak DXM.pngcommercetools Integration Repo for Crownpeak DXM.

We want you to be able to take advantage of Content Xcelerator℠ within your business - whether using it to rapidly deploy content to kick-start a project, or to assist with content migration from another platform. Therefore, we have made the source code available to everyone under the MIT License. See the GitHub repository at https://github.com/Crownpeak/Content-Xcelerator and feel free to experiment.

Content Xcelerator Repo.pngContent Xcelerator℠ Repo

Of course, we welcome your feedback on how we can make this better to assist our customers and partners in decreasing time-to-value. Even better still, perhaps you could extend Content Xcelerator℠ yourself, for your own business needs - as the repository is public, fork and start extending!

Comments

Crownpeak Content Xcelerator℠ (“Content Xcelerator℠”) is made available under the MIT License (“License”) at https://github.com/Crownpeak/Content-Xcelerator, as optional tooling to assist developers working with content migration into Crownpeak Digital Experience Management (“DXM”).

Constructed as a set of Microsoft .NET Visual Studio Projects, producing a Microsoft Windows Forms Application and set of related Microsoft .NET Assemblies, Content Xcelerator℠ can be used “as is” to migrate content between DXM “Instances”, or forked and modified as required to provide further capabilities, within the terms of the License.

Content Xcelerator℠ is not actively maintained by Crownpeak. The underlying DXM Access API (“Access API”), invoked by Content Xcelerator℠, forms part of the DXM product itself, which is fully maintained by Crownpeak.

Executing Content Xcelerator℠

To run Content Xcelerator℠, execute the Microsoft Windows Executable from within a Microsoft Windows environment. Executing Content Xcelerator℠

Exporting Data from DXM

Upon first execution of Content Xcelerator℠, you are required to enter configuration information and your personal security credentials, as follows:

  • Sessions – Historically stored configurations – this will be blank upon first run;
  • Server – The URL to the DXM Server farm, typically “cms.crownpeak.net”;
  • Instance – The DXM Instance that you wish to target;
  • Username – Your DXM username, typically your email address;
  • Password – Your DXM password;
  • Developer Key – Your personal DXM Developer Key. You should contact Crownpeak Support (support@crownpeak.com) if you do not have this.

N.B. Content Xcelerator℠ does not support Federated Authentication. A forms-based user account, with sufficient permission, must be provided.

Content Xcelerator℠ Export Settings

Select the top-level Asset Folder that you wish to export content for. By default, all child Asset Folders and Assets will be selected.

Content Xcelerator℠ Select Assets

N.B. You will not be able to proceed to the next step, until the DXM content tree has completed loading.

Choose an appropriate location for your export XML file and start the export process.

Content Xcelerator℠ Export Process

N.B. You can persist the log content to disk, using the “Save Log”.

Once complete, an XML document will have been created at your chosen location. This XML document contains everything that you need in order to import this content into another DXM location.

Content Xcelerator℠ Export Result

Importing Data to DXM

Upon first execution of Content Xcelerator℠, you are required to enter configuration information and your personal security credentials, as follows:

  • Sessions – Historically stored configurations – this will be blank upon first run;
  • Server – The URL to the DXM Server farm, typically “cms.crownpeak.net”;
  • Instance – The DXM Instance that you wish to target;
  • Username – Your DXM username, typically your email address;
  • Password – Your DXM password;
  • Developer Key – Your personal DXM Developer Key. You should contact Crownpeak Support (support@crownpeak.com) if you do not have this.

N.B. Content Xcelerator℠ does not support Federated Authentication. A forms-based user account, with sufficient permission, must be provided.

Content Xcelerator℠ Import Settings

Select the XML file from your local machine that represents the content that you wish to import. Once selected, click “Refresh” to load the content of the file into the dialog. Choose which content you would like to import into DXM. By default, all child Asset Folders and Assets will be selected.

Content Xcelerator℠ Select Assets

Content Xcelerator℠ will parse the XML file contents and compare it against the target DXM configuration, to try to assess any potential import issues, prior to executing the import process. Any identified issues will be detailed within the dialog box.

Content Xcelerator℠ Review Problems

N.B. It is possible to skip items with issues, or to re-map problem items to other suitable Assets within DXM (e.g. a missing template could be re-mapped to another template. This is only possible to items within DXM already, not to items within the current import file).

Type the “Top” or “Parent” Asset Folder where you want to deploy the exported content.

Content Xcelerator℠ Import Process

Upon completion, navigate to the relevant DXM UI and review your imported content.

Content Xcelerator℠ Import Result

Version history
Revision #:
1 of 1
Last update:
2 weeks ago
Updated by:
 
Contributors
Looking for more?
Ask in Discussions
Developers

Peer-to-peer support  and answers on developing CMS templates, modifying privacy scripts or building integrations.

Digital Experience Management

Find answers and ask questions on content management, personalization and targeting.

Digital Quality Management

Find answers and ask questions on WCAG and SEO quality management.

Digital Governance

Find answers and ask questions on consent and monitoring solutions.