TABLE OF CONTENTS

• Overview
• Connector app setup and prerequisites
• Jira DevOps permissions
• Create connections
• Manage connections
• Create recipes
  • List of default templates for recipes
  • Recipe creation
  • Created recipe page
• Manage recipes
• Customize recipes
  • Trigger
  • Action

Overview

The Jira DevOps Connector app enables seamless integration between Freshservice and Jira, allowing you to track issues and work items within your change management process.

Note: This article specifically focuses on the process of creating connections and recipes for the Jira DevOps Connector app.

Connector app setup and prerequisites

For information on the following topics, refer to the main article (Integrate Freshservice with DevOps Connector apps):

• Prerequisites for the DevOps connector app integration

• Installing the DevOps connector app

• The DevOps connector app dashboard

Jira DevOps permissions

The following table provides information on the scope and permissions you need to enable while creating an API token.

Note:

• The API token inherits permissions from your Jira user account. Ensure your account has the required permissions.

• You must create an ‘API token with scopes’, see Manage API tokens for your Atlassian account for more information.

The following screenshots illustrate the scope and permissions for creating an API token.

Figure 1: Expiration date (important for admins to set and manage)

Figure 2: Selecting the app

Figure 3: Read, write, and manage scopes

Create connections

To share, update, and automate data, you need to connect the Jira DevOps Connector with Freshservice by creating connections.

Note: You can create a maximum of 10 connections per connector app.

To create connections:

1. Log in to your Freshservice account.

2. Go to Admin > DevOps Management > DevOps Tools.

3. Click Go to dashboard next to Jira Connector App under the Installed apps section.

4. Click the Connections tab, then click Create connection.

5. In the Create connection slider, select the relevant credential option (Add new credential or Select existing credential).

6. (To add a new credential) Enter a name in the Credential Name field.

Note: The App Name and Type fields are auto-populated.

7. Enter your Jira email address in the Username field.

8. Enter your Jira API token in the API Token field.

Note:

• For information on creating an API token with scopes, see Manage API tokens for your Atlassian account.

• URL: https://id.atlassian.com/manage-profile/security/api-tokens

• For information on the scope and permissions you need to enable while creating an API token, see the ‘Jira DevOps permissions’ section above.

9. Click Add and Continue.

10. Enter your host name in the Host Name field.

Note: Your hostname can be obtained from your Jira URL (https://<hostname>.atlassian.net).

11. Click Create connection.

Note: The new credential you create while creating a new connection is added to the Credentials module in Freshservice.

12. (To select an existing credential) Select a relevant credential from the Choose Credential dropdown, and click Continue.

Note: For more information on existing credentials created in the Credentials module, see Centralized Credential Store.

13. Enter your host name in the Host Name field.

Note: Your hostname can be obtained from your Jira URL (https://<hostname>.atlassian.net).

14. Click Create connection.

Manage connections

To manage DevOps connector app connections, follow the procedure outlined in this section.

To manage connections:

1. Log in to your Freshservice account.

2. Go to Admin > DevOps Management > DevOps Tools.

3. Click Go to dashboard next to Jira DevOps Connector under the Installed apps section.

4. Click the Connections tab.

5. (To edit a connection) Click the ellipsis menu next to a connection name, and click Edit.

6. Make the necessary updates and save the changes.

Note: You can also click any connection name, and edit the connection.

7. (To delete a connection) Click the ellipsis menu next to a connection name, and click Delete.

Note: Deleting a connection will disable any workflows or recipes using that connection.

Create recipes

Recipes are essentially a series of steps that help automate business processes between a DevOps connector and Freshservice.

Note: By default, a few templates are readily available to create recipes for each DevOps connector app.

List of default templates for recipes

The following default templates for recipes are available with the Freshservice-Jira DevOps connector integration:

• Create devops change on new work item

• Create Change when Jira Issue is Resolved

• Create Change for weekly deployment schedule

• Link Jira Bug with Incident

• Update Incident when Jira Issue is updated

Recipe creation

To create recipes:

1. Log in to your Freshservice account.

2. Go to Admin > DevOps Management > DevOps Tools.

3. Click Go to dashboard next to Jira DevOps Connector under the Installed apps section.

4. Click the Recipes tab, then click Create recipe.

5. In the Create recipe slider, select the relevant template from the Select template dropdown, or enter a name for the recipe in the Name field.

Note:

• Selecting a template is not mandatory.

• The Name field will be auto-populated if you select any template, however you can edit the name.

• You can use the Import option on the Recipes page to import more recipes, and you can also export recipes with the Export option (see How to export or import recipes for DevOps integrations for more information).

6. Click Save. The new recipe is added.

7. You can also create your own recipes from scratch without selecting a template. Just enter a name for the recipe and click Save, which will take you to the recipe creation page.

8. Start configuring a trigger and the relevant actions.

Created recipe page

On any specific recipe page, you can view the Recipe, Jobs, Connections, Versions, Test cases, and Settings tabs.

1. On the Recipe tab, you can view various steps with pre-configured triggers and actions.

2. Go to the Jobs tab to view all the jobs associated with this recipe.

Note: Use the Repeat job, Cancel job, Search jobs, All statuses, All types, and Period filters to modify or update the Jobs list.

3. Go to the Connections tab to view all the associated connections.

4. Go to the Versions tab to view all the associated versions.

Note: Use the Compare versions, Search version comments, All periods, All change types, and All collaborators filters to modify or update the Versions list.

5. Go to the Test cases tab to create a test case.

6. Go to the Settings tab to view the general settings (such as, usage metrics, dependencies, activity audit, and concurrency), and sharing settings (such as, private dependencies and sharing link).

Manage recipes

You can start, stop, edit, test, clone, or delete any recipe.

To manage recipes:

1. Log in to your Freshservice account.

2. Go to Admin > DevOps Management > DevOps Tools.

3. Click Go to dashboard next to Jira DevOps Connector under the Installed apps section.

4. Click the Recipes tab.

5. (To start any recipe) Enable the toggle next to a recipe name on the Recipes page.

6. Or, click any recipe name on the Recipes page to go to the selected recipe page. Then, click Start recipe.

7. (To stop any recipe that is active) Disable the toggle next to a recipe name on the Recipes page.

8. Or, click any recipe name on the Recipes page. Then, click the Stop recipe option (on the right side of the page).

9. (To edit any recipe) Click the ellipsis menu next to a recipe name on the Recipes page, and click Edit.

10. Or, click any recipe name on the Recipes page. Then, click the Edit option (on the right side of the page).

11. (To test any recipe) Click any recipe name on the Recipes page. If the recipe is active, click Stop recipe.

12. Then, select Test recipe from the Start recipe dropdown.

13. (To clone any recipe) Click any recipe name on the Recipes page. If the recipe is active, click Stop recipe.

14. Then, select Clone from the ellipsis menu next to Start recipe dropdown.

15. (To delete any recipe) Click the ellipsis menu next to a recipe name on the Recipes page, and click Delete.

16. Or, click any recipe name on the Recipes page. If the recipe is active, click Stop recipe.

17. Then, select Delete from the ellipsis menu next to Start recipe dropdown.

Additionally, you can customize recipes for each DevOps connector app depending on your specific requirements.

Customize recipes

Each recipe has the following primary components: Trigger and Action. You can customize any recipe depending on your specific requirements.

Let’s take a recipe with a default template as an example to customize it further.

Default template recipe: Create devops change on new work item

You can click any component, and use the Edit option associated with the component to customize or view more details. For example, the Edit option for the Trigger component (as shown in the following figure).

Trigger

This recipe component acts as the starting point for any recipe. For this recipe, the trigger is fetching a new work item/issue from Jira DevOps and creating a change in Freshservice.

The Edit option for a Trigger component displays various trigger details and editing options in the following tabs:

• App: Shows details of the app in use, your connected apps, and other apps.

• Trigger: Shows details of the trigger in use, and the list of all triggers.

• Connection: Shows details of the connection in use, and the option to switch connections.

• Setup: Shows details of the project, and lets you set trigger conditions with trigger data (including recipe data properties) and with AND or OR conditions.

Action

The recipe performs a specific set of actions based on the trigger. For example, the recipe creates a change in Freshservice for a new work item/issue in Jira DevOps.

Note:

• Each successful action in a recipe is counted as one task.

• Tasks are not consumed when you only test the jobs in a recipe or test a recipe.

The Edit option for an Action component displays various action details and editing options in the following tabs:

• App: Shows details of the app in use, your connected apps, and other apps.

• Action: Shows details of the action in use, and the list of all actions. Also, lets you add custom actions using webhooks.

• Connection: Shows details of the connection in use, and the option to switch connections.

• Setup: Lets you configure various default fields (such as, Workspace ID, Requester, Subject, Change type, Status, Priority, Planned Dates, and so on), available optional fields, and map field group and data source.

After customizing a recipe, you can save or test it to ensure it's working correctly.