Konfiguration NinjaOne Documentation Tool

Diese Anleitung erklärt, wie Sie die Documentation-App in der NinjaOne-Konsole aktivieren und einrichten. Nach erfolgter Aktivierung finden Sie weitere Tipps und Best Practices auch in NinjaOne Documentation Management. 

Inhaltsverzeichnis

• Aktivieren Sie die Dokumentationsfunktion/-anwendung
• Dokumentationsvorlagen verwalten
  • Standardvorlagen importieren
  • Eine Dokumentvorlage erstellen
  • Dokumentvorlagen löschen
• Documentation-Checklisten
• Zugriffsverlauf für öffentliche Links
• Siehe auch 

Aktivieren Sie die Dokumentationsfunktion/-anwendung:

1. Navigieren Sie zu Verwaltung > Apps > Installiert > Dokumentation. 
   
2. Klicken Sie auf Aktivieren. 
   

Verwalten Sie Dokumentationsvorlagen:

Dokument(e) von CSV importieren

Mit dem Migrationstool können Sie die erstellten Vorlagen in der NinjaOne-Dokumentationherunterladen. Die heruntergeladenen Vorlagen können dann in andere Umgebungen oder Dokumentationstools importiert werden. Weitere Informationen finden Sie unter Dokumentation: Import über CSV mit Migrationstool - NinjaOne Dojo (zendesk.com).

Standardvorlagen importieren

NinjaOne bietet mehrere Standardvorlagen, die den Nutzen von Documentation maximieren sollen. So greifen Sie auf diese Vorlagen zu:

1. Rufen Sie die Documentation-App wie oben beschrieben auf. 
2. Klicken Sie auf der rechten Seite des App-Editors auf Vorlagen verwalten und wählen Sie dann Vorlagen aus der Bibliothek importieren.
   
   Das Modal für die Konfiguration der Standardvorlagen wird angezeigt. 
3. Sie können im Suchfeld per Schlüsselwort nach Vorlagen suchen oder die Liste der verfügbaren Vorlagen durchsehen. Klicken Sie das Kontrollkästchen neben den Namen der Vorlagen an, die Sie hinzufügen möchten.
4. Wenn Sie Ihre Auswahl getroffen haben, klicken Sie auf Speichern.
   
5. Alternativ können Sie neben der ausgewählten Vorlage auf Bearbeiten klicken, um die benutzerdefinierten Felder hinzuzufügen oder zu entfernen, sie obligatorisch zu machen oder eine Liste von Seiten hinzuzufügen - weitere Informationen finden Sie unter Erstellen einer Dokumentvorlage weiter unten. 
   
   Diese Vorlagen werden in NinjaOne verwendbar und werden im Documentation-App-Editor angezeigt. 

Eine Dokumentvorlage erstellen

So erstellen Sie ein Dokument vollständig neu:

1. Gehen Sie zu Administration > Apps > Documentation. Klicken Sie auf der rechten Seite des App-Editors auf Vorlagen verwalten und wählen Sie dann Vorlage hinzufügen. 
   
   Daraufhin erscheint in einem Popup-Fenster die Seite Neue Dokumentvorlagen.
2. Füllen Sie die nötigen Felder unter Zuhilfenahme der untenstehenden Tabelle aus. 
   

   Feld	Beschreibung
   Name	Hilft, das Dokument zu identifizieren.
   Beschreibung	Klärt den Zweck des Dokuments.
   Benutzerdefinierte Felder	Erlaubt die Hinzufügung benutzerdefinierter Felder und Benutzeroberflächenelemente. Der Vorlage können mehrere Felder und Benutzeroberflächenelemente hinzugefügt werden.
   Liste der Seiten	Ermöglicht, dass ausgewählte benutzerdefinierte Felder in einer Organisation mehrmals verwendet werden können. Siehe Die Verwendung von Dokumenten.
   Obligatorisch	Macht das Ausfüllen des Formulars in einer Organisation verpflichtend. Siehe Die Verwendung von Dokumenten.
   Verfügbar für alle Techniker	Dieses Feld sollte standardmäßig markiert sein. Wenn Sie das Feld deaktivieren, wird darunter ein neues Dropdown-Feld angezeigt, in dem Sie eine oder mehrere Technikerrollen auswählen können, um den Zugriff zu ermöglichen.

3. Per Klick auf Hinzufügen unter Benutzerdefinierte Felder können Sie der Vorlage benutzerdefinierte Felder und Benutzeroberflächenelemente hinzufügen. Der Vorlage können mehrere Felder und Benutzeroberflächenelemente hinzugefügt werden.
   
   
   • Feld – wählen Sie aus der Dropdown-Liste einen Feldtyp aus und verwenden Sie das Feld Label zur Erstellung eines Namens bzw. einer Beschreibung dafür. Das Feld Name wird im Sinne der Anpassung an die Eingabe in das Feld Label automatisch aktualisiert. Sobald Sie auf Erstellen klicken, füllen sich weitere Felder automatisch mit Angaben, um die weitere Konfiguration zu ermöglichen. Das Hinzufügen einer QuickInfo bedeutet, dass die Benutzer in einer Sprechblase weitere Informationen erhalten, wenn sie ihren Cursor darüber bewegen. Ein Beispiel dafür finden Sie in Die Verwendung von Dokumenten. 
     
   • UI-Element – wählen Sie aus der Dropdown-Liste einen Feldtyp aus und verwenden Sie das Feld Referenzname zur Erstellung einer eindeutigen Kennzeichnung dafür. 
     
4. Durch Hoch- und Hinunterziehen eines Elements innerhalb einer Vorlage können Sie die Anzeigenreihenfolge der Elemente verändern. 
   
5. Klicken Sie am Ende auf Speichern .
   Die Documentation-Vorlage ist nun sichtbar und einsatzbereit.

Dokumentvorlagen archivieren oder löschen

Um eine Dokumentvorlage zu löschen, bewegen Sie den Mauszeiger über die betreffende Zeile und klicken Sie dann auf die Ellipsen-Schaltfläche, die auf der rechten Seite erscheint. Sie müssen ein Dokument erst archivieren, bevor Sie es löschen können. Klicken Sie also auf Archivieren.

Um archivierte Vorlagen anzuzeigen, stellen Sie sicher, dass die Filteroption auf 'Sichtbar' eingestellt ist. Bewegen Sie den Mauszeiger über die Zeile und klicken Sie auf die Ellipsen-Schaltfläche, um die Vorlage entweder wiederherzustellen oder endgültig zu löschen.

Wenn Sie Löschen wählen, werden Sie darüber informiert, ob die Vorlage von anderen Organisationsdokumenten verwendet wird. Wenn Sie fortfahren möchten, verifizieren Sie Ihre Identität über MFA, um zu bestätigen, dass gelöschteVorlagen nicht wiederhergestellt werden können. 

Verlauf importieren: 

In der Importhistorie wird eine Liste der Dokumente angezeigt, die über eine hochgeladene CSV-Datei importiert wurden.

Documentation-Checklisten:

Checklists sind eine besondere Form von Dokumentation, die NinjaOne-Techniker in NinjaOne Documentation erstellen und verwalten können. Nach ihrer Hinzufügung zu NinjaOne Documentation können die Checklisten auch dem Reiter Documentation > Checklists auf dem Organisations-Dashboard hinzugefügt werden (siehe NinjaOne Documentation: Checklisten ). 

Verlauf der öffentlichen Links

Die Registerkarte Verlauf der öffentlichen Links bezieht sich auf die öffentlichen Links, die über die Funktion Teilen in der Wissensbasis erstellt wurden. Mit der Funktion Teilen können Systemadministrator:innen und Techniker:innen, die über die entsprechenden Berechtigungen für die globale Wissensbasis verfügen, einen öffentlichen Link für bestimmte Dokumente erstellen. Öffentliche Links ermöglichen den Zugriff auf Dokumente außerhalb von NinjaOne mit dem Branding, das für das eigene Anwendungslogokonfiguriert wurde.

Weitere Informationen finden Sie unter NinjaOne Documentation-Tool: Öffentliche und gemeinsam genutzte Links. 

• Letzter Zugriff: Datum und Uhrzeit, zu der der öffentliche Link verwendet wurde. 
• IP-Adresse: IP-Adresse, die für den Zugriff auf den Link verwendet wurde. 
• Titel: Name des öffentlichen Links.
• Organisation: Organisation, zu der das Dokument gehört, falls zutreffend. Dokumente, die nicht an eine Organisation gebunden sind, zeigen 'GLOBAL_ORGANIZATION'. 
• Artikel: Titel des aufgerufenen Dokuments. 
• Share Link: URL des öffentlichen Links zum Dokument. Fahren Sie mit der Maus über diesen Bereich, um eine Option zum Kopieren des Links anzuzeigen. 

Es werden maximal 150 Ergebnisse auf der Seite angezeigt. Danach ändert sich der Text der X-Anzahl der Ergebnisse und zeigt paginierte Ergebnisse an, durch die durch Anklicken der Pfeile navigiert werden kann. 

Verwenden Sie die verfügbaren Dropdown-Listen, um Ihre Suche zu filtern. Die Ergebnisse zeigen standardmäßig alle globalen Dokumente nach dem letzten Zugriffsdatum an. Sie können das Suchfeld verwenden, um Zugangspunkte nach IP-Adresse oder öffentlichem Link-Titel zu finden. Mit dem Filter 'Zugriffsdatum' können Sie nach einem bestimmten Tag oder Datumsbereich suchen.

Verwenden Sie die Schaltfläche 'Exportieren', um eine .csv-Kopie des Verlaufs der öffentlichen Links in einer Zip-Datei herunterzuladen. Verwenden Sie die Schaltfläche 'Tabelleneinstellungen', um die auf der Seite angezeigten Spalten zu ändern. 

Verwaltung der gemeinsamen Links:

Auf der Registerkarte Gemeinsame Links können Techniker:innen und Systemadministrator:innen alle aktiven gemeinsamen Links an einem Ort bearbeiten oder löschen, unabhängig davon, welche Organisation sie verwendet. 

• Sie können einen gemeinsamen Link bearbeiten, indem Sie das Kontrollkästchen aktivieren und Bearbeiten wählen oder auf die Ellipsen-Schaltfläche rechts daneben klicken und Bearbeiten wählen. 
  
• Löschen Sie einen oder mehrere gemeinsame Links, indem Sie das/die Kontrollkästchen aktivieren und Löschen wählen oder auf die Ellipsen-Schaltfläche rechts daneben klicken und Löschen wählen. 
  

Rollen für Endbenutzer

Wenn Sie einen Ordner für Endbenutzer:innen freigeben, werden die Informationen auf der Registerkarte Rollen für Endbenutzer angezeigt. Diese Registerkarte wird erst dann angezeigt, wenn ein Ordner für mindestens einen Endbenutzer freigegeben wurde.

• Zugang widerrufen Dadurch wird die Zeile von der Seite entfernt und der Zugang für alle zugehörigen Benutzerrollen widerrufen. 
• Den Ordner in einem neuen Tab öffnen. Dadurch werden Sie zur Registerkarte 'Wissensbasis' auf dem globalen Dashboard weitergeleitet, wo Sie alle Dateien in diesem Ordner sehen können. 
• Bearbeiten Sie den Zugang zum Hinzufügen oder Entfernen von Benutzerrollen oder zum Anzeigen von Inhalten mit oder ohne Ordner. 

TOTP

Systemadministrator:innen können Techniker:innen gestatten, zeitbasierte Einmal-Passwörter (TOTP) für sichere verwandte Elemente für Anwendungen und Dienstleistungen, Wissensbasis und Checklisten in der Dokumentation freizugeben. 

Die TOTP-Codes bestehen aus zwei Teilen:

• TOTP-Geheimnis: Dies wird verwendet, um einen einmaligen Code auf der Grundlage der aktuellen Uhrzeit zu generieren. 
• TOTP-Code: Das ist der Code, der durch das Geheimnis generiert wird, das nach der MFA-Authentifizierung offenbart wird. Mit diesem Code können die Anmeldeinformationen nur an die vorgesehenen Empfänger:innen weitergegeben werden, während die Daten vor anderen geschützt werden. 

Weitere Informationen finden Sie unter TOTP-Codes.