Query Syntax - Nextedy Documentation

Query Types

Risksheet supports two query syntaxes:

Syntax	Prefix	Description
Lucene	(none)	Default Polarion query syntax for work item filtering
SQL	`SQL:(...)`	SQL queries for complex work item filtering

Lucene Query Basics

Lucene queries filter work items based on field values using standard Polarion query syntax.

Operators

Operator	Syntax	Example	Description
Equals	`field:value`	`type:risk`	Field equals exact value
NOT	`NOT field:value`	`NOT status:closed`	Field does not equal value
AND	`expr1 AND expr2`	`type:risk AND status:open`	Both conditions must match
OR	`expr1 OR expr2`	`type:risk OR type:hazard`	Either condition must match
Wildcard	`field:val*`	`title:brake*`	Wildcard matching
Quoted	`field:"value"`	`title:"Brake Failure"`	Exact phrase matching
Grouping	`(expr1 OR expr2)`	`(type:risk OR type:hazard) AND status:open`	Logical grouping

Common Fields

Field	Description	Example
`type`	Work item type	`type:risk`
`status`	Workflow status	`status:open`
`project.id`	Project identifier	`project.id:AutoSafety`
`module`	Document/module path	`module:"Risks/FMEA"`
`id`	Work item ID	`id:RISK-001`
`title`	Work item title	`title:"Brake Failure"`
`linkedWorkItems`	Linked item references	`linkedWorkItems:REQ-001`

Query Assembly

The final query is assembled by combining four components with AND logic:

Type filter — Work item types from dataTypes.<type>.types, combined with OR if multiple
Project scope — Current project identifier
Document scope — Current document/module path (quoted to handle spaces)
Custom query — Additional user-defined conditions from the query property

Empty conditions are automatically skipped. At least one work item type must be specified or the system returns an error.

Query in Configuration

Data Type Query

The dataTypes configuration uses the query property to add custom filtering to the generated query:

{
  "dataTypes": {
    "risk": {
      "types": ["fmea_risk"],
      "role": "relates_to",
      "query": "NOT status:rejected"
    },
    "task": {
      "types": ["mitigation"],
      "role": "mitigates",
      "query": "NOT status:closed"
    }
  }
}

Property	Type	Default	Description
`dataTypes`	`object`	`{}`	Configures risk and task data types including query factories, work item types, roles, and menu visibility
`dataTypes.<name>.types`	`array`	Required	Work item types to include. Multiple types combined with OR logic
`dataTypes.<name>.query`	`string`	`""`	Custom Lucene query fragment appended with AND logic
`dataTypes.<name>.role`	`string`	See application	Link role used for item relationships

Escaped Quotation Marks in JSON

When embedding queries with quotation marks inside risksheet.json, use backslash escaping:

{
  "dataTypes": {
    "risk": {
      "types": ["fmea_risk"],
      "query": "customField:\"specific value\" AND category:\"safety\""
    }
  }
}

Use \" to include quotation marks within JSON string values. This is standard JSON escaping and applies to all query strings in risksheet.json.

SQL Query Support

Risksheet supports SQL queries for complex filtering scenarios using the SQL:(...) prefix:

{
  "dataTypes": {
    "risk": {
      "query": "SQL:(SELECT wi FROM WorkItem wi WHERE wi.project.id = 'AutoSafety')"
    }
  }
}

SQL query syntax and available tables/fields depend on your Polarion server version. Verify supported SQL constructs in your environment before deploying.

Query Factory

Query factories provide dynamic query filtering through custom JavaScript functions registered on the window.risksheet.queryFactories object. They enable context-aware filtering of linked items in autocomplete dropdowns.

{
  "columns": [
    {
      "binding": "linkedRequirement",
      "header": "Linked Requirement",
      "type": "itemLink",
      "queryFactory": "requirementFilter"
    }
  ]
}

window.risksheet = window.risksheet || {};
window.risksheet.queryFactories = window.risksheet.queryFactories || {};
window.risksheet.queryFactories["requirementFilter"] = function(column, item) {
  return "type:requirement AND status:approved";
};

Feature	Description
Autocomplete filtering	Customizes which items appear in autocomplete suggestion dropdowns
Context-aware search	Factory function receives the current column and row item, enabling dynamic filtering
Link editor integration	Applied to item link, multi-item link, and task link column editors

See JavaScript API for the full query factory API.

Document Path Handling

Document IDs with _default/ prefix (default modules) have the prefix automatically stripped before query construction. Document paths containing spaces or special characters are automatically quoted in the generated query.

Autocomplete Search Behavior

The autocomplete suggestion system uses queries to search for matching work items:

Parameter	Type	Default	Description
Fuzzy search	Boolean	See application	Enables approximate matching for spelling variations
Wildcard search	Boolean	See application	Allows `*` wildcard characters in search terms
Keyword matching	Boolean	See application	When enabled, all search terms must be present (AND logic)
Result limit	Number	`50`	Maximum number of suggestion results returned
Minimum query length	Number	`3`	Minimum characters before autocomplete activates

Suggestions are automatically scoped to the current project. Cross-project suggestions are not available in the default autocomplete. Newly created items that have not been saved appear in suggestions for the current session.

See Suggestion and Autocomplete API for the full API reference.

Complete Example

A full configuration demonstrating query usage across data types and columns:

{
  "dataTypes": {
    "risk": {
      "types": ["fmea_risk"],
      "role": "relates_to",
      "query": "NOT status:rejected AND customField:\"productFamily_A\""
    },
    "task": {
      "types": ["mitigation", "verification"],
      "role": "mitigates",
      "query": "NOT status:closed"
    }
  },
  "columns": [
    {
      "binding": "linkedRequirement",
      "header": "Requirement",
      "type": "itemLink",
      "queryFactory": "requirementFilter",
      "canCreate": true
    },
    {
      "binding": "linkedHazard",
      "header": "Hazard",
      "type": "itemLink",
      "queryFactory": "hazardFilter"
    }
  ]
}

This configuration:

Loads FMEA risk items for productFamily_A, excluding those with rejected status
Loads both mitigation and verification task types, excluding closed items
Provides item link columns for requirements (with creation) and hazards, each with custom query factory filtering

Configuration Properties Index — all configuration properties
Risksheet.json Format — configuration file structure
Suggestion and Autocomplete API — autocomplete endpoint reference
JavaScript API — query factory registration
Item Link Columns — item link column configuration
Top Panel Template — bridging server data for query factories

Sources

Support Tickets

#6657

Source Code

QueryBuilder.java
AppConfig.ts
MultiItemLinkEditor.ts
SuggestionServlet.java
OpenInTableCommand.ts

​Query Types

​Lucene Query Basics

​Operators

​Common Fields

​Query Assembly

​Query in Configuration

​Data Type Query

​Escaped Quotation Marks in JSON

​SQL Query Support

​Query Factory

​Document Path Handling

​Autocomplete Search Behavior

​Complete Example

​Related Pages

Query Types

Lucene Query Basics

Operators

Common Fields

Query Assembly

Query in Configuration

Data Type Query

Escaped Quotation Marks in JSON

SQL Query Support

Query Factory

Document Path Handling

Autocomplete Search Behavior

Complete Example

Related Pages