Documentation

Installation Instructions

Installing MantisScheduledTickets is as simple as installing any other Mantis plugin:
  1. Download the latest version of MantisScheduledTickets.
  2. Extract the zip file in a temporary location.
  3. Copy the MantisScheduledTickets directory into your Mantis installation's plugins directory.
  4. Log into Mantis with an account that has sufficient privileges to manage plugins.
  5. Click the Install link next to MantisScheduledTickets.

User's Guide

Prerequisites

MantisScheduledTickets currently only supports scheduling tickets via crontab, which means that you will only be able to use this functionality if your Mantis server is running on a platform that supports this functionality. Additionally, the wget utility must be installed/available.

Define Frequencies

The first step to creating tickets automatically is to define frequencies. A frequency defines when/how often tickets should be created, and is closely related to the crontab format:

m h dom mon dow
^ ^  ^   ^   ^
| |  |   |   |
| |  |   |   +---  day of week
| |  |   +-------  month
| |  +-----------  day of month
| +--------------  hour
+----------------  minute

For instance, if something should trigger daily at 1:05am, that frequency would look like this in crontab format:

5 1 * * *

That same frequency, in MantisScheduledTickets, would look like this:

When defining frequencies, make sure to choose some values for hour and minute. Not doing so will result in a LOT of tickets being generated, more than likely NOT the intended result.

Define Templates

Having created frequencies, it is now time to create templates. A template simply defines the ticket's summary and description, and allows one to associate projects/categories with frequencies.

For instance, you are managing two software projects. One is a smaller scale project, managed by John Smith, with less frequent releases, while the other, managed by Jane Doe, is more active, with more features being considered and/or actively being worked on. You want to have periodic conversations with the respective development teams to see what features are close to being completed, so that you can develop a roadmap for those projects. You have already defined two frequencies, a quarterly and a yearly:

You now want to have tickets automatically created in the respective projects. You might create a template that looks like this:

Based on the above setup, a ticket should be automatically created every year on January 1st in "Small project"'s Roadmap category, while "Large project" will see 4 tickets being generated automatically, on the 1st of January, April, July and October, respectively.

Developer Documentation

Click here for the latest developer documentation.