BizCortex Dokumentation

Reiter Quellen: woher Aktualisierungen kommen

Dokumente, Softwarereleases, Supporttickets und Leserfragen als Quellen für Änderungsvorschläge anbinden.

Quellen speisen den sich selbst aktualisierenden Teil von Handbücher. BizCortex liest, was eine Quelle liefert, prüft, ob es die Benutzerinformation betrifft, und entwirft in diesem Fall einen Änderungsvorschlag. Ohne Freigabe wird nichts übernommen. Der Reiter zeigt eine Karte je Art von Quelle.

Reiter Quellen: woher Aktualisierungen kommen
Bildschirmfoto dieser Ansicht

Wer kann das nutzen

  • Inhaber und Administrator können Quellen hinzufügen, einrichten, befüllen und abrufen
  • Alle mit Leserecht für Quellen in Handbücher können ansehen

Schritte

  1. 1. Eine Quelle hinzufügen

    Klicken Sie auf einer Karte auf die Plusschaltfläche, zum Beispiel "GitHub Releases hinzufügen". Füllen Sie den Dialog aus und speichern Sie.

  2. 2. Den Webhook einrichten (GitHub und GitLab)

    Nach dem Anlegen einer GitHub oder GitLab Quelle zeigt BizCortex die Webhook URL und das Webhook Secret. Das Secret wird nur jetzt angezeigt; kopieren Sie es, bevor Sie den Dialog schließen. Tragen Sie URL und Secret in den Webhook Einstellungen des Repositorys ein und wählen Sie das Ereignis für Releases. Neue Releases kommen dann sofort an.

  3. 3. Zugangsdaten hinterlegen

    Klicken Sie bei einer GitHub, GitLab oder Ticketquelle auf "Zugangsdaten" und hinterlegen Sie ein API Token mit Lesezugriff. Klicken Sie auf "Token speichern". Ein gespeichertes Token wird nie wieder angezeigt; ein neues ersetzt es.

  4. 4. Dokumente hochladen

    Legen Sie bei einer Quelle vom Typ Dokumente PDF, DOCX, Markdown oder Textdateien (je bis 50 MB) im Uploadbereich ab. BizCortex zeigt, wie viele Einträge erfasst wurden.

  5. 5. Abrufen, pausieren und Einträge prüfen

    Klicken Sie auf "Jetzt abrufen", um eine Quelle sofort zu lesen. Klicken Sie auf "Pausieren", um eine Quelle anzuhalten, und auf "Fortsetzen", um sie wieder zu starten. Klicken Sie auf "Einträge", um zu sehen, was die Quelle geliefert hat und was daraus wurde.

  6. 6. Eine Quelle löschen

    Klicken Sie auf die Löschschaltfläche und bestätigen Sie. Bereits erstellte Vorschläge bleiben erhalten.

Felder und Optionen

Dokumente

Änderungsmitteilungen, Servicebulletins oder Konstruktionsänderungen hochladen. Dieselbe Datei zweimal hochzuladen fügt nichts hinzu.

GitHub Releases

Neue Softwarereleases einer Steuerung oder App. Geben Sie das Repository als owner/name ein. Optional: "Vorabversionen einbeziehen". BizCortex prüft alle 30 Minuten und nimmt zusätzlich den Webhook an.

GitLab Releases

Releases aus GitLab, auch selbst gehostet. Geben Sie das Repository und die "Serveradresse" ein (Voreinstellung gitlab.com).

Supporttickets

Gelöste Tickets aus Zendesk, Freshdesk, Zammad oder Jira. Wählen Sie das System und optional einen Filter, zum Beispiel ein Schlagwort oder eine Ansicht. Standardmäßig werden nur gelöste Tickets der letzten 30 Tage gelesen, geprüft alle 60 Minuten. Ein Ticket mit einer neuen Antwort wird erneut gelesen.

Offene Leserfragen

Fragen, die die Anleitung nicht beantworten konnte, werden jede Nacht zu Vorschlägen für Lücken gebündelt. Jede Anleitung kann nur eine solche Quelle haben.

Status

Aktiv, Pausiert oder Fehler. Der letzte Fehler wird an der Quelle angezeigt. Eine Quelle mit Fehler wechselt nach dem nächsten erfolgreichen Abruf zurück auf Aktiv.

Zähler

Einträge insgesamt und neue Einträge sowie wann die Quelle zuletzt abgerufen wurde oder "noch nie abgerufen".

Status der Einträge

Neu, Nicht relevant, Verarbeitet, Duplikat oder Fehler.

Gut zu wissen

  • Personenbezogene Daten werden entfernt, bevor ein Eintrag gespeichert wird und bevor ein KI Modell ihn sieht: EMail Adressen, Telefonnummern, IBANs, Namen nach Grußformeln, Signaturblöcke, Erwähnungen und jeder Name, den das Helpdesk dem Ticket beigefügt hat.
  • Ein Eintrag wird nur dann zu einem Vorschlag, wenn er relevant ist und die Benutzerinformation betrifft. Sehr unsichere Entwürfe werden verworfen.
  • Hochladen und Abrufen brauchen das Schreibrecht für Quellen in Handbücher; Hinzufügen, Pausieren und Löschen von Quellen sowie das Hinterlegen von Tokens brauchen das Verwaltungsrecht für Quellen in Handbücher. Standardmäßig haben beide Inhaber und Administrator.

Verwandte Seiten