Browse Source

Merge pull request #24662 from abpframework/EngincanV/suite-entity-extension-document

Add a new section to Suite document to explain extending with custom module entities
pull/24670/head
Muhammed Ali ÖZKAYA 3 weeks ago
committed by GitHub
parent
commit
aea2e5d3c7
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 23
      docs/en/suite/generating-crud-page.md

23
docs/en/suite/generating-crud-page.md

@ -270,6 +270,29 @@ In the example above, the `IdentityUser` entity is selected as the navigation pr
> **Note:** Ensure that your solution is built properly before establishing relationship between your own entity and a module entity because ABP Suite scans assemblies and finds which ABP modules you are using and lists their entities in the navigation property model if you have checked the **Include entities from ABP modules** checkbox. > **Note:** Ensure that your solution is built properly before establishing relationship between your own entity and a module entity because ABP Suite scans assemblies and finds which ABP modules you are using and lists their entities in the navigation property model if you have checked the **Include entities from ABP modules** checkbox.
#### Extending with Custom Module Entities
If you want to extend ABP Suite's system to list entities from your own custom modules (not just ABP's built-in modules), you can configure the `module-entity-extension.json` file. This file is located in the `.suite` folder at the root of your solution (`/.suite/module-entity-extension.json`).
Here is the default sample file content:
```json
{
"Modules": [
{
"DomainProjectDllFileName": "MySampleModule.MyProject.Domain.dll"
}
]
}
```
By defining the `DomainProjectDllFileName` property, ABP Suite will scan the specified module's **.dll** and list its entities in the navigation property model. This allows you to create navigation properties that reference entities from your custom modules.
> **Important:** When extending with custom module entities, ensure that:
> - Your current solution properly depends on the related module.
> - All module references are correctly configured.
> - The solution is built successfully before attempting to establish relationships.
#### Adding An Existing Entity as a Navigation Property #### Adding An Existing Entity as a Navigation Property
Alternatively, you can add `IdentityUser` entity (or any other entity) as a navigation property to an entity by manually entering the required information. See the screenshot below: Alternatively, you can add `IdentityUser` entity (or any other entity) as a navigation property to an entity by manually entering the required information. See the screenshot below:

Loading…
Cancel
Save