The configuration of XLSX custom report headers is available through Platform Settings and GoodData API for workspace Administrators only.
This article describes how you can customize the headers used in the exports of XLSX reports and dashboards in your workspace.
You can specify headers for each workspace in your domain. You can add up to 5 headers (rows) in your XLSX files, each displayed on a separate row. By default, the XLSX file has no headers predefined.
You can specify XLSX headers through:
- Platform Settings
- GoodData API
Adding Headers Through Platform Settings
- Access Platform Settings.
For details, see Configure Various Features via Platform Settings.
- In the Config section at the bottom of the page in the Key field, type
exporter.ExcelExport.CustomHeader.Nwhere N<=5 and specifies the number of the row.
For Value, type what you want to display in the header.
You can use text or macros (see below).
- If you leave the Value empty, the header row is removed.
- If you want to add an empty row in the header, type an empty space as the Value.
- Click Create config.
- Log in to the GoodData Portal and verify that the headers export correctly.
Adding Headers Through GoodData API
To add XLSX headers through GoodData API, see API Reference.
You can apply the following macros for XLSX headers. You can use them separately or insert them inline with other text references.
Report Related Macros
In GoodData, terms workspace and project denote the same entity. For example, project ID is exactly the same as workspace ID. See Find the Workspace ID.
|Internal workspace identifier|
Display name of the workspace
Display name of the source report
Report description value
Date and Time Macros
All date and time values indicate when the report was generated. Values in parentheses are examples for March 07, 2018 at 2:04:05 p.m.
Month with a leading zero (03)
Day of month with leading zero (07)
Day of month (7)
Hour with leading zero in 24-hour format (14)
Hour in 24-hour format (14)
Hour with leading zero in 12-hour format (02)
Hour in 12-hour format (2)
a.m. or p.m. (p.m.)
General time zone (PST)
|%Z||RFC 822 time zone (-0800)|