Session Monitor Erweiterung

Einleitung

Die Session Monitor Erweiterung bindet die Daten des Session Monitor Systems in das Raptor System ein. Dabei werden Computer- und Benutzerobjekte für alle im Session Monitor System vorhandenen Datensätze erstellt. Die entsprechenden Objekte enthalten quer verlinkte Tabellen mit den Sessions des Benutzers und auf Servern und Computern.

Fakten

Name

Session Monitor Data

Bezeichner

SessionMonitorData

Version

1.0

Funktionen

Quelle

Abschnitte

sessionMonitor

Informationsblöcke

sessionMonitor

Features

  • Integriert die Daten des Session Monitor Systems in das Raptor System.

  • Erstellt Benutzer- und Computerobjekte aus den gewonnen Daten und verbindet diese mit Daten aus anderen Quellen.

  • Die Felder der Session Tabellen können konfiguriert werden.

  • Individuelle Aktionsknöpfe können für die Zeilen der Tabelle konfiguriert werden.

Konfiguration

Das Konfigurationsschema

Module

SessionMonitorData

Value

ApiHost

String

  • Must not be empty.

Value

ApiPort

Optional

Integer

  • Minimum value: 1

  • Maximum value: 65535

Default Value:

17672

Value

SslProfile

String

  • Must not be empty.

Value

ApiKey

String

  • Must not be empty.

Value

ApiSecret

Password

  • Must not be empty.

Value

Context

Optional

String

  • Must not be empty.

  • Maximum length: 64

  • Must match this regular expression: [-_.a-z0-9]+            

Default Value:

unknown

Value

OverwriteComputerContext

Optional

Boolean

Default Value:

No

Value

OverwriteUserContext

Optional

Boolean

Default Value:

No

Value

UserObjectEnabled

Boolean

Value

ComputerObjectEnabled

Boolean

Value

TableFields

StringList

  • Must not be empty.

List

TableActions

Complex list definition

Value

Label

String

  • Must not be empty.

  • Maximum length: 64

Value

Arguments

StringList

Value

ProgramPath

Optional

String

Der Wert ApiHost

Mit dem Wert ApiHost konfigurierst du den Hostnamen oder die IP-Adresse des Servers auf dem das Session Monitor System läuft.

1<Module name="SessionMonitorData">
2    <Value name="ApiHost">host.example.com</Value>
3    <Value name="SslProfile">legacy</Value>
4    ...
5</Module>

Der Wert ApiPort

Mit dem optionalen Wert ApiPort kannst du den Port für die Verbindung zum Session Monitor System anpassen. Lässt du den Wert weg, wird der Standartwert Port 17672 verwendet.

1<Module name="SessionMonitorData">
2    <Value name="ApiHost">host.example.com</Value>
3    <Value name="ApiPort">12345</Value>
4    <Value name="SslProfile">legacy</Value>
5    ...
6</Module>

Der Wert SslProfile

Mit SslProfile bestimmst du die SSL-Konfiguration für deine Verbindung. Stelle sicher, dass der Name, den du hier einfügst, in der Liste profiles im SSL Konfigurationsmodul vorhanden ist. In Kapitel Eigene SSL Zertifikate verwenden erfährst du mehr darüber, wie du das SSL-Profil richtig einrichtest.

Du hast auch die Möglichkeit, diesen Wert auf legacy zu setzen. Das ist besonders hilfreich, wenn du eine Migration durchführen oder ältere Installationen unterstützen möchtest. In diesem Fall verwendet das System die integrierten Zertifikate, die mit älteren Versionen des Session Monitor Systems kompatibel sind.

Warnung

Wir empfehlen allerdings ausdrücklich, immer eigene Zertifikate und Schlüssel zu verwenden. Diese sollten den korrekten Servernamen enthalten und von einer internen Zertifizierungsstelle deines Unternehmens ausgestellt werden. Mit dieser Methode stellst du sicher, dass deine Verbindung sicher und authentifiziert ist.

1<Module name="SessionMonitorData">
2    <Value name="ApiHost">host.example.com</Value>
3    <Value name="SslProfile">legacy</Value>
4    ...
5</Module>

Der Wert ApiKey

Der Wert ApiKey setzt den Schlüssel für die Verbindung zum Session Monitor System. Mehr dazu im Kapitel Das Secret System.

Der Wert ApiSecret

Der Wert ApiSecret setzt das Geheimnis für die Verbindung zum Session Monitor System. Mehr dazu im Kapitel Das Secret System.

Der Wert Context

Mit dem Wert Context setzt du den default Kontext für die erzeugten Objekte. Dieser Kontext wird für alle Computer- und Benutzerobjekte verwendet sofern du dich dazu entscheidest den original Wert mit OverwriteComputerContext und OverwriteUserContext zu überschreiben.

Damit Objekte korrekt zusammengeführt werden, kann es Sinn machen den original Kontext mit einem passenden zu überschreiben. Beispielsweise wenn sich der von der Active Directory Erweiterung gemeldete Kontext von dem durch das Session Monitor System gemeldete unterscheidet.

Weiter kann es sein, dass Computer vom Session Monitor System eingebunden werden, welche sich nicht in einer Domäne befinden. Dadurch unterscheidet sich bei diesen Daten der Kontext. Indem der Computer Kontext überschrieben wird, werden diese Datensätze vereinheitlicht.

Handelt es sich um einfache Abweichungen, lassen sich Objekte durch entsprechende Regeln mit dem Wert ContextTransformation im Modul Data des Raptor Servers zusammenführen. Siehe dazu Die Liste ContextTransformation.

Der Wert OverwriteComputerContext

Mit dem optionalen Wert OverwriteComputerContext kannst du den Kontext für die erzeugten Computerobjekte überschreiben.

Setzt du diesen Wert auf Yes, wird der Kontext von jedem erzeugten Computerobjekt mit dem Wert Context überschrieben.

Lässt du diesen Wert weg, oder setzt ihn auf No, wird für den Kontext die Domain des Computers verwendet.

Der Wert OverwriteUserContext

Mit dem optionalen Wert OverwriteUserContext kannst du den Kontext für die erzeugten Benutzerobjekte überschreiben.

Setzt du diesen Wert auf Yes, wird der Kontext von jedem erzeugten Benutzerobjekt mit dem Wert Context überschrieben.

Lässt du diesen Wert weg, oder setzt ihn auf No, wird für den Kontext die Domain des Benutzers verwendet.

Der Wert UserObjectEnabled

Mit dem Wert UserObjectEnabled kontrollierst du, ob Benutzerobjekte aus den Daten des Session Monitor Systems erzeugt werden.

Wir empfehlen diesen Wert immer auf „Yes“ zu setzen

Der Wert ComputerObjectEnabled

Mit dem Wert ComputerObjectEnabled kontrollierst du, ob Computerobjekte aus den Daten des Session Monitor Systems erzeugt werden.

Wir empfehlen diesen Wert immer auf „Yes“ zu setzen

Der Wert TableFields

Mit dem Wert TableFields konfigurierst du welche Spalten in den Tabellen der Objekte angezeigt werden. Es handelt sich dabei um eine Whitespace getrennte Liste von Spaltennamen. Die Spalten werden genau in der konfigurierten Reihenfolge angezeigt.

Die folgende Tabelle enthält alle möglichen Spalten und deren Bezeichner:

Bezeichner

Typ

Titel

Identifier

Text

Identifier

Host

Text

Host

HostDomain

Text

Host Domain

User

Text

User

UserDomain

Text

User Domain

OperatingSystem

Text

Operating System

OperatingSystemVersion

Text

Operating System Version

OperatingSystemDetails

Text

Operating System Details

IdleState

Text

Idle State

IdleTime

Datum/Zeit

Idle Time

ConnectionSource

Text

Connection Source

Created

Datum/Zeit

Created

Action

Aktionen

Action

Das folgende Beispiel konfiguriert genau die drei gezeigten Spalten in der angegeben Reihenfolge:

<Value name="Fields">
   Identifier
   User
   Host
</Value>

Verstecken von Spalten

Mit dem Präfix - vor dem Bezeichner einer Spalte versteckst du diese. Die Spalte ist trotzdem Teil des Datenmodels, beispielsweise für Skripte des Expertensystems, jedoch wird sie dem Benutzer nicht mehr angezeigt.

Das folgende Beispiel zeigt die Spaten Identifier und User and, versteckt aber die Host.

<Value name="Fields">
    Identifier
    User
    -Host
</Value>

Spalte mit Aktionsknöpfen

Mit dem Bezeichner Actions fügst du die Spalte mit den Aktionsknöpfen hinzu. Anders als bei den regulären Spalten darfst du für die Spalte Actions keine Präfixe und Suffixe verwenden.

Das folgende Beispiel blendet die Aktionsknöpfe als letzte Spalte ein.

<Value name="Fields">
    Identifier
    User
    Action
</Value>

Hinzufügen von Spalten als Aktionsparameter

Um den Inhalt einer Spalte als Parameter für die Aktion hinzuzufügen, verwendet du den Präfix $ hinter dem Bezeichner.

Das folgende Beispiel fügt den Inhalt der Spalte Identifier und User als Parameter jeder Aktion hinzu.

<Value name="Fields">
    Identifier$
    User$
    Action
</Value>

Dabei kannst du den Präfix - mit dem Suffix $ kombinieren, um eine Spalte nur als Parameter für die Aktionen zu verwenden. Das folgende Beispiel verwendet die Spalte Identifier nur als Parameter, versteckt diese aber vor dem Benutzer.

<Value name="Fields">
    -Identifier$
    User$
    Action
</Value>

Indem du hinter dem $ zeichen einen weiteren Bezeichner angibst, ändert du damit den namen des Parameters welcher für die Aktion verwendet wird. Im folgenden Beispiel wird für die Spalte Host der Parametername hostName und für die Spalte User der Parametername userName verwendet.

<Value name="Fields">
    Host$hostName
    User$userName
    Action
</Value>

Die Liste TableActions

Mit der Liste TableActions konfigurierst du die Aktionsknöpfe, welche in der Spalte Actions angezeigt werden. Jeder Eintrag in dieser Liste fügt einen Aktionsknopf hinzu. Diese werden in der Konfigurierten Reihenfolge angezeigt.

Der Wert Label

Mit dem Wert Label definierst du den Text der auf dem Aktionsknopf angezeigt wird. Halte diesen Text so kurz wie möglich. Die maximale Länge sind 64 Zeichen.

Der Wert Arguments

Mit dem Wert Arguments konfigurierst du weitere Parameter welche immer an das bei der Aktion aufgerufene Program weitergegeben werden. Dabei werden die Parameter mit Whitespace getrennt angegeben.

<Value name="Arguments">
    arg1=value1
    arg2=value2
    arg3=value3
</Value>

Jeder Parameter wird dabei mit dem Gleichzeichen (=) in den Namen und Wert aufgetrennt. Wichtig ist hier, dass innerhalb der Parameterdefinition kein Leerzeichen vorkommen darf.

Der Name des Parameters darf dabei die Buchstaben a-z, sowie die Ziffern 0-9 enthalten. Auch der Bindestrich - ist erlaubt. Der Wert nach dem Gleichzeichen = darf keine Leerzeichen enthalten.

Zusätzliche Parameter sind optional, jedoch unüblich, daher musst du den Wert Arguments immer angeben. Möchtest du wirklich keine zusätzlichen Parameter, konfigurierst du einfach einen leeren Wert Arguments.

Der Wert ProgramPath

Mit dem optionalen Wert ProgramPath kannst du für den Aktionsknopf ein alternatives Program auswählen. Lässt du den Wert weg, wird das Program verwendet, welches du im Data Modul des Servers konfiguriert hast. Siehe Das Daten Modul.

Gib hier immer einen vollständigen Pfad zu dem Program an, ohne Anführungszeichen und ohne weitere Parameter. Falls du dem Program Parameter übergeben möchtest, musst du diese mit dem Wert Arguments konfigurieren.

Denke auch daran, dass dieses Program durch den Raptor Client auf dem Computer der Anwenders gestartet wird. Der Pfad muss daher dort zugänglich sein und der Anwender muss die nötigen Rechte haben das Program zu starten.

Beispielkonfiguration

 1<?xml version="1.0" encoding="UTF-8" ?>
 2<Configuration
 3    version="1"
 4    xmlns="http://educateit.ch/software/BlueStone/Configuration/1">
 5
 6    <Module name="SessionMonitorData">
 7        <Value name="ApiHost">[host]</Value>
 8        <Value name="SslProfile">legacy</Value>
 9        <Value name="ApiKey">[key]</Value>
10        <Value name="ApiSecret">[secret]</Value>
11        <Value name="UserObjectEnabled">Yes</Value>
12        <Value name="ComputerObjectEnabled">Yes</Value>
13        <Value name="Context">example</Value>
14        <Value name="TableFields">
15            -Identifier$
16            Host$
17            User$
18            -OperatingSystem
19            IdleState
20            -IdleTime
21            Action
22        </Value>
23        <List name="TableActions">
24            <ListEntry>
25                <Value name="Label">Action</Value>
26                <Value name="Arguments">
27                    profile=sessionMonitor
28                </Value>
29            </ListEntry>
30        </List>
31    </Module>
32
33</Configuration>