Page Comparison

To reach this editor navigate to Administration Tab | Setup subsection | External Connectors.

Image Removed

Permissions and Settings

To update settings on this form you must have the global permission System Settings set to Update.

The JIRA connector is used for Enter Time and Time Card Import.

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.

Image Removed

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.

Image Removed

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.

...

Fill out the form using the settings described in this table.

...

The root of your JIRA instance URL. Make sure you include the "s" in https.

Example:

https://mycompany.atlassian.net

...

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.

...

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.

...

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.

...

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.

...

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.

...

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.

...

...

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.

//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

...

...

This document has been replaced: https://

...

projectorpsa.atlassian.net/

...

wiki/

...

1. email address
2. username
3. key
4. display name

...

Now go to the User Defined Fields Editor and associate your new connector with time card UDFs.

...

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).x/AwDsH