Support

Need help with Magnolia? If you have a support contract with Magnolia, you can enter support requests into our Jira issue tracking system. If you don't have a support contract, you can still get very valuable help from the mailing lists and wiki.

Jira account

DX Core clients can use their Magnolia account to access the Jira issue tracking system, Confluence wiki, Git version control and Nexus repository.

If you don't have a Magnolia support account yet, please contact Magnolia Sales at info@magnolia-cms.com and include the following information:

• Name. Please give your personal name. Don't use a shared account. We are happy to create two accounts if needed.
• Company
• Client. This is needed if you are working for a client who already has a contract with Magnolia.
• Email address. Please provide an individual email address at your company, not a generic account such as support@company.com.
• Phone number where we can reach you.

On reporting issues in general

Issue types

Select from the following issue types:

• Support Request. The product license determines the available product support options. For more details about the options, please contact us.
• Magnolia Malfunction. Use to ask for help with any kind of problem related to a corrupted repository, missing documentation or malfunctioning Magnolia code. Covered by support agreement.
• Installation and Migration. Use to request help with the initial installation of Magnolia or for help with migration of Magnolia to a newer version or different type of configuration. Covered by support agreement.
• Development Support Request. Developer support is available for Magnolia Partners and Magnolia DX Core customers only. We use a range of online communication tools to ensure that support is provided by our experts to your developers.

Betas are not supported

Beta versions of Magnolia are not supported. They are not official production releases or intended for production use. Please do not file support tickets for betas. Report and discuss problems on the forum instead.

Exporting configuration

When reporting an issue, the more information you provide, the better we can address your issue. Here's how to collect information from your system.

There are several ways to export content, data and configuration. The most common is exporting XML.

To export XML:

1. Right-click a node to export the node and its children.
2. Select Export. Accept any system requests to download files containing XML.

The resulting XML file contains the node hierarchy. File name matches the path in the repository. For example, when you export Configuration > /modules/adminInterface/controls the file name is config.modules.adminInterface.controls.xml. When Magnolia Support imports the file it will recreate your node hierarchy in their Magnolia instance.

Tracing errors

Error messages tell you which Java class produces the error. This is vital information for finding the root cause of an issue.

The first task in tracing errors is to identify the fully-qualified name of the Java class.

Example: Magnolia was unable to send mail. The fully-qualified name of the Java class where the error was raised is info.magnolia.module.form.processors.SendContactEMailProcessor.

ERROR  info.magnolia.module.form.processors.SendContactEMailProcessor 
   07.10.2011 16:08:17 -- Contact email 
   javax.mail.MessagingException: 
   Could not connect to SMTP host: localhost, port: 25;

The class name is not always available. For example, in Freemarker templating errors only a stack trace is displayed, no class name.

freemarker.core.NonBooleanException: Error on line 13, column 6 in templating-kit/paragraphs/content/textImage.ftl
Expecting a boolean (true/false) expression here
Expression content.subtitle does not evaluate to true/false 
it is an instance of freemarker.template.SimpleScalar
   at freemarker.core.Expression.isTrue(Expression.java:150)
   at freemarker.core.ConditionalBlock.accept(ConditionalBlock.java:77)
   at freemarker.core.Environment.visit(Environment.java:210)
   at freemarker.core.MixedContent.accept(MixedContent.java:92)

A stack trace is a sequence of nested functions called up to the point where the stack trace is generated. The error log displays the stack trace up to function where the failure occurred.

Errors are dealt with sequentially. Magnolia logs the error that first caused the failure. Rectifying the first error does not always solve the problem entirely but will help you to find the ultimate source. For example, if you try to send an email and there is both a templating error and an error in your SMTP configuration, you will first need to resolve the templating error before you can see that there is also an authentication issue.

Once you know class name, configure logging to get more details.

Reading the troubleshooting documentation

Read the troubleshooting documentation that includes solutions to common issues.

Reporting a security issue

If you find a security vulnerability in Magnolia, please always report it in the SUPPORT project:

• Enter a SUPPORT ticket or
• Send mail to support@magnolia-cms.com

Issues in the SUPPORT project are private to Magnolia and the issue reporter.

Magnolia Support team will investigate and take appropriate action. Our goal is to keep the vulnerability private. We take security seriously and aim to provide patches promptly. The best way to stay secure is to always keep your Magnolia instances up-to-date.

Stale issues

Issues where we have been waiting for feedback for a certain amount of time might get closed automatically. You'll always have the possibility to Re-open issues, even if they have been closed this way.

Following up on your issues

At any time, you can see the status of your issues by browsing Jira.

Once a member of the Magnolia Support Team takes your request in charge, it will switch to the In Progress status. If we need more information from you, you will receive an email and the status will be Waiting for customer information. To reply to us, please use the Jira web interface, and the Reply to Magnolia Support action (in the left menu), so that it comes back to us in the proper status. Here too, your collaboration will help us follow up with your issue more effectively. Of course, you can always add comments or attachments when needed.

Once the issue is resolved for you, you can Close it immediately. A member of the Magnolia Support Team could also Resolve your issue, in which case you'll have the possibility to Confirm the issue resolution or Re-open it if you think your issue isn't entirely solved.

Reporting via the About app

To report an issue in Magnolia CMS:

1. Open the About app.
2. Go to the Report an Issue tab
3. Log in with your Jira credentials.
4. Select issue type.
5. Enter details in the dialog.
6. Submit.

After submission, find your issue on the list and go to Jira to add more information such as logs, configuration files and screenshots.

Reporting via Jira

Create an issue directly or click Create new issue and select the Support - Magnolia project in Jira.

Moving an issue into the Support project

To move an issue entered into another project into the Support project:

1. Open the issue in Jira.
2. Click More actions > Move.
3. Set New Project to Support - Magnolia.
4. Set New Issue Type to Support Request.
   
5. Click Next and fill the environment details.

Making issues visible to teammates

By default, support issues are only visible to the reporter (you) and Magnolia Support staff. If you want to grant your teammates access to the issue, type their account names into the Visible to field. You need a DX Core support account in order to create and edit issues.

Forum

If you don't have a Magnolia support contract and therefore no support account, you can still get some help from the community. Describe your issue on the forum, paste logs to a text storage service such as pastebin.com and link to them from your forum post. Don't paste large amounts of text in the forum post itself.

There are several free pastebin services designed specifically to store and share text online. For images, try Tinypic, imgur or any other.

Mailing lists

Subscribe to the mailing lists to stay updated. You can post questions and reach a wide community of experts.

Wiki

Community supported wiki has technical articles and tips.