ABP Commercial version 4.3 RC (Release Candidate) has been published alongside ABP Framework 4.3. RC. I will introduce the new features in this blog post. Here, a list of highlights for this release;
- The microservice starter template is getting more mature. We've also added a service template to add new microservices to the solution.
- New option for the application starter template to have a separate database schema for tenant databases.
- New Forms module to create surveys
- Enable/disable modules per edition/tenant.
- Lepton theme and Account module's source codes are available with the Team License.
Here, some other features already covered in the ABP Framework announcement, but worth mentioning here since they are also implemented for the ABP Commercial;
- Blazor UI server-side support
- Email setting management UI
- Module extensibility system is now available for the Blazor UI too.
This post doesn't cover the features and changes done on the ABP Framework side. Please also see the ABP Framework 4.3. RC blog post.
The Migration Guide
This upgrade requires some manual work documented in the migration guide. Please read the guide carefully. Even if your application doesn't break on upgrade, you should apply the changes to avoid future release problems.
If you upgrade the ABP CLI to 4.3.0-rc.1 and try to create a new solution using the stable (4.2.x) version, it won't compile because of some missing packages. Use ABP CLI to create solutions with
--preview option and downgrade to 4.2.2 to create 4.2.2 solutions. This will be fixed in 4.3.0-rc.2.
What's New With The ABP Commercial 4.3
The Microservice Starter Template
We'd introduced an initial version of the microservice starter template in the previous version. It is getting more mature with this release. We've made a lot of improvements and changes, including;
- New "service" template to add new microservices for the solution. It still requires some manual work to integrate to other services and gateways; however, it makes progress very easy and straightforward.
- Added Tye configuration to develop and test the solution easier.
- Added Prometheus, Grafana integrations for monitoring the solution.
- Automatic database migrations. Every microservice automatically checks and migrates/seeds its database on startup (concurrency issues are resolved for multiple instances). For multi-tenant systems, tenant databases are also upgraded by the queue.
- For multi-tenant systems, databases are being created on the fly for new tenants with separate connection strings.
- Created separate solution (
.sln) file for each microservice, gateway, and application. In this way, you can focus on what you are working on. The main (roof) solution file only includes the executable projects in these solutions.
- All microservices are converted to the standard layered module structure, making it easier to align with ABP application development practices.
After this release, we will be preparing microservice development guides based on this startup solution.
Separate Tenant Schema
ABP's multi-tenancy system allows to the creation of dedicated databases for tenants. However, the application startup solution comes with a single database migration path; hence it has a single database schema. As a result, tenant databases have some host-related tables. These tables are not used for tenants, and they are always empty. However, their existence may disturb us as a clean developer.
With this release, the application startup template provides an option to address this problem. So, if you want, you can have a separate migration path for tenant databases. Of course, this has a cost; You will have two DbContexts for migration purposes, bringing additional complexity to your solution. We've done our best to reduce this complexity and added a README file into the migration assembly. If you prefer this approach, please check that README file.
You can specify the new
--separate-tenant-schema parameter while you are creating a new solution using the ABP CLI:
abp new Acme.BookStore --separate-tenant-schema
If you prefer the ABP Suite to create solutions, you can check the Separated tenant schema option.
Creating Tenant Databases On The Fly
With this release, the separate tenant database feature becomes more mature. When you create a new tenant with specifying a connection string, the new database is automatically created with all the tables and the initial seed data if available. So, tenants can immediately start to use the new database. With this change, tenant connection string textboxes come in the tenant creation modal:
Besides, we've added an "Apply database migrations" action to the tenant management UI to manually trigger the database creation & migration in case you have a problem with automatic migration:
Automatic migration only tries one time. If it fails, it writes the exception log and discards this request. For example, this can happen if the connection string is wrong or the database server is not available. In this case, you can manually retry with this action.
Note that this feature requires to make changes in your solution, if you upgrade from an older version. Because the tenant database creation and migration code are located in the application startup template. See the version 4.3 migration guide for details.
New Module: CMS Kit
CMS Kit module initial version has been released with this version. As stated in the ABP Framework 4.3 announcement post, it should be considered premature for now.
For ABP Commercial application startup template, we are providing an option to include the CMS Kit into the solution while creating new solutions:
It is available only if you select the Public web site option. Once you include CMS Kit, a Cms item is shown on the menu:
Each CMS Kit feature can be individually enabled/disabled, using the global feature system. Once you disable a feature, it becomes completely invisible; even the related tables are not included in your database.
CMS Kit features are separated into two categories: Open source (free) features and pro (commercial) features. For now, only newsletter and contact form features are commercial. By the time, we will add more free and commercial features.
We will create a separate blog post for the CMS Kit module, so I keep it short.
New Module: Forms
Forms is a new module that is being introduced with this version. It looks like the Google Forms application; You dynamically create forms on the UI and send them to people to answer. Then you can get statistics/report and export answers to a CSV file.
Forms module currently supports the following question types;
- Free text
- Selecting a single option from a dropdown list or a radio button list
- Multiple choice: Selecting multiple options from a checkbox list
Screenshot: editing form and questions - view responses
Screenshot: answering to the form
Team License Source Code for Modules
Team License users can't access the source code of modules and themes as a license restriction. You have to buy a Business or Enterprise license to download any module/theme's full source code. However, we got a lot of feedback from the Team License owners on the source code of the account module and the lepton theme. We see that customization of these two modules is highly necessary for most of our customers.
With this version, we decided to allow Team License holders to download the source code of the Account Module and the Lepton Theme to freely customize them based on their requirements.
You can Replace these modules with their source code using the ABP Suite:
Remember that; when you include the source code in your solution, it is your responsibility to upgrade them when we release new versions (while you don't have to upgrade them).
Lepton Theme Public Website Layout
We'd added a public website application in the application starter template in the previous versions. It was using the public website layout of the Lepton Theme. We realized that the layout of this application is customized or completely changed in most of the solutions. So, with this version, the layout is included inside the application in the downloaded solution. You can freely change it. Before, you had to download it separately and include it in your solution manually.
With this release, all modules can be enabled/disabled per edition/tenant. You can allow/disallow modules when you click Features action for an edition or tenant:
- ABP Suite now supports defining required navigation properties on code generation.
- Blazor server-side (with tiered option) is added for the application and microservice starter templates.
- An "Email" tab has been added to the Settings page to configure the email settings.
Please check out the ABP Commercial 4.3 RC to help us to release a more stable version. The planned release date for the 4.3.0 final version is April 21, 2021.
rashed 1 years ago
@hikalkan When is the release date for 4.4 ?
[email protected] 1 years ago
Hi, great to see that an email setting UI is added. I followed the migration guide, but the new tab is not visible. Is this also available for Angular, or did I miss something? Thanks a lot!
trendline 1 years ago
Check the permission if was checked?
murat.yuceer 1 years ago
Hi, Thanks for work I saw new approach in microservice template you migrate and seed data on OnPostApplicationInitialization event. Also i saw DbMigrator. Actually we dont need DbMigrator if we use OnPostApplicationInitialization right?
hikalkan 1 years ago
Yes, DbMigration is completely unnecessary. We keep it by thinking some companies may not want to on-the-fly migration system, because of some "enterprise" rules :)
trendline 1 years ago
how to deal with one application with mutil module databases for a tenant to create separate database？
hikalkan 1 years ago
We suggest to use a single database for a tenant, even if you have multiple databases to separate modules. That has less complexity. Host database is splitted for modules and also shared by tenants (those have not separate databases). However, your scenario is possible in the framework level, however not implemented in the UI and some other parts yet. With the version 4.4, we are planning to add UI support for that for a full support. If you have urgent, you can customize/override the SaaS module to do it yourself.
trendline 1 years ago
Thanks for your suggestion, look forward to the version 4.4