Internal Errigal Collaboration Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== MDC Translator Ui Configuration for Nova ======
 --- //[[anna.dowling@errigal.com|Anna Dowling]] 2022/10/11 11:25//

See also: [[onboarding:mobile:mdctranslatoruiconfig|MDC Translator Ui Configuration for Mobile]]

===== Overview =====
The [[https://bitbucket.org/errigal/mdc-translator/src/master/|mdc-translator]]
 application is leveraged for both mobile and ems-nova to process performance and configuration parameters and assign UiProperty entries to them. At a high level these values can be configured using YAML files per technology which are loaded on bootstrap by the translator application. They can also be inserted via the database directly. (See translator README linked above for more information).

These entries are used to render the performance and configuration specific ui components on the device overview pages in nova.
If a UiProperty is found on a parameter object, it uses the UiProperty specification to attempt to render the parameter in a card. The same object can be used across both mobile and nova to prevent duplication of technology entries.

See sample of UiProperty object for nova below:
<code>
"uiProperty": [
                    {
                        "title": "Power",
                        "uiType": "GAUGE",
                        "row": 2,
                        "column": 1,
                        "order": 1
                    }
                ],

</code>

===== Description of Fields =====
 
  * **title** - will render on parameter card / list entry instead of prettyName or key if specified
  *   **uiType** - used in nova to show different card types
  *   **row** - used in nova to determine how many rows card takes up
  *   **column** - used in nova to determine how many columns card takes up
  *   **order** - determines card order on page
  *   **uiCategory** -
  *   **properties**: properties are configured via the translator key_value table, unused in nova currently but can be leveraged to add addiitonal data / configuration to ui components if required.
===== Current Supported Parameter UiTypes in Nova Device Overview =====

  - GAUGE
  - CHART
  - AMPLIFIER
  - 24HRCHART
  - HORIZONTAL_SLIDER
  - VERTICAL_SLIDER
  - STACKED_SLIDER
  - ANTENNA
  - MICROWAVE
  - TEMPERATURE
Sidebar

Internal Errigal Collaboration Wiki

User Tools

Site Tools

Page Tools
