Branding
The Branding page is available in the Admin app, and lets a Tenant Admin user quickly set some basic branding that can be applied to Word and PDF reports in just a few simple steps.
Options
The options provided (which can be applied selectively to the output documents) are currently:
- A company logo (you can upload one)
- A background image (you can upload one)
- A background colour
- The primary colour
- The secondary colour
- The font face
- The font colour
- The Microsoft Word 'Heading 1' font colour
- The Microsoft Word 'Heading 2' font colour
- Optional JSON configuration - currently not used but included for future-proofing and new capabilities
The background image will be added to each page of the document, and so it should typically as close to A4 (standard Word document) aspect ratio (width and height).
Note: the ability to brand PowerPoint documents is currently not implemented, but is under consideration for a future release.
Usage
Once the branding has been setup, it can be applied as follows:
- By inserting the [ReportMagic.TenantImage:] macro into the input document template - to apply the logo or background image
- By inserting the [ReportMagic.ApplyBrand:] macro into the input document template - to apply one or more items
In either case, the steps to use the branding would be:
- Create a Word document that contains your report template, or use one of our templates (such as the LogicMonitor HealthCheck)
- Insert one of the aforementioned macros anywhere in the document (it will be removed in the completed report)
- Run the report
Example Macro
Suppose you want to set a background colour, choose a font, and set the Heading 1 and Heading 2 colours. The macro to use would be as shown below (the properties parameter specifies each item - more details can be found in the help):
[ReportMagic.ApplyBrand: properties=TenantBackgroundColor;TenantFontFace;TenantHeading1FontColor;TenantHeading2FontColor]
You can also apply everything by omitting the properties, for example:
[ReportMagic.ApplyBrand:]