Bitrix Site Manager

Terms

Hierarchical diagram of the module entities


Module entities

Term Description
Web form Synonyms (implementations) of this notion are, for example, "survey" and "questionnaire". A web form is an aggregate of:

A web form can be displayed, filled and saved as the result.

Different access permissions can be applied to a web form:

  • 1 - access denied (form and its results are totally inaccessible);
  • 10 - form fill (visitor can only fill in and save the form);
  • 15 - edit own result (visitor can view, filter and sort a list of results; view, edit or delete a result);
  • 20 - view all results (visitor can view all active results);
  • 25 - edit all results and view form settings (visitor can view and edit all results depending on their status; if he can access the administrative section, he can view the form settings);
  • 30 - full access (includes all the above rights plus editing the form settings).
A single user can be granted only one permission.

A web form can be assigned mail templates that are used to create mail events upon filling and saving a form.
Field When filling in the form, a user views only questions and answers. When a user clicks Save, the answer values are saved as the result. Very often there is a need to calculate and store some value on the basis of the user supplied answers. To store these values, developers can use the web form fields.
Question A question is an aggregate of:
  • question text;
  • question text type [text|html];
  • question image;
  • list of answers;
  • settings used to display a question in the list of results;
  • settings used to display fields used to filter results by the question answer values.
Answer A web form question implies a set of HTML fields intended to receive the user answer to a question. Each HTML field is an answer. Hence, an answer (in terms of this module) is an aggregate of the following notions:
  • the ANSWER_TEXT parameter (displayed beside the field as a legend);
  • the ANSWER_VALUE parameter (used internally, for example, to calculate the web form values);
  • type, can have the following values:
    • text - single line text;
    • textarea - multiple line text;
    • radio - radio button;
    • checkbox - check button;
    • dropdown - drop-down list;
    • multiselect - multiple selection list;
    • date - date input field;
    • image - image upload field;
    • file - file upload field;
    • password - password input field.
  • width;
  • height;
  • additional parameters.
Result After a user fills in a form and clicks Save, all the answer values are stored in the database as the result. If a handler requires some fields, the calculated field values can also be stored as the result. Each result must have a status regulating the result access permission. A result is an aggregate of:
  • values of answers to a web form questions;
  • web form field values;
  • status value.
Status The major task of status is to delimit the access permission to the web form result for each user group.

The status access permission can be the following:
  • VIEW - view results in this status;
  • MOVE - move results to this status;
  • EDIT - edit results in this status;
  • DELETE - delete results in this status.
A single user can have one or more permission.

Hence, each result must have a status assigned to it. When creating a result, it must be assigned a default status that has an option "Assign this status to all new documents" set.
Validator Validator is a set of functions that are used to verify that the values of the form fields satisfy additional criteria.

A set of types of questions to which the validator is applicable is assigned to each validator. Validators cannot be used with questions that can have answers of different types.

You can create custom validators for any field types. For more details, see Creating Validators.