Table of Contents

Class SystemSettings

Namespace
Geotab.Checkmate.ObjectModel
Assembly
Geotab.Checkmate.ObjectModel.dll

The settings related to the entire system.

public class SystemSettings : Entity, IEntity, IComparable, IIdentifiable, IDefaultable
Inheritance
SystemSettings
Implements
Inherited Members
Extension Methods

Constructors

SystemSettings()

Initializes a new instance of the SystemSettings class.

public SystemSettings()

Fields

MaximumStoredPreviousPasswordHashes

The maximum setting of previous password hashes that we will store.

public const int MaximumStoredPreviousPasswordHashes = 1000

Field Value

int

MinPasswordLength

The minimum password length PasswordPolicy.

public const int MinPasswordLength = 8

Field Value

int

MinWeakPasswordLength

The minimum password length when the custom code ALLOWWEAKPASSWORDS is used PasswordPolicy.

public const int MinWeakPasswordLength = 3

Field Value

int

Properties

AggressivePurge

Gets or sets the aggressive purge setting.

public bool? AggressivePurge { get; set; }

Property Value

bool?

bool

AllowMarketplacePurchases

Gets or sets a value indicating whether marketplace purchases are allowed.

public bool? AllowMarketplacePurchases { get; set; }

Property Value

bool?

A value indicating whether marketplace purchases are allowed.

AllowResellerAutoLogin

Gets or sets if the resellers are allowed to login automatically.

public bool? AllowResellerAutoLogin { get; set; }

Property Value

bool?

The resellers are allowed to login automatically.

AllowThirdPartyMarketplaceApps

Gets or sets a value indicating whether the user is allowed to see third-party marketplace items.

public bool? AllowThirdPartyMarketplaceApps { get; set; }

Property Value

bool?

Nullable<T> where T is. bool

AllowUnsignedAddIn

Gets or sets a value indicating whether unsigned Add-Ins is allowed.

public bool? AllowUnsignedAddIn { get; set; }

Property Value

bool?

Nullable<T> where T is. bool

AllowedUserAuthenticationType

Gets or sets the allowed user authentication type.

public UserAuthenticationType? AllowedUserAuthenticationType { get; set; }

Property Value

UserAuthenticationType?

The allowed user authentication type.

AllowedUserInactivityPeriod

Gets or sets the allowed No access period for user in days.

public int? AllowedUserInactivityPeriod { get; set; }

Property Value

int?

The allowed No access period for user in days.

AllowedUserInactivityPeriodDefault

Gets or sets the default value for allowed No access period for user in days.

public int? AllowedUserInactivityPeriodDefault { get; set; }

Property Value

int?

The allowed No access period for user in days.

Comments

Gets or sets free text field where any user information can be stored and referenced for this database.

public string? Comments { get; set; }

Property Value

string

string

CompanyAddress

Gets or sets the address of the registered company - used in some reports.

public string? CompanyAddress { get; set; }

Property Value

string

string

CompanyGuid

Gets or sets the unique GUID for this database.

public Guid? CompanyGuid { get; set; }

Property Value

Guid?

Nullable<T>

CompanyName

Gets or sets the name of the registered company for this database - it is used in reports.

public string? CompanyName { get; set; }

Property Value

string

string

CountryCode

Gets or sets the name of the country code for this database.

public string? CountryCode { get; set; }

Property Value

string

string

CustomCode

Gets or sets the custom code(s) used to enable specialized functionality.

public string? CustomCode { get; set; }

Property Value

string

string

CustomExemptHOSAbbreviation

Gets or sets the custom Exempt HOS Abbreviation

public string? CustomExemptHOSAbbreviation { get; set; }

Property Value

string

The custom Exempt HOS Abbreviation

CustomExemptHOSName

Gets or sets the custom Exempt HOS name

public string? CustomExemptHOSName { get; set; }

Property Value

string

The custom Exempt HOS name

CustomWebMapProviderList

Gets or sets the custom web map provider list.

public List<CustomWebMapProvider>? CustomWebMapProviderList { get; set; }

Property Value

List<CustomWebMapProvider>

List<T>

CustomerClassification

Gets or sets the customer classifiers.

public List<CustomerClassifier>? CustomerClassification { get; set; }

Property Value

List<CustomerClassifier>

string

CustomerPages

Gets or sets customer pages.

public List<string>? CustomerPages { get; set; }

Property Value

List<string>

List<T> where T is. string

DataPrivacySettings

Gets or sets the data privacy settings for DDIS.

public DataPrivacySettings? DataPrivacySettings { get; set; }

Property Value

DataPrivacySettings

DataPrivacySettings

DataVersion

Gets or sets dataVersion of SystemSettings.

public string? DataVersion { get; set; }

Property Value

string

string

DatabaseOwner

Gets or sets the database owner.

public string? DatabaseOwner { get; set; }

Property Value

string

The database owner.

DatabaseRetentionLastActivityDate

Gets or sets the date of the last recorded activity for use in database retention calculations

public DateTime? DatabaseRetentionLastActivityDate { get; set; }

Property Value

DateTime?

DateTime

DatabaseRetentionPeriod

Gets or sets the number of days to retain a database after its lst audit date before deletion.

public DatabaseMaintenancePeriod? DatabaseRetentionPeriod { get; set; }

Property Value

DatabaseMaintenancePeriod?

DateTime

DemoConfiguration

Gets or sets the DemoConfiguration settings for the database.

public DemoConfiguration? DemoConfiguration { get; set; }

Property Value

DemoConfiguration

DemoConfiguration

DirectSupportAcceptedDate

Gets or sets the DirectSupportAcceptedDate.

public DateTime? DirectSupportAcceptedDate { get; set; }

Property Value

DateTime?

DateTime

DirectSupportInfo

Gets or sets returns the direct support information for this database. This object will have a value if isDirectSupported field in ResellerInfo object is true.

public ResellerInfo? DirectSupportInfo { get; set; }

Property Value

ResellerInfo

ResellerInfo

DistanceIncreaseFactor

Gets or sets percentage factor to add to each calculated distance, used to improve accuracy.

public double? DistanceIncreaseFactor { get; set; }

Property Value

double?

Nullable<T> where T is. double

Domain

Gets or sets a value indicating the domain when the database is created.

public string? Domain { get; set; }

Property Value

string

The domain when the database is created

EmailSenderFrom

Gets or sets the email sender for this database. System sent emails will be from this address.

public string? EmailSenderFrom { get; set; }

Property Value

string

The email sender from.

Exceptions

ArgumentException

Email address is not valid.

EnableDataFileEncryption

Gets or sets the Encryption state.

public bool? EnableDataFileEncryption { get; set; }

Property Value

bool?

Nullable<T> where T is. bool

EnableMinimumTravelInRouteSegment

Gets or sets a value indicating whether or not to enable the minimum distance travel required to complete route segments.

public bool? EnableMinimumTravelInRouteSegment { get; set; }

Property Value

bool?

Nullable<T> where T is bool

EnableOemActivationProcess

Gets or sets a value indicating whether or not to enable the OEM activation process.

public bool? EnableOemActivationProcess { get; set; }

Property Value

bool?

Nullable<T> where T is bool

FeatureEnvironment

Gets or sets the database feature environment. Default is Stable.

public FeatureEnvironment? FeatureEnvironment { get; set; }

Property Value

FeatureEnvironment?

FeatureEnvironment

FileSizeLimits

Gets or sets the size limits for media files.

public FileSizeLimits? FileSizeLimits { get; set; }

Property Value

FileSizeLimits

The size limits for media files.

FuelSettings

Gets or sets the fuel settings.

public FuelSettings? FuelSettings { get; set; }

Property Value

FuelSettings

FuelSettings

FuelTransactionImportSettingsList

Gets or sets the fuel transaction import settings.

public List<FuelTransactionImportSettings>? FuelTransactionImportSettingsList { get; set; }

Property Value

List<FuelTransactionImportSettings>

FuelTransactionImportSettings

GoogleApiKey

Gets or sets the database specific Google API Key if one is provided.

public string? GoogleApiKey { get; set; }

Property Value

string

string

HereApiKey

Gets or sets the database specific Here.com key if one is provided.

public string? HereApiKey { get; set; }

Property Value

string

string

Host

Gets or sets the application host.

public string? Host { get; set; }

Property Value

string

Value indicating the application host.

IncludeReportAttachmentsInEmail

Gets or sets a value indicating whether or not to include report attachments in email.

public bool? IncludeReportAttachmentsInEmail { get; set; }

Property Value

bool?

Include report attachments in email.

Industry

Gets or sets the Industry GUID.

public string? Industry { get; set; }

Property Value

string

string

IsAutomationEnabled

Gets or sets if first time users need to provide the primary job.

public bool? IsAutomationEnabled { get; set; }

Property Value

bool?

bool for validation if first time users need to provide the primary job

IsBackup

Gets or sets is this a backup.

public bool? IsBackup { get; set; }

Property Value

bool?

Nullable<T> where T is. bool

IsDirectCustomer

Gets or sets if is a Direct Customer DB.

public bool? IsDirectCustomer { get; set; }

Property Value

bool?

Nullable<T> where T is bool.

Jurisdiction

Gets or sets the jurisdiction.

public Jurisdiction? Jurisdiction { get; set; }

Property Value

Jurisdiction?

Jurisdiction The data residency jurisdiction.

LastCompanyProfileExportToBq

Gets or sets the last time the company profile data was exported to big query.

public DateTime? LastCompanyProfileExportToBq { get; set; }

Property Value

DateTime?

DateTime

LastUpdate

Gets or sets the LastUpdate.

public DateTime? LastUpdate { get; set; }

Property Value

DateTime?

DateTime

LiveDataValidityInterval

Gets or sets the validity period for live data updates.

public TimeSpan? LiveDataValidityInterval { get; set; }

Property Value

TimeSpan?

The validity period for live data updates.

LocationSharingRadius

Gets or sets the location sharing radius.

public int? LocationSharingRadius { get; set; }

Property Value

int?

The limit of distance from the destination in which the shared vehicle can be seen on the shared link

MapBoxApiKey

Gets or sets the database specific Map Box key if one is provided.

public string? MapBoxApiKey { get; set; }

Property Value

string

string

MapDownloadUrlList

Gets or sets false The map download URL list.

public List<string>? MapDownloadUrlList { get; set; }

Property Value

List<string>

The map download URL list.

MapProvider

Gets or sets the Map Provider for this database.

public string? MapProvider { get; set; }

Property Value

string

string

MaxPCDistance

Gets or sets the maximum distance (in m) that a driver can travel in PC before getting put into D.

public int? MaxPCDistance { get; set; }

Property Value

int?

The maximum distance (in m) that a driver can travel in PC before getting put into D.

MaximumStopInterval

Gets or sets a system wide value representing the maximum stop time to be used for some reports and calculations.

public TimeSpan? MaximumStopInterval { get; set; }

Property Value

TimeSpan?

Nullable<T>

MinimumStopInterval

Gets or sets a system wide value representing the minimum stop time to be used for some reports and calculations.

public TimeSpan? MinimumStopInterval { get; set; }

Property Value

TimeSpan?

Nullable<T>

NotificationExcludedTokens

Gets or sets excluded tokens from notification types such as email

public List<NotificationTokenType>? NotificationExcludedTokens { get; set; }

Property Value

List<NotificationTokenType>

List<T> where T is. NotificationTokenType

PasswordLifetime

Gets or sets the password lifetime. A user's session ultimate expiry date will have a maximum of when this lifetime expires. If a user authenticates and the lifetime is up they will be forced to change their password. Does nothing if the lifetime is 0 or less.

public TimeSpan? PasswordLifetime { get; set; }

Property Value

TimeSpan?

The password lifetime. A user's session ultimate expiry date will have a maximum of when this lifetime expires. If a user authenticates and the lifetime is up they will be forced to change their password. Does nothing if the lifetime is 0 or less.

PasswordPolicy

Gets or sets the password policy.

public PasswordPolicy? PasswordPolicy { get; set; }

Property Value

PasswordPolicy

PasswordPolicy

PercentOfLeasedVehicles

Gets or sets the percent of leased vehicles.

public int? PercentOfLeasedVehicles { get; set; }

Property Value

int?

int

PercentOfTelematicsDevices

Gets or sets the percent of telematics devices.

public int? PercentOfTelematicsDevices { get; set; }

Property Value

int?

int

PhoneNumber

Gets or sets the name of the registered phone number for this database.

public string? PhoneNumber { get; set; }

Property Value

string

string

PurgeSettings

Gets or sets the Purge settings.

public PurgeSettings? PurgeSettings { get; set; }

Property Value

PurgeSettings

PurgeSettings

ResellerInfo

Gets or sets returns the reseller info for this database, if it exists.

public ResellerInfo? ResellerInfo { get; set; }

Property Value

ResellerInfo

ResellerInfo

ResultLimits

Gets or sets the result limits for different sources.

public ResultLimits? ResultLimits { get; set; }

Property Value

ResultLimits

The result limits for different sources.

SmallCacheMode

Gets or sets returns true if the processor is set to light memory footprint mode (for systems with large fleets).

public bool? SmallCacheMode { get; set; }

Property Value

bool?

True if lightweight mode, false otherwise.

SpeedingGraceDuration

Gets or sets the grace period to use when deciding whether speeding is happening for the first speeding trigger.

public TimeSpan? SpeedingGraceDuration { get; set; }

Property Value

TimeSpan?

Nullable<T>

SpeedingTrigger

Gets or sets the 3 Speeding triggers used to calculate the violations in speed ranges in Trip(s), in km/h.

public float[]? SpeedingTrigger { get; set; }

Property Value

float[]

The 3 Speeding trigger.

StopSpeedGo

Gets or sets the maximum speed for GO units, considered as NOT MOVING.

public int? StopSpeedGo { get; set; }

Property Value

int?

Nullable<T> where. int

StoredPreviousPasswordHashes

Gets or sets the number of previous password hashes to remember. Used to prevent users from changing their password to a previous password. 0 is a special value where we will not prevent this. The maximum value is 1000.

public int? StoredPreviousPasswordHashes { get; set; }

Property Value

int?

The number of previous password hashes to remember. Used to prevent users from changing their password to a previous password. 0 is a special value where we will not prevent this. The maximum value is 1000.

SystemScript

Gets or sets systemScript.

public string? SystemScript { get; set; }

Property Value

string

string

ThirdPartyEulasAccepted

Gets or sets the third party EULAs that have been accepted on behalf of the entire company.

public List<EulaAcceptanceInfo>? ThirdPartyEulasAccepted { get; set; }

Property Value

List<EulaAcceptanceInfo>

The third party EULAs that have been accepted on behalf of the entire company.

UserLockoutPolicy

Gets or sets the lockout policy of user.

public UserLockoutPolicy? UserLockoutPolicy { get; set; }

Property Value

UserLockoutPolicy

UserLockoutPolicy

UserTimeoutPeriod

Gets or sets the period (in minutes) after that user session expire if the user has no activity.

public int? UserTimeoutPeriod { get; set; }

Property Value

int?

The period (in minutes) after that user session expire if the user has no activity.

WeatherProvider

Gets or sets the Weather Provider for this database.

public string? WeatherProvider { get; set; }

Property Value

string

The Weather Provider.

Website

Gets or sets the webiste.

public string? Website { get; set; }

Property Value

string

string

ZoneNeighbourhoodLimit

Gets or sets a system wide value representing the maximum distance from a zone's borders where a moving or stationary device is considered visiting the zone's neighbourhood.

public double? ZoneNeighbourhoodLimit { get; set; }

Property Value

double?

A system wide value representing the maximum distance from a zone's borders where a moving or stationary device is considered visiting the zone's neighbourhood.

ZoneNeighbourhoodLimitWhenMoving

Gets or sets a system wide value representing the maximum distance from a zone's borders where a moving device is considered visiting the zone's neighbourhood.

public double? ZoneNeighbourhoodLimitWhenMoving { get; set; }

Property Value

double?

A system wide value representing the maximum distance from a zone's borders where a moving device is considered visiting the zone's neighbourhood.

Methods

Clone()

Creates a new object that is a copy of the current instance.

public override IEntity Clone()

Returns

IEntity

A new object that is a copy of this instance.

Equals(object?)

Check if two objects are equal.

public override bool Equals(object? obj)

Parameters

obj object

The object to be compared.

Returns

bool

Comparison result.

GetHashCode()

Serves as a hash function for a particular type. GetHashCode() is suitable for use in hashing algorithms and data structures like a hash table.

public override int GetHashCode()

Returns

int

A hash code for the current object.

IsMyDemo()

Checks if this is a MyDemo database.

public bool IsMyDemo()

Returns

bool

True if this is a MyDemo database.

IsPasswordExpiryActive()

Gets a value indicating whether passwords can expire on this server.

public bool IsPasswordExpiryActive()

Returns

bool

If true, passwords can expire on this server.

IsValidNewExpiryDate(DateTime?)

Checks if the new expiry date is valid.

public bool IsValidNewExpiryDate(DateTime? expiryDate)

Parameters

expiryDate DateTime?

The new expiry date.

Returns

bool

true if the date is within the acceptable range or both current and new values are null, and false otherwise

PopulateDefaults()

Populate non-required empty (null) properties with default values.

public void PopulateDefaults()

SetDefaultDomain(string)

Set the default email sender for this database using default name.

public void SetDefaultDomain(string domain)

Parameters

domain string

The domain (ex "geotab.com").