RoyalCommandTask

RoyalCommandTask

Scripting > Reference > Object Properties >

Description

The RoyalCommandTask object stores commands for Windows and macOS to be executed in context of connections.

 

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

 

Favorite

Whether or not the object is a favorite.

bool

false

 

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

Custom Properties

CustomProperties

Custom properties allow you to collect additional information for an object.

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

 

Command on macOS

ArgumentsOSX

The arguments for the command line on macOS.

string

Empty String

 

CommandLineOSX

The command to execute for the task on macOS.

string

Empty String

 

ExecuteInTerminalOSX

If set to true, the task will be executed in a terminal window. If set to false, no terminal window is created.

bool

true

 

WorkingDirectoryOSX

The working directory for the command line macOS.

string

Empty String

 

Command on Windows

Arguments

The arguments for the command line.

string

Empty String

 

CommandLine

The command to execute for the task.

string

Empty String

 

WorkingDirectory

The working directory for the command line.

string

Empty String

 

Credentials

CredentialId

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

Guid

Guid.Empty

 

CredentialMode

For Command Tasks:
0 = Run this task with logged on user
1 = Using the context credentials
2 = Specify username and password
3 = Use an existing credential
4 = Specify a credential name
 
For Key Sequence Tasks:
0 = Do not use any credentials
1 = Specify username and password
2 = Use an existing credential
3 = Specify a credential name

int

0

 

CredentialName

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

string

Empty String

 

CredentialPassword

Specify the password for the credential.

string

Empty String

CredentialUsername

Specify the username for the task.

string

Empty String

 

LoadUserProfile

Whether or not to load the user profile.

bool

false

 

RunAsCredential

If set to true, the task will be executed in the user context of the configured credential.

bool

true

 

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

 

Custom Properties

CustomPropertiesFromParent

Use the Custom Properties from the parent folder.

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

 

ExternalID

The external unique object identifier (GUID) of the object.

string

Empty String

 

ID

The unique object identifier (GUID) of the object.

Guid

Guid.Empty

 

NoConfirmationRequired

If set to true, the user does not need to confirm the task execution when executed from the favorite task menu.

bool

false

 

ShowInFavoriteTasks

If set to true, the task will appear in the favorite task menu.

bool

false

 

Notes

NotesFromParent

Use the Notes value from the parent folder.

bool

false