Delivery instruction
This dynamic enumeration defines the choices for 'delivery instructions', to add to Shipments or Orders as a Typed attribute resolver.
The attribute can include an optional text field, where additional information regarding the delivery instruction may or must be entered.
The representation of the combination of delivery instruction and text field in Input forms depends on the method of implementation. The delivery instruction can be featured as a single element or as part of a list of delivery instructions (in a Repeatable element) in a form:
Individual delivery instruction with a text field |
List of delivery instructions |
|
|
Besides the standard properties Name (1) and Description and the option to localize via Localization or Company specific localization, the enumeration offers the following parameters, regarding the optional text field and its validation:
The Text required (2) flag specifies if the text field is a required field and must be filled. Otherwise, the default error message for required fields appears below the field ('This field is required') and the form is considered invalid and cannot be saved.
The Text visible (3) flag specifies whether the text field is visible next to the delivery instruction or not. However, any required text fields are always visible.
A Regular expression (4) can be entered against which the contents of the text field is validated, unless the field is empty.
The Error text (5) to show if validation fails can be derived from Localization or Company specific localization via Bundle and Resource or entered directly into Default value (as shown in the example).
►NOTE◄
If delivery instruction attributes are included in Input forms as individual elements, the included text field is configured according to the parameter settings in the dynamic enumeration. In this process, the flags 'Visible', 'Required' and as far as relevant a Validators are initialized. These presets can be altered to individual settings in each form once the element has been inserted. There is no automatic update foreseen for these settings, in case the parameters in the dynamic enumeration are changed afterwards.
If delivery instruction attributes are listed by a Repeatable element in a form, the current parameter set from the dynamic enumeration is always referred to for each element in the list. This could mean that the content of a certain text field will eventually cause a validation conflict because the regular expression in the enumeration has been updated, rendering the form as invalid and the user unable to 'save' without adjusting the text field to match the new requirements.