This documentation and the Cisco Observability Platform functionalities it describes are subject to change. Data saved on the platform may disappear and APIs may change without notice.


dashui:entityPage

Description

dashui:entityPage defines the entry-point or template of the Observe feature.

When you navigate to an individual entity or a set of entities of a specific type, then the right entity centric page for the entity type needs to be rendered. This selection is controlled by the EntityPage.

The scope type is the detail for individual entities, and the list is used for multiple ungrouped entities. The group is used for multiple entities when you select grouping.

The key template specifies the unique name of the template to select for the combination of entityType and scopeType, and props can be used to pass parameter values to this template. This can be done only if it exposes parameters.

Syntax

{
    "kind": "<string>",
    "scopeType": "<string>",
    "entityType": "<string>",
    "template": "<string>",
    "props": "<object>"  
}

Attributes

Name Description
kind This specifies the kind of document type being defined. For example, entityPage.
scopeType A lower CamelCase identifier that matches against the current type of scope.
entityType A pattern that matches against the entity that the topology context points to.
template The name of a template which is used as entry point for the /observe context. This consists of - NAMESPACE : LOCAL_NAME -.
props These are the props set that are passed to the the selected template.

Example

{
   "kind": "entityPage",
    "scopeType": "detail",
    "entityType": "spacefleet:intercom",
    "template": "spacefleet:intercomEcpDetails"
}