Entity State

Microsoft.SharePoint.2016.SPHA_Health_Report (LinkedReport)

This report renders entity state for specified SharePoint object(s) over time.

Knowledge Base article:

Summary

This report shows for selected SharePoint objects the time in state during the selected report duration. Time in state is summarized by default as per the objects availability Monitors

Description:

For every managed SharePoint object within System Center Operations Manager, monitors configured in each of the disciplines below determine an object's time in state and then roll-up to an object's overall health. The Entity Health report by default shows an object's time in state as per the monitors that roll-up within the availability discipline.

Entity health
Availability	Configuration	Performance	Security

Parameters:

Data Aggregation: Report can be run using the hourly or daily aggregations of data. The default is Hourly.

Date/Time Selection: Allows defining a time period for the report with relative or fixed dates. The default is for past 1 month.

Business hours: Allows defining one business hours time range and the weekdays it applies to. If business hours are defined this report only reports within this range. Business hours only works if hourly aggregation is selected.

Object Picker: Allows selection of Groups or Objects to show Alerts for.

When using the object picker selecting Add Group will return the Group and all objects it contains. Add Object returns only the selected object.

Downtime: When calculating downtime for an object in the report a user can specify whether certain states count as up or downtime. By checking the box next to the state this determines that state to be downtime.

Sample Usage:

Scenario: Report on the health state of all SPHA rules for Monday to Friday last week and select warning as a downtime state.

Instructions: (Parameter selections shown in bold)

Open Entity State Report
Select From drop down and choose Previous Week > Monday
Select To drop down choose Previous Week > Friday
Click Add Group
In search box type "SPHA Rule Group" then click Search
Add all those with type "SPHA Rule Group"
Click OK once complete.
In Downtime parameter check Warning.
Click Run to view report.

Report Output:

The report offers three areas of interaction

Drilling-down the state rollup logic defined for the selected object

Click on the "Availability Tracker" chart

Interaction on each row

A click on the "Object name" launches the "Monitor Availability" sub-report that details which monitor(s) have been reporting which states.

This links to an "Availability time" report that shows in detail what times the object has been in what state and allows drill-downs in time to detail on a monthly, daily and hourly base a time in state.

Reports:

Availability time

The same links as clicking on the Object name

Monitor availability

The same links as clicking on the Availability Tracker chart

Configuration changes

This links to the configuration changes and runs for the same time range an object that details every configuration change detected.

Element properties:

Base	Microsoft.SystemCenter.DataWarehouse.Report.Availability
Target	Microsoft.SharePoint.Library.SPHARule
Accessibility	Public
Visible	True

Source Code:

<LinkedReport ID="Microsoft.SharePoint.2016.SPHA_Health_Report" Accessibility="Public" Base="SCDWReport!Microsoft.SystemCenter.DataWarehouse.Report.Availability" Visible="true" Target="MOSS!Microsoft.SharePoint.Library.SPHARule">

  <ParameterBlock xmlns="http://schemas.microsoft.com/mom/reporting/2007/ReportParameterSettings" columns="4">

    <Controls xmlns="http://schemas.microsoft.com/mom/reporting/2007/ReportParameterSettings">

      <Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.ComboBox">

        <ReportParameters>

          <ReportParameter name="DataAggregation">

            <Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.DataAggregation</Prompt>

          </ReportParameter>

        </ReportParameters>

      </Control>

      <Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.MonitoringObjectXmlPicker" columnSpan="2" rowSpan="2">

        <ReportParameters>

          <ReportParameter name="ObjectList">

            <Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.ObjectList</Prompt>

          </ReportParameter>

          <ReportParameter name="ManagementGroupId" binding="GroupList"/>

        </ReportParameters>

      </Control>

      <Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.CheckedListBox" rowSpan="2">

        <ReportParameters>

          <ReportParameter name="DownTime">

            <Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.AvailabilityDownTime</Prompt>

          </ReportParameter>

        </ReportParameters>

      </Control>

      <Control type="Microsoft.SystemCenter.DataWarehouse.Report.ParameterControl.BusinessRelativeDateTimePicker">

        <ReportParameters>

          <ReportParameter name="TimeZone" binding="TimeZone">

            <Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.TimeZone</Prompt>

          </ReportParameter>

          <ReportParameter name="TimeZoneName" binding="TimeZoneName"/>

          <ReportParameter name="StartDate_BaseType" binding="StartDate_BaseType"/>

          <ReportParameter name="StartDate_BaseValue" binding="StartDate_BaseValue">

            <Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.StartDateTime</Prompt>

          </ReportParameter>

          <ReportParameter name="StartDate_OffsetType" binding="StartDate_OffsetType"/>

          <ReportParameter name="StartDate_OffsetValue" binding="StartDate_OffsetValue"/>

          <ReportParameter name="EndDate_BaseType" binding="EndDate_BaseType"/>

          <ReportParameter name="EndDate_BaseValue" binding="EndDate_BaseValue">

            <Prompt>Microsoft.SystemCenter.DataWarehouse.Report.Library!Microsoft.SystemCenter.DataWarehouse.Report.ParameterPrompt.EndDateTime</Prompt>

          </ReportParameter>

          <ReportParameter name="EndDate_OffsetType" binding="EndDate_OffsetType"/>

          <ReportParameter name="EndDate_OffsetValue" binding="EndDate_OffsetValue"/>

          <ReportParameter name="TimeType" binding="TimeType"/>

          <ReportParameter name="TimeWeekMap" binding="TimeWeekMap"/>

        </ReportParameters>

      </Control>

    </Controls>

  </ParameterBlock>

  <Parameters>

    <Parameter Name="MonitorName">

      <Value>System.Health.EntityState</Value>

    </Parameter>

    <Parameter Name="DownTime">

      <Value>2</Value>

    </Parameter>

    <Parameter Name="StartDate_BaseType">

      <Value>Today</Value>

    </Parameter>

    <Parameter Name="StartDate_OffsetType">

      <Value>Month</Value>

    </Parameter>

    <Parameter Name="StartDate_OffsetValue">

      <Value>-1</Value>

    </Parameter>

    <Parameter Name="EndDate_BaseType">

      <Value>Today</Value>

    </Parameter>

    <Parameter Name="EndDate_OffsetType">

      <Value>None</Value>

    </Parameter>

    <Parameter Name="EndDate_OffsetValue">

      <Value>0</Value>

    </Parameter>

    <Parameter Name="TimeType">

      <Value>Regular</Value>

    </Parameter>

  </Parameters>

</LinkedReport>