User Privileges

  • Create a user in Jira that is dedicated for {{SITENAME}}. This user shouldn’t perform any other action from Jira’s user interface.
  • Note:This user can be part of your Jira system’s Lightweight Directory Access Protocol (LDAP) or Single sign-on (SSO) provider.
  • The user should be a member of the following user groups:
    • For on-premises instance:
      • JIRA-developers
      • JIRA-users
  • For cloud instance:
    • Jira-Ops-Users
Note: These are the privileges required for the dedicated integration user to synchronize the entities. In appendix, please refer Grant permissions to Jira user for step-wise details. These permissions are needed for both On-Premise (self-hosted) and On-Demand (cloud) versions of Jira.
  • Basic issue-types can be synchronized by adding these permissions:
    • Administer Projects (For synchronizing Sprint as a field value or as an entity)
    • Browse Projects
    • View Read-Only Workflow
  • Comments Permissions: Provide the permissions listed below.
    • Add Comments
    • Edit All Comments
    • Delete All Comments
  • Attachments Permissions: Provide the permissions listed below.
    • Create Attachments
    • Delete All Attachments
  • Issue Permissions: Provide the permissions listed below.
    • Assign Issues
    • Close Issues
    • Create Issues
    • Delete Issues
    • Edit Issues
    • Link Issues
    • Modify Reporter
    • Move Issues
    • Resolve Issues
    • Schedule Issues
    • Transition Issues
  • The group that includes the dedicated user should also have the Browse Users permission to access the usernames and e-mail ids of all available users.
    In appendix, please refer: Grant Browse User Global Permission for step-wise details.

 

Other Prerequisites

  • Synchronize an attachment
    For attachment synchronization, the attachment field must be visible while creating or updating an issue. To check this, please follow the steps given below:

    • In Jira, go to Settings > Issues > Click Field Configuration> Select Default Field Configuration
    • Navigate to the list of fields, check whether Attachment field is hidden. If it is hidden, click the Show button to make it visible.

Default Field Configuration

  • OpsHub Integration Manager requires one special field to be defined on the entity that is being synchronized.

These must be set up so that OpsHub Integration Manager can track the integration status of each item.

Version Type of field Field Name
For Version >= 5.0 and <6.2 Text Field (< 255 characters) OH_Created_By
For Version < 5.0

Refer Custom Field for Jira Version < 6.2 section in appendix for details on how to create custom fields.

Appendix

Grant Permissions to Jira User

Following are the steps to grant the permissions:

  • Log in into Jira as a user with the Jira administrator’s role.
  • From the top right corner, Jira ADMINISTRATION menu, select Projects.
  • From the Projects list, select the project for which you want to grant permission.
  • Click Project Settings at the bottom of the page.

Default Field Configuration

  • Click Permissions on the Project Settings page.

Project Setting

  • Click the Actions button and select Edit Permissions.

Project Setting

  • Click the Grant Permission link.
  • Here select the permission and then select the attribute to which this permission is to be granted.
  • For example select Administer Projects and select the user after choosing the Single User radio button as shown in the screenshot below.
  • Click the Grant button.
  • Project Setting

 

Grant access to Jira applications to a User

Before granting access or verifying that you have access, make sure you are logged in from the Admin account.

  • For Jira on-premise instance :
    • To grant access or verify that a user has access to Jira Software or Jira Service Desk, click the Settings button and open the User Management tab. Navigate to the user you want to grant access to or verify access for.
    • As shown in the screenshot below, verify that the user has access to Jira Software. If the user does not have the access to Jira Software, grant access by checking the check box next to the JIRA Software check box.
  • Jira on-premise instance

  • For Jira cloud instance:
    • To grant access or verify that a user has access to Jira Software, click the Settings button and open the User Management tab. A list of all users in your cloud instance will be displayed. Navigate to the user you want to grant access to or verify access for.
    • As shown in the screenshot below, verify that the user has access to Jira Software or not. If the user doesn’t have access, then click the slider button to enable access.
  • Jira cloud instance

 

Grant Browse User Global Permission

  • The group that includes the dedicated user should also have the Browse Users permission to access the usernames and e-mail ids of all available users.
  • To enable this permission, navigate to Systems > Global Permissions > Add Permission.

Global Permissions

  • Select the Browse User and then give the permission to the group in which the integration user is present.

Global Permissions

  • Incase your Jira system is configured with Single sign-on (SSO), then the abovementioned User privileges and permissions are sufficient.

 

Custom Field for Jira Version < 6.2

To create a new custom field:

  • Log in into Jira as a user with the Jira administrators’ global permissions.
  • Click the Administration link on the top bar. The Administration page appears.
  • On the left menu bar, under Issue Fields, click the Custom Fields link.
  • Add Custom Field. A window Create Custom Field: Choose the field type opens.
  • Global Permissions

  • From the Field Type list, select the appropriate field. For OpsHub Integration Manager, select Read-only Text Field.
  • Click the Next>> button. The Create custom field details screen will be displayed.
    Note: The Field Description is displayed beneath the data entry field when entering new issues and editing existing issues, but not during browsing issues.
  • Also, select an appropriate Search Template. For OpsHub Integration Manager, we select Free Text Searcher.
  • Select one or any number of Issue Types to which this custom field will be available. Alternatively, select Any issue type to make the custom field available to all Issue Types. You can change this in the future if needed.
  • Select the applicable context, that is, the Project(s) to which the custom field will be available. Alternatively, select Global context to make the custom field available to all projects.
  • Click the Finish button. This will bring you to the screen association page.
  • Select all the screens and click the Update button. Add At minimum field to the Default Screen. You will, now, return to the View Custom Fields page, which displays a summary of all custom fields in your Jira system.