Grzegorz Wiecheć
Mar 31, 2020
(8 votes)

Configuring Options from Admin Mode

Episerver allows to store configurations using Options attribute. This is a code-first approach, where class decorated with the [Options] attribute, will be used as a config. There are few advantages of this approach:

  • Same setup everywhere - configuration is the same on testing, staging and production servers.
  • Versioning - options are stored together with code in repository. It easy to check previous configuration values.
  • Testability - code is easy to test using unit tests.

Changing options

Customers can't change the Options properties without deploying a new site version to the production server. It means that they need to contact the Partner company responsible for the site implementation to modify options through code. Sometimes changes are urgent but very simple from a development perspective. For example, a Customer requires updating one boolean flag, that toggles an Edit Mode feature. Even for those simple scenarios, a Partner has to change code, deploy to test server, then to staging server and finally to production server. It can take days or even weeks, until the customer will see the updated version of the site.       

changing options.gif

Customers would of course be really happy if they can get the change faster than few weeks.

The idea of this Lab is to allow site administrators to temporary change options values, before the Partner company deploys new code-first version to the Production server. 

Additionally, ConfigurationManager can be used to configure options for other labs and open-source projects like Advanced Reviews.

Here you can see that for example we can disable InlineEditing feature with the Configuration Manager

And below is an example for Advanced Reviews:

How does it work?

By default, options are injected to a class using IoC. When the class (for example, TestService) has dependency on options (for example, TestOptions), the TestOptions are passed as a dependency using constructor to the TestService class.

public clas TestOptions
    public bool Flag1 { get; set; } = true;

    public bool Flag2 { get; set; } = true;

    public bool Flag3 { get; set; } = false;

When using the Configuration Manager labs, this code responsible for injecting options will not change.

Updated Options values are stored in the DDS. Administrators can update Options using the Admin view plugin. The user interface is very simple. To modify options, the Administrator has to provide valid JSON representing Options class. 

When saving JSON, Options are updated automatically, both on the current server and on all other servers (using remote events). Additionally, whenever the server is restarted, overriden configuration is loaded from DDS.

Here you can find the Nuget package.

Mar 31, 2020


Allan Thraen
Allan Thraen Mar 31, 2020 09:34 AM

Nice! And very useful.

It does remind me of an old feature (which might still exist), PluginSettings - as Described by Arild here:

David Knipe
David Knipe Mar 31, 2020 09:58 AM

Wonderful stuff! 

Ravindra S. Rathore
Ravindra S. Rathore Mar 31, 2020 02:40 PM

Nice stuff!

Eric Mar 31, 2020 08:09 PM

Very nice indeed!

Please login to comment.
Latest blogs
How to Merge Anonymous Carts When a Customer Logs In with Optimizely Commerce 14

In e-commerce, it is common for users to browse a site anonymously, adding items to their cart without creating an account. Later, when the user...

Francisco Quintanilla | Mar 27, 2023

How to Write an xUnit Test to Verify Unique Content Type Guids in Content Management

When developing an Optimizely CMS solution, it is important to ensure that each content type has a unique GUID. If two or more content types share...

Minesh Shah (Netcel) | Mar 27, 2023

Extend TinyMCE in Optimizely CMS 12

Since technologies are upgraded to newer versions the ways to extend or override the out-of-the-box functionality are also changed a little bit so...

Ravindra S. Rathore | Mar 27, 2023 | Syndicated blog

Telemetry correlation for Scheduled Jobs in Optimizely

I previously demonstrated how to correlate telemetry to Azure Application Insights within a Hangfire job. But how about those jobs that are built a...

Stefan Holm Olsen | Mar 23, 2023 | Syndicated blog