Accessing System Settings (user settings)

Last Updated: 06/29/2018 Introduced in Version: 2.0
What is a settings object
A settings object is a collection of values that a portal user can edit and which can be used by code. Many times these settings are used to store things like connection information and credentials to external system so that step which interact with those systems can fetch their connection settings from a central place. These settings are also used to customize various aspects of the Decisions Portal.
 
Where a settings object is edited/maintained
These settings can be set by Portal users by navigating to the /System/Settings/ portal folder. In this folder, users will see a list of all settings which they can edit.
 
 
 
Accessing Settings Via Code
Any of the settings found in the portal at System > Settings can be accessed via code using the  ModuleSettingsAccessor. For example, to access the Portal Settings you could use  PortalSettings portalSettings = ModuleSettingsAccessor<PortalSettings>.GetSettings(); 
 
Now each of the properties of Portal Settings can be accessed in your code. For example, to access the portal’s Slogan Text you would use  portalSettings.SloganText
 
Editing Settings Via Code
After accessing settings using  ModuleSettingsAccessor, you can modify and save the values of each individual setting using  .SaveSettings() off  ModuleSettingsAccessor. Below is an example of how to set and save the Slogan Text:

List Of Platform Settings Objects

Additional Resources