Customize the Jira work item collector
Set up the Jira work item collector for advanced use cases in your Jira Cloud projects.
We're updating our terminology in Jira
'Issue' is changing to 'work item'. You might notice some inconsistencies while this big change takes place.
Use the work item collector
This page is for company-managed projects
To check whether your project is team-managed or company-managed, select more actions (•••) next to the project name in either the header or the sidebar. At the bottom of the menu that opens, you’ll be able to view whether your project is team-managed or company-managed.
More about the difference between company-managed and team-managed projects.
What is a work item collector?
The work item collector is only available in company-managed projects. It’s not available in team-managed projects.
The work item collector allows you to easily embed a Jira feedback form into your own website. This form is typically accessed by clicking a 'trigger' tab exposed along the edge of pages in your website.
When used by people visiting your website click this trigger tab and submit the resulting Jira feedback form, a work item is conveniently created in Jira.
Visitors to your website do not require a user account in Jira to use the Jira feedback form.
Before you begin: You must be logged in as a user with the Administer Jira global permission.
Access Jira's work item collectors
In Jira applications, work item collectors are configured (and hence organized) on a per-project basis.
To access all work item collectors configured in Jira
Choose Settings () > System.
Select Work item collectors to open the page, which shows a list of all existing work item collectors in your Jira system.
Click the name of a project to access a more detailed list of work item collectors belonging to that project or click the name of a collector to access detailed information about it. On the work item collector page (containing detailed information), you can access:
An activity graph, showing the number of work items created via this collector (Y-axis) on a daily basis (X-axis).
A list of recent work item in reverse chronological order, which have been created via this collector.
To access work item collectors belonging to a specific project
Next to your project's name in the sidebar, select more actions (•••), then Project settings.
Select Work item collectors from the sidebar.
Click the name of a work item collector to access detailed information about it — in particular, its recent activity and details on how to embed the collector into your website.
Add a work item collector to a project
Next to your project's name in the sidebar, select more actions (•••), then Project settings.
Select Work item collectors from the sidebar.
Click the Add work item collector button.
In the top section of the page, specify the following:
Name | Specify the name of the work item collector, as you want it to appear throughout the Jira user interface. |
|---|---|
Description | Specify a description for the work item collector. This description will appear adjacent to the name of your collector, throughout the Jira user interface. |
Work type | Select the type of work item that you want created in Jira when visitors to your website submit your work item collector's Jira feedback form. |
Work item reporter | Specify the username that will be the default reporter of Jira work items created when visitors to your website submit your work item collector's Jira feedback form. |
Match reporter | Select either of the following:
If the Jira user does not have the Create work items project permission in your Jira project, the default reporter you specify above will be used as the reporter of the created work item. |
Collect browser info | Select this option to collect meta-information about your browser's statistics, which will be incorporated into work items created by submission of the Jira feedback form on your website. |
5. In the middle section of the Add work item collector page (entitled 'Trigger'), specify the following:
Trigger text | Specify a short, brief phrase that will appear on the trigger tab on your website. |
|---|---|
Trigger style | Choose the style in which the trigger tab will appear on your website. 'Custom' will not display a trigger, but will add additional javascript to the generated script, so you can create a custom trigger on your web page. |
6. In the lower section of the Add work item collector page (entitled 'Work Item Collector Form'), specify the following:
Template | Choose from the options provided. Typically, your choice would reflect the type of work item being created (i.e. chosen above). You can choose:
|
Message | Type a message, which appears in the blue 'information' panel along the top of the dialog box. |
7. Click the Submit button to save your changes.
Embedding a work item collector into your website
After clicking the Submit button to save your new work item collector, a page containing code snippets is displayed. Use the code and information provided to embed your new work item collector into your website.
If you accidentally click away from this page, you can easily retrieve the information that was on it by accessing your work item collector's details (above) and scrolling to the end of the page.
Edit a work item collector
Editing a work item collector should not require any changes to web pages that include the work item collector, unless you change the trigger style to or from a custom trigger. Changing the trigger style to or from a custom trigger will change the generated javascript, so you may need to change what you embed in any web page that includes the work item collector.
Log in to Jira as a project administrator or a user with the Administer Jira global permission.
Access the relevant project's list of work item collectors (above).
In the Operation drop-down for the work item collector you would like to edit, select Edit.
Update the work item collector, as desired.
Click Update to save your changes.
Copy a work item collector
Copying a work item collector will create an entirely new collector and will not affect any existing collectors. You will need to embed it in whatever web pages you would like, just as if you had created a new collector.
Log in to Jira as a project administrator or a user with the Administer Jira global permission.
Access the relevant project's list of work item collectors (above).
In the Operation drop-down for the work item collector you would like to copy, select Copy.
All the information from the copied work item collector will be the same as the copied collector, with the exception of the name (which will be "Copy of " + the original name of the copied work item collector.)
Update the work item collector, as desired.
Click Submit to save your changes
Disable or delete a work item collector
Access the relevant project's list of work item collectors (above).
On the list of the project's work item collectors, click Disable or Delete to respectively disable or delete the associated collector.
While a work item collector is disabled, its trigger tabs will still be visible on pages of your website(s) to which the work item collector code has been added until a user refreshes the page. However, clicking these triggers results in a message indicating that the collector is currently out of action.
Was this helpful?
Still need help?
The Atlassian Community is here for you.