How to: Enable the Administrative UI for managing Users' Model Differences

• Jul 04, 2019
• 2 minutes to read

This topic describes how to enable UI elements you can use to manage Model Differences stored in the database.

Note

Mobile applications do not support Users’ Model Differences.

The Administrative UI allows application administrators to manage user settings in user accounts - create, copy, export and reset Model Differences. Follow the steps below to enable this UI in your application:

1. If you use XPO, run the Module Designer and add the ModelDifference and ModelDifferenceAspect types to the module in the Exported Types section:

   

   If you use the Entity Framework, register the ModelDifference and ModelDifferenceAspect entity types within your DbContext:

   C#

   using DevExpress.Persistent.BaseImpl.EF;
   // ...
   public class MyDbContext : DbContext {
    // ...
    public DbSet<ModelDifference> ModelDifferences { get; set; }
    public DbSet<ModelDifferenceAspect> ModelDifferenceAspects { get; set; }
   }
   

   VB.NET

   Imports DevExpress.Persistent.BaseImpl.EF
   ' ...
   Public Class MyDbContext
    Inherits DbContext
    ' ...
    Public Property ModelDifferences() As DbSet(Of ModelDifference)
    Public Property ModelDifferenceAspects() As DbSet(Of ModelDifferenceAspect)
   End Class
   

2. Run the Model Editor and create a new Navigation Item for the ModelDifference_ListView List View.

   

Run the application and click this Navigation Item to open the Model Difference List View. Ensure that the Model Differences management Actions are available in the Tools category.

Users who used the application at least once have initialized Model Differences. The List View lists these Model Differences. This View also contains the Shared Model Difference record that stores global settings. Click Create Model Differences to create Model Differences for unlisted users. Click Import Shared Model Difference to load shared Model Differences created in Visual Studio (the Model.xafml file). You can also copy, export and reset a selected record. Refer to the Model Difference Storages article’s Administrative UI section for more information about these Actions.

Note

• The Export Model Differences Action saves model differences to the application’s ExportedModelDifferences subfolder. Use the ModelDifferenceViewController.ExportedModelDifferencesPath property to change the folder.
• Restart an ASP.NET application on the web server to apply changes if you changed its global settings (for example, using the Import Shared Model Difference Action).