Script Master Documentation

website·Indexed 30 days ago

https://kaisersoftapps.github.io/docs

Documentation for Script Master, a tool built on the Forge framework for Jira and Confluence. It includes guides on creating fragments, gadgets, macros, and listeners, as well as workflow extensions such as post-functions, conditions, and validators. The docs provide details on using the Forge API, managing web triggers, and utilizing the script console for automation tasks.

Tokens
28.2K
Snippets
92
Records
218
Agent score
74%

What's inside Script Master

  1. Overview of KaiserSoft apps for Jira and Confluence

    KaiserSoft develops a suite of apps designed to extend the capabilities of Jira and Confluence to streamline workflows, improve team collaboration, and boost productivity.
  2. Overview of Canned Worklogs for Jira

    Canned Worklogs is a Jira Cloud application that allows teams to create a library of reusable worklog templates for recurring tasks. It ensures consistency in time tracking across teams and reduces manual effort by providing customizable placeholders, timestamps, and dynamic links for worklog entries.
  3. Overview of FieldCraft for Jira

    FieldCraft is a suite of Calculated Fields for Jira designed to enhance screens, filters, and dashboards by extracting and displaying critical insights directly from Jira issues. It allows users to track transition histories, monitor status durations, and automate the calculation of complex data points to improve visibility and real-time reporting.
  4. Overview of Script Master customization modules

    Script Master provides several modules for extending Jira and Confluence functionality using JavaScript, HTML, and CSS:

    • Script Console: A browser-based interface for executing and testing JavaScript code with immediate feedback and debugging.
    • Fragments: Reusable HTML/JS UI blocks for extending interfaces; integrates with Forge Custom UI and Forge bridge APIs.
    • Gadgets: Custom Jira dashboard components created with HTML, CSS, and JS; integrates with Forge Custom UI and Forge bridge APIs.
    • Macros: Dynamic, interactive content blocks for Confluence pages.
    • Web Triggers: JavaScript functions that respond to HTTP requests for integration with external systems (no user authentication required).
    • Custom Fields: Ability to create custom fields.
    • Workflow Extensions: Customization of Jira workflows via Post-functions, Validators, and Conditions.
  5. Overview of Scripted Workflow Post-Functions in Script Master

    Scripted post-functions in Script Master for Jira allow the execution of custom actions during issue transitions, such as sending external requests, modifying data, or triggering background calculations. These functions implement the Forge Jira workflow post-function module.

    Constraint: The script size for a workflow post-function must not exceed 100 kB, or it will not be saved.

  6. Overview of Script Master

    Script Master is a tool built on the Atlassian Forge framework that enables Atlassian Administrators and Consultants to build Forge-compatible scripts, UI extensions, and integrations directly within Jira Cloud and Confluence Cloud. It eliminates the need for complex build processes or external infrastructure. Key characteristics include:

    • 100% Forge-based: All scripts and customizations are hosted within the Atlassian platform.
    • Forge Compatibility: Scripts can be transitioned into standalone Forge apps if they outgrow the tool.
    • API Access: Provides real-time access to both Forge FaaS (Backend API) and Forge Custom UI (Frontend API).
  7. Overview of Smart Variables for Confluence

    The Smart Variables macro allows users to insert dynamic content into Confluence pages by using specific variable placeholders. These variables pull live data about Confluence spaces and pages, transforming static pages into interactive hubs. Key capabilities include displaying live space/page information, building dynamic page catalogs, and managing content workflows.
  8. Introduction to Mermaid diagram syntax

    Mermaid is a lightweight, text-based language used to create diagrams and charts. It allows developers to define visual representations using simple, readable code, which facilitates version control and integration into Markdown-supported documentation and wikis. Supported diagram types include flowcharts, sequence diagrams, class diagrams, state diagrams, and Gantt charts.
  9. Overview of Team Voice for Jira and Confluence

    Team Voice is an application for Jira and Confluence that allows users to create, manage, and analyze polls directly within Jira Issues or Confluence Pages. It provides real-time results available in multiple formats, including tables, bar charts, and pie charts, to facilitate team decision-making and engagement.
  10. Extend Jira workflows using Script Master extensions

    Script Master provides scripted extensions for Jira workflows to automate transitions and enforce business logic. It supports three primary extension types:

    1. Post-Functions: Scripts executed during issue transitions to perform tasks like updating issues, sending requests, or modifying data.
    2. Validators: Scripts that ensure a transition meets specific conditions based on issue data or user actions before the transition can proceed.
    3. Conditions: Scripts that control whether a transition is visible or available to a user based on criteria such as issue status or user permissions.

    Note: This module is available for Jira only. The product has migrated to Apportunity; updated documentation is available at https://docs.apportunity.xyz.

  11. Track field modification times with First/Last Field Change Time

    The First/Last Field Change Time field is a read-only metric in Jira that automatically records the date and time of the first or last change made to one or more specified fields. The field updates automatically whenever an issue is opened or modified. Users can choose between two tracking modes:

    • Latest Change Date: Displays the date of the most recent change to the selected field(s).
    • Earliest Change Date: Displays the date of the first recorded change to the selected field(s).