Page tree
Skip to end of metadata
Go to start of metadata

Magnolia stores data in a Java Content Repository. The repository is a hierarchical object database that is particularly well-suited for storing content. In a content management system you need to be able to store text, documents, images and other binary objects along with their metadata. The data is structured as a tree of nodes. Each node can have one or more types. The type defines what kind of properties the node has, the number and type of its child nodes, and its behavior. See Jackrabbit Node Types for more information and Node Type Visualization for a diagram of the node type hierarchy.

In Magnolia we define custom node types that define Magnolia's custom content model. The JCR in turn enforces the constraints of that model at the repository level. If you need to reference JCR node types in your code, Jackrabbit's JcrConstants is useful. We provide constants also for Magnolia's custom node types but also convenience methods. For example, to update the last modification date of a node, use the NodeTypes.LastModified.update(node) convenience method. Magnolia node types are registered by the NodeTypes Java class.

Prefixes

Node type

Prefix

Notes

JCR primary node type

nt:

 

Mixin node type

mix:

 

Magnolia node type

mgnl:

The mgnl prefix does not tell you whether the node is a primary node or a mixin. To find out which type a mgnl node is, check the magnolia-types.xml file.

Node type hierarchy

In this node type hierarchy diagram you can see what extends what. For example, mgnl:page extends mgnl:versionable. This means that page is an object you can version. In contrast, mgnl:area and mgnl:component are not versionable – they are subnodes that must be activated together with the parent page. However, all three node types (page, area, component) are renderable which means you can render a component on its own without its parent page.

Primary node types

Every node has a primary node type assigned to it upon creation. The primary node type defines node structure such as allowed and required child nodes and properties. Primary types reflect the business that is represented in the repository. Magnolia's primary node types define content management nodes such as pages, areas, components and resources.

JCR primary node types

Notation

Description

nt:base

The base type of all primary node types.

nt:unstructured

Unstructured node type that allows any properties and child nodes.

nt:hierarchyNode

Abstract base type for nodes in a structured node hierarchy.

nt:file

JCR representation of a file.

nt:frozenNode

This node type is used in the versioning system.

Magnolia primary node types

Notation

Description

mgnl:folder

Folder

mgnl:resource

Resource

mgnl:metaData

Metadata

mgnl:content

Activatable and versionable content objects such as pages.

mgnl:contentNode

Typically a content object below page level, such as area or component, that can be rendered also independently.

mgnl:page

Page

mgnl:area

Area

mgnl:component

Component

mgnl:nodeData

Property

mgnl:user

User

mgnl:group

Group
mgnl:role Role

mgnl:reserve

Reserved for system use.

Mixin node types

Mixin node types specify additional properties or characteristics to the node. A node can have a primary type and several mixin types at the same time. JCR mixins add repository-level functionality such as versioning and locking. Magnolia mixins add content management capabilities such as activating and rendering.

JCR mixin node types

Notation

Description

mix:referenceableMixin type for referenceable nodes. Provides an auto-created jcr:uuid property that gives the node a unique, referenceable identifier.
mix:versionableMixin type for versionable nodes.
mix:lockableEnables locking capabilities for a node.

Magnolia mixin node types

Notation

Properties

Description

mgnl:deleted

mgnl:deleted (DATE)

mgnl:deletedBy (STRING)

Date the node was deleted, the user who deleted it and the deletion comment.

mgnl:lastModified

mgnl:lastModified (DATE)

mgnl:lastModifiedBy (STRING)

Date the node was last modified and the user who modified it.
mgnl:activatable

mgnl:lastActivated (DATE)

mgnl:lastActivatedBy (STRING)

mgnl:activationStatus (STRING)

Date the node was activated, the user who activated it and its current activation status.

 

Note that on the public instance, lastActionDate always contains the date of the previous activation, not the current one. This is because the lastActionDate is updated only after the content is sent to the public instance.

mgnl:created

mgnl:created (DATE)

mgnl:createdBy (STRING)

Date the node was created and the user who created it.
mgnl:renderablemgnl:template (STRING)Associates a template with the node for rendering.
mgnl:versionablemgnl:comment (STRING)Allows the user to leave a comment on the version.

Same name siblings are not allowed

The Magnolia node type definition magnolia-types.xml does not allow same name siblings. This means that you cannot have two nodes at the same level in the node hierarchy with the same name. Typically same name siblings is not an issue because Magnolia enforces the constraint automatically during normal usage. However, if prior to Magnolia 5.2 you imported an XML file that was created outside of Magnolia or was edited by hand, it is possible that the XML import created a same name sibling.

Use the siblings.groovy script to find same name siblings in your repository. The example below searches for identically named areas (returnItemType is mgnl:area) in the website workspace under the /travel/about page. See Groovy module for instructions on how to execute Groovy scripts.

siblings.groovy
import info.magnolia.cms.util.QueryUtil;
import info.magnolia.cms.core.search.Query;
import info.magnolia.cms.core.Path;
import info.magnolia.jcr.util.NodeUtil;
import info.magnolia.context.MgnlContext;
import javax.jcr.Session;
import javax.jcr.Node;
import javax.jcr.NodeIterator;
import org.apache.commons.lang.StringUtils;
import java.util.LinkedList;
def siblings(workspace,path,returnItemType) {
    query = "/jcr:root" + path + "//* order by @name";  //i.e. path=/travel/about
    try {
        NodeIterator nodes = QueryUtil.search(workspace,query,Query.XPATH,returnItemType);
        
        Session session = MgnlContext.getJCRSession(workspace);
        def siblings = []; 
        while (nodes.hasNext()) {
            Node node = nodes.nextNode();
            nodePath = node.getPath();
            if (StringUtils.contains(nodePath,"[")) {
              println "found same name sibling of '${node.getName()}' at ${nodePath}";
              siblings.add(node);
            }
        }
        siblings.each {
            nodePath = node.getPath();
            newName = Path.getUniqueLabel(session,nodePath,node.getName());
            NodeUtil.renameNode(node,newName);
            println "${nodePath} was renamed to ${newName}";
        }
        session.save();
    } catch (Exception e) {
        println e;
    }
}
//example
siblings("website", "/travel/about", "mgnl:area");

Options:

  • workspace: Any Magnolia workspace.
  • path: A valid path in the workspace. / will search for everything under the workspace root.
  • returnItemType: A valid JCR node type. The query goes through all node types but the results are filtered to the node type you specify. Use nt:base as a "wildcard". 
  • No labels

2 Comments

  1. https://forums.magnolia-cms.com/forum/thread.html?threadId=6371e2ee-5a74-4b37-9c68-d619123a5a4b

    The last answer mentions, that the lastActivated date on the public instance is always one behind. Could you mention this in the documentation?
    We used it for sorting of our search results (sort by newest article) which works fine on author but not on public. 

    1. Hi Fabian, 

      Thanks for pointing it out, I've updated the page. 

      Julie