Allow catalogNumber format to be determined by CollectionObjectType #5431

melton-jason · 2024-12-03T21:37:39Z

⚠️ Note: This PR affects database migrations. See migration testing instructions.

Aside from implementing #5232 and #5233, there are some other improvements in this PR!

Schema Config

When selecting a Field Format in the Schema Configuration tool, Specify now groups field formatters for the field they selected (Field Formats that explicitly reference the field in fieldName=fieldname) above the rest

Migrations
There were some bugs in other migrations which used the functions defined in specifyweb/specify/update_schema_config.py. These bugs have been fixed in this PR, and a migration has been written to fix these bugs for databases already affected: specify/0017_schemaconfig_fixes.py

UIFormatter picklists for Collection -> catalogNumFormatName and CollectionObjectType -> catalogNumberFormatName

Everywhere in the application*, these fields will now appear as a picklist whose items are the names of CO -> catalogNumber Field Formatters

*on the DataEntry Form, they will only appear as a PickList if uitype="combobox" is used on the form definition

Checklist

Self-review the PR after opening it to make sure the changes look good
and self-explanatory (or properly documented)
Add automated tests
Add relevant issue to release milestone

Testing instructions

Define a Field Format for Collection Object -> catalogNumber which is different than the current Collection -> Catalog Num Format Name
- An example field format called Rocks is provided below:

<format system="false" name="Rocks" class="edu.ku.brc.specify.datamodel.CollectionObject" fieldname="catalogNumber" default="false">
	<autonumber>edu.ku.brc.af.core.db.AutoNumberGeneric</autonumber>
	<field type="constant" size="4" value="ROCK"/>
	<field type="separator" size="1" value="-"/>
	<field type="numeric" size="6" inc="true"/>
</format>

Go to the Data Entry form to create a new Collection Object Type
Ensure the Catalog Number Format Name picklist shows all Catalog Number Field Formats
Save the Collection Object Type with a Catalog Number Format Name that is different than the Collection -> catalogNumFormatName
Make sure collectionObjectType is on the Collection Object form
Go to the Data Entry form to create a new Collection Object
Change the Collection Object Type of the Collection Object to be that which you previously saved
Ensure the Catalog Number of the Collection Object is replaced with the pattern of the new
(If needed) Modify the Catalog Number so that it matches the format of formatter
Save the Collection Object with the new format

See #5232

ONLY affects autonumbering. QB and WB still use Collection -> catalogNumFormatName

… issue-5232

alesan99

Testing instructions

Define a Field Format for Collection Object -> catalogNumber which is different than the current Collection -> Catalog Num Format Name
- An example field format called Rocks is provided below:
Go to the Data Entry form to create a new Collection Object Type
Ensure the Catalog Number Format Name picklist shows all Catalog Number Field Formats
Save the Collection Object Type with a Catalog Number Format Name that is different than the Collection -> catalogNumFormatName
Make sure collectionObjectType is on the Collection Object form
Go to the Data Entry form to create a new Collection Object
Change the Collection Object Type of the Collection Object to be that which you previously saved
Ensure the Catalog Number of the Collection Object is replaced with the pattern of the new
(If needed) Modify the Catalog Number so that it matches the format of formatter
Save the Collection Object with the new format

Functionality wise it seems to be working 👍👍

On the CO form it looks like the form needs an extra update in order to be okay with the new format.
Clicking the save button twice does the trick, or typing in the new catalog number manually.

chrome_9hLjzWdtpV.mp4

The issue also persists if you switch to a different CO of a different type in the same tab.

CarolineDenis · 2024-12-05T16:02:47Z

@alesan99
for

On the CO form it looks like the form needs an extra update in order to be okay with the new format.
Clicking the save button twice does the trick, or typing in the new catalog number manually.

That is good for this pr 👍

bronwyncombs

Define a Field Format for Collection Object -> catalogNumber which is different than the current Collection -> Catalog Num Format Name
- An example field format called Rocks is provided below:
Go to the Data Entry form to create a new Collection Object Type
Ensure the Catalog Number Format Name picklist shows all Catalog Number Field Formats
Save the Collection Object Type with a Catalog Number Format Name that is different than the Collection -> catalogNumFormatName
Make sure collectionObjectType is on the Collection Object form
Go to the Data Entry form to create a new Collection Object
Change the Collection Object Type of the Collection Object to be that which you previously saved
** Ensure the Catalog Number of the Collection Object is replaced with the pattern of the new
(If needed) Modify the Catalog Number so that it matches the format of formatter
Save the Collection Object with the new format

Catalog Number Format Name list appears correctly on COT form and in schema config. COT pick list on CO also displays correctly. Format switch in field functions normally other than needing to click elsewhere on the form to dismiss initial save block.

** I noticed that the CO form header, that displays the catalog number format before a catalog number is saved to the form, does not reflect the format chosen with the COT picklist. If there are two COTs available, this header is consistently opposite of the one on the form.

Screen.Recording.2024-12-05.at.12.52.05.PM.mov

I also saw this on the catalog number field after saving:

combs-a

Testing instructions

Define a Field Format for Collection Object -> catalogNumber which is different than the current Collection -> Catalog Num Format Name
- An example field format called Rocks is provided below:
Go to the Data Entry form to create a new Collection Object Type
Ensure the Catalog Number Format Name picklist shows all Catalog Number Field Formats
Save the Collection Object Type with a Catalog Number Format Name that is different than the Collection -> catalogNumFormatName
Make sure collectionObjectType is on the Collection Object form
Go to the Data Entry form to create a new Collection Object
Change the Collection Object Type of the Collection Object to be that which you previously saved
Ensure the Catalog Number of the Collection Object is replaced with the pattern of the new
(If needed) Modify the Catalog Number so that it matches the format of formatter
Save the Collection Object with the new format

Had a brief strange thing happen where it wasn't switching the format, but seems to have fixed itself on a reload (without clearing cache) so probably okay. Same thing as Alejandro where there's a save blocker incorrectly placed, but clicking anywhere on the form and not just the save blocker clears it.

I didn't run into Bronwyn's second issue, but I did see the same thing with the header. I do remember there being issues with the header update being a bit slow so maybe it's something like that. Will this be addressed in this PR?

Good work Jason! Everything looks good besides the small header thing. 🎉

CarolineDenis · 2024-12-05T20:14:04Z

@emenslin

Will this be addressed in this PR?

No it will not addressed in this pr if present in prod. Could you create an issue for it?

melton-jason · 2024-12-05T20:44:52Z

There may be some other bugs at play here, but at least there is an Issue already about the header being 'slow' to update: #3579.
Although it can probably be renamed, as it's not just contained to Tree forms 😅

The save blocker you briefly see after changing the CollectionObjectType is because everything is happening in the order:

The parser changes for the field when the COT changes
Specify checks if the current value of the field matches that of the new formatter
It (often) doesn't match the formatter, so Specify sets a save blocker on the field
Specify then sets the value of the field to be the pattern of the new formatter
Specify only updates the save blocker when the field gains and then loses focus

We need to conceptually swap steps 3 and 4, but I have not thought of an easy way to accomplish this in the code.
@specify/developers, let me know if you can think of a way to accomplish this! The relevant sections of the code are¹²³⁴

combs-a

~~See above comments for approval reason; header lag is the separate issue that Jason linked 👍 ~~

Misread something along the way and thought that the save blocker bit was about the header lag, so I dismissed my review just in case we're going to address that save blocker issue here. If not, then I'll approve it. 🫡

Misread comments, need to wait on dev comment to fully approve since it is an issue with the PR

melton-jason and others added 18 commits November 19, 2024 15:01

Allow Field Formatters to reference field they format

06c1ed6

Merge remote-tracking branch 'origin/production' into issue-5232

3e713c6

Add catalognumformatname to cot

17275b8

See #5232

Change models + update datamodel

f3fd280

Define picklists for fields expecting catalognumber format name

9897241

Merge remote-tracking branch 'origin/production' into issue-5232

668fbce

Add migration to handle COT catnum format name in schema config

1db84c1

Merge remote-tracking branch 'origin/production' into issue-5232

a5aabf0

Pass app registry to permission initialization

0105c6d

Write a migration to fix schema config bugs from other migrations

a870b74

Update migration for COT -> catalogNuberFormatName

a2349fe

Add isrequired to schema config field fixes

f789f15

Resolve incorrect app for models in permission migration

f453cf9

Merge remote-tracking branch 'origin/production' into issue-5232

56fb288

Correct table label generation in schema config migrations

48b588c

Autonumber CO's based on co -> cot -> catalogNumberFormatName

fb1cec9

ONLY affects autonumbering. QB and WB still use Collection -> catalogNumFormatName

Merge remote-tracking branch 'origin/production' into issue-5232

7478dd3

Merge branch 'production' into issue-5232

6778868

melton-jason changed the title ~~Allow CollectionObjects to be autonumbered by CollectionObjectType~~ Allow catalogNumber format to be determined by CollectionObjectType Dec 3, 2024

Modify default COT form to include catalogNumberFormatName

5186bbd

melton-jason mentioned this pull request Dec 4, 2024

Conditional Field Formatting #5436

Closed

melton-jason and others added 6 commits December 4, 2024 08:59

Merge branch 'production' into issue-5232

bdcbec0

Make migrations_utils a python module

e9a62dc

Merge branch 'issue-5232' of https://github.com/specify/specify7 into…

7ac3ce2

… issue-5232

Resolve faulty import

9225785

Resolve ordering of recently merged migrations

807f439

Resolve failing backend tests

b7bd298

melton-jason requested review from a team December 4, 2024 16:15

Update frontend testing files

be0b5c6

melton-jason added 2 commits December 4, 2024 11:19

Write simple frontend tests for catNum being dictated by COT

946ca8e

Remove unused import

3618ba1

alesan99 requested changes Dec 5, 2024

View reviewed changes

alesan99 requested a review from a team December 5, 2024 15:50

CarolineDenis requested a review from alesan99 December 5, 2024 16:03

CarolineDenis approved these changes Dec 5, 2024

View reviewed changes

alesan99 approved these changes Dec 5, 2024

View reviewed changes

alesan99 requested a review from a team December 5, 2024 16:14

grantfitzsimmons self-requested a review December 5, 2024 16:21

bronwyncombs reviewed Dec 5, 2024

View reviewed changes

combs-a requested changes Dec 5, 2024

View reviewed changes

CarolineDenis requested a review from combs-a December 5, 2024 20:17

combs-a previously approved these changes Dec 5, 2024

View reviewed changes

CarolineDenis requested a review from combs-a December 6, 2024 14:11

maxpatiiuk approved these changes Dec 7, 2024

View reviewed changes

Merge remote-tracking branch 'origin/production' into issue-5232

6a35ba4

CarolineDenis merged commit 18f5c15 into production Dec 10, 2024
12 checks passed

CarolineDenis deleted the issue-5232 branch December 10, 2024 17:03

CarolineDenis mentioned this pull request Dec 12, 2024

When adding a new taxon tree no default information is filled out #5467

Closed

melton-jason mentioned this pull request Dec 18, 2024

Support COT catalog number configurations in the Query Builder #5485

Merged

9 tasks

acwhite211 mentioned this pull request Mar 10, 2025

run_key_migration_functions django command #6308

Merged

2 tasks

melton-jason mentioned this pull request May 1, 2025

Catalog number not being returned for reports #6464

Closed

emenslin mentioned this pull request Sep 29, 2025

feat(FieldFormatters): add visual editor #5075

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Allow catalogNumber format to be determined by CollectionObjectType #5431

Allow catalogNumber format to be determined by CollectionObjectType #5431

Uh oh!

melton-jason commented Dec 3, 2024 •

edited

Loading

Uh oh!

alesan99 left a comment

Uh oh!

CarolineDenis commented Dec 5, 2024

Uh oh!

bronwyncombs left a comment

Uh oh!

combs-a left a comment

Uh oh!

CarolineDenis commented Dec 5, 2024 •

edited

Loading

Uh oh!

melton-jason commented Dec 5, 2024 •

edited

Loading

Uh oh!

combs-a left a comment •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Allow catalogNumber format to be determined by CollectionObjectType #5431

Allow catalogNumber format to be determined by CollectionObjectType #5431

Uh oh!

Conversation

melton-jason commented Dec 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Testing instructions

Uh oh!

alesan99 left a comment

Choose a reason for hiding this comment

Testing instructions

Uh oh!

CarolineDenis commented Dec 5, 2024

Uh oh!

bronwyncombs left a comment

Choose a reason for hiding this comment

Uh oh!

combs-a left a comment

Choose a reason for hiding this comment

Testing instructions

Uh oh!

CarolineDenis commented Dec 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

melton-jason commented Dec 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Footnotes

Uh oh!

combs-a left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

melton-jason commented Dec 3, 2024 •

edited

Loading

CarolineDenis commented Dec 5, 2024 •

edited

Loading

melton-jason commented Dec 5, 2024 •

edited

Loading

combs-a left a comment •

edited

Loading