Table of Contents

Class DatabaseOperationTask

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll
[ComVisible(true)]
[Guid("53C24C25-E465-41BD-9282-C9B39783E830")]
public sealed class DatabaseOperationTask : Task
Inheritance
object
DatabaseOperationTask

Properties

ActionType

public DatabaseTaskType ActionType { get; set; }

Property Value

DatabaseTaskType

AdditionalConnectionOptions

Additional options to be appeneded to the database connection string.

public string AdditionalConnectionOptions { get; set; }

Property Value

string

AdditionalOptions

public string AdditionalOptions { get; set; }

Property Value

string

CID

The Class ID for the object

[IgnoreDataMember]
public override ClassID CID { get; }

Property Value

ClassID

Remarks

Obsolete. Use ClassID instead.

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.

CommandsToExecute

public string CommandsToExecute { get; set; }

Property Value

string

CustomConnectionString

Specify a full OleDb connection string to use.

public string CustomConnectionString { get; set; }

Property Value

string

Remarks

Use "{userid}" and "{password}" to insert user ID and password values from the CredentialProfile.

If CustomConnectionString is set, ServerName, DatabaseName, SchemaName, and AdditionalConnectionOptions are ignored.

DatabaseCredentials

public CredentialProfile DatabaseCredentials { get; set; }

Property Value

CredentialProfile

DatabaseName

The database name.

public string DatabaseName { get; set; }

Property Value

string

Remarks

For Oracle connections, specify the service name if not using TNS for the connection (see Remarks in ServerName).

DatabaseType

The type of database to connect to.

public string DatabaseType { get; set; }

Property Value

string

Remarks

Specify a value from DatabaseTypes.

ImportExportFormat

public DatabaseImportExportType ImportExportFormat { get; set; }

Property Value

DatabaseImportExportType

IsDependent

[IgnoreDataMember]
public override bool IsDependent { get; }

Property Value

bool

JobName

public string JobName { get; set; }

Property Value

string

ProviderName

The OleDb provider name to use, if other than the default.

public string ProviderName { get; set; }

Property Value

string

SchemaName

public string SchemaName { get; set; }

Property Value

string

ServerName

The database server (host) name or address.

public string ServerName { get; set; }

Property Value

string

Remarks

To use a port other than the default, specify it using "servername:portnumber".

For Oracle connections:
*   To connect using TNS, set ServerName to the TNS alias and leave DatabaseName empty.
*   To connect without TNS, set ServerName to the server host name and set DatabaseName to the service name.

SourceFile

public string SourceFile { get; set; }

Property Value

string

SupportedResponseEvents

Gets a list of the events that are supported for Responses associated with this task.

public override ReadOnlyCollection<SupportedResponseEvent> SupportedResponseEvents { get; }

Property Value

ReadOnlyCollection<SupportedResponseEvent>

TargetFile

public string TargetFile { get; set; }

Property Value

string

TargetScript

The script to pass the selected data to.

public Script TargetScript { get; set; }

Property Value

Script

TargetVariable

public string TargetVariable { get; set; }

Property Value

string

WaitForCompletion

public bool WaitForCompletion { get; set; }

Property Value

bool

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.

See Also

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

Inherited Members