User Tools

Site Tools


onboarding:nova:start

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
onboarding:nova:start [2022/10/11 10:59] 10.91.110.100onboarding:nova:start [2023/03/03 16:40] (current) – [EMS NOVA Development Details] 10.91.129.4
Line 1: Line 1:
 ====== EMS NOVA  Development Details ====== ====== EMS NOVA  Development Details ======
-Updated by Anna Dowling 04/10/2022+Updated by Dylan Fennelly 02/03/2023
  
 ===== Overview ===== ===== Overview =====
Line 27: Line 27:
   * https://bitbucket.org/errigal/userprofile/branch/master   * https://bitbucket.org/errigal/userprofile/branch/master
   * https://bitbucket.org/errigal/rdf_orchestrator/branch/master   * https://bitbucket.org/errigal/rdf_orchestrator/branch/master
 +  * https://bitbucket.org/errigal/rdf_agent/branch/master
 +  * https://bitbucket.org/errigal/rdf_tracker/branch/master
    
   * See also: [[onboarding:elastic-replicator:start|Elastic Replicator (Elastic Replicator)]]   * See also: [[onboarding:elastic-replicator:start|Elastic Replicator (Elastic Replicator)]]
Line 46: Line 48:
  
 ===== Development Configuration ===== ===== Development Configuration =====
-Project can be pointed at local or server deployed version of all api endpoints.  +To run a local instance of EMS Nova, 
-See src/config/config.json for environment configuration for local dev.+  - Clone the EMS Nova repository from BitBucket using Git: https://bitbucket.org/errigal/ems-nova/src/master/ (Note: Permissions may need to be granted to your BitBucket account to access the repository) 
 +  - Open the project in an IDE. In the terminal, run the ''npm install'' command to install Node dependencies. 
 +  - In ''src/config/config.json'', certain API endpoints must be changed: 
 +  * Under ''authConfig'', the "redirectUri" field must be set to ''"http://localhost:4230/callback"''
 +  * If a local version of IDMS Proxy is being run, the "proxyApiUrl" field of ''proxyConfig'' must be changed to ''"http://localhost:8080"'' 
 +  * If a specific environment's applications are required, the URLs of all non-local applications must additionally be changedThe general format for these URLs is ''"https://environment.errigal.com/application/path"''
  
-For further information on application configuration for local development see [[https://bitbucket.org/errigal/ems-nova/src/master/README.md|README.MD]]+To run the development server, execute the ''ng serve'' command in the terminal. After the command executes, an instance of the EMS Nova application will be opened on http://localhost:4230/ 
 +---- 
 + 
 +For further information on application configuration for local developmentsee [[https://bitbucket.org/errigal/ems-nova/src/master/README.md|README.MD]]
  
 ===== Deployment ===== ===== Deployment =====
Line 129: Line 139:
 </code> </code>
 ===== Permissions ===== ===== Permissions =====
 +Permissions are retrieved from userprofile for the current user on authentication. These are leverage to control what the use has authorization to access within the application. The below diagram outlines the permissions data storage model and retrieval touchpoints.
 +
 +{{ :onboarding:nova:novapermissions.drawio.png?600 |}}
 +
 +Permissions can be set via userprofile on the SnmpManager profile associated with a user. To understand what permissions map to what area in the ems-nova front end a string search of the code will show the validation on individual ui components e.g. derived-tree. PLEASE NOTE: If multiple of the same permission are assigned nova will default to the lowest access permission type (e.g FULL and VIEW = VIEW. See also ems_nova.CheckPermissionsDirective, ems_nova.PermissionService. Current full list of current permissions is as follows:
 +
   * DERIVED_TREE - CREATE   * DERIVED_TREE - CREATE
   * DERIVED_TREE - DELETE   * DERIVED_TREE - DELETE
Line 149: Line 165:
   * VIEW_DEVICE_IN_LEGACY_EMS - VIEW   * VIEW_DEVICE_IN_LEGACY_EMS - VIEW
  
-===== Screens =====+===== MDC Translator Parameter Ui Configuration ===== 
 +* MDC Translator Ui Configuration - [[onboarding:nova:mdctranslatoruiconfig|MDC Translator Ui Configuration]] (used to specify technology specific parameters for display on the device overview page) 
 + 
 +===== Build / Deploy =====
  
 === Ansible Playbooks === === Ansible Playbooks ===
Line 158: Line 177:
 === Jenkins Build === === Jenkins Build ===
 https://jenkins.errigal.com:8443/job/ems-nova/ https://jenkins.errigal.com:8443/job/ems-nova/
 +
 +===== Screens =====
 +Below are some of the main screens associated with the application. For more in depth review of the UI please visit any existing environment e.g. https://qanova.errigal.com/ems-nova/home
 +=== System Overview - Host Tree ===
 +{{ :onboarding:nova:screenshot_2022-10-11_at_11.27.25.png?400 |}}
 +
 +=== System Overview - Derived Tree Builder ===
 +{{ :onboarding:nova:screenshot_2022-10-11_at_11.27.40.png?400 |}}}}
 +
 +=== System Overview - Header and Map ===
 +{{ :onboarding:nova:screenshot_2022-10-11_at_11.27.48.png?400 |}}
 +
 +=== System Overview - Charts ===
 +{{ :onboarding:nova:screenshot_2022-10-11_at_11.28.00.png?400 |}}
 +
 +=== Device Overview - Tree ===
 +{{ :onboarding:nova:screenshot_2022-10-11_at_11.52.33.png?400 |}}
 +
 +=== Device Overview -Header / Alarm, Ticket, Asset Info, Map ===
 +{{ :onboarding:nova:screenshot_2022-10-11_at_11.52.38.png?400 |}}
 +
 +=== Device Overview - Parameters ===
 +{{ :onboarding:nova:screenshot_2022-10-11_at_12.08.45.png?400 |}}
 +
 +{{ :onboarding:nova:screenshot_2022-10-11_at_12.09.48.png?400 |}}
 +
 +=== Device Overview - Charts ===
 +{{ :onboarding:nova:screenshot_2022-10-11_at_12.07.00.png?400 |}}
 +{{ :onboarding:nova:screenshot_2022-10-11_at_11.52.46.png?400 |}}
 ---- ----
onboarding/nova/start.1665482391.txt.gz · Last modified: 2022/10/11 10:59 by 10.91.110.100