Search Page

The CreateBatch command enables users to generate a new batch from documents or items returned by a search, with flexible import settings and batch creation options.

Key Features:

• Uses the ImportSettings property to configure how items are imported into the new batch.
• Supports importing all results, the current page, or a specific selection from the search results.
• Integrates with Grooper's import providers to control batch naming, structure, and content.

Usage Notes:

• Use this command to isolate and process a subset of documents identified by a search, without affecting the original batch or folder.
• The ImportSettings property allows customization of batch creation, including naming, folder structure, and import provider options.
• This is useful for workflows that require ad-hoc batch creation, quality control, or targeted processing of search results.

This command is typically used in review, exception handling, or reprocessing scenarios where only certain documents need to be grouped and processed as a new batch.

The SubmitJob command enables users to create and submit processing jobs from search results, with configurable options for activity, scope, priority, and job size.

Key Features:

• Assigns a Code Activity to the processing job.
• Allows selection of processing scope (e.g., Folder or Page).
• Supports specifying the folder level for task submission.
• Enables setting task priority and processing queue.
• Batches tasks into jobs of a configurable size.

Usage Notes:

• Use this command to process only the items returned by a search, rather than an entire batch or folder.
• The Level property controls whether tasks are submitted for the selected items, their children, or their ancestors.
• Negative Level values can be used to target ancestor folders of the search results.
• Priority determines the order in which jobs are processed (lower values are processed first).

This command is typically used in review or quality control workflows where only a subset of documents require additional processing.

The AssistantChat command allows users to interact with an AI Assistant whose responses are scoped to the documents or items returned by the current search.

Key Features:

• Selects an AI Assistant configured for the current search index.
• Supports providing custom instructions and retrieval instructions for the chat session.
• Filters the assistant's context to only the selected or filtered search results.
• Enables context-aware Q&A, summarization, and analysis of search result documents.

Usage Notes:

• Use this command to ask questions, request summaries, or perform analysis on a subset of documents without leaving the search page.
• The Instructions and RetrievalInstructions properties allow for session-specific customization of assistant behavior and retrieval logic.
• The filter generated by this command ensures that the assistant only considers the relevant documents, improving the accuracy and relevance of responses.

This command is ideal for review, research, or quality control workflows where targeted, AI-powered insights are needed on filtered document sets.

The Download command provides a configurable way to export or download the results of a search query from the Search Page in a variety of formats.

Key Features:

• Allows users to select the desired download format (such as CSV, Excel, JSON, or custom formats) via the Format property.
• Integrates with the Search Page UI, enabling quick export of all results, the current page, or a selection of items.
• Uses the selected DownloadFormat to generate the output stream, which can be saved or delivered to the user.
• Supports extensibility by allowing custom DownloadFormat implementations for specialized export needs.

Usage Notes:

• Before downloading, choose the appropriate format in the UI. The available formats are determined by the configured DownloadFormat options.
• The exported file will include all fields and data as defined by the selected format.
• This command is commonly used for reporting, data extraction, sharing search results, or integrating with external systems.
• If the current configuration results in zero documents, an exception will be thrown to alert the user.

This button will open the "Change Repository" dialog box. The Object List of this dialog box will be populated by connections to Grooper repositories established in GCC (Grooper Command Console). Selecting an entry other than the current active repository and pressing the OK button will change the environment you are viewing and interacting with for all Grooper pages to the newly selected repository.

This button will open a new tab in your browser pointed at Grooper Help. The destination within the Grooper Help page will change depending on what object you have selected in the Tree Viewer.