...
To reach this editor navigate to Administration Tab | Setup subsection | External Connectors.
Permissions and Settings
To update settings on this form you must have the global permission System Settings set to Update.
...
See our Workflow Management System User Guide which explains how this works for your end users.
Create a Resource User Defined Field
Go to your Administration tab | Setup subsection | User Defined Fields Editor blue dot | Resource subtab. Add a new resource UDF of type Text and name it JIRA Account ID.
You must then edit each resource and fill out the resource UDF with their JIRA account ID. This value can be found by going to Users in JIRA and choosing Show Details. In the URL that is displayed will be their ID. Highlighted in orange below.
Configure JIRA External Connector
This section explains how to configure the JIRA connector. Some of the settings can be customized to your particular JIRA instance. For instance, only find JIRA issues of type=bug. You can reference this JIRA help page for a list of all their search APIs.
...
- Click New to create a new connector
Fill out the form using the settings described in this table.
Field Description Code Use this to uniquely describe your connector. Connector Type Set this to JIRA Issue V2. JIRA's API is currently on v2. This number may change as they release updates to their API. Base URL The root of your JIRA instance URL. Make sure you include the "s" in https.
Example:
Enable Item Search Tick this checkbox so that resources entering a time card in Projector can search for and link JIRA tickets to the time card. Enable Time Import Tick this checkbox so that resources can use Time Card Import to search your JIRA database and create time cards from JIRA tickets. To use the Time Import function, the Tempo Timesheets add-on (version 7.20.18 or earlier) must be enabled in your JIRA instance. Resource Identifier
You must choose User Defined Field from this dropdown list. You should have already configured a resource UDF called JIRA Account ID. Choose it from the second dropdown list.
Resource Field Name At this time we don't see a great use case for this field. As assignees can change from person to person on a JIRA ticket, you can have a situation where the card can be seen and imported by Phil, but then later on be reassigned and then it can't be found.
Used only for the Item Search functionality. It allows you to filter the tickets a resource can search on based on some criteria. It is used in conjunction with the Resource Identifier. For example, in this field you might type:
assignee
This tells to Projector to search for JIRA tickets where assignee = {Resource Identifier}
If you want the resource to see all tickets, not only tickets assigned to them, leave this field blank.
See Assignee.
Project Identifier
Choose from the dropdown the project-related field in Projector that will be used to match JIRA tickets to Projector projects. The options are Project Code or User-defined field.
Project Field Name This is an optional field used only for the Item Search functionality. It represents the field in JIRA that maps to Projector projects. Entering a value in this field will allow you to filter the tickets a resource can search on based on the project associated with the time card the resource is editing. This field is used in conjunction with the Project Identifier. For example, in this field you might type:
project
This tells to Projector to search for JIRA tickets where the JIRA project = {Project Identifier}
If you want the resource to see all tickets, not only tickets on the current project, leave this field blank
See Project.
Key Field Name This field is required and must contain the value "key" for a JIRA setup. For Item Search, this will allow resources to search for issues directly by typing the issue key into the search box on their time card. The field is also used by Time Import to extract additional details about each issue that might be needed during import.
key
See Issue Key.
Search Field Names This is an optional (but highly recommended) field used only for the Item Search functionality. Entering a value of "text#~" will allow resources to search for issues using a text string entered into the search box on their time card. If required, other search fields can be appended in a comma-separated list.
text#~
See Text.
Search Constant Filters Use this field to append additional querystring parameters. For example, if you only want your connector to find JIRA issues created this year:
created>"2016/01/01"
You can also combine search terms. For example, only find JIRA issues with a specific fix version that were also created this year.
fixversion=10001 and created>"2016/01/01"
A full list of search APIs are available here.
Tempo Access Token Get your access token by going to Tempo | Settings | API Integration in JIRA.
Custom Fields As needed, you can add custom fields to the list of fields available during time import.
To add a custom field, enter a name for the field in the “Header” column and the Column Identifier in the following format:
fields.<customfield_XXXXX>.<field name>
You can find the custom field identifier by typing an API call directly into your web browser. Substitute in the correct URL based on your installation.
Code Block //enter your own domain name //enter your own issue key https://mycompany.atlassian.net/rest/api/2/issue/SD-XXX?expand=fields //From the output, find the field containing the data that you need and enter the custom field identifier information in the connector configuration. "customfield_10008": { "self":"https://mycompany.atlassian.net/rest/temp-accounts/1/account/1", "id": "1", "key": "P001001001, "name": "P001001-001" } //example fields.customfield_10008.name
Click Set Credentials.
A username and password field is presented.
The username entered should be for a user that has access to all the tickets you want to bring into Projector or link to Projector. In other words, if you logged in as this actual user and you can't view a ticket, you aren't going to be able to do so through Projector either.Warning title READ THIS This is NOT your JIRA username and password. It is your JIRA email address and API token.
Enter the password. This is NOT the user's actual password. It is an API token value. This page has instructions on generating the token.
Edit each resource in your installation and enter their JIRA Account ID #. To look up an account you can also use their RESTful services with one of the following four parameters: https://mycompany.atlassian.net/rest/api/2/user/search?query=emailAddress
- email address
- username
- key
- display name
Now go to the User Defined Fields Editor and associate your new connector with time card UDFs.
- See our Workflow Management System User Guide
Add JIRA connector to time cards
Go to your Administration tab | Setup subsection | User Defined Fields Editor blue dot | Time subtab. Add a new resource UDF of type JIRA (the one you just created).
...