Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TGDK][Feature] Add Editor Invitation System to Extend Editor Assignment Workflow #4556

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

SSanchez7
Copy link

Important

This implementation is part of a set of features and fixes developed within the context of a project for the TGDK academic journal, with the goal of customizing Janeway to meet the journal's specific needs, which may also be extended to other contexts.

Problem / Objective:

Currently, Janeway only allows direct assignment of editors. While effective, this approach limits flexibility in managing the editorial process. This PR introduces an editor invitation system, allowing editors to be invited to participate in the editorial process via assignment requests, which must be approved or rejected by the invited editor within a set deadline.

This functionality is particularly useful for workflows that require more collaboration and autonomy for editors, while still maintaining the regular direct assignment method for simplicity and consistency.

Solution

The new editor invitation system extends the editorial workflow by introducing assignment requests as an alternative to direct assignments. This system allows editors to be invited to participate in the editorial process through requests that must be approved or rejected within a specified deadline.

image

This functionality is configurable by "Enable Invite Editor" via Review Settings. Is disabled by default, ensuring compatibility with existing workflows.

image


Key Features

Functionalities and panels were integrated to address the needs of both requesters and invitees:

For Requesters:

  • Send assignment requests with a specific due date.
  • View and manage pending requests from a new dashboard, with options to:
    • Edit requests.
    • Delete requests.
    • Send reminders to invited editors.

For Invitees (Invited Editors):

  • Access a dashboard displaying all pending assignment requests.
  • Options to:
    • Approve requests.
    • Reject requests.
For Requesters For Invitees
image image

These functionalities also include automated notifications and alerts for both roles, ensuring clear and effective communication at all times.


Development Considerations

To ensure efficient functionality and integration with the existing editorial workflow, the following technical implementations were made:

  • New Model: EditorAssignmentRequest
    • Serves as a "waiting room" for regular assignments (EditorAssignment), storing pending and approved requests.
    • Approved requests are automatically transferred to EditorAssignment, maintaining compatibility with direct assignments.
    • This separation ensures that the invitation functionality can be disabled without disrupting the regular assignment workflow.
  • Updates to Services and Forms to:
    • Create requests.
    • Edit requests.
    • Send reminders to invitees.
    • Reject or dismiss requests.
    • Approve requests.
  • New Views and Templates

@SSanchez7 SSanchez7 marked this pull request as ready for review December 21, 2024 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant