Creating and Editing Forms
- Dominik Lindenberger
Forms are used to collect Part Requirements in a structured, questionnaire-style format. A Part Requirement Form is triggered when users upload parts into the Basket.
Overview
Each Form is a structured collection of Properties used to capture manufacturing requirements from users. Although the user interface currently displays a flat layout, the backend architecture includes a more detailed hierarchy that will be supported in future UI updates.
Form Structure
A Form is composed of several nested elements. Here’s an overview of the current hierarchy and which elements are displayed:
The structuring element Form Step and Form Step Group are not yet displayed in the UI, although they have to be configured in the admin panel already. At the moment the UI “flattens” the structure and displays all Properties directly within a Form.
Support for Form Steps and Form Step Groups will be added to the UI at a later stage.
Elements Explained
Element | Description |
|---|---|
Form | The top-level structure that holds all part requirement fields. |
Form Step | A logical grouping of Form Step Groups. Used only for structuring; not currently visible in the UI. |
Form Step Group | A container for grouping related Properties. Also not visible in the UI (yet). |
Property | The actual data fields users fill in. Created separately and then linked to Forms. |
Defining Forms in the Admin Panel
Navigate to:
Administration Panel > B3_FORMS2 > Forms
The following fields are available for configuration
Name
The name of the form. The form name is also shown while filling out Part Requirements in the Basket.
Description
Additional description, also shown while filling out Part Requirements in the Basket.
Form Steps
Each form needs to have at least one Form Step. You can add them directly during the Form configuration. Once enabled in the UI, a Form Step’s Name and Description will be displayed on the Part Requirement Form in the Basket. Through Sort priority you can order Form Steps relative to each other.
To configure the content of a Form Step the easiest is to navigate down via Change
The configuration of Form Steps is basically equivalent to the configuration on the Form level. Form Steps have two additional fields:
Form Step Group
Within Form Step Groups we can add any number of properties. Properties are only linked and must be created in the Properties section of the admin panel. See Properties.
The following fields are available for the configuration of Properties within Form Step Groups.
Property
Select a Property from the list of defined Properties. For creating new Properties, see Properties.
Sort priority
Defines the relative order of items in the UI. E.g. an item with Sort priority = 100 is displayed before an item with sort priority = 110.
Display
Decide how the property should be displayed during data input. Only choices corresponding to the respective property type are valid.
Required
Makes user input for this property mandatory. Users cannot complete or save a form if the input is missing.
Show on pdf
Configure whether this property should be shown on order notes and quote PDFs.
The easiest way to navigate through forms in the admin panel is to start from the top and go down vertically using the Change links of each item. To go back up use your browser Back button (several times).
Removing items from a Form
To remove an element from a Form, select the Delete checkbox next to the item you want to remove and confirm the deletion through saving, e.g. Save and continue editing.
Alternatively, navigate to the respective item and use the Delete button.
Removing Properties from a Form does not delete the values of that Property from a part. If a part has Property values that are not part of the current form, those values will be displayed again if the Property is added again to the Form.