Quick start guide german translation

Dies ist eine gekürzte und übersetzte Fassung der englischen Schnellstartanleitung zu Lehrzwecken für die Nestor School 2016.

Installation

PET ist ein Java Programm, muss daher nicht installiert werden und läuft auf allen gängigen Betriebssystemen. Es benötigt Java 7 (oder höher) welches hier heruntergeladen werden kann: http://www.java.com/download

Laden Sie die neuste Version von PET runter und extrahieren Sie das ZIP Archiv: https://github.com/pericles-project/pet/releases/latest

Führen Sie die .jar Datei aus (Windows: Doppelklick, Linux/OS X: java -jar PeriCAT.jar).

Erste Schritte

Lerne die grafische Benutzeroberfläche kennen

Beim ersten Start von PET wird sich die grafische Benutzeroberfläche (GUI "Graphical User Interface") öffnen.

Die GUI ist in Registerkarten ("Tabs") organisiert, wie in folgendem Screenshot zu sehen ist:

1. Im “Monitored files”-Tab können Dateien die mit PET untersucht werden sollen hinzugefügt werden
2. In dem “Modules”-Tab können Module zum Sammeln von Informationen hinzugefügt und konfiguriert werden
3. Der “Environment information”-Tab zeigt die gesammelten Umgebungsinformationen die für alle Dateien der Umgebung gleichermaßen gültig sind
4. Der “Events”-Tab führt alle aufgezeichneten Umgebungsereignisse auf, die von dem Tool erkannt wurden
5. Die gesammelten Umgebungsinformationen die zu einer bestimmten Datei gehören (und somit nicht für alle untersuchten Dateien gültig sind) können in dem "Monitored files"-Tab angesehen werden, indem die dazugehörige Datei ausgewählt wird.
6. Profile erlauben es die Module und die zu untersuchenden Dateien zu ordnen. So können mehrere Szenarien in PET konfiguriert werden.
7. Unten in der Benutzeroberfläche sind Knöpfe um das Sammeln der Informationen zu steuern

Fügen Sie eine Datei hinzu

Öffnen Sie den "Monitored files"-Tab und fügen Sie mit dem "Add Files"-Knopf eine Datei hinzu, die von PET untersucht werden soll. Es wird sich ein Dialog zum Hinzufügen der Datei öffnen. Beim Sammeln von Umgebungsinformationen werden Informationen gesammelt die für diese Dateien wichtig sind. Die Dateien werden dabei nicht von PET verändert.

Selektieren Sie ein Modul zum Sammeln von Informationen

Öffnen Sie den "Modules"-Tab. Dieser verwaltet die Liste von Modulen die definieren welche Informationen gesammelt werden sollen. Klicken Sie den "Add new modules"-Knopf, um Module dieser Liste hinzuzufügen. Wenn ein Modul in der Liste ausgewählt wird öffnet sich eine Oberfläche um dieses zu Konfigurieren.

Starten Sie eines Sammelvorganges

Klicken Sie den "Snapshot"-Knopf unten links in der Benutzeroberfläche. Dies wird einen einzelnen Sammelvorgang starten, bei dem jedes Modul einmal ausgeführt wird.

Betrachten Sie die Ergebnisse

Sie können die gesammelten Umgebungsinformationen im "Environment information"-Tab betrachten. Die Datei abhängigien Informationen können in dem "Monitored files"-Tab betrachtet werden.

PET verstehen

Es folgt eine Übersicht über die Funktionalitäten von PET.

Profile und Entwurfsvorlagen

PET organisiert die Dateien und Module zum Sammeln von Informationen in Profilen, um Konfigurationen für verschiedene Szenarien laden zu können. Beim Start des Tools wird ein leeres Profil geladen. Existierende Profile können mit der "Select profile:"-Combobox oben in der Benutzeroberfläche ausgewählt werden.

Der Knopf "New profile (from template)" erlaubt das Erstellen von Profilen basierend auf vorkonfigurierten Entwurfsvorlagen für spezielle Szenarien. Es ist auch möglich Profile als Entwurfsvorlagen zu exportieren, um sie anderen PET-Benutzern zu schicken die dann Profile aus diesen Vorlagen erstellen können.

Eine Entwurfsvorlage beinhaltet die vorkonfigurierten Module, aber nicht die Dateien, da diese auf anderen Computern wahrscheinlich nicht vorhanden sind.

Die gespeicherten Entwurfsvorlagen können in folgendem Ordner gefunden werden: .../PET_data/config/profile_templates/ Es ist auch möglich diese Konfigurationsdateien, die im JSON-Format geschrieben sind, manuell zu ändern. Alle Vorlagen aus diesem Ordner können vom laufenden Programm aus als Profile geladen werden.

Zwei verschiedene Modi zum Sammeln von Informationen

PET bietet zwei Modi zum Sammeln von Informationen an:

1. Snapshot Modus: In diesem Modus wird jedes Modul zum Sammeln von Informationen einmal gestartet. Die Module zum Beobachten von Umgebungsereignissen werden in diesem Modus nicht ausgeführt. Der Sammelvorgang kann duch Klicken auf den "Snapshot"-Knopf ausgeführt werden.

2. Kontinuierlicher Sammelmodus: Dieser Modus kann in einem Sheer-Curation-Szenario verwendet werden. Die Module zum Beobachten der Umgebung werden gestartet und basierend auf den beobachteten Ereignissen werden kontinuierlich Informationen über die Umgebung gesammelt. Der Modus kann gestartet oder gestoppt werden, indem der "Start/Stop monitor"-Knopf unten in der GUI geklickt wird.

Datei abhängige Informationen und Datei unabhängige Umgebungsinformationen

Die Umgebungsinformationen die gesammelt werden sind entweder Datei abhängig, ändern sich also für jede beobachtete Datei, oder sie sind Datei unabhängig und bleiben für alle Dateien gültig.

Module zum Sammeln von Informationen und Module zum Beobachten der Umgebung

Es gibt drei verschiedene Arten von Modulen in PET: Module die Datei abhängige Informationen sammeln, Module die Datei unabhängige Informationen sammeln und Module die die Umgebung beobachten um Umgebungsereignisse zu melden und das Sammeln von Informationen durch die anderen Module auszulösen.

Die verfügbaren Module können mit einer detailierten Beschreibung im "modules"-Tab durchgesehen werden, in dem auf den "Add new modules"-Knopf geklickt wird.

Konfiguration eines Moduls

Derzeit müssen die Module noch durch eine JSON-Datein konfiguriert werden. Eine komfortablere GUI für die Konfiguration der Module steht als Hauptpunkt auf der Wunschliste für eine spätere PET-Version.

Die Module können im "modules"-Tab durch eine JSON-Datei konfiguriert werden. Die Konfiguration muss dabei exakt der JSON-Syntax entsprechen. Durch einen Klick auf "Save and use configuration" wird die Syntax kontrolliert und im Falle von Syntaxfehlern eine Fehlermeldung angezeigt. Der "Reload config file"-Knopf kann dazu verwendet weren um die ursprüngliche Konfiguration wiederherzustellen.

Die Konfigurationsdatei beinhaltet folgende Informationen:

• Die “class” Option speichert den namen der Java-Klasse des assoziierten Moduls und sollte nicht geändert werden. Er wird gebraucht um das konfigurierte Modul zu laden.
• “moduleName” ist der Name des Modultyps. Dieser Wert darf auch nicht geändert werden. Wenn Sie den angezeigten Namen eines Modules ändern wollen, dann ändern Sie stattdessen den Wert von "moduleDisplayName".
• “moduleVersion” Dieser Wert zeigt die Versionsnummer des Modules an und sollte nicht geändert werden.
• Die “enabled” Option zeigt an ob das Modul momentan für das Sammeln von Informationen verwendet wird oder nicht. Um diesen Wert schnell zu ändern kann ebenso der Radioknopf oben rechts in der GUI verwendet werden. Einige Module deaktivieren sich selber, wenn sie weitere Konfiguration benötigen um richtig funktionieren zu können.
• “recordEvents” TODO
• “supportedSystems” beinhaltet eine Liste von Betriebssystemen, die von dem Modul unterstützt werden. Nicht alle Module funktionieren in jedem Betriebssystem. Manche Module können Betriebssystemspezifisch konfiguriert werden. Dann sollte diese Liste so ergänzt werden, dass sie alle Systeme beinhaltet in denen das Modul laufen kann. “SYSTEM_INDEPENDENT” ist die voreingestellte Option, die besagt dass ein Modul auf jedem System läuft. Die verfügbaren Optionen sind: "OS_X", "SOLARIS", "BSD", "LINUX", und / oder "WINDOWS".
• “fileFilter” Dateifilter erlauben es die Module auf bestimmte Dateitypen zu beschränken. Dies ist besonders für dateiabhängige Module sinnvoll, aber auch für Module die umgebungsweit bestimmte Datein untersuchen. Es gibt fünf verschiedene Filter.
  • “fileExtensionFilter”: Dieser Filter erlaubt es eine Regex zu definieren um nach Dateiendungen zu filtern. Hierfür wird die Java Regexsyntax verwendet.
  • “inclusiveMimeType”: Es sollen nur Dateien eines bestimmten Mimetyps untersucht werden, beispielsweise "application/pdf"
  • “inclusiveMediaType”: Es sollen nur Datein eines bestimmten Mediatyps untersucht werden, z.B. "text"
  • “exclusiveMediaType”: Es sollen Dateien aller Mediatypen mit Ausnahme der in diesem Filter aufgelisteten Typen untersucht werden
  • “exclusiveMimeType”: Es sollen Dateien aller Mimetypen mit Ausnahme der hier aufgelisteten untersucht werden.
• “eventAddToProfile” TODO

Alle weiteren Optionen die in der Konfigurationsdatei auftauchen sind Modulspezifisch. Die Beschreibungen der Module enthalten Hilfetexte für die Konfiguration dieser Optionen.

Die gesammelten Informationen angucken

Im “Environment information”-Tab können Sie die Datei unabhängigen Informationen finden, die Datei abhängigen Informationen werden hingegen im "Monitored files"-Tab angezeigt, wenn eine Datei ausgewählt wird. Zunächst öffnet sich eine Baumdarstellung die die gesammelten Informationen enthält, nach Datum und zugehörigem Modul sortiert.

Mit einem Doppelklick auf eine Information kann diese in einem neuen Fenster im JSON-Format betrachtet werden.

Ein weiterer Anzeigemodus der besonders für die Visualisierung von Informationsänderungen zwischen den verschiedenen Sammelduchgängen gedacht ist kann durch klicken auf den "Visualise information change"-Knopf geöffnet werden. Dafür muss jedoch zunächst das zu untersuchende Modul in der darüberliegenden Combobox ausgewählt werden. In diesem Modus werden alle Resultate der vergangenen Sammeldurchläufe angezeigt. Dabei ist das Datum der Sammlung in der ersten Zeile der Tabelle zu sehen. Die Tabelle kann bildschirmfüllend angezeigt werden und zur weiteren Analyse exportiert werden.

Wenn auf den "Visualise information change"-Knopf geklickt wird ohne dass ein Modul ausgewählt ist, dann wird das Resultat des letzten Sammeldurchlaufes mit dem Vorherigen verglichen wobei die Unterschiede hervorgehoben werden.

Der "Show information in JSON"-Knopf zeigt die gleichen Informationen wie der vorherig beschriebene Modus, nur dass diese im JSON-Format statt als Tabelle dargestellt werden.