Page tree
Skip to end of metadata
Go to start of metadata

The configuration of XLSX custom report headers is available through Platform Settings and GoodData API for project Administrators only.

This article describes how you can customize the headers used in the exports of XLSX reports and dashboards in your project.

For general information about exporting, see Export Reports and Export File Types.

You can specify headers for each project 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

Steps:

  1. Access Platform Settings.
    For details, see Platform Settings.
  2. In the Config section at the bottom of the page in the Key field, type exporter.ExcelExport.CustomHeader.N where N<=5 and specifies the number of the row.
  3. 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.
  4. Click Create config.
  5. 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.

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

MacroDescription

%PROJECT_ID

Internal project identifier

%PROJECT_NAME

Display name of the project

%REPORT_NAME

Display name of the source report

%REPORT_DESCRIPTION

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.

MacroDescription

%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)

%ZRFC 822 time zone (-0800)
  • No labels