Page History
...
Table of Contents | ||
---|---|---|
|
Overview
The Export Defaults section in System Configuration the Administration Console allows administrators to change the default file export settings for different Yellowfin content.
Styleclass | ||
---|---|---|
| ||
...
Export Defaults
Configure the default PDF export settings for Reports, Dashboards and Stories.
Report settings
Option | Description |
---|---|
Page Size | Select the page size for your PDF file. This allows other layout settings to be configured properly. |
Orientation | Choose the orientation of your file. |
Shrink to Fit Page Width | If enabled, the report content will be shrunk to fit the page width. |
Use Default Layout Values | This toggle lets you alter the default system layout settings for this exported PDF. It does not update the system defaults. If disabled, the options below will appear. |
Header Height (px) | If your report contains a header, enter the header's height (pixels) in this box to avoid any overlap between your header and the top of the report. |
Footer Height (px) | If your report contains a footer, enter the footer's height (pixels) in this box to avoid any overlap between the report contents and your footer. |
Report Section Page Break | If enabled, this option creates page breaks for report sections. This ensures that each new section in a report will start at the top of a new page. Note that Yellowfin splits the report table when report sections are defined, creating a separate table for each report section. |
Co-Display Report Page Break | If enabled, this option creates page breaks for co-display reports. This ensures that each co-display report will start from the top of a new page in the exported PDF. |
Export Tabbed Co-displays | This setting is suitable for tabbed co-displayed reports that have separate reports that are brought up by navigating through tabs. When toggled on, each report will be exported. If this is disabled, then only the main report will be exported. |
Secure PDF | Allows you to secure a PDF with password protection. |
PDF Password | |
If Secure PDF | |
is enabled, enter a password to open secure files. |
Dashboard settings
The Export Dashboard dialog box provides a number of options to customize the appearance of your dashboard PDF.
Export as | PDF and XLS are the available options for Dashboards exports. This table describes the options when PDF is selected as the output type. |
Page size | Choose from a range of standard page sizes such as A4 and (US) Letter, as well as larger and smaller page sizes. |
Orientation | Is your report wide? Switch from Portrait to Landscape. |
Use default layout values | Company-wide defaults can be configured for exports. See the Export Defaults section in the Admin Console for more details. If you wish to use your own settings, switch off this setting and set your own preferences within the options that appear below. Next time you export from this dashboard, your own preferences will be remembered. |
Shrink to fit page width | Dashboards wider than the intended printed page width may be cut off at the page edge. Enabling this option will scale the dashboard objects so they fit to the width of the page. Long-running dashboards may still run onto additional pages. Each tab of a dashboard is treated as an individual page |
Option
Description
Page Size
Select the page size for your PDF file. This allows other layout settings to be configured properly.
Orientation
Choose the orientation of your file.
Use Default Layout Values
This toggle lets you alter the default system layout settings for this exported PDF. It does not update the system defaults.
If disabled, the options below will appear. |
Header Height (px) |
Company-wide headers can be configured for reports and dashboards (see Report Settings for more information). | |
Footer Height (px) | Company-wide footers can be configured for reports and dashboards (see Report Settings for more information). |
Export Entire Dashboard |
When this option is toggled on, the entire Dashboard is exported as it appears in the Browser window. An additional option appears that allows the user to choose which Subtabs will be exported in the event that the Dashboard has multiple Subtabs. The user has the option to export the Current Subtab, All Subtabs or Selected. If the Selected option is chosen, the user can toggle each individual Subtab on or off for inclusion in the Export. When this option is toggled off, each individual report or chart will be exported and collated separately in a single PDF file. This is useful when there are reports on the Dashboard that contain more rows than are visible in the Dashboard. Note that in each instance, the view of the report exported will be the same as if that report was opened from the Browse Page. | |
Custom File Name | Default to the dashboard name. The PDF file name can be modified when enabled. |
Append Date Time Stamp | Define date formats for both "Default" and "Custom" Name. |
Secure PDF | Switch this on and a new field will be displayed where you can enter a password. Anyone who tries to access the generated PDF will need this password before they can open it. |
PDF Password
Story settings
Option | Description |
---|---|
Page Size | Select the page size for your PDF file. This allows other layout settings to be configured properly. |
Orientation | Choose the orientation of your file. |
Show Banner Image | If enabled, the Story banner image will be shown. |
Show Header | This toggle lets you show or hide the Story header. If enabled, the header will be shown, and the options Show Date Container and Show Author will appear. |
Show Date Container | If Show Header is enabled, toggle to show or hide the Story publish date. |
Show Author | If Show Header is enabled, toggle to show or hide the Story author. |
Show Story Title | If enabled, the Story title will be shown. |
Show Footer | If enabled, the Story footer will be shown. The footer includes the Story author and collaborators. |
Secure PDF | Allows you to secure a PDF with password protection. |
PDF Password | |
If Secure PDF | |
is enabled, enter a password to open secure files. |
XLSX Export Defaults
Dashboard and Report Settings
The XLSX file format, native to Microsoft Excel spreadsheets, has a choice of options so you can optimize your export before you download it.
XLSX Export Settings are the same for Dashboard and Reports.
Select your preferred settings and click the Export button. See below for some tips in formatting this report.
Export setting | Description |
---|---|
Keep Formatting | This allows any formatting done on values to be retained when they are exported. Formatting includes prefixes, suffixes, or thousand separators in numeric values, a date format applied to date fields, or links added to text fields. Disable this to export raw values, without any formatting. In the above example, the values will be exported as numbers - provided Excel identifies them as numeric values. For instance, the above example will be exported as 100000000. |
Format Column and Row Size | Enabling this will adjust the column widths and row heights to best fit the content in the Excel file. This allows all the content to be visible without opening the cells to see more in case of long text values. This will take longer to export content, however will make the file look neater and easier to read. Disable this to save export time in case of a large file. |
Export Tabbed Co-Displays | This setting is suitable for tabbed co-displayed reports that have separate reports that are brought up by navigating through tabs. The toggle will enable such reports to be exported in the same way, where each report will be in a separate Excel tab. If this is disabled, then only the main report will be exported. |
Wrap Text | Enable this toggle to wrap long lines of text when exporting a report to XLSX. The text limit can be defined by the user in the Wrap Length field. Note that this is not supported for merged cells. |
Wrap Length | If text wrapping is enabled, provide the maximum number of characters in a column after which the line will break and move the remaining text to the next line. |
CSV Export Defaults
Report Settings
Exporting reports to comma-separated values (CSV) format provides some options specific to this export type.
Select your preferred settings (see below for details on each) and click the Export button.
Export setting | Description |
---|---|
Escape Quotes | If enabled, this setting adds an extra pair of double quotes around any part of a field value that’s already double quoted. This ensures that the double quoted portion is treated as part of the same field, and displayed with quotes, rather than a separate field. |
Include Headings | Use this to show or hide report table headings. If enabled, the first row of the CSV file will be the column heading names. This also works for cross tab reports, in which case the row heading names are also included. |
Character Set | Select the character set with which to encode the export file. Using the right character encoding set is essential if the exported file is to be reused in other applications that use a particular file encoding. Tip: Yellowfin uses the standard UTF-8 for storing double-byte characters. |
Line Delimiter | Select from CR, CRLF and LF as line break characters for carriage returns. This is a useful setting when working with third-party tools which may require a specific carriage return type to correctly process CSV files. |
Field Separator | This is the character that will be used to separate individual fields (or data values) in the exported CSV file. Choose predefined separators, such as comma, semicolon, tab, or define a custom separator character. |
Field Separator Character | If the ‘Other’ option was selected for Field Separator definition, then specify a character to be used to separate values. This could be any character, alphabet, number; you are also able to specify multiple characters. |
Quote Commas | This will add Field Enclosure characters around any field value which contains commas, if enabled. This ensures that values containing commas are not treated as separate values before and after the comma. This is ideal for numeric values such as invoices that contain commas, eg: $6,328,754. |
Quote all Values | This toggle will add Field Enclosure characters around all individual fields. If this toggle is enabled, the Quote Commas option will be switched off. |
Field Enclosure | This is the character used to quote individual field values if either the Quote Commas or Quote all Values settings are switched on. Choose pre-defined enclosures such as single or double quotes, or define a custom enclosure character. |
Field Enclosure Character | If ‘Other’ is selected for the Field Enclosure character then specify a character to be used to quote fields in. This could be any character, alphabet, number; you are also able to specify multiple characters. |
DOCX Export Defaults
Report Settings
If you wish to export to the Microsoft Word format of DOCX, there's currently only one option available to configure.
Select your preferred settings (see below for details) and click the Export button.
Export setting | Description |
---|---|
Conditional Formatting Icon Export | If your report uses conditional formatting to display icons instead of data, enabling this option will ensure that those icons are exported. Disabling this option will ignore any conditional formatting and instead use the original data values. |
Applying changes to other client organizations
When client organizations are being used, editing the Export Default prompts a modal to confirm changes for other client organizations. When enabled, this allows you to specify the client organizations you wish to apply the changes to.
Styleclass | ||
---|---|---|
| ||
...