Data Validation in Grooper - Revision history

Rpatton: // via Wikitext Extension for VSCode

2026-04-14T14:03:33Z

// via Wikitext Extension for VSCode

← Older revision		Revision as of 09:03, 14 April 2026
Line 19:		Line 19:

	The different methods of data validation in Grooper discussed in this article include:		The different methods of data validation in Grooper discussed in this article include:
	* ~~[[#~~Value Types~~\|Value Types]]~~		* Value Types
	* ~~[[#~~Required Fields~~\|Required Fields]]~~		* Required Fields
	* Is Valid expressions ~~(WIP)~~		* Calculated Value expressions
	* ~~Calculated Value~~ expressions ~~(WIP)~~		* Is Valid expressions
	* Database Lookups ~~(WIP)~~		* Is Required expressions
	* Data Rules and Data Actions ~~(WIP)~~		* Database Lookups
			* Data Rules and Data Actions

	== Value Types ==		== Value Types ==

Rpatton: // via Wikitext Extension for VSCode

2026-04-14T14:00:36Z

// via Wikitext Extension for VSCode

Show changes

Rpatton: /* Using the Require Value Data Action for validation in a Data Rule */

2026-04-10T16:08:59Z

Using the Require Value Data Action for validation in a Data Rule

← Older revision		Revision as of 11:08, 10 April 2026
Line 579:		Line 579:
	<div style="position: relative; box-sizing: content-box; max-height: 80vh; max-height: 80svh; width: 100%; aspect-ratio: 1.78; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmmm7wzys00ef0u0j4goczb1f?embed_v=2&utm_source=embed" loading="lazy" title="02 Data Rules - False Action" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>		<div style="position: relative; box-sizing: content-box; max-height: 80vh; max-height: 80svh; width: 100%; aspect-ratio: 1.78; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmmm7wzys00ef0u0j4goczb1f?embed_v=2&utm_source=embed" loading="lazy" title="02 Data Rules - False Action" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>

	==== ~~Using the~~ Require Value Data Action ~~for validation in a Data Rule~~ ====		==== Require Value Data Action (Validation) ====

	The '''Require Value''' Data Action is used to enforce that one or more selected Data Elements have data. When a required value is missing, the action marks the item as invalid and records an issue. This is most useful for '''conditional requiredness''' (required only when a rule's "Trigger" is true).		The '''Require Value''' Data Action is used to enforce that one or more selected Data Elements have data. When a required value is missing, the action marks the item as invalid and records an issue. This is most useful for '''conditional requiredness''' (required only when a rule's "Trigger" is true).

Rpatton at 16:08, 10 April 2026

2026-04-10T16:08:14Z

← Older revision		Revision as of 11:08, 10 April 2026
Line 583:		Line 583:
	The '''Require Value''' Data Action is used to enforce that one or more selected Data Elements have data. When a required value is missing, the action marks the item as invalid and records an issue. This is most useful for '''conditional requiredness''' (required only when a rule's "Trigger" is true).		The '''Require Value''' Data Action is used to enforce that one or more selected Data Elements have data. When a required value is missing, the action marks the item as invalid and records an issue. This is most useful for '''conditional requiredness''' (required only when a rule's "Trigger" is true).

	~~=====~~ What it validates ~~=====~~		<big> What it validates </big>

	Require Value checks the items you select in "RequiredElements" and fails validation when:		Require Value checks the items you select in "RequiredElements" and fails validation when:
Line 596:		Line 596:
	* Adds an issue to the rule result (optionally categorized and with metadata)		* Adds an issue to the rule result (optionally categorized and with metadata)

	~~=====~~ Why use Require Value instead of a Data Field's "Required" property ~~=====~~		<big> Why use Require Value instead of a Data Field's "Required" property </big>

	Use Require Value when the requirement is '''conditional''' or when you need to require:		Use Require Value when the requirement is '''conditional''' or when you need to require:
Line 606:		Line 606:
	If a field should always be required, use the Data Field "Required" property instead (simpler and always enforced).		If a field should always be required, use the Data Field "Required" property instead (simpler and always enforced).

	~~=====~~ How to set it up (step-by-step) ~~=====~~		<big>How to set it up (step-by-step) </big>

	# In Grooper Design, create or select a Data Rule in your Project.		# In Grooper Design, create or select a Data Rule in your Project.
Line 622:		Line 622:
	# Save and test by running extraction and validating in Review.		# Save and test by running extraction and validating in Review.

	~~=====~~ Tips ~~=====~~		<big> Tips </big>

	* Keep the "Scope" as narrow as possible:		* Keep the "Scope" as narrow as possible:

Rpatton at 16:05, 10 April 2026

2026-04-10T16:05:52Z

← Older revision		Revision as of 11:05, 10 April 2026
Line 578:		Line 578:

	<div style="position: relative; box-sizing: content-box; max-height: 80vh; max-height: 80svh; width: 100%; aspect-ratio: 1.78; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmmm7wzys00ef0u0j4goczb1f?embed_v=2&utm_source=embed" loading="lazy" title="02 Data Rules - False Action" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>		<div style="position: relative; box-sizing: content-box; max-height: 80vh; max-height: 80svh; width: 100%; aspect-ratio: 1.78; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmmm7wzys00ef0u0j4goczb1f?embed_v=2&utm_source=embed" loading="lazy" title="02 Data Rules - False Action" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>

			==== Using the Require Value Data Action for validation in a Data Rule ====

			The '''Require Value''' Data Action is used to enforce that one or more selected Data Elements have data. When a required value is missing, the action marks the item as invalid and records an issue. This is most useful for '''conditional requiredness''' (required only when a rule's "Trigger" is true).

			===== What it validates =====

			Require Value checks the items you select in "RequiredElements" and fails validation when:

			* A required [[Data Field]] exists but is blank
			* A required [[Data Field]] instance does not exist (for multi-instance situations)
			* A required [[Data Section]] or [[Data Table]] instance does not exist
			* A required collection (multi-instance [[Data Section]] or [[Data Table]]) exists but has no child instances

			When it finds a problem, it:
			* Sets an error on the field (for fields), or adds an error to the container (for sections/tables)
			* Adds an issue to the rule result (optionally categorized and with metadata)

			===== Why use Require Value instead of a Data Field's "Required" property =====

			Use Require Value when the requirement is '''conditional''' or when you need to require:

			* Multiple fields together based on a single trigger
			* A section/table to exist (not just a single field)
			* Different required sets in different scenarios (via different rules/triggers)

			If a field should always be required, use the Data Field "Required" property instead (simpler and always enforced).

			===== How to set it up (step-by-step) =====

			# In Grooper Design, create or select a Data Rule in your Project.
			# Set the rule's "Scope" to where the rule should run:
			#* Data Model (validate once per document)
			#* Data Section (validate once per section instance)
			#* Data Table (validate once per table row)
			# (Optional, but common) Set the rule's "Trigger" to the condition that makes values required.
			# Set the rule's "TrueAction" to '''Require Value'''.
			# Configure the Require Value action:
			#* Set "RequiredElements" to the Data Fields (and/or Data Sections / Data Tables) that must be present when the rule applies.
			#* (Optional) Set "LogMessage" to a friendlier message to show when the requirement fails.
			#* (Optional) Set "Category" to group the issue (useful for reporting/routing).
			#* (Optional) Set "Metadata" to attach key/value details (one per line, <code>key=value</code>).
			# Save and test by running extraction and validating in Review.

			===== Tips =====

			* Keep the "Scope" as narrow as possible:
			* Use '''Data Table''' scope to validate per-row requirements.
			* Use '''Data Section''' scope to validate per-instance requirements.
			* Use '''Data Model''' scope for document-level rules that coordinate multiple areas.
			* Use a clear "LogMessage" so Review users know what to do next (for example, “PO Number is required when Payment Method is PO.”).

			<div style="position: relative; box-sizing: content-box; max-height: 80vh; max-height: 80svh; width: 100%; aspect-ratio: 1.78; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmmumbaab04x2430je72cru37?embed_v=2&utm_source=embed" loading="lazy" title="03 Required Value Data Action" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>

Rpatton: /* How To */

2026-04-10T13:53:45Z

How To

← Older revision		Revision as of 08:53, 10 April 2026
Line 539:		Line 539:

	<div style="position: relative; box-sizing: content-box; max-height: 80vh; max-height: 80svh; width: 100%; aspect-ratio: 1.78; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmmkogfi70036yv0jg7u7n9h5?embed_v=2&utm_source=embed" loading="lazy" title="01 Data Rules - True Action" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>		<div style="position: relative; box-sizing: content-box; max-height: 80vh; max-height: 80svh; width: 100%; aspect-ratio: 1.78; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmmkogfi70036yv0jg7u7n9h5?embed_v=2&utm_source=embed" loading="lazy" title="01 Data Rules - True Action" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>

			==== False Actions ====

	A '''False Action''' is the [[Data Action]] a [[Data Rule]] runs when the rule's "Trigger" evaluates to '''False'''. It is the “else” part of the rule.		A '''False Action''' is the [[Data Action]] a [[Data Rule]] runs when the rule's "Trigger" evaluates to '''False'''. It is the “else” part of the rule.

Rpatton: /* How To */

2026-04-10T13:52:59Z

How To

← Older revision		Revision as of 08:52, 10 April 2026
Line 540:		Line 540:
	<div style="position: relative; box-sizing: content-box; max-height: 80vh; max-height: 80svh; width: 100%; aspect-ratio: 1.78; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmmkogfi70036yv0jg7u7n9h5?embed_v=2&utm_source=embed" loading="lazy" title="01 Data Rules - True Action" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>		<div style="position: relative; box-sizing: content-box; max-height: 80vh; max-height: 80svh; width: 100%; aspect-ratio: 1.78; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmmkogfi70036yv0jg7u7n9h5?embed_v=2&utm_source=embed" loading="lazy" title="01 Data Rules - True Action" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>

	~~==== False Actions ====~~		A '''False Action''' is the [[Data Action]] a [[Data Rule]] runs when the rule's "Trigger" evaluates to '''False'''. It is the “else” part of the rule.

	A '''~~FalseAction~~''' is the [[Data Action]] a [[Data Rule]] runs when the rule's "Trigger" evaluates to '''False'''. It is the “else” part of the rule.

	* If the "Trigger" returns '''True''', Grooper runs the rule's "TrueAction".		* If the "Trigger" returns '''True''', Grooper runs the rule's "TrueAction".
Line 557:		Line 555:
	* '''Enforce “either/or” logic''' (do one thing if true, a different thing if false)		* '''Enforce “either/or” logic''' (do one thing if true, a different thing if false)

	<big> How to set up a ~~FalseAction~~ on a Data Rule </big>		<big> How to set up a False Action on a Data Rule </big>

	# In Grooper Design, create or select the Data Rule you want to configure.		# In Grooper Design, create or select the Data Rule you want to configure.

Rpatton: /* How To */

2026-04-10T13:51:41Z

How To

← Older revision		Revision as of 08:51, 10 April 2026
Line 576:		Line 576:
	* When the "Trigger" is false, Grooper runs "FalseAction" and skips running child [[Data Rule]]s under that rule.		* When the "Trigger" is false, Grooper runs "FalseAction" and skips running child [[Data Rule]]s under that rule.
	\|}		\|}

			<div style="position: relative; box-sizing: content-box; max-height: 80vh; max-height: 80svh; width: 100%; aspect-ratio: 1.78; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmmm7wzys00ef0u0j4goczb1f?embed_v=2&utm_source=embed" loading="lazy" title="02 Data Rules - False Action" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>

Rpatton: /* How To */

2026-04-10T13:50:44Z

How To

← Older revision		Revision as of 08:50, 10 April 2026
Line 504:		Line 504:
	=== How To ===		=== How To ===

	~~True Actions~~		Now that we understand what Data Rules are, let's learn how to configure them in Grooper.

	==== Triggers and TrueActions ====		==== Triggers and TrueActions ====

Rpatton at 13:49, 10 April 2026

2026-04-10T13:49:06Z

Show changes