Follow Up Plugin : Documentation
- AP-258Getting issue details... STATUS - AP-455Getting issue details... STATUS
App Objective:
Follow-up enables you to generate reminders for all issues that have had no action for an elapsed time period. This applies to assignee and users that are tagged on the comments for which there was no follow up action. Reminders can be reviewed as reports or sent via email to the assignee or tagged users.
Functional Requirements:
The functional requirements of the Follow up application:
- Basic search functionalities with Project, Issue type and Time Elapse
- Use JQL filter to select the range of issues and also predefined time elapsed values.
- App should create Time elapsed custom field and should use it for calculation.
- The report should show the username, number of days elapsed and the total number of issues in which the user is mentioned (predefined 'time elapsed categories (>=2days, >=7 days and >=14 days)). Consolidated report for each user with time elapsed categories.
- Exporting the report in the form of CSV / PDF.
- Saving the query for the scheduler - Limit the query count based on the Jira count specified in the Jira server settings.
- Sending emails as the reminder for all the users who are mentioned in the issue - Each user gets the report of issues they are mentioned on (on the comments).
- Scheduling the report based on particular time.
- Report generation will be restricted based on the user project permission.
- Users can save their filters and generate a report based on the saved filter.
Technical Limitations:
The technical limitations for the application
- The basic and advanced JQL should include time elapsed custom field in the query.
- Displaying all the issues in the report screen is not possible due to issue count(If the Count is > 10000) Proposed solution on the count we can have hyperlink on the issue count that can take us to the issues view page(Export option for all the issues in CSV) - Give hyperlink to see issues in issue navigator and limit issue display based on the issue count limit as set in Jira.
- Once the user triggers the report the following actions will performed
* Search query execution based on parameters project, issue type and time elapsed
* Create tables depends on the query data
* Apply Filter logic in the table(users, time elapsed and issue keys)
* Export options based on the parameters users,time elapsed and issue key
* Delete the table after export
* If scheduler is enabled trigger the step 1(Search query execution based on parameters project, issue type and time elapsed) on the scheduled time
4. Including the time elapsed function JQL function.
5. Time elapsed will be calculated function based on the time stamp of the issue
6. We can only share the query we can't send the report to anyone from UI
7. The plugin can't access the DB directly to fetch data(Rest API or Java classes should be used), Jira cloud restricts DB access. Need to verify the data complexity when running the query, storage of the data in local db/other formats and updates whenever query is triggered.
To do Activities :
The To-Do activities for the follow up application
- Checking how to add the Time elapsed function.
- Identify the user mentioned in the activity (Latest comment).
- Calculate the time elapsed from the last activity(Latest comments)
- Explore implementing the project permission for query sharing
Functionality of Follow Up App Version 1
Please find the attachment here for the functionality of the first version of Cloud Follow Up App V1
Draft Timing Plan for App Development:
Sr.No | Task | Estimations (Hours) | Actual Start Date | Actual End date | Status | Assignee | Remark |
---|---|---|---|---|---|---|---|
1 | R & D for Implementation | ||||||
1.1 | Explore Spring boot framework for Cloud app | 16 | - AP-569Getting issue details... STATUS | Dipesh | Prerequisite | ||
1.2 | Explore React JS to use atlas kit in cloud app | 40 | - AP-571Getting issue details... STATUS | Dipesh | Prerequisite | ||
1.3 | Create a cloud app and follow up report view page to list all issues [Screen 1] with Spring boot framework | 16 | - AP-599Getting issue details... STATUS | Dipesh | First Cloud app uses Spring boot + atlas kit (React JS) | ||
1.5 | Create email template [Screen 1 – Popup ] - spring boot | 8 | - AP-784Getting issue details... STATUS | Dipesh | Create an email template with Spring boot and trigger email | ||
Total | 80 | ||||||
2 | Functionality Task | ||||||
2.1 | Design UI to view all issues which have user tagged in the last comment | 8 | - AP-650Getting issue details... STATUS | Dipesh | (Use multi-select project list, issue type, time elapsed filter) [Screen 1] | ||
2.2 | Back end code to load list of all project and issues | 8 | - AP-651Getting issue details... STATUS | Dipesh | |||
2.3 | Back end code to list all issue which has the last user mentioned in comment with time elapsed | 8 | - AP-660Getting issue details... STATUS | Dipesh | Gave KT to the team and created a plan for spring boot enhanced user profile app | ||
2.4 | Back end code to list all issue which has the last user mentioned in comment with total count and all filter | 24 | - AP-661Getting issue details... STATUS | Dipesh |
| ||
2.5 | Save report functionality - Design DB, save a record | 8 | - AP-662Getting issue details... STATUS | Dipesh | |||
2.6 | UI and backend code to show all save report [Screen -2] | 8 | - AP-664Getting issue details... STATUS | Dipesh | |||
2.7 | backend code to delete report and hyperlink to open the same report in screen 1 | 8 | - AP-665Getting issue details... STATUS | Dipesh | |||
2.8 | Export follow up report in CSV format [Screen 1] | 8 | - AP-663Getting issue details... STATUS | Dipesh | Worked 5h with Nishant to fix the issue - AP-726Getting issue details... STATUS on | ||
2.9 | Detail view report for all tagged user | 24 | - AP-745Getting issue details... STATUS | Dipesh |
| ||
3.1 | Dev deployment and Testing | 8 | - AP-764Getting issue details... STATUS | Dipesh |
| ||
3.2 | Modify email template and trigger email to respected tagged user for the reminder | 16 | - AP-666Getting issue details... STATUS | Dipesh |
| ||
3.3 | UI Validation, | 8 | - AP-779Getting issue details... STATUS | Dipesh | |||
3.4 | Testing App by US Team | 8 | Jay | Need to prepare test cases including expected functionality | |||
3.5 | Prepare Marketplace Document | 8 | Jay | ||||
Internal Demo with Shanthi: | |||||||
Expected Go Live Date: | |||||||
3.7 | Production Deployment | - AP-780Getting issue details... STATUS | Dipesh | Need VM and make setup ready for production (Marketplace document, summary pricing, and screenshots) | |||
3.8 | Bug fixes for Tag Tracker | - AP-877Getting issue details... STATUS | |||||
3.9 | Enhancement and Suggestion for Tag Tracker | - AP-878Getting issue details... STATUS | |||||
4 | VM Setup for tag Tracker | - AP-819Getting issue details... STATUS | |||||
4.1 | Changes to the Tag Tracker app | - AP-881Getting issue details... STATUS | |||||
4.2 | Read time out error while loading App | - AP-895Getting issue details... STATUS | |||||
Total | 120 |
Phase-1 development: AP-258
@Jay Karmarkar – To-do:
No | To-do |
---|---|
1 | Need clarification on send summary option of Send Reminder via email page [Screen 1 – Popup ] |
2 | Need clarification on send to option of Schedule Report page [Screen 2 – Popup ] |
3 | Need example and content for Send reminder template. |
Related Jira Issues: