Produced by Araxis Merge on 8/1/2019 1:42:49 PM Eastern Daylight Time. See www.araxis.com for information about Merge. This report uses XHTML and CSS2, and is best viewed with a modern standards-compliant browser. For optimum results when printing this report, use landscape orientation and enable printing of background images and colours in your browser.
# | Location | File | Last Modified |
---|---|---|---|
1 | JLV_2_8_0_0_0_July_2019.zip\JLV_2_8_0_0_0_July_2019\reportbuilder_va | README.md | Mon Jul 8 19:18:40 2019 UTC |
2 | JLV_2_8_0_0_0_July_2019.zip\JLV_2_8_0_0_0_July_2019\reportbuilder_va | README.md | Tue Jul 30 17:57:24 2019 UTC |
Description | Between Files 1 and 2 |
|
---|---|---|
Text Blocks | Lines | |
Unchanged | 3 | 272 |
Changed | 2 | 4 |
Inserted | 0 | 0 |
Removed | 0 | 0 |
Whitespace | |
---|---|
Character case | Differences in character case are significant |
Line endings | Differences in line endings (CR and LF characters) are ignored |
CR/LF characters | Not shown in the comparison detail |
No regular expressions were active.
1 | # Report B uilder | |
2 | ||
3 | Report Bui lder is a Java [Spri ng Boot](h ttps://pro jects.spri ng.io/spri ng-boot/) based web service th at produce s clinical reports i n PDF form . The repo rt request s typicall y come for m the Join t Legacy V iewer (JLV ) web appl ication. | |
4 | ||
5 | ## Install ation and Deployment | |
6 | ||
7 | Report Bui lder uses [Maven](ht tps://mave n.apache.o rg/) to bu ild the pr oject and produce de ployment a rtifacts. The produc tion profi le will pr oduce a wa r artifact by defaul t, but oth er profile s (develop ment, test ) will pro duce a far jar for s tandalone deployment . | |
8 | ||
9 | #### Depen dencies | |
10 | * [wkhtmlt opdf](http s://wkhtml topdf.org/ ) (HTML to PDF conve rter binar y) for tar get platfo rm (Linux, Mac, Win) | |
11 | * [Java Cr yptography Extension ](http://w ww.oracle. com/techne twork/java /javase/do wnloads/jc e-7-downlo ad-432124. html) Need to perfor m AES 256b it encrypt /decrypt o f reports. | |
12 | See also [ AES 256 wi th Java](h ttp://www. ensor.cc/2 014/02/aes -256-encry ption-with -java-and- jceks.html ) | |
13 | ||
14 | #### Encry ption | |
15 | ||
16 | Report enc rypt/decry pt key nee ds to be g enerated u sing the j ava keytoo l. | |
17 | ||
18 | * [AES-256 Encryptio n with Jav a and JCEK S](http:// www.ensor. cc/2014/02 /aes-256-e ncryption- with-java- and-jceks. html) | |
19 | ||
20 | * [AES-256 Encryptio n Utility github](ht tps://gith ub.com/mik e-ensor/ae s-256-encr yption-uti lity) | |
21 | ||
22 | To generat e encrypti on key, on e option i s to use t he followi ng keytool command: | |
23 | ||
24 | ```text | |
25 | $ keytool -genseckey -keystore <keystore _name>.jck -storetyp e jceks -s torepass < keystore-p assword> - keyalg AES -keysize 256 -alias reportbui lder -keyp ass <key_p assword> | |
26 | ``` | |
27 | ||
28 | Then updat e your env ironment c onfigurati ons with t he path to the keyst ore along with encry pted value s (using E ncryptUtil from HuiC ore) of th e alias, k eystore pa ssword, an d key pass word: | |
29 | ||
30 | ```text | |
31 | aes.keysto re.file=D: \\reportbu ilder\\aes -keystore- developmen t.jck | |
32 | aes.keysto re.alias=P G6wcF5pSPQ OgAKYeotVC Q== | |
33 | aes.keysto re.storepa ss=T3l/JIz cxoo/HCk/L dWFIQ== | |
34 | aes.keysto re.keypass =gGVwRnz4t hoYHJ1Z3v0 mlg== | |
35 | ``` | |
36 | ||
37 | #### Confi guration | |
38 | ||
39 | The main c onfigurati on is loca ted at [re portbuilde r/src/main /resources /applicati on.propert ies](https ://bitbuck et.org/haw aiirg/repo rtbuilder/ src/rel_2. 7.0/src/ma in/resourc es/applica tion.prope rties). | |
40 | ||
41 | Environmen t specific configura tions are applied by modifying a environ ment/profi le specifi c configur ation file using the applicait on-<profil e\>.proper ties conve ntion. | |
42 | ||
43 | See [appli cation-dev elopment.p roperties] (https://b itbucket.o rg/hawaiir g/reportbu ilder/src/ cd07e272f1 9bb3618321 34128af7ed e28fac7586 /src/main/ resources/ applicatio n-developm ent.proper ties) and [applicati on-product ion.proper ties](http s://bitbuc ket.org/ha waiirg/rep ortbuilder /src/rel_2 .7.0/src/m ain/resour ces/applic ation-prod uction.pro perties?at =default&f ileviewer= file-view- default). | |
44 | ||
45 | The netfli x Hystrix configurat ions are l ocated at [reportbui lder/src/m ain/resour ces/config .propertie s](https:/ /bitbucket .org/hawai irg/report builder/sr c/rel_2.7. 0/src/main /resources /config.pr operties) | |
46 | ||
47 | Logging is configura tion is lo cated at [ logback-sp ring.xml]( https://bi tbucket.or g/hawaiirg /reportbui lder/src/r el_2.7.0/s rc/main/re sources/lo gback-spri ng.xml) | |
48 | ||
49 | Also, for 256 bit en cryption t o work, yo u must ove rwrite the JRE/lib/s ecurity li braries wi th the jar s from the [Java Cry ptography Extension] (http://ww w.oracle.c om/technet work/java/ javase/dow nloads/jce -7-downloa d-432124.h tml). | |
50 | ||
51 | #### MSSQL Server Up dates | |
52 | ||
53 | Ensure tha t Microsof t SQL Serv er is upda ted with t he latest reportbuil der sql sc ript. | |
54 | ||
55 | See [JLVSQ L/tables/R EPORT_BUIL DER.Table. sql](https ://bitbuck et.org/haw aiirg/jlvs ql/src/def ault/table s/REPORT_B UILDER.Tab le.sql). | |
56 | ||
57 | #### Packa ging | |
58 | ||
59 | mvn packag e -P <prof ile\> | |
60 | ||
61 | Package fo r producti on | |
62 | ||
63 | ```bash | |
64 | $ mvn pack age -P pro duction | |
65 | ``` | |
66 | ||
67 | #### Deplo yment to V irtual Mac hine | |
68 | ||
69 | Use JLV en vironment to deploy reportbuil der box | |
70 | ||
71 | ```bash | |
72 | $ ruby jlv _env.rb up reportbui lder | |
73 | ``` | |
74 | ||
75 | #####Use a Shared Fo lder | |
76 | ||
77 | * Set shar ed a vagra nt folder with repor tbuilder/t arget: | |
78 | ||
79 | * Edit *.. /jlvenv/re portbuilde r/Vagrantf ile* | |
80 | ||
81 | * Uncommen t: *config .vm.synced _folder ". ./../repor tbuilder", "/home/va grant/repo rtbuilder" * | |
82 | ||
83 | * Reload t he Virtual Machine | |
84 | ||
85 | ```bash | |
86 | $ ruby jlv _env.rb re load repor tbuilder | |
87 | ``` | |
88 | ||
89 | #####Repor t Builder Installati on | |
90 | * Log into the repor tbuilder V irtual Mac hine | |
91 | ||
92 | ```bash | |
93 | $ ssh vagr ant@ IP | |
94 | ``` | |
95 | ||
96 | The pass word is va grant | |
97 | ||
98 | * To view logs | |
99 | ||
100 | ```bash | |
101 | $ tail -f /var/log/r eportbuild er.log | |
102 | ``` | |
103 | ||
104 | * Test tha t reportbu ilder is u p and runn ing from h ost machin e | |
105 | ||
106 | ```bash | |
107 | $ curl htt p:// IP /about | |
108 | ``` | |
109 | ||
110 | * To Updat e binary f rom shared folder | |
111 | ||
112 | ```bash | |
113 | $ sh updat e_rb.sh | |
114 | ``` | |
115 | ||
116 | #####Run t ests from Virtual ma chine | |
117 | ||
118 | ```bash | |
119 | $ cd repor tbuilder | |
120 | $ mvn test -DskipTes ts=false | |
121 | ``` | |
122 | ||
123 | #####Deplo y to a Web Container (Weblogic , Webspher e, Tomcat, etc.) | |
124 | ||
125 | * Install wkhtmltopd f dependen cy on depl oyment mac hines. | |
126 | * Update d eployment environmen t's MSSQL Server wit h latest S QL script. | |
127 | * Ensure t hat the ta rget profi le's appli cation pro perties fi le is corr ect (aws, abl, produ ction) | |
128 | * Build an d package the report builder wa r file. Ut ilize envi ronment pr ofile (aws , abl, pro duction, e tc.) | |
129 | ||
130 | ```bash | |
131 | $ mvn package - P abl | |
132 | ``` | |
133 | ||
134 | * Copy rep ortbuilder -2.x.x.x-< profile>.w ar to depl oyment env ironment. | |
135 | * Deploy w ar to the web contai ner. | |
136 | ||
137 | ||
138 |
Araxis Merge (but not the data content of this report) is Copyright © 1993-2016 Araxis Ltd (www.araxis.com). All rights reserved.