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

Error rendering macro 'rw-search'

null

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

You can configure general system settings here, including view & file export defaults, logo options, and server settings.

Note: Export Defaults have moved. You can now find them under the Administration Console - Export Defaults.

Image AddedImage Removed

Expand
titleGeneral Settings


Option

Description

Navigation Style

Select a navigation style to use within the system. The following are available:

  • Left Side Navigation: the system navigation items will appear in a panel that can be expanded or collapsed on the left hand side of the page.
  • Toolbar Navigation: the system navigation items will appear as links in the main navigation bar across the top of the page.
Content Creation Location

Select the location of the Create content button. This is only available when using Left Side Navigation (see Navigation Style option above).

  • Left Side Navigation: the Content Creation options will appear in the Left Side Navigation panel.
  • Top Right: the Content Creation button will be attached to the main navigation bar on the right hand side of the page.
Enable Guided NLQThis toggle allows Guided NLQ to be switched off for all users of a Yellowfin instance. For multi-org setups, this toggle can be set individually per client org.

Color Picker Standard Colours

Define the default colors to display in the color picker, along with the chart color defaults. There is room for six colors to be defined.

Base Tags

  • Included: Base tags will be included in the HTML of every page. This can be useful for debugging purposes, but may cause issues if proxy servers or load balancers are in use.
  • Excluded: Base tags will be excluded from the HTML of every page.
  • Commented (default): Base tags will be included in the HTML of every page, but will be commented out. This can be useful for debugging purposes.

External Instance Base URL

Define the external URL used to access this instance. This should be a link all users can access. If an external URL is not set for a client org, it will revert to the primary org setting. It’s used for embed script links, direct links, and links sent via email. 

JavaScript API Object Name

This field is useful for white label instances of Yellowfin. By default, embed links and JS API window object name use the text yellowfin which is visible to end users.

If you enter text in this field (eg, myCompanyName), the JS API window object name will use your text instead of the default yellowfin (eg, in the JS API window object name,  window.yellowfin would become window.myCompanyName).

If this field is left blank, the default text yellowfin will continue to be displayed in the JS API window object name and embed links.

External API cookie timeout

When using the Javascript API, a browser cookie is used to store the user's login details. Define the time, in seconds, the cookie is valid. Use zero to disable the cookie.

Allowed OriginsThis option allows users to specify a series of domains permitted for Cross Origin Resource Sharing (CORS), while the External JavaScript API is being used.  This option is only available in the primary organization; it is not available in client orgs.

Outgoing Proxy Server

Define this if the Yellowfin server should connect to the internet via a proxy server. For example, when connecting to WMS servers.

Extended Logging

Enable extended logs - when an event is logged to the Event table, additional information such as names and descriptions of users, data sources, views, reports, or dashboards will be included. This can have an impact on performance.

Restricted Roles

Specify which roles can be hidden from specified Administrator roles.

Terms & Conditions

Provide business Terms & Conditions that a user must agree to before logging in to the system for the first time. (Optional)

Administration Tour

Select the storyboard to be used for guiding users through the Administration area. (Optional)

Minimum Schedule IntervalSelect the minimum interval that can be set for running all types of schedules including; Broadcasts, Cached Reports, Cached Filters, Data Transformations and Signals.
Multi-Tab SupportEnable this to allow Yellowfin to be used across multiple tabs and browsers during a single user session.
Maximum File Upload SizeSet the maximum size (in MB) allowed for any file uploaded to Yellowfin, such as GeoPacks, content imports, and images. The default is 80. The field accepts numbers and a decimal separator (eg, 80.5) only.
Unique Tokens for Every Request

When enabled, a nonce is added to every request sent to Yellowfin, which is then validated by the server before the request can be processed. This will help prevent request replay attacks, or automated request submissions. When disabled, no nonce is added and requests will be processed without a unique token. Depending on your system security setup, this could result in processing duplicate submissions. See our hardening guide for more information.


...

Expand
titleReport Export Defaults


OptionDescription
Export to CSVAllow users to export report results to CSV by default.

Export to DOCX

Allow users to export report results to DOCX by default.
Export to PDFAllow users to export report results to PDF by default.

Export to XLSX

Allow users to export report results to XLSX by default.
Expand
titlePDF Export Defaults

Option

Description

Page Size

Select the page size for your PDF file. This allows other layout settings to be configured properly.

Page Orientation

Choose the orientation of your file.

Shrink to Fit Page WidthIf 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 HeightIf 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 HeightIf 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.
Scale ImagesIf enabled, images will be scaled to prevent them from being cut off if too large.
Maximum Image WidthEnter the maximum image width (pixels).
Maximum Image HeightEnter the maximum image height (pixels).

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.

PDF Password

Enter a password to secure exported PDF files. 

Lock Page During ExportsIf enabled, user interactions and navigation will be restricted, preventing unexpected changes when the PDF export is taking place.
Tip

If you can't see the PDF export defaults in this location, they will be visible on the Admin Console.

Expand
titleDOCX Export Defaults

Option

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.

Expand
titleXLSX Export Defaults

Option

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.

Keep Formatting

If your report contains formatting for numeric values, such as prefixes, suffixes and thousand separators, enabling this option will export numeric values as text to maintain formatting. Disabling this option will ignore any formatting and export numeric values as numeric.

This feature is enabled by default.

Expand
titleCSV Export Defaults

Option

Description

Line Delimiter

This setting might be useful when working with third-party tools which may require a specific carriage return type to correctly process CSV files. Set your default carriage return here. Select from CR, CRLF and LF. This setting can be overridden during manual/ad-hoc CSV exports.



Expand
titleCustom Parameters


Option

Description

Custom Parameters

These are used as part of the Link to URL function, allowing you to use a variable as part of a link in a field. Add the parameter key and value to define one.

See Custom Parameters for more information.

...