Skip to main content
diagram

Text Field Suggestions

When you type in a text column, Risksheet queries the server for existing values used in the same field on other risk items. This makes it easy to reuse terminology and keep the analysis consistent.

Request Parameters

The autocomplete request from the grid carries the following parameters. They are produced automatically by the editor.
ParameterTypeDefaultDescription
fieldstringrequiredField identifier to suggest values for
querystringrequiredPartial input text to match against
typestringnoneWork item type filter for type-specific suggestions
projectstringrequiredPolarion project identifier (auto-scoped)
limitinteger50Maximum number of suggestion results returned
fuzzybooleantrueEnable fuzzy matching for approximate searches
starbooleantrueEnable wildcard search with * characters
allbooleanfalseRequire all keywords to match (AND logic) instead of any keyword (OR logic)
Text field autocomplete is controlled by the global.suggestTextFields property in the sheet configuration (default: true). When enabled, the server queries existing field values and suggests matching entries as you type.

Search Behavior

FeatureDescription
Fuzzy searchMatches values even with minor typos or spelling variations
Wildcard searchUse * as a wildcard to match partial text (e.g. *brake* matches Brake Failure)
Keyword filteringWhen all is true, all search terms must appear in results (AND logic)
Project scopingSuggestions are automatically scoped to the current project
Column-specificEach column provides suggestions tailored to its field type
Type-based filteringSuggestions vary based on the work item type being edited

Project-Level Configuration

Several aspects of suggestion behavior are configured per Polarion project under Administration > Nextedy Risksheet > Setup. These defaults apply across every Risksheet document in the project unless overridden in the sheet configuration.
PropertyTypeDefaultDescription
nextedy.risksheet.isSuggesterKeywordsMandatorybooleanfalseWhen enabled, you must provide keywords when searching for items to link
nextedy.risksheet.isSuggesterFuzzySearchingbooleantrueEnables fuzzy matching in the item suggester
Suggester result limitinteger20Maximum number of suggestions shown in dropdowns
nextedy.risksheet.isSuggesterWildcardSearchingbooleantrueEnables wildcard searching with * and ? characters
All-field searchbooleanfalseSearches all fields of linked items instead of just the primary fields
Project-level suggestion settings are configured in the Polarion project administration. Contact your administrator to adjust these defaults.
Link columns (such as itemLink and multiItemLink) use the server’s search interface to find linkable work items. All data comes from Polarion under the current user’s authorization — Risksheet does not cache a separate copy.
FeatureDescription
Minimum query length3 characters required before the search executes
Search methodSubstring match on work item ID, title, and configured fields
Dropdown arrowClick to browse all available items or toggle the suggestion dropdown
Empty field promptShows “Start typing” when clicking the dropdown on an empty field
SEARCH_ALL tokenSpecial query that retrieves the full item list (when supported)

Auto-Selection

When autocomplete returns exactly one matching item for non-task columns, the system automatically selects it. This speeds up data entry for unambiguous searches.

Inline Item Creation

When canCreate is true on a link column, you can create a new linked work item directly from the autocomplete dropdown. The new item is created with the typed text as its title.
PropertyTypeDefaultDescription
canCreatebooleantrueEnables the “Add new <type>” option in the autocomplete dropdown
A global switch also exists on the downstream task data type: when dataTypes.task.canCreate is set to false, no new task items can be created from any column — users can only link to existing items from a library. The multi-item link editor extends the autocomplete system for columns that reference multiple linked work items.
FeatureDescription
Minimum query length3 characters required to trigger the search
Duplicate preventionSelecting an already-linked item shows a toast notification
Local changesNewly created items appear in search results before saving
Change trackingA changed flag enables dirty-state indicators
Custom filteringA queryFactory applies context-aware filters to narrow suggestions

Query Factory Integration

Columns can use a queryFactory to apply a custom Lucene query to autocomplete results. The factory function receives an info object with context data and returns a Lucene query string that filters which work items appear in the dropdown.
columns:
  - id: linkedReqs
    header: Requirements
    type: multiItemLink
    bindings: linkedReqs
    typeProperties:
      linkRole: relates_to
      linkTypes: requirement
      queryFactory: filterByProject
Query factories are defined in the top-level queryFactories section of the sheet configuration and enable context-aware filtering such as:
  • Restricting items to a specific project or document
  • Filtering by work item state, status, or custom field value
  • Reading values from the top panel (for example, a dropdown the user has selected) and folding them into the query
See Query Syntax for the supported filter expressions.

Suggestion Validation

Suggested items can be validated through column configuration. The grid uses the result to decide whether a suggestion is offered, accepted, or marked as invalid.
ValidationBehavior
Valid suggestionDisplayed in the dropdown as normal
Invalid suggestionFiltered out of the results
Invalid user selectionThe cell is marked with the cell-invalid CSS class (red highlight)

Local Changes Integration

Autocomplete results include items created in the current session but not yet saved to Polarion.
SourceBehavior
Server dataQueried from the Polarion work item store
Local changesMerged in from the in-memory session state
CombinedBoth sources are displayed in a unified dropdown
This lets you link to newly created items immediately, without first saving the document.

Complete Example

global:
  suggestTextFields: true
columns:
  - id: failureMode
    header: Failure Mode
    bindings: title
    type: text
  - id: linkedReqs
    header: Requirements
    bindings: linkedReqs
    type: multiItemLink
    canCreate: true
    typeProperties:
      linkRole: relates_to
      linkTypes: requirement
      queryFactory: filterByProject
  - id: mitigationTask
    header: Mitigation
    bindings: task.id
    type: taskLink
In this configuration:
  • The failureMode text column shows autocomplete suggestions from existing failure mode values used in the same project.
  • The linkedReqs multi-item link column searches for requirement work items with a custom query filter and allows inline creation.
  • The mitigationTask task link column provides autocomplete with uniqueness validation to prevent duplicate task assignments.
Last modified on July 10, 2026