Like what you see? Have a play with our trial version.

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated 'Conserve memory export', added 'Display Low Memory Exports toggle', added 'Broadcast filename template'

Table of Contents
classcontents
Anchor
top
top

Overview

In addition to the UI configuration options within Yellowfin, a number of SQL-provoked settings exist, outlined below.

...

Conserve memory during export

To ensure that the memory does not get The low memory export configuration prevents memory from being exhausted when exporting a large report reports to XLSX , you can enable the Low Memory Export option. This format. When the configuration is enabled, the system processes reports in parts in memory, rather than as a whole.

To enable this feature, add the following SQL code into your configuration database:

Code Block
INSERT INTO Configuration(IpOrg, ConfigTypeCode, ConfigCode, ConfigData) values(<IP_org>, 'SYSTEM', 'REPORTLOWMEMORYEXPORT', 'TRUE');

Remember to set your value for <IP_org> to either the primary org (1) or a client org.

Anchor
lowmemoryexportoption
lowmemoryexportoption

Display Low Memory Exports toggle

This configuration displays the Low Memory Exports toggle option on the report Export Settings dialog box, providing the option to enable or disable the feature within the UI per report. The toggle is also displayed on the System Configuration page to enable or disable the feature as the default setting for all report exports.

Enabling this option overrides the global setting, REPORTLOWMEMORYEXPORT which enforces low memory exports. This means exports will be faster, but more memory-intensive.

When set to TRUE, the export option ‘Low Memory Exports’ is displayed in the report Export Settings dialog box. 

To enable this feature, add the following SQL code into your configuration database:

Code Block
INSERT INTO Configuration VALUES (<IP_org>, 'SYSTEM', 'ONSHOWLOWMEMORYEXPORTOPTION', 'TRUE');

Remember to set your value for <IP_org> to either the primary org (1) or a client org.

...

In this sample, 1 signifies the primary/default organization.


Anchor
broadcastfilename
broadcastfilename

Broadcast filename template

This configuration can be used as a template for filenames used in email broadcasts, FTP schedules and save to disk schedules. When set, it applies to all broadcasts on your Yellowfin instance. This configuration overrides the Append Broadcast Date and Append Broadcast Time options, therefore their respective checkboxes will no longer appear on the broadcast configuration dialog box once this configuration is set.

The value stored in the configuration can contain placeholders for the report name and date that will be filled in by the broadcast process:

  • The {filename} placeholder will be replaced with the report name for email broadcasts, or the file name specified in the FTP Broadcast and Save to Disk Schedule dialog boxes.
  • All other placeholders within the curly brackets are treated as datetime format strings, following the SimpleDateFormat specification.

For example, utilizing the Broadcast Filename Template format {yyyy-MM-dd_HH-mm-ss} as outlined in the code snippet below, will produce the filename ‘Ski Report - 2020-01-01_12-34-56.pdf’. 

The resulting filename must be compatible with the filesystem if FTP schedules and Save to Disk schedules are used. For example, if the destination FTP server or the Yellowfin instance are running on Windows, then using a colon character (:) should be avoided as it is an illegal character in filenames on NTFS. Email broadcasts, however, will replace illegal characters in filenames with underscores.

Code Block
languagejava
INSERT INTO Configuration VALUES (1, 'SYSTEM', 'BROADCASTFILENAMETEMPLATE', '{filename} - {yyyy-MM-dd_HH-mm-ss}');

In this sample, 1 denotes the primary/default organization. This is a system-wide setting that cannot be enabled for specific client organizations; therefore, this value must always be set to 1.