Online Help > Entry Types

Variables

Description

 

Session variables can be used in any session 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

 

BadgeInfo48x48

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

 

Settings

 

Variables list

Variables list

 

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

 

ShieldCaution48x48

$PASSWORD$: For security reason, this is only available with some specific session types. You must enable it in the Security section 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$

Return the application name

$CONTACT_DOMAIN$

Return the contact's domain

$CONTACT_PASSWORD$

Return the contact's password

$CONTACT_USERNAME$

Return the contact's username

$CURRENT_CLIPBOARD$

Return the current clipboard content

$CUSTOM_FIELD1$

Return the custom field field 1 value

$CUSTOM_FIELD2$

Return the custom field field 2 value

$CUSTOM_FIELD3$

Return the custom field field 3 value

$CUSTOM_FIELD4$

Return the custom field field 4 value

$CUSTOM_FIELD5$

Return the custom field field 5 value

$DATASOURCE_ID$

Return the data source id for the current session

$DOMAIN$

Return the domain found in the configured credentials

$HOST$

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

$HOST_WITH_PORT$

Return the host including the port if it is available

$HOST_WITHOUT_DOMAIN$

Return the host name without the domain if it is available

$INFORMATION_COMPANY$

Return the company specified in information

$INFORMATION_EMAIL$

Return the email specified in information

$INFORMATION_MACHINE_NAME$

Return the machine name specified in information

$IP$

Return the IP specified in information

$MAC$

Return the MAC address specified in information

$MACHINE_DOMAIN$

Return the machine domain specified in information

$MACRO_PASSWORD$

Return the typing macro password

$NAME$

Return the entry name

$PASSWORD$

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

$PORT$

Return 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.

$REMOTE_MANAGEMENT_SERVER$

Return the Remote Management Server url (if configured)

$REMOTE_MANAGEMENT_SERVER_HOST$

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

$SERIAL$

Return the serial number from invoice tab

$SERVICE TAGS$

Return the service tag field specified in information

$SESSION_ID$

Return the current session id (guid)

$TOOL_DOMAIN$

Return the tool domain

$TOOL_PASSWORD$

Return the tool password

$TOOLS_USERNAME$

Return the tool username

$USERNAME$

Return the user name found in the configured credentials

$VIRTUAL_MACHINE_ID$

Return the virtual machine ID specified in information

$VPN_DOMAIN$

Return the VPN's domain

$VPN_HOST$

Return the VPN's host

$VPN_PASSWORD$

Return the VPN's password

$VPN_USERNAME$

Return the VPN's username

 

Global variables

 

Option

Description

$APPLICATION_PATH$

Return the application path

$APPLICATION_USER$

Return the current data source logged user

$DATE$

Return the current date

$DATE_TEXT$

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

$DATE_TEXT_ISO$

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

$FULLSCREEN_HEIGHT$

Return the screen full screen height

$FULLSCREEN_WIDTH$

Return the screen full screen width

$LOCAL_IP$

Return the local IP v4 address

$MY_MACHINE_NAME$

Return the current machine name

$PUBLIC_IP$

Return the public IP exposed on the internet

$TIME$

Return the current time

$TIME_TEXT$

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

$TIME_TEXT_ISO$

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

$WORKAREA_HEIGHT$

Return the screen work area height

$WORKAREA_WIDTH$

Return the screen work area width

 

Global - Data Source variables

 

Option

Description

$DATA_SOURCE_DOMAIN$

Return the current data source domain

$DATA_SOURCE_NAME$

Return the current data source name

$DATA_SOURCE_PASSWORD$

Return the current data source password

$DATA_SOURCE_USERNAME$

Return the current data source user name

$DATA_SOURCE_USERPROFILE_EMAIL$

Return the current data source user's email

$DATA_SOURCE_USERPROFILE_FIRSTNAME$

Return the current data source user's firstname

$DATA_SOURCE_USERPROFILE_LASTNAME$

Return the current data source user's lastname

$DATA_SOURCE_USERPROFILE_PHONE$

Return 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 Password Vault 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%

C:\ProgramData

%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

 

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$

Return the application name

$DB_CURRENT_CLIPBOARD$

Return the current clipboard content

$DB_CUSTOM_FIELD1$

Return the database custom field field 1 value

$DB_CUSTOM_FIELD2$

Return the database custom field field 2 value

$DB_CUSTOM_FIELD3$

Return the database custom field field 3 value

$DB_CUSTOM_FIELD4$

Return the database custom field field 4 value

$DB_CUSTOM_FIELD5$

Return the database custom field field 5 value

$DB_DOMAIN$

Return the domain found in the configured credentials

$DB_INFORMATION_COMPANY$

Return the company specified in the database information

$DB_INFORMATION_EMAIL$

Return the information email

$DB_INFORMATION_MACHINE_NAME$

Return the information machine name

$DB_NAME$

Return the session name

$DB_SERIAL$

Return the serial number in the invoice tab

$DB_SERVICE_TAG$

Return the service tag field located in the information tab

$DB_VIRTUAL_MACHINE_ID$

Return 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$

Return the application name

$DOMAIN_CURRENT_CLIPBOARD$

Return the current clipboard content

$DOMAIN_CUSTOM_FIELD1$

Return the domain custom field field 1 value

$DOMAIN_CUSTOM_FIELD2$

Return the domain custom field field 2 value

$DOMAIN_CUSTOM_FIELD3$

Return the domain custom field field 3 value

$DOMAIN_CUSTOM_FIELD4$

Return the domain custom field field 4 value

$DOMAIN_CUSTOM_FIELD5$

Return the domain custom field field 5 value

$DOMAIN_DOMAIN$

Return the domain found in the configured credentials

$DOMAIN_INFORMATION_COMPANY$

Return the company specified in the domain information

$DOMAIN_INFORMATION_EMAIL$

Return the information email

$DOMAIN_INFORMATION_MACHINE_NAME$

Return the information machine name

$DOMAIN_NAME$

Return the session name

$DOMAIN_SERIAL$

Return the serial number in the invoice tab

$DOMAIN_SERVICE_TAG$

Return the service tag field located in the information tab

$DOMAIN_VIRTUAL_MACHINE_ID$

Return 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$

Return the application name

$COMPANY_CURRENT_CLIPBOARD$

Return the current clipboard content

$COMPANY_CUSTOM_FIELD1$

Return the company custom field field 1 value

$COMPANY_CUSTOM_FIELD2$

Return the company custom field field 2 value

$COMPANY_CUSTOM_FIELD3$

Return the company custom field field 3 value

$COMPANY_CUSTOM_FIELD4$

Return the company custom field field 4 value

$COMPANY_CUSTOM_FIELD5$

Return the company custom field field 5 value

$COMPANY_DOMAIN$

Return the domain found in the configured credentials

$COMPANY_INFORMATION_COMPANY$

Return the company specified in the company information

$COMPANY_INFORMATION_EMAIL$

Return the information email

$COMPANY_INFORMATION_MACHINE_NAME$

Return the information machine name

$COMPANY_NAME$

Return the session name

$COMPANY_SERIAL$

Return the serial number in the invoice tab

$COMPANY_SERVICE_TAG$

Return the service tag field located in the information tab

$COMPANY_VIRTUAL_MACHINE_ID$

Return 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$

Return the application name

$SOFTWARE_CURRENT_CLIPBOARD$

Return the current clipboard content

$SOFTWARE_CUSTOM_FIELD1$

Return the custom field field 1 value

$SOFTWARE_CUSTOM_FIELD2$

Return the custom field field 2 value

$SOFTWARE_CUSTOM_FIELD3$

Return the custom field field 3 value

$SOFTWARE_CUSTOM_FIELD4$

Return the custom field field 4 value

$SOFTWARE_CUSTOM_FIELD5$

Return the custom field field 5 value

$SOFTWARE_DOMAIN$

Return the domain found in the configured credentials

$SOFTWARE_INFORMATION_COMPANY$

Return the information Company

$SOFTWARE_INFORMATION_EMAIL$

Return the information email

$SOFTWARE_INFORMATION_MACHINE_NAME$

Return the information machine name

$SOFTWARE_NAME$

Return the session name

$SOFTWARE_SERIAL$

Return the serial number in the invoice tab

$SOFTWARE_SERVICE_TAG$

Return the service tag field located in the information tab

$SOFTWARE_VIRTUAL_MACHINE_ID$

Return 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$

Return the application name

$SITE_CURRENT_CLIPBOARD$

Return the current clipboard content

$SITE_CUSTOM_FIELD1$

Return the site custom field field 1 value

$SITE_CUSTOM_FIELD2$

Return the site custom field field 2 value

$SITE_CUSTOM_FIELD3$

Return the site custom field field 3 value

$SITE_CUSTOM_FIELD4$

Return the site custom field field 4 value

$SITE_CUSTOM_FIELD5$

Return the site custom field field 5 value

$SITE_DOMAIN$

Return the domain found in the configured credentials

$SITE_INFORMATION_COMPANY$

Return the company specified in the site information

$SITE_INFORMATION_EMAIL$

Return the information email

$SITE_INFORMATION_MACHINE_NAME$

Return the information machine name

$SITE_NAME$

Return the session name

$SITE_SERIAL$

Return the serial number in the invoice tab

$SITE_SERVICE_TAG$

Return the service tag field located in the information tab

$SITE_VIRTUAL_MACHINE_ID$

Return 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$

Return the application name

$COMPUTER_CURRENT_CLIPBOARD$

Return the current clipboard content

$COMPUTER_CUSTOM_FIELD1$

Return the computer custom field field 1 value

$COMPUTER_CUSTOM_FIELD2$

Return the computer custom field field 2 value

$COMPUTER_CUSTOM_FIELD3$

Return the computer custom field field 3 value

$COMPUTER_CUSTOM_FIELD4$

Return the computer custom field field 4 value

$COMPUTER_CUSTOM_FIELD5$

Return the computer custom field field 5 value

$COMPUTER_DOMAIN$

Return the computer domain found in the configured credentials

$COMPUTER_HOST$

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

$COMPUTER_HOST_WITHOUT_DOMAIN$

Return the host name without the domain if it's available

$COMPUTER_INFORMATION_COMPANY$

Return the company specified in the computer information

$COMPUTER_INFORMATION_EMAIL$

Return the information email

$COMPUTER_INFORMATION_MACHINE_NAME$

Return the information machine name

$COMPUTER_IP$

Return the IP Address

$COMPUTER_MAC$

Return the MAC address defined

$COMPUTER_NAME$

Return the session name

$COMPUTER_SERIAL$

Return the serial number in the invoice tab

$COMPUTER_SERVICE_TAG$

Return the service tag field located in the information tab

$COMPUTER_VIRTUAL_MACHINE_ID$

Return 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$

Return the application name

$IDENTITY_CURRENT_CLIPBOARD$

Return the current clipboard content

$IDENTITY_CUSTOM_FIELD1$

Return the identity custom field field 1 value

$IDENTITY_CUSTOM_FIELD2$

Return the identity custom field field 2 value

$IDENTITY_CUSTOM_FIELD3$

Return the identity custom field field 3 value

$IDENTITY_CUSTOM_FIELD4$

Return the identity custom field field 4 value

$IDENTITY_CUSTOM_FIELD5$

Return the identity custom field field 5 value

$IDENTITY_DOMAIN$

Return the domain found in the configured credentials

$IDENTITY_INFORMATION_COMPANY$

Return the company specified in the identity information

$IDENTITY_INFORMATION_EMAIL$

Return the information email

$IDENTITY_INFORMATION_MACHINE_NAME$

Return the information machine name

$IDENTITY_NAME$

Return the session name

$IDENTITY_SERIAL$

Return the serial number in the invoice tab

$IDENTITY_SERVICE_TAG$

Return the service tag field located in the information tab

$IDENTITY_VIRTUAL_MACHINE_ID$

Return 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$

Return the application name

$CUSTOMER_CURRENT_CLIPBOARD$

Return the current clipboard content

$CUSTOMER_CUSTOM_FIELD1$

Return the customer custom field field 1 value

$CUSTOMER_CUSTOM_FIELD2$

Return the customer custom field field 2 value

$CUSTOMER_CUSTOM_FIELD3$

Return the customer custom field field 3 value

$CUSTOMER_CUSTOM_FIELD4$

Return the customer custom field field 4 value

$CUSTOMER_CUSTOM_FIELD5$

Return the customer custom field field 5 value

$CUSTOMER_DOMAIN$

Return the domain found in the configured credentials

$CUSTOMER_INFORMATION_COMPANY$

Return the company specified in the customer information

$CUSTOMER_INFORMATION_EMAIL$

Return the information email

$CUSTOMER_INFORMATION_MACHINE_NAME$

Return the information machine name

$CUSTOMER_NAME$

Return the session name

$CUSTOMER_SERIAL$

Return the serial number in the invoice tab

$CUSTOMER_SERVICE_TAG$

Return the service tag field located in the information tab

$CUSTOMER_VIRTUAL_MACHINE_ID$

Return 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. It is only useful when a template connection is selected.