XML Lookup (Lookup Specification) - Revision history

Randallkinard at 18:11, 28 October 2025

2025-10-28T18:11:11Z

@@ Line 210: / Line 210: @@
 # When finished configuring the XML Lookup, press "OK" to exit the Lookups editor.
 # Save changes to the Data Element.
 === Use XML Lookup to validate lookup fields ===
@@ Line 239: / Line 241: @@
 # When finished configuring the XML Lookup, press "OK" to exit the Lookups editor.
 # Save changes to the Data Element.
 === Use XML Lookup to populate List Values ===
@@ Line 297: / Line 301: @@
 # At the bottom of the property grid, expand the "List Values" settings.
 # Enable "Include Lookup Results" by changing it to "True".

Dgreenwood: /* Use XML Lookup to populate List Values */

2025-06-24T14:14:35Z

Use XML Lookup to populate List Values

← Older revision		Revision as of 09:14, 24 June 2025
Line 280:		Line 280:
	#* Use field variables (<code>%FieldName</code>) to insert "lookup fields".		#* Use field variables (<code>%FieldName</code>) to insert "lookup fields".
	#* The lookup field(s) value will be inserted into the XPath when XML Lookup runs.		#* The lookup field(s) value will be inserted into the XPath when XML Lookup runs.
	#* Example: <code><nowiki>//state[@name='%State']/counties/county</nowiki></code> would select <county> nodes in a hierarchy of //state/counties/~~county~~ nodes where the state ~~nodes "~~name" attribute is the Grooper extracted value for a "State" Data Field.		#* Example: <code><nowiki>//state[@name='%State']/counties/county</nowiki></code> would select <code><county></code> XML nodes in a hierarchy of <code><state><counties><county></code> nodes where the <code><state></code> node's <code>name</code> attribute is the Grooper extracted value for a "State" Data Field.
	# Open the "Value Selectors" editor (Press the "..." button).		# Open the "Value Selectors" editor (Press the "..." button).
	# Press the "Add" button to add a new Value Selector.		# Press the "Add" button to add a new Value Selector.

Dgreenwood: /* Use XML Lookup to populate List Values */

2025-06-24T14:09:48Z

Use XML Lookup to populate List Values

← Older revision		Revision as of 09:09, 24 June 2025
Line 280:		Line 280:
	#* Use field variables (<code>%FieldName</code>) to insert "lookup fields".		#* Use field variables (<code>%FieldName</code>) to insert "lookup fields".
	#* The lookup field(s) value will be inserted into the XPath when XML Lookup runs.		#* The lookup field(s) value will be inserted into the XPath when XML Lookup runs.
	#* Example: <code><nowiki>//state[@name='%State']/counties/county</nowiki></code>		#* Example: <code><nowiki>//state[@name='%State']/counties/county</nowiki></code> would select <county> nodes in a hierarchy of //state/counties/county nodes where the state nodes "name" attribute is the Grooper extracted value for a "State" Data Field.
	# Open the "Value Selectors" editor (Press the "..." button).		# Open the "Value Selectors" editor (Press the "..." button).
	# Press the "Add" button to add a new Value Selector.		# Press the "Add" button to add a new Value Selector.
	# In the "Path" editor, enter an XML selector that selects an attribute or child XML element whose value you want to collect. When XML Lookup runs, the Value Selector's "target field" will be populated with the selected attribute or element's text.		# In the "Path" editor, enter an XML selector that selects an attribute or child XML element whose value you want to collect. When XML Lookup runs, the Value Selector's "target field" will be populated with the selected attribute or element's text.
	#* Example: <code><nowiki>@name</nowiki></code>		#* Example: <code><nowiki>@name</nowiki></code> would select an XML attribute named "name".
			#*<li class="attn-bullet"> In cases where the Record Selector selects XML elements whose inner text you want to use for List Values, enter the dot expression (<code>.</code>) to select the elements' text.
	# Open the "Target Field" dropdown and select the corresponding Data Field in the Data Model. When XML Lookup runs, the Data Field you select will be populated with the attribute or element's text selected by the Value Selector's Path.		# Open the "Target Field" dropdown and select the corresponding Data Field in the Data Model. When XML Lookup runs, the Data Field you select will be populated with the attribute or element's text selected by the Value Selector's Path.
	#* Example: "County" Data Field		#* Example: "County" Data Field

Dgreenwood: /* The general setup */

2025-06-23T20:33:48Z

The general setup

← Older revision		Revision as of 15:33, 23 June 2025
Line 43:		Line 43:
	#* Each Value Selector specifies an XPath expression and maps the result to a Grooper field.		#* Each Value Selector specifies an XPath expression and maps the result to a Grooper field.
	#**<li class="attn-bullet"> The Value Selector XPath is relative to the record node returned by the Record Selector. The path should start at the root of the ''record'' not the root of the XML itself.		#**<li class="attn-bullet"> The Value Selector XPath is relative to the record node returned by the Record Selector. The path should start at the root of the ''record'' not the root of the XML itself.
			#**<li class="attn-bullet"> If the Record Selector itself selects the XML element you want to map to a target field, there will be no "child element" to select. Instead, enter the dot expression (<code>.</code>) to select it.

	=== The general execution ===		=== The general execution ===

Dgreenwood at 20:29, 23 June 2025

2025-06-23T20:29:05Z

← Older revision		Revision as of 15:29, 23 June 2025
Line 1:		Line 1:
	{\|class="~~attn~~-box"		{{AutoVersion}}

			<blockquote>{{#lst:Glossary\|XML Lookup}}</blockquote>

			{\|class="download-box"
	\|		\|
	~~⚠~~		[[File:Asset 22@4x.png]]
	\|		\|
	~~ARTICLE UNDER CONSTRUCTION~~		You may download the ZIP(s) below and upload it into your own Grooper environment (version 2025). The first contains one or more '''Batches''' of sample documents. The second contains one or more '''Projects''' with resources used in examples throughout this article.
			* [[Media:2025 Wiki - XML Lookup Batches.zip]]
			* [[Media:2025 Wiki - XML Lookup Projects.zip]]
	\|}		\|}

	~~{{AutoVersion}}~~

	~~<blockquote>{{#lst:Glossary\|XML Lookup}}</blockquote>~~

	== About ==		== About ==

	XML Lookup was designed to be a ~~sort of~~ middle-ground between Grooper's '''Lexicon Lookups''' and '''Database Lookup'''. Lexicon Lookup and Database Lookups have their own pros and cons.		XML Lookup was designed to be a middle-ground between Grooper's '''Lexicon Lookups''' and '''Database Lookup'''. Lexicon Lookup and Database Lookups have their own pros and cons.

	'''Lexicon Lookup'''		'''Lexicon Lookup'''

Dgreenwood: /* Use XML Lookup to populate List Values */

2025-06-23T20:20:35Z

Use XML Lookup to populate List Values

@@ Line 238: / Line 238: @@
 === Use XML Lookup to populate List Values ===
 "List Values" is a set of configurable properties for Data Fields and Data Columns. When enabled, it allows Grooper designers to set a list of values users can pick from a dropdown selection when reviewing the field in a Data Viewer.
@@ Line 244: / Line 248: @@
 * This is helpful for use cases where the possible entry values for Field B change based on Field A's value.
 * Example: A "State" lookup field could be used to generate list values for a "County" field using this mechanism.
 {|class="attn-box"
+|
@@ Line 255: / Line 260: @@
 * However, in this case, we want to ''ignore'' that warning to include all results in the selection list.
 |}

Dgreenwood: /* Use XML Lookup to populate List Values */

2025-06-23T19:49:09Z

Use XML Lookup to populate List Values

← Older revision		Revision as of 14:49, 23 June 2025
Line 250:		Line 250:
	'''''BE AWARE: Set the Lookup Specification's "Conflict Disposition" to "Ignore"		'''''BE AWARE: Set the Lookup Specification's "Conflict Disposition" to "Ignore"

	You must set the Lookup Specification's "Conflict Disposition" to "Ignore" in order to use a lookup to generate a selection list for a Data Field/Data Column.		The "Conflict Disposition" determines what happens when the Lookup Specification returns multiple hits (multiple rows for Database Lookup, multiple records for XML Lookup or Web Service Lookup, or multiple lines for Lexicon Lookup).
			* You must set the Lookup Specification's "Conflict Disposition" to "Ignore" in order to use a lookup to generate a selection list for a Data Field/Data Column.
	* In normal lookups (for field population/validation), Grooper is designed to alert you if the lookup produces multiple hits.		* In normal lookups (for field population/validation), Grooper is designed to alert you if the lookup produces multiple hits.
	* However, in this case, we want to ''ignore'' that warning to include all results in the selection list.		* However, in this case, we want to ''ignore'' that warning to include all results in the selection list.
	\|}		\|}

Dgreenwood at 19:45, 23 June 2025

2025-06-23T19:45:29Z

← Older revision		Revision as of 14:45, 23 June 2025
Line 239:		Line 239:
	=== Use XML Lookup to populate List Values ===		=== Use XML Lookup to populate List Values ===

	"List Values" is a set of configurable properties for Data Fields and Data Columns. When enabled, it ~~gives users~~ a list of values to pick from a dropdown selection when reviewing the field in a Data Viewer.		"List Values" is a set of configurable properties for Data Fields and Data Columns. When enabled, it allows Grooper designers to set a list of values users can pick from a dropdown selection when reviewing the field in a Data Viewer.

			When the "Include Lookup Results" option is enabled, the field will use the results of a lookup (such as XML Lookup) to generate the selection list.
			* This is helpful for use cases where the possible entry values for Field B change based on Field A's value.
			* Example: A "State" lookup field could be used to generate list values for a "County" field using this mechanism.
			{\|class="attn-box"
			\|
			⚠
			\|
			'''''BE AWARE: Set the Lookup Specification's "Conflict Disposition" to "Ignore"

			You must set the Lookup Specification's "Conflict Disposition" to "Ignore" in order to use a lookup to generate a selection list for a Data Field/Data Column.
			* In normal lookups (for field population/validation), Grooper is designed to alert you if the lookup produces multiple hits.
			* However, in this case, we want to ''ignore'' that warning to include all results in the selection list.
			\|}

Dgreenwood: /* Examples */

2025-06-23T19:14:28Z

Examples

← Older revision		Revision as of 14:14, 23 June 2025
Line 238:		Line 238:

	=== Use XML Lookup to populate List Values ===		=== Use XML Lookup to populate List Values ===

			"List Values" is a set of configurable properties for Data Fields and Data Columns. When enabled, it gives users a list of values to pick from a dropdown selection when reviewing the field in a Data Viewer.

Dgreenwood: /* Use XML Lookup to populate target fields */

2025-06-23T18:18:44Z

Use XML Lookup to populate target fields

← Older revision		Revision as of 13:18, 23 June 2025
Line 155:		Line 155:
	The process follows this order:		The process follows this order:

	# Grooper executes the "lookup field's" extractor. ~~''In this case the "ISBN Lookup" Data Field in this Data Model.''~~		# Grooper executes the "lookup field's" extractor.
	# XML Lookup runs its "Record Selector" to locate one or more XML nodes. ~~''In this case the selector selects a <book> node whose isbn13 attribute matches the value Grooper extracted.''~~		# XML Lookup runs its "Record Selector" to locate one or more XML nodes.
	# XML Lookup runs its "Value Selectors" against the record and maps the selected attribute or element's text to a Grooper Data Field. ~~''Data from the <book> node is mapped to corresponding Data Fields, like "Book Title" and "Author Name".''~~		# XML Lookup runs its "Value Selectors" against the record and maps the selected attribute or element's text to a Grooper Data Field.

	{\|		{\|cellspacing=10
			\|valign=top\|
			1. Grooper extracts the lookup field.
			\|valign=top\|
			2. XML Lookup's "Record Selector" selects an XML node.
			\|valign=top\|
			3. XML Lookup's "Value Selectors" map XML values to Data Fields.
			\|-
	\|valign=top\|		\|valign=top\|
	[[File:2025Wiki-XMLLookup-03-01-Population-01.png]]		[[File:2025Wiki-XMLLookup-03-01-Population-01.png]]

			''In this case, the "ISBN Lookup" Data Field in this Data Model.''
	\|valign=top\|		\|valign=top\|
	[[File:2025Wiki-XMLLookup-03-01-Population-02.png]]		[[File:2025Wiki-XMLLookup-03-01-Population-02.png]]

			''In this case, the selector selects a <book> node whose isbn13 attribute matches the value Grooper extracted.''
	\|valign=top\|		\|valign=top\|
	[[File:2025Wiki-XMLLookup-03-01-Population-03b.png]]		[[File:2025Wiki-XMLLookup-03-01-Population-03b.png]]

			''Data from the <book> node is mapped to corresponding Data Fields, like "Book Title" and "Author Name" in this case.''
	\|}		\|}