Skip to main content

Creating a Form

To create a form, you need to enter the name of the form in the "Name" field and a unique unique identifier to access the entity in the "Marker" field. After clicking the "Add" button, the form will appear in the forms table.

Editing a Form​

To edit a form, you need to click the "Edit" button in the "Actions" column of the forms table.

Edit

For forms, the following tabs are available during editing:

  • Basic data
  • Form fields
  • Settings
  • Engagement forms — only for Data submission type forms
  • Rating configuration — only for Rating Form type forms: here, the rating form is connected to modules and the rating scale is configured
  • Version History — the history of changes to the form

1. Basic Data​

The "Basic data" tab contains three input fields:

  • Form title (for CMS) - the name of the form that will be displayed in the Platform OneEntry interface
  • Form title (for application) - the name of the form for your website or mobile application
  • unique identifier to access the entity
    • a unique identifier to access the form (only Latin letters and the symbols "_" and "-" are allowed for input)

These three form parameters can be changed while on the "Basic data" tab.

2. Form Fields​

The "Form fields" tab contains three dropdown lists for selecting the type of form, Template (opens in a new tab), and Attribute Set (opens in a new tab).

The attribute set in this case consists of the fields of the form itself.

In Platform OneEntry, there are five types of forms:

  • Order form - a type for order forms
  • Sign In and Registration - a type intended for authorization and registration forms
  • For integration collections - a type for integration collection forms
  • Data submission - a type intended for all other forms; only forms of this type have the "Engagement forms" tab
  • Rating Form - a type for rating forms; the attribute set of such a form must include an attribute with a rating value, and the form itself has a "Rating configuration" tab

3. Settings​

The "Settings" tab contains settings for access to form data and messages that will be displayed upon form submission.

The "Access to form data" card contains a checkbox "Data is available to administrators only (do not provide by token)". When the checkbox is enabled, the submitted form data is only available to administrators and is not provided via token.

The "Fields to send to the script" card contains two input fields:

  • Message about successful data processing - a text input field for the message in case of successful form submission
  • Message about unsuccessful data processing - a text input field for the message in case of an error during form submission

If the form data is sent to a script, an additional field "URL where the form will be sent" will be displayed on the tab - the address to which the form will be sent.

4. Engagement Forms​

The Engagement Forms functionality allows you to integrate data collection forms into various system modules:

  • Administrators (Admin users)
  • Pages (Pages)
  • Catalog (Catalog)
  • Users (Users)

An unlimited number of forms can be attached to each module, providing flexibility in information collection.

Form Settings​

  1. Show form for all entities of the module

    • When activated, the form becomes available for all entities of the selected module
    • Does not require manual selection of individual items (pages, users, etc.)
    • Example: a comment form for all products in the catalog

  2. Close form for data collection

    • Enabling this setting prohibits adding new entries
    • Users can only view existing data
    • Used for archival forms or temporarily closing data collection

  3. View only own data

    • Limits the display of data to only the current user's records
      • Data from other users becomes invisible

  4. Comment only on own data

    • Users can comment exclusively on their own records

  5. Moderate data

    • New entries automatically receive the status of "moderate"
    • Visibility in the system only after approval by a moderator

Selecting Entities in the Engagement Form​

The selection of entities for using the form is presented in three options:

  • Point selection of entities By clicking on the selector to the right of the entity name, the form will be displayed for that specific entity.
  • Indicating nested data for the selected entity Choosing the second selector when selecting entities will automatically connect the form to all nested entities. This is useful in cases where additional entities will be created, and the engagement form will already be connected to it.

Using in Modules​

To view the form in a module, you need to go to the desired module and open the "Engagement forms" tab. After that, select the desired form in the "Form" selector. If necessary, you can specify additional details: "Entity ID for which data is sent" (entity identifier), "User ID who sent data" (identifier of the user who sent the data), "Status", time interval (dates in DD-MM-YYYY format), and the checkbox "Sent by administrator". After filling in the necessary data, click the "Select" button. The "Reset" button clears the specified details.

If you need to display certain attributes, you can use the "Select attributes to display data" selector.

When data is found, a table with filled cells will appear.

Each table element contains a mandatory column "Information," indicating:

  • Date and time of data receipt
  • Sender's data
  • Document status
  • Entity identifier

For each table element, you can start a "conversation" by clicking the button Messages. In the opened modal window, fields of the form will be available for filling. After filling in and specifying the status, a comment will be created for the specified document. Each new comment will be attached to the parent element, allowing you to trace the hierarchy.