For the complete documentation index, see llms.txt. This page is also available as Markdown.

Report (custom)

This article details the many settings and options available for Report (custom) tool entries in Remote Desktop Manager.

SETTINGS

DESCRIPTION

Name

The name of the entry.

Folder

The folder where the entry is located.

General

SETTINGS
DESCRIPTION

Type

The kind of report the script produces. Select one of:

  • Connection list

  • Custom field report

Script source

Where the report script comes from. Select one of:

  • PowerShell

  • Linked entry

With PowerShell, the script is typed in the Script tab.

Linked entry

The entry that holds the script, chosen among the PowerShell session entries and the PowerShell script tools of the vault. Visible and required when Script source is set to Linked entry.

Timeout (ms)

The time allowed for the report script, in milliseconds, from 0 to 60000.

Fields

The columns of the report, one per line. Visible when Type is set to Custom field report.

Script

SETTINGS
DESCRIPTION

Script

The PowerShell script that builds the report. On Windows, the Edit embedded script button opens the script in a separate editor. This tab is visible when Script source is set to PowerShell.

Example

A read-only sample script for the selected Type.

Parameters

SETTINGS
DESCRIPTION

Parameter name

The label of the parameter. Click the name to rename the parameter in a window. In the script, type $PARAMETER1$ for the first parameter, $PARAMETER2$ for the second, and so on, as the example below the list shows.

#

The number of the parameter.

Type

The kind of value the parameter holds. Select one of:

  • Unused

  • Text

  • Secured

  • Env. variable

Default value

The value of the parameter. The value of a Secured parameter is masked.

Add

Add a parameter row at the end of the list.

Delete

Remove the last parameter row added with Add. The first five parameter rows cannot be removed. The delete button at the end of a row clears that parameter and sets its type to Unused.

On Linux, parameter names are edited directly in the list, the Add parameter button below the list adds a parameter, and the delete button of a row removes it.

Prompt for parameters on open

Prompt for the parameter values when the report runs.

Last updated

Was this helpful?