Documentation
DocumentationDeveloperAcademyCommunitySupportLogin
Start typing to search…

Jira (Live) Setup for Enterprise Search

System Overview

Jira is your organization's primary project management and issue tracking platform for managing development workflows, bug reports, and project deliverables. From an enterprise search perspective, Jira contains valuable knowledge in tickets, comments, attachments, and project documentation that teams reference for troubleshooting and project context. Moveworks connects to Jira to perform live search across projects and issues, returning results that based on user permissions, without storing or indexing any data.

Authentication

Authentication is accomplished by creating and registering an Atlassian OAuth 2.0 application for the following approach for live search:

  • Uses delegated OAuth 2.0 with a separate Atlassian app registration and client secret
  • End users sign in and provide consent for the first time; Moveworks then searches only the projects and issues they can access in Jira
  • No enterprise-wide indexing of Jira content occurs

Permissions Enforcement

Live Search: Results are retrieved on behalf of the signed-in user using their token, so source-system permissions are inherently enforced.

API Usage

Moveworks uses the standard Jira Cloud REST API v3 to perform live search from Jira. We use only permissions granted through user consent for live search.

Content Types

Live Search

  • On-demand results from the signed-in user’s accessible Jira projects and issues
  • Not indexed into the enterprise corpus; fetched at query time after user consent

Access Requirements

Pre-requisites

Before you get started, make sure you have everything you need:

Understanding Permissions Scopes required for Enterprise Search

  • jira-work: Required to search for jira projects and issues.
  • jira-user: Required to view information about users.

Instructions for Jira Live Search

1. Register a new App

  1. Sign in to the Atlassian Developer Console

  2. Click on 'Create' button

  3. Click on OAuth 2.0 integration option

  4. Name your Jira OAuth 2.0 app and Click on Create button

  5. In the left sidebar, click on the Permissions tab

  6. In the Permissions table, click on the Add button for the Jira API

  7. Click on the Configure button

  8. Under the Jira Classic scopes tab, click on the Edit Scopes button

  9. Add both read:jira-work and read:jira-user scopes, and Click on the Save button

  10. Verify whether both the scopes have been added successfully


Setup in Moveworks

  1. Log in to your org's MyMoveworks portal

  2. Navigate to Moveworks Setup > Connectors > Built-in Connectors

  3. Click on the Create New button

  4. Search and Select Jira (Next Gen)

  5. Click on Next: Add Creds

  6. Input the following details (copied from steps above)

    1. Connector Name: Name this connector for your future reference. Once set, this name cannot be changed
    2. Client ID: The unique identifier for your Jira app registration
    3. Client Secret: The secret key for your Jira app to authenticate with Jira Software Cloud REST APIs
    4. Cloud ID: Your organization's unique Jira Cloud instance identifier

    Click on the Save button. This connector will now be used to configure live search from Jira.

Configuring Jira for Enterprise Search

Initialising setup

  1. Log in to your org's MyMoveworks portal

  2. Navigate to Moveworks Setup > Answers > Ingestion > Enterprise Search

  3. Click on Create New or Get Started

  4. Select Jira from the dropdown list and click on Get Started button

  5. System Overview: This presents an overview of Jira support from Moveworks

    1. Ingestion Summary: Not applicable for Live Search systems

    2. Connector Selection: In this configuration block, you are required to select the required connector to enable Moveworks to connect and fetch data or enable live search

    3. Content Selection: In this configuration block, you are required to define the content that should be ingested within Moveworks

Connector Selection and Validation

  1. Once you click on Select Connector, a connector setup screen will appear as follows

  2. Select the connector (from the dropdown) that you have created in the Connector Creation step

    📘

    Please note: Only the Jira connectors will appear in this list.

  3. Once the connector is selected, you need to click on Start Validation to validate the connector credentials and required scope

    📘

    Connector Validation

    This is a mandatory step in order to save the configuration and move to the next step.

    Moveworks validates the selected connector to check:

    • Content: Moveworks validates whether connector has right scopes to fetch content

  4. If there are any credentials or scope issues, you will receive an error message as follows. Click on View Details to identify the issue. Refer to this step-by-troubleshoot guide (link to be added) to rectify any validation errors

  5. Once the connector is validated successfully, you will be able to Save the configuration

  6. Input the unique configuration name and Save

  7. Once the configuration is saved, you can view the unique configuration name at the top of the screen. You can also click the pencil 🖊️ icon to edit the configuration name

  8. Additionally, you will see a banner at the top of the screen with an Enable Live Search button. Click it to activate the Slack Live Search feature for your Enterprise Search web application

  9. Additionally, you will start seeing an entry of your configuration in the Enterprise Search home page. You can click on your configuration to go to edit/ complete the configuration

Updated about 6 hours ago