CMIS Lookup (Lookup Specification) - Revision history

Randallkinard at 15:02, 30 October 2025

2025-10-30T15:02:39Z

← Older revision		Revision as of 10:02, 30 October 2025
Line 8:		Line 8:
	Unlike other Lookup types (such as Database Lookup, Lexicon Lookup, Web Service Lookup, or XML Lookup), CMIS Lookup is designed specifically for interacting with CMIS-compliant repositories and leverages CMISQL for querying document metadata and content.		Unlike other Lookup types (such as Database Lookup, Lexicon Lookup, Web Service Lookup, or XML Lookup), CMIS Lookup is designed specifically for interacting with CMIS-compliant repositories and leverages CMISQL for querying document metadata and content.

	== When to ~~Use~~ ==		== When to use ==
	'''Use a CMIS Lookup when you need to:'''		'''Use a CMIS Lookup when you need to:'''
	# Validate that a [[Data Field]] value (such as a document number or ID) exists in a CMIS Repository.		# Validate that a [[Data Field]] value (such as a document number or ID) exists in a CMIS Repository.
Line 20:		Line 20:
	* CMIS Lookups are added to container elements: [[Data Model]], [[Data Section]], or [[Data Table]]. They cannot be added directly to Data Fields or [[Data Column\|Data Columns]].		* CMIS Lookups are added to container elements: [[Data Model]], [[Data Section]], or [[Data Table]]. They cannot be added directly to Data Fields or [[Data Column\|Data Columns]].

	== How to ~~Add~~ and ~~Configure~~ and ~~Test~~ a CMIS Lookup ==		== How to add and configure and test a CMIS Lookup ==
	<div style="padding-left: 1.5em;">		<div style="padding-left: 1.5em;">
	=== Configure a CMIS Lookup ===		=== Configure a CMIS Lookup ===
Line 65:		Line 65:
	* Use the diagnostic output to verify results and troubleshoot errors.		* Use the diagnostic output to verify results and troubleshoot errors.
	<div style="padding-left: 1.5em;">		<div style="padding-left: 1.5em;">
	=== Step by ~~Step Query Edit~~ ===		=== Step by step query edit ===
	# Select a container element, such as a Data Model, Data Section, or Data table.		# Select a container element, such as a Data Model, Data Section, or Data table.
	# Click the ellipsis button for the Lookups property.		# Click the ellipsis button for the Lookups property.

Randallkinard: /* Step by Step Query Edit */

2025-10-15T18:37:14Z

Step by Step Query Edit

← Older revision		Revision as of 13:37, 15 October 2025
Line 66:		Line 66:
	<div style="padding-left: 1.5em;">		<div style="padding-left: 1.5em;">
	=== Step by Step Query Edit ===		=== Step by Step Query Edit ===
			# Select a container element, such as a Data Model, Data Section, or Data table.
			# Click the ellipsis button for the Lookups property.
			# In the Lookups collection editor, with a CMIS Lookup in the collection, click the ellipsis button for the CMIS Query property.
	# Start by writing the <code>Select</code> clause followed by a space and <code>*</code>.		# Start by writing the <code>Select</code> clause followed by a space and <code>*</code>.
	# Press space and intellisense will provide the option for the <code>From</code> clause.		# Press space and intellisense will provide the option for the <code>From</code> clause.

Randallkinard: /* Properties overview */

2025-10-10T19:30:42Z

Properties overview

← Older revision		Revision as of 14:30, 10 October 2025
Line 107:		Line 107:
	* '''Trigger Mode'''		* '''Trigger Mode'''
	** Determines when the lookup is executed (e.g., on field change, on demand, or always).		** Determines when the lookup is executed (e.g., on field change, on demand, or always).
	** ~~The TriggerModes enumeration determines~~ the conditions under which a lookup operation is performed in Grooper. This setting allows you to control whether lookups are executed automatically, only under certain conditions, manually, or based on a custom expression. Choosing the appropriate trigger mode is essential for balancing automation, user control, and data integrity in your solution.		** Determines the conditions under which a lookup operation is performed in Grooper. This setting allows you to control whether lookups are executed automatically, only under certain conditions, manually, or based on a custom expression. Choosing the appropriate trigger mode is essential for balancing automation, user control, and data integrity in your solution.
	* '''Miss Disposition'''		* '''Miss Disposition'''
	** Specifies what happens when no results are returned.		** Specifies what happens when no results are returned.
	** ~~The MissDispositions enumeration determines~~ how Grooper responds when a lookup operation does not return any matching records from the external data source. This setting controls whether errors are flagged, target fields are cleared, or no action is taken.		** Determines how Grooper responds when a lookup operation does not return any matching records from the external data source. This setting controls whether errors are flagged, target fields are cleared, or no action is taken.
	* '''Conflict Disposition'''		* '''Conflict Disposition'''
	** Specifies what happens when multiple results are returned.		** Specifies what happens when multiple results are returned.
	** ~~The Conflict Dispositions enumeration controls~~ how Grooper handles situations where a lookup operation returns more than one matching record from the external data source. This setting determines whether errors are flagged, data is cleared, the first result is accepted, or no action is taken.		** Controls how Grooper handles situations where a lookup operation returns more than one matching record from the external data source. This setting determines whether errors are flagged, data is cleared, the first result is accepted, or no action is taken.
	* '''Field Population'''		* '''Field Population'''
	** Specifies how target fields are populated with the lookup results.		** Specifies how target fields are populated with the lookup results.
	** ~~The PopulationMethod enumeration controls~~ whether and how the results of a lookup operation are written to the target fields in Grooper. This setting determines if lookup results will overwrite existing values, supplement only empty fields, or leave all fields unchanged.		** Controls whether and how the results of a lookup operation are written to the target fields in Grooper. This setting determines if lookup results will overwrite existing values, supplement only empty fields, or leave all fields unchanged.
	=== Lookup Info ===		=== Lookup Info ===
	* '''Lookup Fields'''		* '''Lookup Fields'''

Randallkinard: /* Step by Step Query Edit */

2025-10-10T19:20:51Z

Step by Step Query Edit

← Older revision		Revision as of 14:20, 10 October 2025
Line 73:		Line 73:
	# If more than one field is used, type a comma, then a space and intellisense will come up again allowing you to continue adding fields to the query.		# If more than one field is used, type a comma, then a space and intellisense will come up again allowing you to continue adding fields to the query.
	# Once done adding fields put your cursor after the content type of the <code>From</code> clause, then press space.		# Once done adding fields put your cursor after the content type of the <code>From</code> clause, then press space.
	# ~~Illisense~~ will pop up allowing you to select the <code>Where</code> clause.		# Intellisense will pop up allowing you to select the <code>Where</code> clause.
	# Select the field that will function as the target field to fire the lookup.		# Select the field that will function as the target field to fire the lookup.
	# Press space and intellisense will allow you to select the <code>=</code> sign.		# Press space and intellisense will allow you to select the <code>=</code> sign.
Line 80:		Line 80:
	<div style="position: relative; box-sizing: content-box; max-height: 80vh; max-height: 80svh; width: 100%; aspect-ratio: 1.7777777777777777; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmgjs9so100f4vu0it5b45z0n?embed_v=2&utm_source=embed" loading="lazy" title="Step by Step Query Edit" 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.7777777777777777; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmgjs9so100f4vu0it5b45z0n?embed_v=2&utm_source=embed" loading="lazy" title="Step by Step Query Edit" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
	</div>		</div>

	== How fields are populated ==		== How fields are populated ==
	* When a CMIS Lookup executes, the result set is analyzed:		* When a CMIS Lookup executes, the result set is analyzed:

Randallkinard: /* When to Use */

2025-10-10T19:12:52Z

When to Use

← Older revision		Revision as of 14:12, 10 October 2025
Line 16:		Line 16:

	'''Prerequisites:'''		'''Prerequisites:'''
	* A CMIS Repository must be imported and configured in Grooper.		* A [[CMIS Repository]], which is created as a child of a [[CMIS Connection]], must be imported and configured in Grooper.
	* The repository must support CMISQL queries and have the necessary permissions for querying and retrieving content.		* The repository must support CMISQL queries and have the necessary permissions for querying and retrieving content.
	* CMIS Lookups are added to container elements: [[Data Model]], [[Data Section]], or [[Data Table]]. They cannot be added directly to Data Fields or [[Data Column\|Data Columns]].		* CMIS Lookups are added to container elements: [[Data Model]], [[Data Section]], or [[Data Table]]. They cannot be added directly to Data Fields or [[Data Column\|Data Columns]].

Randallkinard: /* Configure a CMIS Lookup */

2025-10-10T19:07:22Z

Configure a CMIS Lookup

← Older revision		Revision as of 14:07, 10 October 2025
Line 23:		Line 23:
	<div style="padding-left: 1.5em;">		<div style="padding-left: 1.5em;">
	=== Configure a CMIS Lookup ===		=== Configure a CMIS Lookup ===
	Follow these steps to add and configure a CMIS Lookup in Grooper Design ~~Studio~~:		Follow these steps to add and configure a CMIS Lookup from the Grooper Design page:
	# Select the target container element (Data Model, Data Section, or Data Table) where you want to add the Lookup.		# Select the target container element (Data Model, Data Section, or Data Table) where you want to add the Lookup.
	# Click the ellipsis button for the Lookup property.		# Click the ellipsis button for the Lookup property.
	# In the "Lookups" collection editor, click the "Add" button.		# In the "Lookups" collection editor, click the "Add" button.
	# Choose "CMIS ~~Lookukp~~" from the drop-down menu.		# Choose "CMIS Lookup" from the drop-down menu.
	# Configure the following:		# Configure the following:
	#* '''General'''		#* '''General'''

Randallkinard at 21:23, 9 October 2025

2025-10-09T21:23:06Z

← Older revision		Revision as of 16:23, 9 October 2025
Line 48:		Line 48:

	<div style="position: relative; box-sizing: content-box; max-height: 80vh; max-height: 80svh; width: 100%; aspect-ratio: 1.7777777777777777; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmgi9lnb3000f150ipvh2fj6v?embed_v=2&utm_source=embed" loading="lazy" title="Test a CMIS Lookup" 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.7777777777777777; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmgi9lnb3000f150ipvh2fj6v?embed_v=2&utm_source=embed" loading="lazy" title="Test a CMIS Lookup" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
			</div>
	== How to edit CMISQL queries ==		== How to edit CMISQL queries ==
	'''CMISQL''' is a query language used to search and retrieve data from CMIS repositories. In Grooper, you write CMISQL queries in the "Query" property of the CMIS Lookup.		'''CMISQL''' is a query language used to search and retrieve data from CMIS repositories. In Grooper, you write CMISQL queries in the "Query" property of the CMIS Lookup.
Line 64:		Line 64:
	* The query is executed against the selected repository, and results are returned for field population or validation.		* The query is executed against the selected repository, and results are returned for field population or validation.
	* Use the diagnostic output to verify results and troubleshoot errors.		* Use the diagnostic output to verify results and troubleshoot errors.
			<div style="padding-left: 1.5em;">
	=== Step by Step Query Edit ===		=== Step by Step Query Edit ===
	# Start by writing the <code>Select</code> clause followed by a space and <code>*</code>.		# Start by writing the <code>Select</code> clause followed by a space and <code>*</code>.
Line 79:		Line 79:

	<div style="position: relative; box-sizing: content-box; max-height: 80vh; max-height: 80svh; width: 100%; aspect-ratio: 1.7777777777777777; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmgjs9so100f4vu0it5b45z0n?embed_v=2&utm_source=embed" loading="lazy" title="Step by Step Query Edit" 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.7777777777777777; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmgjs9so100f4vu0it5b45z0n?embed_v=2&utm_source=embed" loading="lazy" title="Step by Step Query Edit" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
			</div>
	== How fields are populated ==		== How fields are populated ==
	* When a CMIS Lookup executes, the result set is analyzed:		* When a CMIS Lookup executes, the result set is analyzed:

Randallkinard: /* Step by Step Query Edit */

2025-10-09T19:02:11Z

Step by Step Query Edit

← Older revision		Revision as of 14:02, 9 October 2025
Line 66:		Line 66:

	=== Step by Step Query Edit ===		=== Step by Step Query Edit ===
	# Start by writing the <code>Select</code> clause.		# Start by writing the <code>Select</code> clause followed by a space and <code>*</code>.
	# Press space and intellisense will provide the option for the <code>From</code> clause.		# Press space and intellisense will provide the option for the <code>From</code> clause.
	#* Here you select the content type. You can select a subsite from your CMIS source, and typically will select the document type.		#* Here you select the content type. You can select a subsite from your CMIS source, and typically will select the document type.
	# ~~Put your cursor~~ after the <code>Select</code> clause and press space.		# Delete the <code>*</code> after the <code>Select</code> clause, then backspace to the <code>Select</code> clause and press space.
	# Intellisense will give you a list of fields from the CMIS source you can select. Use the <code>As</code> clause if the alias of the field in the CMIS source is different from the name of the field in Grooper. These fields selected here are the ones to be populated or validated based on data from the target field.		# Intellisense will give you a list of fields from the CMIS source you can select. Use the <code>As</code> clause if the alias of the field in the CMIS source is different from the name of the field in Grooper. These fields selected here are the ones to be populated or validated based on data from the target field.
	# If more than one field is used, type a comma, then a space and intellisense will come up again allowing you to continue adding fields to the query.		# If more than one field is used, type a comma, then a space and intellisense will come up again allowing you to continue adding fields to the query.
Line 78:		Line 78:
	# Press space after this and use the <code>@FieldName</code> syntax to define the target field.		# Press space after this and use the <code>@FieldName</code> syntax to define the target field.

	~~'''''insert~~ supademo ~~here'''''~~		<div style="position: relative; box-sizing: content-box; max-height: 80vh; max-height: 80svh; width: 100%; aspect-ratio: 1.7777777777777777; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmgjs9so100f4vu0it5b45z0n?embed_v=2&utm_source=embed" loading="lazy" title="Step by Step Query Edit" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>

	== How fields are populated ==		== How fields are populated ==

Randallkinard: /* How to edit CMISQL queries */

2025-10-09T16:49:00Z

How to edit CMISQL queries

@@ Line 56: / Line 56: @@
    SELECT Property1, Property2 AS 'FieldName' FROM ContentType WHERE PropertyX = @FieldName
    </pre>
 * Reference Grooper Data Fields or variables in the WHERE clause using <code>@FieldName</code> or <code>@VariableName</code> syntax.
 * The query editor in Grooper provides syntax highlighting and intellisense for content types, properties, and fields.
 '''Query execution and validation:'''
@@ Line 65: / Line 64: @@
 * The query is executed against the selected repository, and results are returned for field population or validation.
 * Use the diagnostic output to verify results and troubleshoot errors.
 == How fields are populated ==

Randallkinard at 17:42, 8 October 2025

2025-10-08T17:42:45Z

Show changes