COG business rules: `isPrimary` and `isSubstrate` #5275

sharadsw · 2024-09-13T19:03:06Z

Business Logic:

In each COG, isPrimary and isSubstrate can only be set to True for a single CO.
COJOs that link to a child COG instead of a child CO cannot check either the isPrimary or isSubstrate fields.
- (Will need to be done with conditional forms)
When checked, IsPrimary is set to True for one CO in a COG. All other COJO records will have IsPrimary set to False.
When no CO has IsPrimary set to True, it is NULL for all COJO records in the COG.
- Default behavior?
The first COJO CO will automatically have isPrimary set to True when the COG type is 'consolidated'

NOTE:
This PR adds the possibility to do an empty value check in conditional rendering using the keyword _EMPTY. This was already possible if we use an incomplete condition like <rows condition="childcog="> but it's an unintentional feature and may not seem very clear to users. Empty value checks can now be done with a condition like this:

<rows condition="childcog=_EMPTY">
...
</rows>

The condition will hold true whenever a relation is null or a field has a blank value.

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

Use following viewdefs

Import these viewdefs: https://github.com/user-attachments/files/17590977/better.common.views.xml.zip
Update the COG and COJO viewdef to the ones below

COG viewdef

<viewdef name="CollectionObjectGroup" class="edu.ku.brc.specify.datamodel.CollectionObjectGroup" type="form" gettable="edu.ku.brc.af.ui.forms.DataGetterForObj" settable="edu.ku.brc.af.ui.forms.DataSetterForObj">
	<desc>Collection Object Group Form</desc>
	<enableRules/>
	<columnDef>100px,2px,178px,5px,108px,2px,130px,5px,100px,2px,195px,0px,15px,p:g</columnDef>
	<columnDef os="lnx">115px,2px,196px,2px,113px,2px,150px,2px,115px,5px,215px,0px,15px,p:g</columnDef>
	<columnDef os="mac">130px,2px,216px,2px,133px,2px,170px,2px,135px,5px,235px,0px,15px,p:g</columnDef>
	<columnDef os="exp">p,2px,p:g,2px,p:g(2),5px,p:g,2px,p:g(2),5px:g,p,2px,p:g,0px,p,p:g</columnDef>
	<rowDef auto="true" cell="p" sep="2px"/>
	<rows>
		<row>
			<cell type="label" labelfor="name"/>
			<cell type="field" id="name" name="name" uitype="text"/>
			<cell type="label" label="Type"/>
			<cell type="field" id="cogType" name="cogType" uitype="combobox"/>
			<cell type="label" label="Parent COG"/>
			<cell type="field" id="parentCojo" name="parentCojo" uitype="querycbx" readonly="true"/>
		</row>
		<row>
			<cell type="subview" id="cojo" name="children" uitype="subview" isrequired="false" defaulttype="table" colspan="13"/>
		</row>
	</rows>
</viewdef>

COJO viewdef

<viewdef name="CollectionObjectGroupJoin" class="edu.ku.brc.specify.datamodel.CollectionObjectGroupJoin" type="form" gettable="edu.ku.brc.af.ui.forms.DataGetterForObj" settable="edu.ku.brc.af.ui.forms.DataSetterForObj">
	<desc>The Collection Object Group Join Form</desc>
	<enableRules/>
	<columnDef>50px,2px,30px,5px,50px,2px,30px,5px,50px,2px,100px,0px,50px,2px,100px,p:g</columnDef>
	<rowDef auto="true" cell="p" sep="2px"/>
	<rows>
		<row>
			<!-- 			<cell type="label" labelfor="1"/>
			<cell type="field" id="1" name="isPrimary" uitype="checkbox" default="false"/>
			<cell type="label" labelfor="2"/>
			<cell type="field" id="2" name="isSubstrate" uitype="checkbox" default="false"/> -->
			<!--<cell type="label" labelfor="3"/>
      <cell type="field" id="3" name="precedence" uitype="text"/>-->
			<cell type="label" labelfor="5"/>
			<cell type="field" id="5" name="childCog" uitype="querycbx" readonly="true" colspan="3"/>
			<cell type="label" labelfor="6"/>
			<cell type="field" id="6" name="childCo" uitype="querycbx" readonly="true" colspan="3"/>
		</row>
		<row>
			<cell type="separator" label="Child Attributes" colspan="20"/>
		</row>
		<row>
			<cell type="panel" colspan="20">
				<rows>
					<row/>
					<!-- Show nothing if no Collection Object Group (COG) or Collection Object (CO) child exists for this COJO record -->
				</rows>
				<rows condition="childCog=_EMPTY">
					<row>
						<cell type="label" labelfor="2" label="isPrimary"/>
						<cell type="field" id="2" name="isPrimary" uitype="checkbox"/>
						<cell type="label" labelfor="3" label="isSubstrate"/>
						<cell type="field" id="3" name="isSubstrate" uitype="checkbox"/>
					</row>
				</rows>
			</cell>
		</row>
		<row>
			<cell type="panel" colspan="15">
				<rows>
					<row/>
					<!-- Show nothing if no Collection Object Group (COG) or Collection Object (CO) child exists for this COJO record -->
				</rows>
				<rows condition="childCo=_EMPTY">
					<row>
						<cell type="label" labelfor="2" label="isPrimary"/>
						<cell type="field" id="2" name="isPrimary" uitype="checkbox" readonly="true"/>
						<cell type="label" labelfor="3" label="isSubstrate"/>
						<cell type="field" id="3" name="isSubstrate" uitype="checkbox" readonly="true"/>
					</row>
				</rows>
			</cell>
		</row>
		<!-- 		<row>
			<cell type="label" labelfor="7"/>
			<cell type="field" id="7" name="version" uitype="text"/>
			<cell type="label" labelfor="8"/>
			<cell type="field" id="8" name="timestampCreated" uitype="text"/>
			<cell type="label" labelfor="9"/>
			<cell type="field" id="9" name="timestampModified" uitype="text"/>
		</row>
		<row>
			<cell type="label" labelfor="10"/>
			<cell type="field" id="10" name="text1" uitype="text"/>
			<cell type="label" labelfor="11"/>
			<cell type="field" id="11" name="text2" uitype="text"/>
			<cell type="label" labelfor="12"/>
			<cell type="field" id="12" name="text3" uitype="text"/>
		</row>
		<row>
			<cell type="label" labelfor="13"/>
			<cell type="field" id="13" name="integer1" uitype="text"/>
			<cell type="label" labelfor="14"/>
			<cell type="field" id="14" name="integer2" uitype="text"/>
			<cell type="label" labelfor="15"/>
			<cell type="field" id="15" name="integer3" uitype="text"/>
		</row>
		<row>
			<cell type="label" labelfor="16"/>
			<cell type="field" id="16" name="Yesno1" uitype="checkbox"/>
			<cell type="label" labelfor="17"/>
			<cell type="field" id="17" name="Yesno2" uitype="checkbox"/>
			<cell type="label" labelfor="18"/>
			<cell type="field" id="18" name="Yesno3" uitype="checkbox"/>
		</row> -->
	</rows>
</viewdef>

Go to Data Entry > CollectionObjectGroup (navigate through the URL if hidden)
Add children to the COG
Verify only 1 CO child can be set as isPrimary or isSubstrate
Verify isPrimary and isSubstrate are read-only for children that link to COGs
Verify isPrimary for the first CO child gets checked when cogtype changes to a Consolidated one (you may have to create COGtypes in your db)

Fixes #114

Fixes #3127

Triggered by dfaa5d0 on branch refs/heads/issue-114

Triggered by 1359149 on branch refs/heads/issue-114

This is not likely the behavior we want, so this is something to be discussed. See related #3127

This reverts commit 22de47c.

…246" This reverts commit 9c00cca, reversing changes made to aac3197.

emenslin

Go to Data Entry > CollectionObjectGroup (navigate through the URL if hidden)
Add children to the COG
Verify only 1 CO child can be set as isPrimary or isSubstrate
Verify isPrimary and isSubstrate are read-only for children that link to COGs
Verify isPrimary for the first CO child gets checked when cogtype changes to a Consolidated one (you may have to create COGtypes in your db)

Looks good, I did notice some weird behavior with the isprimary behavior when the cogtype is consolidated. When you change the cogtype to consolidated it does check the first isPrimary box, but if you save and then try to select another isPrimary box it appears like it has selected more than one but when you save again it only selects one. Not sure if this is the expected behavior but it is a little confusing when this happens

chrome_PiiPh5lGKa.mp4

sharadsw · 2024-11-01T19:10:02Z

@emenslin Looks like all COG children in that video link to COGs (which means primary/substrate needs to be readonly). Can you try again with this COJO viewdef? With this viewdef, primary and substrate will only be visible when you expand the subview but it should handle the mentioned issues

<viewdef name="CollectionObjectGroupJoin" class="edu.ku.brc.specify.datamodel.CollectionObjectGroupJoin" type="form" gettable="edu.ku.brc.af.ui.forms.DataGetterForObj" settable="edu.ku.brc.af.ui.forms.DataSetterForObj">
	<desc>The Collection Object Group Join Form</desc>
	<enableRules/>
	<columnDef>50px,2px,30px,5px,50px,2px,30px,5px,50px,2px,100px,0px,50px,2px,100px,p:g</columnDef>
	<rowDef auto="true" cell="p" sep="2px"/>
	<rows>
		<row>
			<!-- 			<cell type="label" labelfor="1"/>
			<cell type="field" id="1" name="isPrimary" uitype="checkbox" default="false"/>
			<cell type="label" labelfor="2"/>
			<cell type="field" id="2" name="isSubstrate" uitype="checkbox" default="false"/> -->
			<!--<cell type="label" labelfor="3"/>
      <cell type="field" id="3" name="precedence" uitype="text"/>-->
			<cell type="label" labelfor="5"/>
			<cell type="field" id="5" name="childCog" uitype="querycbx" readonly="true" colspan="3"/>
			<cell type="label" labelfor="6"/>
			<cell type="field" id="6" name="childCo" uitype="querycbx" readonly="true" colspan="3"/>
		</row>
		<row>
			<cell type="separator" label="Child Attributes" colspan="20"/>
		</row>
		<row>
			<cell type="panel" colspan="20">
				<rows>
					<row/>
					<!-- Show nothing if no Collection Object Group (COG) or Collection Object (CO) child exists for this COJO record -->
				</rows>
				<rows condition="childCog=_EMPTY">
					<row>
						<cell type="label" labelfor="2" label="isPrimary"/>
						<cell type="field" id="2" name="isPrimary" uitype="checkbox"/>
						<cell type="label" labelfor="3" label="isSubstrate"/>
						<cell type="field" id="3" name="isSubstrate" uitype="checkbox"/>
					</row>
				</rows>
			</cell>
		</row>
		<row>
			<cell type="panel" colspan="15">
				<rows>
					<row/>
					<!-- Show nothing if no Collection Object Group (COG) or Collection Object (CO) child exists for this COJO record -->
				</rows>
				<rows condition="childCo=_EMPTY">
					<row>
						<cell type="label" labelfor="2" label="isPrimary"/>
						<cell type="field" id="2" name="isPrimary" uitype="checkbox" readonly="true"/>
						<cell type="label" labelfor="3" label="isSubstrate"/>
						<cell type="field" id="3" name="isSubstrate" uitype="checkbox" readonly="true"/>
					</row>
				</rows>
			</cell>
		</row>
		<!-- 		<row>
			<cell type="label" labelfor="7"/>
			<cell type="field" id="7" name="version" uitype="text"/>
			<cell type="label" labelfor="8"/>
			<cell type="field" id="8" name="timestampCreated" uitype="text"/>
			<cell type="label" labelfor="9"/>
			<cell type="field" id="9" name="timestampModified" uitype="text"/>
		</row>
		<row>
			<cell type="label" labelfor="10"/>
			<cell type="field" id="10" name="text1" uitype="text"/>
			<cell type="label" labelfor="11"/>
			<cell type="field" id="11" name="text2" uitype="text"/>
			<cell type="label" labelfor="12"/>
			<cell type="field" id="12" name="text3" uitype="text"/>
		</row>
		<row>
			<cell type="label" labelfor="13"/>
			<cell type="field" id="13" name="integer1" uitype="text"/>
			<cell type="label" labelfor="14"/>
			<cell type="field" id="14" name="integer2" uitype="text"/>
			<cell type="label" labelfor="15"/>
			<cell type="field" id="15" name="integer3" uitype="text"/>
		</row>
		<row>
			<cell type="label" labelfor="16"/>
			<cell type="field" id="16" name="Yesno1" uitype="checkbox"/>
			<cell type="label" labelfor="17"/>
			<cell type="field" id="17" name="Yesno2" uitype="checkbox"/>
			<cell type="label" labelfor="18"/>
			<cell type="field" id="18" name="Yesno3" uitype="checkbox"/>
		</row> -->
	</rows>
</viewdef>

emenslin

Go to Data Entry > CollectionObjectGroup (navigate through the URL if hidden)
Add children to the COG
Verify only 1 CO child can be set as isPrimary or isSubstrate
Verify isPrimary and isSubstrate are read-only for children that link to COGs
Verify isPrimary for the first CO child gets checked when cogtype changes to a Consolidated one (you may have to create COGtypes in your db)

When cogtype changes to a consolidated one and all the children are COGs (all childCo are empty), isPrimary still gets checked for the first one. I believe this is the incorrect behavior but it is a little confusing so please correct me if I am wrong.

chrome_Px2WisygVH.mp4

sharadsw · 2024-11-01T20:17:37Z

Thanks! Pushed a fix for that bug

pashiav

Go to Data Entry > CollectionObjectGroup (navigate through the URL if hidden)
Add children to the COG
Verify only 1 CO child can be set as isPrimary or isSubstrate
Verify isPrimary and isSubstrate are read-only for children that link to COGs
Verify isPrimary for the first CO child gets checked when cogtype changes to a Consolidated one (you may have to create COGtypes in your db)

From #5275 (review):

When cogtype changes to a consolidated one and all the children are COGs (all childCo are empty), isPrimary still gets checked for the first one. I believe this is the incorrect behavior but it is a little confusing so please correct me if I am wrong.
—Fixed!

Everything looks good!

emenslin

Go to Data Entry > CollectionObjectGroup (navigate through the URL if hidden)
Add children to the COG
Verify only 1 CO child can be set as isPrimary or isSubstrate
Verify isPrimary and isSubstrate are read-only for children that link to COGs
Verify isPrimary for the first CO child gets checked when cogtype changes to a Consolidated one (you may have to create COGtypes in your db)

Looks good, the previous issue is now fixed!

maxpatiiuk and others added 30 commits March 8, 2023 15:50

Allow independent subviews

8b8ae16

Fixes #114

Turn independent sub views into buttons

a9a0aff

Fixes #3127

Merge branch 'production' into issue-114

2b90246

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

a5101a8

Merge branch 'production' into issue-114

0d9168c

Merge branch 'production' into issue-114

9d24da9

Merge branch 'production' into issue-114

dfaa5d0

Lint code with ESLint and Prettier

8db2925

Triggered by dfaa5d0 on branch refs/heads/issue-114

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

1359149

Lint code with ESLint and Prettier

a373d00

Triggered by 1359149 on branch refs/heads/issue-114

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

a512205

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

f168bb4

Merge branch 'production' into issue-114

90cc9d4

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

009fad3

Merge remote-tracking branch 'origin/production' into issue-114-backend

7b0c29b

Allow modifying remote side of indedpenent resources via API

74502de

Add tests for inline independent resources

a55de9e

Write test for reassigning to-one relationship from to-many side

d970ca1

Merge remote-tracking branch 'origin/production' into issue-114-backend

8d0ad64

Modify frontend orm to handle indpendent to-many relationships

efd44b9

Merge remote-tracking branch 'origin/production' into issue-114-backend

63aff69

Merge remote-tracking branch 'origin/production' into issue-114-backend

495c50b

Add Independent Collection to Collection API

f2a4397

Recompute resource delete blockers on save

e63365c

Don't default independent subviews as buttons

5b41b02

Propagate save blockers on independent resources to related record

5f196c5

This is not likely the behavior we want, so this is something to be discussed. See related #3127

Merge remote-tracking branch 'origin/production' into issue-114-backend

0ea5089

Add CO -> isMemberOfCOG virtual field to frontend

59d1ff8

Improve date backendfilters on frontend

4abacf0

Allow creating new records in Independent ToMany Collections

dc570f6

sharadsw added 4 commits October 30, 2024 14:39

Merge remote-tracking branch 'origin/issue-5185' into issue-5246

9c00cca

fix snapshots

22de47c

Revert "fix snapshots"

eb0c856

This reverts commit 22de47c.

Revert "Merge remote-tracking branch 'origin/issue-5185' into issue-5…

b4bc8ec

…246" This reverts commit 9c00cca, reversing changes made to aac3197.

sharadsw changed the base branch from issue-5185 to production November 1, 2024 14:19

CarolineDenis requested a review from a team November 1, 2024 14:45

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

c569c7c

sharadsw marked this pull request as ready for review November 1, 2024 15:50

sharadsw and others added 4 commits November 1, 2024 13:46

Merge branch 'production' into issue-5246

6c7daed

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

8584e25

Update datamodel

cf2c79f

Merge remote-tracking branch 'origin/issue-5246' into issue-5246

883a84e

emenslin requested changes Nov 1, 2024

View reviewed changes

sharadsw requested a review from emenslin November 1, 2024 19:10

emenslin requested changes Nov 1, 2024

View reviewed changes

Fix business rule when childCo is undefined

f048361

sharadsw requested a review from emenslin November 1, 2024 20:17

pashiav requested a review from a team November 4, 2024 14:12

pashiav approved these changes Nov 4, 2024

View reviewed changes

pashiav requested a review from a team November 4, 2024 15:43

CarolineDenis requested a review from acwhite211 November 5, 2024 14:41

emenslin approved these changes Nov 5, 2024

View reviewed changes

Merge branch 'production' into issue-5246

4f007f4

acwhite211 approved these changes Nov 5, 2024

View reviewed changes

sharadsw merged commit e3cd0bc into production Nov 5, 2024
12 checks passed

sharadsw deleted the issue-5246 branch November 5, 2024 16:05

alesan99 mentioned this pull request Nov 5, 2024

COG & CO form's Add and Clone buttons cause crash upon save #5373

Closed

CarolineDenis mentioned this pull request Nov 5, 2024

Fix cojo relationship on CO and COG #5374

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

COG business rules: `isPrimary` and `isSubstrate` #5275

COG business rules: `isPrimary` and `isSubstrate` #5275

sharadsw commented Sep 13, 2024 •

edited

Loading

emenslin left a comment

sharadsw commented Nov 1, 2024

emenslin left a comment

sharadsw commented Nov 1, 2024

pashiav left a comment

emenslin left a comment

COG business rules: isPrimary and isSubstrate #5275

COG business rules: isPrimary and isSubstrate #5275

Conversation

sharadsw commented Sep 13, 2024 • edited Loading

Business Logic:

Checklist

Testing instructions

Use following viewdefs

emenslin left a comment

Choose a reason for hiding this comment

sharadsw commented Nov 1, 2024

emenslin left a comment

Choose a reason for hiding this comment

sharadsw commented Nov 1, 2024

pashiav left a comment

Choose a reason for hiding this comment

emenslin left a comment

Choose a reason for hiding this comment

COG business rules: `isPrimary` and `isSubstrate` #5275

COG business rules: `isPrimary` and `isSubstrate` #5275

sharadsw commented Sep 13, 2024 •

edited

Loading