Jira Connection Guide

Welcome to the Jira Toolkit Web Interface! This guide will help you connect to your Jira instance.

Prerequisites

Before connecting, you'll need:

1. Jira Instance URL - Your Jira server or cloud URL
2. Authentication Credentials - API token or password depending on your instance type

Connection Types

Jira Cloud

For Atlassian Cloud instances (e.g., https://yourcompany.atlassian.net):

• Instance Type: Select "Jira Cloud (email + API token)"
• Jira URL: Your Atlassian cloud URL
• Email: Your Atlassian account email address
• API Token: Generate from Atlassian Account Settings

How to Generate Jira Cloud API Token

1. Go to https://id.atlassian.com/manage-profile/security/api-tokens
2. Click "Create API token"
3. Give it a label (e.g., "Jira Toolkit")
4. Copy the generated token
5. Paste it into the "API Token/Password" field

Jira Server

For self-hosted Jira Server instances:

• Instance Type: Select "Jira Server (token only)"
• Jira URL: Your server URL (e.g., https://jira.yourcompany.com)
• API Token: Your Jira password or personal access token

Connection Steps

1. Fill in the form:
   - Select your instance type (Cloud or Server)
   - Enter your Jira URL
   - For Cloud: Enter your email address
   - Enter your API token or password

2. Test Connection (Optional):
   - Click "Test Connection" to verify credentials
   - Wait for confirmation message
   - If successful, you'll see your username

3. Save & Connect:
   - Click "Save & Connect" to store credentials
   - The main interface will appear automatically
   - Your credentials are saved in browser localStorage

Security Notes

⚠️ Important Security Information:

• Credentials are stored in your browser's localStorage
• Data never leaves your local machine
• Only use on trusted devices
• Clear credentials when done (use Logout button)
• Don't share your API tokens with others

Troubleshooting

Connection Failed

If connection fails, check:

1. URL Format: Ensure URL starts with https:// or http://
2. API Token: Verify token hasn't expired
3. Email (Cloud): Make sure it matches your Atlassian account
4. Permissions: Ensure your account has access to the Jira project
5. Network: Check firewall/proxy settings

Invalid Credentials

• For Cloud: Regenerate API token and try again
• For Server: Verify password or generate new personal access token
• Check email address matches Atlassian account (Cloud only)

Cannot Access Projects

If connected but cannot see projects:

• Verify project permissions in Jira
• Ensure your account has at least "Browse Projects" permission
• Contact your Jira administrator

Features

Once connected, you can:

• Export Requirements: Generate PPS documents from Jira issues
• Export Test Reports: Create test documentation (TP)
• Create Test Runs: Set up test tasks for sprints
• Manage Templates: Upload and customize document templates
• Monitor Tasks: Track export/import operations in real-time

Getting Started

After connecting successfully:

1. Navigate to Export Requirements tab to generate documents
2. Select your project and template
3. Configure any additional variables
4. Click "Export Requirements" to generate DOCX output
5. Download results from the Output tab

Support

For more information:

• Check the main documentation in the Help tab (after login)
• Review project README.md for detailed setup instructions
• Visit the GitHub repository for issues and updates

Logout

To disconnect and clear credentials:

1. Click the Logout button in the header
2. Confirm the logout action
3. Your credentials will be cleared from localStorage
4. The login modal will appear again

---

Version: Jira Toolkit Web Interface v1.0
Copyright: © Ivars (ivars@blue.lv), 2026