Documentation > Best Practices and Examples

Best Practices and Examples

CrownPeak provides Best Pratices and code examples in this documentation for information about implementing and using API calls in your CrownPeak instance. The best practices and examples provide useful guidelines for using the API libraries; the CMS Template API Library enables template developers to create custom content editing, the Service Template API Library enables developers to access advanced features of the CMS, and the CMS Access API enables developers manage CMS assets and configurations through a set API calls. The CrownPeak API libraries are built on .NET 4.0 for C# development. The best practices and examples provide use cases and user stories to help developers work with the CMS to create forms, render collected data, and publish Web pages.

You can leverage the CMS development environment, or you can use the recommended Microsoft Visual Studio 2013 with the CrownPeak Add-in for Visual Studio or the CrownPeak Desktop Connection (CDC). Click here to access the API libraries.



Project Merge

Section: Project Merge

Project Merge is a powerful tool which has been added to the CMS. This feature allows you to take two Project Branches and merge them into one. This allows you to work on new features an the other changes in isolation and them to combine them safely to be used in one environment.

See More

WCO Dynamic Content

Section: WCO

Dynamic Content allows you to create, edit and manipulate your Web Content Optimizer (WCO) Snippets. In addition to the Snippets, you can edit your Collections. The new user interfaces make working with Snippets much easier in the CMS.

See More

Frequently Asked Questions (FAQ)

Section: Version 3 Guide

Crownpeak is excited to launch the first phase of its new user interface, V3. This new User Interface (UI) marks a return to browser based technologies, and an alternative to the Silverlight used in the Vote UI. We are using all of the latest frameworks like HTML5, Angular and Bootstrap and have made some updates to the way the system works to help make managing your content easier than before. This section presents a list of frequently asked questions and answers.

See More

Help Topics

Section: Version 3 Guide

Crownpeak is excited to launch the first phase of its new user interface, V3. This new User Interface (UI) marks a return to browser based technologies, and an alternative to the Silverlight used in the Vote UI. We are using all of the latest frameworks like HTML5, Angular and Bootstrap and have made some updates to the way the system works to help make managing your content easier than before.

See More

Videos

Section: Version 3 Guide

Crownpeak is excited to launch the first phase of its new user interface, V3. This new User Interface (UI) marks a return to browser based technologies, and an alternative to the Silverlight used in the Vote UI. We are using all of the latest frameworks like HTML5, Angular and Bootstrap and have made some updates to the way the system works to help make managing your content easier than before.

See More

Version 3 Guide

Section: Version 3 Guide

Crownpeak is excited to launch the first phase of its new user interface, V3. This new User Interface (UI) marks a return to browser based technologies, and an alternative to the Silverlight used in the Volte UI. We are using all of the latest frameworks like HTML5, Angular and Bootstrap and have made some updates to the way the system works to help make managing your content easier than before.

See More

Feature List

Section: Version 3 Guide

Crownpeak is excited to launch the first phase of its new user interface, V3. This new User Interface (UI) marks a return to browser based technologies, and an alternative to the Silverlight used in the Vote UI. We are using all of the latest frameworks like HTML5, Angular and Bootstrap and have made some updates to the way the system works to help make managing your content easier than before.

See More

Digital Quality Management Tagging Recomendations

Section: Integrations

Here are some suggested HTML tags that can added to web sites published by the CrownPeak CMS (aka Digital Experience Management, or DXM) in order to make it easier to identify specific information in websites to the CrownPeak Digital Quality Management (DQM, formerly Active Standards) platform. Adding these tags will improve the DQM reporting on your web site, and are often added to web sites in any case to improve site accessibility. Most of these tags exist in either the official HTML or Aria specifications. Those that do not, are prepended with a "cpdqm" prefix to avoid any namespace collision issues, and can be renamed as necessary. These tags will go into the CMS output template files – mixed in with your sites HTML. Some of them will use the template API functions to get data from the CMS while publishing, and some of the tags are simply HTML markup for the DQM scanner to use to identify selected parts of the page.

See More

Render Once, Publish Many

Section: Render Once

Render Once, Publish many has been added as an option on the Publishing Package. Adding servers to a single pulbishing package allows for sychronization among those servers as soon as an asset is published. This use of this feature is only suggested for customers who have experienced issues with a delay in sychronization.

See More

Database as a Service

Section: Services

The updates to CrownPeak Database as a Service allows you to access your DaaS service and perform updates, such as reconfiguration of tables, columns or views, and/or data update on your own, without having to contact CrownPeak

See More

CrownPeak Package Deploy

Section: Services

CrownPeak Package Deploy allows in-house developed business logic to be deployed cleanly, seamlessly and safely alongside a CrownPeak-managed presentation layer for the ultimate in dynamic, multi-channel digital experience solutions.

See More

Projects & Sites

Section: Projects and Sites

The Project & Sites feature was added in November 2014 to improve the site creation and management process for instances with multiple sites and multiple teams of developers. This document provides the steps to setup a project folder and site root for implementation. It shows how you can configure a project to be shared by more than one site and a self-contained project to support a single site. Most importantly, this feature is required to take advantage of project branching. Additional information on branching is available here - http://developer.crownpeak.com/Documentation/BestPractices/Code-Branching/Project-Branching.html

See More

Search G2 Realtime Indexing

Section: Search G2

The CrownPeak Search G2 Realtime Indexing enhances the existing search platform by providing a direct connection between the CMS and the Search G2 platform. With this enhancement, assets can be built within the CMS for delivery directly to the Search G2 platform upon publication.

See More

Search G2 CMS Administration Interface

Section: Search G2

The CrownPeak Search G2 CMS Administration Interface enhances the existing search platform by providing a series of self-service, realtime configuration screens, which allow for management of CrownPeak Search G2 Collections.

See More

Search G2 Introduction

Section: Search G2

The CrownPeak Search G2 platform is a highly-scalable, high-performance, enterprise-grade indexing and query platform, based upon the Apache Lucene Software Library & Apache SolrCloud.

See More

HubSpot

Section: Integrations

HubSpot offers marketing automation software including inbound marketing, SEO blogging and social media tools. The CrownPeak integration provides you with direct access to lead data generated from CrownPeak hosted forms

See More

Project Branching

Section: Project Branching

Project Branching is a powerful tool which has been added to the CMS. This feature allows you to make a copy of your code by branching it. You can then manipulate the code making any desired changes or updates, then view these changes while not affecting the Live website.

See More

Debug Console

Section: Debug Console

The Debug Console is built into the CMS to allow users to analyze their code without needing any additional tools. This capability is very useful when trying to determine why assets are not working as expected. The Debug Console will return debugging statements, notifications and warnings, and error messages for an asset.

See More

Component Library Support in the CMS Platform

Section: Component Library

The CrownPeak Component Library is a Framework and a CrownPeak CMS Extension. As a framework, the Component Library defines a process and provides visual tools to define re-usable CMS components that can be used to define templates, models, and assets without writing any CrownPeak API code. As a CMS Extension, the Component Library introduces a zero-implementation experience (Figure 1), allowing users to create and setup complete sites, leveraging a complete library of front-end patterns, developed by Pattern Labs (http://patternlab.io) (Figure 2), as well as Bootstrap, one of the most popular CSS frameworks. All of the artifacts provided by the extension are fully editable allowing for complete customization and flexibility.

See More

WCO Targeting Groups

Section: WCO

Targeting Groups are used to help website visitors focus on items of interest, for example displaying an East Coast conference to a website visitor from Vermont. The WCO Targeting Groups has been redesigned within the CMS authoring experience. This updated feature enables editors to easily create targeting groups using drag and drop technology. The ability to use drag and drop has made using this feature more intuitive and allows much quicker building of Targeting Groups.

See More

Funnel Dashboard

Section: Funnel Dashboard

The Funnel Dashboard presents a set of widgets that enables you to track the progress of your Testing & Targeting efforts on each of your website properties. The Funnel Dashboard will graphically display the set of WCO snippets which are in a collection being used to focus a user to a final conversion. The funnel graph will visually display how many users start at the first page and how many reach the conversion. This is an easy way to see which of your webpages may need updating due to losing viewers and not clicking to the next webpage.

See More

Creating Custom Reports

Section: Creating Custom Reports

Custom Reports allow you to create useful datasets which you often need at a moments notice. In the CMS, you can save your Advanced Search criteria with a unique name and later reopen it as a report. This means if you regularly search on pages updated by a specific user, you can enter those conditions in Advanced Search and save as a report. Then anytime you need the information you can select Custom Reports and review the latest data.

See More

Tuning up you CMS Instance

Section: Tuning

Every CMS instance starts out as a fast environment that has been setup and configured to meet the needs of each customer. However, over time even the best CMS instance can become slow due to changes in the configuration and updates to the implementation. Here are some of the ways to diagnose and remediate these issues in your CMS.

See More

WCO Form Builder

Section: WCO

Forms are an integral part of any website usually to obtain information from the website visitor. To make using forms effortless, the WCO Form Builder has been redesigned within the CMS authoring experience. This updated feature enables editors to easily create, save, and reuse forms on landing pages and other parts of your website needing a call to action.

See More

Dynamic Content Support

Section: Dynamic Content

There are many benefits to implementing a CMS project using a decoupled architecture while still leveraging all of the rich content of a dynamic platform. CrownPeak uses just such a hybrid architecture that is both agile and secure at the same time.

See More

Implementing Database as a Service (DaaS)

Section: Database as a Service

CrownPeak offers a Database service for existing users of the Content Management System (CMS) and the Web Hosting environment. This database service will operate in the CrownPeak Hosting environment, which is based on Amazon Web Services (AWS). CrownPeak offers several deployment options.

See More

API Solutions

Section: API Solutions

The CrownPeak Application Program Interface (API) Solution lets you use your content dynamically in custom web or mobile applications. You can access the approved content directly through the CrownPeak APIs, or mix and match API access with published content

See More

Java Stack Support in the CMS Platform

Section: Java Stack Support

The CrownPeak Software as a Service (SaaS) Platform is a heterogeneous programming environment supporting the development of websites and web applications in a variety of general purpose programming languages (including Java and JavaScript) that are common to the Web Development community. These languages all work in concert with HTML, the standard markup language used to create websites, and web applications.

See More

Implementing Minifier in CrownPeak

Section: Services

You can use the minifier API call to reduce the size of your cascading style sheets (css) and javascript (js) files in your hosting environment. The Minifier is an executable file inside CrownPeak that enables you to reduce the size of of your css and javascript files. Reducing the size of these files limits rendering time and your pages publish faster.

See More

Implementing a Blog in CrownPeak

Section: CMS Template API

You can use a blog to drive traffic to the most current content on your Website. Blog pages can be updated quickly with product announcements and updates or you can start a dicussion based on a particular topic that you know your customers will benefit from.

See More

Implementing the AccessAPI in Crownpeak

Section: CMS Access API

You can use the AccessAPI to synchronize assets from a local folder structure to your instance. The AccessAPI uses C#, Javascript (js), and Powershell. Developers can now create, import, and manage CMS Assets, Configurations, and Workflows through a set of public API calls protect by access controls and rate limiting governors.

See More

Connect with CrownPeak