Fragments
Fragments are UI components you can inject into Jira's interface — buttons in toolbars, panels on issues, items in navigation menus. They let you add custom functionality exactly where users need it, without modifying Jira's core interface.
Fragment Types
ScriptForge supports two types of fragments:
| Type | What It Is | Example |
|---|---|---|
| Web Item | A clickable button or menu entry | "Create Release Notes" button in the issue toolbar |
| Web Panel | A content area that displays information | A panel showing external service status on an issue |
Locations
Fragments can be placed in various Jira locations:
| Location | Where It Appears |
|---|---|
issue-toolbar |
Action buttons on the issue view (alongside Edit, Comment, etc.) |
project-sidebar |
Left sidebar navigation in a project |
global-nav |
The top navigation bar |
issue-panel |
A panel inside the issue detail view |
issue-glance |
A glance item in the issue sidebar |
Action Types
When a user clicks a fragment (web item), it can trigger different actions:
| Action Type | Behaviour |
|---|---|
url |
Navigate to an external URL |
script |
Run a ScriptForge script |
html |
Render custom HTML content |
dialog |
Open a modal dialog |
constrained-create |
Open Jira's issue create dialog with pre-filled values |
Configuration
Each fragment has these settings:
| Setting | Description |
|---|---|
| Name | Internal identifier |
| Description | What the fragment does |
| Fragment Type | web-item or web-panel |
| Location | Where it appears in the Jira UI |
| Label | Display text shown to users |
| Icon | Optional icon next to the label |
| Action Type | What happens when clicked |
| Action Config | Configuration for the action (URL, script, HTML template) |
| Condition Config | Optional conditions that control when the fragment is visible |
| Enabled | Toggle the fragment on/off |
| Project Scope | Which projects show this fragment |
| Priority | Ordering relative to other fragments |
Conditions
You can control when a fragment appears using conditions:
{
"projectKeys": ["WEB", "API"],
"issueTypes": ["Bug", "Task"],
"userGroups": ["developers"]
}
This makes the fragment visible only in the WEB and API projects, only on Bug and Task issues, and only for users in the "developers" group.
Creating a Fragment
- Navigate to Apps → ScriptForge → Fragments
- Click Create Fragment
- Choose the fragment type and location
- Configure the label, action type, and action config
- Set conditions and project scope
- Enable and save
See the Web Items and Web Panels sections for detailed examples of each type.