Configuration Properties

Configuration options

The Risksheet is configurable in two places:

1. Global / Project-level configuration - as described in this article
2. Document / Document template specific configuration - see the detailed article here

The following properties can be defined in (Project or Global)  Administration > Configuration Properties

TABLE OF CONTENTS

• Disable the check of work Item permissions
• Enable Branching support
• Enable "Configure" action only for project administrators
• Enable editing referenced work items in Risksheet
• Enable field-based access control
• Enable multiple link roles for item link columns
• Freeze downstream items
• Improve loading times
• Load tasks from a specific document
• Open or compare the Risksheet with document baselines easily
• Perform a full search
• Risk Document Type
• Risksheet Template
• Suggester - fuzzy searching
• Suggester - search for complete words
• Suggester - use AND / OR between keywords

Disable the check of work Item permissions

Disable check of work item permissions, this is useful when custom set permissions are in use, and nextedy.risksheet.checkInstanceFieldPermissions is set to 'true'.

Property: nextedy.risksheet.checkPrototypePermissions=false

Default: true

Enable Branching support

Enable support for Polarion branched documents. More on this in the article here.

Property: nextedy.risksheet.branchingSupport=true

Default: false

Enable "Configure" action only for project administrators

Only Project administrators will be able to configure the Risksheet.

Property: nextedy.risksheet.disable_admin_check=true

Default: false

Enable editing referenced work items in Risksheet

Supported since version 23.3.3.

By default, referenced items are read-only on branched Risksheet. 

It is now possible to override this behavior and make them editable. More information on this topic here.

Property: nextedy.risksheet.editableReferencedWorkItems=true 

Default: false

Enable field-based access control

By default disabled due to pending performance tests. 

Property: nextedy.risksheet.checkInstanceFieldPermissions=true

Default: false

Enable multiple link roles for item link columns

Supported since version 24.2.2.

Enabled by having them comma-separated in types in Risksheet configuration.

Property: nextedy.risksheet.checkLinkRoleCompliance=true

Default: false

Freeze downstream items

Option to freeze downstream items at the time of document baseline revision.

By default, downstream items (e.g., linked tasks) always reflect their latest version even when a document is branched at a specific revision.

With the new property, you can lock the downstream context to the state as it was at the moment the revision was created, making the branched document non-editable and true to the snapshot.

Property: nextedy.risksheet.downstreamFromRevision=true

Default: false

Improve loading times

Supported since version 24.8.5.

When working with large Risksheet documents (AKA modules), performance can be hindered by the system checking if work items are editable, which involves resolving the parent document.

If your permission schema is defined at the document level and does not require item-level checks, this will streamline the process by bypassing item-level edit checks, relying solely on document permissions instead.

Property: nextedy.risksheet.moduleOnlyPermissions=true

Default: false

Load tasks from a specific document

Supported since version 23.8.3.

Enable this if you need to load tasks only from a specific document, and not just user the document property to control the suggestion box. It supports target documents with referenced items as well.

Property: nextedy.risksheet.loadTasksFromDocument=true

Default: false

Open or compare the Risksheet with document baselines easily

Supported since version 24.2.0.

Load project baselines optionally. Menu > Document > Show Baselines.

Property: nextedy.risksheet.includeProjectBaselines=true

Default: false

Perform a full search

Perform a full search (not searching id & title only) when searching for items in the itemLink columns.

Property: nextedy.risksheet.isSearchAllFieldsWhenSearchingLinkedItems=true

Default: false

Risk Document Type

Define what Document type(s) represent risk analysis. These and only these documents will be listed on the Risksheet tool page.

Property: nextedy.risksheet.riskDocumentType=riskSpecification

Default: riskSpecification

Risksheet Template

Configure the path to the document that is being used as a template to create new risk analyses.

Property: nextedy.risksheet.risksheetTemplatePath=Risks/Risk Specification

Default: Risks/Risk Specification

Suggester - fuzzy searching

When a user is working with the string/text fields, the Risksheet is suggesting the previous values from other risk analyses. You may need to configure whether the suggester should perform a so-called similarity or fuzzy search to find also "similar" words.

Property: nextedy.risksheet.isSuggesterFuzzySearching=true

Default: true

Suggester - search for complete words

When a user is working with the string/text fields, the Risksheet is suggesting the previous values from other risk analyses. You may need to configure whether the suggester should perform a search so that it expects the words not to have been fully typed. In this case, it searches for words that start with the keywords typed.

Property: nextedy.risksheet.isSuggesterWildcardSearching=true

Default: true

Suggester - use AND / OR between keywords

When a user is working with the string/text fields, the Risksheet is suggesting the previous values from other risk analyses. You may need to configure whether the suggester is searching in a way that each keyword must be there, or if it tries to find the best match, even if some keywords are missing.

Property: nextedy.risksheet.isSuggesterKeywordsMandatory=true

Default: false

For any assistance, please don’t hesitate to reach out by submitting a ticket here.