Class ImportExportOptions

Namespace

ArcanaDevelopment.adTempus.Shared

Assembly

ArcanaDevelopment.adTempus.Shared.dll

Specifies options for export and importing data.

[Serializable]
[DataContract]
public abstract class ImportExportOptions

Inheritance

object

ImportExportOptions

Derived

ExportOptions

ImportOptions

Constructors

ImportExportOptions()

public ImportExportOptions()

Fields

EncryptionKey

The encryption key to use to encrypt/decrypt passwords in the export file.

[DataMember]
public string EncryptionKey

Field Value

string

Remarks

If the IncludePasswords option is True on export, passwords are included in the export file but are encrypted. The EncryptionType specifies the method used for encryption.

• If EncryptionType is ExportEncryptionType.DefaultKey, no EncryptionKey should be set. adTempus uses the default adTempus encryption key.
• If EncryptionType is ExportEncryptionType.Password, EncryptionKey should be set to a password that will be used to encrypt/decrypt the data.

• If EncryptionType is ExportEncryptionType.Asymmetric,

  • On export, EncryptionKey should be set to an RSA public key, which adTempus will use to encrypt the data.
  • On import, EncryptionKey should be set to the corresponding RSA private key.

Use RSACryptoServiceProvider to generate the key pair for asymmetric encryption.

Use SetPassword to set the password for ExportEncryptionType.Password.

EncryptionType

Specifies the encryption type to use if passwords are included in the file.

[DataMember]
public ExportEncryptionType EncryptionType

Field Value

ExportEncryptionType

Remarks

See EncryptionKey for further information.

For ImportOptions, this value is ignored starting with version 6.0. For versions prior to 6.0, it must be set to the value returned in ImportFileInformation.

IncludeJobHistory

Include the job history (status, instances, and log messages) when exporting or importing a job. This option must be set for both the export and the import.

[DataMember]
public bool IncludeJobHistory

Field Value

bool

Properties

AdditionalOptions

Additional named options controlling the operation

[DataMember]
public Dictionary<string, object> AdditionalOptions { get; }

Property Value

Dictionary<string, object>

IncludeClassOptions

Determines whether class options (audit and snapshot settings) are included

public bool? IncludeClassOptions { get; set; }

Property Value

bool?

• truefalseThe settings are includedThe settings are not included
• nullFor export, the settings are included if the OIDs list includes ServerSettings. For import, the settings are imported if they are present in the import source.

IncludeServerJobVariables

Determines whether server-level Job Variables are included

public bool? IncludeServerJobVariables { get; set; }

Property Value

bool?

• truefalseThe variables are includedThe settings are not included
• nullFor export, the settings are included if the OIDs list includes ServerSettings. For import, the settings are imported if they are present in the import source.

IncludeServerOptions

Determines whether general server settings are included

public bool? IncludeServerOptions { get; set; }

Property Value

bool?

• truefalseThe settings are includedThe settings are not included
• nullFor export, the settings are included if the OIDs list includes ServerSettings. For import, the settings are imported if they are present in the import source.

Methods

GetAdditionalOption<T>(string, T)

Gets the additional option with the specified name

public T GetAdditionalOption<T>(string optionName, T defaultValue)

Parameters

Name	Type	Description
optionName	string	Case-insensitive name of the option to get
defaultValue	T	The default value to return if the option is not defined

Returns

T

Type Parameters

Name	Description
T

GetBoolOption(string)

protected bool? GetBoolOption(string optionName)

Parameters

Name	Type	Description
optionName	string

Returns

bool?

SetAdditionalOption(string, object)

Sets the value for the additional option with the specified name

public void SetAdditionalOption(string optionName, object value)

Parameters

Name	Type	Description
optionName	string
value	object

SetBoolOption(string, bool?)

protected void SetBoolOption(string optionName, bool? value)

Parameters

Name	Type	Description
optionName	string
value	bool?

SetPassword(string)

Sets the password to use when EncryptionType is ExportEncryptionType.Password

public void SetPassword(string source)

Parameters

Name	Type	Description
source	string

Remarks

This method hashes the source value; the hash is then used as the password.