AI Search and the Search Page - Revision history

Dgreenwood: /* Result Set Commands */

2026-06-09T21:32:54Z

Result Set Commands

← Older revision		Revision as of 16:32, 9 June 2026
Line 544:		Line 544:
	* '''Analyst Chat''' - Select an AI Analyst to start a chat session with the result set.		* '''Analyst Chat''' - Select an AI Analyst to start a chat session with the result set.
	* '''Download''' - Download a document, generated from the result set. May be one of the following:		* '''Download''' - Download a document, generated from the result set. May be one of the following:
	* '''Download PDF''' - Generates a single bookmarked PDF with optional search hit highlights.		** '''Download PDF''' - Generates a single bookmarked PDF with optional search hit highlights.
	* '''Download ZIP''' - Generates a ZIP file containing each document in the result set.		** '''Download ZIP''' - Generates a ZIP file containing each document in the result set.
	* '''Download CSV''' - Generates a CSV file from the result set's data fields.		** '''Download CSV''' - Generates a CSV file from the result set's data fields.
	* '''Download Custom''' - Generates a custom document using an "AI Generator"		** '''Download Custom''' - Generates a custom document using an "AI Generator"

	==== Document Commands ====		==== Document Commands ====

Randallkinard: /* Create the search index */

2026-05-15T13:29:51Z

Create the search index

← Older revision		Revision as of 08:29, 15 May 2026
Line 207:		Line 207:
	# Right-click the "AI-Search" Content Model, and from the pop-out menu choose "Search" then "Create Search Index".		# Right-click the "AI-Search" Content Model, and from the pop-out menu choose "Search" then "Create Search Index".
	# Click "Execute" in the "Create Search Index" window.		# Click "Execute" in the "Create Search Index" window.
	# If you go to the Advanced tab of the Root node you will notice an "AI Search.json" file.		# If you go to the Advanced tab of the Root node, you will notice an "AI Search.json" file.
	#* This file is created upon the first successful execution of the "Create Search Index" object command of a Content Type.		#* This file is created upon the first successful execution of the "Create Search Index" object command of a Content Type.
	#* Any other executions of that command will add to this file.		#* Any other executions of that command will add to this file.

Randallkinard: /* Configure an Indexing Behavior on a Content Type */

2026-05-15T13:28:40Z

Configure an Indexing Behavior on a Content Type

← Older revision		Revision as of 08:28, 15 May 2026
Line 182:		Line 182:
	#* Feel free to change it, but follow the naming convention rules for an Azure index when doing so.		#* Feel free to change it, but follow the naming convention rules for an Azure index when doing so.
	#* When done naming the index, click the ellipsis button for the Included elements property.		#* When done naming the index, click the ellipsis button for the Included elements property.
	# In the "Included Elements" window alt-click the [[Data Model]] check box to select it and all its child Data Elements.		# In the "Included Elements", window alt-click the [[Data Model]] check box to select it and all its child Data Elements.
	#* When finished, click the "OK" button to close the "Included Elements" window.		#* When finished, click the "OK" button to close the "Included Elements" window.
	# Click the "OK" button in the "Behaviors" window to close it.		# Click the "OK" button in the "Behaviors" window to close it.

Randallkinard: /* Document Commands */

2026-05-15T13:24:35Z

Document Commands

← Older revision		Revision as of 08:24, 15 May 2026
Line 557:		Line 557:


	# Several commands are available for the search query editor. Execute Query - This will execute the query written in the Search, Filter, Order By, and Select parameters. Clear Query - This will clear all query parameters. AI Generate - This will allow you to use AI to help craft a query. Save - This will allow users to store and retrieve queries they use frequently. Copy - This will allow users to copy a link to the clipboard for the current query.		# Several commands are available for the search query editor.
	# Click the hamburger menu icon just above the result list on. A menu will expand with several commands available.		#* '''Execute Query''' - This will execute the query written in the Search, Filter, Order By, and Select parameters.
			#* '''Clear Query''' - This will clear all query parameters.
			#* '''AI Generate''' - This will allow you to use AI to help craft a query.
			#* '''Save''' - This will allow users to store and retrieve queries they use frequently.
			#* '''Copy''' - This will allow users to copy a link to the clipboard for the current query.
			# Click the hamburger menu icon just above the result list on.
			#* A menu will expand with several commands available.
	# Analyst Chat lets you connect with an AI Analyst.		# Analyst Chat lets you connect with an AI Analyst.
	# Create Batch let's you create a Batch from the result selection.		# Create Batch let's you create a Batch from the result selection.
	# Download allows you to download the result selection.		# Download allows you to download the result selection.
	# Submit Job allows you to process the result selection through a defined Activity.		# Submit Job allows you to process the result selection through a defined Activity.
	# Right-click a result from the result list. Several object commands are available.		# Right-click a result from the result list.
			#* Several object commands are available.
	# Copy Link will put the URL to the selected result into your clipboard.		# Copy Link will put the URL to the selected result into your clipboard.
	# Go to Document will jump to the Batch Folder in the Node Tree of your Design environment.		# Go to Document will jump to the Batch Folder in the Node Tree of your Design environment.

Randallkinard: /* Querying */

2026-05-15T13:22:37Z

Querying

← Older revision		Revision as of 08:22, 15 May 2026
Line 468:		Line 468:


	# When using the Search page the first thing you'll want to do is select a search index from the drop-down in the top-right of the screen. With a search index selected, lets get some comfort with the interface by starting with an open query. Click the spyglass icon on the top-left to execute the search.		# When using the Search page the first thing you'll want to do is select a search index from the drop-down in the top-right of the screen.
	# At the bottom of the screen you will see a list of results. Above this list to the right is a drop-down that lets you choose how the result list is displayed. The default is the "list" view. Select a result from the result list.		#* With a search index selected, lets get some comfort with the interface by starting with an open query.
			#* Click the spyglass icon on the top-left to execute the search.
			# At the bottom of the screen you will see a list of results.
			#* Above this list to the right is a drop-down that lets you choose how the result list is displayed.
			#* The default is the "list" view. Select a result from the result list.
	# Above the result list and to the right of the query editor you will see your selection displayed in a Document Viewer.		# Above the result list and to the right of the query editor you will see your selection displayed in a Document Viewer.
	# Change to the "wide" view and notice the different style of the result list.		# Change to the "wide" view and notice the different style of the result list.
	# Change to "card" view and notice the different style of the result list.		# Change to "card" view and notice the different style of the result list.
	# The card view has the ability to expand container elements. This is quite useful to view extracted information, as the other views will display the contents of container elements in a serialized JSON structure, which is harder to read.		# The card view has the ability to expand container elements.
	# Let's get comfortable with the Lucene syntax of the Search box. For now, type a simple term like "Oklahoma", then execute the query. This is known as a keyword search.		#* This is quite useful to view extracted information, as the other views will display the contents of container elements in a serialized JSON structure, which is harder to read.
	# Notice above the result list there is a hit indicator. For this first result, there are three matches, and the first is highlighted. You can click the arrows of the hit indicator to step through the hits.		# Let's get comfortable with the Lucene syntax of the Search box.
			#* For now, type a simple term like "Oklahoma", then execute the query.
			#** This is known as a keyword search.
			# Notice above the result list there is a hit indicator.
			#* For this first result, there are three matches, and the first is highlighted.
			#* You can click the arrows of the hit indicator to step through the hits.
	# In the Document viewer you will notice the current hit selection is highlighted green, while the other results are highlighted gray.		# In the Document viewer you will notice the current hit selection is highlighted green, while the other results are highlighted gray.
	# Let's expand our keyword search. Type "Oklahoma City" into the Search box, and notice the results you get.		# Let's expand our keyword search.
	# Typing multiple terms into the Search box will look for each term independently. It's equivalent to the "OR" boolean operator, which we'll see again later.		#* Type "Oklahoma City" into the Search box, and notice the results you get.
	# If you surround terms in double quotes it will look for the full term, and not the individual words. This is a quoted phrase.		# Typing multiple terms into the Search box will look for each term independently.
	# We can also search for extracted values. For our purposes, the invoice number Data Field is within a Data Section. We first need to type out the parent Data Section, then follow it with a forward slash, then the name of the desired element. You will probably notice the intellisense pop up as you type, which can be quite useful. Once you have a Data Element listed you follow it with a colon, then a space, then the value you're wanting to find.		#* It's equivalent to the "OR" boolean operator, which we'll see again later.
			# If you surround terms in double quotes it will look for the full term, and not the individual words.
			#* This is a quoted phrase.
			# We can also search for extracted values.
			#* For our purposes, the invoice number Data Field is within a Data Section.
			#* We first need to type out the parent Data Section, then follow it with a forward slash, then the name of the desired element.
			#* You will probably notice the intellisense pop up as you type, which can be quite useful.
			#* Once you have a Data Element listed you follow it with a colon, then a space, then the value you're wanting to find.
	# The asterisk is used for wildcard searches.		# The asterisk is used for wildcard searches.
	# You can use an asterisk between elements in the search as well.		# You can use an asterisk between elements in the search as well.
	# Regular expressions can be used in the Search box. You will need to surround the expression with a forward slash on both sides.		# Regular expressions can be used in the Search box.
	# A tilde immediately after a term will invoke fuzzy matching. You must follow the tilde with a 1 or a 2. This number after the tilde determines the character edit distance.		#* You will need to surround the expression with a forward slash on both sides.
	# There are several boolean operators that can be used. First is the "AND" operator. This is used when both terms are expected to be present.		# A tilde immediately after a term will invoke fuzzy matching.
	# Next is the "OR" boolean operator. This is used when either term is expected to be present, but not specifically both.		#* You must follow the tilde with a 1 or a 2.
	# Finally is the "NOT" boolean operator. This is used to search for the presence of the first term, while excluding the second.		#** This number after the tilde determines the character edit distance.
	# When a tilde is placed after a quoted phrase it will invoke what's known as "proximity searching". The number after the tilde is the amount of terms allowed between the contents of the phrase to allow for a valid result.		# There are several boolean operators that can be used.
	# For searches with multiple terms, each term is weighted equally as important. However, if you follow a term with a carat with a number it will affect its "weight". A number above one will increase the "weight" of the term or phrase and push it to the top of the result list. A decimal number between zero and one will reduce the weight of the term or phrase.		#* First is the "AND" operator.
	# The filter box uses OData syntax to allow you to tighten your searches. If a Data Element is within a container like a Data Section you will need to use the lambda expression syntax shown to use comparisons.		#** This is used when both terms are expected to be present.
	# Select also uses OData syntax. This will change the information displayed in the result list. It can be useful to eliminate "noise" by being specific about the data elements that are selected and displayed.		# Next is the "OR" boolean operator.
	# Order By also uses OData syntax. This is quite useful when you have multiple results and need the result list to be ordered in a specific fashion.		#* This is used when either term is expected to be present, but not specifically both.
			# Finally is the "NOT" boolean operator.
			#* This is used to search for the presence of the first term, while excluding the second.
			# When a tilde is placed after a quoted phrase it will invoke what's known as "proximity searching".
			#* The number after the tilde is the amount of terms allowed between the contents of the phrase to allow for a valid result.
			# For searches with multiple terms, each term is weighted equally as important.
			#* However, if you follow a term with a carat with a number it will affect its "weight".
			#** A number above one will increase the "weight" of the term or phrase and push it to the top of the result list.
			#** A decimal number between zero and one will reduce the weight of the term or phrase.
			# The filter box uses OData syntax to allow you to tighten your searches.
			#* If a Data Element is within a container like a Data Section you will need to use the lambda expression syntax shown to use comparisons.
			# Select also uses OData syntax.
			#* This will change the information displayed in the result list.
			#* It can be useful to eliminate "noise" by being specific about the data elements that are selected and displayed.
			# Order By also uses OData syntax.
			#* This is quite useful when you have multiple results and need the result list to be ordered in a specific fashion.

	<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/cmb14j7qd003h0h0ix7sm7u19?embed_v=2&utm_source=embed" loading="lazy" title="Lesson 11 - Querying" 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/cmb14j7qd003h0h0ix7sm7u19?embed_v=2&utm_source=embed" loading="lazy" title="Lesson 11 - Querying" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>

Randallkinard: /* Search page UI overview */

2026-05-15T13:18:31Z

Search page UI overview

← Older revision		Revision as of 08:18, 15 May 2026
Line 436:		Line 436:
	# Within the Query Editor are the different fields by which you can craft a query.		# Within the Query Editor are the different fields by which you can craft a query.
	# "Include hit highlights" will highlight query results in the Document Viewer.		# "Include hit highlights" will highlight query results in the Document Viewer.
	# The top-right portion of the UI is a Document Viewer. This will display documents from selected results.		# The top-right portion of the UI is a Document Viewer.
	# At the bottom of the UI is the Result List. Documents returned by a query will be displayed here.		#* This will display documents from selected results.
			# At the bottom of the UI is the Result List.
			#* Documents returned by a query will be displayed here.
	# Step through pages from a selected result with the Page Navigator in the top-middle of the Result List.		# Step through pages from a selected result with the Page Navigator in the top-middle of the Result List.
	# In the top-right of the Result List are "hit" navigation buttons. Here you can step through returned results from a selection in the Result List.		# In the top-right of the Result List are "hit" navigation buttons.
	# To the right of the "hits" buttons is the command button. This gives several options for commands that can be applied to a result selection.		#* Here you can step through returned results from a selection in the Result List.
	# To the right of the command button is the view button. This will allow you to change how the Result List is displayed.		# To the right of the "hits" buttons is the command button.
			#* This gives several options for commands that can be applied to a result selection.
			# To the right of the command button is the view button.
			#* This will allow you to change how the Result List is displayed.
	# If queries are saved, they'll be displayed in the collapsable list on the left of the UI.		# If queries are saved, they'll be displayed in the collapsable list on the left of the UI.

Randallkinard: /* Recreate search index after Data Model change */

2026-05-15T13:17:32Z

Recreate search index after Data Model change

← Older revision		Revision as of 08:17, 15 May 2026
Line 362:		Line 362:


	# It's very common that you may want to make add or remove Data Elements to your Data Model after you have created a search index and even indexed document data. This is not the same as changing the way currently existing and indexed Data Elements extract. In that situation you can simply re-index newly extracted Batch Folders. A change in the data structure will require that you delete, recreate, and reindex the search index. To see this in action, let's make a change to our Data Model. Expand the Node Tree and select the Data Model from the provided Project.		# It's very common that you may want to make add or remove Data Elements to your Data Model after you have created a search index and even indexed document data.
	# Let's add a [[Data Section]] for organizational purposes. Right-click the Data Model, and in the pop-out menu select "Add" then "Data Section".		#* This is not the same as changing the way currently existing and indexed Data Elements extract.
			#** In that situation you can simply re-index newly extracted Batch Folders.
			#* A change in the data structure will require that you delete, recreate, and reindex the search index.
			#* To see this in action, let's make a change to our Data Model.
			#** Expand the Node Tree and select the Data Model from the provided Project.
			# Let's add a [[Data Section]] for organizational purposes.
			#* Right-click the Data Model, and in the pop-out menu select "Add" then "Data Section".
	# Name the Data Section in the "Add" window, then click the "Execute" button.		# Name the Data Section in the "Add" window, then click the "Execute" button.
	# Set the Scope property of the newly created Data Section to "SingleInstance", then set the Miss Disposition property to "DefaultToParent".		# Set the Scope property of the newly created Data Section to "SingleInstance", then set the Miss Disposition property to "DefaultToParent".
Line 370:		Line 376:
	# Click the "OK" button in the "Confirmation" window.		# Click the "OK" button in the "Confirmation" window.
	# Right-click the "Header Values" Data Section, and in the pop-out menu select "Move Up" to put it above the "LineItems" Data Table.		# Right-click the "Header Values" Data Section, and in the pop-out menu select "Move Up" to put it above the "LineItems" Data Table.
	# Let's add a new Data Field to this new Data Section. Right-click the "Header Values" Data Section, and in the pop-out menu select "Add" then "Data Field".		# Let's add a new Data Field to this new Data Section.
			#* Right-click the "Header Values" Data Section, and in the pop-out menu select "Add" then "Data Field".
	# Name the Data Field in the "Add" window, then click the "Execute" button.		# Name the Data Field in the "Add" window, then click the "Execute" button.
	# Use the "Move Up" object command on the "PO Number" Data Field a few times to move it up beneath the "InvoiceNo" Data Field.		# Use the "Move Up" object command on the "PO Number" Data Field a few times to move it up beneath the "InvoiceNo" Data Field.
	# Set the Value Extractor property to "Labeled Value", then click the ellipsis button for the Value Extractor property set to "Labeled Value".		# Set the Value Extractor property to "Labeled Value", then click the ellipsis button for the Value Extractor property set to "Labeled Value".
	# In the "Value Extractor" window set the Label Extractor property to "List Match", then click the ellipsis button for the Label Extractor property set to "List Match".		# In the "Value Extractor" window set the Label Extractor property to "List Match", then click the ellipsis button for the Label Extractor property set to "List Match".
	# In the "Local Entries" field of the "Label Extractor" window enter the following: ~~PO space NUMBER,~~ P ~~dot~~ O ~~dot space N o dot,~~ PO ~~space pound sign.~~ When configuration is complete, click the "OK" button.		# In the "Local Entries" field of the "Label Extractor" window enter the following:
	# In the "Value Extractor" window set the Value Extractor property to "Reference" and expand its subproperties. Point the Extractor property at the "VAL - Generic Text Segment - No Labels" Data Type.		#* <code>P.O. No.</code>
			#* <code>PO #</code>
			#* When configuration is complete, click the OK" button.
			# In the "Value Extractor" window set the Value Extractor property to "Reference" and expand its subproperties.
			#* Point the Extractor property at the "VAL - Generic Text Segment - No Labels" Data Type.
	# When configuration is complete, click the "OK" button.		# When configuration is complete, click the "OK" button.
	# Click the "Save" button to save the changes made to the "PO Number" Data Field.		# Click the "Save" button to save the changes made to the "PO Number" Data Field.
	# We need to re-run Extraction on our Batch Folders after having made a change to the Data Model. Expand the Node Tree and select the provided "AI-Search" Batch, then click the Viewer tab.		# We need to re-run Extraction on our Batch Folders after having made a change to the Data Model.
			#* Expand the Node Tree and select the provided "AI-Search" Batch, then click the Viewer tab.
	# Select all of the Batch Folders in the Batch Viewer of the Viewer tab.		# Select all of the Batch Folders in the Batch Viewer of the Viewer tab.
	# Right-click the selected Batch Folders, and in the pop-out menu select "Run Activity" then "Document Processing" then "Extract".		# Right-click the selected Batch Folders, and in the pop-out menu select "Run Activity" then "Document Processing" then "Extract".
	# Click the "Execute" button in the "Extract" window.		# Click the "Execute" button in the "Extract" window.
	# With our Data Model adjusted, and our Batch Folders newly extracted, we need to delete the search index and adjust our Content Model's Indexing Behavior. Expand the Node Tree and select the "AI-Search" Content Model.		# With our Data Model adjusted, and our Batch Folders newly extracted, we need to delete the search index and adjust our Content Model's Indexing Behavior.
			#* Expand the Node Tree and select the "AI-Search" Content Model.
	# Right-click the "AI-Search" Content Model, and in the pop-out menu select "Search" then "Delete Search Index".		# Right-click the "AI-Search" Content Model, and in the pop-out menu select "Search" then "Delete Search Index".
	# Click the "Execute" button in the "Delete Search Index" window. This will permanently delete the search index from Azure.		# Click the "Execute" button in the "Delete Search Index" window.
			#* This will permanently delete the search index from Azure.
	# Click the ellipsis button for the Behaviors property.		# Click the ellipsis button for the Behaviors property.
	# Click the ellipsis button for the Included Elements property in the "Behaviors" window.		# Click the ellipsis button for the Included Elements property in the "Behaviors" window.
	# The previous Data Elements should still be selected, but we need to add the newly created Data Section and Data Field. Confirm all the Data Elements are selected, then click the "OK" button in the "Included Elements" window.		# The previous Data Elements should still be selected, but we need to add the newly created Data Section and Data Field.
			#* Confirm all the Data Elements are selected, then click the "OK" button in the "Included Elements" window.
	# Click the "OK" button in the "Behaviors" window.		# Click the "OK" button in the "Behaviors" window.
	# Click the "Save" button to save the changes made to the "AI-Search" Content Model.		# Click the "Save" button to save the changes made to the "AI-Search" Content Model.
	# We can now recreate our search index. Right-click the "AI-Search" Content Model, and in the pop-out menu select "Search" then "Create Search Index".		# We can now recreate our search index.
			#* Right-click the "AI-Search" Content Model, and in the pop-out menu select "Search" then "Create Search Index".
	# Click the "Execute" button in the "Create Search Index" window.		# Click the "Execute" button in the "Create Search Index" window.
	# We can now reindex all associated Batch Folder's document data. Right-click the "AI-Search" Content Model, and in the pop-out menu select "Search" then "Submit Indexing Job".		# We can now reindex all associated Batch Folder's document data.
	# Click the "Execute" button in the "Submit Indexing Job" window. Give the job a moment to be processed, or feel free to go to the Jobs page to watch the progress from there.		#* Right-click the "AI-Search" Content Model, and in the pop-out menu select "Search" then "Submit Indexing Job".
	# Once the indexing job is complete you can go to your index in the Azure portal and run an open search. You'll notice the "Header Values" hierarchy as well as the "PO Number" indexed field.		# Click the "Execute" button in the "Submit Indexing Job" window.
			#* Give the job a moment to be processed, or feel free to go to the Jobs page to watch the progress from there.
			# Once the indexing job is complete you can go to your index in the Azure portal and run an open search.
			#* You'll notice the "Header Values" hierarchy as well as the "PO Number" indexed field.

	<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/cmayf5g9c00v9yf0iht80k3c9?embed_v=2&utm_source=embed" loading="lazy" title="Lesson 10 - Recreate Search Index after Data Model Change" 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/cmayf5g9c00v9yf0iht80k3c9?embed_v=2&utm_source=embed" loading="lazy" title="Lesson 10 - Recreate Search Index after Data Model Change" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>

Randallkinard: /* Indexing Service (Our best practice method) */

2026-05-15T13:10:57Z

Indexing Service (Our best practice method)

← Older revision		Revision as of 08:10, 15 May 2026
Line 339:		Line 339:

	# Expand the Node Tree and select the "AI-Search" Content Model from the provided Project, then click the ellipsis button for the Behaviors property.		# Expand the Node Tree and select the "AI-Search" Content Model from the provided Project, then click the ellipsis button for the Behaviors property.
	# Let's review the Auto Index property. This is the most automated way to index documents. An Indexing Service will periodically poll the Grooper database to determine if classified documents that inherit from a Content Type with an Indexing Behavior need to be added, updated, or deleted. If it does, it will submit an "Indexing Job" with tasks for each document that needs to be added, updated, or deleted. If Auto Index is enabled, or True, additions, updates, or deletions of document data will be recognized. If disabled, or false, only document deletions or changes will be recognized.		# Let's review the Auto Index property.
			#* This is the most automated way to index documents.
			#* An Indexing Service will periodically poll the Grooper database to determine if classified documents that inherit from a Content Type with an Indexing Behavior need to be added, updated, or deleted.
			#** If it does, it will submit an "Indexing Job" with tasks for each document that needs to be added, updated, or deleted.
			#* If Auto Index is enabled, or True, additions, updates, or deletions of document data will be recognized.
			#* If disabled, or false, only document deletions or changes will be recognized.
	# Enable the Auto Index property then click the "OK" button.		# Enable the Auto Index property then click the "OK" button.
	# Click the "Save" button to save the changes made to the "AI-Search" Content Model.		# Click the "Save" button to save the changes made to the "AI-Search" Content Model.
	# Expand the Node Tree and select the Machines folder. Ensure a "Grooper Indexing Service" is installed and running. This is the service that will do the polling of the Grooper Database to check for additions, changes, or deletions to an established search index. This service will create a job with a task for each requisite Batch Folder.		# Expand the Node Tree and select the Machines folder.
	# You may want to give the properties of this service a review. They're pretty straight forward and basically have to do with things like how often do you want this service to poll the database, and or do you want the job created by the indexing service to be deleted upon completion, etcetera.		#* Ensure a "Grooper Indexing Service" is installed and running.
	# You will also need to ensure a Grooper Activity Processing Service is installed and running. This service will do the processing of the job with indexing tasks created by the Indexing Service.		#* This is the service that will do the polling of the Grooper Database to check for additions, changes, or deletions to an established search index.
			#* This service will create a job with a task for each requisite Batch Folder.
			# You may want to give the properties of this service a review.
			#* They're pretty straight forward and basically have to do with things like how often do you want this service to poll the database, and or do you want the job created by the indexing service to be deleted upon completion, etcetera.
			# You will also need to ensure a Grooper Activity Processing Service is installed and running.
			#* This service will do the processing of the job with indexing tasks created by the Indexing Service.

	<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/cmayf5ejr00izyg0iwby5bows?embed_v=2&utm_source=embed" loading="lazy" title="Lesson 09 - Auto Index and Indexing Service" 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/cmayf5ejr00izyg0iwby5bows?embed_v=2&utm_source=embed" loading="lazy" title="Lesson 09 - Auto Index and Indexing Service" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>

Randallkinard: /* Execute Activity with "Add to Index" command */

2026-05-15T13:08:56Z

Execute Activity with "Add to Index" command

← Older revision		Revision as of 08:08, 15 May 2026
Line 315:		Line 315:
	# In the "Steps" window you will notice an "Execute Command" action has been added to the collection.		# In the "Steps" window you will notice an "Execute Command" action has been added to the collection.
	# Notice the "Object Type" is "Batch Folder".		# Notice the "Object Type" is "Batch Folder".
	# Also notice the "Command" is "Add to Index". To summarize we're looking at a Batch Process Step using the Execute activity which leverages an Execute Command action pointing at Batch Folders using the "Add to Index" command. This will perform the exact same command as the "Add to Index" object command of a Batch Folder, but instead it will be automated as part of a Batch Process. When an Execute step is reached in a Batch Process a job will be created with a task for each document in scope. If the document in scope does not need to be added, updated, or deleted, no task will be created. If that is true for all documents in scope, no job will be created.		# Also notice the "Command" is "Add to Index".
			#* To summarize we're looking at a Batch Process Step using the Execute activity which leverages an Execute Command action pointing at Batch Folders using the "Add to Index" command.
			#* This will perform the exact same command as the "Add to Index" object command of a Batch Folder, but instead it will be automated as part of a Batch Process.
			#* When an Execute step is reached in a Batch Process a job will be created with a task for each document in scope.
			#* If the document in scope does not need to be added, updated, or deleted, no task will be created.
			#* If that is true for all documents in scope, no job will be created.

	<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/cmayf5cu000p4up0j4u4twx6v?embed_v=2&utm_source=embed" loading="lazy" title="Lesson 08 - Execute Activity with "Add to Index" Command" 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/cmayf5cu000p4up0j4u4twx6v?embed_v=2&utm_source=embed" loading="lazy" title="Lesson 08 - Execute Activity with "Add to Index" Command" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>

Randallkinard: /* "Submit Indexing Job" Content Type Object Command */

2026-05-15T13:07:39Z

"Submit Indexing Job" Content Type Object Command

← Older revision		Revision as of 08:07, 15 May 2026
Line 283:		Line 283:


	# Before we submit a job, we need to make sure an Activity Processing service is running for our Grooper repository. To verify, click the Machines folder in the Node Tree. With your machine selected, you should see an instance of a Grooper Activity Processing service is running. If this service is not installed and running, nothing will happen after we submit the indexing job.		# Before we submit a job, we need to make sure an Activity Processing service is running for our Grooper repository.
	# With that check done, let's execute the "Submit Indexing Job" object command of a Content Type, which in our case will be the a Content Model. Expand the Node Tree and select the "AI-Search" Content Model from the provided Project.		#* To verify, click the Machines folder in the Node Tree.
	# Right-click the "AI-Search" Content Model, and from the pop-out menu select "Search" then "Submit Indexing Job". Any and all Batch Folders that exist within this Grooper repository that are classified as Document Types that inherit from this Content Model will be considered for this job.		#* With your machine selected, you should see an instance of a Grooper Activity Processing service is running.
	# Notice the "Search Index Statistics" section in the "Submit Indexing Job" window. The provided Batch has 25 Batch Folders in it. ~~I have submitted one of the~~ Batch Folder's document data to the search index so the "Indexed Documents" property is showing "1". There are 25 Batch Folders from the provided Batch that are classified as Document Types that belong to this Content Model. Given that one has already been indexed, the "Added Documents" property will display "24". No Batch Folder's data that has already been indexed has changed, so "Updated Documents" will display "0". No indexed Batch Folders have been deleted, so the "Deleted Documents" property will display "0".		#* If this service is not installed and running, nothing will happen after we submit the indexing job.
	# With an understanding of the "Search Index Statistics" we can now click the "Execute" button to submit an indexing job. The Activity Processing service will pick this job up and process all of its tasks in the background. Feel free to go to the Jobs page to verify its status.		# With that check done, let's execute the "Submit Indexing Job" object command of a Content Type, which in our case will be the a Content Model.
			#* Expand the Node Tree and select the "AI-Search" Content Model from the provided Project.
			# Right-click the "AI-Search" Content Model, and from the pop-out menu select "Search" then "Submit Indexing Job".
			#* Any and all Batch Folders that exist within this Grooper repository that are classified as Document Types that inherit from this Content Model will be considered for this job.
			# Notice the "Search Index Statistics" section in the "Submit Indexing Job" window.
			#* The provided Batch has 25 Batch Folders in it.
			#* One Batch Folder's document data has been submitted to the search index so the "Indexed Documents" property is showing "1".
			#* There are 25 Batch Folders from the provided Batch that are classified as Document Types that belong to this Content Model.
			#* Given that one has already been indexed, the "Added Documents" property will display "24".
			#* No Batch Folder's data that has already been indexed has changed, so "Updated Documents" will display "0".
			#* No indexed Batch Folders have been deleted, so the "Deleted Documents" property will display "0".
			# With an understanding of the "Search Index Statistics" we can now click the "Execute" button to submit an indexing job.
			#* The Activity Processing service will pick this job up and process all of its tasks in the background.
			#* Feel free to go to the Jobs page to verify its status.
	# Once the job is complete, if you go to your search index in Azure, you'll notice there is much more data in the search index now as twenty-four more documents' data has been added.		# Once the job is complete, if you go to your search index in Azure, you'll notice there is much more data in the search index now as twenty-four more documents' data has been added.