Custom fields: Validation

Owned by Natalia Zaitseva
Last updated: Oct 02, 2019
1 min read

Goals

  • summarize validation rules for custom fields

Custom Field Definition Requirements

#Custom fieldValidation RulesImportanceNotesBackend stories
1Help text
  • Character limit: 100
Must-Have

MODCFIELDS-13 - Getting issue details... STATUS

2Label
  • Character limit: 65
  • Required field
Must-Have
3Radio button
  • Option name limit: 65
  • Number of options limit: 5
Must-Have

MODCFIELDS-17 - Getting issue details... STATUS

4Dropdown single select 
  • Option name limit: 100
  • defaults(array type) should have a single value if defined
  • Number of options limit: 200
Must-Have

MODCFIELDS-16 - Getting issue details... STATUS

5Dropdown multi-select 
  • Option name limit: 100
  • Number of options limit: 200
Must-Have

Custom Field Values Requirements

#Custom field typeValidation RulesImportanceNotesBackend stories
1Text area
  • Character limit: 1500
Must-Have

MODCFIELDS-15 - Getting issue details... STATUS

2

Text field

  • Character limit: 150
Must-Have
3Dropdown
  • Check that selected value(s) is defined in custom field definition options.
Must-Have

MODCFIELDS-22 - Getting issue details... STATUS

4Radio button
  • Check that selected value(s) is defined in custom field definition options.
Must-Have
5Checkbox 
  • Check that selected value(s) is defined in custom field definition options.
Must-Have
6Checkbox
  • Cannot delete an option set as default
Must-Have

MODCFIELDS-19 - Getting issue details... STATUS

General Requirements

#RequirementValidation RulesImportanceNotes
1Number of CF per application 
  • Allowed number ~ 15
Must-Have
2Input type Validation 
  • Allowed values are: 
    • radio button(RADIO_BUTTON),
    • single checkbox(SINGLE_CHECKBOX),
    • dropdown (SINGLE_SELECT_DROPDOWN, MULTI_SELECT_DROPDOWN),
    • textbox (TEXTBOX_SHORT),
    • textarea(TEXTBOX_LONG)
  • Once data has been entered/selected to/for the custom field then the user cannot change the input type of a custom field.
Must-Have
3Entity type validation per application
  • for mod-kb-ebsco-java there allowed values are: provider, package, title, resource

  • the entity types should be defined for modules which plan to use mod-custom-fields
4Field name: Field Format/Validation
  • add validation for the following types:
    • email address
    • URL
Not-for-first-version

Questions

Below is a list of questions to be addressed as a result of this requirements document:

QuestionOutcome

Khalilah Gambrell Could you clarify the option 

When an option is deleted then set to "Null" if no default is set OR set to the default

 from the issue  UICFIELDS-10 - Getting issue details... STATUS

the description was corrected
Khalilah Gambrell Could you clarify the option (possibly typo)

Allow user to add options (limit = 200)

from the issue  UICFIELDS-12 - Getting issue details... STATUS  

this value is the real case, so it is not a typo

Not Doing