Installing yuuvis® RAD agent

yuuvis® RAD • 10.x »

yuuvis® RAD agent is an optional component of yuuvis® RAD, which can be installed on a Windows workstation to manage document files on the local workstation in direct connection with yuuvis® RAD core-service and coordinate editing with local applications. yuuvis® RAD agent enables, for example, the direct transfer of files from these applications by working with Office and Outlook add-ins. As a browser application, yuuvis® RAD client alone only supports the downloading and uploading of document files.

Installation and Connections

yuuvis® RAD agent is installed via the MSI file yuuvis_rad_agent_setup_<Version>.msi on the workstations. yuuvis® RAD agent is activated as a startup program and integrated in the Windows desktop task bar, from which it is also called up.

yuuvis® RAD agent requires a connection to yuuvis® RAD core-service.

When installing via the MSI file, a connections_distributed.json file can be distributed with connection profiles. The file must be located in the directory of the yuuvis_rad_agent_setup_<Version>.msi MSI file and will be copied to the %appdata%\Roaming\yuuvis RAD agent\store\ directory when executed. If there are already connection profiles there, the profiles are merged in the connections.json file.

Connection profiles from the connections_distributed.json file are automatically distributed if this file is located in the yuuvis_rad_agent_setup_<Version>.msi MSI file directory before installation.

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

Parameters:

id Unique ID for the connection
alias Profile name for the selection dialog
gatewayUrl URL of yuuvis® RAD gateway
isConnected A connection can be established automatically via the parameter.
selfsigned If the certificate was self-signed for HTTPS, the parameter must be true.
ntlm The user is automatically connected for NTLM authentication via the "ntlm": true parameter.
oauth If an Identity Provider is included, the parameter must be true.
webClientPath Path for the web client
default If users should not be allowed to change the connection profile, the parameter needs to be set to true.

Multiple connections can be specified. Each one needs a unique ID.

For the connection between yuuvis® RAD agent and yuuvis® RAD core-service, administrators can distribute connection profiles via the connections.json file. The file must be created at the workstations in the %appdata%\Roaming\yuuvis RAD agent\store\ directory.

Multiple connection profiles can be specified. A connection can be established automatically via the isConnected parameter. When updating previous versions, their connection profiles are adopted. Additional connection profiles can be added via the connections.json file.

The user is automatically connected for NTLM authentication via the "ntlm": true parameter. Otherwise the user will need to verify his or her identify as a yuuvis® user for authentication purposes.

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

Multiple connections can be specified. Each one needs a unique ID. The default parameter is required. "selfsigned": true is necessary if the certificate was self-signed for HTTPS.

Connection profiles allocated via the connections.json file cannot be deleted or edited on the workstation using yuuvis® RAD agent. Changes to the file require yuuvis® RAD agent to be restarted.

Connection profiles can be created by the user on the workstation:

  1. Open yuuvis® RAD agent via the task bar icon.
  2. Open the list of connections via the Navigation icon Menu icon > Connections.
  3. Open the connection dialog via New.

  4. Enter the name, gateway URL, and path to yuuvis® RAD client.

    Enable Single Sign-on, if desired.

    The necessary data for OAuth2connections is specified in the dialog according to the oidc.json configuration file.

  5. Click Save.

The connection profile is saved.

Via the connection profile from yuuvis® RAD agent, users can open yuuvis® RAD client.

Establishing a Connection

The user can establish a connection from yuuvis® RAD client or yuuvis® RAD agent.

The system administrator can use the configuration file extend.json to configure that new users in yuuvis® RAD client are immediately connected to yuuvis® RAD agent. Depending on the configuration of the connections in yuuvis® RAD agent, the connection is established or the yuuvis® RAD agent connection dialog is opened.

Entry in the extend.json file:

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

Users can use – but not edit – this administrative parameter in the yuuvis® RAD client settings dialog – Use installed agent.

If the autoconnect setting has the value false, then the option is hidden in the yuuvis® RAD client settings dialog. If the autoconnect setting does not exist in the extend.json file, then in the yuuvis® RAD client settings dialog the option is available and the user can enable the option.

If the autoconnect setting is enabled, Lock document on open is automatically set to Always ask if it is not indicated with the lockSettings parameter:

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

Values for lockSettings: always / never / ask

Log Files

The log files are created by yuuvis® RAD agent in the following directory:

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

Uninstalling

You can uninstall yuuvis® RAD agent via the Windows Control Panel.

Updates

For information on updating components, see Release Information.

Configuration for a connected Identity Provider

If yuuvis® RAD agent is used in environments with Identity Provider and OpenID Connect/OAuth2, installation requires that you make a corresponding entry in the connections.json configuration file and set up an additional configuration file oidc.json that provides connection data to the Identity Provider.

connections.json

Add the following entry to the connections.json file: "oauth": true

oidc.json

The oidc.json configuration file is used to specify the connection data to the Identity Provider.

  • Create the oidc directory in the %appdata%\yuuvis RAD agent\ directories.

  • Create the oidc.json file there.

  • Enter the following in the file:

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

    Specify the data according to the Identity Provider configuration.