Command Task

Command Tasks are used to execute command lines (programs or batch scripts) from within Royal TS. Command tasks can run "stand-alone" (like a shortcut) or in context of a selected connection - which also allows you to "inject" variables (replacement tokens) to the command line (like the PING task).

Dashboard

The Task Dashboard is shown in the Dashboard panel when you select a Command Task in the Navigation panel.

CommandTask_Dashboard

Assignments

  • The grid on the top shows connections or folders which are configured to use the selected task as Connect, Disconnect or Key Sequence Task
  • You can also select one or more objects in the Assignments list and perform various edit commands.

Task Context

  • The Task Context list shows all connections available as task context. Connections which are currently selected as task context are shown selected in the list and appear at the top of the list.
  • Changing the selection in the list will change the task context.
  • Click on Execute to start the selected task for the selected task context.
Note

Since command tasks can be executed on all connections, the task context list for command tasks will show all available connections (active and inactive).

See also: Working with Tasks

Task Properties

The Command Task Properties dialog is shown:

  • for a new command task by clicking the Command Task menu item in the Add drop down menu in the Edit group on the Home ribbon tab.
  • for an existing command task by selecting a command task and clicking on the Properties command in the Edit group on the Home ribbon tab.
  • as a bulk-edit dialog when multiple command tasks were selected in the Folder / Document Dashboard and the Properties command in the Edit group on the Home ribbon tab is clicked. See also: Bulk Operations

Command Task Properties

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.

No confirmation required

If checked, tasks executed from the Favorite Command Tasks menu do not show the Task Context confirmation window.

Note

You should only check this option for simple and harmless tasks, such as PING. Tasks which can cause damage if executed for the wrong selection (such as a reboot) should not have checked this option.
A task executed from the Navigation panel or Tasks panel always requires confirmation, regardless of the setting.

Command

The Command page allows you to configure which command should be executed.

Command

Specify a program or batch file to execute.

Arguments

Specify arguments for the command.

Tip

Use the fly-out button to the right to show a list of available replacement tokens.
You may also use environment variables (such as %TEMP%).

Working Directory

Specify the working directory for the command.

Note

Tasks are always executed locally (on the machine where Royal TS is running) but in context of a selection of connections. Using replacement tokens you can inject values from the selected connection(s) (such as custom fields or the URI, even username and password). Executing a task against multiple connections will start one command for each connection.
To execute tasks on the remote machine, you can make use of tools like psexec (from Microsoft).

About the OS X tab

Since Royal TSX for macOS can also be used to work with your Royal TS documents, you can specify a different command configuration for macOS. Some commands may have a slightly different syntax but basically do the same. To prevent users from creating multiple tasks with the same function for each platform, you can specify a different command configuration for macOS.

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.

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

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

Important

You cannot create connections in the Application document. Moving a folder containing connections to a folder in the Application document will fail.