Custom fields: Validation

Custom fields: Validation

Goals

  • summarize validation rules for custom fields

Custom Field Definition Requirements

#

Custom field

Validation Rules

Importance

Notes

Backend stories

#

Custom field

Validation Rules

Importance

Notes

Backend stories

1

Help text

  • Character limit: 100

Must-Have

https://folio-org.atlassian.net/browse/MODCFIELDS-13

2

Label

  • Character limit: 65

  • Required field

Must-Have

3

Radio button

  • Option name limit: 65

  • Number of options limit: 5

Must-Have

https://folio-org.atlassian.net/browse/MODCFIELDS-17

4

Dropdown single select 

  • Option name limit: 100

  • defaults(array type) should have a single value if defined

  • Number of options limit: 200

Must-Have

https://folio-org.atlassian.net/browse/MODCFIELDS-16

5

Dropdown multi-select 

  • Option name limit: 100

  • Number of options limit: 200

Must-Have

Custom Field Values Requirements

#

Custom field type

Validation Rules

Importance

Notes

Backend stories

#

Custom field type

Validation Rules

Importance

Notes

Backend stories

1

Text area

  • Character limit: 1500

Must-Have

https://folio-org.atlassian.net/browse/MODCFIELDS-15

2

Text field

  • Character limit: 150

Must-Have

3

Dropdown

  • Check that selected value(s) is defined in custom field definition options.

Must-Have

 

https://folio-org.atlassian.net/browse/MODCFIELDS-22

4

Radio button

  • Check that selected value(s) is defined in custom field definition options.

Must-Have

 

5

Checkbox 

  • Check that selected value(s) is defined in custom field definition options.

Must-Have

 

6

Checkbox

  • Cannot delete an option set as default

Must-Have

https://folio-org.atlassian.net/browse/MODCFIELDS-19

General Requirements

#

Requirement

Validation Rules

Importance

Notes

#

Requirement

Validation Rules

Importance

Notes

1

Number of CF per application 

  • Allowed number ~ 15

Must-Have

2

Input 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

3

Entity 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

4

Field 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:

Question

Outcome

Question

Outcome

@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 https://folio-org.atlassian.net/browse/UICFIELDS-10

the description was corrected

@Khalilah Gambrell Could you clarify the option (possibly typo)

Allow user to add options (limit = 200)

from the issue https://folio-org.atlassian.net/browse/UICFIELDS-12 

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

Not Doing