User Tools

Site Tools


Writing /app/www/public/data/meta/onboarding/mobile/mobiledeviceoptions.meta failed
onboarding:mobile:mobiledeviceoptions

MobileDeviceOptions

Anna Dowling 2020/11/16 08:53

Overview

The SnmpManager domain MobileDeviceOptions is utilised for inserting button permissions entries for display on the device / component overview levels in the Mobile Navigator. These entries are associated with a technology entry via this table.The idms-proxy does a lookup of these entries for the technology id of the device and passes them to the DeviceResponse for mobile when a user accesses the Device Overview or Component Overview pages.

The purpose of this domain is to provide a mechanism for controlling functions accessible to certain technologies such as reboot and ping as well as a means to set permissions at a Device or Component level for these functions. The naming for the Component page can also be configured here to show something else for example Remote for DAS use cases.

Example of UI Display

Configuration

  • Current configuration of these values can be done via the following controller link: SnmpManager/mobileDeviceOptions/create
  • Or via sql insert into the database table mobile_device_options .

Description of Fields

  boolean showLocationInfo // (Controls access to the Location page in the manage tab.)
  
  boolean showMetrics // (Controls access to the Metrics page in the manage tab.)
  
  boolean showDeviceHistory // (No longer used, to be removed.)
   
  boolean showReboot // (Controls access to the Reboot function in the device / component header.)
  
  boolean showTestConnection // (Controls access to the Ping function in the manage tab.)
  
  boolean showMap // (No longer used, to be removed.)
  
  String componentCardName // (Custom name to display at child level overview. Defaults to Component unless specified here.)
  
  String childComponentNameFilterRegex. // (If set filters the list of child devices (components) to show in the list accessable from the Components card on the Device overview page.)
   
  Technology technology // (The technology id this permission is associated with for the network element lookup.)
  
  Level level // (Level to set the permission: DEVICE_OVERVIEW or COMPONENT_OVERVIEW)

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.

Request Format
{
	"technologyId": "37"
	,
	"mobileDeviceOptions": [
			{
	                        "showLocationInfo": true,
				"showMetrics": true,
				"showReboot": true,
				"showTestConnection": true,
				"componentCardName": "Remotes",
				"childComponentNameFilterRegex":"/*test*/",
				"level": "DEVICE_OVERVIEW"
			}
   ],
	"mobileUiConfigurations": [
			{
	             "showOnOverView": true,
	             "showOnComponent": false,
	             "isEditableParameter": false,
	             "parameterName": "test param 1",
	             "discoveredName": "test_1",
	             "priorityOrder": "1",
	             "uiTag": "",
	             "minimumRange": "10",
	             "maximumRange": "100",
	             "lowRange": "30",
	             "highRange": "80",
	             "iconToDisplay": "amplifier",
	             "displayNameField": "Test 1",
	             "showOnMatchingDiscoveredName": false
			},
			{
	             "showOnOverView": false,
	             "showOnComponent": true,
	             "isEditableParameter": true,
	             "parameterName": "test param 2",
	             "discoveredName": "test_2",
	             "priorityOrder": "2",
	             "uiTag": "RANGE_SLIDER",
	             "minimumRange": "10",
	             "maximumRange": "100",
	             "lowRange": "30",
	             "highRange": "80",
	             "iconToDisplay": "amplifier",
	             "displayNameField": "Test 2",
	             "showOnMatchingDiscoveredName": false
	   }
   ]
}
onboarding/mobile/mobiledeviceoptions.txt · Last modified: 2021/06/25 10:09 by 127.0.0.1