In faktur:box Archive kann eine System-Dokumentation mit dem faktur:box-Wiki in nur wenigen Klicks automatisch über die Funktion Serverdokumentation erstellen generiert und aktualisiert werden. Auf dieser Seite finden Sie Anleitungen zu den Einstellungen, die für die Einrichtung notwendig sind, sowie zur Durchführung der automatischen Dokumentation.
Um eine reibungslose Durchführung der automatischen Dokumentation zu garantieren, muss das faktur:box-Wiki verwendet werden.
¶ Umfang der automatischen Dokumentation
Mit der Funktion Serverdokumentation erstellen werden alle Einstellungen der folgenden Bereiche im faktur:box-Wiki automatisch dokumentiert:
- Systeme
- Authentifizierung
- Objekttypen
- Regeln und Rechte (mit Benutzerübersicht)
- Lookup
- Workflows
- Workflowrollen
¶ Einstellungen im faktur:box-Wiki
Bevor Sie mit der Einrichtung anfangen müssen sie auf die Seite docuvita.Server und das Schlagwort fbadocumentation vergeben. Dafür gehen Sie auf das Verzeichnis welches hier angegeben ist.
Alternativ könne sie auf die Webseite https://[URL Ihres faktur:box-Wikis]/fd-documentation/docuvita-server.
Nun drücken Sie rechts oben auf das Papiersymbol mit dem Stift um das Dropdown Menü mit den Seitenaktionen zu öffnen. Wenn Sie auf Bearbeiten drücken werden Sie auf die Einstellungen der Seite weitergeleitet.
Auf der Bearbeitungsseite können Sie dann rechts oben auf das Symbol mit der Beschriftung Seite drücken um ein neues Fenster zu öffnen. Im unteren Bereich unter dem Reiter Info können Sie das Schlagwort fbadocumentation eingeben und der Seite hinzufügen. Anschließend können Sie sich der Einrichtung der automatischen Dokumentation widmen.
Für die Einrichtung der automatischen Dokumentation, müssen Sie in Ihrem faktur:box-Wiki, in dem die Dokumentation eingebettet werden soll, einen API-Key anlegen. Hierfür muss der Benutzer Admin-Rechte besitzen. Um in den Administrations-Bereich zu gelangen, klicken Sie auf das 
-Symbol oben rechts in der Navigationsleiste.
In der linken Navigationsleiste finden Sie unter System den Punkt API-Zugriff:
Hier finden Sie folgende Oberfläche:
Aktivieren Sie nun den API-Zugriff, indem Sie auf die Schaltfläche API AKTIVIEREN klicken:
ACHTUNG
Die Funktion Serverdokumentation erstellen funktioniert nur, wenn der API-Zugriff aktiviert ist!
Erstellen Sie nun einen neuen API-Key, indem Sie auf die Schaltfläche NEUER API-SCHLÜSSEL klicken. Nun erscheint das folgende Fenster:
Vergeben Sie für den API-Key einen beschreibenden Namen, wie z.B. "Automatische Dokumentation". Bitte beachten Sie, dass nach dem Ablauf des API-Keys ein neuer API-Key erstellt werden muss, um die Funktion Systemdokumentation erstellen weiter benutzen zu können. Wählen Sie dementsprechend den gewünschten Gültigkeitszeitraum aus.
Der Haken bei Voller Zugriff muss gesetzt sein, damit die Funktion Systemdokumentation erstellen funktionieren kann!
Klicken Sie auf die Schaltfläche GENERIEREN, um den API-Key zu erstellen. Nun erscheint das folgende Pop-Up:
Folgen Sie den Anweisungen und sichern Sie falls notwendig den gezeigten API-Key. Halten Sie den API-Key bereit, um diesen in den nächsten Schritten in die Einstellungen in faktur:box Archive einzufügen.
Nachdem Sie auf SCHLIESSEN geklickt haben kann dieser API-Key nicht mehr aufgerufen werden! Sollten Sie den API-Key "verlieren", muss ein neuer API-Key angelegt werden.
¶ Einstellungen in faktur:box Archive
¶ API-Benutzer
Für das Anlegen des Wiki-Cloud-Services muss ein Benutzer mit Authentifizierungsmethode API (API-Benutzer) vorhanden sein, der über alle Zugriffsrechte verfügt.
Falls kein API-Benutzer bekannt ist, sollte zuerst überprüft werden, ob schon ein API-Benutzer vorhanden ist. Falls nicht, muss ein API-Benutzer angelegt werden.
Eine ausführliche Anleitung zur Aktivierung der API-Authentifizierung und zum Anlegen eines API-Benutzers finden Sie hier.
Achten Sie bei der Erstellung eines API-Benutzers auf folgende Einstellungen:
Nach der Erstellung muss überprüft werden, ob der API-Benutzer über alle Zugriffsrechte verfügt. Fehlende Zugriffsrechte müssen dem API-Benutzer unbedingt erteilt werden!
¶ Wiki-Cloud-Service anlegen
Nachdem Sie einen API-Key für Ihr faktur:box-Wiki erstellt haben, müssen Sie in faktur:box Archive noch einen Cloud-Service anlegen, um die Funktion Systemdokumentation erstellen verwenden zu können. Hierfür brauchen Sie einen Benutzer mit Admin-Rechten.
Unter Administration finden Sie den Punkt Cloud-Services:
Um einen neuen Cloud-Service anzulegen klicken Sie auf Hinzufügen:
Es öffnet sich nun die folgende Ansicht:
Vergeben Sie hier einen beschreibenden Namen für den Cloud-Service, wie z.B. "Wiki". Bei Plugin wählen Sie aus dem Drop-Down-Menü den Punkt "wiki" aus.
Nun öffnet sich die Konfiguration für das Plugin:
| Feld | Beschreibung |
|---|---|
| Wiki Adresse | wird auf https://[URL Ihres faktur:box-Wikis]/graphql gesetzt (ohne eckige Klammern) |
| Wiki Apikey | der API-Key Ihres faktur:box-Wikis |
| MailArchive Adresse | (optional) Adresse des MailArchives |
| MailArchive Apikey | (optional) Api-Key des MailArchives |
| faktur:box Archive Adresse | Adresse Ihres faktur:box Archive-Systems ohne /web |
| faktur:box Archive Apikey | Api-Key eines im System vorhandenen API-Benutzers, der alle Zugriffsrechte hat |
| Robot Adresse | wird standardmäßig auf https://fdcustomfeatures.fakturbox.io/robot/webhook/86dc2980-3e15-4f4b-b54d-e6531703acd4 gesetzt |
Der API-Benutzer, der hier verwendet wird, muss sämtliche Administrator-Rechte haben. Fehlen Zugriffsrechte, so kommt es beim Generieren der Dokumentation zu Fehlern!
¶ Generieren und Aktualisieren der automatischen Dokumentation
Sobald alle Einstellungen vorgenommen wurden, kann die automatische Dokumentation durchgeführt werden. Hierzu finden Sie unter Administration > Systeme die Schaltfläche Serverdokumentation erstellen. Mit Klick auf diese Schaltfläche wird die Dokumentation Ihres Systems nun in Ihrem faktur:box-Wiki automatisch generiert.
