RoyalAppConnection

RoyalAppConnection

Scripting > Reference > Object Properties >

Description

The RoyalAppConnection object represents an External Application connection object in Royal TS.

 

Properties

Category

Name

Description

Type

Default Value

Is Secure

General

Name

The display name of the object.

string

Empty String

 

Description

The description text of the object.

string

Empty String

 

URI

The target URI for the connection object (computer name, URL, ...).

string

Empty String

 

Custom Fields

CustomField1

Custom fields allow you to collect additional information to the object.

string

Empty String

 

CustomField2

Custom fields allow you to collect additional information to the object.

string

Empty String

 

CustomField3

Custom fields allow you to collect additional information to the object.

string

Empty String

 

CustomField4

Custom fields allow you to collect additional information to the object.

string

Empty String

 

CustomField5

Custom fields allow you to collect additional information to the object.

string

Empty String

 

CustomField6

Custom fields allow you to collect additional information to the object.

string

Empty String

 

CustomField7

Custom fields allow you to collect additional information to the object.

string

Empty String

 

CustomField8

Custom fields allow you to collect additional information to the object.

string

Empty String

 

CustomField9

Custom fields allow you to collect additional information to the object.

string

Empty String

 

CustomField10

Custom fields allow you to collect additional information to the object.

string

Empty String

 

CustomField11

Custom fields allow you to collect additional information to the object. The content of this custom field will be stored encrypted in your document.

string

Empty String

CustomField12

Custom fields allow you to collect additional information to the object. The content of this custom field will be stored encrypted in your document.

string

Empty String

CustomField13

Custom fields allow you to collect additional information to the object. The content of this custom field will be stored encrypted in your document.

string

Empty String

CustomField14

Custom fields allow you to collect additional information to the object. The content of this custom field will be stored encrypted in your document.

string

Empty String

CustomField15

Custom fields allow you to collect additional information to the object. The content of this custom field will be stored encrypted in your document.

string

Empty String

CustomField16

Custom fields allow you to collect additional information to the object. The content of this custom field will be stored encrypted in your document.

string

Empty String

CustomField17

Custom fields allow you to collect additional information to the object. The content of this custom field will be stored encrypted in your document.

string

Empty String

CustomField18

Custom fields allow you to collect additional information to the object. The content of this custom field will be stored encrypted in your document.

string

Empty String

CustomField19

Custom fields allow you to collect additional information to the object. The content of this custom field will be stored encrypted in your document.

string

Empty String

CustomField20

Custom fields allow you to collect additional information to the object. The content of this custom field will be stored encrypted in your document.

string

Empty String

Advanced

CommandLineMatchString

The command line string Royal TS will look for embedding or tracking (in case a different process is started and needs to be tracked).

string

Empty String

 

KillOnDisconnect

If set to true, Royal TS will kill the process when the connection is disconnected.

bool

true

 

LoadProfile

If set to true, the external application will load the profile of the runas user.

bool

true

 

MaxWaitTime

The maximum amount of time (in seconds) Royal TS will wait for the external application to launch before it closes the connection.

int

10

 

MinWaitTime

The minimum amount of time (in seconds) Royal TS will wait for the external application before it is tracked and embedded after launch.

int

0

 

ProcessNameToTrack

The process name of the external application Royal TS will look for embedding or tracking.

string

Empty String

 

RunElevated

If set to true, Royal TS will start the process elevated.

bool

false

 

StartHidden

If set to true, the external application is started hidden at first and will be visible right before it is embedded.

bool

false

 

StartUnattached

If set to true, the external application will be started unattached (without tracking in Royal TS), similar to a shortcut.

bool

false

 

UseCredentials

If set to true, the external application will be started using the configured credentials (similar to runas).

bool

false

 

WindowTitleMatchSkip

The number of matching Window Titles to skip before the window is embedded.

int

0

 

WindowTitleMatchString

The window title Royal TS will look for embedding the external application.

string

Empty String

 

Changes

Created

The date and time the object was created.

DateTime

DateTime.Now

 

CreatedBy

The user who initially created the object.

string

Empty String

 

Modified

The last date and time the object was modified.

DateTime

DateTime.Now

 

ModifiedBy

The user who last modified the object.

string

Empty String

 

Connect Task

PreConnectTaskConditionAbort

If set to true, the connection will be closed when the task fails (exit code <> 0).

bool

false

 

PreConnectTaskConditionFirst

If set to true, the task will only be executed if it is the first connection in a folder to be connected.

bool

false

 

PreConnectTaskFromParent

Use the Connect Task values from the parent folder.

bool

false

 

PreConnectTaskId

Assign a task object to this object as connect task by specifying the task object's GUID.

Guid

Guid.Empty

 

PreConnectTaskMode

0 = Use connect task from parent folder
1 = Use an existing task
2 = Specify a task name.

int

1

 

PreConnectTaskName

Assign a task object to this object as connect task by specifying the task object's name.

string

Empty String

 

PreConnectTaskWait

If set to true, the connection will be started after the task finished.

bool

false

 

Credentials

CredentialAutologon

Whether or not to automatically logon to the connection. Connections which do not support automatic logon will ignore this setting.

bool

true

 

CredentialFromParent

Use the Credential values from the parent folder.

bool

false

 

CredentialId

Assign a credential object to this object by specifying the credential object's GUID.

Guid

Guid.Empty

 

CredentialKeyFile

Assign a key file to the object by specifying the key file's full path.

string

Empty String

 

CredentialMode

0 = Do not use any credentials
1 = Use credentials from the parent folder
2 = Specify username and password
3 = Use an existing credential
4 = Specify a credential name
5 = Use credential from context connection (only for Connection Templates)

int

0

 

CredentialName

Assign a credential object to this object by specifying the credential object's name.

string

Empty String

 

CredentialPassphrase

Assign a key file passphrase to the object.

string

Empty String

CredentialPassword

Assign a password to the object.

string

Empty String

CredentialUsername

Assign a username to the object.

string

Empty String

 

Custom Fields

CustomField10FromParent

Use the CustomField10 value from the parent folder.

bool

false

 

CustomField11FromParent

Use the CustomField11 value from the parent folder.

bool

false

 

CustomField12FromParent

Use the CustomField12 value from the parent folder.

bool

false

 

CustomField13FromParent

Use the CustomField13 value from the parent folder.

bool

false

 

CustomField14FromParent

Use the CustomField14 value from the parent folder.

bool

false

 

CustomField15FromParent

Use the CustomField15 value from the parent folder.

bool

false

 

CustomField16FromParent

Use the CustomField16 value from the parent folder.

bool

false

 

CustomField17FromParent

Use the CustomField17 value from the parent folder.

bool

false

 

CustomField18FromParent

Use the CustomField18 value from the parent folder.

bool

false

 

CustomField19FromParent

Use the CustomField19 value from the parent folder.

bool

false

 

CustomField1FromParent

Use the CustomField1 value from the parent folder.

bool

false

 

CustomField20FromParent

Use the CustomField20 value from the parent folder.

bool

false

 

CustomField2FromParent

Use the CustomField2 value from the parent folder.

bool

false

 

CustomField3FromParent

Use the CustomField3 value from the parent folder.

bool

false

 

CustomField4FromParent

Use the CustomField4 value from the parent folder.

bool

false

 

CustomField5FromParent

Use the CustomField5 value from the parent folder.

bool

false

 

CustomField6FromParent

Use the CustomField6 value from the parent folder.

bool

false

 

CustomField7FromParent

Use the CustomField7 value from the parent folder.

bool

false

 

CustomField8FromParent

Use the CustomField8 value from the parent folder.

bool

false

 

CustomField9FromParent

Use the CustomField9 value from the parent folder.

bool

false

 

Dashboard

DashboardAutoShowWindows

If set to true, the dashboard will show processes and windows automatically.

bool

true

 

DashboardFilterProcesses

If set to true, the dashboard will only show processes which match the configuration of the connection.

bool

false

 

DashboardUseAppSettings

If set to true, the plugin default settings for the dashboard are used.

bool

true

 

Disconnect Task

PostDisconnectTaskConditionLast

If set to true, the task will only be executed if it is the last active connection in a folder.

bool

false

 

PostDisconnectTaskFromParent

Use the Disconnect Task values from the parent folder.

bool

false

 

PostDisconnectTaskId

Assign a task object to this object as disconnect task by specifying the task object's GUID.

Guid

Guid.Empty

 

PostDisconnectTaskMode

0 = Use disconnect task from parent folder
1 = Use an existing task
2 = Specify a task name.

int

1

 

PostDisconnectTaskName

Assign a task object to this object as disconnect task by specifying the task object's name.

string

Empty String

 

PostDisconnectTaskWait

If set to true, the connection will be closed after the task finished.

bool

false

 

General

Color

Assign a custom color as hex string to the object (#FF0000 for red). Empty string is the default color value (no custom color assigned).

string

Empty String

 

ColorFromParent

Use the Color value from the parent folder.

bool

false

 

DoNotStart

If set to true, Royal TS will not start the process and assumes that it's already running.

bool

false

 

ID

The unique object identifier (GUID) of the object.

Guid

Guid.Empty

 

IsConnectionTemplate

If set to true, the connection object is a template.

bool

false

 

Key Sequence

KeySequence

The key sequence to be executed after the connection was successfully established.

string

Empty String

 

KeySequenceEnabled

If set to true, the configured key sequence will be executed after the connection was successfully established.

bool

false

 

KeySequenceFromParent

Use the Key Sequence values from the parent folder.

bool

false

 

KeySequenceId

Assign a key sequence task object to this connection by specifying the task object's GUID.

Guid

Guid.Empty

 

KeySequenceMode

0 = Specify a key sequence
1 = An existing key sequence task is assigned using the task's GUID
2 = Specify a key sequence task by name
3 = Use key sequence from parent.

int

0

 

KeySequenceName

Assign a key sequence task object to this object by specifying the key sequence task object's name.

string

Empty String

 

Notes

NotesFromParent

Use the Notes value from the parent folder.

bool

false

 

Plugin for OS X

PlugInOSX

The plug in ID used for this connection for OS X.

string

Empty String

 

UseGlobalPlugInOSX

If set to true, the connection will use the application default plug in for the connection type on OS X.

bool

true

 

Plugin for Windows

PlugInWin

The plug in ID used for this connection for Windows.

string

Empty String

 

UseGlobalPlugInWin

If set to true, the connection will use the application default plug in for the connection type on Windows.

bool

true

 

Royal Server

ManagementEndpointFromParent

Use the Royal Server values from the parent folder.

bool

false

 

ManagementEndpointID

Assign a Royal Server object to this object by specifying the Royal Server object's GUID.

Guid

Guid.Empty

 

ManagementEndpointName

Assign a Royal Server object to this object by specifying the Royal Server object's name.

string

Empty String

 

Secure Gateway

SecureGatewayFromParent

Use the Secure Gateway values from the parent folder.

bool

false

 

SecureGatewayID

Assign a Secure Gateway or Royal Server object to this object by specifying the Secure Gateway or Royal Server object's GUID.

Guid

Guid.Empty

 

SecureGatewayName

Assign a Secure Gateway or Royal Server object to this object by specifying the secure gateway or Royal Server object's name.

string

Empty String

 

SecureGatewayUsageMode

0 = Never
1 = Always

int

0

 

Window Mode

DisplayMode

0 = Embedded (Tabbed)
1 = External Window
2 = Full Screen (where supported).

int

0

 

ExternalHeight

Specifies the last known height of the external window.

int

0

 

ExternalLeft

Specifies the last known position (left) of the external window.

int

0

 

ExternalPositionMode

0 = Remember position
1 = Custom left and right coordinates

int

0

 

ExternalScreen

Specifies on which Screen the External Window will be shown (Windows).

int

0

 

ExternalScreenMode

0 = Remember Screen
Any other number indicates the display number.

int

0

 

ExternalScreenOSX

Specifies on which Screen the External Window will be shown (OS X).

int

0

 

ExternalSizeMode

0 = Remember Size
1 = Custom width and height
2 = Maximize

int

0

 

ExternalTop

Specifies the last known position (top) of the external window.

int

0

 

ExternalWidth

Specifies the last known width of the external window.

int

0

 

FixedSize

Specifies whether or not the control or form should be expanded automatically to fill the container or maximized form

bool

false

 

MinimizeMainWindow

If set to true, the main window will be minimized after the connection was established.

bool

false