From 7ce3f570611ca1a053395a6901cf56648af49379 Mon Sep 17 00:00:00 2001 From: aai <aai@kereval.com> Date: Fri, 29 Oct 2021 15:48:55 +0200 Subject: [PATCH] Update Doc --- docs/installation-guide.md | 59 ++++++++++++++++++++++++++++++++++---- 1 file changed, 53 insertions(+), 6 deletions(-) diff --git a/docs/installation-guide.md b/docs/installation-guide.md index 9fb7056..0fae92d 100644 --- a/docs/installation-guide.md +++ b/docs/installation-guide.md @@ -14,8 +14,9 @@ date: 19/10/2021 4. ##### [Generate Artifact](#generateArtifact) 5. ##### [Prepare BBR](#prepareBBR) 6. ##### [Generate Validator](#generateValidator) -7. ##### [Validate CDA](#validateCDA) -8. ##### [Extras](#extra) +7. ##### [Generation Validator form UML (oprional)](#generateValidatorFromUML) +8. ##### [Validate CDA](#validateCDA) +9. ##### [Extras](#extra) <div id='introduction'/> @@ -292,7 +293,7 @@ Example with SEQUOIA: ``` **For logs:** -> Go to the root folder of the provided output path +> Go to the root folder of the provided output path, then logs/logs-[generation_date_time] > > `cd /home/mylap/Documents/GOC-OUTPUT/logs/logs-[generation_date_time]` @@ -304,9 +305,55 @@ Example with SEQUOIA:  +<div id='generateValidatorFromUML' /> + +## 7. Generate Validator from UML (Alternative) + +This section is just an alternative way to regenerate the validator when the functional specifications changes +without re-running GOC, but just from the generated ```model.uml``` file. + +```bash +> cd /home/mylap/Documents/GOC-OUTPUT/[validator-name]-validator-jar/model/[validator-name].uml +``` +for example for epsos5 + +```bash +> cd /home/mylap/Documents/GOC-OUTPUT/epsos5-validator-jar/model/epsos5.uml +``` + +Then you can edit it with a Text Edito, or a dedicated modeling tool (ex: Topcased). + +**After saving your model, you need to:** + +Go to GOC-OUTPUT/epsos5-validator-jar and do the following: +```bash +> cd /home/mylap/Documents/GOC-OUTPUT/epsos5-validator-jar +> mvn exec:exec@generateValidator -DmvnPath="/opt/apache-maven-3.5.4/bin/mvn" -DcdaProps="cdaepsos" -DprojectName="epsos5" +> mvn clean package +``` + +The generic form of the command is: + +```bash +> mvn exec:exec@generateValidator -DmvnPath="[maven-path]" -DcdaProps="[cdaepsos or cdabasic]" -DprojectName="[validator-name]" +``` + +Your validator will be available at: GOC-OUTPUT/epsos5-validator-jar/target/appassembler/bin +and do the following: + +```bash +> cd /home/mylap/Documents/GOC-OUTPUT/epsos5-validator-jar/target/appassembler/bin +> chmod +x validator.sh +``` + +Now you can refere to [Section 8](#validateCDA) to Validate a CDA document with your new validator. + + + + <div id='validateCDA'/> -## 7. Validate CDA +## 8. Validate CDA Now we are going to use the generated validator.<br> @@ -377,7 +424,7 @@ Here is an example to validate a document with normal case: <div id='utilityScripts'/> -## 8. Utility Scripts +## 9. Utility Scripts As we saw in the previous section: [Generate Validator](#generateValidator), there is too many options to remember for generating a validator.<br> Therefore, that decreases the usability of the tool, so we created some utility scripts for both common generation types: @@ -400,7 +447,7 @@ And just follow the instructions shown by the interactive script. <div id='extra'/> -## 9. Extras +## 10. Extras You can find some previous made documentation here _(belong the old GOC, and could propably not reperesent the actual version)_: - [GOC Instalation guide fo developper](https://docs.google.com/document/d/1G5bmLhFKNjOvg_rxEllidTofYrwxBeZG_kigTM0pqXM/edit?usp=sharing) -- GitLab