Skip to content
Nappai Documentation

Jira Reader

The Jira Reader component connects to your Jira Cloud account and lets you pull information like issues, users, projects, issue types, priorities, and statuses. It’s a simple way to bring Jira data into your Nappai dashboards or automation flows without writing any code.

How it Works

When you add the Jira Reader to a workflow, it uses the Jira API to fetch data. First, you select a Credential that contains your Jira Base URL, email, and API token. The component then sends a request to Jira based on the operation you choose (for example, “List Issues”). The response is returned as a data object that can be used by other components or displayed in the dashboard. If you enable Mapping Mode, you can feed the component with multiple records at once, making it ideal for batch processing.

Operations

This component offers several operations that you can select based on what you need to do. You can only use one operation at a time:

  • List Issues: Retrieves a list of issues from a specified Jira project, optionally filtered by project key.
  • List Users: Returns all users that have access to the Jira instance.
  • List Projects: Provides a list of all projects in the Jira account.
  • List Issue Types: Gives the available issue types (e.g., Task, Bug, Subtask) in the selected project.
  • List Priorities: Returns the priority options (e.g., High, Medium, Low) for issues in the project.
  • List Statuses: Lists the status categories (e.g., To Do, In Progress, Done) used in the project.

To use the component, first select the operation you need in the Operation field.

Inputs

Mapping Mode

This component has a special mode called “Mapping Mode”. When you enable this mode using the toggle switch, an additional input called Mapping Data is activated, and each input field offers you three different ways to provide data:

  • Fixed: You type the value directly into the field.
  • Mapped: You connect the output of another component to use its result as the value.
  • Javascript: You write Javascript code to dynamically calculate the value.

This flexibility allows you to create more dynamic and connected workflows.

Input Fields

The following fields are available to configure this component. Each field may be visible in different operations:

  • Operation: Choose what you want the component to do.

    • Visible in: List Issues, List Users, List Projects, List Issue Types, List Priorities, List Statuses

  • Issue Type: Select the type of issue (e.g., Task, Bug, Subtask).

    • Visible in: List Priorities

  • Mapping Mode: Enable mapping mode to process multiple data records in batch.

    • Visible in: List Issues, List Users, List Projects, List Issue Types, List Priorities, List Statuses

  • Project Key: Choose the Jira project key to filter issues.

    • Visible in: List Issues, List Users, List Issue Types, List Priorities, List Statuses

  • Tool Name: The name of the tool that will be used when this component is connected as a tool. This name will be displayed to the agent when it selects tools to use.

    • Visible in: List Issues, List Users, List Projects, List Issue Types, List Priorities, List Statuses

  • Tool Description: A detailed description of what this tool does. This description will help the agent understand when and how to use this tool effectively.

    • Visible in: List Issues, List Users, List Projects, List Issue Types, List Priorities, List Statuses

  • Tools arguments metadata: Defines the arguments metadata for the tools.

    • Visible in: List Issues, List Users, List Projects, List Issue Types, List Priorities, List Statuses

  • Credential: Select the Jira API credential you created in Nappai.

    • Visible in: All operations

Important: Before using the component, you must first set up a Jira API credential in the Nappai credentials section. Then, choose that credential in the Credential field above. The credential requires:

Outputs

  • Jira Response: The raw data returned from Jira (type: Data, method: read_from_jira).
  • Tool: A tool object that can be used by the Nappai agent (type: Tool, method: to_toolkit).

These outputs can be fed into other components, displayed in dashboards, or used by the agent to take further actions.

Usage Example

Scenario: You want to list all open issues in the “Marketing” project and then create a report.

  1. Add the Jira Reader component to your workflow.
  2. Set Operation to List Issues.
  3. In Project Key, select MARKETING.
  4. Enable Mapping Mode if you plan to process multiple projects at once.
  5. Connect the Jira Response output to a Table component to display the issues.
  6. Optionally, use the Tool output to let the agent automatically fetch more details or create a new issue.
  • Jira Writer – Lets you create or update Jira issues from Nappai.
  • Jira Base Reader – The underlying base class that provides common Jira connection logic.
  • Data Formatter – Helps transform the Jira Response into a format suitable for charts or reports.

Tips and Best Practices

  • Test with a small project first to ensure your credentials and filters work correctly.
  • Use Mapping Mode when you need to process many projects or issue types in a single run.
  • Keep your API token secure: never share it in public scripts or dashboards.
  • Leverage the Tool outputs to let the Nappai agent automatically decide which Jira data to use next.
  • Add descriptive Tool Names and Descriptions so the agent can choose the right tool in complex workflows.

Security Considerations

  • Store your Jira API credentials in Nappai’s secure credential store; never hard‑code them in your workflow.
  • Use the Credential input to reference the stored credential, ensuring that the token is never exposed in logs or UI.
  • If you share a dashboard, make sure only authorized users have access to the component and its outputs.