Citrix Cloud Datenquelle

Einleitung

Die Citrix Cloud Datenquelle holt Session-Daten aus Citrix Cloud oder einer lokalen Citrix Virtual Apps and Desktops-Installation. Die Session-Daten, inklusive aller damit verknüpften Benutzer-, Computer- und Applikationsobjekte, werden dabei in das Raptor System integriert.

Fakten

Name	Citrix Cloud Data
Bezeichner	CitrixCloudData
Version	1.2
Funktionen	Datenquelle
Abschnitte	Default: primary Es können beliebige Abschnitte konfiguriert werden.
Informationsblöcke	citrixCloud

Features

• Integriert die Daten einer oder mehrerer Citrix Cloud- oder lokaler Citrix CVAD-Schnittstellen in das Raptor System.

• Erlaubt die Konfiguration beliebig vieler Verbindungen, jede mit einem individuellen Objekt Kontext.

• Die Felder aller Tabellen lassen sich beliebig konfigurieren.

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

• Es lässt sich ein Proxyserver für die Verbindungen konfigurieren.

• In der Konfiguration kann die Quelle für den Benutzernamen gewählt werden.

Konfiguration

Das Konfigurationsschema

↓ Alles anzeigen ↓

Module

CitrixCloudData

Value

SectionIdentifier

Optional

String

• Must not be empty.

• Minimum length: 1

• Maximum length: 64

• Must match this regular expression: [a-z]+

Default Value:

citrixCloudData

Value

OrderIndex

Optional

Integer

• Minimum value: 1

• Maximum value: 1000

Default Value:

100

List

Tables

Optional

Complex list definition

Value

TableType

String

• Must be one of this: Session

Value

ObjectType

Optional

String

• Must be one of this: Any, Computer, User, Application, Session

Default Value:

Any

List

TableColumns

Optional

Complex list definition

Value

Identifier

String

• Minimum length: 2

• Maximum length: 64

• Must match this regular expression: [A-Z][a-zA-Z]+

Value

Title

Optional

String

• Must not be empty.

• Maximum length: 64

• Must match this regular expression: [^\p{Zl}\p{Zp}\p{C}]+

Value

IsVisible

Optional

Boolean

Default Value:

Yes

Value

IsActionParameter

Optional

Boolean

Default Value:

No

Value

ActionParameterName

Optional

String

• Must not be empty.

• Maximum length: 64

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

List

TableActions

Optional

Complex list definition

Value

Label

String

• Must not be empty.

• Maximum length: 64

• Must match this regular expression: [^\p{Zl}\p{Zp}\p{C}]+

Value

Arguments

StringList

Value

ProgramPath

Optional

String

List

Connections

Complex list definition

Value

Name

String

• Must not be empty.

• Must match this regular expression: [-_a-z0-9]+

• Maximum length: 64

Value

ObjectContext

String

• Must not be empty.

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

Value

ConnectionType

Optional

String

• Must be one of this: Cloud, OnPremises

Default Value:

Cloud

Value

ClientId

Optional

String

• Must not be empty.

• Maximum length: 250

Value

ClientSecret

Optional

Password

• Must not be empty.

Value

CustomerId

Optional

String

• Must not be empty.

• Maximum length: 250

Value

AdministratorUserName

Optional

String

• Must not be empty.

• Maximum length: 250

Value

AdministratorPassword

Optional

Password

• Must not be empty.

Value

StartupDelay

Optional

Integer

• Minimum value: 5

• Maximum value: 3600

Default Value:

10

Value

RetrievalInterval

Optional

Integer

• Minimum value: 30

• Maximum value: 86400

Default Value:

60

Value

DelayAfterError

Optional

Integer

• Minimum value: 1

• Maximum value: 3600

Default Value:

10

Value

ErrorCountToEscalate

Optional

Integer

• Minimum value: 2

• Maximum value: 100

Default Value:

10

Value

DelayAfterErrorEscalation

Optional

Integer

• Minimum value: 60

• Maximum value: 86400

Default Value:

600

Value

RequestTimeout

Optional

Integer

• Minimum value: 60

• Maximum value: 86400

Default Value:

300

Value

BaseURL

Optional

String

• Must not be empty.

Default Value:

https://api.cloud.com/

Value

ApiVersion

Optional

String

• Must be one of this: Initial, June2024

Default Value:

June2024

Value

UserNameSource

Optional

String

• Must be one of this: Name, Sid, Guid, DistinguishedName, CanonicalName, SamName, SamAccountName, CommonName, PrincipalName

Default Value:

Name

Value

UserNameCharacterFilter

Optional

String

• Must not be empty.

• Must be a valid regular expression.

Value

SessionRetrievalLimit

Optional

Integer

• Minimum value: 0

Default Value:

0

Group

Proxy

Optional

Value

Type

String

• Must be one of this: None, Default, Socks5, Http

Value

Host

Optional

String

Default Value:

None

Value

Port

Optional

Integer

Default Value:

0

Value

Username

Optional

String

Default Value:

None

Value

Password

Optional

Password

Default Value:

None

Der Wert SectionIdentifier

Mit dem optionalen Wert SectionIdentifier definierst du in welchem Abschnitt die Tabellen dieser Quelle platziert werden sollen. Aus dem Bezeichner welcher du hier angibst, wird automatisch der Titel gebildet, er darf maximal 64 Buchstaben enthalten.

Felder welche den selben Abschnittsbezeichner haben, werden automatisch unter diesem Abschnitt zusammengefasst. Es spielt dabei keine Rolle, ob der Abschnitt von dieser, oder einer anderen Erweiterung erstellt wurde. Einige zusätzliche Informationen zu den Abschnitten findest du im Kapitel Der Wert SectionOrder.

Lässt du diesen Wert weg, wird der Default citrixCloudData verwendet, der im Client als :guilabel:Citrix Cloud Data angezeigt wird.

<Module name="CitrixCloudData">
    ...
    <Value name="SectionIdentifier">citrixCloudData</Value>
    ...
</Module>

Die Abschnitte A wie sie im Client angezeigt werden

Der Wert OrderIndex

Mit dem optionalen Wert OrderIndex setzt du eine individuelle Position wo die Tabellen innerhalb des Abschnitts platziert werden. Dazu definierst du hier einen Reihenfolgeindex zwischen 1 und 1000. Lässt du den Wert weg, wird 100 verwendet.

<Module name="CitrixCloudData">
    ...
    <Value name="OrderIndex">700</Value>
    ...
</Module>

Die folgende Illustration zeigt ein Beispiel wie der Reihenfolgeindex des Felds die Reihenfolge innerhalb jedes Abschnitts definiert.

Die Reihenfolgeindexe definieren die Reihenfolge der Felder im Client

Die Liste Tables

Mit der Liste Tables konfigurierst du die verschiedenen Tabellen der Erweiterung. In der aktuellen Version dieser Datenquelle gibt es nur ein Tabellentyp: Session.

Jeder Eintrag in dieser Liste wählt einen Tabellentyp mit dem Wert TableType, und ein Objekttyp mit dem Wert ObjectType. Dabei werden die Einträge in dieser Liste in der Reihenfolge in der sie definiert werden abgearbeitet. Passt sowohl der Tabellentyp wie auch der Objekttyp dann werden die Einträge der Tabellenspalten und Tabellenaktionen übernommen.

Der Wert TableType

Der Wert TableType kann aktuell nur Session sein. Er muss jedoch zwingend angegeben werden um spätere Erweiterungen zu erleichtern.

<Module name="CitrixCloudData">
    ...
    <List name="Tables">
        <ListEntry>
            <Value name="TableType">Session</Value>
            <Value name="ObjectType">User</Value>
            ...
        </ListEntry>
        <ListEntry>
            <Value name="TableType">Session</Value>
            <Value name="ObjectType">Any</Value>
            ...
        </ListEntry>
    </List>
    ...
</Module>

Der Wert ObjectType

Der optionale Wert ObjectType schränkt die Tabellenkonfiguration auf einen bestimmten Objekttyp ein. Möglich sind dabei alle gültigen Objekttypen des Raptor Systems, sowie dem Wert Any der auf alle Objekttypen passt.

• Any

• Computer

• User

• Application

• Session

Lässt du den Wert weg, wird der Default Any verwendet.

<Module name="CitrixCloudData">
    ...
    <List name="Tables">
        <ListEntry>
            <Value name="TableType">Session</Value>
            <Value name="ObjectType">User</Value>
            ...
        </ListEntry>
        <ListEntry>
            <Value name="TableType">Session</Value>
            <Value name="ObjectType">Any</Value>
            ...
        </ListEntry>
    </List>
    ...
</Module>

Die Listen TableColumns und TableActions

Die beiden Listen TableColumns und TableActions definieren die angezeigten Spalten und Aktionen in der Tabelle. Alle Details findest du im Kapitel Tabellenkonfiguration.

Konfigurationsbeispiel:

↓ Alles anzeigen ↓

<Module name="CitrixCloudData">
    ...
    <List name="Tables">
        <ListEntry>
            <Value name="TableType">Session</Value>
            <Value name="ObjectType">User</Value>
            <List name="TableColumns">
                <ListEntry>
                    <Value name="Identifier">Id</Value>
                    <Value name="IsActionParameter">Yes</Value>
                </ListEntry>
                <ListEntry>
                    <Value name="Identifier">ClientName</Value>
                </ListEntry>
                <ListEntry>
                    <Value name="Identifier">MachineName</Value>
                </ListEntry>
                <ListEntry>
                    <Value name="Identifier">ApplicationsInUse</Value>
                </ListEntry>
                <ListEntry>
                    <Value name="Identifier">Actions</Value>
                </ListEntry>
            </List>
            <List name="TableActions">
                <ListEntry>
                    <Value name="Label">User Action</Value>
                    <Value name="Arguments">action=usertest</Value>
                </ListEntry>
            </List>
        </ListEntry>
        <ListEntry>
            <Value name="TableType">Session</Value>
            <Value name="ObjectType">Any</Value>
            <List name="TableColumns">
                <ListEntry>
                    <Value name="Identifier">Id</Value>
                    <Value name="IsActionParameter">Yes</Value>
                </ListEntry>
                <ListEntry>
                    <Value name="Identifier">IsHidden</Value>
                </ListEntry>
                <ListEntry>
                    <Value name="Identifier">UserName</Value>
                </ListEntry>
                <ListEntry>
                    <Value name="Identifier">ClientName</Value>
                </ListEntry>
                <ListEntry>
                    <Value name="Identifier">MachineName</Value>
                </ListEntry>
                <ListEntry>
                    <Value name="Identifier">ApplicationsInUse</Value>
                </ListEntry>
                <ListEntry>
                    <Value name="Identifier">Actions</Value>
                </ListEntry>
            </List>
            <List name="TableActions">
                <ListEntry>
                    <Value name="Label">Common Action</Value>
                    <Value name="Arguments">action=commontest</Value>
                </ListEntry>
            </List>
        </ListEntry>
    </List>
    ...
</Module>

Die Felder der Tabellen

Die folgende Tabellen zeigen dir alle möglichen Spalten welche du in der jeweiligen Tabelle verwenden kannst. Die genaue Bedeutung der jeweiligen Spalten findest du in der Citrix „Dokumentation“. Aktuell findest du diese unter der folgenden URL:

https://developer.cloud.com/citrixworkspace/citrix-daas-rest-apis/apis/Sessions-APIs/Sessions_GetSession

Die Session Tabelle

Bezeichner	Typ
Id	Text
Context	Text
IsHidden	Boolean
SessionType	Text
StartTime	Datum/Zeit
State	Text
UntrustedUserName	Text
ApplicationsInUse	Textliste
User	Text (Verlinkt)
Machine	Text (Verlinkt)
Client	Text (Verlinkt)
Actions	Aktionen

Die User Tabelle

Bezeichner	Typ
Name	Text
Context	Text
Sid	Text
Guid	Text
DistinguishedName	Text
CanonicalName	Text
SamName	Text
SamAccountName	Text
CommonName	Text
PrincipalName	Text
Session	Text (Verlinkt)

Die Machine Tabelle

Bezeichner	Typ
Id	Text
Context	Text
Name	Text
DnsName	Text
IpAddress	Text
InMaintenanceMode	Boolean
Session	Text (Verlinkt)

Die Client Tabelle

Bezeichner	Typ
Name	Text
Context	Text
IpAddress	Text
Session	Text (Verlinkt)

Die Application Tabelle

Bezeichner	Typ
Name	Text
Context	Text
Session	Text (Verlinkt)

Die Liste Connections

Mit der Liste Connections konfigurierst du die einzelnen Verbindungen zur Citrix API. Jeder Eintrag verbindet entweder eine Citrix Cloud-Umgebung oder eine lokale Citrix CVAD-Installation. Für eine Cloud-Verbindung verwendest du Client Identifier, Client Secret und Customer Identifier. Für eine lokale Verbindung verwendest du stattdessen die Zugangsdaten eines Administrators.

<Module name="CitrixCloudData">
    ...
    <List name="Connections">
        <ListEntry>
            <Value name="Name">ExampleAccess</Value>
            <Value name="ObjectContext">example.com</Value>
            <Value name="ClientId">...</Value>
            <Value name="ClientSecret">...</Value>
            <Value name="CustomerId">...</Value>
        </ListEntry>
        ...
    </List>
    ...
</Module>

Der Wert Name

Mit dem Wert Name definierst du einen eindeutigen Namen für die Verbindung. Dieser Name wird in Logdateien und Fehlermeldungen verwendet, damit du ein Problem der Verbindung zuordnen kannst.

Der Verbindungsname muss eindeutig sein, aus maximal 64 Zeichen bestehen und nur Buchstaben, Zahlen, den Unterstrich und Bindestrich enthalten.

<Module name="CitrixCloudData">
    ...
    <List name="Connections">
        <ListEntry>
            <Value name="Name">ExampleAccess</Value>
            <Value name="ObjectContext">example.com</Value>
            <Value name="ClientId">...</Value>
            <Value name="ClientSecret">...</Value>
            <Value name="CustomerId">...</Value>
        </ListEntry>
        ...
    </List>
    ...
</Module>

Der Wert ObjectContext

Mit dem Wert ObjectContext setzt du den Kontext für alle Objekte welche für diesen Active Directory. Hier kannst du maximal 64 Zeichen mit Buchstaben, Zahlen, dem Unterstrich _ oder Punkten . angeben.

Wir empfehlen das du einen einheitlichen Kontext für alle zusammengehörenden Objekte im Raptor Server konfigurierst. Verwende beispielsweise für die Domäne example.com den Kontext example in allen Erweiterungen.

<Module name="CitrixCloudData">
    ...
    <List name="Connections">
        <ListEntry>
            <Value name="Name">ExampleAccess</Value>
            <Value name="ObjectContext">example.com</Value>
            <Value name="ClientId">...</Value>
            <Value name="ClientSecret">...</Value>
            <Value name="CustomerId">...</Value>
        </ListEntry>
        ...
    </List>
    ...
</Module>

Der Wert ConnectionType

Mit dem optionalen Wert ConnectionType wählst du das Ziel der Verbindung. Cloud verbindet die Erweiterung mit Citrix Cloud und ist der Standard. OnPremises verbindet sie mit einer lokalen Citrix Virtual Apps and Desktops-Installation.

Bei Cloud musst du ClientId, ClientSecret und CustomerId konfigurieren. Bei OnPremises benötigst du stattdessen AdministratorUserName und AdministratorPassword. Die Erweiterung ignoriert bei einer lokalen Verbindung den konfigurierten CustomerId und verwendet intern CitrixOnPremises.

<List name="Connections">
    <ListEntry>
        <Value name="Name">LocalSite</Value>
        <Value name="ObjectContext">example.com</Value>
        <Value name="ConnectionType">OnPremises</Value>
        <Value name="AdministratorUserName">EXAMPLE\RaptorService</Value>
        <Value name="AdministratorPassword">●encoded-password●</Value>
        <Value name="BaseURL">https://ddc01.example.com/</Value>
    </ListEntry>
</List>

Der Wert ClientId

Mit dem Wert ClientId definierst du den Client Identifier für eine Verbindung vom Typ Cloud. Bei einer lokalen Verbindung lässt du diesen Wert weg.

<Module name="CitrixCloudData">
    ...
    <List name="Connections">
        <ListEntry>
            <Value name="Name">ExampleAccess</Value>
            <Value name="ObjectContext">example.com</Value>
            <Value name="ClientId">example1234556</Value>
            <Value name="ClientSecret">...</Value>
            <Value name="CustomerId">...</Value>
        </ListEntry>
        ...
    </List>
    ...
</Module>

Der Wert ClientSecret

Mit dem Wert ClientSecret legst du das Client-Secret für eine Verbindung vom Typ Cloud fest. Bei einer lokalen Verbindung lässt du diesen Wert weg. Achte darauf, das Secret entsprechend zu schützen. Informationen zum Kodieren von Passwörtern und Secrets findest du im Kapitel Kodieren von Passwörtern.

<Module name="CitrixCloudData">
    ...
    <List name="Connections">
        <ListEntry>
            <Value name="Name">ExampleAccess</Value>
            <Value name="ObjectContext">example.com</Value>
            <Value name="ClientId">example1234556</Value>
            <Value name="ClientSecret">...</Value>
            <Value name="CustomerId">...</Value>
        </ListEntry>
        ...
    </List>
    ...
</Module>

Der Wert CustomerId

Den Wert CustomerId musst du für eine Verbindung vom Typ Cloud definieren. Er dient zur Authentifizierung sowie zur Auswahl der entsprechenden Site. Bei OnPremises ignoriert die Erweiterung diesen Wert und verwendet intern CitrixOnPremises.

<Module name="CitrixCloudData">
    ...
    <List name="Connections">
        <ListEntry>
            <Value name="Name">ExampleAccess</Value>
            <Value name="ObjectContext">example.com</Value>
            <Value name="ClientId">example1234556</Value>
            <Value name="ClientSecret">...</Value>
            <Value name="CustomerId">...</Value>
        </ListEntry>
        ...
    </List>
    ...
</Module>

Der Wert AdministratorUserName

Mit AdministratorUserName gibst du den Benutzernamen für eine lokale Verbindung an. Der Wert ist nur bei ConnectionType OnPremises erforderlich und darf höchstens 250 Zeichen enthalten. Verwende bei Bedarf die Form DOMÄNE\Benutzer.

Der Wert AdministratorPassword

Mit AdministratorPassword gibst du das Kennwort für eine lokale Verbindung an. Der Wert ist nur bei ConnectionType OnPremises erforderlich. Schütze das Kennwort mit der in Kodieren von Passwörtern beschriebenen Kodierung.

Der Wert StartupDelay

Mit dem optionalen Wert StartupDelay kannst du die Verzögerung in Sekunden festlegen, die vor der ersten Anfrage nach dem Start der Erweiterung gewartet werden soll.

Lässt du den Wert weg, wird der Standardwert von 10 Sekunden verwendet.

<Module name="CitrixCloudData">
    ...
    <List name="Connections">
        <ListEntry>
            <Value name="Name">ExampleAccess</Value>
            <Value name="ObjectContext">example.com</Value>
            ...
            <Value name="StartupDelay">60</Value>
            ...
        </ListEntry>
        ...
    </List>
    ...
</Module>

Der Wert RetrievalInterval

Mit dem optionalen Wert RetrievalInterval kannst du das Intervall zwischen zwei Abfragen in Sekunden festlegen. Dieser Wert definiert die Zeit, die zwischen den Abfragen vergeht.

Lässt du den Wert weg, wird der Standardwert von 60 Sekunden verwendet.

<Module name="CitrixCloudData">
    ...
    <List name="Connections">
        <ListEntry>
            <Value name="Name">ExampleAccess</Value>
            <Value name="ObjectContext">example.com</Value>
            ...
            <Value name="RetrievalInterval">120</Value>
            ...
        </ListEntry>
        ...
    </List>
    ...
</Module>

Der Wert DelayAfterError

Mit dem optionalen Wert DelayAfterError kannst du die Verzögerung in Sekunden nach einem Fehler oder einer unerwarteten Antwort von der API festlegen.

Lässt du den Wert weg, wird der Standardwert von 10 Sekunden verwendet.

<Module name="CitrixCloudData">
    ...
    <List name="Connections">
        <ListEntry>
            <Value name="Name">ExampleAccess</Value>
            <Value name="ObjectContext">example.com</Value>
            ...
            <Value name="DelayAfterError">120</Value>
            ...
        </ListEntry>
        ...
    </List>
    ...
</Module>

Der Wert ErrorCountToEscalate

Mit dem optionalen Wert ErrorCountToEscalate kannst du festlegen, wie viele Fehler auftreten dürfen, bevor das Problem als Fehler gemeldet wird. Dieser Wert stellt den Schwellenwert für die Eskalation des Problems dar.

Lässt du den Wert weg, wird der Standardwert 10 verwendet.

<Module name="CitrixCloudData">
    ...
    <List name="Connections">
        <ListEntry>
            <Value name="Name">ExampleAccess</Value>
            <Value name="ObjectContext">example.com</Value>
            ...
            <Value name="ErrorCountToEscalate">5</Value>
            ...
        </ListEntry>
        ...
    </List>
    ...
</Module>

Der Wert DelayAfterErrorEscalation

Mit dem optionalen Wert DelayAfterErrorEscalation änderst du, wie lange bis zum nächsten Verbindungsaufbau nach einem Fehler gewartet werden soll. Der Wert ist die Anzahl der Sekunden der totalen Wartezeit.

Lässt du den Wert weg, wird der Default von 600 Sekunden verwendet.

<Module name="CitrixCloudData">
    ...
    <List name="Connections">
        <ListEntry>
            <Value name="Name">ExampleAccess</Value>
            <Value name="ObjectContext">example.com</Value>
            ...
            <Value name="DelayAfterErrorEscalation">2400</Value>
            ...
        </ListEntry>
        ...
    </List>
    ...
</Module>

Der Wert RequestTimeout

Mit dem optionalen Wert RequestTimeout, änderst du wie lange die Erweiterung auf eine Antwort vom Cloud Server warten soll. Der Wert ist die Anzahl der Sekunden der totalen Wartezeit. Wird die Zeitspanne überschritten, wird der Verbindungsaufbau mit einem Fehler abgebrochen.

Lässt du den Wert weg, wird der Default von 300 Sekunden verwendet.

<Module name="CitrixCloudData">
    ...
    <List name="Connections">
        <ListEntry>
            <Value name="Name">ExampleAccess</Value>
            <Value name="ObjectContext">example.com</Value>
            ...
            <Value name="RequestTimeout">1200</Value>
            ...
        </ListEntry>
        ...
    </List>
    ...
</Module>

Der Wert BaseURL

Mit dem optionalen Wert BaseURL legst du die Basisadresse für Authentifizierung und Datenabruf fest. Für eine lokale Verbindung gibst du hier die HTTPS-Adresse des Delivery Controllers an.

Die Adresse muss mit https:// beginnen und darf neben Hostname und optionalem Port keinen Pfad, keine Anmeldedaten, Abfrage und kein Fragment enthalten. Lässt du den Wert weg, wird für Cloud-Verbindungen der Standard https://api.cloud.com/ verwendet.

<Module name="CitrixCloudData">
    ...
    <List name="Connections">
        <ListEntry>
            <Value name="Name">ExampleAccess</Value>
            <Value name="ObjectContext">example.com</Value>
            ...
            <Value name="BaseURL">https://api.cloud.com/</Value>
            ...
        </ListEntry>
        ...
    </List>
    ...
</Module>

Der Wert ApiVersion

Mit dem optionalen Wert ApiVersion wählst du die Logik für die API-Abfragen. Mögliche Werte sind:

• Initial

• June2024

Lässt du diesen Wert weg, verwendet die Erweiterung June2024. Für lokale Verbindungen ist Initial nicht zulässig.

Bemerkung

Wir raten dir von einer Veränderung dieses Wertes ab. Bitte verändere diesen Wert nur nach Rücksprache mit unserem Support Team.

Der Wert UserNameSource

Mit dem optionalen Wert UserNameSource wählst du, welches Feld aus der Benutzertabelle für den Objektnamen verwendet wird. Dabei kannst du zwischen folgenden Felder wählen:

• Name

• Sid

• Guid

• DistinguishedName

• CanonicalName

• SamName

• SamAccountName

• CommonName

• PrincipalName

Lässt du den Wert weg, wird der Default Name verwendet.

Der in dem Feld enthaltene Name wird zuerst normalisiert und danach alle Sonderzeichen mit einen Unterstrich ersetzt. Falls du weitere Teile aus dem Feldinhalt entfernen möchtest, kannst du dazu den Wert UserNameCharacterFilter verwenden.

<Module name="CitrixCloudData">
    ...
    <List name="Connections">
        <ListEntry>
            <Value name="Name">ExampleAccess</Value>
            <Value name="ObjectContext">example.com</Value>
            ...
            <Value name="UserNameSource">CommonName</Value>
            ...
        </ListEntry>
        ...
    </List>
    ...
</Module>

Der Wert UserNameCharacterFilter

Mit dem optionalen Wert UserNameCharacterFilter kannst du Elemente aus dem Feld für den Benutzernamen entfernen. Gib dazu einen gültigen regulären Ausdruck an. Jede Stelle auf den dein regulärer Ausdruck passt wird aus dem Namen entfernt.

Lässt du den Wert weg, wird nichts aus dem gewählten Feld entfernt.

<Module name="CitrixCloudData">
    ...
    <List name="Connections">
        <ListEntry>
            <Value name="Name">ExampleAccess</Value>
            <Value name="ObjectContext">example.com</Value>
            ...
            <Value name="UserNameCharacterFilter">(?:lab-|beta-)</Value>
            ...
        </ListEntry>
        ...
    </List>
    ...
</Module>

Der Wert SessionRetrievalLimit

Mit dem optionalen Wert SessionRetrievalLimit kannst du die Anzahl der Sessions, welche mit einer Abfrage zurückgegeben werden limitieren. Lässt du diesen Wert weg, wird 0 verwendet, welches die Anzahl der zurückgegebenen Sessions nicht limitiert.

Bemerkung

Wir raten dir von einer Veränderung dieses Wertes ab. Bitte verändere diesen Wert nur nach Rücksprache mit unserem Support Team.

Die Gruppe Proxy

Mit der optionalen Gruppe Proxy kannst du einen Proxyserver definieren, über den alle Verbindungen zur Citrix Cloud aufgebaut werden. Lässt du die Gruppe weg, wird kein Proxyserver für die Verbindungen verwendet.

<Module name="CitrixCloudData">
    ...
    <Group name="Proxy">
        <Value name="Type">Socks5</Value>
        <Value name="Host">proxy.example.com</Value>
        <Value name="Port">8888</Value>
        <Value name="Username">example</Value>
        <Value name="Password">password</Value>
    </Group>
    ...
</Module>

Der Wert Type

Mit dem Wert Type setzt du den Typ des Proxyservers. Mögliche Werte sind:

• None - Kein Proxyserver wird verwendet.

• Default - Die Proxyeinstellungen des Betriebssystems werden verwendet.

• Socks5 - Ein Socks 5 Proxy wird verwendet.

• Http - Ein HTTP Proxy wird verwendet.

<Module name="CitrixCloudData">
    ...
    <Group name="Proxy">
        <Value name="Type">Socks5</Value>
        <Value name="Host">proxy.example.com</Value>
        <Value name="Port">8888</Value>
        <Value name="Username">example</Value>
        <Value name="Password">password</Value>
    </Group>
    ...
</Module>

Der Wert Host

Mit dem Wert Host setzt du den DNS namen des Proxyservers, oder die IP-Adresse. Dieser Wert ist notwendig, falls du einen Socks 5 oder HTTP Proxy verwenden möchtest.

<Module name="CitrixCloudData">
    ...
    <Group name="Proxy">
        <Value name="Type">Socks5</Value>
        <Value name="Host">proxy.example.com</Value>
        <Value name="Port">8888</Value>
        <Value name="Username">example</Value>
        <Value name="Password">password</Value>
    </Group>
    ...
</Module>

Der Wert Port

Mit dem optionalen Wert Port setzt du einen eigenen Port, falls dieser vom Defaultport des Protokolls abweicht.

<Module name="CitrixCloudData">
    ...
    <Group name="Proxy">
        <Value name="Type">Socks5</Value>
        <Value name="Host">proxy.example.com</Value>
        <Value name="Port">8888</Value>
        <Value name="Username">example</Value>
        <Value name="Password">password</Value>
    </Group>
    ...
</Module>

Der Wert Username

Falls der verwendet Proxyserver einen Benutzernamen verlangt, setzt du ihn mit diesem Wert.

<Module name="CitrixCloudData">
    ...
    <Group name="Proxy">
        <Value name="Type">Socks5</Value>
        <Value name="Host">proxy.example.com</Value>
        <Value name="Port">8888</Value>
        <Value name="Username">example</Value>
        <Value name="Password">password</Value>
    </Group>
    ...
</Module>

Der Wert Password

Wenn du einen Benutzernamen verwendest, dann kannst du mit dem Wert Password das dazugehörige Passwort setzen.

<Module name="CitrixCloudData">
    ...
    <Group name="Proxy">
        <Value name="Type">Socks5</Value>
        <Value name="Host">proxy.example.com</Value>
        <Value name="Port">8888</Value>
        <Value name="Username">example</Value>
        <Value name="Password">password</Value>
    </Group>
    ...
</Module>

Konfigurationsbeispiel

Hier siehst du ein komplettes Konfigurationsbeispiel für die Erweiterung.

↓ Alles anzeigen ↓

<?xml version="1.0" encoding="UTF-8" ?>
<Configuration
        version="1"
        xmlns="http://educateit.ch/software/BlueStone/Configuration/1">

    <Module name="CitrixCloudData">
        <List name="Connections">
            <ListEntry>
                <Value name="Name">Test Access</Value>
                <Value name="ObjectContext">educateit.test</Value>
                <Value name="ClientId">***</Value>
                <Value name="ClientSecret">***</Value>
                <Value name="CustomerId">***</Value>
            </ListEntry>
        </List>

        <List name="Tables">
            <ListEntry>
                <Value name="TableType">Session</Value>
                <!-- Currently there is only Session available. -->
                <Value name="ObjectType">User</Value>
                <!-- Any, Computer, User, Application-->
                <List name="TableColumns">
                    <ListEntry>
                        <Value name="Identifier">Id</Value>
                        <Value name="IsActionParameter">Yes</Value>
                    </ListEntry>
                    <ListEntry>
                        <Value name="Identifier">ClientName</Value>
                    </ListEntry>
                    <ListEntry>
                        <Value name="Identifier">MachineName</Value>
                    </ListEntry>
                    <ListEntry>
                        <Value name="Identifier">ApplicationsInUse</Value>
                    </ListEntry>
                    <ListEntry>
                        <Value name="Identifier">Actions</Value>
                    </ListEntry>
                </List>
                <List name="TableActions">
                    <ListEntry>
                        <Value name="Label">User Action</Value>
                        <Value name="Arguments">action=usertest</Value>
                    </ListEntry>
                </List>
            </ListEntry>
            <ListEntry>
                <Value name="TableType">Session</Value>
                <Value name="ObjectType">Any</Value>
                <List name="TableColumns">
                    <ListEntry>
                        <Value name="Identifier">Id</Value>
                        <Value name="IsActionParameter">Yes</Value>
                    </ListEntry>
                    <ListEntry>
                        <Value name="Identifier">IsHidden</Value>
                    </ListEntry>
                    <ListEntry>
                        <Value name="Identifier">UserName</Value>
                    </ListEntry>
                    <ListEntry>
                        <Value name="Identifier">ClientName</Value>
                    </ListEntry>
                    <ListEntry>
                        <Value name="Identifier">MachineName</Value>
                    </ListEntry>
                    <ListEntry>
                        <Value name="Identifier">ApplicationsInUse</Value>
                    </ListEntry>
                    <ListEntry>
                        <Value name="Identifier">Actions</Value>
                    </ListEntry>
                </List>
                <List name="TableActions">
                    <ListEntry>
                        <Value name="Label">Common Action</Value>
                        <Value name="Arguments">action=commontest</Value>
                    </ListEntry>
                </List>
            </ListEntry>
        </List>

    </Module>

</Configuration>

Diagnoseinformationen

Diese Erweiterung bietet die folgenden Bezeichner für erweiterte Diagnoseinformationen an.

Bezeichner	Beschreibung
CcDataDetails	Zeigt die grundlegende Informationen der Logik der Erweiterung an.
CcDataHttpDetails	Zeigt dir die individuellen Anfragen und Antworten welche via HTTPS gemacht werden.
CcDataWatchDog	Zeigt die Details des Überwachungssystems an.