• Documentation
• URL Parameter Reference

URL Parameter Reference

Unified Monitoring pages support direct URL query parameters, Application Portal SDK state, and module-specific params. The protocol varies by module. An unsupported location, value, or encoding can cause a parameter to be ignored.

General Rules

1. Place a query before #, for example, /encompass-monitor-hmi/?assetScope=device#/asset-list.

2. Configure page-shape parameters in the menu URL. Application Portal SDK cannot append arbitrary query parameters to that URL.

3. When a direct query and state contain the same parameter, the page normally reads the direct query first.

4. state is module-specific:

Module	state format	Notes
Asset List	Query string	For example, nodeIds=SITE001&defaultDeviceType=WTG, URL-encoded as a whole.
Common KPI Inquiry	Query string	The value of params is a JSON string.
Charting Tool	The entire state is a JSON object	The usual structure is {params, target}.
Portfolio	Direct query recommended	Preconfigure page shape and initial behavior in the target menu URL.

Cross-module Parameters

Parameter	Purpose	Conditions and Limitations
appId / menuCode	Identifies the application and menu context.	Usually provided by Application Portal.
disableMultipleAssetTree	Hides the multiple asset-tree switch when true.	Changes the entry point only; it does not change asset permissions.
useAssociatedResource	Enables associated resources when true.	The target environment and page must support associated resources.
filterParentNodes	Filters parent nodes without permission when true.	This differs from permission checks that show but disable a node.
locale	Sets the page language.	The target environment must support the selected language.

Portfolio Parameters

Default route: /encompass-monitor-hmi/#/portfolio/runtime.

Parameter	Purpose	Notes
disablePageJump	Disables drill-down and some detail navigation when true.	It does not enable navigation.
defaultNodeId / nodeIds	Attempts to preselect asset-tree nodes.	Every node must exist in the current tree and match the page dimension.
assetSticky	Attempts to restore the most recently selected asset when set to solar.	The selection is restored within the page’s saved scope.
windSiteRotatingIconColors	Sets colors that trigger wind-site icon rotation; separate values with commas.	Only matching icon styles are affected.
solarSiteIcon	Enables the supported dynamic solar-site icon when set to yellow.	Other historical values are unsupported.
tiandiKey	Supplies a Tianditu key.	Required only when Tianditu is used and the environment does not provide a key.
disableMultipleAssetTree / useAssociatedResource / filterParentNodes	Controls asset-tree behavior.	See Cross-module Parameters.

Do not use historical solarSiteEnlightIframe, CDSCacheControl, or filterByDomainsolarSiteIcon in new menus.

Asset List Parameters

Default route: /encompass-monitor-hmi/#/asset-list.

Page-shape Parameters (Direct Query)

Parameter	Values/examples	Purpose
assetScope	site / region / device	Sets the site, region, or device dimension.
timeTypes	realtime / history / realtime,history	Sets real-time, historical, or both data types; the default is real-time.
layoutTypes	table / block / piece; comma-separated combinations	Sets table, card, or compact-card views.
enableBlockChart	true / false	Controls trend charts in cards.
siteTypes / deviceTypes	Comma-separated mdmType values	Limits site or device types and their order.
summaryPosition	top / bottom / false	Sets the summary-row position or hides the summary.
showSummaryTitle / showTime	true / false	Controls the summary prefix and page time information.
showDeviceHierarchy	true / false	Controls device-hierarchy filtering.
filterByDomain	true / false	Controls whether asset-type filters are grouped by domain.
srTypes / controlTypes / batchControlTypes	Comma-separated mdmType values	Limits applicable Service Request, single-control, or batch-control types.
controlMaxNum	Positive integer	Limits the number of devices in one batch-control operation.
assetSticky / useAssociatedResource / disableMultipleAssetTree	See Cross-module Parameters	Controls asset memory, associated resources, and the multiple-tree entry point.

Parameters Available Through Direct Query or Query-string state

Parameter	Purpose	Notes
defaultSiteTypes	Preselects site types.	Separate values with commas.
defaultDeviceType	Preselects device types.	Multi-select mode can retain multiple values; single-select mode normally takes the first valid value.
nodeIds	Preselects organization-structure or site nodes.	Separate IDs with commas.
deviceNodeIds	Preselects device nodes.	The current page must support device selection.
cardFilter	Preselects metric-card filters.	For example, GenSiteState*2 or GenActivePower<*2000.
showFilter	Limits available filters and actions.	none hides all; other values are combined according to the page allowlist.
filterParentNodes	Filters parent nodes without permission.	Disabled by default.

Charting Tool Parameters

Default route: /encompass-monitor-hmi/#/charting-tool.

Top-level Parameters

Parameter	Purpose	Notes
disableDataFilter	Hides or limits the data-filter entry.	The page still displays data for the supplied query conditions.
disableMultipleAssetTree	Hides the multiple asset-tree switch.	—
useAssociatedResource / filterParentNodes	Controls associated resources and parent-node filtering.	Direct query only.
params	A URL-encoded query JSON object.	Used in direct-URL mode.
target	A target mode such as modal or blank.	May be supplied with params in the URL or JSON state.

The source precedence is Application Portal JSON state → direct URL params/target → sessionStorage in the current tab. After the first valid params is found, later sources are ignored.

Common params Fields

Field	Purpose	Notes
objType	Analysis object.	siteGroup / site / device.
metas[]	Assets and data fields.	An item can contain mdmIds, keys, name, and packNames.
startTime / endTime / rangeType	Query time.	Use a time format supported by the page.
interval / timeAggMethod	Time granularity and aggregation method.	Available values depend on the data field.
stackType / isInterpolator	Stacking and interpolation.	Applied by chart type.
useUTCTime	Uses UTC time.	Boolean.
openRaw	Allows or uses the raw interval.	A field in params, not a separate top-level query.
enableAssetSelect	Controls the asset selector.	Defaults to true.
editable	Controls whether results can be edited.	Used for embedded or navigation scenarios.
theme / bgColor / title	Controls the presentation theme and title.	—
metaGroups	Preconfigures data groups.	Its structure must match the page grouping protocol.

deviceTreeTypes, siteTypes, and openQuality are page-configuration or historical parameters; do not use them as current top-level navigation parameters.

Common KPI Inquiry Parameters

Default route: /encompass-monitor-hmi/#/metric-tool.

Page-shape Parameters (Direct Query)

Parameter	Purpose	Notes
subjects	Sets the site, device-group, or device analysis object.	Separate values with commas.
siteTypes / checkableSiteTypes	Limits asset types and types that can be selected across sites.	—
deviceTreeTypes	Sets a flat or hierarchical device tree.	Use this spelling; do not use historical devciceTreeTypes.
groupKey	Sets the data-category field group.	The default is determined by page configuration.
orderType	Shows assets by asset-tree or input order.	Common values are default and input.
bigDataMdmTypes	Sets large-data device types.	Large-data mode does not enumerate individual devices.
openFilter	Controls the query-filter entry.	—
regionResourceRegardAsSite	Treats region associated resources as site options.	Requires associated resources to be enabled.
exportDetailUrl	Sets the detail-export address.	Normally requires the same origin.
disableMultipleAssetTree / useAssociatedResource	Controls multiple trees and associated resources.	Direct query only.

params and state

state is a query string whose params value is JSON. When params=useStorage, the page reads query configuration from sessionStorage in the current tab; use this only for the same origin and the same tab.

params field	Purpose	Notes
subject	Query object.	Site, device group, or device.
mdmTypes / mdmIds / siteIds	Asset types and asset IDs.	The required combination depends on subject.
deviceMdmTypes	Device types.	Used for device or device-group queries.
fields[]	Data columns to query.	Each item includes an identifier, name, unit, format, and related metadata.
dimensions[]	Query dimensions.	Each item includes a dimension type and selected values.
interval / rangeType	Time granularity and range type.	Available values depend on metrics and page configuration.
startTime / endTime	Query start and end time.	—
statisticsType	Detail or aggregate statistics.	Works with dimension and subtotal configuration.

Do not pass siteIds, deviceIds, mdmTypes, or deviceTypes as ordinary top-level URL parameters alongside params.

Landing Page Parameters

Parameter	Purpose	Notes
appId / menuCode / accessToken	Supplies portal context.	Usually provided by Application Portal.
url	Sets an iframe page directly.	The target domain must be allowlisted.
landingpage	Supplies an old inline-container configuration.	Compatibility only; do not use it for new menus.
defaultDeviceType	Sets the default device type.	Direct query only.
disableMultipleAssetTree	Hides the multiple asset-tree entry.	Visible by default.
pageId	Sets the page configuration ID.	—
multiLevelRegion	Controls multi-level region behavior.	The target version must support it.
state	Business state.	The current use is primarily query-string asset context.

crumbs and autoFirstAsset are unsupported. When building the iframe address, the container removes the outer url and landingpage parameters to prevent them from being passed to the child page again.

Legacy DTV Filter Output Parameters

When a legacy DTV page uses global filters to receive Landing Page context, it can use the following keys. The exact integration is version-dependent.

Key	Context	Description
nodeName	Asset	Current node name.
siteIds	Asset	Current site-ID collection.
allGroupMdmIds / groupMdmIds	Asset	All aggregated or grouped asset IDs.
mdmIdsByRegion / mdmIdsByType	Asset	IDs grouped by region or asset type.
deviceIds / mdmId	Device	Current device or site identifier.
startTime / endTime	Time	Current time range.
startOfMonth / endOfMonth	Time	Current month boundaries.
startOfYear / endOfYear	Time	Current year boundaries.
interval	Time	Current day/month/year interval.
appId / menuCode	Application Portal	Current application and menu context.

Historical or Unsupported Parameters

Module	Parameter	Recommended handling
Portfolio	solarSiteEnlightIframe	Use disablePageJump instead.
Portfolio	CDSCacheControl	A cache policy is not a page URL parameter.
Portfolio	filterByDomainsolarSiteIcon	Use solarSiteIcon=yellow instead.
Charting Tool	openQuality / top-level deviceTreeTypes / siteTypes	Use page configuration or fields supported by params.
Common KPI Inquiry	devciceTreeTypes	Use the correctly spelled deviceTreeTypes.
Landing Page	crumbs / autoFirstAsset	Unsupported.

Troubleshoot Parameters That Do Not Take Effect

1. Confirm that the query is before # and is correctly URL-encoded.

2. Confirm that the parameter belongs to the current route and target version.

3. Confirm that state uses the query-string or JSON format required by that module.

4. Check whether a direct query overrides the same value in state.

5. Check that asset IDs, mdmType, menu configuration, and permissions are valid.

6. For a sessionStorage solution, confirm the same origin and same tab, and check whether storage is cleared after it is read.