Table of Contents

Class ExportOptions

Namespace
ArcanaDevelopment.adTempus.Shared
Assembly
ArcanaDevelopment.adTempus.Shared.dll

Specifies options for exporting data.

[DataContract]
public class ExportOptions : ImportExportOptions
Inheritance
object
ExportOptions

Fields

Comments

Optional comments to be included in the export file.

[DataMember]
public string Comments

Field Value

string

CompressExport

If true, the export file is compressed into a ZIP archive.

[DataMember]
public bool CompressExport

Field Value

bool

ExportAllData

Exports all data that the user has permission for.

[RequiredVersion(6, 0, 0, 0)]
[DataMember]
public bool ExportAllData

Field Value

bool

Remarks

This includes independent objects of all classes and objects referenced by those objects, and all the server setting options.

HistoryEndDate

The latest date/time to include if IncludeJobHistory is True.

[DataMember]
public DateTime? HistoryEndDate

Field Value

DateTime?

HistoryStartDate

The earliest date/time to include if IncludeJobHistory is True.

[DataMember]
public DateTime? HistoryStartDate

Field Value

DateTime?

IncludePasswords

Include passwords for credential profiles for which the user has Associate permission. Passwords are never exported for profiles for which the client does not have Associate permission.

[DataMember]
public bool IncludePasswords

Field Value

bool
See Also
SetPassword(string)

OIDs

The list of objects to export.

[DataMember]
public HashSet<OID> OIDs

Field Value

HashSet<OID>

Remarks

To export all objects of a given type, use IncludeClasses.

TargetSchemaVersion

The target version of adTempus for the export.

[DataMember]
public int TargetSchemaVersion

Field Value

int

Remarks

The TargetSchemaVersion determines the format used for the export file. Specify 300 for adTempus 3.x or 400 or greater for adTempus 4.x.

Properties

IncludeClasses

Specifies the class(es) of objects to export.

[DataMember]
[RequiredVersion(6, 0, 0, 0)]
public List<ClassID> IncludeClasses { get; }

Property Value

List<ClassID>

Remarks

If any class IDs are included in this list, all objects of that class that the user has permission for are included in the export, along with any dependencies.

Any individual objects specified in OIDs are also included, regardless of their class.

To export all readable objects, use ExportAllData.

IncludeEncryptedData

Determines whether encrypted data is included in the export.

[RequiredVersion(6, 0, 0, 0)]
[DataMember]
public bool IncludeEncryptedData { get; set; }

Property Value

bool

Remarks

When this value is false encrypted data (passwords, API secrets, hidden variables, etc.) is not included in the export.

IncludeSecurityTemplates

Determines whether security templates are included

public bool IncludeSecurityTemplates { get; set; }

Property Value

bool

Remarks

Security templates are the security containers for classes of objects. For example all Messaging Service Providers inherit security from the Messaging Service Provider security template

Inherited Members