SDK: Creating Settings Objects
  • 03 May 2022
  • 1 Minute to read
  • Dark
    Light

SDK: Creating Settings Objects

  • Dark
    Light

Overview

If the application requires its own set of settings, new settings can be created via code. After creating these settings, the values of these settings can be fetched and set via code (see Accessing System Settings (user settings)) or by users who navigate in the portal to System > Settings and edit your specific settings.

Example of Creating Settings

Create a new class file project with a public class that inherits from and implementsAbstractModuleSettings. Add references to System.Runtime.Serialization and DecisionsFramework. Decorate the class with [ORMEntity] & [DataContract].

Below is an example implementation of AbstractModuleSettings.

 List<baseactiontype> actionTypes = new List<baseactiontype>();
actionTypes.Add(new EditEntityAction(typeof(MyCustomSettings), "Edit Settings", "Edit My Custom Settings"));
return actionTypes.ToArray();</baseactiontype></baseactiontype>

For each individual setting should be part of the new settings object, add a public and private member decorated as shown below.

 [ORMField]
private string externalUrl = "";

[DataMember]
public string ExternalUrl
{
    get { return externalUrl; }
    set { externalUrl = value; }
}

The custom settings object will not be initialized until it is accessed for the first time.  To have it initialized immediately, the type should implement Initializable.

 public class DefaultAuditSettings : AbstractModuleSettings, IInitializable
....
public void Initialize()
{
   // Make sure Audit Settings gets initialized in life.
   ModuleSettingsAccessor<defaultauditsettings>.GetSettings();
}</defaultauditsettings>

Was this article helpful?