> You must have an [ABP Team or a higher license](https://abp.io/pricing) to use this module.
This module allows you to create questionnaires to gather information. The forms module can store responses as they come in and you can export the data to a CSV file. You can share your form with others with your form unique link. You can request authentication or allow anonymous reply. It is similar to the Google Form application. Usage area is quite wide, you can create surveys, manage event registrations, collect email addresses for a newsletter, create a quiz, and even receive an order request.
The Forms module allows you to create questionnaires, collect responses and export the results to CSV. A form can accept anonymous responses or require authentication, collect email addresses and allow respondents to edit their responses. You can share a form by using its unique link or sending an invitation email.
See [the module description page](https://abp.io/modules/Volo.Forms) for an overview of the module features.
## How to install
## How to Install
The form module doesn't come pre-installed. You need to install it manually. There are 2 ways of installing it:
The Forms module isn't pre-installed. You can install it in one of the following ways:
* **Via ABP CLI:** Open a command line window in your solution folder (in the folder where the `* .sln` file is located) and type the following command:
* **ABP CLI:** Open a command-line terminal in the solution folder (the folder containing the solution file) and run the following command:
```bash
abp add-module Volo.Forms
```
* **Via ABP Suite:** Open ABP Suite and select your project. Then go to the modules page from the top menu. Find **Forms** card and click add as project (with source-code) or add as package (without source-code).
* **ABP Suite:** Open ABP Suite, select your solution and go to the modules page. Find the **Forms** card and add it as source code or as a package.
## Packages
This module follows the [module development best practices guide](../framework/architecture/best-practices) and consists of several NuGet and NPM packages. See the guide if you want to understand the packages and relations between them.
This module follows the [module development best practices guide](../framework/architecture/best-practices) and consists of several NuGet packages. See the guide if you want to understand the packages and their relationships.
You can visit the [forms module package list page](https://abp.io/packages?moduleName=Volo.Forms) to see list of packages related with this module.
Visit the [Forms module package list](https://abp.io/packages?moduleName=Volo.Forms) to see the packages provided by this module.
## User interface
## User Interface
### Menu items
### Menu Item
SaaS module adds the following item to the root main menu.
The module adds a **Forms** item under the **Administration** menu when the current user has the `Forms.Form` permission. The page is used to create forms, manage their questions and settings, share them and inspect their responses.
* **Forms**: Add a new form, manage your form questions, delete your form.
The `FormsMenus` class contains the menu item names.
### Forms Page
The `FormsMenus` class has the constant variable for the menu item name.
### Pages
#### Forms
Forms page is used to manage the forms. You can view the form contents, send it to others or delete it from the actions menu.
The Forms page lists the forms that you can manage. Its actions menu opens the form designer, opens the invitation dialog or deletes the form. Use the designer to manage questions and settings or preview the form. The **Responses** tab opens the response page, where you can inspect and export responses.
To see the other features of the Forms module, visit [the module description page](https://abp.io/modules/Volo.Forms).
### Question Types
## Data seed
The built-in form designer supports the following question types:
This module adds a sample initial form (see [the data seed system](../framework/infrastructure/data-seeding.md)) to the database when you run the `.DbMigrator` application:
* Short text
* Multiple choice
* Checkboxes
* Dropdown list
* **Form title:** "Test Form"
* **Form description:** "Test Description"
Questions and choices are displayed in their configured order. Multiple-choice and checkbox questions can also include an **Other** option.
## Internals
### Response Settings
### Domain layer
New forms accept responses by default. The other response settings are disabled by default.
#### Aggregates
| Setting | Behavior |
| --- | --- |
| `RequiresLogin` | The packaged MVC page redirects anonymous users to the login page. `GetQuestionsAsync` and response submission also reject anonymous users. The anonymous `GetAsync` endpoint still returns the form details, including its questions, so it is not an authorization boundary for question data. |
| `HasLimitOneResponsePerUser` | Rejects a second response from the same authenticated user. This setting is automatically disabled when `RequiresLogin` is disabled. |
| `IsCollectingEmail` | In the packaged MVC response flow, displays the email field and requires a non-empty value when a response is created or updated. |
| `CanEditResponse` | In the packaged MVC response flow, allows a saved response to be updated. If login is required, that flow only updates the current user's response. A direct update API client must send the target response's actual `FormId`; the application service uses the supplied form ID when it checks these settings and ownership. |
| `IsAcceptingResponses` | Enables or disables response entry on the packaged MVC form page. |
| `IsQuiz` | Stores the quiz-mode flag. The packaged module doesn't calculate a quiz score. |
This module follows the [Entity Best Practices & Conventions](../framework/architecture/best-practices/entities.md) guide.
### Sharing and Routing
- ##### Form
The public form page uses the `/Forms/{formId}/ViewForm` route. When login is required, this route redirects an anonymous visitor to the account login page and uses the form route as the return URL.
- The main aggregate root of the form entities. The form options, title and description is being stored on this entity.
By default, the share dialog builds the form link from the current request. Configure `FormRoutingOptions` in the host module when forms must be shared through a dedicated application:
- ##### QuestionBase
```csharp
Configure<FormRoutingOptions>(options =>
{
options.HostUrl = "https://forms.example.com/";
options.OnlyViewInHostProject = true;
});
```
- It stores questions of the form. This entity is dependent to form entity by `FormId`.
`HostUrl` becomes the base URL for links generated by the share dialog. When `OnlyViewInHostProject` is `true` and `HostUrl` has a value, the form route returns a not-found result if the current display URL does not start with the configured `HostUrl`. `OnlyViewInHostProject` has no effect when `HostUrl` is empty.
- ##### FormResponse
The invitation action sends the configured subject and body through ABP's `IEmailSender`. See the [email sending documentation](../framework/infrastructure/emailing.md) to configure an email provider.
- Each form submit is a new form response record. The form response has answer records.
### CSV Export
#### Repositories
The response page can export a requested response page to a `{form-title}.csv` file. The packaged download action requests responses sorted by ID and doesn't send the page or filter state, so it exports the default maximum of 10 responses. API clients can set `MaxResultCount` to `0` to export all matching responses. The export:
This module follows the [Repository Best Practices & Conventions](../framework/architecture/best-practices/repositories.md) guide.
* uses UTF-8 with a byte-order mark;
* uses the current UI culture and quotes all fields;
* writes `Date` as the first column and then the question titles in their configured order;
* writes one row per response and uses the response's last modification time, or its creation time when it hasn't been modified; and
* contains answer values, but doesn't include the separately collected email value.
Following custom repositories are defined for this module:
Response answers can contain personal or confidential data. Grant form-management and export access only to trusted users, and store downloaded CSV files according to your application's data-handling requirements.
* `IFormRepository`
* `IQuestionRepository`
* `IChoiceRepository`
* `IResponseRepository`
## Feature and Permissions
#### Domain services
The module defines the `Volo.Forms.Enable` feature. It is enabled by default. Disabling it prevents the Forms application services from being used, and all Forms permissions require this feature.
This module follows the [Domain Services Best Practices & Conventions](../framework/architecture/best-practices/domain-services.md) guide.
See the [Feature System documentation](../framework/infrastructure/features.md) for feature configuration and the [Feature Management module](feature-management.md) for managing feature values.
##### QuestionManager
The module defines the following permissions:
`QuestionManager` is used to manage the questions of your form.
| Permission | User interface and application task |
| --- | --- |
| `Forms.Form` | Opens the Forms administration page and its form and question management UI. It also protects form operations such as sharing, response inspection and CSV export. |
| `Forms.Form.Delete` | Deletes a form. |
| `Forms.Response` | Displays the response-management tab and response results in the packaged UI. |
| `Forms.Response.Delete` | Deletes an individual response or all responses of a form. |
### Application layer
## UI Support
#### Application services
The module provides an MVC/Razor Pages UI in the `Volo.Forms.Web` package. It doesn't provide an Angular or Blazor WebAssembly UI package. Since the packaged UI uses Razor Pages, it can also be hosted by a Blazor Server application that supports Razor Pages.
- `FormApplicationService`
- `QuestionAppService`
- `ResponseAppService`
## Internals
### Database providers
### Domain Layer
#### Common
#### Aggregates
##### Table / collection prefix & schema
This module follows the [Entity Best Practices & Conventions](../framework/architecture/best-practices/entities.md) guide.
All tables/collections use the `Frm` prefix by default. Set static properties on the `FormsDbProperties` class if you need to change the table prefix or set a schema name (if supported by your database provider).
* `Form` is the aggregate root that stores the form title, description and response settings.
* `QuestionBase` is the base aggregate root for form questions. A question references its form through `FormId`; the concrete question type stores its choices when applicable.
* `FormResponse` is the aggregate root for a form submission and owns its answer collection.
##### Connection string
#### Repositories
This module uses `Forms` for the connection string name. If you don't define a connection string with this name, it fallbacks to the `Default` connection string.
This module follows the [Repository Best Practices & Conventions](../framework/architecture/best-practices/repositories.md) guide and defines the following custom repositories:
See the [connection strings](../framework/fundamentals/connection-strings.md) documentation for details.
* `IFormRepository`
* `IQuestionRepository`
* `IChoiceRepository`
* `IResponseRepository`
#### Entity Framework Core / MongoDB
#### Domain Services
##### Tables / Collections
This module follows the [Domain Services Best Practices & Conventions](../framework/architecture/best-practices/domain-services.md) guide.
`QuestionManager` creates, updates and deletes questions and their choices, including their stored display order.
- **FrmForms**: Form list.
- **FrmQuestions**: Questions of the forms.
- **FrmAnswers**: Answers of the form response.
- **FrmChoices**: Choices of questions.
- **FrmFormResponses**: A new form response is being created each time user submits the form.
### Application Layer
The module defines the following application services:
* `FormAppService` manages forms, form settings, questions, sharing and response exports.
* `QuestionAppService` updates, reads and deletes individual questions.
* `ResponseAppService` reads, creates, updates and deletes form responses.
See the `FormsPermissions` class members for all permissions defined for this module.
This module uses `Forms` as its connection string name. If a connection string with this name isn't defined, it falls back to the `Default` connection string.
See the [connection strings](../framework/fundamentals/connection-strings.md) documentation for details.
### Angular UI
#### Entity Framework Core
Forms module doesn't support Angular UI for now.
Entity Framework Core tables use the `Frm` prefix by default. Set the static `FormsDbProperties.DbTablePrefix` and `FormsDbProperties.DbSchema` properties to change the table prefix or schema.
### Blazor UI
The module creates the following tables by default:
maliming
2 months ago