Custom Integration Quickstart Guide

Web Server Options

You can either deploy the Custom Integration on your own web server or use the built-in web server included with RD WebServices.

Built-in Web Server

The built-in web server is available at:
https://<Hostname>/webclientci
The associated files are stored in:

Windows: C:\ProgramData\Thincast\RDWebServices\webclientci
Linux: /var/lib/rdwebservices/webclientci

Preparations

Custom Integration Example Files

The example files for Custom Integration are installed in:

Windows: C:\ProgramData\Thincast\RDWebServices\webclientci-examples
Linux: /usr/share/doc/rdwebservices/webclientci-examples

To use the Embedded Client or File Client examples, copy the desired files from the example directory to your web server directory.

Create a Custom Integration Token

Open the RD WebServices Admin interface and navigate to:
WebClient -> Custom Integration
Create a new Custom Integration Token and store the generated value.

Add Custom Integration User to Policies

Custom Integration connections require that the user account
BUILTIN\RDWebClient-CustomIntegrationUser
is added to both a Client Policy and a Server Policy.

To configure this:

Open the desired Client Policy, switch to the Requirements tab, and add the user.
Open the desired Server Policy, switch to Users/Groups, and add the same user.

Embedded Client Example

Copy the file embedded_template.html from the example directory to your web server directory (e.g. rename it to example1.html) and open it in a text editor. Configure the following parameters:

g_rdWebServicesHost: Hostname where RD WebServices is installed
g_accessToken: Custom Integration access token created earlier
g_ssoToken: Optional SSO token for automatic authentication
g_config: RDP configuration in .rdp file syntax

After configuring the file, open the example via the built-in web server:
https://<Hostname>/webclientci/example1.html

File Client Example

Copy file.html from the example directory into your web server directory. Then place the RDP file that you want to load (e.g. rdpfile.rdp) in the same directory. Edit the RDP file and ensure that the following entries are included:

rdwchost:s:<Hostname>
rdwcgatewaytoken:s:<AccessToken>
rdwcssotoken:s:<SSOToken> (optional for automatic login)

To start the RD WebClient using the built-in web server, open:
https://<Hostname>/webclientci/file.html?file=rdpfile.rdp