Allow an Administrator to Create Custom Persistent Fields in an XPO-Based Application

• Dec 27, 2022
• 5 minutes to read

You can allow an application administrator to create custom persistent fields and display the added fields’ data in the UI without recompiling the application. In this example, the SkypeID field will be added to the Contact business object in the MainDemo application.

The following sections describe the process of implementation custom persistent fields from application settings to runtime customization.

• Prerequisites
• Setup the Application
• Choose the Model Editor Type
• Implement the Persistent Field and Display It
• Apply Changes to the Database

Prerequisites

Ensure that your application does not contradict the following conditions. Otherwise, creating new persistent fields is impossible at runtime.

• WinForms and ASP.NET Web Forms applications should be based on the XPO data model.
• ASP.NET Core Blazor applications do not support the DBUpdater tool that is required for the approach described in this topic.

• The following features should not be used together.

  • SecuredObjectSpaceProvider or XPObjectSpaceProvider created using the constructor with the threadSafe parameter set to true (this parameter enables ThreadSafeDataLayer).
  • An Administrator’s Model Differences stored in the database using the XafApplication.CreateCustomModelDifferenceStore event (you can still store the User’s differences in the database using the XafApplication.CreateCustomUserModelDifferenceStore event).
  • Custom Persistent Fields declared in the Administrator’s Model Differences.

  With this configuration, your application loads information on custom persistent fields from the database and then updates the database schema. However, a thread-safe data layer does not support altering the data model after the database connection is established.

• Middle Tier Security, Workflow Server Service, or any other application that creates and configures a ServerApplication/XafApplication cannot access custom fields added in the client XAF application project (in code or in XAFML), or by customizing the application model at runtime. You should add a custom field in a common module and reference it in all applications where you are going to use it.

Setup the Application

Apply the following changes in the application code to allow application administrators to create and display custom persistent field data in the UI.

• Set the static ModelMemberReadOnlyCalculator.AllowPersistentCustomProperties property to true to allow creating persistent fields at runtime. Open the Module.cs (Module.vb) file and add the following code to the module’s constructor.

  C#

  DevExpress.ExpressApp.Model.Core.ModelMemberReadOnlyCalculator.AllowPersistentCustomProperties = true;
  

  VB.NET

  DevExpress.ExpressApp.Model.Core.ModelMemberReadOnlyCalculator.AllowPersistentCustomProperties = True
  

• Set the IObjectSpaceProvider.CheckCompatibilityType property to CheckCompatibilityType.DatabaseSchema to catch the database changes and update the database if the schema is modified.

  

• To allow the database schema updates, set the XafApplication.DatabaseUpdateMode property to DatabaseUpdateMode.UpdateDatabaseAlways or DatabaseUpdateMode.UpdateOldDatabase.
• Copy the DBUpdater.v24.2.exe and DBUpdater.v24.2.config files from the %PROGRAMFILES%\DevExpress 24.2\Components\Tools\eXpressAppFramework\DBUpdater\ folder to the application’s installation folder.

Choose the Model Editor Type

It is necessary to determine which type of the Model Editor is appropriate for your application: standalone or built-in.

• A built-in Model Editor

  When an administrator uses a WinForms application, it is possible to invoke the built-in Model Editor tool to add a custom field to the application model. Using this Model Editor type, the administrator can edit both Model Differences stored in the application database and Model Differences from the XAFML file.

• A standalone Model Editor

  The use of the standalone Model Editor is preferred if an administrator uses only an ASP.NET Web Forms application and Model Differences are stored in the XAFML file. For information on how to use this tool, refer to the Deploy and Run the Standalone Model Editor section of the Ways to Invoke the Model Editor topic.

Implement the Persistent Field and Display It

Follow the steps below to add a custom persistent field at an end-user workstation.

1. Invoke the built-in Model Editor using the Tools | Edit Model command at runtime or close the application and start the standalone Model Editor by running the DevExpress.ExpressApp.ModelEditor.v24.2.exe executable file.

   If you use the standalone Model Editor, specify the path to the application configuration file (e.g., MainDemo.Win.exe.config or Web.config) and click Open in the Open Model dialog.

   

2. Navigate to the BO_Model | Contact node in the tree on the left. Right-click the OwnMembers child node and choose Add… | Member.

   

3. Set the Name property of the newly added node to “SkypeID”. Then, set the IsCalculated property to “False”, Type to “System.String”, Size to “32”, and Caption to “Skype ID”.

   

4. If the built-in Model Editor is in use, copy the differences that you have introduced in the administrator’s layer using the Merge Differences command. Otherwise, skip this step and move to the next one.

   

5. Save changes using the Save button or the CTRL+S shortcut and restart the Model Editor.

6. Navigate to the Views | Contact_DetailView node in the tree on the left. Right-click the Items child node and choose Add… | PropertyEditor.

   

7. Set PropertyName and Id to “SkypeID”.

   

8. Focus the Layout node. Right-click the empty space within the form preview displayed on the right and select Customize Layout.

   

9. Drag the Skype ID item from the invoked Customization window to an appropriate position within the form.

   

   You can also add the Skype ID column to the Contact List View using a similar approach (see List View Columns Customization).

10. If the built-in Model Editor is in use, merge the differences as described at the forth step.
11. Save the changes and close the Model Editor.
12. Update your database schema as described in the Apply Changes to the Database section.
13. Restart the application and open the Contact Detail View to see the result demonstrated in the introduction of this topic.

Important

If the application is installed on several PCs and the Administrator’s Model Differences are stored in the Model.xafml file, copy it from the application’s working folder to each PC. Otherwise, the created field will be available only at the workstation where you added it.

Access a custom peristent field in code

To access custom persistent fields in code, use the solution from the following topic: Use Metadata to Customize Business Classes Dynamically

Apply Changes to the Database

Use the DBUpdater tool to add the column mapped to the newly created custom persistent field to the database.

Open the Command Prompt, change the current directory to the applications working directory, and run the following command.

DBUpdater.v24.2.exe MainDemo.Win.exe.config -forceUpdate