Mapping configuration
After Streak Connector for Jira has been successfully installed, the next step you should consider is configuring the plugin.
Configuration screen can be accessed in 2 ways:
1. By pressing on a ‘Configure’ button within a plugin box:
2. By pressing on a ‘Pipeline Configurations’ link on the navigation menu on the left:
This is how the configuration screen looks like when you access it for the first time:
Currently, there are no configurations. To add a new one, press on an ‘Add pipeline configuration’ button.
What we see next is an empty form with some input fields:
Setting mapping fields
| Field | Jira notion | Streak notion | Must have | Comment | Example |
|---|---|---|---|---|---|
| Streak API key | User API Key | MANDATORY | This field expects an API key which goes with a Streak client. You can learn how to get this key from the Streak site. | f9e7e3cb0c48475dbc522e129b657c01 | |
| Pipeline name | Title of pipeline | MANDATORY | This is a name of the pipeline which you would like to synchronise with the Jira project. Once entered values for select options will be filled data from Streak Pipeline (you will find more about these fields below). | Sales | |
| Project key | Project Key | MANDATORY | This is a Jira project that will be synchronised with the Streak’s pipeline. This field expects an existing Jira project key (all letters in uppercase).For example, there is a project named “Best Kitten Gallery” with the project key “BKG” (w/o quotes). You should use “BKG” (w/o quotes). Once provided the issue type field will be automatically filled in with the list of available issue types. | BKG | |
| Issue Type | IssueType | n/a | MANDATORY | This field represents an issue type of the issue created from Streak. I.e. if you set this field to ‘Story’ - each issue, created by /jira create command will result in the new issue with the ‘Story’ type.This field is populated with the list of available issue types when you provide the valid project key (see field #2). | |
| Issue assignee | Jira User | MANDATORY | This is a username of the Jira user who will be the default assignee of each issue created by JSC. If you don’t know the username of the certain user, you can always get it from the user list. The user list is a popup that appears after pressing an After you find the needed user, just click on a row for the popup to disappear and his username will be automatically assigned to the field. This prevents you from incorrect input. | ||
| Issue reporter | Jira User | MANDATORY | This field defines the user as an author of each change received from Streak (creating issue, adding comment, assigning issue, performing status transition). | StreakConnector | |
| Issue number | Issue Key | Pipeline field | MANDATORY | This field represents the name of the Streak column which will hold the Jira issue key (in our example it’s Jira-key). This field can only be set if you provide the valid Streak API key, the pipeline name and choose the column name from the list. | Jira-key |
| Issue status | Status | Pipeline field | OPTIONAL | This field represents the name of the Streak column which will hold the Jira status name. This field can only be set if you provide the valid Streak API key, the pipeline name and choose the column name from the list. | Jira-status |
| Issue priority | Priority | Pipeline field | OPTIONAL | This field represents the name of the Streak column which will hold the Jira priority name.This field can only be set if you provide the valid Streak API key, the pipeline name and choose the column name from the list. | Jira-priority |
| Issue assignee | Jira User | Pipeline field | OPTIONAL | This field represents the name of the Streak column which will hold the Jira assignee username. This field can only be set if you provide the valid Streak API key, the pipeline name and choose the column name from the list. | Jira-assignee |
| Issue Link | n/a | Pipeline field | This field represents the name of Streak column which hold direct link to Jira isuue . This field can only be set if you provide the valid Streak API key, the pipeline name and choose the column name from the list. | Jira-link | |
| Description | Optional description of pipeline |
Transition Mapping
If you want Steak box to be moved to corresponding stage when issues is moved to specific status in JIRA this can be configured on Transition Mapping screen of pipeline configuration
At given example for instance whenever issue is transitioned to status "Resolved" in JIRA, corresponding box will moved to "Closed-Won" stage
Update values
Should you change any values of fields on Streak side you have an option to update relevant values on JIRA Side
Available options in your dropdown columns on Streak side:
For statuses:
-all available statuses within the current default project (see the screenshot above);
For priorities:
-all available priorities all over the project;
For assignees:
-all assignable users in the following format: Peter Griffin (pgriffin), where Peter Griffin is a user’s full name taken from JIRA and pgriffin is his JIRA username:
That’s all that it takes to have JSC up and running. You can wire as many projects and pipelines as you wish as long as they are all within the same Streak account.