Environmental settings

These settings define the generic settings for the myDBR installation. The installation defines an instance of myDBR connected to a defined database.

Report Database Setup

These settings define the connection info for the myDBR installation and are stored in mydbr_config.php on the server. In order to change these re-run the installation. The installation will check that the required objects exist in the selected database.

Database type: MySQL is accessed through mysqli, Sybase ASE and Sybase Anywhere are accessed through FreeTDS and MS SQL Server can be accessed through FreeTDS or on Windows server using Microsoft's sqlsrv-driver.
Host: The computer where the reporting database is located. Hostname or an IP address.
Port: If the connection is using TCP/IP port, it is defined here.
Database: Name of the database containing the mydbr objects.
User: Admin user's username. This user must have privileges to the mydbr database object, including the right to execute stored routines. In the example installation, we created user mydbr for this purpose.
Password: Password for the admin user.

Authentication

Determines which authentication module is used.

myDBR user authentication: User logins and passwords are defined inside myDBR. See Users.
Database login: A user is authenticated through the database's own user/password procedure. The user must have access to the database containing the reported data.
Single Sign-On (SSO): The user is authenticated by an external website which then redirects the user back to myDBR. See SSO for more information.
Active Directory: The user is authenticated using Active directory.
Custom: Custom authentication allows using external authentication, while still keeping the simplicity of the login process. See Custom authentication for more information.
Session lifetime: Session duration allowing the user to stay connected even when the browser is closed. When returning to myDBR a previous session is restored. Please note that you may need to change PHP's gc_maxlifetime-directive in order to have a longer lifetime.
Two-factor authentication: As an OEM version feature, Two-factor authentication protects the logins via Google Authenticator (TOTP).

Password settings when using myDBR authentication

Defines password rules.

Single Sign-On (SSO) settings

SSO secret token: The token used to verify that SSO redirects are coming from the authenticated SSO server. This token is known only to the myDBR server and SSO server
SSO Server URL: The URL to which the user is redirected for login. myDBR will add a random token and a return URL as parameters to this URL. See SSO for more information.

Active Directory settings

Domain Controller: List of Domain Controllers. If you want to balance the queries over multiple controllers, you can specify multiple controllers by separating them with a comma. Example dc01.mydomain.local
Account Suffix: The full account suffix for your domain. Example mydomain.local
Base DN: The base dn for your domain. This is generally the same as your account suffix, but broken up and prefixed with DC=. Your base dn can be located in the extended attributes in Active Directory Users and Computers MMC.
Username / Password: An AD username with access rights to read the AD structure.

Password reset

Password reset allows users to reset their own password via email request when using myDBR authentication. User request a password reset request and receives via email a password reset link. The link is valid for the defined period. In order to use this functionality, the mail settings need to be set and the user's myDBR account needs to have a valid email address. New reset link request reset the old ones. The link can be used only once.

Enabled: Defines if the feature is enabled
Username / Email / Username or email: Defines which information is asked from the user when (s)he requests a password reset link
Admin user's password can be changed: If this is set the user can request a password reset link for the admin user. if unchecked, admin logins are protected from password change
Reset link valid for XX minutes: The user can use the link sent only for XX minutes. After that, the link expires and cannot be used.
Show reset link only after a login failure: If this is set, the link to password reset functionality is shown only after an unsuccessful login attempt. If the option is not set, the link is always visible.

Customizing the password reset email

You can customize the password reset email templates defined in mydbr/interface/languages/templates-folder. By creating a template with same name in mydbr/user/templates/-folder. A template can contain HTML code and supports following predefined template variables:

#{name} User name
#{hostname} The server URL
#{reset_link} Password reset link
#{link_valid_minutes} How many minutes the password reset link is active
#{page_title} Page title defined in Environment settings

Automatic login

With automatic login enabled, no user login is required. All users accessing the reports will use the same login info. This option is used in cases where myDBR is used as a public reporting source (intranets, public extranets). Username and password here should in normal cases be set to the non-admin username (not allowing everyone to change the content). Admin access can be gained by pointing the browser to login.php instead of the usual index.php.

Username: The username to be used as a shared username
Password: The password to be used as a shared password

Formatting defaults

These settings are shared between the users.

Date: Default date format
Time: Default time format
Thousand separator: Default thousand separator
Decimal separator: Default decimal separator
Sum prefix, Min prefix, Max prefix, Average prefix, Count prefix: Prefixes to be used in summary rows when aggregate functions are used in reports
myDBR report prefix: By default, myDBR will search for unused reports based on this prefix. Any stored procedure that starts with this prefix is offered to be added into the myDBR reporting structure
Theme: The UI style to be used in the application
Language: Languages available under myDBR installation. This selection will allow the admin to translate the system to selected languages and users to set these languages as default

Mail

Mail is used by dbr.mail extension and the password reset feature.

Host: SMTP mail hostname
Port: TCP/IP port used by the SMTP mail server (25 is the default for non-encrypted mail)
Secure: The mail can use TLS/SSL encryption
Username/Password: Username/password for protected mail server access
From Name/Email: Defaults to be used for "From:"
ReplyTo Name/Email: Defaults to be used for "ReplyTo:". Optional. If not set, no separate ReplyTo header is used in mail.

If separate "From Name/Email" and "ReplyTo Name/Email" is wanted for password resets, these can be set by overriding the defaults.php's 'password_reset' values in user/defaults.php.

The password reset instructions are sent to the user's mail address. The mail templates are stored in mydbr/interface/languages/templates. If your language template is not there, you can create one by copying the existing templates and modifying them. If you want to override the existing templates and create your own ones, you can place one with the same name into mydbr/user/templates.

OEM

OEM customization options are shown if you have an OEM license.

Licensee: The OEM license holder. Shown in the About-dialog.
Application name: When defined, replaces the 'myDBR'-text in the upper left corner in non-report screens.
Disable header: When selected, no header is shown. Suitable for installations where myDBR is used just for the reports, navigation is done elsewhere.
Disable footer: When selected, no footer is shown.
Footer: When defined, replaces the standard footer text
About info: Additional info to the About-dialog
Login image CSS: An example of the CSS which defines the logo shown in the login screen. Place the definition into user/userstyle.css
Redis enabled: Use the Redis cache to speed up the reports
Redis host: Hostname for the server running the Redis
Redis port: TCP port used by the Redis
Redis username: If you use Redis with a defined username, otherwise leave this field empty
Redis password: The Redis password used for setups where the Redis server is password protected via the requirepass option in redis.conf. By default Redis is accessible only from the machine that it is installed in and by default has no password.
Key ID: If you have multiple myDBR installations using the same Redis, you can differentiate the key being used. The Redis keys used by myDBR use format "myDBR:"+report_id+":"+md5(query) if no key is set and "myDBR:"+redis_key+";"+report_id+":"+md5(query) if the key is set to "mydbr1")

Installed modules

myDBR supports multiple charting modules. In order to take advantage of image charts and Graphviz-charts, you need to install the support for these. See Optional installations on how to install these modules. wkhtmltopdf allows you to export myDBR reports at full quality.

Image-charts: ChartDirector image support. ChartDirector is an optional install to myDBR. ChartDirector is a commercial application whose license is included with myDBR.
Graphviz-charts: Graphviz support is enabled in the environment.
wkhtmltopdf: wkhtmltopdf support for better PDF output
Default chart format: Choose between SVG and PNG charts. SVG charts are rendered in the client and make full use of client browsers native font subsystem producing crisp charts. PNG charts are images generated in the server.
Use embedded charts: When checked, the chart data is embedded in the report.

Miscellaneous settings

PHP include path: Enables you to specify the PHP include path in environments where some of the modules are not in the default path.
Proxy server: If your server is behind a proxy, the automatic update may not work until the proxy server is defined. Format is host:port (no http:// prefix).