Search Import

The SearchIndexQuery class encapsulates all parameters needed to perform a search against a Grooper AI Search index.

Key Features:

• Specify the target search index via IndexName.
• Perform full-text search using Lucene syntax with the Search property.
• Apply fielded filtering using OData filter syntax via the Filter property.
• Control result ordering with the OrderBy property, supporting ascending/descending options.
• Scope results to all, current page, or selection using the ResultSetScope enum.
• Integrates with Grooper UI editors for query construction and validation.

Can be one of the following values:

The Level property determines which objects are imported relative to each search result:

• 0: Import the documents or documents directly returned by the search result set.
• Positive values: Import descendant documents at the specified level below each search result. For example, Level = 1 imports immediate children, Level = 2 imports grandchildren, and so on.
• Negative values: Import ancestor documents at the specified level above each search result. For example, Level = -1 imports the immediate parent, Level = -2 imports the grandparent, etc.

Examples:

• If the search returns documents and Level = 0, those documents are imported.
• If Level = 1, the direct children of each result are imported.
• If Level = -1, the parent of each result is imported.

This property enables flexible selection of items to import, supporting scenarios such as importing entire documents, specific sections, or related parent/child folders.

The SamplesPerType property limits the number of items imported for each unique Content Type found in the search results.

• If set to a positive integer, only up to that many items will be imported for each content type. Once the limit is reached for a given type, additional items of that type are skipped.
• If SamplesPerType is null, zero, or less than zero, no per-type limit is enforced and all matching items are eligible for import (subject to other limits such as MaxItems).

Examples:

• If the search result contains 200 invoices and 50 contracts, and SamplesPerType = 10, only 10 invoices and 10 contracts will be imported.
• If not set, all items matching the search and other criteria will be imported, regardless of content type.

This property is useful for sampling, quality control, or limiting the batch size by content type, especially when working with large or imbalanced result sets.

When 'Sparse Import' is enabled, Grooper creates a Content Link for each imported document instead of copying the file content into the repository. This reduces storage requirements and speeds up imports, especially for large volumes. Content can be loaded on demand later in the process, and all Grooper activities work with sparse documents as with normal documents.

Use 'Skip Count' to restart an import that was previously stopped, or to perform incremental imports by skipping items already processed.

Use 'Max Items' to limit the number of documents or folders imported in a single operation. This can be combined with 'Skip Count' for incremental or staged imports.

The 'Batch Creation' property defines rules for grouping imported items into batches, including batch size, structure, and organization. Adjust these settings to match your workflow and processing requirements.

The 'Batch Name Options' property allows you to configure naming conventions for new batches, including dynamic values based on process, content type, or other metadata.

Assigns a Content Type to each imported document or folder. This controls classification, data extraction, and downstream processing. Set this property to ensure imported content is correctly identified and processed in Grooper.