Getting Started

Creating a Custom Field

Recommended (& Easiest) Method

1. In Jira, click the gear icon located in the upper right corner and go to Jira admin settings > Apps > Issue Pulse

2. Click Create Field in the top right of the “Issue Pulse Custom Fields” section to create your field

3. Fill out the name, and optionally the description of the field. Choose the scope of the field, which will scope the field to the projects you select so that updates are only made to issues in those selected projects, or scope it globally to all issues in your Jira instance.

Adding Rules to a Issue Pulse Custom Field

1. While you’re still in the Issue Pulse app admin page, select the Issue Pulse custom field that you created by clicking the crossed out eye under “Actions”

2. Click Create Rule in the upper right corner of the section that appears below.

3. Provide the emoji, name, and filter for the rule and submit. This process may take some time as the app processes and evaluates all the issues associated with the field against the filter.

• If you don’t have any filters, click the blue “here” text below to navigate to the filter creation (All work) screen or go to Search > View all work items. Use “Basic” for an easy and intuitive way to create filters, or switch to “JQL” to create more complex filters. Input a filter, and save it.

4. Once it’s complete, go to Search > View all work items and add your Issue Pulse custom field as a column to see the emoji assigned to each issue!

Making an Issue Pulse Field Visible On Issues

Your newly created Issue Pulse field won’t be visible on an issue view by default. To make it visible, follow the steps below.

Assigning the Field to a Team-Based Project

To ensure the field is visible in your issues, assign it to the appropriate work types.

1. Go to Project Settings > Fields > Add Fields > Search for the name of the field you created earlier.

2. Under Work Types, choose the work types you wish to link with the custom field, drag it to the desired area you want it to appear in, and save your changes.

   

   
   

‌

Assigning the Field to a Company-Managed Project (Classic)

To ensure the field is visible in your issues, add the field to the screen of the projects you want it to appear in.

Screen(s)

Using Default Screen/Existing Screens

If you are utilizing the default screen or existing screens, click the gear icon in the top right and go to Jira admin settings > Work Items > Screens, click on the name of the screen you want to add the Issue Pulse field to, and include the field.

Using a New Screen

If you wish to use a new screen, go to Jira admin settings > Work Items > Screens and click Add Screen on the top right. Enter a name and create the new screen.

Next, you’ll need to create a screen scheme and associate it with the screen you just created. In the sidebar, click on Screen schemes and click on the Add screen scheme button in the top right. Enter a name for the screen scheme, and choose the screen you created above as the Default Screen.

Optionally, you can associate a work type with a screen scheme.

For example, if you want only the Bug work type to have the Issue Pulse field visible:

1. Click Work type screen schemes in the side bar

2. Click Add work type screen scheme in the top right and create a new work type screen scheme. Choose the screen scheme you created above as the Default Screen Scheme.

3. Click the name of the newly created work type screen scheme

4. Click Associate work type with a Screen Scheme in the top right, select the Bug type, and choose the screen scheme you created or a screen that includes the Issue Pulse field. For the “Default” work type (which applies to any other work type not linked to the selected screen scheme), select a screen scheme that doesn’t include the Issue Pulse field.

‌

Associating a Screen Scheme with Your Project(s)

To use a screen scheme:

1. Go to your Project Settings > Work Types > Screens

2. In the top right corner, click Actions > Use a different scheme, then select the screen scheme you wish to apply, if it hasn’t been selected yet.

‌

‌

(Optional) Fields

Field Configuration

Create a new field configuration in Work Items > Field Configuration. Click Configure on the field configuration you want to use, and ensure the Issue Pulse field you created is included in the list. If it’s missing, add it.

If you don’t want your field associated to any other projects using the default field configuration, remove it from the default field configuration. Delete it from the default field configuration if that’s the case.

‌

Field Configuration Schemes

In Work Items > Field Configuration Schemes, create a new scheme. If you want to assign specific work types to the Issue Pulse field, click Configure on your newly created scheme. In the top right corner, click Associate a work type with a field configuration and select the work types you want to connect to the Issue Pulse field. Choose the field configuration from the previous step. If you want all work types to be linked with the field configuration, modify the “Default” work type to associate it with the selected field configuration (if you haven’t done this during the creation process).

‌

Associating a Field Configuration Scheme With Your Project(s)

To apply the field configuration scheme you created earlier, navigate to your Project Settings > Work Types > Fields, and in the top right corner, click Actions > Use a different scheme, then select the field configuration scheme you created.

‌

Things to Note

Field Configuration & Screens

If your Issue Pulse custom field is assigned to a field configuration or scoped to specific projects but not a screen, it won’t show up in the issue view. However, our app will still process the field and all issues related to it in the background. If performance is taking a notable hit, consider removing the Issue Pulse custom field from a field configuration or remove the project from the field’s scope IF it is not being used in a project and/or it isn’t associated with a screen (i.e. not visible).

Just keep in mind that the more the issues, the more the cost for us and therefore you!

Deleting a filter

When you delete your filter, or someone else who has delete access for your filter deletes it, we’ll automatically delete any rules that you have associated with that filter. That includes rules with that filter across different Issue Pulse custom fields.

For example, if I have a filter Filter 1 and I have a rule Rule 1 with Filter 1 in Custom Field 1 but I also have Rule 2 with Filter 1 in Custom Field 2, both rules will be deleted if I delete Filter 1 via the “Filters” page.

Deleting a custom field

When you delete a Issue Pulse custom field, we’ll automatically delete all rules associated with that custom field. This is irreversible. But don’t worry, when you delete a custom field through the Jira admin setting’s Fields page, it’ll be trashed first and recoverable for 60 days. Your rules associated with that field will only be deleted after the custom field is truly “deleted.”

Or more conveniently, on the Issue Pulse app admin page, click the 3 dots under “Actions” next to a custom field to trash or delete it.

“Done” Status Category

Any issues that have a status category of “Done” will not be processed by our app, and any issue that gets changed to a status with a status category of “Done” will have its Issue Pulse custom field values cleared.

If an issue changes back from the “Done” status category, it will be re-evaluated against it’s rules.