Adding Report Details to your Custom OpsMgr Report

So you finally created that super cool custom report in OpsMgr and you want to add all the info necessary to run the report correctly. But how do you do that?

If you use the MP Authoring Tool you have the option to add a Description.

If you open the MP xml file you can see the above Description is added to the DisplayStrings section of the MP.

This is the Result:

To do more advanced stuff you need to add a KnowledgeArticles section to your XML.

 

So if you add the next section to the KnowledgeArticles Section:

<KnowledgeArticle ElementID="My.Custom.Reporting.Report" Visible="true"> <MamlContent> <maml:section xmlns:maml="https://schemas.microsoft.com/maml/2004/10"> <maml:title>Summary</maml:title> <maml:para> <maml:ui>How does this report work?</maml:ui> </maml:para> <maml:para>This report shows the next items:</maml:para> <maml:list> <maml:listItem> <maml:para>Item 1</maml:para> </maml:listItem> </maml:list> <maml:para /> <maml:para>The report finds data if the objects supplied are of type</maml:para> <maml:para>Exampe type</maml:para> <maml:para>Search for objects on blabla</maml:para> <maml:para /> <maml:para>The report displays for every selected object a separate chart. Data is aggregated to days of a month.</maml:para> <maml:para> <maml:ui>How to use this report?</maml:ui> </maml:para> <maml:para>When run from the Reporting space:</maml:para> <maml:para>The second column in the search results shows of which type the displayed objects are. Make sure you select objects of type blabla.</maml:para> <maml:para /> <maml:para>When run from the Monitoring space:</maml:para> <maml:para>Create a state view or performance view by choosing the blabla type.</maml:para> <maml:para /> <maml:para> <maml:ui>What Parameters are offered?</maml:ui> </maml:para> <maml:para>Date/Time selection: Allows selecting a relative or fixed date and time range and time zone.</maml:para> <maml:para>Object: Allows adding objects to run this report for</maml:para> <maml:para /> </maml:section> </MamlContent> </KnowledgeArticle>

 

This will be the result in the OpsMgr Console Report Description: