Skip to content

FWF-4621: [Documentation] BPM Listener readme additions #2734

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

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

auslin-aot
Copy link
Contributor

@auslin-aot auslin-aot commented May 9, 2025

User description

Issue Tracking

JIRA:
Issue Type: BUG/ FEATURE
https://aottech.atlassian.net/browse/FWF-4621

Changes

BPM Listener readme updates

Checklist

  • Updated changelog
  • Added meaningful title for pull request

PR Type

Documentation


Description

  • Fix incorrect .jpg image references in AccessGrantNotifyListener readme

  • Add optional 'color' and 'percentage' variables in audit readme

  • Add 'isResubmit' and 'eventName' optional variables in state readme


Changes walkthrough 📝

Relevant files
Documentation
accessgrantnotifylistner-readme.md
Fix image references in AccessGrantNotifyListener readme 

forms-flow-bpm/starter-examples/listeners/accessgrantnotifylistner-readme.md

  • Removed extra .jpg extensions in image links
  • Corrected snapshot image filenames
  • +2/-2     
    applicationaudit-readme.md
    Add optional audit visibility variables                                   

    forms-flow-bpm/starter-examples/listeners/applicationaudit-readme.md

  • Added optional Camunda variables for audit visibility
  • Listed 'color' and 'percentage' variables
  • +4/-0     
    applicationstate-readme.md
    Add optional resubmission variables                                           

    forms-flow-bpm/starter-examples/listeners/applicationstate-readme.md

  • Added optional Camunda variables for resubmission
  • Listed 'isResubmit' and 'eventName' variables
  • +4/-0     

    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • Copy link

    github-actions bot commented May 9, 2025

    PR Reviewer Guide 🔍

    (Review updated until commit 8b96197)

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Duplicate alt text

    Both newly added images use identical alt text referencing "messageId", which may confuse readers; consider providing distinct descriptions for clarity.

    ![Access Grant Notify listener (messageId) - Snapshot](./images/accessgrantnotify-listner-snp2.jpg)
    
    List formatting inconsistency

    The optional variables list uses bullet points while earlier lists are numbered; unify list styles to maintain consistency.

    Optional camunda variables for audit visibility (UI not yet implemented)
    * color -  Status highlight
    * percentage - Progress or completion metric
    

    Copy link

    github-actions bot commented May 9, 2025

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @auslin-aot auslin-aot force-pushed the fwf-4621-bpm-listeners-readme-changes branch from 048973a to 8b96197 Compare May 9, 2025 11:37
    Copy link

    sonarqubecloud bot commented May 9, 2025

    Copy link

    github-actions bot commented May 9, 2025

    Persistent review updated to latest commit 8b96197

    Copy link

    github-actions bot commented May 9, 2025

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant