Creating a Product Requirement

100 vues Markdown

Creating a Product Requirement is where you build one custom checkout field: its answer type and its module mapping. The same screen opens again when you edit one.

Opening the Screen

From Product Requirements, click Create New Product Requirement. To change an existing requirement, click its name in that list, or open its row menu and choose Edit.

Direct address (new requirement): {admin}/products/requirements/add

Direct address (existing requirement): {admin}/products/requirements/edit?id={requirement}

What Is on the Screen

When creating a new requirement, a banner explains that clients fill it in during checkout. Once saved, you attach it to a product from its own Requirements tab. A language strip sits above the form. Only your main language is required; open another tab to translate Name and Description. Below the strip is a single form; which fields you see below Option Type depends on the type you pick.

Fields

Identity and Grouping

Requirement NameThe name shown to the client, per language.

Requirement DescriptionA short explanation shown with the field, per language.

StatusActive or Inactive. Default: Active. An inactive requirement stays out of new orders.

Related Product GroupThe product group this requirement can be offered under. Required.

Requirement CategoryGroups the requirement for the category filter on the list and for browsing. Required.

IconA font icon or an uploaded image shown next to the requirement. Optional.

Sort OrderWhere the requirement falls in listings, lowest first. Default: 0.

Answer Type

RequiredForces clients to fill in this requirement. Default: off.

Option TypeHow the client answers: Input, Password, Text Area, File, Dropdown, Radio Selection, or Checkbox. Default: Input. File adds Maximum File Size and Allowed Extensions. Dropdown, Radio Selection, and Checkbox add the options table. Radio Selection and Checkbox also add a Listing Template choice: Box List or Horizontal List. Default: Horizontal List.

Maximum File SizeThe largest upload allowed, in MB. Shown only when Option Type is File. Leave blank to use the system-wide default from Settings.

Allowed ExtensionsA comma-separated list of file extensions, such as .jpg, .png, .pdf. Shown only when Option Type is File. Leave blank to use the system-wide default from Settings.

Choices and Module Mapping

OptionsThe fixed choices clients pick from. Shown only when Option Type is Dropdown, Radio Selection, or Checkbox. Each row holds a name and description per language, plus an icon. An API Value maps the choice to your service module. Add Option appends a new row; the last remaining row cannot be removed, only cleared. Drag the handle on the left of a row to change its order.

Configurable OptionsMaps this requirement's answer to one field of an installed module. The value applies automatically when the service is set up. Hidden when Option Type is File. Each module gets its own panel with a None choice and one choice per field it exposes.

Tasks

Create a Requirement

Fill in a Name, then choose Related Product Group and Requirement Category, both required. Pick an Option Type, and click Create.

Collect a File Upload

Set Option Type to File. Set Maximum File Size and Allowed Extensions, or leave either blank to fall back to the system default.

Offer a Fixed Set of Choices

Set Option Type to Dropdown, Radio Selection, or Checkbox. In the options table, name each choice and, if your module needs it, give it an API Value. Radio Selection and Checkbox also let you pick Box List or Horizontal List for how choices are displayed.

Map the Answer to a Module Field

Open a module's panel under Configurable Options. Pick which of its fields should receive this requirement's answer, or leave it on None.

Things to Watch

Blank File Limits Use the System Default

Leaving Maximum File Size or Allowed Extensions blank applies the system-wide default from Settings, not an unlimited size or every file type.

Switching Option Type Keeps Your Values

Changing Option Type only shows or hides the sections that go with it. Values already entered in the options table or the file settings stay saved if you switch back.

Required Privileges

Products > EditOpens the create screen and saves any requirement.

Products > View or Products > EditEither one opens an existing requirement for editing.

Cet article vous a-t-il été utile ?

Merci pour votre retour !

Besoin d'aide supplémentaire ?

Notre équipe d'assistance est disponible 24h/24 pour tout ce que vous ne trouvez pas ci-dessus.

Nous contacter Ouvrir un ticket