Skip to main content

Creating a DXA Java Module

In my previous blog post Troubleshoot a DXA Java Module, I presented a solution for a very specific issue with loading a DXA Java module. Then I had the idea for this blog post -- write a short tutorial on how to write a DXA module.

What follows are the steps to create a new DXA Java module (I am using DXA v1.5). In this post, I present the Content Manager items needed for the new module. In fact, these are the minimum items and properties needed for having a new working DXA module.

In next post Creating a DXA Java Module (part 2), I present the Java code and configuration needed to run the new DXA module in a web-application.

1. Create a New Module in Tridion Content Manager

I am using DXA reference implementation, and I created a new module called Emerald, next to the Core module of the reference implementation. Create the following Tridion folder structure starting from Folder Emerald:

2. Create Module Configuration Component

In Folder Admin, create new Component Emerald on Schema Module Configuration. For minimum configuration, it's enough to only fill in the the mandatory fields.

3. Publish Module Configuration

If using the DXA reference implementation, publish page Publish Settings from Structure Group _System. You don't need to do anything else.

Otherwise, create a Page on Page Template JSON, File Name settings.

Add one Component Presentation to this Page. The Module Configuration component Emerald. If you have more than one module, only place one module Component on this Page, otherwise you will get errors during publishing.

Publish the Publish Settings page.

4. Create Schemas

In Folder Editor, I'm only going to create a Main Navigation Schema that points to an embeddable Schema Navigation Links.

It is very important to give it a unique Root Element Name. I chose MainNavigation and NavigationLinks respectively.

In order to keep things simple, I chose the already predefined target namespace This name is used by the Semantic Mapper vocabularies and it coincides with the Core module vocabulary name. If not define, you must define it in a vocabulary Application Data -- not a nice thing to do. Luckily, we can re-use the existing predefined namespace for the Core module.

5. Create Content

In Folder Editor, create a simple Component Main Navigation on Schema Main Navigation.

6. Create a Component Template

Create a Component Template Main Navigation CT and link it to the Schema Main Navigation. Make it use Metadata Schema Component Template Metadata and fill in the view to use Emerald:MainNavigation. According to DXA naming convention, the view name is prefixed with the name of the module, separated by colon (:).

7. Create a Content Page

Create a Page using File Name Navigation Test Page and Page Template Section Page. Add one Component Presentation to it using Component Main Navigation and Component Template Main Navigation CT.

Publish the Page.

At this moment, the Content Delivery Datastore has all the information necessary to support the DXA web application in fetching the model and rendering the Page. But more about that, in the next post.


Popular posts from this blog

Running sp_updatestats on AWS RDS database

Part of the maintenance tasks that I perform on a MSSQL Content Manager database is to run stored procedure sp_updatestats . exec sp_updatestats However, that is not supported on an AWS RDS instance. The error message below indicates that only the sa  account can perform this: Msg 15247 , Level 16 , State 1 , Procedure sp_updatestats, Line 15 [Batch Start Line 0 ] User does not have permission to perform this action. Instead there are several posts that suggest using UPDATE STATISTICS instead: I stumbled upon the following post from 2008 (!!!), , which describes a way to wrap the call to sp_updatestats and execute it under a different user: create procedure dbo.sp_updstats with execute as 'dbo' as

Content Delivery Monitoring in AWS with CloudWatch

This post describes a way of monitoring a Tridion 9 combined Deployer by sending the health checks into a custom metric in CloudWatch in AWS. The same approach can also be used for other Content Delivery services. Once the metric is available in CloudWatch, we can create alarms in case the service errors out or becomes unresponsive. The overall architecture is as follows: Content Delivery service sends heartbeat (or exposes HTTP endpoint) for monitoring Monitoring Agent checks heartbeat (or HTTP health check) regularly and stores health state AWS lambda function: runs regularly reads the health state from Monitoring Agent pushes custom metrics into CloudWatch I am running the Deployer ( installation docs ) and Monitoring Agent ( installation docs ) on a t2.medium EC2 instance running CentOS on which I also installed the Systems Manager Agent (SSM Agent) ( installation docs ). In my case I have a combined Deployer that I want to monitor. This consists of an Endpoint and a

Debugging a Tridion 2011 Event System

OK, so you wrote your Tridion Event System. Now it's time to debug it. I know this is a hypothetical situtation -- your code never needs any kind of debugging ;) but indulge me... Recently, Alvin Reyes ( @nivlong ) blogged about being difficult to know how exactly to debug a Tridion Event System. More exactly, the question was " What process do I attach to for debugging even system code? ". Unfortunately, there is no simple or generic answer for it. Different events are fired by different Tridion CM modules. These modules run as different programs (or services) or run inside other programs (e.g. IIS). This means that you will need to monitor (or debug) different processes, based on which events your code handles. So the usual suspects are: dllhost.exe (or dllhost3g.exe ) - running as the MTSUser is the SDL Tridion Content Manager COM+ application and it fires events on generic TOM objects (e.g. events based on Tridion.ContentManager.Extensibility.Events.CrudEven