RedminePlus Automations

https://redmineplus.com/docs/

Admin

RedminePlus Automations is a Redmine plugin that enables users to automate workflows, enforce...

Tokens:2,941

Snippets:59

Trust Score:5.6

Update:6 months ago

Show doc for...

Tokens:

Raw

### Run Database Migrations

Source: https://redmineplus.com/docs/plugin-installation

Execute database migrations for the installed Redmine plugins to set up necessary tables and columns.

```bash
bundle exec rake redmine:plugins:migrate RAILS_ENV=production
```

--------------------------------

### Restart Redmine Application Server

Source: https://redmineplus.com/docs/plugin-installation

Restart the Redmine application server to apply changes after plugin installation. This example uses Passenger with Apache.

```bash
touch /path/to/redmine/tmp/restart.txt
```

--------------------------------

### Install Plugin Dependencies

Source: https://redmineplus.com/docs/plugin-installation

Install the required Ruby dependencies for the Redmine plugin using Bundler.

```bash
cd /path/to/redmine
bundle install
```

--------------------------------

### Log Action

Source: https://redmineplus.com/docs/actions

Configuration for recording custom messages to the automation log.

```APIDOC
## Log Action

### Description
Records a custom message to the automation log for debugging or auditing purposes.

### Settings
- **Log message** (string) - Required - Message text (supports smart tokens).
```

--------------------------------

### Send Web Request Action

Source: https://redmineplus.com/docs/actions

Configuration settings for sending HTTP requests to external services.

```APIDOC
## Send Web Request

### Description
Sends an HTTP request to an external service with configurable methods and body formats.

### Settings
- **Web request URL** (string) - Required - Endpoint URL (supports smart tokens).
- **HTTP method** (string) - Required - GET, POST, PUT, PATCH, or DELETE.
- **Web request body** (string) - Optional - Empty, Issue data (Redmine format), JSON, or Custom body.
- **Headers** (string) - Optional - Request headers (supports smart tokens).
- **Expected response codes** (list) - Optional - List of codes to validate the response.
```

--------------------------------

### Copy Plugin Zip File

Source: https://redmineplus.com/docs/plugin-installation

Copy the downloaded plugin zip file to the Redmine plugins directory.

```bash
cp /path/to/downloads/redmine_plus_automation.zip /path/to/redmine/plugins/
```

--------------------------------

### Unzip Plugin

Source: https://redmineplus.com/docs/plugin-installation

Unzip the plugin archive in the Redmine plugins directory to extract its contents.

```bash
cd /path/to/redmine/plugins
unzip redmine_plus_automation.zip
```

--------------------------------

### Set Up Cron Job for Scheduled Automations

Source: https://redmineplus.com/docs/plugin-installation

Configure a cron job to run the Redmine Automation Plugin's scheduled triggers every 5 minutes. Ensure the Redmine path is updated.

```bash
crontab -e
```

```bash
*/5 * * * * cd /path/to/redmine && RAILS_ENV=production bundle exec rails runner "AutomationRunScheduledTriggersJob.perform_now" >> log/cron_automation.log 2>&1
```

--------------------------------

### Send Email Action

Source: https://redmineplus.com/docs/actions

Configuration settings for dispatching notification emails to specified recipients.

```APIDOC
## Send Email

### Description
Dispatches a notification email to specified recipients using application users, groups, issue fields, or manual input.

### Settings
- **To** (string) - Required - Recipient email(s) via users, groups, issue fields, or manual input.
- **CC** (string) - Optional - Carbon copy recipients.
- **Bcc** (string) - Optional - Blind carbon copy recipients.
- **Subject** (string) - Required - Email subject (supports smart tokens).
- **Body** (string) - Required - Email body content (supports smart tokens).
```

Tokens:

Raw