Ghostwriter Wiki - Scheduled Tasks

[wilsonator]

Is your feature request related to a problem? Please describe.
The tasks.py section of the wiki is missing some key functions. For example a task named archive_projects is documented in the Wiki but does not seem to be part of the tasks.py source code anymore.

The documentation outlines: https://github.com/GhostManager/Ghostwriter/wiki/Scheduled-Tasks#archive-projects however this function is not in the tasks.py source code from what I can see.

Secondly, I would like to see an example of scheduled tasks using buttons in Ghostwriter. One use case I can think of, when a project report is set to 'Delivered' notify the client via Slack or MS Teams message. I have created a webhook for this use case, however, I don't see any documentation for how you would trigger a scheduled task based on the status of an item changing or a button being pressed.

It is documented in https://www.ghostwriter.wiki/features/background-tasks that you can use a button (various) in GW to trigger a scheduled task, however, I don't see any examples in the documentation.

Describe the solution you'd like
I would like to see the archive_projects source code or know which release this scheduled task was last released in. I would like to see an example of a scheduled task based on a GW UI function being called, or some more examples of scheduled tasks.

Describe alternatives you've considered
N/A

Additional context
N/A

[chrismaddalena]

The archive_projects task does exist. It's in a different tasks.py than some of the others as they are grouped by their function. Since archive_projects deals with archiving reports for completed projects, it lives under the reporting application—ghostwriter.reporting.tasks.py.archive_projects

If you'd like to trigger a Slack or Teams a message when a report is flagged as delivered, you could go about this in a few different ways.

1. You could create a custom task that runs every hour that looks at all reports with a last_update timestamp in the past hour and checks if they've been flagged as delivered.
2. You could add a Signal to ghostwriter/reporting/signals.py that runs when a report is saved. If the report has bene marked as delivered, send your message.
3. You could customize the view that marks a report as delivered (ghostwriter.reporting.views.py.ReportDeliveryToggle) and have it send a message when it toggles.

The first option introduces a delay and might require some fiddling to avoid sending extra messages. The most straightforward is the third option.

As for buttons, you can add a button to the interface that loads a link or triggers an Ajax request to trigger a background task. You can find many examples in ghostwriter/home/views.py. There are views in there—i.e., TestAWSConnection—that queue background tasks.

[github-actions]

This issue has been labeled as stale because it has been open for 30 days with no activity.

[github-actions]

This issue is closed because it has been inactive for 14 days since being labeled stale. Feel free to re-open the issue with a comment. If this needs further discussion (e.g., a feature request), it might be better to open a topic under the Discussions tab.