Add more details about stock exit on the voucher receipt #4000

mbayopanda · 2019-11-15T11:32:50Z

This PR update description of the voucher and items of the voucher receipt.

jniles

Technically, this solves the problem, but it can't be translated. Did you look into creating the string in JS as we've done with other descriptions? That would make the most sense to me, if it is possible.

jniles · 2019-11-15T13:03:42Z

server/models/procedures/stock.sql

+      SET voucher_description = CONCAT('Distribution to ', v_patient_description, ' from ', v_depot_description, ' : ', v_voucher_description);
+    END IF;
+
+    IF (v_depot_description IS NOT NULL AND v_patient_description IS NOT NULL AND v_invoice_description IS NOT NULL) THEN 


Oof. This is super complicated. Can't we find a way to do this in JavaScript to get regular translation support? For example, this is how the patient invoice description is created: https://github.com/IMA-WorldHealth/bhima/blob/master/client/src/i18n/en/patient_invoice.json#L15.

We must add a server side api end point for getting details of the description, and before to create a stock movement we must ask the API end point for having description details and after that we can create the stock movement on the client side.

jniles · 2019-11-15T13:04:09Z

test/data.sql

@@ -755,7 +755,7 @@ INSERT INTO `voucher` (uuid, `date`, project_id, currency_id, amount, descriptio
  (@fourth_voucher, CURRENT_TIMESTAMP, 1, 1, 75, 'Fourth Voucher to be Posted', 1, 9);

 -- voucher items sample data
-INSERT INTO `voucher_item` VALUES
+INSERT INTO `voucher_item` (`uuid`, `account_id`, `debit`, `credit`, `voucher_uuid`, `document_uuid`, `entity_uuid`) VALUES


jniles · 2019-11-15T13:04:16Z

server/models/schema.sql

@@ -1865,6 +1865,7 @@ CREATE TABLE IF NOT EXISTS `voucher_item` (
  `voucher_uuid`    BINARY(16) NOT NULL,
  `document_uuid`   binary(16) default null,
  `entity_uuid`     binary(16) default null,
+  `description`     TEXT NULL,


jniles

@mbayopanda, this is a lot better! I've made a few comments to tighten up the code in the client controller. Let me know what you think.

jniles · 2019-11-20T09:44:39Z

client/src/i18n/en/stock.json

-    "EXIT_SERVICE"    : "Exit to a service",
+    "EXIT_DEPOT"      : "Distribution to a depot",
+    "EXIT_PATIENT"    : "Distribution to a patient",
+    "EXIT_PATIENT_ADVANCED" : "Distribution to the patient {{patient}} from depot {{depot}}",


jniles · 2019-11-20T09:49:28Z

server/controllers/admin/services.js


-  db.exec(sql)
+  filters.custom('uuid', 's.uuid = ?');


Does equals not work here?

filters.equals('uuid', 'uuid', 's');

jniles · 2019-11-20T09:49:41Z

server/controllers/finance/reports/vouchers/receipt.handlebars

@@ -61,7 +61,13 @@
      {{#each items}}
        <tr>
          <td>{{number}}</td>
-          <td>{{label}}</td>
+          <td>
+            {{#if description}}


jniles · 2019-11-20T09:52:16Z

client/src/modules/stock/exit/exit.js

@@ -427,6 +429,53 @@ function StockExitController(
    };
  }

+  function buildDescription(entityUuid, invoiceUuid) {
+    const glb = {};
+    return PatientService.read(null, { uuid : entityUuid })


If these services are based on the PrototypeAPIService, you should be able to call .read() with the uuid directly to return a JSON object. For example:

PatientService.read(null, { uuid : entityUuid }) .then(([patient]) => {});

becomes

PatientService.read(entityUuid) .then(patient => {});

The reason here is i don't want to get an error if there is nothing, i want to have an empty array instead.

jniles · 2019-11-20T10:02:00Z

client/src/modules/stock/exit/exit.js

+  function buildDescription(entityUuid, invoiceUuid) {
+    const glb = {};
+    return PatientService.read(null, { uuid : entityUuid })
+      .then(([patient]) => {


I think you can probably combine a lot of these calls together to save space and time. For example:

// we use all settled here, since any of these might be undefined. return Promise.allSettled([ PatientService.read(entityUuid), PatientInvoiceService.read(invoiceUuid), ServiceService.read(entityUuid), ]).then(([patient, invoice, service]) => { // etc.. });

jniles · 2019-11-20T10:08:31Z

client/src/modules/stock/exit/exit.js

+    return PatientService.read(null, { uuid : entityUuid })
+      .then(([patient]) => {
+        if (patient) {
+          glb.patientDescription = patient.display_name.concat(` (${patient.reference})`);


If we are mixing both $translate and String.concat(), it probably means we can write a better translation template.

I think what you are trying to achieve is to have a translation with something like this:

Distribution to the patient JNILES (PA.TBD.123) from ...

And your template is

Distribution to the patient {{patient}} from...

I propose you change your template to be:

Distribution to the patient {{patientName}} ({{patientReference}})

And then you could just provide the patientName and patientReference as two different translation keys.

jniles · 2019-11-20T10:11:40Z

client/src/modules/stock/exit/exit.js

+        }
+
+        if (vm.depot.text && glb.patientDescription && glb.invoiceDescription) {
+          description = $translate.instant('STOCK.EXIT_PATIENT_ADVANCED_WITH_INVOICE', {


It looks like your translation key object doesn't change all that much. Let's put all the keys in a single object and use them for each translation. Like this:

const i18nKeys = { patient : glb.patientDescription, depot : vm.depot.text, invoice : glb.invoiceDescription }; // later.. if (x && y) { description = $translate.instant('STOCK.EXIT_PATIENT_ADVANCED', i18nKeys); } if (y && z) { description = $translate.instant('STOCK.EXIT_PATIENT_ADVANCED_WITH_INVOICE', i18nKeys); }

Close Third-Culture-Software#3990

mbayopanda · 2019-11-25T09:00:13Z

@jniles could you review this PR again please

…o upgrade-stock-voucher-receipt

jniles

@mbayopanda, this looks like a good first implementation to me. I would still like to see the stock movement description translated, but we can do that after this is merged.

Once the merge issues are fixed, we can "bors" it.

jniles · 2019-11-26T14:46:52Z

bors r+

4000: Add more details about stock exit on the voucher receipt r=jniles a=mbayopanda This PR update description of the voucher and items of the voucher receipt. ![voucher stock details](https://user-images.githubusercontent.com/5445251/68940634-051c6780-07a4-11ea-8ecf-e7be588f43f6.png) Close #3990 Co-authored-by: mbayopanda <mbayopanda@gmail.com>

bors · 2019-11-26T15:13:49Z

Build succeeded

kwilu added size: L Feature Request labels Nov 15, 2019

jniles reviewed Nov 15, 2019

View reviewed changes

mbayopanda force-pushed the upgrade-stock-voucher-receipt branch from 7f9e515 to e1c4bcb Compare November 18, 2019 14:42

kwilu added size: XL and removed size: L labels Nov 18, 2019

jniles reviewed Nov 20, 2019

View reviewed changes

mbayopanda added 5 commits November 21, 2019 10:59

Add more details about stock exit on the receipt

7e51cd8

Close Third-Culture-Software#3990

add lot in voucher item description

4d117e1

build description on the client

0ec4af1

Enhance description on the client side

4be715a

Enhance description codes

ddcf514

mbayopanda force-pushed the upgrade-stock-voucher-receipt branch from e1c4bcb to ddcf514 Compare November 21, 2019 09:59

Merge branch 'master' of https://github.com/IMA-WorldHealth/bhima int…

3def1aa

…o upgrade-stock-voucher-receipt

jniles approved these changes Nov 26, 2019

View reviewed changes

fix mergin conflicts

0a0a8af

bors bot merged commit 0a0a8af into Third-Culture-Software:master Nov 26, 2019

This was referenced Jan 13, 2020

Do not require stock description if we automatically template them in #4082

Closed

Certain stock transactions are submitted to the journal without a description #4060

Closed

mbayopanda deleted the upgrade-stock-voucher-receipt branch April 27, 2020 11:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add more details about stock exit on the voucher receipt #4000

Add more details about stock exit on the voucher receipt #4000

mbayopanda commented Nov 15, 2019

jniles left a comment

jniles Nov 15, 2019

mbayopanda Nov 18, 2019

jniles Nov 15, 2019

jniles Nov 15, 2019

jniles left a comment

jniles Nov 20, 2019

jniles Nov 20, 2019

jniles Nov 20, 2019

jniles Nov 20, 2019

mbayopanda Nov 21, 2019

jniles Nov 20, 2019

jniles Nov 20, 2019

jniles Nov 20, 2019

mbayopanda commented Nov 25, 2019

jniles left a comment

jniles commented Nov 26, 2019

bors bot commented Nov 26, 2019

Add more details about stock exit on the voucher receipt #4000

Add more details about stock exit on the voucher receipt #4000

Conversation

mbayopanda commented Nov 15, 2019

jniles left a 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

jniles left a 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

mbayopanda commented Nov 25, 2019

jniles left a comment

Choose a reason for hiding this comment

jniles commented Nov 26, 2019

bors bot commented Nov 26, 2019

Build succeeded