Skip to content

Configuration

The configuration service provides methods for retrieving various type of configuration values.

Plugin configuration

Using the secure/unsecure plugin configuration is straightforward. First, ensure your plugin constructor includes the unsecure and secure strings Then, inject an IPluginConfigService into the plugin. This interface provides methods to deserialize the secure or unsecure configuration strings.

Example plugin with secure and unsecure configuration
namespace Sample.Plugins
{
    using Imprevis.Dataverse.Plugins;

    public class TestPlugin : Plugin<TestPluginRunner>
    {
        public TestPlugin(string unsecure, string secure) : base(unsecure, secure) { }
    }

    public class TestPluginRunner : IPluginRunner
    {
        public TestPluginRunner(IPluginConfigService config)
        {
            Config = config;
        }

        public IPluginConfigService Config { get; }

        public void Execute()
        {
            var unsecureConfig = Config.GetUnsecure<TestPluginConfig>();

            // Do something!
        }
    }
}

Note

By default, the configuration service assumes a JSON string, however you can specify SerializationFormat.Xml if you have an XML string.

Feature flags

Coming soon.

Environment variables

Coming soon.