Page tree

This is the documentation of Xray Server. If you are looking for Xray Cloud, visit this page. Documentation of older versions of Xray Server is available in this page.

Skip to end of metadata
Go to start of metadata

This page list all the options available in the Miscellaneous configuration section.

Test Run Options

Options related to the execution of test issues.

Set final Test Run status

When this option is enabled, the overall Test Run status can be set directly, without depending on the status of manual Test steps or, in the case of Cucumber Scenario Outlines, Test examples.

Inline Execute Tests

When this option is enabled, Test Runs can be executed inline, directly from the Test Execution issue view page. This option is only available if the final Test Run Status (above) can be manually set.

When this option is enabled, the execution of tests is restricted to the Test Run's assignee.

Fail All Steps/Examples

When this option is enabled, all the Test Steps/Examples Statuses will be updated to FAIL whenever the status of a Test Run is changed to FAIL.

Restrict automated Test status

When this option is enabled, the status of automated Test Runs can't be set manually. It can only be modified through the import of automated test results action.

Can Edit TestRun Dates

When this option is enabled, the user can edit the Started On date in the Test Execution Details page. 


Defect Issue Links

Options related to the creation of Defect issue in the context of test execution.

Link Defects with Test

When this option is enabled, the defects created in the context of a test run are automatically linked to the Test being executed.

Link Defects with Test Execution

When this option is enabled, the defects created in the context of a test run are automatically linked to the Test Execution issue.

Link Defects with Requirement

When this option is enabled, the defects created in the context of a test run are automatically linked to the Requirement being tested.


Workflow statuses

Disallow executions of Tests with workflow statuses

Disallow Tests within certain workflow statuses from being executed or even added to Test Executions. Sometimes, a Test is still being written and should not be added to a Test Execution. In those cases, just indicate which Test workflow statuses are considered "not ready to be executed".

Disallow executions with workflow statuses

Choose the workflow statuses in which the Test Execution issues will not allow execution of Tests. For example, if you configure this list with the "Closed" status, then users are no longer able to execute Test Runs in this Test Execution issue when a Test Execution issue transitions to "Closed". 

In progress Test Execution workflow status

Choose what workflow status the test execution will transition to when a test run is executed.

Resolved Test Execution workflow status

Choose what workflow status the test execution will transition to when all the test runs are in a final status.

Resolution for Resolved Test Execution

Choose what resolution will be applied to the test execution. This option is only available if the Resolved Test Execution workflow status is not none. The resolution is only changed for status of type done.


Notifications

User Groups allowed to add/remove Xray Notifications

User Groups which are allowed to add/remove Xray notifications to the Notification Scheme in the project settings page, since it can affect other projects using the sameNotification Scheme.

Final Test Run statuses that may trigger notifications

Final Test Run statuses that may trigger the 'Test Run Status set to Final' or 'Precedent Test Run Status set to Final' events.


Hierarchical Test Organization

Enable Hierarchical Test Organization

When this option is enabled, the Test Repository and the Test Plan Board will be enabled and accessible from the top menu and the project sidebar.

Project Roles allowed to edit the Test Repository information

The project roles that are allowed to edit the Test Repository. If no role is specified, then every user is able to modify the Test Repository.


Automated Steps Library

Enable Automated Steps Library

When this option is enabled, the Automated Steps Library will be enabled and accessible from the top menu and the project sidebar.

Validate Cucumber Scenarios

When this option is enabled, the Cucumber Scenarios will be validated before creating or updating a test.


Defect Default Values

Environment

The defects created in the context of a test run are populated with the "Environment" value from the Issue Type selected in this field

Include Steps Table in Description

When this option is enabled, the description field of the defects created in the context of a manual test step result, will default to a table containing the steps of the test until the step where the defect is being created.

Include Version

When this option is enabled, the Affect Version field of the defects created in the context of a test run will be populated by the FixVersion value of the Test Execution.

Label

The defects created in the context of a test run are populated with the Label value from the Issue Type selected in this field


Miscellaneous

Display Pre-Condition section before Test Details

When this option is enabled, the Pre-Condition web panel on the Test issue view screen will be displayed above the Test Details panel.

Display Manual Test Steps table in short view

When this option is enabled, the cells of the Manual Test Steps table will be displayed in short-view mode. If this mode is enabled, the rows will have a limited height to allow for better page navigation. There is an expand option within each cell to view the complete content.

Delete test definition when changing Test type

When this option is enabled, the test definition will be deleted when changing Test Type. If this option is disabled, the test definition won't be deleted and it'll be possible to undo the Test Type change operation and keep the information.

User Groups allowed to add Xray Issue Types

User Groups that are allowed to add Xray Issue Types to a project in the project settings. If no user group is specified, then no one is able to add Xray issue types from the project settings page.


Cucumber Export Prefixes

When generating Cucumber .feature files, the issue keys are included as labels in the feature. This option allows you to prefix the generated label keys to identify the scenario with the following Jira issues:

  • Test
  • Pre-Condition
  • Test Set
  • Requirement

Cucumber Export Language

Language

Choose the language in which the automated Cucumber tests will be exported in. The default language is English.

Cucumber Export

Replace dash [ - ] with underscore [ _ ] when exporting issue keys as tags

When this option is enabled, the dashes in the issue keys included in the exported Cucumber feature files will be replaced by underscores. Enable this option if your testing framework does not support dashes in tags.

Generate features by requirements

When this option is enabled, one feature file will be generated for each requirement issue within the export context. Disabling this option will generate all tests in the same feature file, given that all tests also have the same background (pre-condition) or they have no background.


Bulk Operations

Options related to the execution of test issues.

Max Test Runs for bulk operations

Maximum number of Test Runs a user can select for bulk operations in the Test Execution view page (default  is 100).


Requirements Reports

Max number of requirements per report or gadget results

Maximum number of requirements that can be shown in the Overall and Historical Requirement Coverage reports/gadgets (default is 10000). If exceeded, then you need to adjust the filter being used or adjust this setting instead.


Tests per Test Plan

Max number of Tests per Test Plan


Sets the maximum number of Tests per Test Plan that will be allowed. Affects all new add operations and limits the previous that exceed this value. This is a soft validation that will not invalidate Test Plans that already have more tests than the number set in this configuration.

Xray REST API

Max results per request

Some endpoints results are paginated. This configuration defines the number of objects returned in each set of paginated results. Any try to make a REST API call that returns more than this number of results will result in a error.


Usage Metrics

Enable Xray Analytics

When this option is enabled, we will collect some anonymous data concerning general usage of Xray. This data will be sent to Xpand IT for internal usage only and will allow us to improve the overall user experience and existing features. Please read the privacy policy for more details.

  • No labels