Online Help > Knowledge Base > Protocols and application > Remote Desktop Manager

Web protocol handler

Description

 

A Web Protocol Handler (also called URL Protocol Handler) has been implemented in Remote Desktop Manager to be able to launch a session directly from an HTML content. This can be very useful to call Remote Desktop Manager from a Configuration Management Database (CMDB) or even a Document Management System (DMS).

 

Internet Explorer and Mozilla Firefox execute the URL by clicking on it or by pressing Enter. However, with some other web browser such as Google Chrome, executing the URL normally results in a web search. These browsers may require to do Ctrl + Click or Ctrl + Enter to execute the URL.

 

Scenarios

 

There are two ways of using the handler:

 

1.Generate a URL for a session (basically every entry type that connects to a remote device using a protocol)

2.Generate a URL for a template, this will allow you to specify the host name of the device you wish to connect to, but it will take the settings of the template.

 

Parameters

 

Here are the parameters that can be use to build a protocol handler URL. They are for advanced scenarios, as only the DataSource and Session IDs are enough to open a connection.

 

Please note that the DataSource parameter overrides the data source which the application connects to at start-up. This applies even if the user is prompted for a data source to connect to when the application starts.

 

PARAMETER

DESCRIPTION

DataSource

Indicate the data source or the database ID.

Find them in the IDs section of the Advanced properties of an entry.

A data source ID is unique per installation, which makes the URL usable only by the workstation where the data source has been created. By default Remote Desktop Manager generates the URL with the database ID.

Session

Indicate the ID of a session. Find it in the Session ID field in the Advanced properties of a session.

Template

Indicate the ID of the template of an entry. The template parameter retrieves some properties of a template and uses them against the session parameter. The host parameter is required when using the template parameter.

Host

Indicate the hostname or IP address of the remote device. Used along with the template parameter, or to override the host property of the session parameter.

Port

Indicate the port to use. Used to override the port property of the session or template parameter.

Username

Indicate the username to use. Used to override the username property of the session or template parameter.

Password

Indicate the password to use. Used to override the password property of the session or template parameter.

Domain

Indicate the domain to use. Used to override the domain property of the session or template parameter.

Title

Indicate the title of the tab when a session is launched using the embedded display mode. This can be very useful when several sessions are launched at the same time.

Filter

Populate the Search field.

Tabpage

Give the focus to a tab in the dashboard after the application has completed the startup procedure. Available only with the Select action. The possible tabs are:

 

Overview

Documentation

MacroScriptTool

RemoteTools

Information

SubConnections

Attachments

Logs

 

Actions

 

Open: open the specified connection.

Find: find sessions by host.

Edit: edit the specified connection.

View: view the password of the specified entry.

OpenWithMacro: open the specified with a macro.

Select: select a connection in the navigation pane (allows to select a tab in the dashboard as well).

 

Syntax

 

Syntax:

rdm://<action>?<parameter1>=<value>[&<parameter2>=<value>]

 

The base syntax of the protocol handler requires the application protocol, an action, and at least one parameter to work with.

 

There are three rules to follow when constructing an URL for the protocol handler:

 

The action is separated from the parameters with a question mark (?).

Each parameter is assigned a value by using an equal sign (=).

Parameter/Value pairs are separated with an ampersand (&).

 

Examples

 

Open Remote Desktop Manager with the search/filter field populated and the focus on the Dashboard

rdm://open?Filter=RDP&Tabpage=Dashboard

 

Open an RDP session

1.In the Advanced section of an entry properties, click on the Create Web Url button.

 

Create Web Url

Create Web Url

 

2.The Url is stored in the clipboard.
 

Url copied to clipboard

Url copied to clipboard

 

3.Paste (Ctrl+V) this Url in any application able to handle application protocols. It can be in a web page, a web browser address bar, or even a supported chat application. The protocol handler launches Remote Desktop Manager if it is closed, then perform the requested action with the provided parameters.