Pro Customization Toolkit for Jira

Pro Customization Toolkit for Jira is an app that helps you visually manage and deploy Jira dynamic modules. It lets Jira administrators create, configure, update, and manage advanced customizations, such as custom issue panels, issue contexts, and custom fields, without app updates.

The app uses Atlassian's Dynamic Modules API to register new features instantly on your Jira site.

Who is this for?

• Jira Administrators: Use the visual builder to create, configure, and manage dynamic modules.

• Regular Users: Interact with custom modules (like new panels or fields) directly within the Jira issue view.

Key Features

• Low-Code Visual Builder: Build Jira extensions using an intuitive, form-based interface.

• Instant Deployment: Modules register dynamically and become immediately available on your Jira site.

• Advanced Display Conditions: Control where UI modules appear (for specific projects, project types, or issue types) to keep the issue view uncluttered.

• Usage Tracking: See how many issues use a module and who created or last updated it.

• Jira Automation Integration: Includes a custom automation action to toggle modules programmatically.

Available Modules

You can create these dynamic module types with the Toolkit:

1. Issue Panel (jira:issuePanel): Adds a panel in the main content area of the issue view to display custom information.

2. Issue Context (jira:issueContext): Adds a section to the right-hand sidebar (context area) of the issue view.

3. Issue Action (jira:issueAction): Adds a clickable action to the issue's action menu (•••).

4. Issue Activity (jira:issueActivity): Adds a custom activity tab within the issue view's activity section (alongside Comments, History, etc.).

5. Custom Field (jira:customField): Creates a dynamic custom field to capture and display data on an issue.

6. Custom Field Type (jira:customFieldType): Defines a new custom field type for advanced data needs.

7. Entity Property (jira:entityProperty): Defines rules for storing and indexing JSON data against an issue for reporting or search.

Getting Started: Accessing the Toolkit

(For Jira Administrators)

1. Log in to your Jira site as an administrator.

2. In the sidebar navigation, click Apps.

3. Select Pro Customization Toolkit for Jira from the dropdown.

4. You'll arrive at the Toolkit Dashboard, where you can view all dynamic modules you can create.

Step-by-Step: Creating a New Module

Follow these steps to create a new module (for example, an Issue Panel):

1. Start the creation by selectng the module type

From the Toolkit Dashboard, click a card of the module you want to create.

2. Configure module details

Fill in details required for the module. Fields vary by module type. For an Issue Panel:

• Title: Enter the title shown above the panel and in the ••• menu.

• Icon URL: Provide a URL to an icon displayed on the button that adds the panel.

3. Set display conditions (optional)

Set display conditions to prevent the module from appearing on every issue.

• Projects: Select projects where the module should appear.

• Issue Types: Restrict the module to specific issue types (for example, Bugs or Epics).
  

  

4. Build the UI Template (UI Modules Only)

For UI-based modules, you will automatically proceed to the Template Editor step after configuring your module's details. Here, you define exactly what your module will display using standard HTML, Velocity and/or Javascript, and dynamic "smart values."

• Code Editor: Write your custom code in the left-hand Ace editor pane. It supports standard HTML, CSS styling, Velocity templates, and Javascript.

• Smart Values (Variables Panel): Click the chevron (arrow) button on the middle divider to expand the Variables Panel. Here, you can easily copy and insert dynamic Jira data (such as the current user's name or specific issue details) directly into your code.
  

  

5. Save

Click Save (or Ctrl or Cmd + S keybord combination). The module registers instantly. Open an issue that matches the display conditions, reftesh the page, and see the module live.

Managing Existing Modules

From the Toolkit Dashboard, administrators can view all dynamic modules.

• View status & usage: The dashboard shows whether a module is enabled, who created or updated it, when it was last updated, and its Usage Count (how many issues it applies to).

• Edit: Click the module title or edit button in Actions to update a module's title, icon, display conditions, or template. Changes apply instantly.

• Delete: Permanently remove a module if it's no longer needed.

Jira Automation Integration

The Toolkit includes a custom action for Jira Automation that lets you enable or disable Wombat modules based on triggers.

How to use it:

1. Go to Project Settings > Automation (or Global Automation).

2. Create a rule and set a trigger (for example, "When an issue is transitioned").

3. Add an action and search for "Automate Custom Dynamic Modules" (provided by Pro Customization Toolkit for Jira app).
   

   

4. Configure the action by providing:

   • Module or modules: Choose from the dropdown.

   • Action: Choose whether to enable or disable the module.

5. Save and publish the rule.

For Regular Users

Regular Jira users don't need to configure anything. Modules created by administrators integrate into your workflow.