Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Forms are used for a Questionnaire type input of Part Requirements. A Part Requirement Form is loaded when users upload parts into the Basket.

Structure of Forms

You can think of a Form as a collection of Properties and their arrangement. There are several elements with which you can organize a Form. The hierarchy of elements is as illustrated in the following graphic.

...

Form

The main component for collecting Part Requirements. A Form is a collection of Form Steps.

Form Step

Collection of Form Step Groups. Only for UI structure – no functional impact.

Form

...

Step Group

Grouping of properties Properties. Only for UI structure – no functional impact.

Property

Properties are fields that can be added to Part Requirement Forms. Users can provide input to these fields when uploading parts in the Basket and filling out a Part Requirement Form.

Info

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.

Defining Forms

Forms are defined in the admin panel at

...

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. A Once enabled in the UI, a Form Step’s Name is displayed both during data input and on the part detail view, its Description is only displayed during data input but not on the part detail view 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:

Is collapsible

If this field is checked, this section will initially be collapsed during data input.

Collapsible text

The text in the UI next to the collapse toggle.

...

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 Part Properties.

The following fields are available for the configuration of properties Properties within Form Step Groups.

Property

Select a property Property from the list of defined properties Properties. For creating new properties Properties, see Part 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.

Example

Shows an example input to users in the case of Integer, Float, or String properties.

Option max selectable

Limits the maximum number of choices users can select in the case of multiple-choice properties.

Info

The easiest way to navigate through forms in the admin panel is tostart 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 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.

Info

Removing properties Properties from a form Form does not delete the values of that property Property from a part. If a part has property Property values that are not part of the current form, those values will be displayed under section Other on the part detail viewagain if the Property is added again to the Form.