GSoC2018 report generator #1

Trodrige · 2018-05-28T13:17:22Z

Ability to connect a second database (report generator database), and use.

…ed a report generator table connection

aethelwulffe · 2018-05-28T21:19:47Z

@pri2si17-1997 Hit it dude! :)

…lationship. Updated instructions

aethelwulffe

Nice work. Much love here.

aethelwulffe · 2018-06-06T13:24:55Z

Documentation/instructions.txt

@@ -57,7 +57,8 @@ Instructions:
    'php artisan migrate'

 12. You can seed the database width
-    'php artisan db:seed'
+    'php artisan db:seed' // This shouldn't work for now.


This is obviously a WIP comment. Making a comment here just so we make sure to check for these when it is final review time.

aethelwulffe · 2018-06-06T13:26:57Z

...tor/Database/Migrations/2018_06_04_083903_create_draggable_component_report_format_table.php

@@ -0,0 +1,44 @@
+<?php


I assume these names are for WIP versioning for now, or are they intended to serve in a meaningful way to version components later?

@aethelwulffe that's the Laravel convention. I am trying to make the table names as obvious as possible.

aethelwulffe · 2018-06-06T13:27:43Z

Modules/ReportGenerator/Entities/DraggableComponent.php

+    */
+    public function report_formats()
+    {
+        return $this->belongsToMany('ReportFormat')->withTimestamps();


I like the naming convention for many-to-one, one-to-many elements. Nice.

That's the beauty of Laravel!

aethelwulffe · 2018-06-06T13:28:26Z

Modules/ReportGenerator/Resources/views/index.blade.php

@@ -81,7 +81,7 @@
                        </div>
                        <div id="collapseOne" class="collapse show" aria-labelledby="headingOne" data-parent="#accordion">
                            <div class="card-body" id="second">
-                                <p class="note">Why am I stil empty?</p>
+                                <p class="note">Why am I still empty?</p>


I feel the same way. 😸

Why is my still empty? 🍷

aethelwulffe · 2018-06-06T13:30:35Z

public/assets/css/master.css

@@ -6,7 +6,7 @@
    text-align: center;
 }

-#draggable{
+.draggable{


ID to class? Was that an error correction or just a refactor of the approach?

pri2si17-1997 · 2018-06-06T18:22:00Z

database/migrations/2018_05_18_085927_create_list_options_table.php

+            $table->boolean('is_default')->default(0)->comment = "0 -> False, 1 -> True.";
+            $table->float('option_value', 8, 2)->default(0)->comment = "";
+            $table->string('mapping', 31)->comment = "";
+            $table->string('notes', 255)->comment = "This stores the meaning or usefulness of the component.";


Limiting notes to string is not a good idea. You can use text instead. Notes may exceed 255 char.

pri2si17-1997 · 2018-06-06T18:25:20Z

.../ReportGenerator/Database/Migrations/2018_05_22_153827_create_draggable_components_table.php

+            $table->string('title', 255)->comment = "This is the text on the component that end users see.";
+            $table->integer('order', 0)->comment = "The order in which components appear in the list.";
+            $table->boolean('active')->default(1)->comment = "0 -> False, 1 -> True whether the component should be active or not.";
+            $table->json('notes', 255)->comment = "This stores the fields that the component relates to in the database.";


Why notes to be of json type? I can't understand from your comment. Any example will be appreciated.

pri2si17-1997 · 2018-06-06T18:26:21Z

Modules/ReportGenerator/Database/Migrations/2018_05_25_203256_create_report_formats_table.php

+            $table->string('title', 255)->comment = "This is the report name e.g Patient List.";
+            $table->string('system_feature', 255)->comment = "The system feature under which the report belongs.";
+            $table->text('description')->comment = "This describes the report format briefly.";
+            $table->json('draggable_components_id')->comment = "This stores the id of all the components that belong to this report format";


Not able to get draggable_components_id field's type.

pri2si17-1997 · 2018-06-06T18:31:20Z

This is a general feedback looking at one go. I would test your PR explicitly and let you know @Trodrige .

Sorry @aethelwulffe , been very busy last week, with academic major and all.

teryhill · 2018-06-06T23:23:00Z

aethelwulffe · 2018-06-11T14:44:51Z

I assume this is open elsewhere now?
I got a data set, and I wannaa play with it.
Evals are due ya know. :)

Trodrige · 2018-06-11T17:44:24Z

@aethelwulffe I'm sorry for the inconvenience. I renamed the branch to show 2018 instead of 2017. I didn't realize this happened.

Trodrige · 2018-06-11T17:52:23Z

@aethelwulffe please let me know if everything is fine now

aethelwulffe · 2018-06-11T17:53:30Z

Looks good to me!
I just want to play with the code. I don't (as much) much care what it is called!

pri2si17-1997 · 2018-06-12T18:52:26Z

Hi @Trodrige , You need to add new instructions, from scratch, how to handle two databases. It would be easier to follow.

aethelwulffe · 2018-06-13T15:00:40Z

Modules/ReportGenerator/Http/Controllers/ReportGeneratorController.php

-      return url('reportgenerator/showReport');
+      $option_ids = serialize($option_ids);
+      return response()->json([
+          'redirecturl' => 'http://localhost:8000/reportgenerator/report/'.$option_ids,


Shoutcast port? :)

Not sure what this affects, but might need to be configurable/discoverable. For instance, this would not work in my production setup. localhost does one thing. 127.0.0.1 does something completely different.
-I am sure you have this under consideration, or it is actually a non-issue...I am just making sure you know I am here! 😺

I have this @aethelwulffe I'll use the $DB_HOST global.

aethelwulffe · 2018-06-13T15:08:20Z

Modules/ReportGenerator/Resources/views/layouts/master.blade.php

        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <meta name="viewport" content="width=device-width, initial-scale=1">
        <meta name="author" content="Tigpezeghe Rodrige K. @ [email protected]">
-        <metan name="description" content="GSoC2018: Building a report generator for LibreHealthEHR">


Taken care of!

aethelwulffe · 2018-06-13T15:08:37Z

public/assets/js/master.js

    data: { ids: option_ids },
    dataType: 'json',
    success: function(response){
-      alert("You've successfully sent the unique ids");
+      console.log(response);
+      //alert("You've successfully sent the unique ids");


Yes, debug.

aethelwulffe · 2018-06-13T15:11:50Z

public/assets/js/master.js

    }
  });
 }

 $(document).ready(function() {
-  $('#generate-button').click(function() {
+  $('#generate-button').click(function(e) {
+    e.preventDefault();
    if (jQuery.isEmptyObject(IDs)) { // check if the user has dropped any component before trying to generate a report
      alert("Please drag and drop components before you can generate a report!");


"Cannot create a blank report. Please drag and drop at least one component into your new report before attempting to generate it."
OR
"Cannot generate a blank report! You must add at least one component."

I thought of that, and it escaped me. Handling it now!

pri2si17-1997 · 2018-06-13T16:00:19Z

Modules/ReportGenerator/Database/Migrations/2018_05_25_203256_create_report_formats_table.php

@@ -0,0 +1,46 @@
+<?php
+/**
+ * This file creates draggable_components for the report-generator.


It should be "This file created report_format for report-generator." . Just a guess.

pri2si17-1997 · 2018-06-13T16:06:45Z

...tor/Database/Migrations/2018_06_04_083903_create_draggable_component_report_format_table.php

+            $table->foreign('draggable_component_id')->references('id')->on('draggable_components');
+            $table->integer('report_format_id')->unsigned()->comment = "Ussed to access the report_formats.";
+            $table->foreign('report_format_id')->references('id')->on('report_formats');
+


There should be something, that what happens if it is deleted. Like onDelete('cascade').

pri2si17-1997 · 2018-06-13T16:08:26Z

Modules/ReportGenerator/Resources/views/index.blade.php

-                                    <div class="col-sm-3" id="draggable"><p>I am seven</p></div>
-                                    <div class="col-sm-3" id="draggable"><p>I am eight</p></div>
+                                <div class="row" id="draggable-column">
+                                    @foreach ($draggableComponents as $draggableComponent)


This is good use of foreach to write compact code. 👍

foreach is indeed a beautiful construct. One that sometimes leaves me thinking "My code can't work! There isn't enough....CODE!" 😜

My mentors catch everything!!!

aethelwulffe · 2018-06-14T23:35:53Z

Pri is your mentor here. I am the Laravel noob peanut gallery blowing the Vuvuzela.

Trodrige · 2018-07-02T11:23:48Z

@pri2si17-1997 in order to these recent changes, you have to run 'php artisan module:migrate-refresh ReportGenerator' in the project folder.
Use the 'librereportgenerator.sql' file in the Documentation folder to populate the draggable_components table. BANG!

Generate reports
Add System Feature
Save Report Format
Leave your comments!!!

pri2si17-1997 · 2018-07-02T17:42:33Z

Hi! @Trodrige

I got your code working, please see attached screenshot :

General Comments :

[1] Search button is not visible.
[2] Not able to find any draggable componets, probably because I haven't imported from your sql file. I can see if I import your data. So in this case, if your table is empty, you should have some relevant message there, like 'Oops! No components available.'
[3] Why query part is disabled?

Specific Comments:

[1] You should have detailed instruction, on how to make it up. And add what is relevant to you. Like if you do not need base db, just remove its all contents, it should not throw error in your migrate command.

[2] Do not take dump of your specific table. Take dump of database.

[3] I am not able to search my created system feature. Nothing happens.

[4] Is there any specific order of dragging components or it will handle automatically?

[5] I am getting this error, when trying to generate report.

These are my findings. I would suggest you to modify instruction, considering a new bie with only laptop in his hand is going to build your code and request from @aethelwulffe @teryhill @tmccormi to review it and give their feedback.

pri2si17-1997 · 2018-07-02T17:43:53Z

Documentation/librereportgenerator.sql

+-- --------------------------------------------------------
+
+--
+-- Dumping data for table `report_formats`


Take dump of whole database. What if user do not run migrations or somehow migration fails? He/she do not know your table structure.

I took these when I had no entries for report_formats, and system features in the database. I'll populate those tables with some entries and dump again!

I meant that you are taking dump of one table draggable_components. Instead take dump of whole database librereportgenerator. I think now I'm clear.

If I export the entire database, then it'll have CREATE TABLE xyz, and migration command takes care of creating tables.
We need only the INSERT sql statements in this file.

pri2si17-1997 · 2018-07-02T17:44:55Z

Modules/ReportGenerator/Resources/views/index.blade.php

+                                    @foreach ($draggable_components as $draggable_component)
+                                        <div class="col-sm-2 wordwrap draggable" id="{{ $draggable_component->option_id }}">
+                                            <p data-toggle="tooltip" data-placement="top" title="{{ $draggable_component->title }}">
+                                                {{ $draggable_component->title }}


I like templating. 👍

pri2si17-1997 · 2018-07-02T17:45:53Z

Modules/ReportGenerator/install.txt

+1. Create your own .env file from the .env.example fill
+2. Edit the database variables as for your report generator database connection.
+3. Create a new database with the database name you specified in DB_REPORT_GENERATOR_DATABASE
+4. Run php artisan module:seed ReportGenerator


No need to have a separate file. Merge this and instructions.txt to Readme.

pri2si17-1997 · 2018-07-02T17:46:41Z

app/Console/Commands/CreateDatabase.php

+         *  @TODO: Uncomment the line below when EHR is in full Laravel mode.
+         *  That is, when the EHR has been completely ported to Laravel.
+         */
+    	 //$this->createDB(env('DB_DATABASE'), env('DB_HOST'), env('DB_PORT'), env('DB_USERNAME'), env('DB_PASSWORD'));


I have uncommented this line to make it working.

Should I uncomment and push?

Trodrige · 2018-07-02T18:42:25Z

Hello @pri2si17-1997

General answers

Hover over the search button. I'll make it colourful if it's trouble!
For now, you have to import the draggable components. Subsequently, I'll populate the tables with default draggable components, system features and report formats automatically. For now, let's roll this way. I know it's painful, but I'll take care of this!
The query part is an aside from my project. That is not necessary, but we'll implement it after the main report generator we had in mind is up and running.

Specific answers

I've taken care of the instructions for setting up the database.
I don't think I understand!!! Anyways, this is what I think. You want the librereportgenerator.sql file to have INSERTs for all tables. The report generator will have the opportunity for the user to create all those things. In addition, we'll have default draggable components, system features, and report formats. I've not yet added enough data for the last 2.
The search isn't working yet. The next thing on my TODO list is creating a page to edit/delete system feature and reports. The system features also have to show up as menu items in the navbar. Then the report formats under each system feature will be displayed in the list under each menu (system feature) item.
There is no specific order of dragging components. The generated report displays in the order the user dragged the components. I'm not sure if this answers your question.
For the error you're getting, please make sure you enter correct details for the main libreehr database in your .env file. The laravel application doesn't see your database. Maybe you've specified a wrong database name. Check port, username and password.

aethelwulffe · 2018-07-04T15:37:34Z

Teacher: "Little boy, what is 24 divided by 8?"
Little Boy: "I don't know. What do you think?"
Teacher: "I don't THINK, I KNOW!"
Little Boy: "Well I don't think I know either!"

On 2. above (sort of): The Layout Engine allows users to alter tables like patient_data. This includes deletions. That is not great, and should at least have a "blacklist" of fields that cannot be modified through the GUI at very least. Many installations have been bricked by someone doing a general cleanup and deleting something useless appearing like "genericval2". It may be worth looking at having a robust enough "report troubleshooter" so that if, after the report is created, if something gets broken, each query involved can be run sequentially to report to the user in plain language where the problem is.

Trodrige · 2018-07-05T06:45:57Z

@aethelwulffe I don't think I'm getting you clearly here. Which '2 above' are you referring to?
Let me just explain this here.

A user of the report generator will have default draggable components, system features, and report formats that they can't edit or delete. The users can only edit and/or delete those that they have created. There is no action done in this report generator that will delete data in the patient_data table. NONE. The users of the report generator can only view these data. The only data they have permission to edit/delete are those for the draggable components, system features and report formats that they created.

I don't know if this is what you were referring to, but I think it's something we all should know.

aethelwulffe · 2018-07-05T14:07:36Z

Right. You can't use the report gen to delete core things. Other things can delete things. Then your report tries to run.
-The thought above was to see if there was something simple we could do to let the user know why the report they built and have been using has suddenly stopped working. They might get an error message that means something to them, depending on how the server is set up.

-I am just thinking about how everything can fall to pieces. I am a systems engineer. That is my job. 😜

aethelwulffe · 2018-07-31T19:10:25Z

public/pdf_report.php

@@ -1 +0,0 @@
-<?php echo 'yes it worked!!!'; ?>


error_log("Yes, it still does work")
👍

aethelwulffe · 2018-08-03T17:52:05Z

Component pool, or component ocean? :)

Trodrige · 2018-08-06T17:02:28Z

https://tigrodrige.wordpress.com/2018/08/06/gsoc-2018-final-submission/

If @pri2si17-1997 and @aethelwulffe can confirm, then I can submit my final evaluation and continue work here.

pri2si17-1997 · 2018-08-14T18:28:28Z

Hi @Trodrige ,

Please see point 7 and 8. System features are of same name. So is it desirable? IMO system features should be unique.

Trodrige · 2018-08-16T01:28:51Z

@pri2si17-1997 thanks for observing. I'll fix that ASAP.

Trodrige · 2018-08-17T06:59:52Z

@pri2si17-1997 @aethelwulffe hope y'all doing great. I moved the work to the main repo in order to work on installation. This is the pr below. just head to localhost:'port'/modules/report_generator/public/reportgenerator while trying to test the PR in the link below.
LibreHealthIO/lh-ehr#1225

Pri, I fixed the duplicate entries for system features and report formats too.

robbyoconnor · 2021-09-19T05:14:38Z

Shall this be closed?

Trodrige added 2 commits May 26, 2018 11:31

Adding migrations and models for report generator tables

7c71034

An attempt to add Factories and seeders for the report generator. Add…

3db8a1b

…ed a report generator table connection

Trodrige requested a review from pri2si17-1997 May 28, 2018 13:17

Trodrige added 2 commits June 4, 2018 21:11

Added the junction table for report format and draggable component re…

b62f74a

…lationship. Updated instructions

display draggable components

ff73094

aethelwulffe reviewed Jun 6, 2018

View reviewed changes

pri2si17-1997 reviewed Jun 6, 2018

View reviewed changes

Getting the option IDs of selected components

eae3984

Trodrige closed this Jun 11, 2018

Trodrige deleted the GSoC2017_Report_Generator branch June 11, 2018 09:35

Trodrige changed the title ~~GSoC2017 report generator~~ GSoC2018 report generator Jun 11, 2018

Trodrige restored the GSoC2017_Report_Generator branch June 11, 2018 17:39

Trodrige reopened this Jun 11, 2018

Sending CSRF header and getting response from controller

2fc50a5

aethelwulffe reviewed Jun 13, 2018

View reviewed changes

pri2si17-1997 reviewed Jun 13, 2018

View reviewed changes

corrected previous PR. Added command to create two laravel-ehr databases

84cb384

An attempt to get data from selected columns, and send to views

2e6ac8d

Adding ability to save report format. Adding entries to join table

b1cb778

Updating instruction.txt to show Libre EHR Db configurations

780e21a

pri2si17-1997 reviewed Jul 2, 2018

View reviewed changes

Merging install and instruction files in README file

8e281b5

Trodrige added 7 commits July 5, 2018 17:24

dumping test data for features and report formats

83de3ee

updating and deleting system features

6b70601

Delete report format

c932ea5

Edit report format title and description

4558a47

View existing report from selected report format

29bbb2b

hiding save report format button when showing existing report

00a4f22

Adding pdf_report.php for PDF generation function

bc024c6

Trodrige force-pushed the GSoC2017_Report_Generator branch 2 times, most recently from c88eeec to 425b965 Compare July 28, 2018 15:12

sending for columns for use in pdf generation

7f33e3f

Trodrige force-pushed the GSoC2017_Report_Generator branch from 425b965 to 7f33e3f Compare July 28, 2018 15:57

aethelwulffe reviewed Jul 31, 2018

View reviewed changes

keeping all draggable components in drop box and draggable pool.

ecc9ebc

--amend

2320022

GSoC2018 report generator #1

Are you sure you want to change the base?

GSoC2018 report generator #1

Conversation

Trodrige commented May 28, 2018

aethelwulffe commented May 28, 2018 • edited Loading

aethelwulffe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Trodrige Jun 8, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pri2si17-1997 commented Jun 6, 2018

teryhill commented Jun 6, 2018

aethelwulffe commented Jun 11, 2018

Trodrige commented Jun 11, 2018

Trodrige commented Jun 11, 2018

aethelwulffe commented Jun 11, 2018

pri2si17-1997 commented Jun 12, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aethelwulffe commented Jun 14, 2018

Trodrige commented Jul 2, 2018

pri2si17-1997 commented Jul 2, 2018

General Comments :

Specific Comments:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Trodrige commented Jul 2, 2018

aethelwulffe commented Jul 4, 2018

Trodrige commented Jul 5, 2018

aethelwulffe commented Jul 5, 2018

Choose a reason for hiding this comment

aethelwulffe commented Aug 3, 2018

Trodrige commented Aug 6, 2018

pri2si17-1997 commented Aug 14, 2018

Trodrige commented Aug 16, 2018

Trodrige commented Aug 17, 2018 • edited Loading

robbyoconnor commented Sep 19, 2021

aethelwulffe commented May 28, 2018 •

edited

Loading

Trodrige Jun 8, 2018 •

edited

Loading

Trodrige commented Aug 17, 2018 •

edited

Loading