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.
Comment: Updated with new 9.6 config options

...

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

Image RemovedImage Added


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.

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. 

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

Enable this option to ensure every request is validated before they are processed. When enabled, every request will be given a unique token to prevent duplicate submission. When disabled, requests will be processed with their existing token, which may lead to duplicate submissions, depending on your system setup.



Expand
titleCompany Logo


Option

Description

Company Logo Image

Upload an image file to be used as the Company Logo in Reports.

Client Organisation Logo Image

Enter an absolute URL used to retrieve the client logo. ## will be replaced by the relevant Client Reference Id. eg:

http://localhost/myimage?ref=##

Logo Image Scale Factor

Define the percentage the Logo Image will be scaled to.


...

Expand
titlePDF Export Defaults


Option

Description

Page Size

Select the default paper size to be used for PDF exports.

Page Orientation

Select the default paper orientation to be used for PDF exports.

Shrink to fit page widthFit Page Width

Define if content should be shrunk to fit on a page, or displayed as is - possibly cutting content if too large.

Header Height

Define the default height (pixels) of page headers in PDF exports.

Footer Height

Define the default height (pixels) of page footers in PDF exports.

Scale Images

Display images at their full resolution or scale them down to avoid them being cut off if too large.

Maximum Image Width

Define the maximum image width (pixels) for use in PDF exports.

Maximum Image Height

Define the maximum image height (pixels) for use in PDF exports.

Report Section Page Break

Define whether each Report Section will start directly below the end of the previous section in a PDF export or on the next page.

Co-Display Report Page Break

Define whether each Co-Display Report will start directly below the end of the previous section in a PDF export or on the next page.

PDF Password

Define a password to be used to secure PDF exports. (Optional)used to secure PDF exports. (Optional)



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
titleCSV Export Defaults


Option

Description

Line Delimited

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.

...

Expand
titleSecurity


Option

Description

JavaScript Charts

Enabling this button allows permitted users to create JavaScript charts.

Client Org JavaScript ChartsSwitch this button on to allow your users (with appropriate role permissions) to access the JavaScript functionality, if you have a multi-client organization.

Dashboard Code Mode

Switch on toggle to enable Code Mode in dashboards and Present for the current instance. This allows Code Mode content to be consumed, and also enables permitted users to edit dashboard code and add custom HTML, CSS, and JavaScript (provided they have the correct role function).

Client Org Dashboard Code Mode

Switch on toggle to provide client org admins control to enable or disable Code Mode in dashboards and Present at the client org level. If this gets turned off, the Code Mode settings for all client orgs will become disabled; this also prevents any custom Code Mode content created in client orgs from runningCode Mode content created in client orgs from running.



Expand
titleHousekeeping


Option

Description

Time Delay for Report Thumbnail Clean-up

 This system task runs in the background and is invoked every week. It checks for reports that have been deleted recently (using the number set in this field as a minimum number of days since deletion) and deletes the thumbnail images linked to them.


Region 
Anchor
region
region

...

Expand
titleAuthentication Method


Option

Description

User Authentication

Define whether system or LDAP authentication will be used during the login process.

JWT Single Sign OnEnable user authentication via JWT Tokens. Toggling this option on produces a variety of options. See the wiki page Using JWT tokens with SSO for more information.
SAML Single Sign OnEnable user authentication via SAML. Toggling this option on produces a variety of options. See the related wiki page for more information.



Expand
titleLDAP Configuration


The LDAP directory needs to be configured, if this is the selected user authentication method.

Option

Description

LDAP Host

The Hostname or IP address of the LDAP server.

LDAP Port

The TCP port that the LDAP service is listening on.

Encryption

The encryption method implemented by the LDAP server.

LDAP Base DN

The LDAP node that all users and groups are contained within.

LDAP Group

Only members of this group will be able to login to Yellowfin.

LDAP Bind User

An LDAP user with rights to search the LDAP directory.

LDAP Bind Password

The password for the LDAP Bind User defined above.

LDAP Search Attribute

The LDAP attribute that contains a user’s Yellowfin username, entered by LDAP users at login.

LDAP First Name Attribute

The LDAP attribute that contains a user’s first name.

LDAP Surname Attribute

The LDAP attribute that contains a user’s surname.

LDAP Email Attribute

The LDAP attribute that contains a user’s email address.

LDAP Role Attribute

The LDAP attribute that contains a user’s Yellowfin role.

LDAP Group Filtering Criteria

Criteria used to filter a list of LDAP groups. Only groups returned in the filtered list will be passed to Yellowfin.

Ordering

The order in which internal authentication is performed.

Map LDAP Group to a Yellowfin Role

When enabled, LDAP user’s roles are updated directly in Yellowfin based on their LDAP group.

Test Connection

Test your LDAP connection with the settings defined above.

See 20709979 for more information.


...

Expand
titlePassword Settings


Option

Description

Password Length Restrictions

Define the minimum and maximum character length for user passwords.

Password Requirements

Enable any special password requirements for user passwords. These can include requiring:

  • At least one number
  • At least one letter
  • At least one upper case letter
  • At least one lower case letter
  • At least one special character
  • Password must be different from last

Password Attempts Limit

Define the maximum number of password attempts a user may have before the account is locked.

Show Forgot Password Link

Display the Forgot Password Link on the login page so users can request a password reset. This option requires Email Notifications to be enabled in the Email Settings tab.

Remember Me

Display the Remember Me option on the login page so users can set Yellowfin to remember their credentials for a set period of time.

Remember Me Period

If Only displayed if 'Remember Me' is enabled, this . This defines the number of hours Yellowfin will remember a user's credentials.

Password Expiry PolicyWhen enabled, set an expiry duration for user passwords, and each user will receive an email requesting they update their password 10 days before it expires. If a user does not log in before their password expires, they will be prompted to reset their password at next login before they gain access to the system.
Note: this option is not available for LDAP users as their password management is handled by LDAP.
Password Expiry AgeThe Only displayed if 'Password Expiry Policy' is enabled. This sets the number of days that a user's password is valid. This value to can be set to any number of days and begins counting down from the day after a user's current password is set.


...

Expand
titlePage Header


Option

Description

Display

Define whether a standard, custom, or no header is used throughout the system.

URL

This option only displays if 'Display' is set to 'Custom'. Specify the location of the custom header file.

Page Title

Display the page title in the header area of the page.

User

Display the name of the current user in the header area of the page.

Client

Display the name of the current client org in the header area of the page.

Role

Display the name of the current user's role in the header area of the page.


...

Expand
titlePage Footer


Option

Description

Display

Define whether a standard, custom, or no footer is used throughout the system.

URL

This option only displays if 'Display' is set to 'Custom'. Specify the location of the custom footer file.


...

Expand
titleTimeout Page


Option

Description

Display

Define whether a standard or custom session timeout page is used.

URL

This option only displays if 'Display' is set to 'Custom'. Specify the location of the custom timeout page.


...