Skip to main content
diagram

​
Suggestion Endpoint

​
Text Field Suggestions

Provides autocomplete suggestions for custom text fields by querying existing values from the database.
ParameterTypeDefaultDescription
fieldstringRequiredCustom field 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) vs. any keyword (OR logic)
Text field autocomplete is controlled by the global.suggestTextFields configuration property (default: true). When enabled, the system 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

Suggestion behavior is configurable at the project level:
PropertyTypeDefaultDescription
Keyword search mandatorybooleanfalseWhen enabled, you must provide keywords when searching for items to link
Fuzzy searchbooleantrueEnables fuzzy matching in the item suggester
Suggester result limitinteger20Maximum number of suggestions shown in dropdowns
Wildcard searchbooleantrueEnables wildcard searching with * and ? characters
All-field searchbooleanfalseSearches all fields of linked items instead of just primary fields
Project-level suggestion settings are configured in the Risksheet project properties. Contact your administrator to adjust these defaults.
Link columns use OData queries to search for linkable work items:
FeatureDescription
Minimum query length3 characters required before search executes
Search methodsubstringof match on work item ID and type
Dropdown arrowClick to browse all available items or toggle the suggestion dropdown
Empty field promptShows “Start typing” message when clicking dropdown on empty field
SEARCH_ALL tokenSpecial query that retrieves the full item list

​
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 new linked work items directly from the autocomplete dropdown:
PropertyTypeDefaultDescription
canCreatebooleantrueEnables “Add new <type>” option in autocomplete dropdown
The new item is created with the typed text as its title. 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 search
Duplicate preventionSelecting an already-linked item shows a toast notification
Local changesNewly created items appear in search results before saving
Change trackingBoolean changed flag enables dirty state indicators
Custom query filteringqueryFactory applies context-aware filters to narrow suggestions

​
Query Factory Integration

Columns can use a queryFactory to apply custom OData filters to autocomplete results: 
{
  "columns": [
    {
      "id": "linkedReqs",
      "header": "Requirements",
      "type": "multiItemLink",
      "queryFactory": "filterByProject"
    }
  ]
}
Query factories are registered via window.risksheet.queryFactories and enable context-aware filtering such as:
  • Restricting items to a specific project
  • Filtering by work item state or status
  • Applying business-logic constraints
See Query Syntax for query filter details.

​
Suggestion Validation

Suggested items are validated using configured validator logic:
ValidationBehavior
Valid suggestionDisplayed in dropdown as normal
Invalid suggestionFiltered out of results
Invalid user selectionCell marked with cell-invalid CSS class (red highlight)

​
Local Changes Integration

Autocomplete suggestions include items created in the current session but not yet saved to the server:
SourceBehavior
Server dataQueried via /risksheet/suggestion/ or OData endpoints
Local changesMerged into results from in-memory session state
CombinedBoth sources displayed in unified dropdown
This allows you to link to newly created items immediately without saving first.

​
Complete Example

{
  "global": {
    "suggestTextFields": true
  },
  "columns": [
    {
      "id": "failureMode",
      "header": "Failure Mode",
      "binding": "title",
      "type": "text"
    },
    {
      "id": "linkedReqs",
      "header": "Requirements",
      "binding": "linkedReqs",
      "type": "multiItemLink",
      "canCreate": true,
      "queryFactory": "filterByProject"
    },
    {
      "id": "mitigationTask",
      "header": "Mitigation",
      "binding": "mitigationTask",
      "type": "taskLink"
    }
  ]
}
In this configuration:
  • The failureMode text column shows autocomplete suggestions from existing failure mode values
  • The linkedReqs multi-item link column searches for requirements with a custom query filter and allows inline creation
  • The mitigationTask task link column provides autocomplete with uniqueness validation to prevent duplicate task assignments
Source Code
  • CellEditorFormatter.ts
  • TextEditor.ts
  • SuggestionServlet.java
  • AppConfig.ts
  • RisksheetProjectProperties.java