nextcloud / nextcloud/workflow_script

add possibility to define an activity text for each workflow which will be written to the activity stream

Open
#56 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
PHP
Stars
89
Forks
19
Avg merge
6h 38m
Merged PRs (30d)
3

Description

Enhancement request

For compliance reasons, it would be nice to be able to define an activity text for each workflow which then will be written to the activity stream of a user. Alternatively a text returned by the external script could be written to the activity stream. This would allow to get notice of the processing done by a workflow script. It should be possible to use the available place holders in that text string.

Example: Imagine you've created an external script which converts an uploaded 3gp-video to a mp4-video. As soon as you uploaded a file a message like "You have created xvz-video.3gp" is being logged. Next an external script is executed which converts the file to a mp4-video (xyz-video.mp4) and the original file is being deleted.

As a result you will see a file named "xyz-video.mp4" on your server but not the file "xyz-video.3gp" anymore. Currently the activity stream doesn't contain any entry about the external script execution nor the file renaming and how/why it has happened.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are named. Start by locating the workflow execution entry point and the activity-stream integration, then check how workflow configuration and placeholders are represented. Done means a workflow can record a configured or script-returned message, with placeholders expanded, in the user's activity stream.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.