Setup & Authentication

Overview

After installing the plugin, each user must configure it with their own Personal Access Token (PAT) from TestKase. The plugin uses a three-stage configuration flow to guide you through setup.

Three-Stage Configuration Flow

The plugin transitions through three states as you complete setup:

Stage 1: NO_CONFIG

What you see: A warning screen with instructions to configure the plugin.

This is the initial state before any PAT has been entered. The panel displays a message explaining that configuration is required and provides a link to the global configuration page.

How to proceed: Click the configuration link or navigate to the TestKase global page in Jira to enter your PAT.

Stage 2: PAT_SAVED

What you see: The plugin validates your PAT and checks the project mapping.

After you save your PAT, the plugin verifies the token is valid and looks for a TestKase project mapped to the current Jira project. If the mapping exists, the plugin transitions to the READY state automatically.

If the mapping is not found: The panel shows a message explaining that the Jira project is not connected to a TestKase project. An admin must configure this via Jira Integration in TestKase Settings.

Stage 3: READY

What you see: The full test management interface with Test Cases and Test Cycles tabs.

The plugin is fully configured and ready to use. You can now create test cases, manage cycles, execute tests, and use all plugin features.

Generating a Personal Access Token

1. Log in to your TestKase account.
2. Navigate to Settings → API Keys.
3. Click Generate New Key.
4. Give the key a descriptive label (e.g., "Jira Plugin").
5. Copy the generated token immediately -- it will not be shown again.

For detailed instructions, see API Keys.

Entering Your PAT in Jira

1. In Jira, navigate to the TestKase global page (accessible from the apps menu or from the configuration link in the plugin panel).
2. Paste your TestKase PAT into the token field.
3. Click Save.
4. The plugin validates your token and checks for a project mapping.

Once saved, the PAT is stored securely on Atlassian's Forge infrastructure and is used for all subsequent API calls from the plugin.

Project Mapping

The plugin automatically detects which TestKase project is mapped to the current Jira project. This mapping is established through the Jira Integration configuration in TestKase Settings.

Prerequisite: Before the plugin can function on a Jira project, a TestKase project admin must:

1. Go to TestKase Settings → Jira Integration.
2. Connect the TestKase project to the Jira project.
3. Complete the integration setup.

The plugin reads this mapping automatically -- you do not need to configure the project connection in the plugin itself.

Re-Configuration

Updating Your PAT

If your PAT expires or you need to use a different token:

1. Navigate to the TestKase global page in Jira.
2. Enter your new PAT and click Save.
3. The plugin validates the new token and resumes normal operation.

Deleting Configuration

To clear your plugin configuration:

1. Navigate to the TestKase global page in Jira.
2. Delete the saved PAT.
3. The plugin returns to the NO_CONFIG state.

Security

• Per-user tokens -- Each user authenticates with their own PAT. There is no shared credential.
• Encrypted storage -- PATs are stored on Atlassian's Forge infrastructure using their built-in encrypted storage.
• HTTPS only -- All communication between the Forge app and TestKase API uses HTTPS encryption.
• No Jira modifications -- The plugin reads Jira issue context but does not modify your Jira issues.

Timezone Handling

The plugin uses your Jira profile timezone when displaying dates related to test execution (e.g., last run date, execution timestamps). Ensure your Jira profile timezone is set correctly for accurate date display.

FAQ

▶What if my PAT expires?

Navigate to the TestKase global page in Jira, enter a new PAT, and click Save. The plugin will validate the new token and resume working. You can generate a new PAT from TestKase Settings → API Keys at any time.

▶Can I use the same PAT for multiple Jira projects?

Yes. A single PAT works across all Jira projects, as long as the TestKase user behind the PAT has access to the mapped TestKase projects. The plugin detects the correct project mapping per Jira project automatically.

▶What if the project mapping is lost?

If the Jira Integration is disconnected or reconfigured in TestKase, the plugin panel will show a mapping error. A TestKase project admin must reconnect the integration via TestKase Settings → Jira Integration.