Raumbuchungssystem-Handbuch für TYPO3

Raumbuchungssystem Handbuch
für die TYPO3-Erweiterung: t3m_calender
Für Version v 3.0.0
Autor:
Version vom:
Janice Noack,
Mykola Orlenko team in medias GmbH
29.07.2015 11:36 Uhr
Inhaltsverzeichnis
1. Oberfläche......................................................................................................................................... 4
1.1 Kalenderansicht........................................................................................................................... 4
1.2 Buchung erstellen........................................................................................................................ 5
1.3 Buchung Detailansicht................................................................................................................. 6
1.4 Buchung bearbeiten..................................................................................................................... 7
1.5 Backend Besonderheiten............................................................................................................. 7
1.6 Filterung....................................................................................................................................... 9
1.7 Serien und einzelne Buchungen löschen.....................................................................................9
2.Installation........................................................................................................................................ 10
2.1 Migration älterer Versionen........................................................................................................ 11
3.Backend Einrichtung......................................................................................................................... 12
3.1 Kategorie anlegen...................................................................................................................... 13
3.2 Objekt anlegen........................................................................................................................... 14
3.3 Zusatzfeld anlegen..................................................................................................................... 16
3.4 Zusatzfeld einer Kategorie zuordnen.........................................................................................17
4.Benutzerverwaltung.......................................................................................................................... 18
4.1 Benutzergruppe bestimmen....................................................................................................... 19
4.2 Benutzer anlegen....................................................................................................................... 20
4.3 Benutzer bestimmte Objekte freigeben......................................................................................21
5.Plug-In: t3m_calendar verwalten...................................................................................................... 22
5.1 Plug-In einfügen......................................................................................................................... 22
5.2 Berechtigung einstellen.............................................................................................................. 23
6.TypoScript Constants....................................................................................................................... 24
Seite 2
Abbildungsverzeichnis
Abbildung 1: Oberfläche: Kalenderansicht............................................................................................ 4
Abbildung 2: Oberfläche: Buchung erstellen......................................................................................... 5
Abbildung 3: Oberfläche: Buchung Detailansicht...................................................................................6
Abbildung 4: Backend Modul................................................................................................................. 7
Abbildung 5: BE-Modul: Kategorie wechseln......................................................................................... 8
Abbildung 6: BE-Modul: Benutzer zuweisen.......................................................................................... 8
Abbildung 7: Serienbuchung - Typen..................................................................................................... 9
Abbildung 8: Serienbuchung löschen.................................................................................................... 9
Abbildung 9: Erweiterung installieren.................................................................................................. 10
Abbildung 10: t3m_calendar im Seitentemplate integrieren.................................................................11
Abbildung 11: Extension update.......................................................................................................... 12
Abbildung 12: Systemstruktur.............................................................................................................. 13
Abbildung 13: Kategorie anlegen......................................................................................................... 14
Abbildung 14: Objekt anlegen.............................................................................................................. 15
Abbildung 15: Objekt anlegen.............................................................................................................. 16
Abbildung 16: Zusatzfeld anlegen....................................................................................................... 17
Abbildung 17: Zusatzfeld einer Kategorie zuweisen............................................................................18
Abbildung 18: Feuser: Systemordner anlegen.....................................................................................19
Abbildung 19: Feuser: Benutzergruppe anlegen.................................................................................20
Abbildung 20: Feuser: Benutzer anlegen............................................................................................ 21
Abbildung 21: Feuser: Benutzer bestimmte Objekte freigeben............................................................22
Abbildung 22: Plug-In anlegen............................................................................................................. 23
Abbildung 23: Plug-In: Einstellungsmöglichkeiten...............................................................................23
Abbildung 24: Plug-In: Berechtigung einstellen...................................................................................24
Seite 3
1. Oberfläche
1.1 Kalenderansicht
1
Schaltfläche um eine neue Buchung erstellen zu können
2
Hierüber kann die Anzeige der einzelnen Objekte gefiltert werden.
3
Schaltfläche um zwischen den Tagen / Wochen / Monaten wechseln zu können *1)
4
Zeigt den Aktuellen Tag / Woche / Monat an. *1)
5
Schaltfläche um zwischen der Tages-, Wochen- und Monatsansicht zu wechseln.
6
Farblich hinterlegtes Feld zeigt den aktuellen / heutigen Tag an.
7
Eine einzelne Buchung mit Information über das gebuchte Objekt und den Benutzer der dieses Objekt
gebucht hat.
*1) Anzeige oder Verhalten ist abhängig davon was in (5) gewählt wurde.
Abbildung 1: Oberfläche: Kalenderansicht
Seite 4
1.2 Buchung erstellen
1
Buchungsobjekt
Dieser Bereich zeigt die Kategorie und eine Auswahl der zugehörigen Objekte an.
Category
Dieser Wert zeigt die Kategorie und dient nur zur Orientierung.
Objekt
Liste mit Objekten die der Kategorie zugehören. Bei der Auswahl eines Objektes werden
entsprechende Informationen darunter angezeigt, dazu gehört: die Objektbezeichnung,
der mögliche Buchungszeitraum und die Beschreibung.
2
Buchungszeitraum
Hier kann der Zeitraum bestimmt werden wie lange man das jeweilige Objekt buchen möchte.
3
Start
Bestimmt den Anfangszeitraum
End
Bestimmt den Endzeitraum
Wiederholungsoption
Bestimmt die Art der Wiederholung für ein buchbares Objekt.
Repeat every Bestimmt die genaue Art der Wiederholung – Soll die Buchung [week] wöchentlich oder
[Month] monatlich wiederholt werden.
Stop reap
4
Bestimmt den Endzeitpunkt wann die Wiederholung enden soll.
Zusätzliche Felder
Beinhaltet alle Zusatzfelder die einer Kategorie zugewiesen wurde *1)
5
Schaltfläche zum Hinzufügen der Buchung
*1) Siehe hierzu „3.3 Zusatzfeld anlegen“ und „3.4 Zusatzfeld einer Kategorie zuordnen“
Abbildung 2: Oberfläche: Buchung erstellen
Seite 5
1.3 Buchung Detailansicht
Die Detailansicht einer Buchung erhalten Sie sobald Sie eine Buchung aus dem Kalender anwählen
1
Buchungsinformationen
Hier erhalten Sie eine kurze Übersicht um welches Objekt es sich handelt und zu welchem Zeitraum
dieses gebucht wurde.
2
Buchung bearbeiten
Über diese Schaltfläche lässt sich die ausgewählte Buchung bearbeiten. *1)
(siehe hierzu auch „1.4 Buchung bearbeiten “)
3
Buchung löschen
Über diese Schaltfläche lässt sich die ausgewählte Buchung löschen. *1)
*1) Sie müssen über entsprechende Berechtigung verfügen um diesen Schaltfläche angezeigt zu bekommen.
Abbildung 3: Oberfläche: Buchung Detailansicht
Seite 6
1.4 Buchung bearbeiten
Das Bearbeitungsformular einer Buchung erhalten Sie nachdem Sie auf „EDIT“ in der Detailansicht
der Buchung geklickt haben. (siehe hierzu auch „1.3 Buchung Detailansicht“).
Die Oberfläche des Formulars zum bearbeiten einer Buchung ähnelt dem Formular zum erstellen einer Buchung. Eine Übersicht über die einzelnen Elemente erhalten Sie entsprechend in Kapitel „1.2
Buchung erstellen“.
1.5 Backend Besonderheiten
Im Backend stehen Ihnen als Administrator weitere Felder zur Verfügung, die Sie im Frontend nicht
haben.
Backendmodul
Um im Backend zugriff auf das Raumbuchungssystem zu
haben, gibt es zusätzlich, unterhalb von „Benutzerwerkzeuge“ ein neues Modul namens „Booking Calendar“.
Hierüber kommen Sie auf die einfache Kalenderansicht.
Die Grundlegende Bearbeitung und Buchung von Objekten
Abbildung 4: Backend Modul
verhält sich gleich wie im Frontend.
Seite 7
Kategorieauswahl in der Kalenderansicht
Im Backend Modul „Booking Calendar“ steht Ihnen auf der Kalenderübersicht, ein zusätzliches Feld
zum wechseln zwischen allen verfügbaren Kategorien zur Verfügung. So bekommen Sie je nach
Kategorie alle zugehörigen Buchungen in der Kalenderansicht angezeigt.
Abbildung 5: BE-Modul: Kategorie wechseln
Zuweisung Benutzer / Besitzer zu einer Buchung
Erstellen oder bearbeiten Sie über das Backend Modul „Booking Calendar“ eine Buchungen, können
Sie den zugehörigen Benutzer/Besitzer direkt auswählen. Im Frontend geschieht dies Automatisch
über die Frontend-User Verwaltung bzw. Login.
Abbildung 6: BE-Modul: Benutzer zuweisen
Seite 8
1.6 Filterung
Es ist möglich Objekte innerhalb des Kalenders zu filtern. Standardmäßig werden immer alle Objekte
angezeigt.
Siehe Hierzu 1.1 Kalenderansicht, Punkt 2
1.7 Serien und einzelne Buchungen löschen.
Es ist möglich Serienbuchung des Typs „täglich“, „wöchentlich“ und „monatlich“ zu erstellen.
Abbildung 7: Serienbuchung - Typen
Bei dem löschen solch einer Serienbuchung ist es möglich eine gesamte Serie oder nur einzelne Termine dieser Serie zu löschen.
Abbildung 8: Serienbuchung löschen
Seite 9
2.Installation
Um das Raumbuchungssystem „t3m_calendar“ in Ihrem TYPO3-Web nutzten zu können müssen Sie
diese zunächst über den Erweiterungsmanager in Ihr System installieren.
Abbildung 9: Erweiterung installieren
Seite 10
Anschließend muss die Erweiterung noch im Seitentemplate eingeschlossen werden:
Abbildung 10: t3m_calendar im Seitentemplate integrieren
2.1 Migration älterer Versionen
Wenn Sie die Raumbuchungssystem-Erweiterung „t3m_calendar“ von der alten TYPO3-Version 4.5.x
auf die neue TYPO3-Version 6.2.x updaten möchten, sollten Sie zunächst das „Aktualisierungs-Skript
ausführen“.
Starten Sie hierzu den „Extensionmanager“ und wählen die Option „Aktualisierungs-Skript ausführen“.
Abbildung 11: Extension update
Anschließend klicken Sie auf „Update starten“
Seite 11
Nun werden folgende Schritte durchgeführt:
•
Erstellung neuer Datenbank-Tabellen
•
Sicherung der alten Datenbank
•
Migration der alten Datenbank-Struktur auf die neue Struktur
•
Aktualiserung der alten Flexforms für bereits bestehende Frontend-Plugins.
3.Backend Einrichtung
Um die Erweiterung optimal nutzten zu können sollten Sie in Ihrem TYPO3-Web einen Bereich für
das Raumbuchungssystem schaffen.
Legen Sie hierzu einen Systemordner mit sprechenden Namen wie z.B. „Raumbuchungssystem“ an.
Hier sollten alle Elemente gespeichert werden die mit der Erweiterung zu tun haben. So können Sie
hier z.B. die einzelnen Kategorien ablegen oder auch weitere untergeordnete Systemordner für Räume oder Zusatzfelder anlegen.
Beispiel:
Abbildung 12: Systemstruktur
Seite 12
3.1 Kategorie anlegen
Eine Kategorie stellt die Basis in dem Raumbuchungssystem dar. Eine Kategorie kann z.B. Raum,
Auto oder Equipment sein.
Um solch eine Kategorie anlegen zu können wechseln Sie auf das „Listen“-Modul und wählen anschließend den Ort an dem Sie die Kategorie anlegen möchten. Optimal wäre hier ein eigener Syste mordner.
In der Liste der Inhaltselemente orientieren Sie sich nach dem Abschnitt „Booking Calendar“ und
wählen dort „Category“.
Abbildung 13: Kategorie anlegen
Nun können Sie der Kategorie einen Namen geben und Zusatzfelder zuweisen (siehe hierzu „3.3 Zusatzfeld anlegen“).
Seite 13
3.2 Objekt anlegen
Ein Objekt ist bei einer Kategorie „Raum“ z.B. als Raum 101, Konferenzraum A1 usw. zu verstehen.
Um ein Objekt anlegen zu können wechseln Sie auf das „Listen“-Modul und wählen anschließend den
Ort an dem Sie das Objekt anlegen möchten. Optimal wäre hier der Systemordner der Kategorie zu
dem das Objekt zugehörig ist.
In der Liste der Inhaltselemente orientieren Sie sich nach dem Abschnitt „Booking Calendar“ und
wählen dort „Object“.
Abbildung 14: Objekt anlegen
Hier stehen Ihnen nun mehrere Eingabefelder zur Verfügung.
1 Object is public and visible for Damit bestimmen Sie ob das Objekt nur von Ihnen(Administrator)
other users
oder auch von anderen Benutzer einsehbar bzw. buchbar ist.
2 Start of possible time to Book Möchten Sie das Objekt nur für einen bestimmten Zeitraum zur
End of possible time to Book
Buchung bereit stellen können Sie dies über diese Option steuern.
3 Category
Über dieses Feld können Sie das Objekt einer Kategorie zuordnen.
4 Name
Hier vergeben Sie den Namen des Objekts z.B. Konferenzraum
A101
Seite 14
5 Color
Über den Farbwähler können Sie dem Objekt eine Farbe
zuweisen. Sobald jemand dieses Objekt bucht wird es mit der
angegebenen Farbe im Kalender angezeigt.
6 Description
Hier können Sie eine kurze Beschreibung um Objekt hinterlegen.
Abbildung 15: Objekt anlegen
Seite 15
3.3 Zusatzfeld anlegen
Wie bereits in „3.1 Kategorie anlegen“ erwähnt, lassen sich Kategorien über Zusatzfelder erweitern.
Solch ein Zusatzfeld kann z.B. ein Feld für eine zusätzliche Namenseingabe sein.
Um ein Zusatzfeld anlegen zu können wechseln Sie auf das „Listen“-Modul und wählen anschließend
den Ort an dem Sie die Zusatzfeld anlegen möchten. Optimal wäre hier ein eigener Systemordner
z.B. mit dem Namen „Zusatzfelder“. Alternativ können Sie das Element auch woanders innerhalb des
Systemordners „Raumbuchungssystem“ anlegen.
In der Liste der Inhaltselemente orientieren Sie sich nach dem Abschnitt „Booking Calendar“ und
wählen dort „Field“.
Abbildung 16: Zusatzfeld anlegen
Hier stehen Ihnen nun mehrere Eingabemöglichkeiten zur Verfügung.
Name
Bestimmt den Namen des Zusatzfeldes. Dieser Name wird auch im Frontend angezeigt.
Type
Hier können Sie bestimmen ob es sich bei dem Zusatzfeld um ein...
- [Text], ein einzeiliges Eingabefeld
- [Textarea], ein mehrzeiliges Eingabefeld
- [Checkbox], eine Checkbox
handelt.
Mandatory
Damit bestimmen Sie ob dieses Zusatzfeld ein Pflichtfeld sein soll indem Sie das Häckchen
setzten.
Seite 16
3.4 Zusatzfeld einer Kategorie zuordnen
Um ein Zusatzfeld (siehe „3.3 Zusatzfeld anlegen“) einer Kategorie zuweisen zu können, gehen Sie
zunächst zu der gewünschten Kategorie und bearbeiten diese. Beachten Sie, das Sie hierzu in der
Listenansicht sein müssen um die Kategorie Datensätze sehen zu können.
Abbildung 17: Zusatzfeld einer Kategorie zuweisen
Im Bereich „Field“ klicken Sie auf das kleine Ordner-Symbol rechts (1). Nun öffnet sich ein neues
Fenster wo Sie zunächst den Speicherort der Zusatzfelder angeben müssen(2). Anschließend erhalten Sie eine Übersicht über die verfügbaren Zusatzfelder (3). Über das „+“-Zeichen können Sie die
Felder nun der Kategorie hinzufügen. Diese werden entsprechend wie bei (4) zu sehen angezeigt.
Seite 17
4.Benutzerverwaltung
Es ist wichtig anzumerken das dass Raumbuchungssystem nur Optimal mit einer Benutzerstruktur
funktionieren kann.
Werden Buchungen erstellt, werden diese dem jeweiligen Benutzer, der sich zuvor über das Frontendlogin eingeloggt hat, zugewiesen und nur dieser Benutzer kann diese Buchung verändern. Ein
anderer Benutzer kann diese Buchungen lediglich einsehen aber nicht verändern. Ausnahme ist hierbei der Backend Administrator, welcher alle Buchungen frei verwalten kann.
Das heißt speziell - erstellen Sie einen Kalender ohne Frontend Login und somit ohne Zuweisung auf
eine Benutzergruppe, können Sie zwar Buchungen erstellen aber nicht wieder bearbeiten.
Ebenso lässt sich über eine Benutzerverwaltung steuern welche Objekte oder Kategorien von welchen Benutzern/Benutzergruppen eingesehen werden dürfen. Ebenso kann bestimmt werden welche
Objekte von einem Benutzer gebucht werden darf (siehe hierzu „4.3 Benutzer bestimmte Objekte freigeben“ )
Verfügen Sie bereits über eine Frontend-User Struktur können Sie direkt zu „4.3 Benutzer bestimmte
Objekte freigeben“ oder „Plug-In: t3m_calendar verwalten“ springen.
Andernfalls wäre der erste Schritt einen entsprechenden Bereich für die Frontend-Benutzer in Ihrem
TYPO3-Web anzulegen. Legen Sie hierzu an beliebiger Stelle einen Systemordner z.B. mit dem Namen „feuser“ an. Unter „Verhalten“ können Sie bestimmen das es sich bei diesem Systemordner um
„Website-Benutzer“ handelt – die Frontendbenutzer sind TYPO3 Standard weshalb nichts zusätzlich
installiert werden muss.
Abbildung 18: Feuser: Systemordner anlegen
Seite 18
4.1 Benutzergruppe bestimmen
Über die Benutzergruppe steuern Sie welche Kategorien und damit welchen Kalender ein Benutzer
zugriff haben darf. So können Sie z.B. je Kategorie eine Benutzergruppe erstellen.
Um solch eine Benutzergruppe erstellen zu können wechseln Sie auf das „Listen“-Modul und wählen
anschließend den Ort an dem Sie die Benutzergruppe anlegen möchten. Optimal wäre hier ein Systemordner für die Frontendbenutzer.
In der Liste der Inhaltselemente orientieren Sie sich nach dem Abschnitt „Systemdatensätze“ und
wählen dort „Website-Benutzergruppe“.
Abbildung 19: Feuser: Benutzergruppe anlegen
Nun können Sie der Gruppe einen Namen geben und eine kurze Beschreibung hinterlegen. Wenn
Sie möchten können Sie der Gruppe eine Untergruppe zuweisen.
Seite 19
4.2 Benutzer anlegen
Über den Benutzer können Sie direkt bestimmen welche Objekte dieser Buchen darf und entsprechend der Zuweisung in einer Benutzergruppe steuern Sie auf welche Kategorien bzw. Kalender er
allg. zugriff hat.
Um einen Benutzer erstellen zu können wechseln Sie auf das „Listen“-Modul und wählen
anschließend den Ort an dem Sie die Benutzer anlegen möchten. Optimal wäre hier ein Systemordner für die Frontendbenutzer.
In der Liste der Inhaltselemente orientieren Sie sich nach dem Abschnitt „Systemdatensätze“ und
wählen dort „Website-Benutzer“.
Abbildung 20: Feuser: Benutzer anlegen
Hier können Sie dem Benutzer nun einen Benutzergaben geben [Benutzername], ein Passwort setzten [Passwort] und ihn ein oder mehreren Gruppen zuweisen [Benutzergruppe].
Seite 20
4.3 Benutzer bestimmte Objekte freigeben
Möchten Sie das ein Benutzer nur bestimmte Objekte Buchen kann, können Sie dies über das Registerfeld „Erweitert“ beim Benutzer direkt bestimmen. Dabei bedeutet, kein ausgewähltes Objekt in der
linken Spalte, keine Beschränkung. D.h. alle Objekte sind erlaubt. Dies ist das Standardverhalten je
Benutzer.
Abbildung 21: Feuser: Benutzer bestimmte Objekte freigeben
Die Einträge innerhalb der Verfügbaren Objekte verstehen sich als [Objektname, Objekt Kategorie].
Seite 21
5.Plug-In: t3m_calendar verwalten
5.1 Plug-In einfügen
Um das Plug-In „Raumbuchungssystem“ auf Ihrer Seite integrieren zu können wechseln Sie zunächst
auf das „Seiten“-Modul“. Nun legen Sie auf der gewünschten Seite ein neues Inhaltselement des
Typs „Allgemeines Plug-in“ an.
Abbildung 22: Plug-In anlegen
Anschließend gehen Sie auf das Registerfeld „Plug-In“ und wählen aus dem Auswahlfeld den Eintrag
„Booking Calendar“. Wenn Sie nach dem neu laden der Seite wieder auf das Registerfeld „Plug-In“
gehen bekommen Sie folgende Felder:
1
Hier können Sie die Kategorie
auswählen welche der Kalender
zugehörig ist.
Entsprechend werden nur Objekte
dieser Kategorie zum Buchen
angeboten
2
Sobald eine Buchung getätigt wurde
wird eine E-Mail-Benachrichtigung
verschickt.
Hier bestimmen Sie an welche
E-Mail Adresse diese gehen soll.
3
Abbildung 23: Plug-In: Einstellungsmöglichkeiten
Hierüber können Sie unterbinden das
die jQuery-Libary eingebunden wird.
Das macht Sinn sobald Sie diese
Libary anderweitig eingebunden haben
um Konflikte oder Fehler zu vermeiden.
Seite 22
5.2 Berechtigung einstellen
Um einzustellen wer Zugriff auf den Kalender haben darf gehen Sie im Plug-In „Booking Calendar“
auf das Registerfeld „Zugriff“. Unterhalb von „Zugriffsrechte für Benutzergruppen“ können Sie die Benutzergruppen auswählen die den Kalender einsehen dürfen.
Abbildung 24: Plug-In: Berechtigung einstellen
Seite 23
6.TypoScript Constants
Key
Type
Default
Beschreibung
senderEmail string
[email protected]
Empfänger E-Mail Adresse
firstDay
-1
Definition des ersten Wochentag
string
0 für Sonntag,
1 für Montag,
2 für Dienstag,
3 für Mittwoch,
4 für Donnerstag,
5 für Freitag,
6 Für Samstag,
-1 das System erkennt automatisch den ersten Tag der
Woche, je nach gewählter Sprache
Seite 24