Atlassian Jira configuration
jira software is part of a family of products designed to help teams of all types manage work originally, jira was designed as a bug and issue tracker but today, jira has evolved into a powerful work management tool for all kinds of use cases, from requirements and test case management to agile software development the following items are prerequisite to integration jira account user should have an active jira account on the specific jira instance user want to connect to if user don't have one, user need to sign up for a jira account access to jira instance ensure that user have access to the specific jira instance where the projects, components, and issues are hosted users need the url or web address of the jira instance user want to connect to project membership users must be part of the jira projects user intend to access ensure that users have the necessary project membership to retrieve information about projects, components, and issues access policy as platform administrator and administrator ensure that the user creating the connection has the necessary access policies the user should have the platform administrator role to create and manage connections effectively the user needs the administrator role, which allows them to create and manage configurations jira rest api version compatibility relies on jira's rest api, and it is designed to work with a specific version as of now, the integration is aligned with jira rest api version 2 (/rest/api/2/) it's crucial to ensure that jira is using a compatible version for the integration to function optimally integrating jira with pulls data from github actions such as build and deploy details, including its unique identifier, status, time stamp, duration and cause the process for onboarding github actions comprises the following steps, each of which is a multistep procedure create a personal access token create a connection configure the application onboard the jira technical service creating a personal access token jira api tokens are used as a form of authentication in jira services to access and interact with its resources programmatically or through apis use the following procedure to create a jira token navigate to the top right corner of the jira homepage click on your profile picture and select manage account go to the security tab click on create and manage api tokens select create api token creating a connection to pull data from github actions, you must establish a connection between and github actions use the following procedure click on settings → → connections → add new → add connection select add connection select the appropriate authentication type if you are using a proxy adapter to access through an intermediary layer, enter the uuid for the adapter in the proxy id field note when the sync all is enabled, all the organization and repositories for which the user has access will be synced when the archive is enabled, the connection is archived for future use for oauth based authentication, follow the steps given here to get the below required fields consumerkey given on jira application link page privatekey private key ( pem format) of the public key generated while configuring jira application link page secret generated after user confirmation from a dialog box accesstoken generated value using secret configuring for github actions, recent customers note the procedures in this section are valid only for customers onboarded 6 june, 2024 or after procedures for legacy customers are provided in the subsequent section configure for github, legacy customers having created a connection, you must now configure the application use the following procedure click settings & utilities → application configuration select an existing application or create a new application navigate to add tools step select the phase as plan click add tool configuration complete the configurations, presented in the following tabs release work item format bug formats bug severity bug status onboarding the jira technical service you must now onboard the technical service use the following procedure click settings & utilities → application configurations click the overflow menu for the chosen application and click on onboard technical service select the phase as plan for tool engine , select jira for connection , select the appropriate connection name from the drop down enter the technical service name you can select project tracking or component tracking onboarding technical services are always configured as mutually exclusive if two users having same privileges attempt to create technical service for the same project/component, only the first user is allowed to create the technical service because the project/component is already configured the service will not be listed for the second user to configure this behavior applies to sync for project tracking, select the project name from the dropdown configured projects are omitted from the list the component field should remain empty for component tracking, select the project name and the component name deleting the technical service the administrator may, at will, delete the github technical service use the following procedure click settings & utilities → application configuration expand the application to see all the associated phases click the overflow menu against the plan phase click delete technical service for tool engine select jira select the appropriate projects and components click delete configuring for github actions, legacy customers the user needs to select the project that needs to be tracked through the and its respective components then, tracking can be done at two levels project level this will track all the entities of a given project if no components selected components level this will track issues only for those selected components project level tracking for this type of tracking, certain selections have to be made in the system, as follows tool engine jira technical service name it could be any string and is used only for reference project here, the user must select project name from the dropdown the already configured project will be omitted from the list component at project level tracking, this field should be empty the following is an image of the project level tracking configuration screen component level tracking for this type of tracking, certain selections have to be made in the system, as follows tool engine jira technical service name it could be any string and is used only for reference project here, the user must select project name from the dropdown the already configured project will be omitted from the list component at project level tracking, this field should be empty api key personal access token, generated from the following menu selection your profile and settings → personal settings → app passwords if the configuration is successful, then a window will appear that shows a table with the configuration details the sync feature scans current data for visibility after configuring credentials at periodic intervals the intervals are set as follows the account sync interval is set to 5 mins refresh current data the account delete interval is set to 7 mins all deleted accounts updated the history pulled interval is set to 180 days data history for more details, see your delivery representative