Online Help > Entry Types

Variables

Description

 

Variables can be used in any entry's configuration or with any templates. The variables will be replaced by their corresponding values just prior to establishing a connection.

 

You can select a variable by double clicking on it directly in the dialog. For ease of use there is a button at the bottom of the edition screen that allows you to select a variable to insert in the currently focused field.

 

Variables

Variables

 

Variables are case-sensitive and must be typed in UPPERCASE.

 

Settings

 

Entry variables

Entry variables

 

The variables are classify under multiple tabs. Not all contexts are available depending on the entry being edited, for example the Parent tab is present only when editing a sub connection.

 

General

 

$PASSWORD$: For security reason, this is only available with the command line session type and some specific types. You must enable it in the Security settings of the entry with "Allow password in variable" option.

For an Advanced Data Source, the administrator can disable usage of this variable for the whole data source.

 

Entry variables

OPTION

DESCRIPTION

$APPLICATION_NAME$

Returns the application name.

$CONTACT_DOMAIN$

Returns the contact's domain.

$CONTACT_PASSWORD$

Returns the contact's password.

$CONTACT_USERNAME$

Returns the contact's username.

$CURRENT_CLIPBOARD$

Returns the current clipboard content.

$CUSTOM_FIELD1$

Returns the custom field field 1 value.

$CUSTOM_FIELD2$

Returns the custom field field 2 value.

$CUSTOM_FIELD3$

Returns the custom field field 3 value.

$CUSTOM_FIELD4$

Returns the custom field field 4 value.

$CUSTOM_FIELD5$

Returns the custom field field 5 value.

$DATA_SOURCE_ID$

Returns the data source id for the current session.

$DOMAIN$

Returns the domain found in the configured credentials.

$DYNAMIC_PORT$

Returns the dynamic port used when the entry uses an SSH VPN with a dynamic port set up.

$HOST$

Returns the host name if it's available (server name or IP addess...).

$HOST_WITH_PORT$

Returns the host including the port if it is available.

$HOST_WITHOUT_DOMAIN$

Returns the host name without the domain if it is available.

$INFORMATION_COMPANY$

Returns the company specified in information.

$INFORMATION_EMAIL$

Returns the email specified in information.

$INFORMATION_IP$

Returns the information IP.

$INFORMATION_MACHINE_NAME$

Returns the machine name specified in information.

$IP$

Returns the IP specified in information.

$KEYWORDS$

Returns the keywords/tags.

$MAC$

Returns the MAC address specified in information.

$MACHINE_DOMAIN$

Returns the machine domain specified in information.

$MACRO_PASSWORD$

Returns the typing macro password.

$NAME$

Returns the entry name.

$ONE_TIME_PASSWORD$

Returns a timed one time password.

$PASSWORD$

This variable is replaced by the password. It's only available when enabled in the advanced options.

$PORT$

Returns the host port if it's available and when it's not the default.

$QUICK_CONNECT$

This variable is replaced by the quick connect value (Note). Use this variable when you create a template used specifically for the quick connect.

$REMOTE_MANAGEMENT_SERVER$

Returns the Remote Management Server url (if configured).

$REMOTE_MANAGEMENT_SERVER_HOST$

Returns the host part of the Remote Management Server url (if configured).

$SERIAL$

Returns the serial number from invoice tab.

$SERVICE_TAG$

Returns the service tag field specified in information.

$SESSION_ID$

Returns the current session id (guid).

$TAGS$

Returns the tags.

$TOOL_DOMAIN$

Returns the tool domain.

$TOOL_PASSWORD$

Returns the tool password.

$TOOLS_USERNAME$

Returns the tool username.

$USERNAME$

Returns the user name found in the configured credentials.

$VIRTUAL_MACHINE_ID$

Returns the virtual machine ID specified in information.

$VIRTUAL_MACHINE_TYPE$

Returns the virtual machine's type.

$VPN_DOMAIN$

Returns the VPN's domain.

$VPN_HOST$

Returns the VPN's host.

$VPN_PASSWORD$

Returns the VPN's password.

$VPN_USERNAME$

Returns the VPN's username.

 

Global variables

OPTION

DESCRIPTION

$APPLICATION_PATH$

Returns the application path.

$APPLICATION_USER$

Returns the current data source logged user.

$DATE$

Returns the current date.

$DATE_TEXT$

Returns the current date in a text format to use in a file name. Ex: January 30th 2013 - 20130130.

$DATE_TEXT_ISO$

Returns the current date in a basic ISO 8601 format. EX: January 30th 2013 - 20130130.

$FULLSCREEN_HEIGHT$

Returns the screen full screen height.

$FULLSCREEN_WIDTH$

Returns the screen full screen width.

$LOCAL_IP$

Returns the local IP v4 address.

$MY_MACHINE_NAME$

Returns the current machine name.

$PUBLIC_IP$

Returns the public IP exposed on the internet.

$TIME$

Returns the current time.

$TIME_TEXT$

Returns the current time in a text format to use in a file name. EX: 8h15 30 - 081530

$TIME_TEXT_ISO$

Returns the text of the current time in the basic ISO 8601 format. EX: 8h15 30 - 081530

$WORKAREA_HEIGHT$

Returns the screen work area height.

$WORKAREA_WIDTH$

Returns the screen work area width.

 

Global - Data Source variables

OPTION

DESCRIPTION

$DATA_SOURCE_DOMAIN$

Returns the current data source domain.

$DATA_SOURCE_NAME$

Returns the current data source name.

$DATA_SOURCE_PASSWORD$

Returns the current data source password.

$DATA_SOURCE_USERNAME$

Returns the current data source user name.

$DATA_SOURCE_USERPROFILE_EMAIL$

Returns the current data source user's email.

$DATA_SOURCE_USERPROFILE_FIRSTNAME$

Returns the current data source user's firstname.

$DATA_SOURCE_USERPROFILE_LASTNAME$

Returns the current data source user's lastname.

$DATA_SOURCE_USERPROFILE_PHONE$

Returns the current data source user's phone number.

 

Environment Variables

 

This context allows you to access ANY environment variable defined in your system. The ones available in the form are the standard ones, but any value enclosed by the percent sign will be expanded using the Windows environment. You could use this to set a custom security token in your user profile and use it from within Remote Desktop Manager.

 

OPTION

DESCRIPTION

%ALLUSERSPROFILE%

C:\ProgramData

%APPDATA%

C:\Users\{username}\AppData\Roaming

%COMMONPROGRAMFILES%

C:\Program Files\Common Files

%COMMONPROGRAMFILES(x86)%

C:\Program Files (x86)\Common Files

%COMPUTERNAME%

{computername}

%COMSPEC%

C:\Windows\System32\cmd.exe

%HOMEDRIVE%

C:

%HOMEPATH%

\Users\{username}

%LOCALAPPDATA%

C:\Users\{username}\AppData\Local

%LOGONSERVER%

\\{domain_logon_server}

%PATH%

C:\Windows\system32;C:\Windows;C:\Windows\System32\Wbem;{plus program paths}

%PATHEXT%

.com;.exe;.bat;.cmd;.vbs;.vbe;.js;.jse;.wsf;.wsh;.msc

%PROGRAMDATA%

%SystemDrive%\ProgramData

%PROGRAMFILES%

%SystemDrive%\Program Files

%PROGRAMFILES(X86)%

%SystemDrive%\Program Files (x86) (only in 64-bit version)

%PROMPT%

Code for current command prompt format. Code is usually $P$G {Drive}:

%PSModulePath%

%SystemRoot%\system32\WindowsPowerShell\v1.0\Modules\

%PUBLIC%

%SystemDrive%\Users\Public

%SystemDrive%

C:

%SystemRoot%

%SystemDrive%\Windows

%TEMP%

%SystemDrive%\Users\{username}\AppData\Local\Temp

%TMP%

%SystemDrive%\Users\{username}\AppData\Local\Temp

%USERDOMAIN%

{userdomain}

%USERNAME%

{username}

%USERPROFILE%

%SystemDrive%\Users\{username}

%WINDIR%

C:\Windows

 

Group

 

Parent

This context exists only when in a sub-connection. It returns the corresponding value taken from the parent entry.

 

$PARENT_PASSWORD$: For security reason, this is only available for use in the keyboard macro. If you must use the credentials stored in the parent to connect, you must choose Parent in the credentials drop down list of the general tab.

 

OPTION

DESCRIPTION

$PARENT_APPLICATION_NAME$

Returns the application name.

$PARENT_CURRENT_CLIPBOARD$

Returns the current clipboard content.

$PARENT_CUSTOM_FIELD1$

Returns the parent custom field field 1 value.

$PARENT_CUSTOM_FIELD2$

Returns the parent custom field field 2 value.

$PARENT_CUSTOM_FIELD3$

Returns the parent custom field field 3 value.

$PARENT_CUSTOM_FIELD4$

Returns the parent custom field field 4 value.

$PARENT_CUSTOM_FIELD5$

Returns the parent custom field field 5 value.

$PARENT_DOMAIN$

Returns the parent domain found in the parent configured credentials.

$PARENT_HOST$

Returns the parent host name if it's available (server name or IP address...).

$PARENT_HOST_WITH_PORT$

Returns the parent host including the port if it's specified.

$PARENT_HOST_WITHOUT_DOMAIN$

Returns the host name without the domain if it's available.

$PARENT_INFORMATION_COMPANY$

Returns the company specified in the parent information.

$PARENT_INFORMATION_EMAIL$

Returns the email specified in information.

$PARENT_INFORMATION_MACHINE_NAME$

Returns the machine name specified in information.

$PARENT_IP$

Returns the IP address specified in parent information.

$PARENT_MAC$

Returns the MAC address defined.

$PARENT_MACRO_PASSWORD$

Returns the typing macro password.

$PARENT_NAME$

Returns the session name.

$PARENT_PASSWORD$

Returns the password from the parent configured credentials. It's only available when enabled in the parent advanced options.

$PARENT_PORT$

Returns the host port if it's available (server name, IP address...).

$PARENT_SERIAL$

Returns the serial number in the invoice tab.

$PARENT_SERVICE_TAGS$

Returns the service tag field located in the information tab.

$PARENT_SESSION_ID$

Returns the parent session id (guid).

$PARENT_TOOL_DOMAIN$

Returns the tool domain.

$PARENT_TOOL_PASSWORD$

Returns the tool password.

$PARENT_TOOL_USERNAME$

Returns the tool user name.

$PARENT_USERNAME$

Returns the user name from the parent configured credentials.

$PARENT_VIRTUAL_MACHINE_ID$

Returns the virtual machine ID specified in information.

 

Database

The following context will find any Database entry type as long as it is in the hierarchy above you current entry. If there is multiple matches it will take the entry closest in the hierarchy to the current entry.

 

OPTION

DESCRIPTION

$DB_APPLICATION_NAME$

Returns the application name.

$DB_CURRENT_CLIPBOARD$

Returns the current clipboard content.

$DB_CUSTOM_FIELD1$

Returns the database custom field field 1 value.

$DB_CUSTOM_FIELD2$

Returns the database custom field field 2 value.

$DB_CUSTOM_FIELD3$

Returns the database custom field field 3 value.

$DB_CUSTOM_FIELD4$

Returns the database custom field field 4 value.

$DB_CUSTOM_FIELD5$

Returns the database custom field field 5 value.

$DB_DOMAIN$

Returns the domain found in the configured credentials.

$DB_INFORMATION_COMPANY$

Returns the company specified in the database information.

$DB_INFORMATION_EMAIL$

Returns the information email.

$DB_INFORMATION_MACHINE_NAME$

Returns the information machine name.

$DB_NAME$

Returns the session name.

$DB_SERIAL$

Returns the serial number in the invoice tab.

$DB_SERVICE_TAG$

Returns the service tag field located in the information tab.

$DB_VIRTUAL_MACHINE_ID$

Returns the virtual machine ID.

 

Domain

The following context will find any Domain entry type as long as it is in the hierarchy above you current entry. If there is multiple matches it will take the entry closest in the hierarchy to the current entry.

 

OPTION

DESCRIPTION

$DOMAIN_APPLICATION_NAME$

Returns the application name.

$DOMAIN_CURRENT_CLIPBOARD$

Returns the current clipboard content.

$DOMAIN_CUSTOM_FIELD1$

Returns the domain custom field field 1 value.

$DOMAIN_CUSTOM_FIELD2$

Returns the domain custom field field 2 value.

$DOMAIN_CUSTOM_FIELD3$

Returns the domain custom field field 3 value.

$DOMAIN_CUSTOM_FIELD4$

Returns the domain custom field field 4 value.

$DOMAIN_CUSTOM_FIELD5$

Returns the domain custom field field 5 value.

$DOMAIN_DOMAIN$

Returns the domain found in the configured credentials.

$DOMAIN_INFORMATION_COMPANY$

Returns the company specified in the domain information.

$DOMAIN_INFORMATION_EMAIL$

Returns the information email.

$DOMAIN_INFORMATION_MACHINE_NAME$

Returns the information machine name.

$DOMAIN_NAME$

Returns the session name.

$DOMAIN_SERIAL$

Returns the serial number in the invoice tab.

$DOMAIN_SERVICE_TAG$

Returns the service tag field located in the information tab.

$DOMAIN_VIRTUAL_MACHINE_ID$

Returns the virtual machine ID.

 

Company

The following context will find any Company entry type as long as it is in the hierarchy above you current entry. If there is multiple matches it will take the entry closest in the hierarchy to the current entry.

 

OPTION

DESCRIPTION

$COMPANY_APPLICATION_NAME$

Returns the application name.

$COMPANY_CURRENT_CLIPBOARD$

Returns the current clipboard content.

$COMPANY_CUSTOM_FIELD1$

Returns the company custom field field 1 value.

$COMPANY_CUSTOM_FIELD2$

Returns the company custom field field 2 value.

$COMPANY_CUSTOM_FIELD3$

Returns the company custom field field 3 value.

$COMPANY_CUSTOM_FIELD4$

Returns the company custom field field 4 value.

$COMPANY_CUSTOM_FIELD5$

Returns the company custom field field 5 value.

$COMPANY_DOMAIN$

Returns the domain found in the configured credentials.

$COMPANY_INFORMATION_COMPANY$

Returns the company specified in the company information.

$COMPANY_INFORMATION_EMAIL$

Returns the information email.

$COMPANY_INFORMATION_MACHINE_NAME$

Returns the information machine name.

$COMPANY_NAME$

Returns the session name.

$COMPANY_SERIAL$

Returns the serial number in the invoice tab.

$COMPANY_SERVICE_TAG$

Returns the service tag field located in the information tab.

$COMPANY_VIRTUAL_MACHINE_ID$

Returns the virtual machine ID.

 

Software

The following context will find any Software entry type as long as it is in the hierarchy above you current entry. If there is multiple matches it will take the entry closest in the hierarchy to the current entry.

 

OPTION

DESCRIPTION

$SOFTWARE_APPLICATION_NAME$

Returns the application name.

$SOFTWARE_CURRENT_CLIPBOARD$

Returns the current clipboard content.

$SOFTWARE_CUSTOM_FIELD1$

Returns the custom field field 1 value.

$SOFTWARE_CUSTOM_FIELD2$

Returns the custom field field 2 value.

$SOFTWARE_CUSTOM_FIELD3$

Returns the custom field field 3 value.

$SOFTWARE_CUSTOM_FIELD4$

Returns the custom field field 4 value.

$SOFTWARE_CUSTOM_FIELD5$

Returns the custom field field 5 value.

$SOFTWARE_DOMAIN$

Returns the domain found in the configured credentials.

$SOFTWARE_INFORMATION_COMPANY$

Returns the information Company.

$SOFTWARE_INFORMATION_EMAIL$

Returns the information email.

$SOFTWARE_INFORMATION_MACHINE_NAME$

Returns the information machine name.

$SOFTWARE_NAME$

Returns the session name.

$SOFTWARE_SERIAL$

Returns the serial number in the invoice tab.

$SOFTWARE_SERVICE_TAG$

Returns the service tag field located in the information tab.

$SOFTWARE_VIRTUAL_MACHINE_ID$

Returns the virtual machine ID.

 

Site

The following context will find any Site entry type as long as it is in the hierarchy above you current entry. If there is multiple matches it will take the entry closest in the hierarchy to the current entry.

 

OPTION

DESCRIPTION

$SITE_APPLICATION_NAME$

Returns the application name.

$SITE_CURRENT_CLIPBOARD$

Returns the current clipboard content.

$SITE_CUSTOM_FIELD1$

Returns the site custom field field 1 value.

$SITE_CUSTOM_FIELD2$

Returns the site custom field field 2 value.

$SITE_CUSTOM_FIELD3$

Returns the site custom field field 3 value.

$SITE_CUSTOM_FIELD4$

Returns the site custom field field 4 value.

$SITE_CUSTOM_FIELD5$

Returns the site custom field field 5 value.

$SITE_DOMAIN$

Returns the domain found in the configured credentials.

$SITE_INFORMATION_COMPANY$

Returns the company specified in the site information.

$SITE_INFORMATION_EMAIL$

Returns the information email.

$SITE_INFORMATION_MACHINE_NAME$

Returns the information machine name.

$SITE_NAME$

Returns the session name.

$SITE_SERIAL$

Returns the serial number in the invoice tab.

$SITE_SERVICE_TAG$

Returns the service tag field located in the information tab.

$SITE_VIRTUAL_MACHINE_ID$

Returns the virtual machine ID.

 

Computer/Hardware

The following context will find any Device, Printer and Workstation entry type as long as it is in the hierarchy above your current entry. If there is multiple matches it will take the entry closest in the hierarchy to the current entry.

 

OPTION

DESCRIPTION

$COMPUTER_APPLICATION_NAME$

Returns the application name.

$COMPUTER_CURRENT_CLIPBOARD$

Returns the current clipboard content.

$COMPUTER_CUSTOM_FIELD1$

Returns the computer custom field field 1 value.

$COMPUTER_CUSTOM_FIELD2$

Returns the computer custom field field 2 value.

$COMPUTER_CUSTOM_FIELD3$

Returns the computer custom field field 3 value.

$COMPUTER_CUSTOM_FIELD4$

Returns the computer custom field field 4 value.

$COMPUTER_CUSTOM_FIELD5$

Returns the computer custom field field 5 value.

$COMPUTER_DOMAIN$

Returns the computer domain found in the configured credentials.

$COMPUTER_HOST$

Returns the host name if it's available (server name, IP address...).

$COMPUTER_HOST_WITHOUT_DOMAIN$

Returns the host name without the domain if it's available.

$COMPUTER_INFORMATION_COMPANY$

Returns the company specified in the computer information.

$COMPUTER_INFORMATION_EMAIL$

Returns the information email.

$COMPUTER_INFORMATION_MACHINE_NAME$

Returns the information machine name.

$COMPUTER_IP$

Returns the IP Address.

$COMPUTER_MAC$

Returns the MAC address defined.

$COMPUTER_NAME$

Returns the session name.

$COMPUTER_SERIAL$

Returns the serial number in the invoice tab.

$COMPUTER_SERVICE_TAG$

Returns the service tag field located in the information tab.

$COMPUTER_VIRTUAL_MACHINE_ID$

Returns the virtual machine ID.

 

Identity

The following context will find any Identity entry type as long as it is in the hierarchy above you current entry. If there is multiple matches it will take the entry closest in the hierarchy to the current entry.

 

OPTION

DESCRIPTION

$IDENTITY_APPLICATION_NAME$

Returns the application name.

$IDENTITY_CURRENT_CLIPBOARD$

Returns the current clipboard content.

$IDENTITY_CUSTOM_FIELD1$

Returns the identity custom field field 1 value.

$IDENTITY_CUSTOM_FIELD2$

Returns the identity custom field field 2 value.

$IDENTITY_CUSTOM_FIELD3$

Returns the identity custom field field 3 value.

$IDENTITY_CUSTOM_FIELD4$

Returns the identity custom field field 4 value.

$IDENTITY_CUSTOM_FIELD5$

Returns the identity custom field field 5 value.

$IDENTITY_DOMAIN$

Returns the domain found in the configured credentials.

$IDENTITY_INFORMATION_COMPANY$

Returns the company specified in the identity information.

$IDENTITY_INFORMATION_EMAIL$

Returns the information email.

$IDENTITY_INFORMATION_MACHINE_NAME$

Returns the information machine name.

$IDENTITY_NAME$

Returns the session name.

$IDENTITY_SERIAL$

Returns the serial number in the invoice tab.

$IDENTITY_SERVICE_TAG$

Returns the service tag field located in the information tab.

$IDENTITY_VIRTUAL_MACHINE_ID$

Returns the virtual machine ID.

 

Customer

The following context will find any Customer entry type as long as it is in the hierarchy above you current entry. If there IS multiple matches it will take the entry closest in the hierarchy to the current entry.

 

OPTION

DESCRIPTION

$CUSTOMER_APPLICATION_NAME$

Returns the application name.

$CUSTOMER_CURRENT_CLIPBOARD$

Returns the current clipboard content.

$CUSTOMER_CUSTOM_FIELD1$

Returns the customer custom field field 1 value.

$CUSTOMER_CUSTOM_FIELD2$

Returns the customer custom field field 2 value.

$CUSTOMER_CUSTOM_FIELD3$

Returns the customer custom field field 3 value.

$CUSTOMER_CUSTOM_FIELD4$

Returns the customer custom field field 4 value.

$CUSTOMER_CUSTOM_FIELD5$

Returns the customer custom field field 5 value.

$CUSTOMER_DOMAIN$

Returns the domain found in the configured credentials.

$CUSTOMER_INFORMATION_COMPANY$

Returns the company specified in the customer information.

$CUSTOMER_INFORMATION_EMAIL$

Returns the information email.

$CUSTOMER_INFORMATION_MACHINE_NAME$

Returns the information machine name.

$CUSTOMER_NAME$

Returns the session name.

$CUSTOMER_SERIAL$

Returns the serial number in the invoice tab.

$CUSTOMER_SERVICE_TAG$

Returns the service tag field located in the information tab.

$CUSTOMER_VIRTUAL_MACHINE_ID$

Returns the virtual machine ID.

 

 

Custom fields

 

Custom fields can contain any required data and can be accessed using the *_CUSTOM_FIELD* variables. Please refer to Custom Fields for details.

 

Quick Connect

 

The $QUICK_CONNECT$ variable will be replaced by the value in the Quick Connect control as described in Quick Connect. It is only useful when a template connection is selected.