User Tools
onboarding:mobile:mobiluiconfig
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| onboarding:mobile:mobiluiconfig [2020/12/14 16:43] – 10.91.120.28 | onboarding:mobile:mobiluiconfig [2021/06/25 10:09] (current) – external edit 127.0.0.1 | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ======MobileUiConfiguration ====== | ||
| + | --- // | ||
| + | ===== Overview ===== | ||
| + | |||
| + | The SnmpManager domain **MobileUiConfiguration** is utilised for inserting parameter entries for display on the device overview page in the Mobile Navigator. These entries are associated with a technology entry via this table.The idms-proxy does a lookup of the parameters with these entries set and passes them to the ParameterResponse for mobile when a user accesses the Device Overview or Component Overview pages. | ||
| + | |||
| + | The purpose of this domain is to provide a mechanism for configuring specific discovered parameters (typically performance parameters) to highlight on the device overview and provide a means of settings alarm thresholds for these measured values. The user can also set appropriate icons for these values from available icons in the idms-mobile directory: **config/ | ||
| + | |||
| + | See also: [[onboarding: | ||
| + | |||
| + | ===== Example of UI Display ===== | ||
| + | |||
| + | {{ : | ||
| + | |||
| + | ===== Configuration ===== | ||
| + | * Current configuration of these values can be done via the following controller link: **SnmpManager/ | ||
| + | |||
| + | * Or via sql insert into the database table **mobile_ui_configuration** . See sample insert sql here: ([[https:// | ||
| + | |||
| + | ===== Description of Fields ===== | ||
| + | |||
| + | boolean showOnOverView // (Set to true to show on DeviceOverview page.) | ||
| + | | ||
| + | boolean showOnComponent // (Set to true to show on Child / Component Overview page.) | ||
| + | | ||
| + | boolean isEditableParameter // (Set to true to show on display edit ui for parameter instead of trheshold ui on either device overview or component overview page.) | ||
| + | | ||
| + | String parameterName // (Can be a partial match(wildcard) of the parameter name matched against the parameter key passed from the MDC orchestrator. Checked in idms-proxy in order go assign parameters to MobileUiConfig entries.) | ||
| + | | ||
| + | String discoveredName // (The full discovered name of the parameter, Also checked in idms-proxy in order go assign parameters to MobileUiConfig entries.) | ||
| + | | ||
| + | Integer priorityOrder // (The order in which the parameters will display in the list on the Device / Component Overview screen.) | ||
| + | | ||
| + | Technology technology // (The technology id this parameter can be discovered under.) | ||
| + | | ||
| + | String uiTag // (Utilised by parameter edit screen to determine which ui type to display (current options for POC are limited to: RANGE_SLIDER / INPUT_TEXT) | ||
| + | | ||
| + | String minimumRange // (Utilised for RANGE_SLIDER ui component in mobile to display a minimum slider range value.) | ||
| + | | ||
| + | String maximumRange // (Utilised for RANGE_SLIDER ui component in mobile to display a maximum slider range value.) | ||
| + | | ||
| + | String lowRange // (Utilised for RANGE_SLIDER ui component in mobile to display a low slider range value.) | ||
| + | | ||
| + | String highRange // (Utilised for RANGE_SLIDER ui component in mobile to display a high slider range value.) | ||
| + | | ||
| + | String iconToDisplay // (The icons to show for this value configured from available icons in the idms-mobile directory: **config/ | ||
| + | | ||
| + | DisplayNameField displayNameField = DisplayNameField.COMBINATION // (The type of display name to show for the header value of the parameter in the mobile UI. Options are: COMBINATION, | ||
| + | | ||
| + | boolean showOnMatchingDiscoveredName // (Allows user to configure a component level discovered parameter to show on the Device Overview page.) | ||
| + | |||
| + | | ||
| + | ===== Example Entry ===== | ||
| + | |||
| + | {{: | ||
| + | |||
| + | ===== API POST Request ===== | ||
| + | Idms Proxy application exposes a REST endpoint which allows for the upload of MobileUiConfiguration and MobileDeviceOptions for a given technologyId. | ||
| + | |||
| + | * **Rest Endpoint:** https:// | ||
| + | * **Type:** POST | ||
| + | * **Authentication: | ||
| + | |||
| + | == Request Format == | ||
| + | < | ||
| + | { | ||
| + | " | ||
| + | , | ||
| + | " | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | ], | ||
| + | " | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | </ | ||
Page Tools
