Best practices

A best practice is a way of working that consistently yields better results. Best practices save time and effort and result in more maintainable projects.

Administration

Disk space

We recommend that you allocate at least 50GB of disk space for an author instance and 25GB for a public instance.

See Disk space

Apps

Changing the location in the app UI

See Location, location, location

Add a Container instance in your ContentConnector

Make the Container instance available in your ContentConnector. This makes it easier to implement item and itemId related methods. This works only if you have only one Container per subapp. If you need more Containers you must decouple the Container and the ContentConnector.

See Content app framework

Displaying content stored in apps

See Search

Define as a component anything that is likely to change

Defining something as a component allows other developers to quickly change the implementation. For this reason, you should define anything that is likely to be changed or customized later as a component. For example, define your apps and subapps as components. Views are also common customization points so define the views returned by subapps as components. Any components you define are available for injection. This is also true for components further up the hierarchy in parent components.

Examples

Fields

Use delegating field transformers

The delegating transformer classes should be your first choice since they are the most versatile. If you can, use DelegatingCompositeFieldTransformer or DelegatingMultiValueFieldTransformer rather than the other available classes.

See Transforming field values

Forms

Checking for null values

See Field validators

Language

Provide a message bundle

With message bundles a translator can work with a plain text file and doesn’t need to touch the code.

See Internationalization

Use UTF-8

Magnolia requires everyone to use UTF-8 character encoding in .properties files.

See Internationalization

Avoid hard-coded strings

Avoid hard-coded strings exposed to visitors, editors or administrators. Always allow localization of texts displayed on the website and in Magnolia Shell.

See Types of translatable text

See Types of translatable text

Modules

Create your own webapp

To create a custom Magnolia webapp, always start with a preconfigured Magnolia webapp.

Use the properties section to define versions. The section may the serve as a central part for organizing all versions required by your project.

See Creating a custom webapp with Maven

Create separate modules for templates, content and resources

When you are creating a website project, you should have one module for templates, another module for content, a third for a theme and so on.

See Modules

Multisite

Author domain

In a multisite setup with one Magnolia installation, you assign multiple domains to the public instance. However, it is sufficient and recommended to have only one domain pointing to your author instance. The domain of the author instance is different from the domains of the public instance.

Site definition name and handle prefix

Use different values for the site-definition-name and the name of the mapped node (handlePrefix).

Turn off domains and mappings inheritance

When extending site definitions, turn off inheritance for mapping and domains by using @extends=override.

Disable the uri-starts-with-sitename rule on the public context

Disable the uri-starts-with-sitename rule in the public context.

Add an additional voter AdminOnlyMatcher to the rule. This way you can use the same configuration on both the author and public instances.

See How to use Multisite

Personalization

Create traits that have a clear set of allowed values

Every trait has inherent allowed values. For example, locations are countries, ages are numbers, and genders are either male or female. Create traits that have a clear set of allowed values. Traits that have vague values are difficult to detect and assign. Also, make sure the trait applies to the majority of your audience. "New vs. returning visitor" is a good trait because the values are easy to detect and it applies to every visitor.

See Personalization

Create a segment only when you know your audience well

Create a segment only when you know your audience well and have targeted at least one successful campaign to them using local rules. Visitors who share a combination of traits are good candidates for segmentation if they respond well to personalization. For example, add visitors who previously bought a product to a "Previous buyers" segment and offer them a discount as a reward for return business. Segmentation helps you repeat successful personalization experiments. Start with local rules, move to segmentation later.

See Personalization

Resources

Use a dedicated CSS pre-processor

See Resources

REST

Delivery API

Improving response times

  1. Minimize references.

    Using reference resolvers can impact the response times significantly. If the data contains a lot of referenced properties, the request processing times may be considerably longer.

  2. Minimize asset renditions.

    Each asset rendition config added to the endpoint definition increases the request processing overhead regardless of whether the asset renditions do or do not exist.

  3. Minimize response size.

    A large response can take longer to generate and return.

  4. Minimize the value of the depth property.

    Extra but unnecessary depths configured may have a major impact on response times. Even just one extra depth level can have an adverse effect on the responsiveness of the endpoint.

    For example, setting depth to 4 may take five seconds to process, whereas depth: 5 could easily increase it to twenty seconds.

    When needing to retrieve a hierarchical collection of nodes such as to build a sitemap, a navigation, or to represent the hierarchy of content in a content app, consider retrieving just one or two depths of content at once, and then making further requests as necessary.

  5. Adjust the caching configuration.

    Using cache can boost the performance of your endpoint. The default cache response threshold value is 500. This means that responses for data larger than 500 kilobytes are not cached.

    If your endpoint will be handling much larger chunks of data, consider modifying the cacheResponseThreshold property accordingly. For more details, see cache threshold.

Security

Create an app group for your own apps

Create a new app group for your own apps, especially if you have multiple apps. This approach is better than placing your apps in the native Magnolia groups. A dedicated group gives your organization’s apps an identity and makes them instantly recognizable.

See App permissions

Provision apps only to users who need them

Provision apps only to users who actually need them. This ensures that the app launcher stays uncluttered and users find apps quickly.

See App permissions

LDAP groups

When you store groups in LDAP, create one matching group per role in Magnolia. Assign roles to the group in Magnolia in order to grant users the permissions they need. This minimizes the number of groups you need to create in Magnolia.

See Group resolving

Separate message bundles

Create separate message bundles for user interface labels and template labels. Don’t store these two groups of text in the same properties files or message bundles. They are aimed at different audiences and have different localization requirements.

Example: Message files in the Travel Demo

Workflow and tasks

Don’t use tasks for non-human workflows

Do not use tasks if you don’t have any human activity in your workflow. They are great for humans but unnecessary for operations that only involve the system itself.

See Tasks

Configure your content staging instance as a public instance

Configure your content staging instance as a public instance so that users cannot edit pages on it. The Pages app does not display the green edit bars on public instances. You typically don’t want reviewers to change content on the staging instance. While reviewers may need permission to log into the AdminCentral to review functionality such as new apps, they should not edit pages. The staging instance is intended for testing and approving only. If something is not correct, fix it on the author instance and publish again to staging for another test.

See Content staging

Feedback

DX Core

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the DX Core docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules