Customize the Context Menu

When you right-click a cell in the Risksheet grid, the context menu displays built-in actions depending on the cell context and grid state:

Action	When Available	Description
Open Row Item	Always	Opens the current row’s work item in Polarion’s item editor
Open [Column] Item	Cell contains a valid item link	Opens the linked work item for that column (the label includes the column name, e.g. Open Item/Func Item …)
Open Task Item	Cell contains a task link	Opens the task work item; label uses `dataTypes.task.name` if configured
New [Level] Item	Editable grid, `showInMenu: true`	Creates a new work item at the selected hierarchy level (e.g. New Item, New Failure mode, New Cause)
Overwrite Row Item	Item has `systemReferenceType: "reference"`	Converts a referenced item to overwrite mode for local editing
Remove Row Item	Non-read-only grid	Removes the selected row from the grid
Freeze Pane	Always	Freezes columns to the left of the current column
Unfreeze Pane	Columns are frozen (`frozenColumns > 0`)	Removes column freezing
Copy link to row	Always	Copies a direct link to the current row to the clipboard
Debug	Developer/debug mode active	Outputs cell diagnostic info to the browser console. Debug mode is a developer/runtime mode and is not enabled through the sheet configuration (see the note below).

Risksheet exposes an extensibility point through window.risksheet.customContextMenuActions that allows top panel scripts to register additional menu items. The canonical registration pattern uses string function names (resolved against the global window object at runtime) for both the enable and execute hooks.

Step 1 — Define Action Functions

Create JavaScript functions on the global window object. Each custom action needs an enable function (controls when the item is active) and an execute function (runs when clicked):

// Enable function: receives the current row item, returns boolean
window.isReportEnabled = function(item) {
  return item && item.type === "risk";
};

// Execute function: receives the current row item
window.generateRiskReport = function(item) {
  alert("Generating report for: " + item.title);
};

window.isCopyEnabled = function(item) {
  return item !== null;
};

window.copyItemToClipboard = function(item) {
  navigator.clipboard.writeText(item.id + ": " + item.title);
};

Step 2 — Register the Actions

Add your custom actions to the customContextMenuActions array. Always reference the enable and execute hooks by function name as a string — Risksheet looks the names up on window when the menu opens:

window.risksheet = window.risksheet || {};
window.risksheet.customContextMenuActions = [
  {
    label: "Generate Risk Report",
    enableFn: "isReportEnabled",
    executeFn: "generateRiskReport"
  },
  {
    label: "Copy to Clipboard",
    enableFn: "isCopyEnabled",
    executeFn: "copyItemToClipboard"
  }
];

Each custom action object requires three properties:

Property	Type	Description
`label`	`string`	Text displayed in the context menu
`enableFn`	`string`	Name of a `window` function that returns `true` to enable the action
`executeFn`	`string`	Name of a `window` function that runs when the action is clicked

enableFn and executeFn must be strings naming a function on window. Assigning inline function expressions (for example enableFn: function(item) { ... }) is not the supported registration form and the menu action will not appear. Define each function on window first, then reference it by name.

Step 3 — Load the Script

Place the script in your top panel configuration (risksheetTopPanel.vm) so it loads when Risksheet initializes:

<script>
  // Define functions on window, then register actions
  window.isReportEnabled = function(item) { return item && item.type === "risk"; };
  window.generateRiskReport = function(item) { /* ... */ };

  window.risksheet = window.risksheet || {};
  window.risksheet.customContextMenuActions = [
    { label: "Generate Risk Report",
      enableFn: "isReportEnabled",
      executeFn: "generateRiskReport" }
  ];
</script>

Because enableFn and executeFn are resolved by name, functions defined inside closures, IIFEs, or module scopes will not be found at runtime and the menu action will silently fail. Always attach them to window.

The “New [Level] Item” menu options are generated dynamically from the levels configuration in the sheet configuration. Use showInMenu to control which levels appear:

levels:
  - name: Failure Mode
    controlColumn: systemItemId
    zoomColumn: systemItemId
    showInMenu: true
  - name: Cause
    controlColumn: cause
    zoomColumn: cause
    showInMenu: true
  - name: Internal Reference
    controlColumn: reference
    zoomColumn: reference
    showInMenu: false

Setting showInMenu to false hides that level from the context menu while keeping it functional in the grid hierarchy. This is useful for levels populated automatically or through imports. The “Open Task Item” menu label dynamically reflects the configured task type name. Set dataTypes.task.name in the sheet configuration:

dataTypes:
  task:
    name: Mitigation Action
    type: mitigationAction
    role: mitigates

With this configuration, the context menu displays “Open Mitigation Action” instead of the default “Open Task”.

Overwrite Row Item

The “Overwrite Row Item” action converts a referenced item to overwrite mode, enabling local modifications to be saved back to the source. This action appears only when the selected item has systemReferenceType set to reference.

When Debug is available in the context menu, it logs the ghost status, column ID, cell value, full item object, and comparison manager state to the browser console — invaluable when diagnosing why an overwrite action is unavailable.Debug mode is a developer/runtime mode and is not enabled through the sheet configuration. Setting debug: true in the global section has no effect (the key is silently ignored), and there is no appConfig.debug setting that turns it on.

Triggering Polarion document workflow transitions (for example, changing document status from within Risksheet) is not provided as a built-in menu item. Use the customContextMenuActions extensibility point to call the appropriate Polarion endpoint from your custom function.

Verify Your Changes

After configuring custom context menu actions:

Reload the Risksheet page to load your top panel script changes.
Right-click on a grid cell — you should now see your custom menu items alongside the built-in actions.
Verify that the enableFn condition correctly enables and disables the action based on the selected item.
Check the browser console for errors if a custom action does not appear (a common cause is a function defined inside a closure rather than on window).

Default Context Menu Actions

Register Custom Context Menu Actions

Step 1 — Define Action Functions

Step 2 — Register the Actions

Step 3 — Load the Script

Control New Item Menu Options

Customize Task Menu Labels

Overwrite Row Item

Verify Your Changes

See Also

​Default Context Menu Actions

​Register Custom Context Menu Actions

​Step 1 — Define Action Functions

​Step 2 — Register the Actions

​Step 3 — Load the Script

​Control New Item Menu Options

​Customize Task Menu Labels

​Overwrite Row Item

​Verify Your Changes

​See Also

Default Context Menu Actions

Register Custom Context Menu Actions

Step 1 — Define Action Functions

Step 2 — Register the Actions

Step 3 — Load the Script

Control New Item Menu Options

Customize Task Menu Labels

Overwrite Row Item

Verify Your Changes

See Also