Merge pull request #156 from CAST-ANJ/WEBITOOLS-185_Add_doc_for_file_…

…path_parameter_ANJ

WEBITOOLS-185: Adds doc related to file path change in architecture s…

aip-console-jenkins/README.md

@@ -147,6 +147,25 @@ The Snapshot can then be found inside the `Snapshot` tab in AIP Console.
 
 ![create_snapshot_menu](doc/images/create_snapshot_menu.png)
 
+#### Architecture Studio Model Checker
+
+![Menu item to add the model checker step](doc/images/arch_studio_model_checker.png)
+
+The `Architecture Studio Model Checker` will check the application against a model.
+
+This step requires the following :
+
+* An application name against which the model will be checked. <u>This application must exist in AIP Console</u>.
+* A model name which is the name of the architecture model.
+* A report path location where the report will be downloaded.
+* An upload path with filename where the architecture model is located(only required when the architecture model against which the application needs to be checked is not already present in the AIP console).
+
+This step will perform the following actions :
+
+* Upload the file `filename.CASTArchitect` to architecture studio in AIP Console(if file path is provided).
+* Checks the application against the provided model.
+* Downloads the report in the provided report path
+
 #### Onboard Application
 
 Creates an application or uses an existing application to manage source code using a modern on-boarding workflow in CAST
@@ -184,6 +203,9 @@ You can use these environment variables on the following fields in each jobs (wh
 * Snapshot name
 * Domain Name
 * Source File Path
+* Model Name
+* Report Path
+* Upload File Path
 
 You can manually add environment variables to a build or use global jenkins environment variables (see [the jenkins documentation](https://www.jenkins.io/doc/book/pipeline/jenkinsfile/#using-environment-variables))
 
@@ -387,12 +409,13 @@ Under `Advanced Settings` you will find the following parameters :
 * *sleep duration* : Amount of seconds used to fetch the ongoing job status (defaulted to **1s**).
 
 ### Architecture Studio Model Checker
-![Architecture Studio Model Checker step parameters](doc/images/architecture_studio_model_checker.png)
+![Architecture Studio Model Checker step parameters](doc/images/arch_studio_model_checker_build_steps.png)
 The architecture studio model checker step provides the following parameters :
 
 * *Application Name* (**required**): The name of the application for which the analysis will be run.
 * *Model Name*: (**required**): The name of the model to check against the application. 
-* *Report Path*: The path where the downloaded report will be saved. 
+* *Report Path*: The path where the downloaded report will be saved.
+* *Upload File Path*: The path where the architecture model is located.
 
 Under `Advanced Settings` you will find the following parameters :
 

aip-console-tools-cli/README.md

@@ -166,7 +166,7 @@ To **ArchitectureStudioModelChecker**
 To perform *ArchitectureStudioModelChecker* action you can use following command
 
 ```bash
-java -jar .\aip-console-tools-cli.jar ArchitectureStudioModelChecker -s="Console URL" --apikey "valid.key" -n "my-app" --model-name "model filename" --report-path "valid local path"
+java -jar .\aip-console-tools-cli.jar ArchitectureStudioModelChecker -s="Console URL" --apikey "valid.key" -n "my-app" --model-name "model filename" --report-path "valid local path" --file-path "valid filepath with filename"
 ```
 
 ### Advanced Usage
@@ -449,6 +449,8 @@ The available options are :
 
 * `--report-path` or `-p` : The local directory path where the report will be downloaded.
 
+* `--file-path` or `-f` : The local directory path where the model is located.
+
 When AIP Console finishes execution, it will return a specific return code, based on the execution.
 
 Here is a detailed list of all error codes that can be returned by the CLI :