Dynamic Folder
A Dynamic Folder allows you to import data from external sources. All imported objects are read-only but credential objects can be assigned to other objects outside of dynamic folders.
Dynamic Folder Properties
The Dynamic Folder property dialog is shown:
- for a new Dynamic Folder by clicking the Dynamic Folder menu item in the Add drop down menu in the Edit group on the Home ribbon tab.
- for an existing folder by selecting the folder in the navigation panel or folder dashboard and clicking on the Properties command in the Edit group on the Home ribbon tab.
See also: Dynamic Folder and RoyalJSON
Display Name (required)
Enter a display name for object.
Color
Click the color picker button in the display name text box to select a color. In the User Interface settings you can configure to show the color in the navigation tree, the connection tab or as connection border.
Icon
Click the icon picker button next in the display name text box to select and assign a custom icon to the object.
Description
Enter a description for the object.
Dynamic Folder Script
The Dynamic Folder Script page allows you to configure the script and the interpreter which populates the dynamic folder content.
Script Interpreter
Select the script interpreter you want to use when the script is executed. Some interpreters may need additional files to be installed on your system.
Tokens
Use the Tokens drop down to insert replacement tokens into the script. This way you can use the configured credentials in your script.
Script
The script to be executed which creates a Royal JSON output for the folder content.
Important
Royal TS for Windows expects the script output to be UTF8 encoded. Depending on your script interpreter and system locale, encoding might be different by default. Also, older PowerShell versions do not use UTF8 encoding by default.
Here's an example on how to set output encoding in PowerShell: [System.Console]::OutputEncoding = [System.Text.Encoding]::UTF8
Dynamic Credential Script
The Dynamic Credential Script page allows you to configure the script and the interpreter which will be called to gather the credential information at connect-time.
Script Interpreter
Select the script interpreter you want to use when the script is executed. Some interpreters may need additional files to be installed on your system.
Tokens
Use the Tokens drop down to insert replacement tokens into the script. This way you can use the configured credentials in your script.
Script
The script to be executed which creates a Royal JSON output for the credential information.
Credentials
The Credentials page allows you to assign a credential to the object. You can specify username and password, assign a predefined credential or you specify a credential by name (ideal when you share your configuration). You can also use the credentials defined in the parent folder.
Do not use any credentials
When selected, no credentials are configured for the object. Connections that require credentials may prompt to enter credentials or fail to connect.
Use credentials from the parent folder (not always available)
When selected, Royal TS will look for a configured credential in the parent folder.
Note
Not available for Royal Server objects, Secure Gateway objects, Remote Desktop Gateway objects and Key Sequence Tasks
Use from this connection (not always available)
When selected, the username and password is used from the context connection object.
Specify username and password
When selected, a username and password can be provided. For domain accounts use the syntax "domain\username" (without the quotes).
Use an existing credential
When selected, assign an existing credential to the object using the drop-down list. Use the add button to add a new credential. Use the edit button to edit the selected credential.
Tip
The drop-down list supports sorting and filtering "as you type" to easily find the correct credential.
Specify a credential name
When selected, enter or choose a credential name you want to assign to the object during connect-time.
If you enter '?' (without the quotes) as credential name, Royal TS will prompt for credentials by showing the credential picker dialog.
Note
Assigning a credential by name is recommended when a team of users share the same configuration file. Each user can define his own credential as long as it is using the same name and saves the credential in his own personal and protected document. This makes sharing files across team members very easy while keeping credentials safe.
Omit Domain
When checked, Royal TS will omit the domain portion of the username (domain\username or username@domain).
Note
The Omit Domain checkbox is not available for all object types!
Automatic Logon
When checked, Royal TS will use the credentials to log on to the connection automatically. This setting applies only to connection types supporting automatic logon and is ignored if a connection doesn't support automatic logon.
Note
To access the configured credentials through replacement tokens (for example in Auto Fill or Key Sequence Task configurations), use the replacement tokens \(EffeciveUsername\) and \(EffectivePassword\).
Edit Source
Opens the properties dialog of the source object for the configuration. This button will only be available when the object is configured to use the parent configuration.
See also: Working with Credentials, Credential, About shared documents
Tasks
You can specify a task to be executed before a connection is established and after it has been disconnected. For example: establish a VPN connection before you connect and close it after disconnect.
Connect Task
Do not execute a task
Royal TS will not execute a command task when a connection is established.
Use task from parent folder
Royal TS will look for a configured connect task in the parent folder. This option is not available on the document level.
Use an existing task
Choose a command task from the drop-down list. Use the add button to add a new credential. Use the edit button to edit the selected credential.
Note
The drop-down list supports sorting and filtering "as you type" to easily find the task you are looking for.
Specify a task name
When selected, enter or choose a task name you want to assign to the object during connect-time.
Note
Assigning a task by name is recommended when a team of users share the same configuration file. Each user can define his own task as long as it is using the same name and saves the task in his own personal and protected document. This makes sharing files across team members very easy.
Wait for connect task completion
If checked, Royal TS will wait for the selected task to finish before the connection will be established.
Execute for first connection in folder
If checked, the task will only be executed if no other connection in the same folder is active.
Note
This setting might be useful if you need to setup a VPN connection. Put all your connections which require you to setup this VPN in one folder and Royal TS will establish the VPN connection only for your first connection.
Abort when connect task fails
If checked, the connection will not be established when the configured task fails and returns an Exit Code other than 0.
Disconnect Task
Do not execute a task
Royal TS will not execute a command task when a connection is disconnected.
Use task from parent folder
Royal TS will look for a configured disconnect task in the parent folder. This option is not available on the document level.
Use an existing task
Choose a command task from the drop-down list. Use the add button to add a new credential. Use the edit button to edit the selected credential.
Note
The drop-down list supports sorting and filtering "as you type" to easily find the task you are looking for.
Specify a task name
When selected, enter or choose a task name you want to assign to the object during disconnect-time.
Note
Assigning a task by name is recommended when a team of users share the same configuration file. Each user can define his own task as long as it is using the same name and saves the task in his own personal and protected document. This makes sharing files across team members very easy.
Wait for disconnect task completion
If checked, Royal TS will wait for the selected task to finish before the connection will be disconnected.
Execute for last connection in folder
If checked, the task will only be executed if it is the last active connection in the folder.
Note
This setting might be useful if you need to setup a VPN connection. Put all your connections which require you to setup this VPN in one folder and Royal TS will disconnect the VPN connection after the last connection is disconnected.
See also: Working with Tasks, Command Task
Key Sequence
The Key Sequence page allows you to configure a sequence of key strokes (simulating keyboard events) to be sent to the connection after the connection has been established.
Do not send a key sequence
This is the default value. If selected, no key sequence is sent to the remote session after connect.
Use key sequence task from parent folder
Royal TS will look for a configured key sequence task in the parent folder. This option is not available on the document level.
Specify a key sequence
If selected, a key sequence can be specified for this connection.
Note
Use the fly-out button to the right to show a list of available replacement tokens and special key commands. Use the WAIT command anywhere in the sequence to delay the sequence.
Examples for Key Sequences:
- A group policy is set to show a message whenever a user is attempting to log on interactively. Create a key sequence "{WAIT:1000}{ENTER}" which will wait 1 second (1000ms) after successfully connected to the remote desktop session and sends the ENTER key to the remote session to confirm the message.
- A web page connection to a flash based application which requires you to log on using a username and password can be configured to send the appropriate key sequence after the connection has been established.
Use an existing key sequence task
If selected, a key sequence task can be specified for this connection.
Note
If a key sequence is in progress, do not interact with Royal TS or any other application after you connect. The status bar message indicates when a key sequence is in progress and when it has finished.
Specify a key sequence task name
When selected, enter or choose a key sequence task name you want to assign to the object during connect-time.
Note
Assigning a task by name is recommended when a team of users share the same configuration file. Each user can define his own task as long as it is using the same name and saves the task in his own personal and protected document. This makes sharing files across team members very easy.
Edit Source
Opens the properties dialog of the source object for the configuration. This button will only be available when the object is configured to use the parent configuration.
Royal Server
The Royal Server page allows you to configure a Royal Server object for supported connections or choose to use a Royal Server configuration from the parent folder.
Use Royal Server from the parent folder
If checked, Royal TS will look for a configured Royal Server in the parent folder. This option is not available on the document level.
Direct Connect (No Royal Server)
This is the default value. If selected, no Royal Server is used and Royal TS will directly connect to the remote computer.
Specify a Royal Server object
The selected Royal Server object is used for supported connections.
Note
A Royal Server is a product which allows you to gather information and execute management tasks securely on your managed servers.
Edit Source
Opens the properties dialog of the source object for the configuration. This button will only be available when the object is configured to use the parent configuration.
See also: Introducing Royal Server
Advanced
The Advanced page allows you to configure advanced dynamic folder settings.
Automatically reload folder contents
If checked, Royal TS will automatically reload the folder contents when the document is opened.
Persist (cache) folder contents
If checked, Royal TS will save (cache) the contents of this dynamic folder within the document.
If checked, Royal TS will save (cache) the contents of this dynamic folder within the document.
Note
This option is only available for personal (not shared) documents.
Dynamic Folder Script
Token Handling
Configure, how replacement tokens are passed on to the script.
- Replace Inline
- Environment Variables
Tokens
All listed tokens will be available as environment variables.
Prefix
A common prefix for all environment variables to avoid conflicts with existing variables.
Dynamic Credential Script
Token Handling
Configure, how replacement tokens are passed on to the script.
- Replace Inline
- Environment Variables
Tokens
All listed tokens will be available as environment variables.
Prefix
A common prefix for all environment variables to avoid conflicts with existing variables.
Note
Environments variable will be created for the script in the following way (assuming the prefix is DynFolder_
):
The replacement token $EffectiveUsername$
will be available in the environment variable DynFolder_EffectiveUsername
.
Dots (.
) in replacement tokens will be substituted with the underscore (_
) character:
$this.EffectiveUsername$
= DynFolder_this_EffectiveUsername
$CustomProperty.AccountPassword
= DynFolder_CustomProperty_AccountPassword
Notes
The Notes page allows you to enter notes for the selected object with HTML formatting, links and embedded images. You can also configure the notes to be inherited from the parent folder.
Use Notes from the parent folder
When selected, Royal TS will display the notes from the parent folder in the notes panel. This option is not available on the document level.
Tip
To embed images, drag them into the editor using drag & drop.
Custom Properties
The Custom Properties page allows you to enter and store additional information for the object. Various data formats are available, including protected fields. You can also group properties by using Header.
Inherit from Parent
When checked, the properties configured on the parent folder are shown but are read-only.
Custom Properties
Use the '+' icon to add a header or a Field or multiple fields based on a template. Click on the label to name the field and enter a value. Click the 'Gear' icon to remove a field or header. The 'Gear' icon also shows additional options, like moving a field up or down.
Custom Fields
The Custom Fields page allows you to enter and store additional information for the object. Custom fields can be used in tasks and templates to inject values from the context connection.
Standard custom fields are also shown in the folder dashboard views and in the properties panel. Protected custom fields can be used to store confidential data (for example when you need an additional password in a task). If you make use of protected custom fields, make sure you encrypt and password protect your document.
Note
Custom fields can be used in Tasks and in the Properties Panel. You can put web page URLs (like an iLO management address) or command lines (such as programs or batch files) in the custom fields and execute them using tasks or directly from the properties panel. Each individual custom field can also be configured to be inherited from the parent folder.
Parent Folder
The Parent Folder page allows you to view or change the parent folder of the selected object. To move multiple objects to another folder use the parent folder page in bulk-edit mode or use the move to command from the Edit tab (see Working with Connections).