Skip to content

Scalus Tokens

Miriam McMahon edited this page Feb 4, 2022 · 3 revisions

The following tokens can be reference in the scalus.json file by enclosing with ‘%’, e.g.
“Exec” : “%AppData%/HandlersFor%Protocol%/MycustomProgram%Host%.exe”

Name Description
Account The account part of a Safeguard URL that is used to run the AlternateShell.
AlternateShell The program to be started automatically in the remote RDP session instead of explorer.
AppData The user's local application directory on this platform. This is platform dependent.
Asset The asset part of a Safeguard URL that is used to run the AlternateShell.
Fragment The fragment part of a standard URL.
GeneratedFile The full path to the generated file that can be passed to the application. This is only available if UseDefaultTemplate is true or UseTemplateFile is configured for the application. The file extension will be set to match the template file (if provided), or determined by the parser.
Home The user's home directory on this platform. This is platform dependent.
Host The hostname or IP address that the application will connect to.
OriginalUrl The full URL string passed to scalus.
Path The path part of a standard URL.
Port The port number that the application will connect to.
Protocol The protocol in use, eg. scheme part of the URL, e.g. 'rdp'.
Query The query part of a standard URL.
RelativeUrl The URL string without the protocol, e.g. 'full+address=s:address&username=s:user'.
Remoteapplicationname The name of the remote application to run in the RDP session.
Remoteapplicationprogram The alias or executable name of the remote application to run in the RDP session.
TargetHost The target host name or IP address part of a Safeguard URL.
TargetPort The target port part of a Safeguard URL.
TargetUser The target username part of a Safeguard URL.
TempPath The user's temp directory on this platform. This is platform dependent.
Token The token part of a Safeguard URL.
User The user part of the URL. For Safeguard URLs, parsed by the rdp, ssh or telnet parser, this will contain the full auth token information, e.g. vaultaddress ~ hostname%token~tokenstring%user1@targethost.
Vault The hostname or IP address of the Safeguard vault, extracted from a Safeguard URL.
Clone this wiki locally