yuuvis® RAD agent installieren

yuuvis® RAD • 10.x »

yuuvis® RAD agent ist eine optionale Komponente von yuuvis® RAD, die an einem Windows-Arbeitsplatz installiert werden kann, um in direkter Verbindung mit yuuvis® RAD core-service Dokumentdateien am lokalen Arbeitsplatz zu verwalten und das Bearbeiten mit lokalen Anwendungen zu koordinieren. yuuvis® RAD agent ermöglicht beispielsweise über die Zusammenarbeit mit Office- und Outlook-Add-Ins eine direkte Übernahme von Dateien aus diesen Anwendungen. yuuvis® RAD client allein kann als Browser-Anwendung nur das Herunter- und Hochladen von Dokumentdateien ermöglichen.

Installation und Verbindungen

Die Installation von yuuvis® RAD agent erfolgt über die MSI-Datei yuuvis_rad_agent_setup_<Version>.msi an den Arbeitsplätzen. yuuvis® RAD agent wird als Autostartprogramm aktiviert und in die Taskleiste im Windowsdesktop eingebunden und von dort aufgerufen.

yuuvis® RAD agent benötigt eine Verbindung zu yuuvis® RAD core-service.

Bei der Installation über die MSI-Datei kann eine Datei connections_distributed.json mit Verbindungsprofilen verteilt werden. Die Datei muss im Verzeichnis der MSI-Datei yuuvis_rad_agent_setup_<Version>.msi liegen und wird beim Ausführen in das Verzeichnis %appdata%\Roaming\yuuvis RAD agent\store\ kopiert. Falls dort bereits Verbindungsprofile vorliegen, dann werden die Profile in der Datei connections.json zusammen geführt.

Verbindungsprofile aus der Datei connections_distributed.json werden automatisch verteilt, wenn diese Datei vor der Installation im Verzeichnis der MSI-Datei yuuvis_rad_agent_setup_<Version>.msi liegt.

[{
"id": "<String>"
"alias": "Profilbezeichnung",
"gatewayUrl": "http://<gateway-URL>",
"isConnected": false,
"selfsigned": false,
"ntlm": false,
"oauth": false,
"webClientPath": "/<client/>"
"default": true
},
{...}
]

Parameter:

id Eindeutige ID für die Verbindung
alias Profilbezeichnung für den Auswahldialog
gatewayUrl URL von yuuvis® RAD gateway
isConnected Eine Verbindungen kann über den Parameter automatisch hergestellt werden
selfsigned Wenn für HTTPS das Zertifikat selbst signiert wurde, dann benötigt der Parameter den Wert true
ntlm Für NTLM-Authentifizierungen wird der Benutzer über den Parameter "ntlm": true automatisch verbunden.
oauth Falls ein Identity Provider eingebunden ist, dann benötigt der Parameter den Wert true
webClientPath Pfad für den Webclient
default Falls Benutzer das Verbindungsprofil nicht ändern sollen, dann benötigt der Parameter den Wert true

Mehrere Verbindungen können angegeben werden. Jede braucht eine eindeutige ID.

Für die Verbindung zwischen yuuvis® RAD agent und yuuvis® RAD core-service können Verbindungsprofile administrativ über die Datei connections.json verteilt werden. Die Datei muss an den Arbeitsplätzen im Verzeichnis %appdata%\Roaming\yuuvis RAD agent\store\ angelegt werden.

Mehrere Verbindungsprofile können angegeben werden. Eine Verbindungen kann über den Parameter isConnected automatisch hergestellt werden. Bei einem Update vorheriger Versionen werden deren Verbindungsprofile übernommen. Weitere Verbindungsprofile können über die Datei connections.json hinzugefügt werden.

Für NTLM-Authentifizierungen wird der Benutzer über den Parameter "ntlm": true automatisch verbunden. Andernfalls muss der Benutzer sich als yuuvis®-Benutzer authentifizieren.

[{
"id": "<String>"
"alias": "Profilbezeichnung",
"gatewayUrl": "http://<gateway-URL>",
"isConnected": false,
"selfsigned": false,
"ntlm": false,
"oauth": false,
"webClientPath": "/<client/>"
"default": true
},
{...}
]

Mehrere Verbindungen können angegeben werden. Jede braucht eine eindeutige ID. Der Parameter default ist notwendig. "selfsigned": true ist notwendig, wenn für HTTPS das Zertifikat selbst signiert wurde.

Verbindungsprofile, die über die Datei connections.json verteilt werden, können am Arbeitsplatz über yuuvis® RAD agent nicht gelöscht oder bearbeitet werden. Änderungen an der Datei erfordern einen Neustart von yuuvis® RAD agent.

Verbindungsprofile können vom Benutzer am Arbeitsplatz angelegt werden:

  1. yuuvis® RAD agent über das Taskleistensymbol öffnen.
  2. Über das Navigations-Symbol Menü-Symbol + Verbindungen die Liste der Verbindungen öffnen.
  3. Über Neu den Verbindungsdialog öffnen.

  4. Name, Gateway-URL, und Pfad zum yuuvis® RAD client eintragen.

    Optional Single Sign-on aktivieren.

    Für OAuth2-Verbindungen werden die notwendigen Daten im Dialog entsprechend der Konfigurationsdatei oidc.json angegeben.

  5. Auf Speichern klicken.

Das Verbindungsprofil wird gespeichert.

Benutzer können über das Verbindungsprofil aus yuuvis® RAD agent yuuvis® RAD client öffnen.

Verbindung herstellen

Eine Verbindung kann der Benutzer aus yuuvis® RAD client oder yuuvis® RAD agent herstellen.

Über die Konfigurationsdatei extend.json kann administrativ eingestellt werden, dass neue Benutzer in yuuvis® RAD client gleich mit yuuvis® RAD agent verbunden werden. Abhängig von der Konfiguration der Verbindungen in yuuvis® RAD agent wird die Verbindung hergestellt oder der Verbindungsdialog von yuuvis® RAD agent geöffnet.

Eintrag in der Datei extend.json:

{
    "agent":{
        "autoconnect": true
    }
}

Benutzer können dann diese administrative Vorgabe im Einstellungsdialog von yuuvis® RAD client - Installierten Agent nutzen - nicht ändern.

Wenn die Autoconnect-Einstellung den Wert false hat, dann ist im Einstellungsdialog von yuuvis® RAD client die Option ausgeblendet. Wenn die Autoconnect-Einstellung in der Datei extend.json nicht existiert, dann ist im Einstellungsdialog von yuuvis® RAD client die Option vorhanden und der Benutzer kann die Option aktivieren.

Wenn die Autoconnect-Einstellung aktiviert ist, dann ist auch automatisch die Einstellung Dokument beim Öffnen sperren mit Immer fragen vorgeben, falls sie nicht mit dem Parameter lockSettings angegeben wird:

{
    "agent":{
        "autoconnect": true
        "lockSettings": "ask"
    }
}

Werte für lockSettings: always / never / ask

Log-Dateien

Die Log-Dateien werden von yuuvis® RAD agent in folgendem Verzeichnis angelegt:

C:\Users\<Benutzername>\AppData\Roaming\yuuvis RAD agent\logs\

Deinstallation

Deinstallieren Sie yuuvis® RAD agent über die Windows Systemsteuerung.

Update

Informationen zur Aktualisierung von Komponenten erhalten Sie über die Release-Informationen.

Konfiguration für einen angebundenen Identity Provider

Falls yuuvis® RAD agent in Umgebungen mit Identity Provider und OpenID Connect/OAuth2 eingesetzt wird, benötigen Sie zur Installation einen entsprechenden Eintrag in der Konfigurationsdatei connections.json und eine zusätzliche Konfigurationsdatei oidc.json mit den Verbindungsdaten zum Identity Provider.

connections.json

Ergänzen Sie die Datei connections.json um folgenden Eintrag: "oauth": true

oidc.json

Über die Konfigurationsdatei oidc.json werden die Verbindungsdaten zum Identity Provider angegeben.

  • Legen Sie in den Verzeichnissen %appdata%\yuuvis RAD agent\ das Verzeichnis oidc an.

  • Legen Sie dort die Datei oidc.json an.

  • Tragen Sie folgendes in die Datei ein:

    {
      "tenant": "tenant",
      "issuer": "realm url",
      "openid_configuration": "OpenID Endpoint Configuration url",
      "client_id": "client id"
    }

    Geben Sie die Daten entsprechend der Konfiguration des Identity Providers an.