Mit dem Add-on Dokumente können innerhalb von i-doit umfangreiche Textdokumente erstellt und gestaltet werden. Diese Dokumente können mit den Informationen aus der IT-Dokumentation auf vielfältige Weise ergänzt werden. Betriebshandbüchern, Übergabeprotokollen, Notfallplänen u.v.m. stehen somit nichts mehr im Wege.

Inhaltsverzeichnis

Konfiguration

Eine technische Konfiguration des Add-ons ist nach der Installation nicht notwendig.

Rechtevergabe

Nach der Installation verfügen Personengruppen und Personen aus i-doit über keine Berechtigungen um auf das Add-on zuzugreifen. (ausgenommen: Standard-Personengruppe admin)

Die Rechte können über VerwaltungRechtesystem → Rechtevergabe → Dokumente vergeben werden.

Hier können folgende Berechtigungen definiert werden: 

  • Dokument
  • Vorlage
  • Kapitel
  • Online Repository

Über die Bedingung Dokument kann die Berechtigung zur Bearbeitung einzelner oder aller Dokumente vergeben werden.

Die Bedingung Vorlage erlaubt die Erzeugung und Bearbeitung von Dokumentenvorlagen.

Ähnlich verhält es sich mit der Bearbeitung von Kapiteln. Der Zugriff auf diese wird über die Bedingung Kapitel möglich.

Um das Online Repository einzusehen und Inhalte herunterladen zu können, verwende bitte die Bedingung Online Repository.

Verwendung

Nach der Installation und der Konfiguration der Rechte steht das Add-on unter Extras → Dokumente zur Verfügung. 

WYSIWYG-Editor

Die Bearbeitung der Inhalte erfolgt generell über einen sogenannten WYSIWIG-Editor. Dies steht für „what you see is what you get“ und bedeutet, dass die Inhalte in der Bearbeitungsansicht bereits der Ansicht im fertigen Dokument entsprechen.

Eine Darstellung, in der Design und Inhalt voneinander getrennt werden ist ebenfalls möglich. Hierfür steht dir die Schaltfläche Quellcode zur Verfügung. Neben den bekannten Schaltflächen zur Formatierung der Texte existieren Schaltflächen zur Einbindung von aktuellen Informationen aus i-doit in das Dokument.

Hier werden Platzhalter eingefügt, die später automatisiert die gewählten Attribute an die entsprechende Stelle im Dokument ergänzen. Es ist möglich, Eigenschaften des Haupt-Objekts, dem das Dokument zugehörig ist und Attribute aus zuvor definierten Objekten einzubinden. Außerdem können Reports eingefügt und Standard-Inhalte (Autor, Datum, etc) als sogenannte Templates ergänzt werden.

Dokumentvorlagen

Dokumentvorlagen bieten die Grundlage, auf deren Basis die Dokumente erzeugt werden. Wenn du eine neue Vorlage erzeugst, vergebe im ersten Schritt eine Bezeichnung und wähle die Kategorie des Dokuments.

Vorab ist es außerdem möglich, Kopf- und Fußzeile zu bearbeiten und Einstellungen zum Inhaltsverzeichnis, den Seitenabständen und den Seitenzahlen vorzunehmen.

Nachdem die Vorlage des Dokuments angelegt wurde, steht die Kapitelübersicht zur Verfügung. Hier ist es möglich, einzelne Kapitel zu bearbeiten, deren Sortierung anzupassen und diese auch wieder zu löschen. Weiterhin kannst  du untergeordnete Kapitel erzeugen, welche sich in einer tieferen Ebene befinden. Die Schaltflächen für diese Vorgänge werden eingeblendet, wenn du mit der Maus über das entsprechende Kapitel fährst.

Die Verschiebung erfolgt über die Drag-and-Drop-Funktionalität.

Bereits erzeugte Dokumentvorlagen werden gemäß ihrer Kategorie im Baum-Menü auf der linken Seite einsortiert.

Eine Dokumentenvorlage kann über die Schaltfläche Dokumentvorlage exportieren heruntergeladen werden. Diese Vorlagen können in beliebige i-doit Installationen, welche über das Dokumente-Add-onl verfügen, importiert werden.

Der Import kann in der Vorlagenübersicht einer Kategorie mit der Schaltfläche Dokumentenvorlage importieren durchgeführt werden.

Dokumente erzeugen

In den Dokumenten können neue Dokumente mit den zuvor erstellten Vorlagen und den Attributen ausgewählter Objekte erzeugt werden.

Über die Schaltfläche Neu wird das Overlay aufgerufen, in dem das zu verwendende Template sowie die gewünschten Objekte ausgewählt werden. Für jedes ausgewählte Objekt wird ein eigenes Dokument erzeugt. Bei diesem Objekt handelt es sich um das Haupt-Objekt, dessen Informationen die entsprechenden Platzhalter im Dokument ersetzen. Zusätzlich kann eine Beschreibung hinterlegt werden, um zusätzliche Informationen zum Dokument verfügbar zu machen.

Nachdem die Dokumente generiert wurden, können diese über die Schaltflächen in den Formaten HTML und PDF heruntergeladen und gespeichert werden.

Dokumente automatisch erzeugen

Um neue Revisionen eines Dokuments automatisch zu erzeugen, kann der i-doit Controller genutzt werden. Mit dem Handler document und dem Parameter -t <ID des Dokuments> wird auf diese Weise eine Automatisierung im Hintergrund ermöglicht. Der Parameter -t nimmt eine kommaseparierte Liste von IDs entgegen:

./controller -u admin -p admin -i 1 -v -m document -t 1,2,3

Online Repository

Das Online-Repository ist eine Anlaufstelle, die Vorlagen für verschiedene Dokumenttypen anbietet. Dieses Repository wird in regelmäßigen Abständen um weitere Standard-Dokumentvorlagen erweitert, die du über die Importieren-Funktion online abrufen und in deine i-doit Installation integrieren kannst.

Releases

VersionDatumChangelog
1.3.331.07.2019
[Bug] Category "e-mail" description field no outpot in a table

[Bug] Placeholder for creation date/revision date also contains time of creation
[Bug] Export of enumerated fields from the wysiwyg editor is not possible
1.3.205.04.2019
[Bug] Bad behavior with add-on license
1.3.101.02.2019
[Bug] Empty table columns can trigger PHP warnings during revision creation
[Bug] Fix permission to import template from repository
1.305.12.2019
[Improvement] Chapter headlines without numbers
[Improvement] License Key
[Improvement] Added the possibility of using real object data when previewing a document template
[Improvement] Option for displaying category entries with status "archived" or "deleted"
[Improvement] Edit categories
[Improvement] Documents via console
[Improvement] Comment on revision
[Improvement] User defined template variables
[Improvement] Document Caching
[Improvement] Template locking
[Bug] Not able to set single rights to document categories
[Bug] Headers for the attributes "Host" and "Primary Access URL" are not displayed correctly
[Bug] Only one entry of category "contract assignment" is displayed in documents
[Bug] Wrong presentation of frequency attributes
[Bug] Primary host address is not shown correctly
[Bug] Vertical alignment of table cell content ignored in PDF file
[Bug] Header and footer ignore side clearances (top and bottom)
[Bug] Cursor locked in placeholder
[Bug] Editing size of pictures in editor
[Bug] Right Margin Of Footer Is Incorrect
[Bug] Button Text "Close popup" In "Duplicate document template" Not Conform
[Bug] The position in the rack is not displayed in the tabular view
[Bug] Documents Add-On: Organisation are displayed with the object-id
[Bug] Documents Add-On: cpu is not displayed
[Bug] Documents Add-On: Fiber Channel capacity is not displayed
[Bug] Bigger Reports Are Cut And Displayed Not Correctly Formatted
[Bug] Footer uses margins of document and is placed over header on second page
[Bug] Docu: attribute last change is missing an exact time
[Bug] Doku: Template last change is missing the exact time
[Bug] Cannot create documents when one or multiple attribute assignments are missing
[Bug] SLA time values not usable
[Bug] Document titles are not displayed in the overview
[Bug] Report Compiler class outputs report as HTML
[Bug] PHP Fatal error when adding a document
[Bug] Additional line break between two lines
[Bug] no documents can be created after adding contact assignment
[Bug] After updating the administrators group has no rights to the add-on anymore
[Bug] When choosing a multivalue category the "show as table" setting should be set
[Bug] Improved HTML export
[Bug] New placeholders are not available in Templates
[Bug] The category "organization => person" is not available in the property selector
[Bug] Object browser fields of custom categories are not being displayed correctly
[Bug] Online repository can not be called with the configured proxy
1.2.113.08.2018
[Verbesserung]  Erstellung- und Änderungsdatum von Templates
[Verbesserung]  Logbucheintrag anlegen bei neuer Revision
[Verbesserung]  Dokumente: Parallele Revision multipler Dokumente
[Verbesserung]  Anzeige des Dokumente-Titels in der Dokumente-Ansicht
[Verbesserung]  Dokumente erhalten einen optionalen Titel
[Verbesserung]  Benutzerdefinierte Spaltenbreite für Tabellen
[Verbesserung]  Tabellen der Platzhalter formatieren
[Verbesserung]  Metadaten eines Reports in Vorlage übernehmen
[Verbesserung]  Platzhalter um neue Seite zu erzwingen
[Änderung]      In Kapitel-bearbeiten ist Button "Löschen" falsch, müsste "Abbrechen" sein
[Bug]           Reimplement variable reports
[Bug]           Fusszeile wird als PDF im Header ausgegeben
[Bug]           Dokumente: Quellcode wird in einem neuem Kapitel nicht gespeichert
[Bug]           Deckblatt der Vorlage wird nicht Dupliziert
[Bug]           Keine Angabe der Vorlagen-Bezeichnung und der Kategorie beim Vorlagen-Import
[Bug]           Löschen-Dialog ohne markierte Dokumentvorlagen irritierend
[Bug]           Fusszeile in der Vorschau entspricht nicht der Fusszeilendefinition
[Bug]           Zielfelder für das Verschieben von Kapiteln inkonsistent
[Bug]           Sonderzeichen werden falsch ausgegeben
[Bug]           Inhalte der Tabs zu "Aktuelle Version" und "Revisionen" verschoben
[Bug]           System Fehlermeldung nach Klick auf "Preview"
[Bug]           Verwaistes Dokument bleibt nach Löschen übrig
[Bug]           Repository wirft Fehler, wenn keine Internet-Verbindung besteht
[Bug]           Archivierte Kategorie-Einträge werden dargestellt
[Bug]           Datumsformat von Datumsangaben in benutzerdefinierten Kategorien im Dokument immer im Format YEAR-MONTH-DAY
[Bug]           Kapitel Drag&Drop funktioniert nicht einwandfrei
1.223.01.2018
[Verbesserung]  Nutzung von Reports mit Platzhaltern
[Verbesserung]  E-Mail-Adressen sollen als Links dargestellt werden
[Bug]           Attribut "Telefonnummer" aus Kategorie "Stammdaten (Personengruppen)" wird nicht ausgegeben
[Bug]           Nur erstes Element bei Dialog+ (Mehrfachauswahl) wird ausgegeben
[Bug]           Deckblatt wird erst ab 2. Revision erstellt
[Bug]           Button "Dokument aktualisieren / Revision erzeugen" aktualisiert weder Tab "Aktuelle Version" noch Tab "Revisionen"
[Bug]           Optionen werden nicht mit dupliziert
1.1.502.10.2017
[Verbesserung]  Objektbezug Option für Report-Einbettung
[Bug]           Dokumente können in einem Objekt nicht erstellt werden
[Bug]           Erfolgsmeldung beim Duplizieren einer Dokumentvorlage aber ohne Duplikaterstellung
[Bug]           Klick auf "Löschen" beim Editieren der Dokumentvorlage löscht diese
[Bug]           Verwendung von identischen Attributen unterschiedlicher Kategorien führt zu Überschreibung und doppelten Werten
[Bug]           Das Hochladen von Schriftarten soll nicht auf 0,5 Megabyte beschränkt sein.
[Bug]           Duplizierte Vorlage verliert Eigenschaften und wirft Warnung
[Bug]           Verschiedene Variablen werden nur als ID ausgegeben
[Bug]           Seitenzahlen werden nicht Korrekt dargestellt wenn mehrere Reports in einem Dokument zusammengeführt werden
[Bug]           Fonts werden in falschen Ordner hochgeladen
[Bug]           Gleichzeitiges Erstellen mehrerer Dokumente schreibt falsche Daten
[Bug]           Ohne WYSIWYG Editor können Vorlagen nicht gespeichert werden
[Bug]           Deckblatt wird nicht mit dupliziert
[Bug]           Beim erstellen einer neuen Dokumentenvorlage wird mit jedem Klick auf "Speichern" eine neue Vorlage angelegt
[Bug]           Beim PDF Export erscheint immer eine zusätzliche leere Seite
[Bug]           Überschriften werden nicht dargestellt, wenn das Inhaltsverzeichnis aktiviert ist
[Bug]           Inhaltsverzeichnis wird nicht dargestellt
[Bug]           Kapitelnummerierung wirkt sich auf die Sortierung der Kapitel aus
[Bug]           Dokumente lassen sich unter bestimmten Umständen nicht erstellen (Benutzerdefinierte Kategorien)
[Bug]           Fehler beim Erstellen eines Dokuments mit dynamischen Bildern
[Bug]           Optionen eines Dokuments werden verworfen
1.1.431.07.2017
[Bug]           Dokumente Add-on: Fußzeile wird auf letzter Seite eines Dokuments nicht dargestellt
[Bug]           Dokumente-Modul: Es werden gelöschte und archivierte Kontaktzuweisungen angezeigt
[Bug]           Seitennummern werden falsch hochgezählt, wenn kein Deckblatt genutzt wird
1.1.302.05.2017
1.1.2
[Bug]           Full index bricht mit Fehlermeldung ab
[Bug]           PHP Warnung beim Aufrufen von Report-Browser
[Bug]           Unnötiger "Warte"-Hinweis beim Import von Dokumentvorlage
1.1.112.04.2016
[Bug]           Fehler beim Duplizieren von Dokumentenvorlagen
[Bug]           Add-on Update: Fehler bei Migration der benutzerdefinierten Schriftarten
[Bug]           MySQL Fehlermeldung beim Erstellen eines Dokumentes
[Bug]           Fehler beim Aufruf eines Dokuments, das aus einer duplizierten Vorlage erstellt wurde
[Bug]           DOM Parsing Fehler beim Erstellen eines Dokuments
1.131.08.2015
[Bug]           Überschriften werden falsch platziert
[Bug]           Darstellung von Inline-Bildern aus Bilder Kategorie
1.0.331.08.2015
[Bug]           Ohne Berechtigung sind Bearbeitungs-Buttons pro Kapitel sichtbar
[Bug]           Link zum verknüpften Objekt öffnet sich nicht
[Bug]           Elemente ragen über die Seitenränder
[Bug]           Link zur Dokument-Vorlage funktioniert im Revisions-Widget nicht
[Bug]           Design vom Report-Widget unsauber
[Bug]           Wenn alle WYSIWYG Editor Funktionen in der Systemeinstellung aktiviert sind ist es nicht mehr möglich Objekte bzw. Kategorien in die Dokumentenvorlage zu verlinken.
[Bug]           Beim Ändern einer Variable im Dokumente-Modul wird die ursprüngliche Auswahl nicht nachgeladen
[Bug]           Umlaut in erzeugtem Dokumentennamen aus Dokumente-Modul funktioniert nicht
[Bug]           Einmal hochgeladene Bilder können nicht mehr gelöscht werden.
1.0.209.03.2015
[Bug]           SQL-Fehler beim Erstellen von Dokumenten
[Bug]           Kategorie-Tabs sind ineinander verschoben
[Bug]           In der Kategorie-Liste Dokumente funktioniert der Download einer PDF/HTML Datei nicht
[Bug]           Kategorie "Dokumente" auf der Übersichtsseite bewirkt die Anzeige einer weißen Seite
1.0.124.09.2014
1.017.09.2014Initiales Release