Skip to main content

Creating a form

To create a form, enter its name in the "Name" field and a unique unique identifier used to retrieve the entity in the "Marker" field. After you click "Add", the form appears in the forms table.

Editing a form​

To edit a form, click "Edit" in the last column of the forms table (the column without a header).

Edit

When you edit a form, these tabs are available:

  • Basic data
  • Form fields
  • Settings
  • Engagement forms: only for forms of the Data submission type
  • Rating configuration: only for forms of the Rating Form type. Here you connect the rating form to modules and set up the rating scale
  • Version History: the form's change history

1. Basic data​

The "Basic data" tab has three input fields:

  • Form title (for CMS): the form name shown in the OneEntry interface
  • Form title (for application): the form name for your website or mobile app
  • unique identifier used to retrieve the entity
    • a unique identifier used to retrieve the form (only Latin letters and the characters "_" and "-" are allowed)

You can change all three on the "Basic data" tab.

2. Form fields​

The "Form fields" tab has three dropdown lists for choosing the form type, the Template (opens in a new tab), and the Attribute set (opens in a new tab).

Here, the attribute set defines the fields of the form itself.

OneEntry has five form types:

  • Order form: for order forms
  • Sign In and Registration: for sign-in and registration forms
  • For integration collections: for integration collection forms
  • Data submission: for all other forms. Only forms of this type have the "Engagement forms" tab
  • Rating Form: for rating forms. The attribute set of such a form must include an attribute with the rating value, and the form gets a "Rating configuration" tab

3. Settings​

The "Settings" tab has the access settings for form data and the messages shown when the form is submitted.

The "Access to form data" card has the "Data is available to administrators only (do not provide by token)" checkbox. When it's selected, submitted form data is available only to administrators and isn't provided by token.

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

  • Message about successful data processing: the message shown when the form is submitted successfully
  • Message about unsuccessful data processing: the message shown when an error occurs during form submission

If the form data is sent to a script, the tab also shows the "URL where the form will be sent" field, which is the address the form is sent to.

4. Engagement forms​

Engagement forms let you add data collection forms to these modules:

  • Admin users
  • Pages
  • Catalog
  • Users

You can attach an unlimited number of forms to each module.

Form settings​

  1. Show form for all entities of the module

    • When enabled, the form is available for all entities of the selected module
    • You don't need to select individual items (pages, users, and so on)
    • Example: a comment form for all products in the catalog
    • The checkbox is available only while no individual entity is selected. If entities are already selected, the checkbox is disabled and shows the hint To activate it, remove all selections instead of its name. Clear the selected entities to enable it
  2. Close form for data collection

    • Enabling this setting blocks adding new entries
    • Users can only view existing data
    • Use it for archived forms or to pause data collection temporarily
  3. View only own data

    • Shows only the current user's entries
      • Other users' data is hidden
  4. Comment only my data

    • Users can comment only on their own entries
  5. Moderate data

    • New entries automatically get the "moderate" status
    • Entries become visible in the system only after a moderator approves them

Selecting entities in an engagement form​

You can choose the entities that use the form in three ways:

  • Selecting individual entities Click the selector to the right of an entity's name to show the form for that entity.
  • Including nested data of a selected entity Turn on the second selector when choosing entities to connect the form automatically to all nested entities. This is useful when more entities will be created later: the engagement form will already be connected to them.

Below the list of entities are counters for data sent through the form: Total Data Sent (all submissions) and Unique Data Sent (unique submissions).

Usage in modules​

You can view engagement form data on two tabs:

  • "Engagement forms for the entire module": data for the whole module (a top-level tab in the module)
  • "Engagement forms": data for a specific entity, such as a page (a tab in the entity's editor)

Select a form in the "Form" selector. To narrow the results, you can set "User ID who sent data" (the ID of the user who sent the data), "Status", a date range (dates in DD-MM-YYYY format), and the "Sent by administrator" checkbox. The "Engagement forms for the entire module" tab also has the "Entity ID for which data is sent" field. The tab of a specific entity doesn't have it, because the entity is already selected there. Then click "Select". "Reset" clears the filters you set.

To show specific attributes, use the "Select attributes to display data" selector.

If data is found, a table with the results appears.

Each table row has a required "Information" column with:

  • Date and time the data was received
  • Sender details
  • Document status
  • Entity ID

To start a "conversation" on any row, click Messages. The modal that opens contains the form fields. Fill them in and set a status to create a comment on that document. Each new comment is attached to its parent element, so you can trace the hierarchy.