XBRL Template File - Revision history

Ihr at 11:03, 27 October 2018

2018-10-27T11:03:40Z

← Older revision		Revision as of 11:03, 27 October 2018
Line 9:		Line 9:
	==Sample file==		==Sample file==

	<~~syntaxhighlight~~ lang="xml">		<source lang="xml">
	<?xml version="1.0" encoding="UTF-8"?>		<?xml version="1.0" encoding="UTF-8"?>
	<!--		<!--
Line 112:		Line 112:
	</xbrlMap>		</xbrlMap>

	</~~syntaxhighlight~~>		</source>

	==Elements==		==Elements==
Line 135:		Line 135:

	A sample datasources section where two data sources are defined. One is a web form, the other is a connection to a database that requires a configuration file called SQLMapperDriverConfig.xml and is located in the same folder as the XBRL Template file:		A sample datasources section where two data sources are defined. One is a web form, the other is a connection to a database that requires a configuration file called SQLMapperDriverConfig.xml and is located in the same folder as the XBRL Template file:
	<~~syntaxhighlight~~ lang="xml">		<source lang="xml">
	<datasources>		<datasources>
	<source id="form" class="com.ihr.xbrl.mapper.source.WebFormDataSource"/>		<source id="form" class="com.ihr.xbrl.mapper.source.WebFormDataSource"/>
	<source id="sql" class="com.ihr.xbrl.mapper.source.SQLDataSource" config="SQLMapperDriverConfig.xml"/>		<source id="sql" class="com.ihr.xbrl.mapper.source.SQLDataSource" config="SQLMapperDriverConfig.xml"/>
	</datasources>		</datasources>
	</~~syntaxhighlight~~>		</source>

	===Definition of events===		===Definition of events===
Line 157:		Line 157:

	This is a sample '''dts''' section definition for the IFRS taxonomy:		This is a sample '''dts''' section definition for the IFRS taxonomy:
	<~~syntaxhighlight~~ lang="xml">		<source lang="xml">
	<dts>		<dts>
	<file>http://xbrl.iasb.org/taxonomy/2009-04-01/ifrs/ias_1_2009-04-01/cal_ias_1_2009-04-01_role-210000.xml</file>		<file>http://xbrl.iasb.org/taxonomy/2009-04-01/ifrs/ias_1_2009-04-01/cal_ias_1_2009-04-01_role-210000.xml</file>
Line 164:		Line 164:
	<file>http://xbrl.iasb.org/taxonomy/2009-04-01/ifrs/ias_1_2009-04-01/def_ias_1_2009-04-01_role-210000.xml</file>		<file>http://xbrl.iasb.org/taxonomy/2009-04-01/ifrs/ias_1_2009-04-01/def_ias_1_2009-04-01_role-210000.xml</file>
	</dts>		</dts>
	</~~syntaxhighlight~~>		</source>
	Note that this example is not including the IFRS taxonomy schema. This is not an error. The required schema will be added automatically by the tool in order to produce a valid XBRL report during the document creation phase.		Note that this example is not including the IFRS taxonomy schema. This is not an error. The required schema will be added automatically by the tool in order to produce a valid XBRL report during the document creation phase.

Line 176:		Line 176:

	This is a very simple example of contexts inside the template file:		This is a very simple example of contexts inside the template file:
	<~~syntaxhighlight~~ lang="xml">		<source lang="xml">
	<contexts>		<contexts>
	<scheme>http://www.xbrl.org/companyName</scheme>		<scheme>http://www.xbrl.org/companyName</scheme>
Line 206:		Line 206:
	</context>		</context>
	</contexts>		</contexts>
	</~~syntaxhighlight~~>		</source>

	The first two elements of the contexts element are '''scheme''' and '''company'''. The value of those elements is any string value for company and a valid URI value for the scheme element. The values indicated here will be used in order to substitute the content of the XBRL identifiers in the real contexts. When the value of the scheme attribute in the identifier elements is an underscore character '''"_"''', the mapper processor will substitute the underscore character by the value indicated in the scheme element. When the processor find an underscore character are the value of the identifier element, it will be substituted by the value of the company element.		The first two elements of the contexts element are '''scheme''' and '''company'''. The value of those elements is any string value for company and a valid URI value for the scheme element. The values indicated here will be used in order to substitute the content of the XBRL identifiers in the real contexts. When the value of the scheme attribute in the identifier elements is an underscore character '''"_"''', the mapper processor will substitute the underscore character by the value indicated in the scheme element. When the processor find an underscore character are the value of the identifier element, it will be substituted by the value of the company element.
Line 225:		Line 225:

	This is an example of a units element with content:		This is an example of a units element with content:
	<~~syntaxhighlight~~ lang="xml">		<source lang="xml">
	<units>		<units>
	<xbrli:unit id="Euros">		<xbrli:unit id="Euros">
Line 231:		Line 231:
	</xbrli:unit>		</xbrli:unit>
	</units>		</units>
	</~~syntaxhighlight~~>		</source>

	Units must have an id that will be referenced from item data events.		Units must have an id that will be referenced from item data events.
Line 240:		Line 240:

	The following piece of XML code is the declaration of an event in order to obtain data for an item fact. All required information for the event definition is stored in attributes. Part of the information is required and other parts are optional.		The following piece of XML code is the declaration of an event in order to obtain data for an item fact. All required information for the event definition is stored in attributes. Part of the information is required and other parts are optional.
	<~~syntaxhighlight~~ lang="xml">		<source lang="xml">
	<item sourceRef="source0" contextRef="ctx0i" mapIdentifier="identifier0" concept="tx:A" unitRef="Euros"/>		<item sourceRef="source0" contextRef="ctx0i" mapIdentifier="identifier0" concept="tx:A" unitRef="Euros"/>
	</~~syntaxhighlight~~>		</source>

	The attributes defined in a fact item data capturing event are:		The attributes defined in a fact item data capturing event are:
Line 253:		Line 253:

	The following piece of XML code is the declaration of a sample event in order to obtain data for a tuple fact.		The following piece of XML code is the declaration of a sample event in order to obtain data for a tuple fact.
	<~~syntaxhighlight~~ lang="xml">		<source lang="xml">
	<tuple concept="tx:T">		<tuple concept="tx:T">
	... here goes the tuple specific events; they are other item events or tuple events. Events can be nested in order to represent tuple structures in the instance document ...		... here goes the tuple specific events; they are other item events or tuple events. Events can be nested in order to represent tuple structures in the instance document ...
	</tuple>		</tuple>
	</~~syntaxhighlight~~>		</source>

	The declaration of events in order to populate content for tuples contains the following attributes:		The declaration of events in order to populate content for tuples contains the following attributes:
Line 268:		Line 268:

	Sample content of a facts element:		Sample content of a facts element:
	<~~syntaxhighlight~~ lang="xml">		<source lang="xml">
	<facts xmlns:tx="http://taxonomy.com/example">		<facts xmlns:tx="http://taxonomy.com/example">

Line 291:		Line 291:
	<item sourceRef="source0" contextRef="ctx0dim" mapIdentifier="identifier3" concept="tx:C" unitRef="Euros"/>		<item sourceRef="source0" contextRef="ctx0dim" mapIdentifier="identifier3" concept="tx:C" unitRef="Euros"/>
	</facts>		</facts>
	</~~syntaxhighlight~~>		</source>
	==Navigation==		==Navigation==
	[[Main Page]] \| [[XBRLmapper]]		[[Main Page]] \| [[XBRLmapper]]

Ihr: /* Sample file */

2015-08-07T08:46:05Z

Sample file

← Older revision		Revision as of 08:46, 7 August 2015
Line 14:		Line 14:
	This is a simple configuration file for Reporting Standard XBRL Mapping engine.		This is a simple configuration file for Reporting Standard XBRL Mapping engine.

	(C) Reporting Standard S.L. 2007-~~2009~~ - All rights reserved		(C) Reporting Standard S.L. 2007-2015 - All rights reserved

	This file has been created for the purposes to show a simple use case for the mapper		This file has been created for the purposes to show a simple use case for the mapper
Line 24:		Line 24:
	-->		-->
	<xbrlMap		<xbrlMap
	xmlns="http://www.reportingstandard.com/map/2"		xmlns="http://www.reportingstandard.com/map/3"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.reportingstandard.com/map/1 http://www.reportingstandard.com/schemas/mapper/mapper-~~2009~~.xsd"		xsi:schemaLocation="http://www.reportingstandard.com/map/1 http://www.reportingstandard.com/schemas/mapper/mapper-2011.xsd"
	xmlns:xbrli="http://www.xbrl.org/2003/instance"		xmlns:xbrli="http://www.xbrl.org/2003/instance"
	xmlns:xbrldi="http://xbrl.org/2006/xbrldi">		xmlns:xbrldi="http://xbrl.org/2006/xbrldi">

Ihr: /* Sample file */

2015-08-07T08:45:34Z

Sample file

← Older revision		Revision as of 08:45, 7 August 2015
Line 18:		Line 18:
	This file has been created for the purposes to show a simple use case for the mapper		This file has been created for the purposes to show a simple use case for the mapper

	The namespace for this file is "http://www.reportingstandard.com/map/2"		The namespace for this file is "http://www.reportingstandard.com/map/3"
	The "official location" of the schema is "http://www.reportingstandard.com/schemas/mapper/mapper-~~2009~~.xsd"		The "official location" of the schema is "http://www.reportingstandard.com/schemas/mapper/mapper-2011.xsd"
	The mapping engine already provides an internal copy of the schema for the purposes of validating the		The mapping engine already provides an internal copy of the schema for the purposes of validating the
	configuration file. The mapping engine does not need to have interner access.		configuration file. The mapping engine does not need to have interner access.

Ihr: /* Description */

2015-08-07T08:44:56Z

Description

← Older revision		Revision as of 08:44, 7 August 2015
Line 3:		Line 3:
	The XBRL Template file is an XML file that defines events in order to let drivers to capture data that will be used for the generation of a new XBRL report.		The XBRL Template file is an XML file that defines events in order to let drivers to capture data that will be used for the generation of a new XBRL report.

	The namespace definition of elements in the XBRL Template file is '''<nowiki>http://www.reportingstandard.com/map/2</nowiki>'''		The namespace definition of elements in the XBRL Template file is '''<nowiki>http://www.reportingstandard.com/map/3</nowiki>'''

	The official location for the schema that corresponds to the indicated namespace is '''<nowiki>http://www.reportingstandard.com/schemas/mapper/mapper-~~2009~~.xsd</nowiki>'''		The official location for the schema that corresponds to the indicated namespace is '''<nowiki>http://www.reportingstandard.com/schemas/mapper/mapper-2011.xsd</nowiki>'''

	==Sample file==		==Sample file==

Ihr at 22:12, 6 September 2009

2009-09-06T22:12:32Z

← Older revision		Revision as of 22:12, 6 September 2009
Line 292:		Line 292:
	</facts>		</facts>
	</syntaxhighlight>		</syntaxhighlight>
			==Navigation==
			[[Main Page]] \| [[XBRLmapper]]

Ihr: /* Definition of data sources */

2009-09-06T22:05:57Z

Definition of data sources

← Older revision		Revision as of 22:05, 6 September 2009
Line 130:		Line 130:

	The '''source''' element is an empty element that has three attributes:		The '''source''' element is an empty element that has three attributes:
	* Required ''id'' attribute. Used by '''item''' and '''tuple''' events (see next section Definition of Events) in order to identify the source they are linked with.		* Required ''id'' attribute. Used by '''item''' and '''tuple''' events (see next section Definition of Events) in order to identify the data source they are linked with.
	* Required ''class'' attribute. Used to indicate the driver class. The driver class must be instantiated at runtime (in a dll or in the classpath) and must implement the interface defined in [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/mapper/source/XBRLDataSource.html the XBRLDataSource interface].		* Required ''class'' attribute. Used to indicate the driver class. The driver class must be instantiated at runtime (in a dll or in the classpath) and must implement the interface defined in [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/mapper/source/XBRLDataSource.html the XBRLDataSource interface].
	* Optional ''config'' attribute. Used to point to a file with configuration information for the driver indicated in the ''class'' attribute. The content may be a URI relative to the URI of the XBRL Template File and it is resolved using ''xml:base'' if it is indicated in the '''source''' element or any of it ancestors.		* Optional ''config'' attribute. Used to point to a file with configuration information for the driver indicated in the ''class'' attribute. The content may be a URI relative to the URI of the XBRL Template File and it is resolved using ''xml:base'' if it is indicated in the '''source''' element or any of it ancestors.

Ihr: /* Definition of data sources */

2009-09-06T22:05:28Z

Definition of data sources

← Older revision		Revision as of 22:05, 6 September 2009
Line 130:		Line 130:

	The '''source''' element is an empty element that has three attributes:		The '''source''' element is an empty element that has three attributes:
	* Required ''id'' attribute. Used by '''item''' and '''tuple''' events (see ~~definition~~ of ~~events later in this section~~) in order to identify the source they are linked with.		* Required ''id'' attribute. Used by '''item''' and '''tuple''' events (see next section Definition of Events) in order to identify the source they are linked with.
	* Required ''class'' attribute. Used to indicate the driver class. The driver class must be instantiated at runtime (in a dll or in the classpath) and must implement the interface defined in [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/mapper/source/XBRLDataSource.html the XBRLDataSource interface].		* Required ''class'' attribute. Used to indicate the driver class. The driver class must be instantiated at runtime (in a dll or in the classpath) and must implement the interface defined in [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/mapper/source/XBRLDataSource.html the XBRLDataSource interface].
	* Optional ''config'' attribute. Used to point to a file with configuration information for the driver indicated in the ''class'' attribute. The content may be a URI relative to the URI of the XBRL Template File and it is resolved using ''xml:base'' if it is indicated in the '''source''' element or any of it ancestors.		* Optional ''config'' attribute. Used to point to a file with configuration information for the driver indicated in the ''class'' attribute. The content may be a URI relative to the URI of the XBRL Template File and it is resolved using ''xml:base'' if it is indicated in the '''source''' element or any of it ancestors.

Ihr: /* Definition of data sources */

2009-09-06T22:04:49Z

Definition of data sources

← Older revision		Revision as of 22:04, 6 September 2009
Line 130:		Line 130:

	The '''source''' element is an empty element that has three attributes:		The '''source''' element is an empty element that has three attributes:
	* Required ''id'' attribute. Used by '''item''' and '''tuple''' events later in order to identify the source they are linked with.		* Required ''id'' attribute. Used by '''item''' and '''tuple''' events (see definition of events later in this section) in order to identify the source they are linked with.
	* Required ''class'' attribute. Used to indicate the driver class. The driver class must be instantiated at runtime (in a dll or in the classpath) and must implement the interface defined in [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/mapper/source/XBRLDataSource.html the XBRLDataSource interface].		* Required ''class'' attribute. Used to indicate the driver class. The driver class must be instantiated at runtime (in a dll or in the classpath) and must implement the interface defined in [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/mapper/source/XBRLDataSource.html the XBRLDataSource interface].
	* Optional ''config'' attribute. Used to point to a file with configuration information for the driver indicated in the ''class'' attribute. The content may be a URI relative to the URI of the XBRL Template File and it is resolved using ''xml:base'' if it is indicated in the '''source''' element or any of it ancestors.		* Optional ''config'' attribute. Used to point to a file with configuration information for the driver indicated in the ''class'' attribute. The content may be a URI relative to the URI of the XBRL Template File and it is resolved using ''xml:base'' if it is indicated in the '''source''' element or any of it ancestors.

Ihr: /* Events */

2009-07-01T16:53:23Z

Events

← Older revision		Revision as of 16:53, 1 July 2009
Line 239:		Line 239:
	Linking all together; the most important part of the instance template document are the events. Events are defined in order to obtain data from drivers and according to the [[Mapper to driver data exchange dialog\|mapper to driver data exchange dialog]]. The '''facts''' element wraps the content of all events defined in an XBRL Template File.		Linking all together; the most important part of the instance template document are the events. Events are defined in order to obtain data from drivers and according to the [[Mapper to driver data exchange dialog\|mapper to driver data exchange dialog]]. The '''facts''' element wraps the content of all events defined in an XBRL Template File.

	~~Sample~~ event ~~declaration~~ in order to obtain data for an item. All required information for the event definition is stored in attributes. Part of the information is required and other parts are optional.		The following piece of XML code is the declaration of an event in order to obtain data for an item fact. All required information for the event definition is stored in attributes. Part of the information is required and other parts are optional.
	<syntaxhighlight lang="xml">		<syntaxhighlight lang="xml">
	<item sourceRef="source0" contextRef="ctx0i" mapIdentifier="identifier0" concept="tx:A" unitRef="Euros"/>		<item sourceRef="source0" contextRef="ctx0i" mapIdentifier="identifier0" concept="tx:A" unitRef="Euros"/>
	</syntaxhighlight>		</syntaxhighlight>

	The attributes defined in item data capturing ~~events~~ are:		The attributes defined in a fact item data capturing event are:
	* required ''sourceRef'', this attribute content must match with the id of the '''source''' to be informed about the event.		* required ''sourceRef'', this attribute content must match with the id of the '''source''' to be informed about the event.
	* required ''contextRef'', this attribute content must match with the id of one of the contexts defined in the '''contexts''' section.		* required ''contextRef'', this attribute content must match with the id of one of the contexts defined in the '''contexts''' section.
	* required ''mapIdentifier'', this attribute holds the event name and will be used by drivers.		* required ''mapIdentifier'', this attribute holds the event name and will be used by drivers. See the [[Mapper to driver data exchange dialog\|mapper to driver data exchange dialog]] wiki page for more information.
	* required ''concept'', this attribute hold the concept QName this item refers to. The concept must be defined in a taxonomy schema that is part of the DTS declared in the DTS section.		* required ''concept'', this attribute hold the concept QName this item refers to. The concept must be defined in a taxonomy schema that is part of the DTS declared in the DTS section.
	* optional ''unitRef'', this attribute content must match with the id of one of the units defined in the '''units''' section. The attribute is optional because non numeric concepts does not require units.		* optional ''unitRef'', this attribute content must match with the id of one of the units defined in the '''units''' section. The attribute is optional because non numeric concepts does not require units. If the used does not add this optional attribute in a numeric fact then the driver would be responsible of adding a unit. If the driver does not add a unit then the produced instance document may not be valid
	* optional ''multi'', this attribute defines the behavior of the engine generating the report when the driver returns more than one value for this event and the element is inside a tuple. Possible values are "All", "Single", "Prev" or an integer. ~~(To be documented later)~~.		* optional ''multi'', this attribute defines the behavior of the engine generating the report when the driver returns more than one value for this event and the element is inside a tuple. Possible values are "All", "Single", "Prev" or an integer. See the [[Mapper to driver data exchange dialog\|mapper to driver data exchange dialog]] wiki page for more information.

	~~Sample~~ event ~~declaration~~ in order to obtain data for a tuple.		The following piece of XML code is the declaration of a sample event in order to obtain data for a tuple fact.
	<syntaxhighlight lang="xml">		<syntaxhighlight lang="xml">
	<tuple concept="tx:T">		<tuple concept="tx:T">
			... here goes the tuple specific events; they are other item events or tuple events. Events can be nested in order to represent tuple structures in the instance document ...
			</tuple>
	</syntaxhighlight>		</syntaxhighlight>

	The declaration of events in order to populate content for tuples contains the following attributes:		The declaration of events in order to populate content for tuples contains the following attributes:
	* required ''concept'', this attribute ~~hold~~ the concept QName this tuple refers to. The concept must be defined in a taxonomy schema that is part of the DTS declared in the DTS section.		* required ''concept'', this attribute holds the concept QName this tuple refers to. The concept must be defined in a taxonomy schema that is part of the DTS declared in the DTS section.
	* optional ''mapIdentifier'', this attribute holds the event name and will be used by drivers. Due to the reason that tuple content are items or other tuples, the mapIdentifier here is optional. ~~In this case~~ none of the drivers is informed about the event for generating a tuple ~~and~~ one tuple will be created automatically in order to populate the content ~~of items or any other nested tuple~~.		* optional ''mapIdentifier'', this attribute holds the event name and will be used by drivers. Due to the reason that tuple content are items or other tuples, the mapIdentifier here is optional. If there is no mapIdentifier attribute declared none of the drivers will be informed about the event for generating a tuple, one instantiation of the tuple will be created automatically in order to populate the tuple content.
	* optional ''multi'', this attribute ~~defined~~ the behavior of the engine generating the report when ~~inside the tuple~~ is a nested tuple inside a tuple and there are more than one ~~data item~~ to be ~~mapped into nested items or tuples~~. ~~(To be documented later)~~.		* optional ''multi'', this attribute defines the behavior of the engine generating the report when there is a nested tuple inside a parent tuple and there are more than one fact tuples to be created in the report. See the [[Mapper to driver data exchange dialog\|mapper to driver data exchange dialog]] wiki page for more information.
	* optional ''sourceRef''~~, this attribute is optional~~, if the attribute exist its content must match with the id of the '''source''' to be informed about the event. If the attribute exists, the driver will be responsible of calculating the number of tuples that the final instance document will contain. (See ~~how~~ the ~~SQL~~ driver ~~works~~ for more information ~~(To be documented later))~~.		* optional ''sourceRef'', if the attribute exist its content must match with the id of the '''source''' to be informed about the event. If the attribute exists, the driver will be responsible of calculating the number of fact tuples that the final instance document will contain. See the [[Mapper to driver data exchange dialog\|mapper to driver data exchange dialog]] wiki page for more information.

	An event is declared and named using the ''mapIdentifier'' attribute in either a '''tuple''' or an '''item''' element. The content of that attribute is a string that identifies the event name. Other GUI tools and drivers will use the content of the mapIdentifier attribute in order to match it with the function that obtains values from the data source.		An event is declared and named using the ''mapIdentifier'' attribute in either a '''tuple''' or an '''item''' element. The content of that attribute is a string that identifies the event name. Other GUI tools and drivers will use the content of the mapIdentifier attribute in order to match it with the function that obtains values from the data source.

Ihr: /* Events */

2009-07-01T16:28:54Z

Events

← Older revision		Revision as of 16:28, 1 July 2009
Line 237:		Line 237:
	====Events====		====Events====

	Linking all together; the most important part of the instance template document are the events. Events are defined in order to obtain data from drivers and according to the [[Mapper driver dialog\|mapper to driver dialog]]. The '''facts''' element wraps the content of all events defined in an XBRL Template File.		Linking all together; the most important part of the instance template document are the events. Events are defined in order to obtain data from drivers and according to the [[Mapper to driver data exchange dialog\|mapper to driver data exchange dialog]]. The '''facts''' element wraps the content of all events defined in an XBRL Template File.

	Sample event declaration in order to obtain data for an item. All required information for the event definition is stored in attributes. Part of the information is required and other parts are optional.		Sample event declaration in order to obtain data for an item. All required information for the event definition is stored in attributes. Part of the information is required and other parts are optional.