XhBtRmL Configuration file and XBRL Database: Difference between pages

From XBRLWiki
(Difference between pages)
Jump to navigationJump to search
 
No edit summary
 
Line 1: Line 1:
During the creation of an [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/transform/TransformProcessor.html TransformProcessor]] instance, the URI of a configuration file is required. The configuration file contains information required by the TransformProcessor in order to get all required information.
==Product page==


The configuration file must be a valid instance of an XML document according to the schema documented in this section.
[[http://www.reportingstandard.com/XBRL_Database.xhtml XBRL Database]]


==Namespace==
[[File:XBRLDBIcon.png|none|left|XhBtRmL template language to produce HTML representation of XBRL reports]]


The namespace for the configuration file is '''<nowiki>http://www.reportingstandard.com/transform/0</nowiki>'''
==Description==


==Schema location==
The XBRL Database is a permament repository system implemented using relational databases and the most advanced technologies in order to allow the storage of document level information like XBRL reports, XBRL Taxonomies and XBRL Linkbases along with granular level information as XBRL Fact items, XBRL concept definitions, XBRL Labels, XBRL Resources, XBRL Relationships.


The schema location for the configuration file is http://www.reportingstandard.com/taxonomies/versioning/transformer.xsd
* The storage system allows the storage of everything that is valid XBRL 2.1
* The storage repository accepts information for any existing or new XBRL 2.1 taxonomy
* The storage system allows users to develop complex cross instance document and cross taxonomy information systems


==Sample file==
There is a live demo of the XBRL Database that store all the information published by the SEC here [[http://www.xbrl4.org/regulators/ExploreXBRL.html ExploreXBRL direct link]].


This is the content of a sample configuration file:
For more information about the XBRL Database please contact reporting standard directly by sending an email to info at reportingstandard.com
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<!-- This is a configration file to transform XBRL into another format or databases etc -->
<xbrlTransformation
  xmlns="http://www.reportingstandard.com/transform/0"
  xmlns:xbrli="http://www.xbrl.org/2003/instance"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.reportingstandard.com/transform/0 http://www.reportingstandard.com/taxonomies/versioning/transformer.xsd">
    <dts>
        <dimensional/>
        <file>samples/taxonomies/sample/sampleTaxonomy.xsd</file>
        <transformer class="com.ihr.xbrl.transform.target.HTMLFactHandler" configFile="samples/htmlFactConfigFile.xml"/>
        <resultInstances>1</resultInstances>
        <result class="com.ihr.xbrl.transform.target.HTMLReportHandler" configFile="samples/htmlReportConfigFileSample.xml"/>
    </dts>
</xbrlTransformation>
</syntaxhighlight>


==Configuration file content==
Starting with version 2.6.12 of Reporting Standard S.L. tools, the XBRL Database functionality has been incorporated into XBRLizer and XBRLViewer. Also, a new software component has been created in order to access to information stored in the XBRL Database from Excel formulas.


===Root element===
Now, the XBRL Database can receive XBRL reports from:


The root element is '''<xbrlTransformation ...>'''. The content of the '''<xbrlTransformation ...>''' is a sequence of one or more '''dts''' elements. This means, the same TransformProcessor instance can be used for multiple DTSs simultaneously.
* The XBRL Validation component (server mode) after XBRL 2.1 validation is finished with no errors.
* The XBRL Grab daemon that periodically search for new reports published (We currently support the SEC RSS feed)
* XBRLizer and XBRLViewer, using the File -> XBRL Database -> Store document into the XBRL Database.
* All the components above relays on a API component in the library for storing a DTS into the XBRL Database. That API is available from other applications to use.


===The '''dts''' element===
The XBRL Database can be used from:


This element defines how a DTS is defined and what the TransformProcessor will do with it. The first child of the '''dts''' element is optional and is an indication to let the processor knows if the DTS will contain or not dimensions. This is indicated by the optional empty '''dimensional''' element.
* XBRLizer, XBRLviewer and any other API component the File -> Open component has a button to open data from the XBRL Database. The XBRL Database can be used as a proxy for official documents based on the absolute document URI.
* The Excel functions that access information in XBRL reports using filters.
* Any other application trying to load information from SQL to another BI (Business Intelligence) system.


===The '''file''' element===
==User data model==
The XBRL Database API provides a mechanism to extend the XBRL data model. This allows developers using Reporting Standard XBRL API to create their own data model and tables on top of the XBRL data model and use them as any other tables in the model.


The next element is '''file'''. The content of the '''file''' element is a relative or absolute URL pointing to a file. There may be one or many '''file''' elements. '''file''' elements will be used in order to define the DTS that should match the DTS of instance document submitted to the transformer for processing.
There is more information in the [[How to add classes to the XBRL Database model]] wiki page.


A DTS will be defined inside the transformation processor using the URLs indicated in '''file''' elements and the DTS discovery rules in section 3.2 of the XBRL 2.1 specification. If the user points to a schema that contains linkbases, the DTS will contain the schema and the discovered linkbases. A matching instance document accepted for processing must contain the same documents set in the DTS.
==Navigate==
 
[[Main Page]]
===The '''transformer''' element===
 
Transformation requires an object responsible of attending transformation events. This is done by classes implementing interfaces, in this case the transformer is implemented by the ''com.ihr.xbrl.transform.target.HTMLFactHandler'' class. The interface of that class accepts a configuration file but the implementation class actually does not require a configuration file so the parameter is not used.
 
===The '''resultInstances''' element===
 
The TransformProcessor instance keeps an internal pool of created ReportHandlers. ReportHandlers are used in order to allow multiple threads to run concurrently on the transformation from XBRL to HTML without interfering one in the memory space of the other. The parameter indicated here is the initial pool size. The pool grows up automatically.
 
===The '''result''' element===
 
This is the class and configuration file for the ReportHandler. In this example the class in use is the ''com.ihr.xbrl.transform.target.HTMLReportHandler'' and this class requires a configuration file in order to indicate special number formatting options, default number formatting options and the initial template to be used. Refer to the section [[XhBtRmL HTMLReportHandler Configuration file]] for more information.
 
==Navigation==
[[Main Page]] | [[XhBtRmL]]

Revision as of 15:28, 4 September 2013

Product page

[XBRL Database]

XhBtRmL template language to produce HTML representation of XBRL reports

Description

The XBRL Database is a permament repository system implemented using relational databases and the most advanced technologies in order to allow the storage of document level information like XBRL reports, XBRL Taxonomies and XBRL Linkbases along with granular level information as XBRL Fact items, XBRL concept definitions, XBRL Labels, XBRL Resources, XBRL Relationships.

  • The storage system allows the storage of everything that is valid XBRL 2.1
  • The storage repository accepts information for any existing or new XBRL 2.1 taxonomy
  • The storage system allows users to develop complex cross instance document and cross taxonomy information systems

There is a live demo of the XBRL Database that store all the information published by the SEC here [ExploreXBRL direct link].

For more information about the XBRL Database please contact reporting standard directly by sending an email to info at reportingstandard.com

Starting with version 2.6.12 of Reporting Standard S.L. tools, the XBRL Database functionality has been incorporated into XBRLizer and XBRLViewer. Also, a new software component has been created in order to access to information stored in the XBRL Database from Excel formulas.

Now, the XBRL Database can receive XBRL reports from:

  • The XBRL Validation component (server mode) after XBRL 2.1 validation is finished with no errors.
  • The XBRL Grab daemon that periodically search for new reports published (We currently support the SEC RSS feed)
  • XBRLizer and XBRLViewer, using the File -> XBRL Database -> Store document into the XBRL Database.
  • All the components above relays on a API component in the library for storing a DTS into the XBRL Database. That API is available from other applications to use.

The XBRL Database can be used from:

  • XBRLizer, XBRLviewer and any other API component the File -> Open component has a button to open data from the XBRL Database. The XBRL Database can be used as a proxy for official documents based on the absolute document URI.
  • The Excel functions that access information in XBRL reports using filters.
  • Any other application trying to load information from SQL to another BI (Business Intelligence) system.

User data model

The XBRL Database API provides a mechanism to extend the XBRL data model. This allows developers using Reporting Standard XBRL API to create their own data model and tables on top of the XBRL data model and use them as any other tables in the model.

There is more information in the How to add classes to the XBRL Database model wiki page.

Navigate

Main Page

Retrieved from "https://reportingstandard.com/wiki/index.php?title=XhBtRmL_Configuration_file&oldid=348"