Documentation

Terminology

Module entities hierarchy chat

Web form
Such entities as "checklist" and "feedback form". Web from is combined from:

Web form can be displayed on screen, filled in and saved as a result.

Various access permissions can be defined for user groups:

  • 1 - access restricted (web form and its results are completely unavailable);
  • 10 - form can be filled in (visitor can only fill in and save the web form);
  • 15 - edit your result (visitor has the option to see the list of own results. This list can be filtered and sorted; also, the visitor can view, modify and delete own result);
  • 20 - view all results (visitor can view all active results);
  • 25 - edit all results and view the web form settings (visitor can view and edit all results depending on their statuses. The visitor also has open access to the module administrative section - access permission to view the web form settings);
  • 30 - full access (includes are the abovementioned access permissions, as well as access permissions to change web form settings).
Single user can have only one of the above mentioned access permissions (considered as the highest access permission available for this user).

Web form can have several mail templates bound to it. These mail templates can be used to create mail events when filling in and saving the web form.

Field
When filling in the web form, only questions and answers for them are displayed. When a user fills in a web form and clicks the Save button, the answer values will be saved as the result. Sometimes, it is necessary to calculate and save an amount based on the , data, received from user, filling in the web form. To store such calculated values, the web form field is designed.


Question
Combines the following:
  • question text directly;
  • question text type[text|html];
  • question image;
  • list of answers;
  • settings, associated with the question image shown in the list of results;
  • settings, associated with display of fields for results filtering by answer values to this question.

Answer
Each web form question contains set of HTML fields, designed to input answer to this question. Each such HTML field operates as the answer. As a result, answer (within this module terminology) contains a combination of such notions as:
  • parameter ANSWER_TEXT (printed next to HTML fields as the caption to this field);
  • parameter ANSWER_VALUE (used for internal maintenance purposes. For example, when calculating values of the web form fields веб-формы);
  • type, that can show the following values:
    • text - single line text field;
    • textarea - multiline text field;
    • radio - radio button);
    • checkbox - flag for multiple selection (checkbox);
    • dropdown - single selection element of dropdown list
    • multiselect - multi selection list element;
    • date - field to input date;
    • image - field for image upload;
    • file - field to upload custom file;
    • password - field to input password.
  • width;
  • height;
  • additional parameters.
Result
After the user fills in the web form and clicks Save, all the answers values will be saved in the data base as the result. If the developer envisages the use of fields, then pre-calculated values of these fields can be also recorded in the result. Each result must have a status, regulating access permissions to this result. It means that result - is a combination of:
  • answer values to the web form questions;
  • web form field values;
  • status values.
Status
Main goal of the status - into limit access permissions to the result for each user group.

Access permission to status can be of the following types:

  • VIEW - access permission to view results in this status;
  • MOVE - access permission to move results into this status;
  • EDIT - access permission to edit results in this status;
  • DELETE - access permission to delete results in this status.

Single user can have one or more ща the above access permissions.

Consequently, each result must have a status. When creating a new result, its new status will be equal to the status, which settings has the Assign this status to all new documents by default flag checked.

Validator

Validator - it is a set of functions, designed to check compliance to additional conditions of question and answer values of the web form.

List of questions to which this validator is applicable is defined. Questions that contain different types of answers, no validators are applicable.

Own validators with any functionality for any types of fields can be created. See details at manual for creating validators.



© «Bitrix24», 2001-2024