Annotation section type - details

This section type shows a block of text with an optional title. You can use Markdown syntax to change the appearance of the text and to add links and graphics.

There are two types of annotation available to you:

  • You can add an annotation for the entire report. This is displayed at the top of the report, with a control for hiding or displaying the annotation.
    Report-level annotation is described in Annotation tab - report level.
  • You can add one or more annotation sections to your report.
    Section-level annotation is described in the current help topic. Both types of annotation support Markdown (see below for syntax), which means that you can format them and add graphics and links.

Getting started with an annotation section

  1. Edit the report.
    • Create a new report.
    • Open an existing report and select Edit report from the report menu.
  2. Edit a report section.
    • Create a new section on the Sections and layout tab.
    • Edit an existing section. Select the section and click Define Section.
  3. Set Section type to Annotation.
    This will display the Annotation tab and hide all other tabs except Section tabs (because nothing else applies to an annotation tab).
  4. In the Enter annotation text box, type the text you want to appear in this section of your report.
    You can leave your text plain or use Markdown syntax (described below) to format the text and add links and graphics.

Example 1

A very basic annotation section could look something like this.

With a little effort, you could add graphics and links to add a more impressive section to your report. For example:

This sentence includes a link to the [Applications dashboard](/LSServlet?dmiAction=Generate&lsEntryName=Applications+dashboard) report on the same NAM Server.

Example 2

In this example, we make an Annotation section that talks about two standard NAM reports. We used a little Markdown syntax to add headers, bold, and italics, just to show it in action.

This is the actual text we typed into the Enter annotation text box:

# All about SAP dashboards...
Here is the **Enter annotation text** for my sample annotation section, which supposedly is about SAP dashboards but is *really* just the sample text you're reading right now.  
On the **Section tabs** tab, I have also added a couple of button tabs to this section. They open two randomly chosen standard DMI reports ("SAP dashboard" and "SAP RFC dashboard").
Here is where I would maybe describe the reports and what to do with them in general.
And then we have a heading level two:
## SAP dashboard
Use the **SAP dashboard** report to blah blah blah... notice the bold headings.
## SAP RFC dashboard
Use the **SAP RFC dashboard** report to blah blah blah... I could put some text *italics* if I wanted to.
So now that I have explained all about SAP dashboards, you have two buttons to actually open those dashboards.

In the DMI editor, it looks like this:

Switching to Section tabs, we added buttons that open the reports we were describing in the annotation.

  1. Click Add new tab.
  2. In Target, find a target report
  3. In Name, enter the button label for that report.
  4. Select Button.
  5. Repeat this procedure as needed, once per target report.

Then we click Display report in the DMI editor to see our section, with the explanatory text followed by buttons that open the relevant reports.

sample annotation section output
sample annotation section output

Markdown syntax

Notation Usage
**strong** Renders strong text
_emphasized_ Renders emphasized text
absolute link [Dynatrace Community]( Renders a Dynatrace Community link
relative link [NAM Server About](/about) Renders the NAM Server About link pointing to the About screen of the NAM Server instance displaying the report.
reference style link [Dynatrace Corporate Website][1] with
    [1]: [Dynatrace Corporate Website](  
used once anywhere in the annotation. You can then reference it many times in the same annotation
Renders Dynatrace Corporate Website
* unordered list element A  
* unordered list element B  
  • unordered list element A
  • unordered list element B
1. ordered list element 1
1. ordered list element 2
  1. ordered list element 1
  2. ordered list element 2
# Heading 1
## Heading 2
### Heading 3
###### Heading 6
Renders headings. Levels are controlled by the number of # characters.
`preformatted` with a single ` before and after the text Renders preformatted text.
![logo]( Displays the image at the path provided in parenthesis () logo with the text from square brackets [ ] as the value of the alt attribute. <img src="" alt="logo"/> The path to the image can be a full http path or a path relative to the CAS wwroot directory.