22 October, 2012

Setting up EurekaLog Viewer for remote server

EurekaLog Viewer 4 has feature of managing all of your bug reports in one central database. It supports Firebird databases. Viewer use local file database (embedded server) by default. However, you may want to set it up to use remote server.

Basic prerequisites

EurekaLog Viewer 4 is compiled against Firebird 2.1, default database is also created with Firebird 2.1. It's installed into %APPDATA%\EurekaLab s.a.s\EurekaLog\Viewer\Eureka.fdb by default. This file is used for actual work. There is also a master copy of database (empty database) located in C:\Program Files\EurekaLab\EurekaLog 7\Bin\Default.fdb. You can use this file to restore fatally corrupted database file in %APPDATA% folder. You can also use this file to copy it on another machines.

Database's default login/password is SYSDBA/masterkey. Additionally, Viewer uses its own additional roles. Default is admin/admin.

Setting up remote server

First you need to download Firebird 2.1 installer from the official web-site. You're interested in "Classic & Superserver Installer".

You should install it by following installation manual. No special steps are required. Installation with default settings is fine.

Copy Default.fdb file from machine with Viewer installed to machine with Firebird server. Make sure that Default.fdb file is placed to writable folder. You may rename file if you want (e.g. to something like Eureka.fdb).

(OPTIONAL) You may use any Firebird-client tool to test connection to Default.fdb, change default account password, and/or add more accounts. Use default isql.exe tool or any 3rd party tool (like IBExpert). EurekaLog Viewer do not have any database administration features.

Possible conflicts

Please note that Firebird 2.1 installation may conflict with Interbase installation (which usually comes with Delphi/C++ Builder), and even with another Firebird installation (other version).

If possible - remove any other Firebird and Interbase installations before installing Firebird 2.1. If this is not possible - then you may get conflicts. Please refer to Firebird documentation/support to know more about resolving conflicts.

Typically conflicts manifest itself as error message "Unsupported on-disk structure for file xxx.fdb; found yyy, support zzz" when you test connection or load Viewer. When you see such message - make sure that Viewer connects to proper Firebird installation and it uses proper client libraries. Again, refer to Firebird's documentation for more info.

Configuring Viewer

Run Viewer and go to Configure/Settings. Enable "Firebird database" option on "Database" tab. Enter remote server's name or IP address, full path to database file (as it's placed on remote server), and user name and password (SYSDBA/masterkey by default):

Entering remote database details
(click to enlarge)
Then click on "Test connection" button. If everything is set OK - then you should see OK message:

Success connection test
Otherwise (if there is error) - then solve it and re-test.

Please note: if you have already set up Viewer to use specific database file and try to test connection for the same file again - it will fail. That's because file is being used by Viewer itself. You first need to switch Viewer back to View mode and restart it. This will release database file. And then you may to reconfigure it.

Once database connection is established, you now may use Viewer. Optionally you may configure EurekaLog roles for more customizations. Please refer to Viewer's help for more information.

Switching View mode to Database mode

EurekaLog uses local Firebird database when being launched from Start menu. It also runs in View mode when opening bug report file. This is default behaviour.

Since you've already set up a remote server - you may want to import bug reports, rather than just view them. This can be done by two ways - either you do this default action or you will specifically select it for each bug report.

To put it short there are the following ways:
  1. Run Viewer from Start Menu or Tools menu (IDE). This will launch it in Database mode. Use "Import" command from toolbar and select bug report file to import.
  2. Right click on any bug report file and choose "Import the report" command.
  3. Run Viewer, go to Configure/Settings, switch to "Actions" tab and enable "Import into current database" option (note: this option is only available when you set up Database mode). Then close Viewer. Now double-clicking any bug report file will import it into database.

Please see also: Database mode vs. View mode.

Using Firebird 2.5 or higher

EurekaLog Viewer uses Firebird 2.1. There is a new version of Firebird available right now (2.5). It's not directly supported by Viewer, because Firebird 2.5 uses slightly different format of database file than Firebird 2.1. However, you still can use Firebird 2.5. You just need to migrate database file for this.

Please refer to Firebird documentation/support for more information about versions compatibility and migration process. However, migration process typically goes like this:
  1. Backup existing Firebird 2.1 database using Firebird 2.1 installation and tools
  2. Shutdown Firebird 2.1 server (optionally - uninstall it)
  3. Install Firebird 2.5 (if not installed) and run it
  4. Create new database file in Firebird 2.5 and restore it from the backup, resolve any possible import errors
Sometimes you may also need to copy Firebird's client DLLs to C:\Program Files\EurekaLab\EurekaLog 7\Bin\ folder.

No comments:

Post a Comment

You can use some HTML-tags like:

<b>Bold</b>
<i>Italic</i>
<a href="http://www.example.com/">Link</a>