Branding

Tenant Administrators can set up your organisation's branding once, in the Admin app. Anyone writing report templates can then apply it with two macros.

Setting up branding

1. In the Admin app, go to Tenant, then Branding
2. Under Images, choose an SVG or PNG file for your logo. You need a logo before you can save
3. Optionally, choose a background image. It can be any size, but should suit an A4 portrait page
4. Under Palette, choose the background, primary and secondary colours
5. Under Font Style and Colours, choose the colour and face of the normal font, and the colours of Heading 1 and Heading 2
6. Leave the JSON configuration under More Options as it is. It is not used yet
7. Click Save, then let your colleagues know the branding is ready

Note: Restore to Default deletes your saved branding straight away, including your logo and background image.

Using branding in a report

Two macros apply the branding:

• [MagicSuite.TenantImage:] inserts your background image where it is placed, or your logo with imageType=Logo
• [MagicSuite.ApplyBrand:] applies your colours and font to the whole document, wherever it is placed. On its own it applies all of them. To apply only some, name them in properties

[MagicSuite.ApplyBrand:] works only in Word templates, for Word and PDF output.

To use them, open or create a Word template, or start from a Library template, add the macros and run the report.

Examples

Apply all of your colours and font:

[MagicSuite.ApplyBrand:]

Apply only the background colour, the font face and the two heading colours:

[MagicSuite.ApplyBrand: properties=TenantBackgroundColor;TenantFontFace;TenantHeading1FontColor;TenantHeading2FontColor]

Insert your logo:

[MagicSuite.TenantImage: imageType=Logo]

Insert your background image:

[MagicSuite.TenantImage: imageType=Background]

Each macro's own help page describes all of its parameters.