Installation on SQL-Server

From XBRLWiki
Jump to: navigation, search


  • SQL Server engine (SQL Server 2008 Express Edition is supported) installed either on the local computer or in a server that can be reach over the network.
  • SQL Server version 2005 or greater.
  • User with enough privileges to create tables and create indexes in the tablespace designated for the XBRL Database. Authentication on SQL Server can be either user name and password or integrated with the operating system (Windows Authentication)
  • Pay special attention to the Collation parameter once you create the database (see below). In XML (and XBRL too) uppercase and lowecase element names are different. SQL Server database engine must be configured for the indexes to distinguish between uppercase and lowercase element names. Regardless of the Collation dictionary you want to use is preferable you always select the _CS_AS_KS_WS option.


  1. Connect to the SQL-Server database and create a DATABASE that will be used for the storage of the XBRL data model, tables, indexes etc. There are multiple ways for creating a DAtABASE in SQL-Server, contact your SQL-Server database administrator for more information or read documentation on the Internet. The DATABASE name is a user's choice, in this walkthrough we have named it TBXBRL. In our case we are using Microsoft SQL Server Management Studio that can be installed from the Internet. As described in the Requisites section. then creating a new Database in the Databases folder, open the database properties and, on the General page, go down to Maintenance section. The Collation parameter should end with _CS_AS_KS_WS or you may be in troubles later when storing XBRL reports.
  2. If user authentication is based on Windows Authentication, then keep the fields User and Password blank. If you are using a 64 bits operating system you may have to contact our support department in order to obtain an updated version of the DLL that performs user authentication on 64 bit computers. The installation assumes you are running on a 32 bits operating system. (note Office 2007 is a 32 bits application and requires 32bits DLLs too on the Add-ins). If authentication is based on user name and password, annotate the assigned user name and password for later use. The user must have privileges for creating tables and indexes on the tables in the database.
  3. Open XBRLizer or XBRLviewer and do File -> XBRL Database -> DB Settings
    The following dialog appears
  4. Click on the SQL-Server button on the right. This will change the value of the Diver class text field and the value of the Dialect field. A dialog box would tell you more information related with settings for the SQL-Server database. The information in that dialog is also on this walkthrough.
  5. Change the value of the User and Password fields. The user will be XBRLUSER and the password will be XBRL in this walkthrough. Keep them blank if you are using Windows Authentication.
  6. Change the value of the URL text box according to the following format:
    • Substitute {server} with the server name or IP address of the computer where the SQL Server database is installed. If this is the same computer where Reporting Standard tools are installed you can use the name localhost or the IP address
    • Substitute {database} with the database name created on the first step TBXBRL.
    Contact you SQL Server Administrator for more information about the connection URL. Read documentation about SQL-Server JDBC driver (jtds) for more information about additional parameters on the URL.
  7. Click on (Test connection) button. If the connection can be established with the database, then all parameters are OK. In case of any errors you will be informed about the error condition. Please check the error message and correct the content of the User, Password or URL fields. Contact our support department in case of technical problems you don't know how to solve.
  8. At this time, the button (Drop & Create DB) changed from disabled status to enabled status. Click on that button in order to create the table model on the database.
  9. (Optional) if you made changes to the data model on your own, there is a chance the changes are not compatible with the XBRL storage procedure. In order to guarantee the compatibility of the data model we provide a button that validates if the data model is compatible with the XBRL data model. At this stage most users don't need to validate the data model, but clicking on the Validate DB Structure will not hurt.
  10. Click on Exit. The database model has been created and it is ready for storing XBRL reports, taxonomies and linkbases.

Congratulations, you have the XBRL Database installed on SQL Server Database!


Main Page | Installing the XBRL Database