oss

Xindice data store configuration

Overview

This page is relevant to those looking to use the XBRLAPI with the Xindice data store. It provides very terse suggestions on the steps required to get the Xindice database running in a manner that will permit interaction from the XBRLAPI.

You will need to download or otherwise have the xbrlapi-xindice module on the class path to use the Xindice data store.

Install a Java SDK

Install Tomcat or Jetty.

Install the Xindice database as a web application in the servlet container. Download the most recent stable version of Xindice. Make sure that you download the binary webapp. version of Xindice, which provides the necessary xindice-XXX.war file. Note that the XXX part of the war file name is likely to differ between releases of Xindice.

Rename the war file that you downloaded to xindice.war

Move the xindice.war file to the webapps directory in your Java servlet container.

Start the servlet container to unpack the war.

Check that the Xindice database is running by entering the URL http://localhost:8080/xindice/. You should see the ugly debugging tool if Xindice is operating properly. You may have to change the port number and the domain to match the servlet container configuration.

Once Xindice is installed in the Java servlet container, you should be able to run all of the unit tests in the unit testing suite provided by org.xbrlapi.data.xindice.tests.AllTests. If you run into problems make sure that the Xindice test configuration parameters reflect your own Xindice installation.

SourceForge Logo