Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[IMIS] Document generation for quarantine decrees #2696

Closed
markusmann-vg opened this issue Aug 25, 2020 · 7 comments · Fixed by #3184
Closed

[IMIS] Document generation for quarantine decrees #2696

markusmann-vg opened this issue Aug 25, 2020 · 7 comments · Fixed by #3184
Assignees
@MateStrysewske
Labels
feature A new feature to be developed (ticket type) qa-verified Issue has been tested and verified by QA
Projects
Sprint Backlog Team Application (depr...
Milestone
Sprint 95 - 1.51.0

Comments

@markusmann-vg
Copy link

Situation Description

Feature Description

Quarantine documents are generated from docs templates, defined placeholders are replaced by case data. The mechanism provides both a mapping from data available in SORMAS to predefined placeholders as well as ‘free’ placeholders which values are provided by the individual SORMAS
user (e.g., room number of the officer). These user-provided values will be cached client-side.

The service for document generation is complemented by a mechanism to manage templates and a persistence service to store generated documents for a case.
The generalisation of case-related document filing to arbitrary documents has to be kept in mind (see issue #1771).

Backend:

  • Pick a template engine
    to generate a document
  • A service to persist,
    read and delete a template from the DB
  • A service to generate
    a document from a template and a list of key/value pairs

UI:

  • UI element to allow to
    generate a document from a templates
  • UI element for the admin
    console to upload and manage templates

Possible Alternatives

Additional Information
@markusmann-vg markusmann-vg added the feature A new feature to be developed (ticket type) label Aug 25, 2020
@markusmann-vg markusmann-vg added this to the Sprint 92 - 1.48.0 milestone Aug 25, 2020
@akuckartz
Copy link

Maybe you should contact Stadt Köln which did something like that for DiKoMa.

@bernardsilenou
Copy link

@markusmann-vg what about ding it in r and link it to sormasui using any of the following r packages: rmarkdown, sweave or knitr

@JonasCir
Copy link
Contributor

@akuckartz Good point, we already talked to them :)
@bernardsilenou We already started to implement it in Java and we would like to stick to it. Further, no one of our team is familiar with R.

@JonasCir
Copy link
Contributor

Just to clarify, we already investigated the issue and talked to several GAs about their requirements. Implementation is in progress 👍

@JonasCir JonasCir mentioned this issue Sep 18, 2020
Closed
@ftavin ftavin mentioned this issue Sep 29, 2020
Closed
@StefanKock StefanKock removed this from the Sprint 93 - 1.49.0 milestone Oct 6, 2020
@JonasCir JonasCir mentioned this issue Oct 9, 2020
Closed
@syntakker syntakker mentioned this issue Oct 19, 2020
Closed
MateStrysewske pushed a commit that referenced this issue Oct 27, 2020
@syntakker @JoshuaRenckens
@JonasCir @s8jorenc @DavidBaldsiefen
[IMIS] #2696 document generation quarantine (#3184)
4294320 
* move TemplateEngineService to new branch (#8)

* TemplateEngineService EJB Test (#8)

* Generic test cases for TemplateEngineService (#8)

* use system's default charset (#8)

* revert: use system's default charset (#8)

* normalize Windows line ending (#8)

* normalize Windows line ending (#8)

* move TemplateEngineService to new branch (#8)

* TemplateEngineService EJB Test (#8)

* Generic test cases for TemplateEngineService (#8)

* use system's default charset (#8)

* revert: use system's default charset (#8)

* normalize Windows line ending (#8)

* normalize Windows line ending (#8)

* rudimentary QuarantineOrderFacade + Test (#8)

* add quarantine button mockup (#8)

* technical Durchstich :-) (#8)

* extra template testcase written in Word

* remove obsolete line ending cleanup (#8)

* Change wording to "Quarantine order" (#8)

* Create GUIDE_DOCUMENT_GENERATION.md

* Quarantine test docx, Issue #8

* EntityDtoAccessHelper for variable name mapping (#8)

* EntityDtoAccessHelper for variable name mapping (#8)

* EntityDtoAccessHelper property as String (#8)

* Fixes and test case (#8)

* Quarantine.docx in cargo server (#8)

* cleanup

* Fix docx templates (#8)

* Fix docx templates (#8)

* Allow property access in templates (#8)

* read available templates (#8)

* added proper i18n label and caption

* template selection (#9)

* template selection (cleanup) (#9)

* preliminary template upload (#5)

* added rudimentary template-management-ui (#6)

* Merge

* template variables + preliminary template delete (#5)

* assert sucessful template deletion (#5)

* read additional variables (#8)

* Added rudimentary template management and ui (#6 and #4)

* integrate additional variables in UI (#9)

* textfield width (#9)

* fix deselect template (#9)

* Improved Template-Management UI (#6)

* QuarantineOrderFacade.getTemplate (#8)

* Added functionality to view-template buttn (#6)

* Validate templates (#8)

* Check if template exists (#8)

* Replace IllegalArgumentException by ValidationException (#8)

* Fix QuarantineOrderComponent (#9)

* Added error handling (#6)(#4)

* improved error messages #6

* Various Template UI improvements (#6)

* Added user right DOCUMENT_TEMPLATE_MANAGEMENT (#4)

* Refactored 'Template...' to 'DocumentTemplate...'

* Popup window for document generation (#9)

* Fix validateTemplateTest for Windows (#8)

* Added full i18n support (#6)

* Document Template Guide (#4)

* Link to Document Template Guide in UI (#9)

* Fix typo (#9)

* Quarantine order for contacts (#9)
Fix I18N test

* Test for wrong ReferenceDto type (#8)

* User Right QUARANTINE_ORDER_CREATE (#9)

* cleanup (#9)

* hide quarantine box unless quarantine is HOME or INSTITUTIONELL (#9)

* cleanup Strings and Captions (#9)

* cleanup Strings and Captions (#9)

* fix merge

* refactor (#9)

* fix translation DE (#9)

* exclude admin from QUARANTINE_ORDER_CREATE (only pseudonymized data access) (#9)

* Secure against writing outside template directory (#8)

* Complete I18N (#9)

* QuarantineType.isQuarantineInEffect, unify with visibility of quarantine fields  (#9)

* reset I18nConstantsUpdatedTest (#9)

* Update SORMAS_Data_Dictionary.xlsx and SORMAS_User_Rights.xlsx (#9)

* fix merge (#9)

* merge bugfix #3198

* fix onValueChange (fixes #3198)

* Document Example Templates (#9)

* script ui build and redeploy (#9)

* Document Example Template Word (#9)

* PR #3184 remove de.symeda.sormas.ui.configuration.infrastructure.QuarantineTemplatesGrid

* PR #3184 fix import order

* PR #3184 remove obsolete condition

* PR #3184 use StringUtils.isNotBlank

* PR #3184 fix issues from comments

* PR #3184 remove obsolete redeployUI.sh

* PR #3184 fix issues from comments

* PR #3184 rename MS Word to Microsoft Word

* PR #3184 remove logging

* PR #3184 add explanation of ROOT_ENTITY_NAME

* PR #3184 use specific exception types

* PR #3184 UI fixes

* PR #3184 adjust spacing in UI

* PR #3184 delete obsolete password.txt

* PR #3184 update SORMAS_Data_Dictionary and SORMAS_User_Rights after merge

Co-authored-by: Joshua <justgivemeanacceptablemail@gmail.com>
Co-authored-by: Jonas Cirotzki <s8jociro@stud.uni-saarland.de>
Co-authored-by: s8jorenc <57158691+s8jorenc@users.noreply.github.com>
Co-authored-by: David <david.baldsiefen@stud-mail.uni-wuerzburg.de>
@vidi42 vidi42 added this to the Sprint 95 - 1.51.0 milestone Nov 2, 2020
@vidi42 vidi42 added this to Backlog in Sprint Backlog Team Application (deprecated) via automation Nov 2, 2020
@vidi42 vidi42 moved this from Backlog to Testing in Sprint Backlog Team Application (deprecated) Nov 2, 2020
@vidi42 vidi42 added this to Sprint 95 Application in Product Backlog (deprecated) Nov 2, 2020
@vidi42 vidi42 linked a pull request Nov 2, 2020 that will close this issue
[IMIS] #2696 document generation quarantine #3184
Merged
@vidi42 vidi42 closed this as completed Nov 2, 2020
Product Backlog (deprecated) automation moved this from Sprint 95 Application to Done Nov 2, 2020
@AndyBakcsy-she AndyBakcsy-she added the qa-verified Issue has been tested and verified by QA label Nov 3, 2020
@AndyBakcsy-she
Copy link

AndyBakcsy-she commented Nov 3, 2020 •
edited
Loading

Verified issue on the latest version of SORMAS Version: 1.51.0-SNAPSHOT
Downloading of Quarantine Templates works only when the Quarantine field is enabled and the dates are set.
Uploading templates works as well as expected.

@MateStrysewske
Copy link
Contributor

MateStrysewske commented Nov 3, 2020 •
edited
Loading

  • Allow national users to generate quarantine documents (will be done by me)

@MateStrysewske MateStrysewske reopened this Nov 3, 2020
Sprint Backlog Team Application (deprecated) automation moved this from Done to In Progress Nov 3, 2020
@MateStrysewske MateStrysewske self-assigned this Nov 3, 2020
MateStrysewske added a commit that referenced this issue Nov 4, 2020
@MateStrysewske
#2696 - Allow national users to generate documents
ae95889
Sprint Backlog Team Application (deprecated) automation moved this from In Progress to Testing Nov 4, 2020
@AndyBakcsy-she
Copy link

Validated the new functionality for the National User availability.

@StefanKock StefanKock mentioned this issue Nov 13, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MateStrysewske MateStrysewske

Labels
feature A new feature to be developed (ticket type) qa-verified Issue has been tested and verified by QA
Projects
No open projects
Sprint Backlog Team Application (depr...
  
Done
Milestone
Sprint 95 - 1.51.0
Development

Successfully merging a pull request may close this issue.

[IMIS] #2696 document generation quarantine ImisDevelopers/SORMAS-Project
8 participants
@akuckartz @vidi42 @bernardsilenou @JonasCir @MateStrysewske @StefanKock @markusmann-vg @AndyBakcsy-she