This article describes how to create and edit row perspectives using the JSON files. Row perspectives can more easily be editing in SquaredUp DS from system > matrix rows see How to create and modify Matrix row perspectives. Use the information below if you prefer to use the JSON files.
New row perspectives can be created on the SquaredUp server by creating a new row perspective JSON file.
We recommend you don't edit the SquaredUp DS perspectives. A good way to start is by copying the JSON from an existing perspective and amending as you require.
Don't forget to replace the "id" with a new GUID. You can create a new GUID simply by typing new-guid into PowerShell.
Log on to the SquaredUp server and run Notepad as an administrator.
Create a JSON file in the following path in your SquaredUp DS folder: \User\Packages\Everyone\perspectives\rows
The default location for the SquaredUp folder is C:\inetpub\wwwroot\SquaredUp
For v5 it is C:\inetpub\wwwroot\SquaredUpv5 and for v4 C:\inetpub\wwwroot\SquaredUpv4.
A custom location may have been chosen during the installation.
Name of the SquaredUp folder
The default name of the SquaredUp folder is SquaredUp for v6 and above.
For v5 it is SquaredUpv5, and for v4 SquaredUpv4.
Below is the JSON configuration template for a row perspective. You can copy this into the JSON file you have created.
Each row perspective JSON file must use a unique "id". Create a new GUID ready to use for the row perspective. You can do this simply by typing new-guid into PowerShell.
Replace NEWGUID with the new GUID you have created.
Replace SCOMID with the SCOM ID of the group or class you want this row perspective to be displayed for. For example, for the IIS Computer Group: If you are using a SCOM Group ID:
"showStatusIcon": true will show the status icon indicator. false will hide the icon. The default value is true.
"labelTemplate" a mustache template to render as custom label. Can contain any valid template, the context object for the current row will be provided as the template context. Default if none provided is {{displayName}}.
Source Properties: None
Displays the health state of an object as simple colored block, with the color indicating the health state.
"fullWidth": true the block will fill the available column width, false will use a fixed width. The default value is false.
"labelTemplate" a mustache template to render as custom label. Can contain any valid template, the context object for the current row will be provided as the template context. Default if none provided is {{displayName}}.
Source Properties: None
Renders a custom mustache template and displays the result in the cell.
"contentTemplate" a mustache template to render. Can contain any valid template, the context object for the current row will be provided as the template context.
Example content templates:
Display the IP address: "{{(properties.ipAddress || '').split(',')[0]}}"
Display size value in Gigabytes: "{{Math.round(properties.size / 10737418.24) /100}} GB"
Display the file system e.g. C:\ "{{properties.fileSystem}}"
Source Properties: None
Displays blocks representing the health state history of an object over a time period.
"fullWidth" if set true, the tile will fill the available column width, else false will use a fixed width based on the width setting above. Default value is false.
Source Properties:
"monitorIds" a monitor SCOM ID.
To find the SCOM ID of a monitor in SquaredUp DS for SCOM browse to a server in SquaredUp DS for SCOM, and click on the Monitored Entity perspective. In the Monitors section click on the monitor you need, for example Hardware Performance Rollup. The SCOM ID is shown in the URL immediately after id=. For example, the SCOM ID for the monitor in the following URL is 29f76d4e-dbfe-b80d-d770-3679524a5ec6 http://servername/SquaredUp/drilldown/scommonitor?id=29f76d4e-dbfe-b80d-d770-3679524a5ec6&objectid=fb9564cd-3ff1-1b3b-88b1-096111a722d0
Default timeframe:
By default, all cell tiles in the Matrix tile adapt to the page timeframe.
The page timeframe is the timeframe setting a dashboard or perspective is currently using. These timeframes are all relative to the current time, for example 7 days ago until now. When a user changes the page timeframe, all tiles that have use page timeframe set will adapt to the new timeframe. (Tiles that do not have use page timeframe set (i.e. are set to specific timeframe or custom timeframe) are not affected and won't change.)
The custom option can be used to set timeframes using
SquaredUp DS does not support the week notation.
Setting a specific timeframe:
You can set a fixed timeframe for cells by adding timeframe as a source property:
last1hour, last12hours, last24hours, last7days, last30days, last3months,last6months, last12months, all
Durations of 2, 4, 6 hours, or 14 days can NOT be used in the above format.
The custom option can be used to set timeframes using ISO 8601 format
SquaredUp DS does not support the week notation.
Note: You need to make sure that the data source supports the timeframe you set.
type
fixed = use fixed range value
inherit = use page timeframe (default)
Displays a small SLA gauge showing a visualization of the target value from 0-100%. Color, shape (how filled) and label of the gauge indicate the value and status.
Source Properties:"sloId" this is the SCOM ID of the Service Level Objective (SLO) object, and is mandatory.
To find the SCOM ID of the Service Level Objective (SLO) object, temporarily add an SLA tile configured to the SLO you require. Click the edit tile button and then the edit JSON button . The SCOM ID of the SLO will be shown in the JSON after "sloId":
Default timeframe:
By default, all cell tiles in the Matrix tile adapt to the page timeframe.
The page timeframe is the timeframe setting a dashboard or perspective is currently using. These timeframes are all relative to the current time, for example 7 days ago until now. When a user changes the page timeframe, all tiles that have use page timeframe set will adapt to the new timeframe. (Tiles that do not have use page timeframe set (i.e. are set to specific timeframe or custom timeframe) are not affected and won't change.)
The custom option can be used to set timeframes using
SquaredUp DS does not support the week notation.
Setting a specific timeframe:
You can set a fixed timeframe for cells by adding timeframe as a source property:
last1hour, last12hours, last24hours, last7days, last30days, last3months,last6months, last12months, all
Durations of 2, 4, 6 hours, or 14 days can NOT be used in the above format.
The custom option can be used to set timeframes using ISO 8601 format
SquaredUp DS does not support the week notation.
Note: You need to make sure that the data source supports the timeframe you set.
type
fixed = use fixed range value
inherit = use page timeframe (default)
Displays a sparkline graph visualization of SCOM performance data over time for a given object. When clicked, the graph will drilldown into the detailed SCOM performance view for the object.
Performance data for the tile is queried per column using the tile scope. This data needs to be grouped together for each object, so that it can be displayed correctly for the appropriate row. By default it is grouped assuming that the objects are unhosted or top-level objects such as Computers, Network Devices, or Distributed Applications. If your tile is scoped to hosted child objects such as disks, websites or databases then you will need to override the default grouping behavior by specifying managed entity.
By default, all cell tiles in the Matrix tile adapt to the page timeframe.
The page timeframe is the timeframe setting a dashboard or perspective is currently using. These timeframes are all relative to the current time, for example 7 days ago until now. When a user changes the page timeframe, all tiles that have use page timeframe set will adapt to the new timeframe. (Tiles that do not have use page timeframe set (i.e. are set to specific timeframe or custom timeframe) are not affected and won't change.)
The custom option can be used to set timeframes using
SquaredUp DS does not support the week notation.
Setting a specific timeframe:
You can set a fixed timeframe for cells by adding timeframe as a source property:
"valueTemplate" mustache template to execute that processes the "value" to be rendered as the bar graph label. By default this template is "{{value ? Math.min(value, 100) : ''}}"
"height" in pixels of the bar visualization.
Source Properties:
The "objectname" and "countername" properties should be set to the appropriate metric to be retrieved by that data-source.
Example showing memory usage with rounded value formatted in valueTemplate:
By default, all cell tiles in the Matrix tile adapt to the page timeframe.
The page timeframe is the timeframe setting a dashboard or perspective is currently using. These timeframes are all relative to the current time, for example 7 days ago until now. When a user changes the page timeframe, all tiles that have use page timeframe set will adapt to the new timeframe. (Tiles that do not have use page timeframe set (i.e. are set to specific timeframe or custom timeframe) are not affected and won't change.)
The custom option can be used to set timeframes using
SquaredUp DS does not support the week notation.
Setting a specific timeframe:
You can set a fixed timeframe for cells by adding timeframe as a source property:
To find the SCOM ID of a monitor in SquaredUp DS for SCOM browse to a server in SquaredUp DS for SCOM, and click on the Monitored Entity perspective. In the Monitors section click on the monitor you need, for example Hardware Performance Rollup. The SCOM ID is shown in the URL immediately after id=. For example, the SCOM ID for the monitor in the following URL is 29f76d4e-dbfe-b80d-d770-3679524a5ec6 http://servername/SquaredUp/drilldown/scommonitor?id=29f76d4e-dbfe-b80d-d770-3679524a5ec6&objectid=fb9564cd-3ff1-1b3b-88b1-096111a722d0
Displays the health state of a specific entity monitor for the current object as a simple colored block, with the color indicating the health state.
"fullWidth": true will fill the available column width. false will use a fixed width. The default value is false.
Source Properties:
"monitorIds" array of SCOM monitor IDs.
Displays a visualization to indicate a numeric value in blocks. Typically used to show a small number of items as blocks e.g. number of CPUs from 1-16.
Provide a unique name which will be seen in the list of row perspectives to choose from when configuring a Matrix tile.
id
Provide a GUID that should be unique to this row perspective. You can generate a new GUID by typing new-guid into PowerShell or online here. You should create a new GUID for each row perspective. Altering the existing GUID randomly will not work.
format
row (This property differentiates a row perspective from a regular perspective)
Rank specifies which perspective should be displayed when more than one perspective matches the scoped criteria. 0 is the lowest rank and will be considered the lowest priority. Best practice is to assign numbers with sufficient gap between them (like multiples of 10) so that you can later insert other perspectives of lower ranks in between if you wish to.
columns
Column is an array of cell tile definitions. You need to define cell tiles in the column block.