SETTINGS

    As add-on developers, we strive to make sensible decisions about features and default settings within our add-ons. Understandably, our decisions sometimes don't match what you need in your JIRA instance. Because of this, Simple Tasklists ships with several settings that allow you to tweak the functionality of the add-on to some degree or another.

    Below you'll find an overview of the various settings, and what they mean. Do note, all of the following options are global, and apply to all users and projects alike.

    TASK SECTION POSITION

    Each JIRA issue shows its own Simple Tasks section. This is where all the tasks within an issue are collected. By default, the Tasks section shows in the right sidebar of an issue.

    Depending on your usage of our add-on, or other add-ons you've installed, you may want to allocate more space for Tasks. Changing the value from "right" to "left", moves the Tasks section into the main JIRA issue body, and shows the tasks below the issue description.

    Alternatively, you may not want to show the tasks section at all, and only use {task} macros showing the Tasks inline. To accomplish this, simply set the value to "Hidden", which removes the Tasks section from Issue entirely.

    NOTE:

    If a JIRA issue has tasks that were added from the sidebar, those tasks don't appear in any specific Issue field or comment. As such, hiding the Tasks section would result in those Tasks no longer being visible.

    MACROS SHORTCUTS

    Simple Tasklists provides a convenient {task} macro for inserting tasks into fields. We understand that typing out {task}some content{task} can be tedious, especially when you're creating multiple tasks in an Issue. To alleviate this, we've provided a shortcut that automatically inserts the macro for you. Simply type /t in any wiki enabled field, and a {task} macro is inserted.

    If you don't like the /t shortcut, you can easily change which set of characters to use based on your own needs. This could be anything, from single characters or symbols, to entire words.

    Alternatively, you can also disable the shortcut entirely.

    FILTERS

    Simple Tasklists provides 2 separate screens that aggregate Tasks. "My Tasks" and "Project Tasks".

    Both of these screens provide filters for which tasks to show by default. The possible values are "All", "Open", or "Closed".

    The "Default Status Filter" setting allows you to change which tasks to show by default.

    NOTIFICATIONS

    "Notify when a Task is toggled" controls whether JIRA notifications are triggered when a task changes state (checked or unchecked). If this option is enabled (yes by default), and your instance has a Notification scheme setup, then user are notified when tasks are toggled based on the notification rules you've setup.

    "Fire Issue Events" is disabled by default, and controls whether an issue update event is fired when a task is toggled.

    This typically only matters when you have other add-ons that you want to notify when tasks are changing. We have only encountered a few scenarios where this mattered, and it usualyl involved custom add-ons that clients have written to integrate with Simple Tasklists.

    Most other users / JIRA admins most likely don't care about this setting.

    NOTE:

    This setting does not impact the use of Workflow functions, but it does impact the use of the JIRA Automation plugin, and can have interesting side effects if you have automation rules that are tied to issue_update events.

    "History entry for Task changes" controls whether a history entry is generated whenever a task is added, edited, or removed. History entries are kept separate from the standard issue history, and do not show up in the JIRA Activity Stream, or the regular issue history. Instead, Simple Tasklists exposes it's own history tab within each issue.

    "History entry when a Task is toggled" controls whether a history entry is generated when a task is toggled to checked or unchecked. Each history entry identifies which task was toggled, who did it, when, and the new state of the task.