Skip to content

Commit

Permalink
Update Automating RT docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bkembreeBPS committed Jun 13, 2024
1 parent d50dc9a commit cbd3d4f
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions docs/automating_rt.pod
Original file line number Diff line number Diff line change
Expand Up @@ -268,4 +268,48 @@ have no C<--action-arg> must be added at the end. If order is important,
you may need to add an action argument as a placeholder even if it
isn't used.

=head1 RT 5 Scheduled Processes

The Scheduled Processes admin page was added in RT 5.0.8. It allows you to
schedule an rt-crontool process directly in RT instead of scheduling it in cron.

Go to Admin > Tools > Scheduled Processes to view the list of Scheduled
Processes.

=for html <img alt="List Scheduled Processes" src="images/scheduled-processes.png">

=for :text [Create a Custom Role F<docs/images/scheduled-processes.png>]

=for :man [Create a Custom Role F<docs/images/scheduled-processes.png>]

Click the Create tab to create a new scheduled process. Click an existing
scheduled process to modify it.

To recreate the above L<Commenting and Corresponding on a Ticket> section you
would enter the following on the Create a Scheduled Process page in the Details
section:

=for html <img alt="Create a Scheduled Process" src="images/scheduled-process-create.png">

=for :text [Create a Custom Role F<docs/images/scheduled-process-create.png>]

=for :man [Create a Custom Role F<docs/images/scheduled-process-create.png>]

and then schedule the process to run in the Schedule section:

=for html <img alt="Schedule the Process" src="images/scheduled-process-schedule.png">

=for :text [Create a Custom Role F<docs/images/scheduled-process-schedule.png>]

=for :man [Create a Custom Role F<docs/images/scheduled-process-schedule.png>]

You must schedule L<rt-run-scheduled-processes> in cron to run these scheduled
processes. You'll need to have cron run this script every 15 minutes. Here's an
example crontab entry to do this.

*/15 * * * * /opt/rt5/bin/rt-run-scheduled-processes

This will run the script every 15 minutes, every hour. This may need some
further tweaking to be run as the correct user.

=cut
Binary file added docs/images/scheduled-process-create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/scheduled-process-schedule.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/scheduled-processes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cbd3d4f

Please sign in to comment.