Table of Contents

Class NetworkConnection

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll

Represents a network connection that must be established for a job to run

public sealed class NetworkConnection : Resource
Inheritance
object
NetworkConnection

Remarks

Network connections appear on the Resources page of the job properties in the user interface

Properties

ClassID

The Class ID for the object

[IgnoreDataMember]
public override ClassID ClassID { get; }

Property Value

ClassID

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.

Credentials

The credentials to use for this connection

public CredentialProfile Credentials { get; set; }

Property Value

CredentialProfile

Remarks

If Credentials are set to null the connection is made under the main identity of the Job.

DriveLetter

The drive letter to map to the resource (optional)

public string DriveLetter { get; set; }

Property Value

string

Remarks

If specified the DriveLetter must include the colon, e.g., "F:".

If no drive letter is specified, the resource is mounted but not assigned to a drive.

See the user guide for restrictions on drive letter conflicts.

IsDependent

Indicates whether the object is a dependent of (owned by) another object

[IgnoreDataMember]
public override bool IsDependent { get; }

Property Value

bool

Remarks

An independent object (IsDependent is false) is an object that can exist on its own without being part of another object. For example, Jobs, Job Groups, etc.

A dependent object (IsDependent is true) is a part of another object. For example, a JobStep cannot exist independently of a Job, so the JobStep is dependent.

Dependent objects cannot be directly fetched from the server: they are only fetched as part of the object they belong to. They also cannot be saved or deleted independently: they are automatically saved or deleted when the owning object is saved or deleted.

Path

The path of the resource to load.

public string Path { get; set; }

Property Value

string

Remarks

Specify this as the full UNC path, e.g., "\servername\sharename".

Methods

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.

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

Writes the object and any contained objects to a configuration report

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

The report builder to write the object to.

Inherited Members