22.09.2017
Author: Sven Lichterfeld

Individuelle Fehlerseite (404 oder 500) in OpenCms 10 anlegen

Die Fehlerseite soll sich inhaltlich nicht gravierend von der normalen Seite unterscheiden. Bisher wurden die Fehlerseiten immer statisch entwickelt. Somit konnten die Erwartungen vom Kunden nicht erfüllen werden. Mit dieser kleinen Anleitung soll sich das Ändern.

Hintergrund

Die Fehlerseiten in OpenCms 10 liegen standardmäßig in einem Bereich, auf den ein Redakteur keinen Zugriff hat. Eine genaue Prüfung des Quellcodes dieser Seiten ergab, dass es möglich ist, Fehlerseiten auch im Zugriffsbereich der Redakteure abzulegen. Dadurch können die Redakteure eine Fehlerseite genauso inhaltlich bearbeiten, wie jede andere Seite auch. Heißt das Verzeichnis  ".errorpages" und existieren darin Seiten mit dem Namensschema "handle###.html", ruft OpenCms diese Seiten automatisch im Fehlerfall auf.

Was ist zu tun?

  1. In das ROOT-Verzeichnis der Site wechseln. Zum Beispiel: /sites/default/.
  2. Auf "Ressource erstellen" (Zauberstab) klicken und ein neues Verzeichnis erstellen.
  3. Als Verzeichnisname ".errorpages" verwenden. Der Titel, die Beschreibung und anderen Felder können ignoriert werden.
  4. In den aus Schritt drei (3) erstellten Ordner wechseln und dort wieder auf "Ressource erstellen" (Zauberstab) klicken und eine neue Container-Seite erstellen.
  5. Als Dateiname für die Seite "handle###.html" definieren. ### durch den jeweiligen Fehlercode ersetzen. Zum Beispiel so: handle404.html oder handle500.html. Der Titel sollte außerdem befüllt werden, dieser wird z.B. im Browser-Tab angezeigt. Zur 404-Fehlerseite würde zum Beispiel: "Seite nicht gefunden" passen.
  6. Der Ordner ".errorpages", sollte außerdem aus der Suche ausgeschlossen werden. Dazu wären folgende Schritte notwendig:
    1. Rechtsklick auf den Ordner ,errorpages".
    2. Die Eigenschaften öffnen.
    3. Auf den Tab "Alle Eigenschaften" wechseln.
    4. Den Bereich "Unbenutzte Eigenschaften" öffnen und im Feld "search.exclude", "true" eintragen.
    5. Auf OK klicken.
  7. Die neuen/angepassten Ressourcen, aus den letzten Schritten, veröffentlichten und einen Test durchführen.

Die Fehlerseite bearbeiten/pflegen

Die Fehlerseite kann nun, wie eine normale Seite, einfach bearbeitet/gepflegt werden. Dazu einfach auf die entsprechende Fehlerseite im Explorer klicken. Die Seite öffnet sich und kann wie gewohnt, mit Inhalten ausgeschmückt werden :)

Jede Site hat eigene Fehlerseiten

In jeder Site kann man somit individuelle Fehlerseiten erstellen. Eine Programmierung ist dafür nicht notwendig.