Jira Configuration ¶

Jira settings must be configured in conQlude in order to enable Jira integration for specific projects. Users with conQlude Administration permissions can access Jira settings via Administration -> Projects.

Enabled¶

Jira integration may be disabled temporarily. This means all Jira-related information will be still visible, but new execution will not cause any changes in Jira.

Auto Upload¶

If Auto Upload is enabled, executions are automatically uploaded as soon as the test execution is complete. When Auto Upload is disabled, users must manually upload the executions.

URL¶

conQlude uses the Jira REST API for integration. This URL is the base URL of the Jira server, as typed into the browser. The URL should not include /rest at the end. For example: https://jira.company.com.

Authentication token¶

The authentication token to be used with the Jira REST API. This token must be a Basic Authentication token, as described in Jira documentation. It should be in the following format: Basic xxxxxx.

An authentication token may be generated from the Jira user's username and password, using base64 utility with following command:

1	echo -n username:password \| base64

Jira Project¶

This is the key of the Jira project where the test issues are defined. All Jira test issues, test executions, cycles and folders will be created in this Jira project. For example: DEV.

Product Version¶

Version of the product under test. All cycles, folders and test executions will be created for this version. A list of versions is available in Jira under Project Settings. For example: v1.0.

Custom Field: Cycle (Optional)¶

The Cycle custom field found in the Jira Settings page may be used to gather cycle information when creating a new test execution. The value of the field defined as a cycle field will be used to determine the test execution cycle. If not defined, cycle from the metadata will be used (see Creating Test Executions).

This setting's value must be the name of a custom fields.

Custom Fields: Product (Optional)¶

Like the Cycle custom field, a Product field may be defined to determine the folder for the test execution. If this field is not defined, Product from the metadata will be used (see Creating Test Executions).

This setting's value must be the name of a custom field.

Socket Timeout¶

The Socket Timeout specifies the Timeout value for calls to the Jira REST API in milliseconds. The default value is 10000 (10 seconds).

Custom Fields ¶

Each custom field must be defined with following properties:

Name - This may be used to refer to the field as cycle or product field.
Jira code - The code for a Jira field, for example, customfield_10400.
Metadata Name - The tag to used when extracting value from metadata (comment) lines in Feature File (see Test Metadata).
Default Value - May be used to define a constant value for all test executions. For example, if a field should mark a test as an automated test, the field may be set to true for all tests using the default value functionality. Generally, this should be empty for normal fields.
Field type - Declares the Jira field type.
- Multi-select fields may contain multiple values separated by a space or comma.
- Values containing space characters must be written in quotes. For example: #@ FEATURES: "Create Account" "Send Email".

Uploading¶

Selecting Auto upload from Configuration -> Jira Settings enables the automatic uploading of reports to Jira as soon as they are received by conQlude. If Auto upload is not selected, reports may be uploaded manually instead.

The results from the upload operation are visible in conQlude via Reports -> Jira Uploads report as well as the Execution Detail views. When the upload operation fails, the failure reason is also visible in these views.

Sources of Failure¶

Technical reasons, including:

Connection problems
Authentication problems
Permission problems

Data-related problems, including:

Missing fields such as reporter
Description or invalid values for fields such as component and version
- In this case, the upload operation may be manually retried using the upload button in these views