Class ScramblingOptions

Namespace

The.Components

Assembly

Instagile.dll

public sealed class ScramblingOptions

Inheritance

object

ScramblingOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

DateScramblingDayRange

The maximum number of days into the future that the data scrambler should change date values in order to scramble them.

public int DateScramblingDayRange { get; set; }

Property Value

int

DefaultDateFormat

Format to use when reading or detecting date values from spreadsheets.

public string DefaultDateFormat { get; set; }

Property Value

string

DefaultDateTimeFormat

Format to use when reading or detecting datetime values from spreadsheets.

public string DefaultDateTimeFormat { get; set; }

Property Value

string

DefaultScramblingAction

Fallback behaviour for the data scrambler if no cascading scrambling tag has been specified in the model snapshot.

public ScramblingAction DefaultScramblingAction { get; set; }

Property Value

ScramblingAction

DefaultTimeFormat

Format to use when reading or detecting time values from spreadsheets.

public string DefaultTimeFormat { get; set; }

Property Value

string

EntityScramblingBatchSize

Batch size to use when scrambling entities.

public int EntityScramblingBatchSize { get; set; }

Property Value

int

PreserveInstantOffset

When scrambling attributes of type Instant, whether to preserve the Offset component. If false, converts to UTC before scrambling.

public bool PreserveInstantOffset { get; set; }

Property Value

bool

PurgeAuditLogsAfterScrambling

Whether to purge audit entity types after scrambling a database.

public bool PurgeAuditLogsAfterScrambling { get; set; }

Property Value

bool

PurgeBatchSize

Batch size to use when erasing a target scrambled database in preparation to store scrambled data in it.

public int PurgeBatchSize { get; set; }

Property Value

int

RecalculateAfterScrambling

Whether to recalculate properties after scrambling a database.

public bool RecalculateAfterScrambling { get; set; }

Property Value

bool

RelationshipCopyingBatchSize

Batch size to use when copying relationships to a scrambled database.

public int RelationshipCopyingBatchSize { get; set; }

Property Value

int

ScramblingUsername

The identity to use for persistence when scrambling.

public string ScramblingUsername { get; set; }

Property Value

string

TimeScramblingMinuteRange

The maximum number of minutes into the future that the data scrambler should change time values in order to scramble them.

public int TimeScramblingMinuteRange { get; set; }

Property Value

int

Methods

AddDatabase(string, Func<Stream>, EntityMetadataDictionary, EntityMetadataDictionary, IEntityStore, IEntityStore, IEntityStore)

Registers a database that can be scrambled.

public void AddDatabase(string name, Func<Stream> getModelStream, EntityMetadataDictionary metadata, EntityMetadataDictionary legacyMetadata, IEntityStore scrambledStore, IEntityStore legacyStore, IEntityStore scrambledLegacyStore)

Parameters

name string

A name for this database that can be scrambled.

getModelStream Func<Stream>

A function returning a stream containing the model file for the framework database being scrambled.

metadata EntityMetadataDictionary

Entity metadata in non-legacy mode for the scrambled database.

legacyMetadata EntityMetadataDictionary

Entity metadata in legacy mode for the scrambled database.

scrambledStore IEntityStore

Entity store configured in non-legacy mode for the scrambled database.

legacyStore IEntityStore

Entity store configured in legacy mode for the non-scrambled database.

scrambledLegacyStore IEntityStore

Entity store configured in legacy mode for the scrambled database.

AddGlobalExcludedWord(string)

Prevents the specified word from being scrambled.

public void AddGlobalExcludedWord(string excludedWord)

Parameters

excludedWord string

The word to exclude from scrambling. This is case insensitive within the invariant culture.

AddGlobalExcludedWordPrefix(string)

Prevents the specified prefix from being scrambled. For ""id"" is added and the scrambler encounters the word ""idiosyncrasy"" or ""ID12345"", it will leave the first two letters unchanged and scramble the remaining characters.

public void AddGlobalExcludedWordPrefix(string excludedWordPrefix)

Parameters

excludedWordPrefix string

The prefix to exclude from scrambling. This is case insensitive within the invariant culture.