Internal Errigal Collaboration Wiki

User Tools

Site Tools

Trace:
idmsapplications:analytical_reports

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
idmsapplications:analytical_reports [2021/06/25 10:09] – external edit 127.0.0.1idmsapplications:analytical_reports [2021/12/13 14:40] (current) – 10.91.120.28
Line 1: Line 1:
 ====== Analytical Reports (Bubble App) ====== ====== Analytical Reports (Bubble App) ======
 +Updated by Yanjun Wang 13/12/2021
  
  
-**Overview**+==== Overview ====
  
-Customers are keen to reports to display the ticket state transition diagram, which shows how many and how long it took on the transition of ticket state one from another. Bubble App is developed to show the dynamical tickets status transition diagram and transferred ticket count trend chart based on data from key_stats. The diagram/chart can filter results by changing workflow, user, region, date, form, alarm, technology, priority, start status, threshold from the sidebar. The APP has been integrated with Errigal Common Header and CAS in Global Admin Tool, also supports Google Analytics.+Customers are keen to reports to display the ticket state transition diagram, which shows how many and how long it took on the transition of ticket state one from another. Bubble App is developed to show the dynamical tickets status transition diagram and transferred ticket count trend chart based on data from key_stats. The diagram/chart can filter results by changing workflow, user, region, date, form, alarm, technology, priority, start status, the threshold from the sidebar.  
 + 
 +The APP has been integrated with Errigal Common Header, CAS, and Userprofile, also been tracked by Google Analytics.
  
 Repo: https://bitbucket.org/errigal/bubbleapp/src/dev/ Repo: https://bitbucket.org/errigal/bubbleapp/src/dev/
Line 10: Line 13:
 ---- ----
  
-**Details**+==== Access and Permissions ====
  
-  * The sidebar contains all the filters which are used for filtering ticket state transition result. Workflow Name, Threshold, Start/End Date are required fields to fill in. Any other supported optional filters can be added by **Add Filter**, and easily removed by the minus button behind each filter. +The APP has been integrated with CAS and Userprofile.
-  * The sidebar is allowed to show/hide by the button above it. +
-  * The report window for ticket state transition diagram also supported to change to a table view by clicking the table icon at the top-right corner. +
-  * The second icon at the top-right corner of the report window allows users to print the diagram or export the table.+
  
-{{:idmsapplications:bubb-app-new.png?600|}}+User can visit the APP from either the button on Ticketer -> Admin Options -> Analytical Report, or link directly.
  
-  * By clicking a link between the ticket state transition diagram's 2 states, another report window will be presented to the user(as below), which shows 1) total tickets count among certain time and 2) count of tickets at a certain time(minute) moved from one status to another. Both of them can be hidden by clicking the legend behind the chart. +{{ :development:applications:bubble-app-link.png?200 |}}
-  * By default, the chart will show the main data only(90% of the total tickets count), then the scope of data can be changed by the scroll bar above. The big blue button will show 100% of the data. +
-  * The Redpoint shows the time that half of the total tickets moved from one status to another. +
-  * The chart is developed with Amchart4 which also supports download as jpg etc.+
  
-  * Working With Saved Reports +Permission control is handled by Userprofile. 
-      * Unordered List ItemIt is possible to save a report query for later use as necessary. +  * System Admin: System Administrator can access all data and functionality. 
-  * Creating A New Saved Report, to save a new report query: +  * Supper System Admin: Supper System Administrator can access all data and functionality. 
-      - Ordered List Item1. Fill out the report parameters necessary to generate the desired report. +  * End User: Application user without ability to create new user. 
-      - Select the **Save** button under the Saved Report section. +  * API User: API User is allowed to access the APIs.
-      - You will then be prompted to enter a name for your saved report. (Ensure the report name makes sense and that it is under 100 characters in length) +
-      - Select the **Confirm** button to save the report or select the **Cancel** button to stop creating a saved report.+
  
-  * Accessing An Existing Saved Report, to access an existing saved report query: 
-      - Ordered List ItemSelect the saved report from the Saved Report dropdown. 
-      - This will bring up the parameters associated with your saved report. 
-      - With the report parameters loaded, select the **Run Report** button to run the report. 
  
-  * Updating An Existing Saved Report, to update an existing saved report query: +----
-      - Ordered List ItemSelect the saved report from the Saved Report dropdown. +
-      - This will bring up the parameters associated with your saved report. +
-      - From here you can update the report parameters as necessary. +
-      - Once you are happy with your updates, select the **Save** button to update the saved report.+
  
-  * Duplicating An Existing Saved Report +==== Details ====
-      * Unordered List ItemYou can duplicate an existing saved report to create a similar report with some different parameters if needed. To duplicate an existing saved report: +
-      - Ordered List ItemSelect the saved report from the Saved Report dropdown. +
-      - This will bring up the parameters associated with your saved report. You can update the parameters as needed or leave them as they are to exactly duplicate the saved report. +
-      - Select the **Save As New** button to duplicate the saved report. +
-      - You will be asked to give this duplicate report a name. Enter a suitable name and select the **Confirm** button to create the new saved report.+
  
-  * Removing A Saved Report, to remove/delete an exiting saved report: +There are two types of reports (panel).  
-      - Select the saved report from the Saved Report dropdown. +  * Ticket State Change Report: displays time used between ticket status changes. 
-      - From here, select the **Remove** button to delete the saved report (you will be asked to confirm this action before the saved report is removed).+  * Ticket State Distribution: displays ticket count distribution over time between two certain statuses.
  
-  * Quartz job is used to populate the 8 parameter tables in bubble_app database on a daily basis. The data used to populate parameter tables are based on the query on custom_query table, which is editable; custom_query indicates the query used to populate tables, the target table to update, and if the refresh is active for a specific table. Hitting https://host/bubble-app/refreshTables will do a manually refresh+=== Ticket State Change Report ===
  
-{{:development:applications:bubble-app2.png?600|}}+  * The sidebar contains all the filters which are used for filtering ticket state transition results. Workflow Name, Threshold, Start/End Date are required fields to fill in. Any other supported optional filters can be added by **Add Filter**, and easily removed by the minus button behind each filter. 
 +  * The sidebar also contains a special filter: Saved Report, by selecting from its option, pre-saved reports variables will be auto-populated in the below filters.  
 +    * User can **create** a **new** report(variables) by  
 +      * Leave the Saved Report dropdown blank 
 +      * Filling all the filters 
 +      * Clicking **Save** 
 +      * Enter a report name and Confirm 
 +      * OR 
 +      * No matter what's value in Saved Report dropdown 
 +      * Filling all the filters 
 +      * Click **Save As New** 
 +      * Enter a report name and Confirm 
 +    * User can **update** an **existing** report(variables) by  
 +      * Select the report going to be updated from the Saved Report dropdown 
 +      * Filling all the filters you want to update 
 +      * Click **Save** 
 +    * User can **remove** an **existing** report(variables) by  
 +      * Select the report going to be removed from the Saved Report dropdown 
 +      * Click **Remove** 
 +  * The sidebar is allowed to show/hide by the button above it. 
 +  * The report window for ticket state transition diagram also supported to change to a table view by clicking the table icon at the top-right corner. 
 +  * The second icon at the top-right corner of the report window allows users to print the diagram or export the table. (If there's going to add more features to this report, can be added under this icon.) 
 + 
 +{{ :development:applications:bubble-app1.png?600 |}} 
 + 
 + 
 +=== Ticket State Distribution === 
 + 
 +  * By clicking a link between the ticket state transition diagram's 2 states, another report window will be presented to the user(as below), which shows the below figures, and both of them can be hidden by clicking the legend behind the chart. 
 +    * The total tickets count over a certain time period. 
 +    * The count of tickets at a certain time(minute) moved from one status to another.  
 +  * By default, the chart will show the main data only(90% of the total tickets count), then the scope of data can be changed by the scroll bar above. The big blue button will show 100% of the data. 
 +  * The Redpoint shows the time that half of the total tickets moved from one status to another. 
 +  * The chart is developed with Amchart4 which also supports download as jpg etc. 
 + 
 +{{ :development:applications:bubble-app2.png?600 |}}
  
 ---- ----
  
-**Architecture**+==== Architecture ====
  
-{{:development:applications:bubble-app3.png?600|}}+{{ :development:applications:bubble-app3.png?600 |}}
  
 ---- ----
  
-**Reports**+==== Impelmentation ====
  
-Report class has two methods, getParams to add parameters to report object sent in the request object. This report object will be returned as part of the response. Another method is the run method. This method returns the JSON string. This JSON string will be added to the report object sent in request as reportData. +  * Ticket State Diagram Report: TicketStateReport.groovy 
-  * Unordered List ItemTicket State Diagram Report: TicketStateReport.groovy +  * Ticket State Distribution: TicketStateDistributionReport.groovy 
-  * Unordered List ItemDrilldown Report: TicketStateDistributionReport.groovy+ 
 +Parameter table population is replying on QUARTZ job to run on a daily basis. The SQL query used for the corresponding table is at custom_query table.
  
 ---- ----
  
-**List of Tools & Technologies**+==== List of Tools & Technologies ====
  
 Backend Backend
Line 83: Line 101:
   * REST   * REST
   * Security, Includes CAS   * Security, Includes CAS
-  * Quartz 
 Frontend Frontend
   * ReactJS   * ReactJS
-  * GoJS +  * [[https://gojs.net/latest/index.html|GoJS]] 
-  * amCharts+  * [[https://www.amcharts.com/docs/v4/|amCharts]]
   * BubbleJS   * BubbleJS
 Development Development
-  * Jest: Helps running unit test on ReactJS Code +  * Jest: helps running unit test on ReactJS Code 
-  * Storybook: Helps speed up React Component Development+  * Storybook: helps speed up React Component Development
 Other Other
   * Ansible   * Ansible
   * Prometheus    * Prometheus 
-  * Flyway 
  
 ---- ----
  
-**Key Stats**+==== Key Stats ==== 
  
 Reports have the ability to connect databases via MySQL JDBC connector. For the state diagram report, it queries from key_stat table which is generated and updated by different processes that Marut introduced for Tableau. At the time of 3.11, table names that state diagram report looks up are wf_ticket_status_change and ticket_summary. Reports have the ability to connect databases via MySQL JDBC connector. For the state diagram report, it queries from key_stat table which is generated and updated by different processes that Marut introduced for Tableau. At the time of 3.11, table names that state diagram report looks up are wf_ticket_status_change and ticket_summary.
  
-For further information see requirements document[[https://drive.google.com/drive/folders/0BzOPOur52nscUXdwTll0Sm9XVTA|here]]+---- 
 + 
 +==== Appendix ==== 
 + 
 +Project folder: 
 +  * [[https://drive.google.com/drive/folders/0BzOPOur52nscUXdwTll0Sm9XVTA|Reprting Manager]] 
 +  * [[https://drive.google.com/drive/u/0/folders/1pCLg8Nh-fZcnP_LjQZZlpJDQV3WyR3xd|Original]] 
 +  * [[https://drive.google.com/drive/u/0/folders/1znq8MBb4ehOHKFHAzHkk_EuyjmH9p20b|Enhancements]] 
 + 
 +R&D Docs: [[https://docs.google.com/document/d/16_xKYkFweTl7xmUn5Wa5is_MlyoVWA-zw_r9Ec1TKxg/edit?usp=sharing|3.11]] [[https://docs.google.com/document/d/1U7czQRRd0ZUrxL33BeZ2Ja1by7RGhdme5xShSO6zIQc/edit?usp=sharing|3.13]] [[https://docs.google.com/document/d/1yFN_HxtRfZXfdaAGmkbhB8eXW8XFHU9DsxFid6ASVtk/edit?usp=sharing|3.14]]
  
  
idmsapplications/analytical_reports.1624612196.txt.gz · Last modified: 2021/06/25 10:09 by 127.0.0.1

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki