Automan for Jira#

Welcome to the [Automan for Jira]({TODO: “Link to Atlassian Marketplace listing”}) documentation! Automan is a powerful scripting plugin for Jira Cloud that enables you to automate tasks, extend workflows, and integrate custom JavaScript logic directly into your Jira instance.

Table of Contents#

  1. Introduction
  2. Features
  3. Support and Contact
  4. Installation
  5. Quick Start

Introduction#

Automan brings the power of custom JavaScript scripting to Jira Cloud. Similar to ScriptRunner or Automation for Jira, Automan allows administrators to extend Jira’s functionality with custom code that executes in response to various triggers and events.

Unlike traditional automation tools, Automan provides:

  • Full JavaScript support with access to Jira’s REST API
  • Multiple execution contexts - workflow transitions, automation rules, event triggers, and scheduled jobs
  • Secure sandboxed execution - scripts run in an isolated environment
  • Version history - track all changes to your script definitions
  • Environment variables - securely store API keys and configuration

Features#

Workflow Post Functions#

Execute custom JavaScript code when work items transition through workflow states. Perfect for:

Automation Actions#

Integrate custom scripts directly into Jira Automation rules as actions. Use smart values to pass data to your scripts:

  • Execute complex logic that Automation for Jira can’t handle natively
  • Integrate with external APIs and services
  • Return values for use in subsequent automation actions
  • Read more about Automation Actions

Event Triggers#

React to Jira events in real-time with custom scripts:

  • Work item created, updated, deleted, or assigned
  • Comment added or updated
  • Worklog changes
  • Version and component changes
  • Project changes
  • And many more events
  • Read more about Event Triggers

Comment Mentions#

Execute JavaScript code directly from Jira comments:

  • Mention @automan in any comment with a code block
  • Automan executes the code and replies with results
  • Perfect for quick queries and one-off scripts
  • No configuration required
  • Read more about Comment Mentions

Scheduled Scripts (Cron)#

Run scripts on a schedule using cron expressions:

Script Definitions Management#

Centralized management of all your scripts:

  • Create, edit, and organize script definitions
  • View version history and restore previous versions
  • Test scripts before deployment
  • Search and filter definitions
  • Read more about Script Definitions

Environment Variables#

Securely store configuration and secrets:

Support and Contact#

We’re dedicated to ensuring that your experience with Automan is excellent. If you ever run into challenges, have questions, or just want to provide feedback, we’re eager to hear from you.

Here’s how you can reach out to us:

  • Email: Feel free to drop us a line anytime at contact@softgrown.com. We’re here to help, whether you have a simple question or need in-depth assistance.

  • Support Portal: For a direct line to our dedicated support team, please visit our Support Portal. It’s the quickest way to get in touch and ensures that we can track and respond to your concerns effectively.

Installation#

Follow this straightforward guide to install Automan on your Jira Cloud instance.

  1. Access Atlassian Marketplace: Log in to your Jira Cloud instance and navigate to Apps > Explore more apps.
  2. Search for Automan: Type “Automan” in the search bar and open the app.
  3. Install & Confirm: Click Get app and confirm any prompts.
  4. Access Automan: After installation, navigate to Apps > Automan to access the main dashboard.

{TODO: “Screenshot of Automan in Apps menu”}

Quick Start#

Creating Your First Script#

  1. Navigate to Apps > Automan to open the Automan dashboard
  2. Click New Definition to create a new script
  3. Enter a name and description for your script
  4. Write your JavaScript code in the editor
  5. Click Save to save your definition
  6. Click Run Script to test your code

automan.jpg

Example: Log Work Item Details#

// Access the event object containing trigger data
console.log("Event received:", event);

// Make a request to Jira API
const response = await requestJira(route`/rest/api/3/myself`);
const user = await response.json();
console.log("Current user:", user.displayName);

Next Steps#

Workflow Post Function Next