DEPRECATION WARNING
This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.
EXT: CIVSERV¶
Created: | 2005-10-14T15:50:07 |
---|---|
Changed by: | britta kohorst |
Changed: | 2010-02-15T14:21:41 |
Author: | citeq |
Email: | osiris@citeq.de |
Info 3: | |
Info 4: |
EXT: CIVSERV¶
Extension Key: civserv
Copyright 2004-2010, citeq, <osiris@citeq.de>
This document is published under the Open Content License
available from http://www.opencontent.org/opl.shtml
The content of this document is related to TYPO3
- a GNU/GPL CMS/Framework available from www.typo3.com
Table of Contents¶
EXT: CIVSERV 1
Einleitung 1
Was ist CIVSERV 1
Screenshots 2
Installationsanleitung 4
Was wird benötigt 4
Vorbereitungen 4
Die CIVSERV Extension Installieren 5
Administration 11
Konfiguration 11
Globale Konfiguration 11
Mandantenkonfiguration: 11
Template Konfiguration 13
Layout-Konfiguration der Extension CIVSERV 14
FAQ 16
Tutorial 18
Known Problems 18
ToDo Liste 18
Changelog (only major changes in english): 18
Version 3.x 18
Version 4.0.0. 18
Version 4.2.0. 19
Einleitung¶
Was ist CIVSERV¶
CIVSERV ist ein Synonym für O.S.I.R.I.S.: "Open Source basiertes Integriertes Regionalisiertes Informations-System für Virtuelle Rathäuser". Es wurde an der Universität Münster in einem Gemeinschaftsprojekt unter dem Namen regio@komm von dem Institut für Wirtschaftsinformatik , der c iteq und dem Kreis Warendorf als Prototyp für ein virtuelles Rathaus im entwickelt. Seit Oktober 2004 wird es von der citeq als Projekt 'tx_civserv' auf der Typo3ExtensionDevelopmentPlatform weiterentwickelt.
Das Problem bei der Errichtung virtueller Rathäsuser ist oftmals die fehlende Softwareunterstützung, die zur Bereitstellung von elektronischen Verwaltungsleistungen erforderlich sind.
Mit O.S.I.R.I.S. können beispielsweise auch Dienstleistungen des Landes bzw. Landkreises in das virtuelle Rathaus der Städte und Gemeinden integriert werden (Region-Features.u.).
Ein weiteres großes Problem ist es, die vielfältig in der Verwaltung anfallenden Informationen zu koordinieren und dem Bürger in einem angemessenen Design und im richtigen Kontext online anzuzeigen. Zudem ist eine ständige Aktualität dieser Inhalte sehr wichtig.
O.S.I.R.I.S. kann diese Informationen managen und bereitstellen.
O.S.I.R.I.S. wird mit einem komplette css-Layout ausgeliefert und kann im Single- oder Mehrmandanten-Betrieb laufen, d.h. in einer Installation von O.S.I.R.I.S können die Daten von einer oder mehreren Kommunen gleichzeitig bereitgehalten werden.
Im Mehrmandanten-Betrieb können die Kommunen, die sich ein virtuelles Rathaus teilen, Musteranliegen untereinander austauschen und größere Kommunen können kleinen Gemeinden ihre Dienstleistungen zur Verfügung stellen (Region-Feature).
Jede Kommune kann im Mehrmandanten-Betrieb ihren eigenes Layout indiviuell anpassen.
Screenshots¶
Installationsanleitung¶
Was wird benötigt¶
- Apache Webserver
- PHP >= 5.2.x
- MySQL >= 5.x
- TYPO3 Version >= 4.2.11
Kompatibilität¶
Ab civserv Version 4.5.0 ist das virtuelle Rathaus kompatibel mit der Typo3 Version 4.3.x !
Zeichensatz¶
Es wird dringend empfohlen, Datenbank, Typo3-Backend und das Frontend durchgängig auf utf8-codierung einzustellen!!
Vorbereitungen¶
Wir empfehlen für die ersten Geh-Versuche mit der Extension O.S.I.R.I.S eine komplett leere (Dummy-) Site zu verwenden.
Step1:
MOD_REWRITE muss im Apache aktiviert sein für die Funktion „simulate static“. Anleitungen sind hierzu in der Newsgroup typo3.projects.civserv auf news.netfielders.de oder direkt unter http://lists.netfielders.de/pipermail/typo3-project-civserv/ zu finden.
Andernfalls muss „simulate static“ in /typo3conf/ext/civserv/pi1/static/setup.txt auskommentiert werden.
Step2:
Installieren der für O.S.I.R.I.S. nötigen Extensions:
Smarty Template Engine;
User>Task Center, Actions und
Indexed Search Engine
Nach Möglichkeit sollte auch phpMyAdmin installiert werden.
Die CIVSERV Extension Installieren¶
Step 1:
Jetzt kanndie CIVSERV Extension heruntergeladen und installiert werden.
Wechseln Sie in den Extension Manager und suchen Sie auf dem TER nach 'civserv'.
Wenn die Extension nicht gefunden wird, müssen Sie die Option 'display shy extensions' aktivieren (typo3_src < 4.0) bzw unter 'settings' die Option 'enable unsupported exensions' aktivieren (typo3_src >= 4.0))
Installieren Sie civserv als lokale Extension.
Step 2:
Falls nicht vorhanden, muss im Verzeichnis civserv ein Verzeichnis templates_c angelegt werden (die smarty engine möchte ihre temporären Dateien im Pfad civserv/templates_c/ ablegen).
Step 3:
Die Ordner civserv und civserv/model_services unterhalb von fileadmin anlegen (hier werden dann die Bild- u.a. Ressourcen, die die Redakteure ins virtuelle Rathaus hoch laden, abgelegt).
Den Verzeichnisbaum erstellen¶
Die vorgefertigten .t3d Dateien für den Aufbau des Verzeichnisbaums befinden sich im Pfad civserv/doc/.
Speichern Sie die Datei 2006-11-16_virtuelle_verwaltung_inkl_mandant.t3d (und ggfs andere dort vorhandene .t3d-Dateien) auf einem lokalen Laufwerk.
Für alle folgenden Schritte wählen Sie das Modul „Liste“.
Seitenbaum in die Root importieren (leere Dummy-Site!!!)¶
Nachdem Sie die .t3d-Datei hochgeladen haben, wählen Sie im Reiter 'Import' die Option „force uids“ bzw "ALLE UID Werte erzwingen"
Import-Optionen¶
ACHTUNG : Diese Option dürfen Sie nur wählen, wenn sie die Extension civserv in einer leeren Site installieren. Sonst riskieren Sie, dass ein bereits vorhandener Seitenbaum überschrieben wird!
Wenn Sie die Extension civserv in einer leeren Site installieren erspart Ihnen die Option „force uids“ die Konfiguration des Mandanten.
Ggfs müssen Sie erst auf den Button Vorschau klicken, bevor der Button Import angezeigt wird. Der Import kann bis zu einer Minute dauern.
Nach erfolgtem Import finden Sie einen Ordner „virtuelle Verwaltung“ direkt unter der Weltkugel:
Der importierte Seitenbaum¶
Step 2:
Jetzt müssen Sie das statische Typo3-Standard-Template einbinden, damit im FE überhaupt irgendwelcher Content angezeigt wird.
Dazu editieren Sie das Mastertemplate: Wählen Sie css_styled_content aus.
Statische Templates einbinden¶
Step 3:
Nun muss die Mandanten-Konfiguration einmal geöffnet und gespeichert werden (damit im Hintergrund einige notwendige Verzeichnisse für den Mandanten angelegt werden). Klappen Sie dazu den Seitenbaum „virtuelle Verwaltung“ auf und wählen Sie den Ordner „Mandanten pflegen“.
Mandantenkonfiguration 'Musterstadt' bearbeiten¶
Öffnen Sie den Datensatz „Musterstadt“ zum Bearbeiten und speichern ihn sogleich wieder.
Step 4:
Schließlich müssen Sie eine Startseite für Ihre Site anlegen. Legen Sie eine neue Seite vom Typ „Shortcut“ direkt unterhalb der Weltkugel an.
Startseite als Shortcut auf CIVSERV-Vorschau-Seite¶
Der Shortcut muss auf die Seite „virtuelle Verwaltung“ (im Seitenbaum unterhalb des Ordners „Webseiten“) gelegt werden.
ACHTUNG: An dieser Stelle müssen Sie darauf achten, dass Sie die Seite (doktype 1) „virtuelle Verwaltung“ und nicht den gleichnamigen Ordner (doktype 254) auswählen.
Step 5:
Jetzt können Sie erstmals das FE des virtuellen Rathaus O.S.I.R.I.S aufrufen. Wählen Sie im Seitenbaum die Startseite (oder die Seite „virtuelle Verwaltung“) aus und wählen Sie dann das Modul „Anzeigen“.
Vorschaufunktion¶
Oder Sie bleiben im Modul Liste und wählen die Option „Anzeigen“ aus dem Click-Menü aus.
Sonstiges:
- Im Mehrmandanten-Betrieb sollte der Shortcut für die Startseite auf die Seite 'O.S.I.R.I.S. - choose community' zeigen.
- „English Version“ ist nur eine optionale Seite, sie kann ganz weggelassen werden. Gebraucht wird sie nur, wenn man auch Inhalte in 1 anderen Sprache in O.S.I.R.I.S. abbilden möchte (das feature steht ab version 4.0. zur Verfügung)
Der Verzeichnisbaum von O.S.I.R.I.S sollte am Ende im ungefähr so aussehen:
Verzeichnisbaum Überblick¶
Der Root-Ordner des virtuellen Rathauses enthält globale Ordner
- Regionen pflegen
- Mandanten pflegen
- Musteranliegen pflegen
und Mandanten-spezifische Ordner
- alles unterhalb von „c00.Musterstadt“
- die Vorschauseite für den Mandanten Musterstadt ist die Seite „virtuelle Verwaltung“ im Ordner „Webseiten“.
Eine Installation des virtuellen Rathauses kann beliebig viele Mandanten enthalten.
Der Seitenbaum jedes Mandanten ist identisch, alle Ordner befinden sich in der gleichen Anordnung und haben die gleichen Bezeichnungen – bis auf die Ordner unterhalb von „Dienstleistungen pflegen“, diese können frei gewählt werden.
Auch die Seite „English Version“ ist nur ein extra Feature, sie kann entfallen.
CIVSERV Seitenbaum mit 2 Mandanten¶
Administration¶
- Die Redakteure sollten mit Hilfe des Moduls Aufgaben->Befehle (user- taskcenter->actions) erstellt werden.
- Beachten Sie, dass Sie erst einen Befehl „Redakteur anlegen“ konfigurieren müssen, bevor Sie es ausgewählten BE-usern (Mandanten- Administratoren) ermöglichen können, eigenen Redakteure anzulegen.
Konfiguration¶
Globale Konfiguration¶
Bevor Sie anfangen im virtuellen Rathaus zu arbeiten, müssen Sie die Tabelle tx_civserv_configuration mit Werten versehen .
ACHTUNG : hierzu müssen Sie phpMyAdmin verwenden, diese Tabelle ist nicht über das BE editierbar
Die Tabelle ist nach der Installation der Extension zunächst ganz leer.
Wählen Sie das Modul „phpMyAdmin“ oder rufen Sie phpMyAdmin in einem neuen Browserfenster auf, falls Sie das Tool separat installiert haben.
Wählen Sie die entsprechende Datenbank aus und daraus die tabelle tx_civserv_configuration und beginnen Sie mit der Eingabe der Daten:
((generated))¶
PHPMyAdmin: Werte eintragen in tx_civserv_configuration¶
Die Werte in den Spalten cf_module und cf_key sind Schlüsselwörter, die im Quelltext der Extension referenziert werden. Sie müssen genau so eingetragen werden (s.u.)
Die Werte in der Spalte cf_value müssen den Werten des jeweiligen Systems entsprechen
Beim Eintragen der Werte im PHPMyAdmin können die Funktionsfelder, welche den Typ der Datenfelder beschreiben, leer gelassen werden.
PHPMyAdmin: tx_civserv_configuration mit Werten¶
Mandantenkonfiguration:¶
- Für jeden Mandanten im System muss je ein Datensatz „Mandant“ angelegt werden im Ordner „Mandanten pflegen“.
- In dem Mandanten-Datensatz müssen die UIDs von Ordnern und von bestimmten Datensätzen des Mandanten gepflegt werden. Wenn Sie den Verzeichnisbaum ohne die Option „force uids“ importiert haben, müssen Sie die Mandantenkonfiguration manuell vornehmen.
- Bevor der Mandant konfiguriert werden kann (im Ordner 'Mandanten pflegen'), muss im virtuellen Rathaus mindestens 1 Region angelegt worden sein (im Ordner 'Regionen pflegen').
- Im Ordner ' Regionen pflegen' befindet sich ein Datensatz Region (wählen Sie das Modul Liste und schauen Sie sich den Inhalt des Ordners 'Regionen pflegen' an), dieser muss umbenannt werden. Im Mehrmandantenbetrieb würde man eine Region pro Mandant anlegen oder Beispielsweise drei Regionen wie „KreisStadt“, „Mittlere Gemeinden“ und „kleine Gemeinden“.
- Falls der Ordner 'Regionen pflegen' leer ist, legen Sie ein neues Regions-Objekt an.
((generated))¶
Region 'Musterstadt'¶
Erläuterung der Felder in der Mandanten-Konfiguration:¶
Deutsch
Mandantenbezeichnung
Feldbezeichnung (Englisch)
cm_community_name
Wert
z.B. Berlin
Version
Ab 3.0.0
Deutsch
Gemeindekennziffer
Feldbezeichnung (Englisch)
cm_community_id
Wert
--> www.orte.de
Version
Ab 3.0.0
Deutsch
UID des Einstiegspunktes des Mandanten im Verzeichnisbaum
Feldbezeichnung (Englisch)
cm_uid (Community-Entrypoint)
Wert
ID des Root-Ordners des Mandanten (z.B. Verwaltung_1)
Tabelle pages
Version
Ab 3.0.0
Deutsch
Einstiegspunkt in Lebenslagen
Feldbezeichnung (Englisch)
cm_circumstance_uid
Wert
Id der ersten Lebenslage i m Ordner 'Lebenslagen pflegen'.
Uid aus Tabelle tx_civserv_navigation
Hinweis: diese erste Lebenslage erscheint nicht im Front-End.
Version
Ab 3.0.0
Deutsch
Einstiegspunkt Nutzergruppen
Feldbezeichnung (Englisch)
cm_usergroup_uid
Wert
Id der ersten Nutzergruppe im Ordrner 'Nutzgergruppen pflegen'.
Uid aus Tabelle tx_civserv_navigation
Hinweis: diese erste Nutzer erscheint nicht im Front-End
Version
Ab 3.0.0
Deutsch
Einstiegspunkt Organisationen
Feldbezeichnung (Englisch)
cm_organisation_uid
Wert
Id der ersten Organistation imOrdner ' Organisation pflegen'.
Uid aus Tabelle tx_civserv_organisation
Version
Ab 3.0.0
Deutsch
UID des Ordners Dienstleistungen
Feldbezeichnung (Englisch)
cm_service_folder_uid
Wert
Id Ordner Dienstleistungen pflegen
Uid aus Tabelle pages
Version
Ab 3.0.0
Deutsch
UID des Ordners Externe Dienstleistungen
Feldbezeichnung (Englisch)
cm_external_service_folder_uid
Wert
Id Ordner externe Dienstleistungen
Version
Ab 3.0.0
Deutsch
UID des Ordners betreute Musteranliegen
Feldbezeichnung (Englisch)
cm_model_service_temp_uid
Wert
Id Ordner betreute Musteranliegen
Uid aus Tabelle pages
Version
Ab 3.0.0
Deutsch
UID der Front-End-Seite
Feldbezeichnung (Englisch)
cm_page_uid
Wert
Id der Seite Virtuelle Verwaltung (die Seite auf der das Plugin installiert ist), standardmäßig einzige FE-Seite pro Mandant.
Uid aus Tabelle pages
Version
Ab 3.0.0
Deutsch
UID der Fulltext-Search Seite
Feldbezeichnung (Englisch)
cm_search_uid
Wert
Id der Seite Volltextsuche
Uid aus Tabelle pages
Version
Ab 3.0.0
Deutsch
UID der alternativen FE-Seite
Feldbezeichnung (Englisch)
cm_alternative_page_uid
Wert
Id einer evtl. anderssprachigen FE-Seite, muss auch Plugin tragen,
standardmäßig 0
Uid aus Tabelle pages
Version
Ab 4.0.0
Deutsch
UID des Ordners 'Anderssprachige Dienstleistungen'
Feldbezeichnung (Englisch)
cm_alternative_language_folder_uid
Wert
Id des Ordners, in dem Dienstleistungen in der zweiten Sprache abgelegt werden,
standardmäßig 0
Uid aus Tabelle pages
Version
Ab 4.0.0
Deutsch
Checkbox: Mitarbeiterdaten von Suchmaschine erfassen lassen?
Feldbezeichnung (Englisch)
cm_employeesearch
Wert
Konfiguration für die Volltextsuche (indexed search oder htdig)
Version
Ab 3.1.0
Deutsch
Checkbox: Organisations-UIDs im Page-Subtitle der DienstleistungsOrdner (manuell eintragen!!)?
Feldbezeichnung (Englisch)
cm_page_subtitle_contains_organisation_uid
Wert
Nur für sehr große Kommunen, der Schalter sollte standardmäßig nicht gesetzt werden (Erklärung folgt)
Version
Ab 4.0.1
Deutsch
UID des Ordners 'Räumlichkeiten'
Feldbezeichnung (Englisch)
cm_building_folder_uid
Wert
Muss ab Version 4.0.1 gepflegt werden für den Mitarbeiter-Position- Raum-Wizard!
Version
Ab 4.0.1
Deutsch
Zielmailadresse für Benachtrichtigungen im Workflow (als Kontrollinstanz)
Feldbezeichnung (Englisch)
cm_target_email
Wert
Email-Adresse des Mandanten-Administrators oder des Musteranlien- Beauftragten
Version
Ab 3.0.0
Deutsch
Typ der Kommune
Feldbezeichnung (Englisch)
cm_community_type
Wert
Regionale Zuordnung
Version
Ab 3.0.0
Die Tabelle tx_civserv_conf_mandant ist die zentrale Konfigurations-Tabelle für O.S.I.R.I.S. (neben den Mandanten TS- Templates, s.o.). Wenn im Nachhinein Änderungen an dieser Tabelle vorgenommen werden, verhindert manchmal die Session, dass das FE entsprechend aktualisiert wird. In diesem Falle sollte man in in der Datei
civserv/pi1/class.tx_civserv_pi1.php
hinter jede session_start() Anweisung eine session_destroy() Anweisung setzten, damit die Mandantenkonfiguration neu eingelesen wird. Sobald die Änderungen im FE angekommen sind, kann session_destroy wieder raus genommen werden.
Template Konfiguration¶
Im Virtuellen Rathaus O.S.I.R.I.S gibt je nach Installation mindestens 3 TypoScript-Templates
Virtuelle Verwaltung¶
Name im Verzeichnisbaum
Virtuelle Verwaltung
Typ
Ordner
Template-Name
Mastertemplate
Is Root
x
Relevanz
O.S.I.R.I.S. - choose community¶
Name im Verzeichnisbaum
O.S.I.R.I.S. - choose community
Typ
Seite
Template-Name
Portaltemplate
Is Root
x
Relevanz
Nur für Mehrmandanten-Betrieb
Webseiten (Mandant Musterstadt)¶
Name im Verzeichnisbaum
Webseiten (Mandant Musterstadt)
Typ
Ordner
Template-Name
Template Mustestadt
Is Root
Relevanz
Ggfs gibt es noch weitere Templates, etwa für eine Seite in einer zweiten Sprache oder weitere Mandanten-Templates.
Für die Konfiguration von Menüs und Layout sind vor allem die Mandanten-Templates von Bedeutung.
Step 1:
*Master* *Template* *–* befindet sich aufdemOrdner 'virtuelle Verwaltung' (dem root-Ordner des gesamten virtuellen Rathaus).
- Das Master Template braucht nicht editiert werden, es trägt die drei Häkchen für das Root-Template und für Clear Constants und Clear Setup.
- Beim Master Template müssen unter Include static (from extensions) 'css styled content' und 'Civil Services' ausgewählt sein.
- Alle anderen Felder können leer bleiben. Ggfs kann im Setup Spam Protection eingerichtet werden.
Step 2:
*Portal Template* – befindet sich auf der Seite O.S.I.R.I.S. portal entry,
kann i.d.Regelvernachlässigtwerden, wird nur gebraucht wenn man eine Portal-Einstiegsseite für O.S.I.R.I.S. im Mehrmandantenbetrieb darstelllen möchte.Für die Werte die in dem Code-Beispiel in eckigen Klammern dargestellt sind, setzen sie die entsprechenden UID-Werte aus Ihrem Seitenbaum.
In jedem Fall sollten hier nur die Felder Constants und Setup bearbeitet werden.
:underline:`**Constants**`
pageid = [123]
cache_services = 1
community_choice = 1
pageid = die ID der Seite 'O.S.I.R.I.S. - choose community' - die Konstante 'pageid' kann beim Portal Template auch weggelassen werden!
:underline:`**Setup**`
plugin.tx_civserv_pi1._DEFAULT_PI_VARS.community_id= choose
Step 3:
*Template Verwaltung 1* – befindet sichauf dem Sysordner ' Webseiten'
Hier nur „Constants“ editieren, die Werte müssen mit denen aus der Mandantenkonfiguration übereinstimmen.Für die Werte die in dem Code- Beispiel in eckigen Klammern dargestellt sind, setzen sie die entsprechenden UID-Werte aus Ihrem Seitenbaum.
Minimal müssen eingetragen werden:
:underline:`**Constants**`
pageid = [129]
fulltext_search_id = [130]
cache_services = 1
community_choice = 0
community_id = [11000000]
pageid = die ID der Seite ' Virtuelle Verwaltung' (nicht der Sysordner sondern die Seite - befindet sich im Sysordner Webseiten )
f ulltext_search_id = die ID der Seite 'Volltextsuche'
community_id = Nummer zu eindeutigen Identifizierung des Mandanten (kann zb. aus www.orte.de entommen werden, Berlin hat zum Beispiel die deutschlandweit eindeutige Gemeindekennziffer 11000000)
Layout-Konfiguration der Extension CIVSERV¶
CIVSERV standalone¶
O.S.I.R.I.S ist so aufgebaut, dass es eigenständig mit seinem eigen Menü, welches automatisch generiert wird, und mit einem eigenen Layout laufen kann. Die einzige Frontend-Seite ist dann die Seite „virtuelle Verwaltung“ (im Ordner 'Webseiten' eines jeden Mandanten).Die Menü- Einträge sind über das Mandanten-TS-Template (auf dem Ordner Webseiten) konfigurierbar (Constants-Feld), zur Verfügung stehen die Optionen:
menuServiceList = 1
menuCircumstanceTree = 1
menuUsergroupTree = 1
menuOrganisationList = 0
menuOrganisationTree = 1
menuFormList = 1
menuTop15 = 1
menuEmployeeList = 0
Das Beispiel zeigt die Standardkonfigurartion für das Hauptmenü, wenn im Mandanten-TS-Template keine menu-Konfiguration eingetragen wird, dann werden die Menüpunkte entsprechend der obigen Auswahl angezeigt.
Weitere Konfigurationsmöglichkeiten auch für die Stichwortsuche und die ServiceNavagation sind der Datei civserv/ext_typoscript_constants.txt zu entnehmen.
CIVSERV in bestehendes Template einbinden (BeispielSzenario von Thomas Gottschlich)¶
Für gewöhnlich existiert bereits eine Seitenstruktur inkl. Template, zum Beispiel eine kommunale Homepage und man möchte das virtuelle Rathaus in die bestehende Struktur und das Corporate Design der Homepage einbinden.
Step 1:
Wenn man CIVSERV in dieses Template einbinden möchte, muss man zunächst das Plugin Virtuelle Verwaltung auf der entsprechenden Seite einfügen (hier Bürgerservice ).
Seite Bürgerservice mit Plugin CIVSERV¶
Step 2:
Anschließend ist die entsprechende pageID in den Constants einzutragen:
- Webseiten – Templateverwaltung 1 – Constants
- O.S.I.R.I.S. portal entry – Portaltemplate – Constants
Template-Verteilung
Step 3:
Häufig werden Menus im TYPO3 aus der Seitenstruktur heraus erzeugt. (--> 2004, Meyer, Deutsche TYPO3-Dokumentation v.2.0, http://www.mittwald.de/fileadmin/pdf/dokumentation.pdf, S.64ff) Das bedeutet auch, dass die erzeugte Seite (hier Bürgerservice ) mit dem Plug-In bereits im Menu angezeigt wird.
Step 4:
Nun sind die Verlinkungen aus dem Original-Template zu kopieren und mit diesen unterhalb der erzeugten Seite Shortcuts anzulegen.
Verlinkung des virtuellen Rathaus mit Navigation der Homepage
Die Shortcuts sollten nun ebenfalls im Menu des FE auftauchen.
CIVSERV einbinden - Optionen¶
Es sind auch andere Möglichkeiten denkbar, O.S.I.R.I.S. in eine bestehende Website zu integrieren:
- es können auch interne Seitenlinks statt der Shortcuts verwendet werden.
- Die Startseite der Extension CIVSERV kann auch so angepasst werden, dass sie die Startseite der Homepage imitiert – a la Mimikri. Das bietet sich vor allem an, wenn sich die Homepage und das virtuelle Rathaus auf verschiedenen Servern befinden.
Das Layout von O.S.I.R.I.S. anpassen:¶
Das gesamte Layout von O.S.I.R.I.S. wird gesteuert über:
- eine zentrale css-Datei: civserv/templates/css/screen.css
- ein zentrales html-Template: civserv/templates/index.html
- verschiedene smarty-Templates, die die unteschiedlichen Ansichten wied ergeben:civserv/templates/service.tpl.htmlcivserv/templates/service_l ist.tpl.htmlcivserv/templates/organisation.tpl.htmlusw.
Das Layout kann für jeden Mandanten im System überschrieben werden. Dazu muss eine Kopie von screen.css im Pfad des Mandanten abgelegt werden, z.B.
filedmin/civserv/1100000/templates/css/musterstadt.css (1100000 sei die GKZ von Musterstadt, musterstadt.css sei eine Kopie von screen.css)
Weiterhin sollte eine Kopie des zentralen html-design-Templates in den Pfad
filedmin/civserv/1100000/templates/musterstadt.html (musterstadt.html sei eine Kopie von index.html)
gelegt werden.
Diese Dateien können dann nach Belieben angepasst werden .
Gleichzeitig müssen im Setup des Mandaten-TS-Templates die Pfade zu den neuen Layout-Dateien gesetzt werden:
page.includeCSS >
page.includeCSS{
file100 = fileadmin/civserv/1100000/templates/css/musterstadt.css
file100.title= individual style
file100.media=screen
und:
page.10.template.file = fileadmin/civserv/1100000/templates/musterstadt.html
Es können dort auch mehrere verschiedene css-Dateien angegeben werden. Die müssen dann entsprechend eingebunden werden.
FAQ¶
Updates of CIVSERV (english):¶
- After each update via the TER you should check if a new field has been added to the configuration of the clients (Mandanten) in tx_civserv_conf_mandant.
- After each update via the TER you should go to the install tool and run the database analyser -> compare to ensure that new fields are added to the database
Weblinks¶
- Weitere Dokumentationen und Anleitungen http://www4.citeq.de/O.S.I.R.I.S./doc/
- Beispiel-Site (1 Mandant, standalone) http://www4.citeq.de/osiris_demo/
- CIVSERV Mailinglist http://lists.netfielders.de/cgi- bin/mailman/listinfo/typo3-project-civserv
CIVSERV Datenmodell¶
Die Zusammenhänge der einzelnen Objekte im CIVSERV lassen sich am besten anhand des Datenmodells verstehen.
Versioning and Workspaces¶
CIVSERV >= 4.1.3 (in combination with Typo3 >= 4.x) supports workspace and versioning – in an experimental status though.
Further documentation of civserv and workspaces will follow when there is reliable experience from a mandant using this feature.
Tutorial¶
Umfangreiche Schulungsunterlagen (auf deutsch) können bei der citeq downgeloaded werden: http://www4.citeq.de/O.S.I.R.I.S./doc/
Known Problems¶
Manchmal gibt es Probleme bei der Stapel/Massen-Bearbeitung von Datensätzen im BE.
ToDo Liste¶
Die Versionierung von Dienstleistungs-Datensätzen mit Workspaces muss noch unter verschiedenen Bedingungen gestestet werden
Changelog (only major changes in english):¶
Version 3.x¶
Fixed 'Region bug':¶
First of all: this feature will only work in sites with several mandants/clients/communities belonging to several different regions!
At the very bottom of the service-form you may select another region to which you want to offer this service. The idea is that a county administration offers some of its services, i.e. car registration procedures, to the smaller regions/clients configured in the same site (because obviously small villages do not offer these services themselves). If you do chose to offer your service to another region via the above-mentioned select-field, the communities / clients belonging to that region will find the service in the folder 'external services' in their pagetree and then they can chose to make it visible for their own virtual town hall.
The bug: It was possible to chose your own region in the select field, which led to to an accumulation of redundant services in your folder 'external services' – this is no longer possible now.
Version 4.0.0.¶
New wizard for service-organisation-relations¶
This wizard makes it much more comfortable to choose a responsible organisational unit for a given service.
New feature for bilingual O.S.I.R.I.S. sites¶
First of all this is only a limited realisation of a bilingual site!
To make it work you need a second page (doktype 1) for the display of the english content, next to the main display-pagethe second or alternative web-page has to carry the plugin civserv and its own TS- extension-template.
Alternative page / extension TS template – constants:
language = default //defaut = english!
pageid = 1417 //uid of second-language-content
alternative_page_id = 280 //uid of main page
fulltext_search_id = //leave empty!!!
# Enable/disable menu-items //you must disable all menu entries exept service-list!!
menuServiceList = 1
menuCircumstanceTree = 0
menuUsergroupTree = 0
menuOrganisationList = 0
menuOrganisationTree = 0
menuFormList = 0
menuTop15 = 0
menuEmployeeList = 0
Alternative page / extension TS template – setup:
page.config.language >
page.config.language = {$language}
page.10.template.file = fileadmin/civserv/{$community_id}/templates/index_english.html
leftmenu.1.NO.allWrap =|*||*| <li> | </li> || <li class="german"> | </li>
leftmenu.1.ACT.allWrap =|*||*| <li> | </li> || <li class="german"> | </li>
page.10.marks.MENU < leftmenu
Main page / TS template – constants:
pageid = 280 //uid of main page
alternative_page_id = 1417 //uid of second-language-content
Further you need
a service folder for the services in the second language (one only!). It has to be included in the Mandant's Configuration, same as the alternative_page_id
an alternative HTML-start-page (copy of index.html, with all the static content translated into alternative language of your choice) which has to be referred in the setup field of the extension TS template
New wizard for employee-position-room-relations:¶
Choose which room will be displayed for your employee by selecting a building first, then then floor and then one of the rooms on that floor
3 new wizards for the selection of positions in the service form¶
select a position via its name (name of the employee occupying that position is also displayed in choice field)
select a position via the name of the employee (name of the position is also displayed)
select from a limited number of positions: only those which are related to the responsible organisational unit. (the service- organisation relation(s) have to be saved first)
You can further limit the number of positions availble to the editor of a service, depending on his or her view of the pagetree. It is kind of a „dirty trick“ but it might come handy for administrations with a very big staff, say over 1000 postions. There are two conditions you have to fulfill for this limitation to work (will have an effect on the first two wizards, and only if the actual be_user is an editor with a limited webmount. Administrators will still get to see all of the postions):
- Write the uid of the related organisation into the subtitle field of the service folders.
- Tick the checkbox in the client configuration at „page_subtitles of service folders carry organisation_uids“
What happens?:
If there is a service folder (i.e. 'services/police administration') with theuid 10 which contains services related to the organisational unit with the uid 55 ('police') you write '10' into the subtitle-field of the page with the uid 55 (you have ticked the above mentioned checkbox of course)
An editor who has access to the folder with the uid 10 in his page tree will see all postions belonging to the organisational unit with the uid 55 when he edits a service and wants to chose a contact person.
The whole mechanism works additively: The more service folders (with an accordingly manipulated subtitle field) the editor has in his page tree, the more positions he gets to see.
New checkbox for display of organisation supervisor¶
You can chose wether you want to display the names of the organisation-supervisors in the organisation detail view – or not. Just tick the checkbox on the organisation-form.
Version 4.2.0.¶
This is version of the extension CIVSERV supports the new WS_Versioning feature of typo3_src >= 4.0.
How to use workspaces in O.S.I.R.I.S. will be explained in the future in an extra chapter of this manual. You may also chose to run the extension without defining any workspaces.
There are also some general new features:
New fields in serveral forms:¶
New fields in forms form:¶
a
Field
b
Function
c
Mandatory?
d
Relevant for FE?
a
Organisation code
b
Many organisations have codes like 12, 30, 66 etc. You can mark the code of the organisation issuing the form here.
c
No
d
no!
a
Internal Form Name
b
Some forms have non-human-readable internal names.
c
No
d
no!
a
Category
b
If you have integrated a folder with categories into your pagetree, you can chose a form-category here.
c
No
d
Yes!
In FE the forms will appear sorted by categories.
a
Target
b
If you chose to integrate your own html-forms (based on content type html) you can tick this checkbox to have them open in the same window
c
No
d
yes!
New fields in buildings form:¶
a
Field
b
Function
c
Mandatory?
d
Relevant for FE?
a
Building name to show
b
If he building data have been imported from an external database, they may have non-human-readable names. In that case you can overwrite them with nice names here.
c
No
d
yes!
a
City-Map-Link
b
Textfield into which you can paste an url pointing to the citymap (i.e. Google.maps)
c
No
d
yes
Further new features¶
Services form:
- wizard for forms-by-categories (in a community with say over 1000 form-records this may be helpful)
- all select-fields are only available in the form, after it has been saved at least once. Instead of the select fields for other records (i.e. Positions) an info-text is displayed while a service record has not yet been published
employees form:
the select field for positions is only available, after the employee- record has been saved at least once. Instead of the select field an info-text is displayed
service-positions form:
this is only relevant for civserv running with typo3_src >= 4.0: you can only edit a service-position-record when the according service has the status 'published'. This feature is important when you are working within custom workspaces.
Folder rooms:
The rooms are now displayed in BE with information about building and floor where they are located. This helps the editors to identfy rooms in the BE list view!