XAF - Generate Database Updater Code for Security Roles Created in Application UI in Development Environment

An XAF test environment usually uses a non-production database. Developers often populate such databases with initial security roles. They use a runtime administrative UI to do this since the visual approach is often faster than writing code, especially for complex permissions with criteria. At some point, developers may need to transfer role data to production databases on customer sites.

This example relies on standard XAF mechanisms that help you seed initial data in databases: ModuleUpdater API and DBUpdater tool.

The transfer mechanism suggested in this solution works as follows: you embed controllers from this example into your test application, and these embedded controllers can analyze database content and generate ModuleUpdater code for required roles. You can then copy and paste this code into your production project's ModuleUpdater descendant. Use the standard DBUpdater tool to seed data in the database.

The example intentionally skips user creation code. User names are often unknown at early stages which simplifies creating and linking users to predefined roles later in a production environment.

If this solution is not suitable, you can use one of the following alternatives:

• Save the data records from the development database in an XML file and then load this XML file in an application that uses the production database.

• Transfer data using built-in RDBMS capabilities.

For more information, see the following Support Center ticket: Security - Best Practices for Export/Import Role Permissions at runtime (without releasing a new application version to clients). Please note that this solution is applicable only if you use XPO.

Note
You can find a solution for .NET Framework, Web Forms, and VB.NET in branch 20.1.3.

Implementation Details

1. In the Solution Explorer, include RoleGenerator.csproj in your XAF solution.

2. In the YourSolutionName.Module project, add a reference to the RoleGenerator project.

3. Add the following files to your XAF solution projects:

   • YourSolutionName.Module: RoleGeneratorController.cs
   • YourSolutionName.Win: RoleGeneratorControllerWin.cs
   • YourSolutionName.Blazor.Server: RoleGeneratorControllerBlazor.cs

4. Modify the CS/EFCore/GenerateRoleEF/GenerateRoleEF.Win/App.config and YourSolutionName.Blazor.Server/appsettings.json files to add the EnableRoleGeneratorAction key.

   <appSettings>
       ...
     <add key="EnableRoleGeneratorAction" value="True" />
   </appSettings>

   "EnableRoleGeneratorAction": "True",

5. Run the YourSolutionName.Win or YourSolutionName.Blazor.Server project, select the roles in the Role List View, and click the Generate Role Action (in the WinForms project, you can find this Action in the Tools menu).

   ASP.NET Core Blazor

   

   Windows Forms

   

6. Save the generated file. It contains code that creates initial roles based on the data stored in your test database. To use this file in your XAF solution, consider one of the following techniques:

   • Modify the existing YourSolutionName.Module/DatabaseUpdate/Updater.xx file based on the CreateUsersRole method code copied from the generated Updater.xx file.
   • Include the generated Updater.xx file into the YourSolutionName.Module/DatabaseUpdate folder and modify the YourSolutionName/Module.cs file to use this new RoleUpdater class as follows:

   // C#
   using System;
   using DevExpress.ExpressApp;
   using System.Collections.Generic;
   using DevExpress.ExpressApp.Updating;
   
   namespace YourSolutionName.Module {
     public sealed partial class YourSolutionNameModule : ModuleBase {
       public override IEnumerable<ModuleUpdater> GetModuleUpdaters(IObjectSpace objectSpace, Version versionFromDB) {
         ModuleUpdater updater = new DatabaseUpdate.Updater(objectSpace, versionFromDB);
           ModuleUpdater roleUpdater = new RoleUpdater(objectSpace, versionFromDB);
       	return new ModuleUpdater[] { updater, roleUpdater };
   //...

   Note
   In the ASP.NET Core Blazor application, the file is saved to the Documents folder by default. You can change this behavior by overriding the RoleGeneratorControllerBlazor.SaveFile method.

Customization for Custom Security Roles

You can use a custom security role class. For example, ExtendedSecurityRole implementations are available in the following examples: Implement a Custom Security System User Based on an Existing Business Class, Implement Custom Security Objects (Users, Roles, Operation Permissions). If a security role has custom properties, you need to include these properties in the generated code. To do this, handle the RoleGenerator.CustomizeCodeLines event in the RoleGeneratorController class added in Step 2:

// C#
using System.Collections.Generic;
using System.Linq;
using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Actions;
using DevExpress.Persistent.Base;
using RoleGeneratorSpace;

namespace XafSolution.Module.Controllers {
    public abstract class RoleGeneratorController : ViewController<ListView> {
	//...
        protected void RoleGeneratorAction_Execute(object sender, SimpleActionExecuteEventArgs e) {
            RoleGenerator roleGenerator = new RoleGenerator(roleType);
            roleGenerator.CustomizeCodeLines += RoleGenerator_CustomizeCodeLines;
            IEnumerable<IPermissionPolicyRole> roleList = e.SelectedObjects.OfType<IPermissionPolicyRole>();
            string updaterCode = roleGenerator.GetUpdaterCode(roleList);
            SaveFile(updaterCode);
        }

        private void RoleGenerator_CustomizeCodeLines(object sender, CustomizeCodeLinesEventArg e) {
            ExtendedSecurityRole exRole = e.Role as ExtendedSecurityRole;
            if(exRole != null) {
                e.CustomCodeLines.Add(string.Format("role.CanExport = {0};", exRole.CanExport.ToString().ToLowerInvariant()));
            }
        }
    }
}

Warning

We created this example for demonstration purposes and it is not intended to address all possible usage scenarios. You can extend this example or change its behavior as needed. This can be a complex task that requires good knowledge of XAF: UI Customization Categories by Skill Level, and you might also need to research the internal architecture of DevExpress components. Refer to the following help topic for more information: Debug DevExpress .NET Source Code with PDB Symbols. We are unable to help with such tasks. Custom programming is outside our Support Service scope: Technical Support Scope.

Files to Review

• RoleGeneratorController.cs
• RoleGeneratorControllerWin.cs
• RoleGeneratorControllerBlazor.cs
• RoleGenerator

Does this example address your development requirements/objectives?

(you will be redirected to DevExpress.com to submit your response)