How to use site properties in OutSystems to toggle features or maintenance mode?

Using Site Properties in OutSystems for Toggling Features or Maintenance Mode

OutSystems provides a robust mechanism for environment configuration and feature toggling using site properties. This guide offers a detailed, step-by-step approach to using site properties in OutSystems to effectively manage application features and implement maintenance modes.

Prerequisites

• An OutSystems account with access to Service Studio.
• Basic knowledge of developing applications using the OutSystems platform.
• Understanding of web and mobile application deployment in OutSystems.

Understanding Site Properties

• Site properties are global variables stored on the server side within the OutSystems environment.
• They can be configured at runtime without re-deploying the application.
• Typically used to manage configurations, enable/disable features, or switch the application to maintenance mode.

Creating Site Properties

• Open your desired module in OutSystems Service Studio where you want to use site properties.
• Navigate to the "Data" tab.
• Right-click on "Site Properties" and select "Add Site Property."
• Provide a meaningful name, data type (e.g., Boolean, Text, Integer), and default value. For instance, a Boolean named "FeatureToggleX" can be used to enable or disable a feature.
• Make sure the "Is Active" property is checked to enable its use in expressions.

Using Site Properties for Feature Toggles

• Add logic to your application using If conditions or JavaScript that checks the value of the site property.
• Example: Add an If condition wherever FeatureX's logic resides:

      If(GetSiteProperty("FeatureToggleX"), EnableFeatureXLogic(), DisableFeatureXLogic())
      

• This will check the site property before executing feature logic.
• Ensure proper testing to verify various paths the application might take based on the site property’s value.

Implementing Maintenance Mode

• Create a site property called "MaintenanceMode" which would be a Boolean.
• In your application’s primary layout or main entry points, check this property’s value.
• Add logic in your screens to either redirect to a maintenance page or disable certain features based on this property:

      If(GetSiteProperty("MaintenanceMode"), RedirectToMaintenancePage(), ContinueWithNormalExecution())
      

• Design a user-friendly maintenance page explaining the application is in maintenance mode.

Configuring Site Properties in the Environment

• Access the OutSystems environment management console (Service Center).
• Navigate to "Factory" > "eSpaces," find your module, and click on it.
• Select "Site Properties" tab to view and edit the properties dynamically.
• Modify the value of your site properties as needed without redeploying the app.

Testing and Verifying Configuration Changes

• After updating site properties, ensure you test the application thoroughly to ensure changes are correctly applied.
• Both desktop and mobile interface rendering should be validated if applicable.
• Check the behavior in multiple user roles to verify that feature access control is respected.

Deploying Configurable Features to Production

• Plan your deployment strategy ensuring that any new site properties are initialized with sensible default values.
• Provide documentation or notes on how to manage new toggles or maintenance settings to your operations or support teams.
• Regularly monitor user feedback to refine feature toggle strategy for optimal performance and user satisfaction.

By following these steps, you can effectively control the feature availability and maintenance modes within your OutSystems applications, allowing for more dynamic and user-centric development and operations. This approach ensures that you can respond quickly to operational needs without disrupting the user experience.