Table of Contents

Class RemoteAgent

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll
public sealed class RemoteAgent : ADTIndependentObject
Inheritance
object
RemoteAgent

Properties

AgentNumber

public int AgentNumber { get; }

Property Value

int

AllowedModes

public int AllowedModes { get; set; }

Property Value

int

CID

The Class ID for the object

[IgnoreDataMember]
public override ClassID CID { get; }

Property Value

ClassID

Remarks

Obsolete. Use ClassID instead.

CanBeUpdated

Indicates whether the Agent can be updated to a newer version of the adTempus software.

public bool CanBeUpdated { get; }

Property Value

bool

Certificate

public string Certificate { get; }

Property Value

string

CertificateIdentity

public string CertificateIdentity { get; set; }

Property Value

string

ClassKeyName

The key name for the class.

public override string ClassKeyName { get; }

Property Value

string

Remarks

This name the name used by adTempus to identify the class and is intended for programmatic use only. Use the ClassName for a user-friendly name.

ConfigurationReport

Gets information about the adTempus software configuration on the Agent.

public string ConfigurationReport { get; }

Property Value

string

ConnectionOptions

Gets or sets options for the connection to the Agent.

public AgentConnectionOptions ConnectionOptions { get; set; }

Property Value

AgentConnectionOptions

Enabled

public bool Enabled { get; set; }

Property Value

bool

IsConnected

public bool IsConnected { get; }

Property Value

bool

IsDependent

[IgnoreDataMember]
public override bool IsDependent { get; }

Property Value

bool

JobVariables

public JobVariableCollection JobVariables { get; }

Property Value

JobVariableCollection

LastErrorMessage

public string LastErrorMessage { get; }

Property Value

string

Name

An optional name for the agent, used instead of the ServerAddress to identify it in the user interface.

public string Name { get; set; }

Property Value

string

NameAndAddress

Returns the Name if one has been specified, in addition to the ServerAddress.

public string NameAndAddress { get; }

Property Value

string

NameOrAddress

Gets the Name of the Agent, if set, or the Address otherwise.

public string NameOrAddress { get; }

Property Value

string

Remarks

When returning the address, only the server address, port, and instance name are returned. Any connection properties in the address are stripped out.

Priority

public int Priority { get; set; }

Property Value

int

ServerAddress

The name or IP address of the agent computer.

public string ServerAddress { get; set; }

Property Value

string

ServerVersion

Gets the version of the adTempus server software running on the Agent.

public string ServerVersion { get; }

Property Value

string

StrippedServerAddress

Gets the ServerAddress, with connection properties stripped out.

public string StrippedServerAddress { get; }

Property Value

string

SupportedModes

public int SupportedModes { get; }

Property Value

int

UpdateLog

Gets the log from the last software update operation on the Agent.

public string UpdateLog { get; }

Property Value

string

UpdateStatus

public AgentSoftwareUpdateStatus UpdateStatus { get; }

Property Value

AgentSoftwareUpdateStatus

ValidateCertificate

public bool ValidateCertificate { get; set; }

Property Value

bool

Methods

GetInheritedVariables(bool)

Gets a collection containing the JobVariables inherited by this object, and optionally the variables for the object itself.

public JobVariableCollection GetInheritedVariables(bool includeSelf)

Parameters

NameTypeDescription
includeSelf bool

Returns

JobVariableCollection

GetObjectDescription()

Gets a description of the object's key settings.

protected override string GetObjectDescription()

Returns

string

Remarks

This method is called by GetDescription() to get a user-friendly description of the object (such as its key settings) for display to the user. The description should contain enough information to distinguish this object from others of the same class.

See Also

Resynchronize()

Forces a resynchronization of the Agent by resending all data that the Agent should have.

public void Resynchronize()

Remarks

The caller must have Modify permission for the RemoteAgent.

SendSupportFiles(DiagnosticSubmissionInformation, out string)

Sends the current diagnostic logs for the Agent to Arcana Development for troubleshooting.

public bool SendSupportFiles(DiagnosticSubmissionInformation info, out string message)

Parameters

NameTypeDescription
info DiagnosticSubmissionInformation
message string

Returns

bool

Remarks

Requires Administrator permission

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

Inherited Members