Context Variables - Nextedy Documentation

Variable Summary

Variable	Type	Availability	Description
`$item`	ModelObject	All entities	Primary work item accessor with property access methods
`$wi`	IWorkItem	Work item entities only	Legacy Polarion work item API for low-level operations
`$tx`	Transaction	All evaluations	Current transaction object for query operations
`$module`	IModule	Document-scoped entities	Document (LiveDoc) containing the work item; `null` for non-document entities
`$context`	PowersheetContext	All evaluations	Powersheet-specific context: project, document scope, query helpers
`$pObject`	IPObject	All entities	Raw Polarion persistent object

$item (ModelObject)

The primary accessor for work item data. Available for all entity types.

Property / Method	Return Type	Description
`$item.title`	`string`	Work item title
`$item.status`	`object`	Status object with `.id` property
`$item.author`	`object`	Author user object
`$item.created`	`datetime`	Creation timestamp
`$item.updated`	`datetime`	Last modification timestamp
`$item.uri`	`string`	Polarion URI for the work item

Example

$item.title - $item.status.id

Use $item as the primary work item accessor. It provides a higher-level API than $wi and is available for all entity types.

$wi (IWorkItem)

Legacy Polarion work item API. Only available when the entity is a work item (not for documents or other entity types).

Property / Method	Return Type	Description
`$wi.getLinkedWorkItems()`	`collection`	Returns all linked work items
`$wi.getCustomField(name)`	`object`	Returns custom field value by field ID
`$wi.getProjectId()`	`string`	Returns the project ID

Example

#set($links = $wi.getLinkedWorkItems())
$links.size() linked items

$wi is only set for work item entities. For Document or other non-work-item entity types, $wi is null. Use $item for cross-entity-type templates.

$tx (Transaction)

Current transaction object for transactional queries and read-only operations.

Property / Method	Return Type	Description
Transaction scope	object	Access to transaction-scoped data and queries

Example

#set($related = $trackerService.getWorkItemByUri($item.uri))
$related.title

Server-rendered templates should perform read-only operations only. Modifying data within a template evaluation can cause unexpected side effects.

$module (IModule)

The LiveDoc containing the current work item. null for entities not within a document.

Property / Method	Return Type	Description
`$module.moduleFolder`	`string`	Document folder/space path
`$module.moduleName`	`string`	Document name
`$module.space`	`string`	Polarion space identifier

Example

#if($module)
  Document: $module.moduleName in $module.moduleFolder
#else
  No document context
#end

Always check #if($module) before accessing module properties. Entities that are not contained within a document will have $module set to null.

$context (PowersheetContext)

Powersheet-specific context providing access to project scope, document scope, and query capabilities.

Property / Method	Return Type	Description
Project context	object	Current project information
Document scope	object	Current document filtering context
Query helpers	object	Query execution utilities
`$context.parameters`	map	The current sheet URL’s query parameters, keyed by name (`$context.parameters.<name>`). Starting with Powersheet 26.7.2.

Example

$context.projectId

The exact methods available on $context depend on the Powersheet version. Consult the server logs for available context properties.

`$context.parameters` — reading URL query parameters

Starting with Powersheet 26.7.2, a serverRender template can read the query parameters of the sheet’s own URL through $context.parameters. Each parameter present on the URL is available under $context.parameters.<name>, keyed by the name it has in the URL:

$!context.parameters.testrun

For a sheet opened at …&testrun=v13, $context.parameters.testrun resolves to the string v13. This lets a single data model drive different server-computed values from a shareable, bookmarkable link — the same URL parameters the sheet configuration reads client-side (see URL Parameters) are also visible to server-side rendering. Worked example. A test-status column normally shows a rolling summary of a test case’s most recent runs. Passing ?testrun=<id> on the URL narrows that column to a single run, so the sheet reports each test case’s result for that specific run rather than the last few. The template reads the run from the URL and branches on it:

#set($run = "$!context.parameters.testrun")
#if($run != "")
  ## …render only the result for the run named $run…
#else
  ## …render the default rolling summary…
#end

Because the run id lives in the URL, the narrowed view is shareable: send a colleague …&testrun=v13 and they see exactly the same slice.

Read a URL parameter with Velocity’s quiet reference form — $!context.parameters.testrun, with the ! right after the $. Plain $context.parameters.testrun renders the literal text $context.parameters.testrun into the cell whenever the parameter is absent from the URL (Velocity’s default behavior for any reference that resolves to null). The quiet form degrades to blank instead, which is what you want for an optional parameter.

$context.parameters only feeds values into a template; it does not relax the read-only contract. A serverRender script — including one driven by URL parameters — can read Polarion data but cannot modify it. Keep templates to read-only operations, as with any server-rendered property.

$pObject (IPObject)

The raw Polarion persistent object underlying the entity.

Property / Method	Return Type	Description
`$pObject.uri`	`string`	Polarion URI
`$pObject.contextId`	`string`	Context (project) identifier

Client-Side Context Variables

In addition to server-side Velocity variables, Powersheet supports client-side $context expressions for dynamic value resolution in YAML configuration.

Context Path	Description
`$context.document.id`	Current document path (`folder/name`)
`$context.source.document.component`	Source entity’s document component
`$context.source.project.id`	Source entity’s project ID

These are resolved at configuration processing time, not during Velocity template evaluation. See JavaScript Functions for client-side expressions.

Complete YAML Example

domainModelTypes:
  UserNeed:
    polarionType: userNeed
    properties:
      title:
      status:
      documentPath:
        serverRender: |
          #if($module)$module.moduleFolder/$module.moduleName#else(unscoped)#end
      authorName:
        serverRender: "$item.author.name"
      linkCount:
        serverRender: |
          #set($links = $wi.getLinkedWorkItems())
          $links.size()

Velocity Templates — template syntax and evaluation
Polarion Services — platform service variables
Properties — data model property definitions

​Variable Summary

​$item (ModelObject)

​Example

​$wi (IWorkItem)

​Example

​$tx (Transaction)

​Example

​$module (IModule)

​Example

​$context (PowersheetContext)

​Example

​$context.parameters — reading URL query parameters

​$pObject (IPObject)

​Client-Side Context Variables

​Complete YAML Example

​Related Pages

Variable Summary

$item (ModelObject)

Example

$wi (IWorkItem)

Example

$tx (Transaction)

Example

$module (IModule)

Example

$context (PowersheetContext)

Example

`$context.parameters` — reading URL query parameters

$pObject (IPObject)

Client-Side Context Variables

Complete YAML Example

Related Pages