This page allows administrators to configure a wide range of settings that fall under the following tabs:
- Configuration - Email
- Configuration - System
- Configuration - Region
- Configuration - Authentication
- Configuration - Integration
You can configure all email related settings here, including default addresses and outgoing server settings that set up your SMPT server.
Support Email Address
Define the email address to receive support issue emails.
Enable email notifications for various user events in the system. See here for a list of all events.
Email Notification Display Name
Define the sender display name for Email Notifications.
Email Notification Address
Define the sender email address for Email Notifications.
Enable the events to send users email notifications for:
Broadcast Display Name
Define the sender display name for Broadcast emails.
Broadcast Email Address
Define the sender email address for Broadcast emails.
|Display Broadcast Filter Values||Display the filter values applied to the report in the body of the broadcast email.|
Allow users to search for recipients in the user list when sending an email.
|Broadcast Failure Task||A task will be created any time a broadcast fails to be sent.|
Broadcast Failure Task Recipient
Select a group to receive broadcast failure tasks.
|Custom Share Email Sender||Allows Yellowfin content to be shared through a customized email account, if enabled, rather than through the logged in user's account. Use the following two configurations to define the custom account.|
|Share Email Display Name||Define the sender's display name for shared emails.|
|Share Email Address||Define the sender's email address for shared emails.|
Send email in Background
Allow users to continue working in the system while an email is sent.
Include link in Broadcast
Include a link to the content in all broadcast types.
Define the hostname or IP address of the outgoing mail server to be used to send emails.
Define the port to connect to the outgoing mail server on. Leave this blank to use the default SMTP port.
Enable this option if your SMTP server requires authentication. You will then need to complete the following:
|Email Size Limit||Define the maximum email content size (in megabytes) permitted to be broadcast.|
Define how to use encryption when connecting to the outgoing mail server. Options include:
|Allow Invalid Certificate||Allow connections to the outgoing mail server even if the SSL certificate is not valid. Warning: Only use this option if you trust the server.|
Test Email Address
Define an email address to send a test email to.
Save to Disk Path
The server path where Save To Disk report broadcasts will be saved. This can also be a UNC path if the user’s environment permits.
You can configure general system settings here, including view & pdf defaults, logo options, and server settings.
Select a navigation style to use within the system. The following are available:
|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).
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.
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.
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
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.
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.
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)
Select the storyboard to be used for guiding users through the Administration area. (Optional)
|Minimum Schedule Interval||Select 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 Support||Enable this to allow Yellowfin to be used across multiple tabs and browsers during a single user session.|
|Maximum File Upload Size||Set 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.
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:
Logo Image Scale Factor
Define the percentage the Logo Image will be scaled to.
Filter Views by Category
Display the View list in Administration grouped by Source and View Category.
Table List Length
Define the number of tables displayed at once in the Database Tables list on Step 1 of the Drag & Drop View Builder.
|View Data Preview|
Define the default number of rows of data to be displayed in the View Builder.
Database Column Order
Display the columns within a database table in alphabetical or native order when viewed in the View Builder.
|Grouped Values Threshold||Define the number of unique values in a field required before the Grouped Values option is suggested. This is used in the Data Profiling section of the View Builder.|
Report View List Sort
Define whether to sort the list of available views on the Report Initialisation page by their name or recent use.
|Drill Anywhere Default||Define whether or not Drill Anywhere is enabled by default on new fields when they are added to views.|
|Default Metric Aggregation||Select the default aggregation to be applied whenever a metric field is added to a view.|
|Add New View Fields||Define whether or not table fields selected on the Model page in the view builder will automatically be added as view fields.|
|Default Data Preview||Choose a default selection for the data previewed on the Prepare page in the view builder.|
|Data Profiling||Define whether or not data profiling is enabled in the view builder.|
|Export to CSV||Allow users to export report results to CSV by default.|
Export to DOCX
|Allow users to export report results to DOCX by default.|
|Export to PDF||Allow users to export report results to PDF by default.|
Export to XLSX
|Allow users to export report results to XLSX by default.|
Select the default paper size to be used for PDF exports.
Select the default paper orientation to be used for PDF exports.
Shrink to Fit Page Width
Define if content should be shrunk to fit on a page, or displayed as is - possibly cutting content if too large.
Define the default height (pixels) of page headers in PDF exports.
Define the default height (pixels) of page footers in PDF exports.
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.
Define a password to be used to secure PDF exports. (Optional)
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.
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.
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.
Dashboard Code Mode
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 running.
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.
You can configure all region related settings here, including time & date and language specific text settings.
Default User Time Zone
Specify the default Time Zone to be initially assigned to users until they customise the setting.
Specify the default date format to be used throughout the system.
Week Start Day
Specify the first day of the week, to be used for predefined date filters.
Financial Year Start Date
Specify the first day of the financial year for use in predefined date filters
Specify the default format to be used when displaying a user’s full name in the system.
|Middle Initial||Specify if the middle initial should be used in names by default.|
Specify the default decimal separator character to be used in the system.
Specify the default thousand separator character to be used in the system.
Default Language Font
Specify the default language font to be used in the system if special language characters are required.
|User Defined Language Font||Specify if users should be able to specify their preferred language font, rather using the system defined Default Language Font for PDF export settings.|
CSV Character Set
Specify the default character set to be used when exporting reports to CSV format.
Decimal Separator Per Language
Toggle to activate an alternative decimal separator for each non-default user language set. Users will see this decimal separator in their language on any reports and charts they view, overriding the system-wide default for them.
Thousand Separator Per Language
Toggle to activate an alternative thousand separator for each non-default user language set. Users will see this thousand separator in their language on any reports and charts they view, overriding the system-wide default for them.
Enable Content Translation to allow advanced users to provide alternate text to be displayed for additional languages.
Specify the languages users may translate content to.
|Copy Content Translation||Enable this toggle to copy translated content when making a copy of a report with it. If disabled, the copied report only contains the original content.|
You can configure all authentication related settings here, including implementing LDAP authentication, Client Organizations, and password restrictions.
Specify whether users log in to the system with an email address or username.
Allow External Access
Direct links to unsecured content can be shared with anyone.
Multiple Login Logic
Define what happens when a user tries to log in at one location, when they're already logged in somewhere else.
|Allow Content Super User|
A super user can view and delete content across the board, overriding any other config settings related to viewing and managing content. This includes the XML export of private content. Therefore, any user roles given this function have full access to all content, whether private or public, within an organization.
After activating this setting, you must then assign user roles that include this function. When this function is included in a user role, the role cannot be deleted. Remember, changes at the role level won't take effect for a user until their next successful login.
Define whether system or LDAP authentication will be used during the login process.
|JWT Single Sign On||Enable 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 On||Enable user authentication via SAML. Toggling this option on produces a variety of options. See the related wiki page for more information.|
The LDAP directory needs to be configured, if this is the selected user authentication method.
The Hostname or IP address of the LDAP server.
The TCP port that the LDAP service is listening on.
The encryption method implemented by the LDAP server.
LDAP Base DN
The LDAP node that all users and groups are contained within.
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.
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 your LDAP connection with the settings defined above.
See Configuration for more information.
Client Organization Functionality
Enable creation of multiple virtual instances within the system.
Allow annotations created at the Primary Org to be viewed through any Client Orgs.
Password Length Restrictions
Define the minimum and maximum character length for user passwords.
Enable any special password requirements for user passwords. These can include requiring:
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.
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
Only displayed if 'Remember Me' is enabled. This defines the number of hours Yellowfin will remember a user's credentials.
|Password Expiry Policy||When 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 Age||Only displayed if 'Password Expiry Policy' is enabled. This sets the number of days that a user's password is valid. This value can be set to any number of days and begins counting down from the day after a user's current password is set.|
You can configure integration settings that allow you to customize panels in Yellowfin, including Headers, Footers, and Toolbars.
Define whether a standard, custom, or no header is used throughout the system.
This option only displays if 'Display' is set to 'Custom'. Specify the location of the custom header file.
Display the page title in the header area of the page.
Display the name of the current user in the header area of the page.
Display the name of the current client org in the header area of the page.
Display the name of the current user's role in the header area of the page.
Display the main navigation bar directly under the header area of the page.
Display a Logout link in the main navigation bar directly under the header area.
Define the number of pixels the main navigation bar options are pushed out from the left hand side of the page.
Define whether a standard, custom, or no footer is used throughout the system.
This option only displays if 'Display' is set to 'Custom'. Specify the location of the custom footer file.
Define whether a standard or custom session timeout page is used.
This option only displays if 'Display' is set to 'Custom'. Specify the location of the custom timeout page.