freescout/freescout-custom-workflow-user
2
0
Fork 0
mirror of https://git.yylx.win/https://github.com/karrierekick-dev/freescout-custom-workflow-user.git synced 2025-11-22 17:56:33 +08:00
Code Issues Projects Packages Wiki Activity Actions
This is a collection of files to patch the original FreeScout Workflow Module. It will let you define an existing user which will become the default user for your automated workflow. Manuel workflows will use the user running the workflow task.
12 commits 1 branch 0 tags 52 KiB
Find a file
Exact
Karriere Kick Entwickler 1a626f57a0
Update README.md
2024-01-22 11:04:01 +01:00
Workflows Patches for custom workflow users 2024-01-22 01:06:15 +01:00
LICENSE Initial commit 2024-01-22 00:19:34 +01:00
README.md Update README.md 2024-01-22 11:04:01 +01:00

README.md

FreeScout Custom Workflow User

This collection of files is designed to patch the original FreeScout Workflow Module.

Why

The original Workflow Module uses a user named "Workflow" to execute all actions. Consequently, instead of displaying the name of the actual user, you see "Workflow" as the sender's name. You can alter the name in the .env file using the property WORKFLOWS_USER_FULL_NAME, but this has a few limitations. It only allows up to 20 characters, and additional settings, such as an email address, cannot be defined. As a result, signatures using variables like user.email are not displayed correctly. Additionally, when manually executing a workflow, the "Workflow" user is used instead of the user who initiated the workflow.

What

This patch brings two enhancements:

  • Define an existing user as the default user for all your automated workflows.
  • Manual workflows will use the logged-in user running the workflow task as the sender.

Requirements

You need a FreeScout installation and the Workflow Module installed.

Installation

  1. Save a copy of your "Modules/Workflows" directory so that you can easily revert to the original.

  2. To define the default user used for your automated workflows, open your .env file in the root directory and add the following line anywhere in the file: WORKFLOWS_USER_EMAIL=existing-user@yourdomain.com

    NOTE: A User with this email must exist in your FreeScout environment. Instead of using a real user's account, you may create a special account specifically for your workflows. For example:

  3. Copy the files from this repository's "Workflows" directory into the "Modules/Workflows" directory of your FreeScout installation. The following files will be replaced:

    • Config/config.php
    • Entities/Workflow.php
    • Http/Controllers/WorkflowsController.php

Note

If you have workflows that should not be associated with an existing user, it's advisable not to use this patch.

To undo this patch, use your backup.

To view the actual changes to the original, check here.

Have fun!