Configure Custom Headers for XLSX Exports
The configuration of custom headers in XLSX exports is available only through the platform settings and APIs.
For workspace administrators only
This article describes how you can customize the headers used in the XLSX exports of reports and dashboards in your workspace. For general information about exporting, see Export Reports and Export File Types.
You can specify headers for each workspace in your domain. By default, the XLSX file has no headers predefined. You can add up to 5 headers (rows) to your XLSX files, each displayed on a separate row.
Configure Headers through Platform Settings
Steps:
- Access the platform settings. For details, see Configure Various Features via Platform Settings.
- Scroll down to the bottom of the page to the Config section.
- In the Key field, type
exporter.ExcelExport.CustomHeader.N
whereN
is a natural number from 0 through 5 and specifies the number of the header row. - In the Value field, type what you want to display in the header. You can use text or macros.
- If you leave the Value field empty, the header row will be removed.
- To add an empty row as the header, type an empty space in the Value field.
- Click Create config. The header is configured. The page with the details of the newly configured header opens.
- Log in to the GoodData Portal and verify that the headers export correctly.
Configure Headers through API
See the API for customizing the headers.
Macro References
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.
Macro | Description |
---|---|
%PROJECT_ID | Workspace ID |
%PROJECT_NAME | The name of the workspace |
%REPORT_NAME | The name of the source report |
%REPORT_DESCRIPTION | The description of the source report |
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.
Macro | Description |
---|---|
%YYYY | Year (2018) |
%YY | Year (18) |
%MM | Month with a leading zero (03) |
%M | Month (3) |
%DD | Day of month with leading zero (07) |
%D | Day of month (7) |
%HH | Hour with leading zero in 24-hour format (14) |
%H | Hour in 24-hour format (14) |
%hh | Hour with leading zero in 12-hour format (02) |
%h | Hour in 12-hour format (2) |
%am | a.m. or p.m. (p.m.) |
%mm | Minutes (04) |
%ss | Seconds (05) |
%z | General time zone (PST) |
%Z | RFC 822 time zone (-0800) |