| Table of Contents |
|---|
...
2. On the right of the toolbar, click the Configure Data Sources icon. The data sources configuration opens.
...
3. In the Data Sources Configuration window, in the Data Sources tab, select JIRA. The Step 2. Configure Source pane opens.
...
4. On the Step 2 pane configure JIRA Data Source.
...
1. Configure credentials
There are 3 4 options of Jira integration:
Basic - authentification flow, which supports default credentional setting.
OIDC - Open ID Connect authentication protocol for Jira based on OAuth 2.0.
OAuth 1.0 - is an authentication protocol, which allows to integrate Perf with Jira that support OAuth 1.0 or if you have security concerns around sharing login credentials with third-party applications.
1.1 Basic authentication
The following information must be provided:
URL - JIRA instance URL (without a project key)Personal Access Token - is an API token generated by Jira (server version) and linked to particular user profile. This API token provide access to Jira API. Token can has expiration and can be revoked any time by user.
1.1 Basic authentication
The following information must be provided:
URL - JIRA instance URL (without a project key);
Login (or e-mail);
Password or API token;
Project key: it allows you entering more than one project key but overall number of tickets from all projects should not exceed 120.000 otherwise data load will take too long and may fail;
Optional. Issue filter ID or JQL. Filter should be public (see Obtaining Jira Filter ID );
Optional. Advanced Settings to tune data load from JIRA;
Optional. Requests per second - how many requests to do in a second to get tickets from Jira, expected value is from 1 to 1000;
Optional. Tickets per request - how many tickets to get from JIRA during a request, expected value is from 1 to 100, by default it is 50.
...
Token URL - URL of your Jira instance's authorization server. This is typically in the format of
https://<your-jira-instance-url>/oauth/token.Client ID - unique identifier assigned to your client application by the Jira instance.
Login - login/Jira username
Password - Jira passwor
...
1.4 Personal Access Token (PAT)
Go to your Project, Configure Data Source
Click on the "Add Data Source" button and select "Jira" from the list of available datasources.
Choose Basic Auth as Type of Integration
Put jira-api-token as a Login and your PAT as Password/API token
Press 'Check Connection'
...
| Expand | ||
|---|---|---|
| ||
JIRA Cloud vs. ServerJIRA Cloud If you use JIRA Cloud (for example, https://<your-subdomain>.atlassian.net), follow the rules:
JIRA Server If you use a JIRA Server, use a regular login and password. CAPTCHAAfter several unsuccessful attempts to log in, JIRA refuses all subsequent attempts without passing the CAPTCHA challenge. To resolve the persistent CAPTCHA:
Default credentialsIf you enter an URL that coincides with any URL from Default Credentials, no password/login is needed. For more information, see PERF Administration. |
Check connection
Once you completed credentials configuration, check the connection. PERF will check connectivity to your Jira and get some metadata from it.
...
2. Workflows Interpretation
Workflows represent processes on your project and give you control over the project's progress. PERF simplifies workflows by distributing each of them into three different buckets.
At this step issue statuses pulled from a JIRA project are to be distributed into 3 buckets: To Do, In Progress, and Done.
To Do: for statuses meaning the item is not ready for development.
In Progress: for statuses meaning the item is in development.
Done: for statuses meaning the item satisfies the "Definition of Done" criterion in a project.
...
Change is applied immediately, data load is unnecessary.
For more details, see Include Sub-Items into Metrics Calculation.
...
Jira workflows could be changed and then a new status could be added or removed the existing one. To manage changes in the configuration you can choose between automatic and manual workflows update.
Workflow Updates Type | Description |
|---|---|
Automatically | If any JIRA workflow was changed, then the PERF application after next data load does the following:
|
Manually |
|
...
3. Configure fields mapping
Custom fields in Jira enable collecting additional information not available in the default system fields.
PERF allows using custom fields:
to calculate metrics with custom fields (e.g., story points estimations, person-hours estimations, severity, priority, etc.);
to build custom metrics over the data collected in the custom fields;
to use custom fields in PERF and make accurate calculations, defining where the project saves the required data.
To map metrics attribute with custom fields, select the needed attribute in the table and choose the corresponding custom field. Otherwise, PERF will use a standard system field for the parameter.
...
If you plan to build custom metrics over data with custom fields, we recommend adding required custom fields to the table to be available in the "Fields" tab of advanced custom metrics.
...
| Info |
|---|
If a custom field’s value is longer than 500 symbols, then PERF will save only 500 symbols. |
...
While using the Add new rule or ADD CRITERION buttons, pay attention to multiple conditions and how they logically interact with each other.
...
Button | Logical Operator | Description |
|---|---|---|
ADD CRITERION | AND | A new criterion is connected to existing criteria inside the rule by logical AND |
Value | OR | Multiple values for a criterion are connected by logical OR |
Add new rule | OR | A new rule is a set of criteria, which is connected to other rules by the logical OR |
4. Configure scope management
...
PERF uses information provided at this step to properly calculate metrics related to the productivity area such as follows:
Parameter | Impacted metric |
|---|---|
Reaction Time Target | |
Resolution Time Target |
7. Complete configuration process
...