Difference between revisions of "FAQ"

Revision as of 13:16, 15 August 2011

General

What is the BioCASe Provider Software and what can I use it for?

See the Beginner's Guide.

When can I use the BioCASe Provider Software?

See the requirements in the Beginner's Guide.

I’m not sure whether the Provider Software is the right choice for me. How do I find out?

Just contact us and describe your situation and what you’re planning to use BioCASe for.

How much is the BioCASe Provider Software?

It’s Open Source Software, so you can use it for free.

I am not affiliated with any institution. Can I use the Provider Software in spite of that?

Sure, you can also use the Provider Software as a private person.

Can I use the Provider Software on my operating system?

I guess. As long as a web server (such as Apache) and Python are available for your operating system, you can – and they are for most operating systems.

I cannot meet all of the requirements for installing the BPS. What options do I have?

Basically, there are two options: If you still want to use BioCASe (maybe because you owe very rich data and need the comprehensive ABCD schema for publication), you might ask a partner institution already using BioCASe to host your data. In this case, you would send the database (or Excel file) to this institution, where it would be published using the existing BioCASe installation. You would still remain owner of the data and attributed accordingly on the data portals; the partner institution would act merely as a technical host (like a commercial internet host).

Another option would be to use one of the tools offered by GBIF. With the Integrated Publishing Toolkit (IPT, http://www.gbif.org/informatics/infrastructure/publishing/) you can create a DarwinCore Archive (see http://www.gbif.org/informatics/standards-and-tools/publishing-data/data-standards/darwin-core-archives/ for more on DwC Archives) from your database, which you would send to GBIF for publication. The GBIF Spreadsheet Processor (http://code.google.com/p/gbif-spreadsheet-processor/) is a similar tool intended for smaller occurrence datasets stored in Excel files. The downside for both is that they support only the DarwinCore standard, which is rather limited in comparison to ABCD.

I have some recommendations/bug report. How can I file it?

You can either leave a message on the respective Discussion page or get directly in contact with us.

Installation

I already have a newer Python version installed on my server which is already used by another application. I read that Python 2.5 is recommended for BioCASe. What should I do?

You can have several Python versions installed on the same machine, so you can keep the newer version for other applications and install Python 2.5 for BioCASe.

When typing in the URL for my new installation (http://localhost/biocase), I get an empty page or a “URL not found” error. What’s wrong?

If you get a blank page, that’s probably because Apache (or the web server you use) is not running. Start it and retry (you might need to close and reopen your browser). If you get a “The requested URL /biocase was not found on this server” or similar message, the web server doesn’t find your BioCASe installation. Go to the section Linking BioCASe and Your Web Server of the Installation guide and follow the instructions.

When typing in the URL for my new installation (http://localhost/biocase), I get an “Internal Server Error: The server encountered an internal error or misconfiguration and was unable to complete your request” message.

You’re probably using Apache, which cannot find your Python installation. Make sure you’ve installed Python correctly and did run the setup script (see sections Installing Apache/IIS and Python and Running the Setup Script in the Installation guide).

I cannot find the installation package for the DBMS and the Python version I am using.

You’re probably using one of the newer Python versions which are not yet supported by the DB package you want to use (that’s the reason Python 2.5 is recommended). Just install an older version (2.5 or 2.6). You can have several Python versions installed on the same machine, so you can keep the newer version for other applications and install the older version for BioCASe.

I’ve installed the Python package for my DBMS, but it doesn’t show up in the Test libs page. What’s wrong?

Python packages are Python version specific and you’ve probably installed the DB package for the wrong Python version. If you have several Python versions installed on your machine, make sure you installed the package for the version that is used by BioCASe.

I’m using Postgres and installed the psycopg2 lib for that. When connecting, I get a pink error message “A problem occurred in a Python script”; the last line of the error messages reads “psycopg2._psycopg.connection object has no attribute server_version”.

This is caused by an outdated psycopg2 version. Please install version 2.0.12 or later.

I have problems installing GraphViz. Do I really need it?

If installed, Graphviz will create a graph of the table you've configured with their primary/foreign keys and the relations between them on the Database Structure page. If you have more than just a few tables and lots of relations between them, this can be very useful. If you don't need this feature, you don't need to bother installing GraphViz.

I’ve installed GraphViz, but it doesn’t show up as being installed on the Test libs page.

You need to tell BioCASe about the location of the GraphViz files, since it is not a Python package that will be registered automatically. In order to do so, locate the Graphviz installation on your local disk. Go to the System Administration and enter the path to the binary executable into the text box labelled Graphviz dot binary. On Linux machines it might look similar to the default (/usr/local/bin/dot), on Windows machines it will be probably something like C:\Program Files\Graphviz2.26.3\bin\dot.exe. Press update config to save the path.

I want to update my BioCASe installation. How do I do this?

First: If you have a running BioCASe installation, you shouldn’t touch it until you’ve successfully installed a new version. So keep the old installation instead of replacing it. Download and install the new version as described in the Installation guide (lucky enough, you can skip the installation of Apache, Python and any DB packages). Before pointing your web server to the new installation, manually copy the configuration files located in the config folder of your old installation: config.ini for the system settings and all folders in the datasources directory.

Debugging

I’ve mapped ABCD2. In the result document, each record of the dataset becomes a single dataset, even though there is just one dataset in the database – what’s wrong?

That’s probably because you’ve mapped a metadata element to a table that holds several rows for this dataset, so for each row a different dataset gets created. It doesn’t matter whether the values for that field are effectively different from each other; rows are distinguished from each other by their primary keys.

I’ve mapped ABCD2, and in the result datasets I get several units for each record, each with the same UnitID.

That happens when you map a non-repeatable element of ABCD to a database column that has several rows for one record. In order to create a valid ABCD document, for each of these values a new unit gets created by the Provider Software. To solve this, remove the multiple values or map them to a repeatable element.

The database connection status is No Connection, even though I’ve selected the correct DBMS in the connection settings dialog and entered the credentials into the text boxes.

Check whether you’ve installed Python package for the DBMS you’re using (test libs page). If you still can’t get a connection, turn on debugging (in the System Administration dialog) and go to the database settings dialog again, press Save to retry connecting. Then see the log files (in the log folder of your biocase installation) for more detailed error messages.

The information that can be found in the log files folder is too sparse – what can I do?

Turn on debugging in the System Administration.

How do I find out if my BioCASe web service works right?

Use the Query Form to send a BioCASe request to your web server and check the result document (see the Debugging guide and the Sample ABCD document for more).

I’ve copied a schema mapping for a datasource from an older installation by placing the cmf_ABCD_2.06.xml in the datasource configuration folder, but when querying the datasource, I get a “schema is not supported by this provider” error.

The Provider Software keeps a list of supported schema mappings in the provider setup file. Just open go to the mapping editor for the schema in question, press Save (without having modified anything), then go back to the overview page of the datasource configuration. The Provider Software will then update the list of the supported schemas.

When using the local Query Form for debugging, I don’t get any results, even though my web service is working. On pressing Submit, I get a timeout after about a minute.

That’s probably because the domain configured in the BioCASe System administration is not correct. The default localhost works only if you’re using the query form directly on the server machine. If you’re using them in the browser window of another machine, the domain needs to be configured correctly with the IP address or the full server name (e.g. ww3.bgbm.org).

I mapped the ABCD concept FullScientificNameString. But when running the Search test (which includes a filter on the scientific name per default), I still get the error message "The requested concept /DataSets/DataSet/Units/Unit/Identifications/Identification/Result/TaxonIdentified/ScientificName/FullScientificNameString is not searchable for this provider! Please do a capabilities request to see all searchable concepts." What's wrong?

The element FullScientificNameString exists twice in ABCD 2 (as the whole TaxonIdentified tree that surrounds it): once for the Identification object under the path above, and then in the Synecology branch (/DataSets/DataSet/Units/Unit/Gathering/Synecology). This can be a bit confusing, and probably you've accidentally mapped the wrong concept. Change the mapping, and it should work.

Trouble Shooting

I’ve forgot the password of my BioCASe installation. What should I do?

Just go to the config folder of your installation and have a look into the file config.ini.

I get a nice pink “A problem occurred in a Python script” error. What’s wrong?

Probably something happened we didn’t foresee, or you might have just found a bug. Please take a screenshot of the screen and write down what you did to make this happen. Then contact the BioCASe team.

I run into problems when installing/configuring the Provider Software. Neither the tutorials nor these FAQ I am looking at now can help me.

Just contact us; we’ll try our best to help you.

In the mapping editor, I am trying to insert a literal that contains a non ASCII character. When saving, the system directs me to a page that tells me a Python settings file (sitecustomize.py) will be changed. Unfortunately, on my installation there is no such file in that location; as a result, I get an enoding error in the Provider Software later on.

First of all, read the paragraphs on the disadvantages of mapping literals in the Beginners Guide and consider storing the information in a database table instead of mapping it as literals. Then, just move the data to a table and map it to the database columns. If, after thinking it over again, you still want to map literals, you need to do the following:

• Go to your Python installation (for example /usr/lib/python2.5),
• Create the file sitecustomize.py in the subfolder /site-packages with the following two lines:

import sys
sys.setdefaultencoding('utf-8')

• Save the file and retry. Maybe you'll have to restart your machine for the changes to take effect.