Class Settings
A settings helper class for all settings in the core of LemonEdge and the API
Inheritance
Inherited Members
Namespace: LemonEdge.Core
Assembly: API.dll
Syntax
public static class Settings
Properties
AutoUpdaterPath
The path to look for new versions of the AutoUpdater application
For example: https://download.lemonedge.com/trial/updater/
Declaration
public static string AutoUpdaterPath { get; }
Property Value
Type | Description |
---|---|
System.String |
EmailLogin
The email login used for sending automated LemonEdge emails from
Declaration
public static string EmailLogin { get; }
Property Value
Type | Description |
---|---|
System.String |
EmailPassword
The email password used for sending automated LemonEdge emails from
Declaration
public static string EmailPassword { get; }
Property Value
Type | Description |
---|---|
System.String |
EmailSenderAddress
The email address used for sending automated LemonEdge emails from
Declaration
public static string EmailSenderAddress { get; }
Property Value
Type | Description |
---|---|
System.String |
EmailSenderName
The name used for sending automated LemonEdge emails from
Declaration
public static string EmailSenderName { get; }
Property Value
Type | Description |
---|---|
System.String |
EmailSMTPAddress
The smtp address used for sending automated LemonEdge emails from
Declaration
public static string EmailSMTPAddress { get; }
Property Value
Type | Description |
---|---|
System.String |
EmailSMTPPort
The smtp port used for sending automated LemonEdge emails from
Declaration
public static int EmailSMTPPort { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
InitiallyConnectToDatabasesOnStartup
Indicates when this service initially starts up that it should connect to each database. This can be configured not to happen if the task service is running from a sturage queue instead, but you may want an initial connection to verify databases.
Declaration
public static bool InitiallyConnectToDatabasesOnStartup { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
MessageConnectionString
A service bus end point for using messages
Declaration
public static string MessageConnectionString { get; }
Property Value
Type | Description |
---|---|
System.String |
MessageTopicForServerSync
The topic to use for the messages for server synchronization
Declaration
public static string MessageTopicForServerSync { get; }
Property Value
Type | Description |
---|---|
System.String |
MessageType
The type of message service to use to synchronize local caches across multiple services. Can be used instead of SharedCacheConnectionString
Values: Azure
Default: Azure
Declaration
public static string MessageType { get; }
Property Value
Type | Description |
---|---|
System.String |
SharedCacheConnectionString
The connection string to a shared cache server such as a redis cache server
Declaration
public static string SharedCacheConnectionString { get; }
Property Value
Type | Description |
---|---|
System.String |
SharedCacheExpirey
The default timespan to use before items in the cache automatically expire
Default: 2:00:00:00
Declaration
public static TimeSpan SharedCacheExpirey { get; }
Property Value
Type | Description |
---|---|
System.TimeSpan |
SSRS_Credential_Domain
The domain to use when using domain/username/password credentials to connect to the SSRS report server.
Declaration
public static string SSRS_Credential_Domain { get; }
Property Value
Type | Description |
---|---|
System.String |
SSRS_Credential_Password
The password to use when using domain/username/password credentials to connect to the SSRS report server.
Declaration
public static string SSRS_Credential_Password { get; }
Property Value
Type | Description |
---|---|
System.String |
SSRS_Credential_UseDefault
Indicates when connecting to the SSRS report server if it should use default network credentials or not.
You must provide domain/username/password if this is false.
Declaration
public static bool SSRS_Credential_UseDefault { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
SSRS_Credential_UserName
The username to use when using domain/username/password credentials to connect to the SSRS report server.
Declaration
public static string SSRS_Credential_UserName { get; }
Property Value
Type | Description |
---|---|
System.String |
SSRS_URL
Indicates the url to connect to your SSRS report server that the SSRS Reports will use by default.
The url needs to connect to the 2005 report execution server, for example:
http://localhost:80/ReportServer/ReportExecution2005.asmx?wsdlDeclaration
public static string SSRS_URL { get; }
Property Value
Type | Description |
---|---|
System.String |
StorageBasePath
The base path to store everything in the storage type. For Azure this is a container, for a local file system it's just a folder path.
Default: LTShare\
Declaration
public static string StorageBasePath { get; }
Property Value
Type | Description |
---|---|
System.String |
StorageConnectionString
The default connection string to the storage type. For azure this is an azure storage connection string, for a local drive it's just the drive name
Default: c:\
Declaration
public static string StorageConnectionString { get; }
Property Value
Type | Description |
---|---|
System.String |
StorageType
The type of storage to use for saving task server results
Values: Local, Azure
Default: Local
Declaration
public static string StorageType { get; }
Property Value
Type | Description |
---|---|
System.String |
TaskServiceNewCacheOnEveryTask
Indicates the task service will create a new cache when processing every task so it is not out of sync with any changes within the database itself
This is only really needed if the service is not aware through messaging, or shared cache, of any database changes
Default: falseDeclaration
public static bool TaskServiceNewCacheOnEveryTask { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
TaskServicePollTimeInMilliSecs
The gap between the task service polling the database for any new tasks (if it isn't using the storage account as a queue)
Default: 1000 (milliseconds)
Declaration
public static int TaskServicePollTimeInMilliSecs { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
TaskServiceQueueName
The name of the queue for the task service
Declaration
public static string TaskServiceQueueName { get; }
Property Value
Type | Description |
---|---|
System.String |
UpdatePath
The path to look for new versions of the currently running application
For example: https://download.lemonedge.com/trial/wpfcore/
Declaration
public static string UpdatePath { get; }
Property Value
Type | Description |
---|---|
System.String |
UpdatePathSharedAccessKey
The shared access token assigned to you with your license providing access to downloading the lemonedge latest updates automatically
If you are deploying this within your own network and getting updates from there you will not need a shared access key and this can be blank
Declaration
public static string UpdatePathSharedAccessKey { get; }
Property Value
Type | Description |
---|---|
System.String |
UseSharedCache
Indicates you would like to synchronize the cache between multiple services through the use of a shared cache server
Default: false
Declaration
public static bool UseSharedCache { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
UseStorageForTaskServiceQueue
Indicates you want the system to use the storage to create a queue for the task service rather than the task service polling the database continually.
For Azure this will use an Azure queue and means you can have a SQL Azure database setup as serverless while the task service uses the azure queue so as to allow the database to powerdown when unsused
Default: false
Declaration
public static bool UseStorageForTaskServiceQueue { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Methods
ReloadAPISettings()
Forces the system to reload all settings contained within the API assembly
Declaration
public static void ReloadAPISettings()