Skip to main content

Workflow (PRD) (Figma workflow)

Overview​

This document outlines the requirements for the Workflows feature, which consists of two types: Report Workflows and Remediation Workflows. The Workflows feature allows users to track items through various stages of completion.

1. Workflow Types​

1.1 Report Workflows​

Report Workflows allow users to track reports through different stages:

  • In Progress: Reports initially enter this stage
  • Generated: Reports automatically move to this stage when completed
  • Done: Final stage for completed and reviewed reports

Users can create new workflows and add reports to existing workflows when placing requests.

1.2 Remediation Workflows​

Remediation Workflows track remediation actions. Each remediation is represented as a card within the workflow.

Default stages:

  • To Do: Initial stage (Cards are added here)
  • Done: Final stage
  • Custom stages: Users can create additional stages between To Do and Done

Remediation cards contain:

  • Subject: Card name (e.g., "GST Filings")
  • Description: Issue details (e.g., "#report name has not filled GST on time for last 6 months, because of that the entities overall score came down")
  • Remediation: Action required (e.g., "#reportname should file GST on time")

2. Workflows Creation​

2.1 Report Workflows Creation​

  • Users can create new workflows when placing report requests
  • Users can add reports to existing workflows when placing requests

2.2 Remediation Workflows Creation​

Remediation workflows can be created from three locations:

  1. Reports Dashboard
  2. Xena
  3. Workflows List screen

When creating from Reports Dashboard or Xena, users will have options to:

  • Create a new workflow
  • Add to an existing workflow

3. User Interface Elements​

3.1 Workflows List Screen​

Displays all workflows created by the user with the following columns:

  • Workflow Name
  • No. of Cards (Total number of cards)
  • No.of Users
  • Type (Report or Remediation)
  • Created date
  • Owner

Features:

  • Filters: By workflow type and date
  • Sorting: By number of cards
  • Search: By workflow name and owner

3.2 Workflow Dashboard​

Displays cards within a selected workflow.

Features:

  • Search: Find specific cards
  • Card management: Users can move cards between stages

3.3 Remediation Card Features​

  • Edit: Users can modify Subject, Description, and Remediation fields
  • Messaging: Clients can add messages to cards
  • Vendor communication:
    • Clients can add vendor email addresses to cards
    • Remediation details and messages can be sent to vendors via email (sent from SignalX on behalf of SignalX)

4. Workflow Stages​

4.1 Report Workflow Stages​

  • InProgress: Initial stage for reports
  • Generated: Automatic transition when reports are completed
  • Done: Final stage

4.2 Remediation Workflow Stages​

  • To Do: Default initial stage
  • Done: Default final stage
  • Custom: Users can create additional stages between To Do and Done

Card View Structure

​

Header Section

  • Card Title: Prominently displayed at the top (e.g., "GST Filings")
  • Type Tag: Indicates card type (Report/Remediation)
  • Close Button: Allows users to exit the card view

​

Left Column: Core Information

  • Report name: name of the report
  • Status: Dropdown to change workflow stage (To Do, In Progress, Done, etc.)
  • Assignee: Team member responsible with avatar and name
  • Description: Detailed information about the issue or report
  • Remediation: Required actions (for remediation cards)

​

Right Column: Communication & Activity

  • Communication Panel:
    • Recipients field for vendor emails
    • Message composition area
    • Send button
  • Activity & Files Timeline:
    • Chronological record of all card activities
    • Comments from team members
    • File attachments with preview capabilities
    • Email history showing sent communications
  • Comment Entry: Input field for adding new comments or file