Relational database data source driver - Revision history

Ihr at 16:50, 20 September 2017

2017-09-20T16:50:38Z

← Older revision		Revision as of 16:50, 20 September 2017
Line 12:		Line 12:

	Sample SQL Driver data source declaration:		Sample SQL Driver data source declaration:
	<~~syntaxhighlight~~ lang="xml">
			<source lang="xml">
	<datasources>		<datasources>
	<source		<source
Line 19:		Line 20:
	config="SQL-driver-config.xml"/>		config="SQL-driver-config.xml"/>
	</datasources>		</datasources>
	</~~syntaxhighlight~~>		</source>

	The configuration file must be valid according to the XML Schema that has the following namespace <nowiki>http://www.reportingstandard.com/source/driver/SQLDriver-2009</nowiki> and that is published in the following official location <nowiki>http://www.reportingstandard.com/schemas/source/XBRLDataSourceSQL-2009.xsd</nowiki>		The configuration file must be valid according to the XML Schema that has the following namespace <nowiki>http://www.reportingstandard.com/source/driver/SQLDriver-2009</nowiki> and that is published in the following official location <nowiki>http://www.reportingstandard.com/schemas/source/XBRLDataSourceSQL-2009.xsd</nowiki>

	Sample configuration file:		Sample configuration file:
	<~~syntaxhighlight~~ lang="xml">		<source lang="xml">
	~~<?xml version="1.0" encoding="UTF-8"?~~>
	<!-- Sample configuration file for SQLDataSource content -->		<!-- Sample configuration file for SQLDataSource content -->
	<XBRLDataSourceSQL xmlns="http://www.reportingstandard.com/source/driver/SQLDriver-2009" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.reportingstandard.com/source/driver/SQLDriver-2009 http://www.reportingstandard.com/schemas/source/XBRLDataSourceSQL-2009.xsd">		<XBRLDataSourceSQL xmlns="http://www.reportingstandard.com/source/driver/SQLDriver-2009" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.reportingstandard.com/source/driver/SQLDriver-2009 http://www.reportingstandard.com/schemas/source/XBRLDataSourceSQL-2009.xsd">
Line 70:		Line 70:
	</data>		</data>
	</XBRLDataSourceSQL>		</XBRLDataSourceSQL>
	</~~syntaxhighlight~~>		</source>

	Each '''data''' element above defines a select statement to the database in order to retrieve information that may be relevant to create an XBRL report. Each '''data''' element has a '''connRef''' attribute that identify the database connection parameters.		Each '''data''' element above defines a select statement to the database in order to retrieve information that may be relevant to create an XBRL report. Each '''data''' element has a '''connRef''' attribute that identify the database connection parameters.
Line 91:		Line 91:
	From the API, it is possible to send parameters to the SQL statements using a Properties object as a parameter to the map method. The following code adds a parameter that is later replaced in the SQL statements:		From the API, it is possible to send parameters to the SQL statements using a Properties object as a parameter to the map method. The following code adds a parameter that is later replaced in the SQL statements:

	<~~syntaxhighlight~~ lang="java">		<source lang="java">
	// uConfig is the URI of the configuration file		// uConfig is the URI of the configuration file
	MapEngine me = new MapEngine(uConfig);		MapEngine me = new MapEngine(uConfig);
Line 101:		Line 101:
	// Generamos el informe XBRL		// Generamos el informe XBRL
	XBRLInstance instance = me.map(parameters);		XBRLInstance instance = me.map(parameters);
	</~~syntaxhighlight~~>		</source>

	The text '''${SELECTED_RECORD}''' will be replaced by the value of the '''idSelectedRecord''' variable.		The text '''${SELECTED_RECORD}''' will be replaced by the value of the '''idSelectedRecord''' variable.

	<~~syntaxhighlight~~ lang="xml">		<source lang="xml">
	<data connRef="con0">		<data connRef="con0">
	<decimals>INF</decimals>		<decimals>INF</decimals>
Line 112:		Line 112:
	<where>fiscalCode = ${SELECTED_RECORD}</where>		<where>fiscalCode = ${SELECTED_RECORD}</where>
	</data>		</data>
	</~~syntaxhighlight~~>		</source>

	===When the statement is executed===		===When the statement is executed===

Ihr at 09:33, 16 November 2010

2010-11-16T09:33:44Z

@@ Line 55: / Line 55: @@
 	<where>fiscalCode = '12345'</where>
    </data>
 </XBRLDataSourceSQL>
 </syntaxhighlight>
-Each '''data''' element above defined a select statement to the database in order to retrieve information that may be relevant to create an XBRL report. Each '''data''' element has a '''connRef''' attribute that identify the database connection parameters.
+Each '''data''' element above defines a select statement to the database in order to retrieve information that may be relevant to create an XBRL report. Each '''data''' element has a '''connRef''' attribute that identify the database connection parameters.
 The content of a '''data''' element is first either a '''decimals''' or a '''precision''' element that will be relevant for all numeric fields obtained by this select statement.
@@ Line 64: / Line 78: @@
 The next element is a '''table''' element that contains the SQL table o view name used to build the select statement.
-Following the '''table''' element is a sequence of one or unlimited number of '''field''' elements. A field element maps a table field with a generation identifier name. The field name is indicated in the '''name''' attribute and the event generation identifier name is indicated in the '''identifier''' attribute.
+After the '''table''' element there may be a '''statement''' element (this is optional) if present, the content of the statement element will replace the select statement that the driver creates for you automatically using the table name and selected fields.
 Optionally, there may exist one '''where''' element that contains the text of a where clause that will be added to the end of the select statement.
 ===When the statement is executed===

Ihr: /* When the statement is executed */

2009-10-21T15:06:37Z

When the statement is executed

← Older revision		Revision as of 15:06, 21 October 2009
Line 70:		Line 70:
	===When the statement is executed===		===When the statement is executed===

	In the [[Mapper to driver data exchange dialog]], during the 2<sup>nd</sup> question, the mapper asks the driver about how may fact items for a specific ~~identifier~~ are in the data source. At this time, if the query has not been executed before, it is executed now (and the result is cached during the live of the execution of the XBRL report).		In the [[Mapper to driver data exchange dialog]], during the 2<sup>nd</sup> question, the mapper asks the driver about how may fact items for a specific mapping event are in the data source (using the identifier as the key). At this time, if the query has not been executed before, it is executed now (and the result is cached during the live of the execution of the XBRL report).

	==Navigation==		==Navigation==
	[[Main Page]] \| [[XBRLmapper]]		[[Main Page]] \| [[XBRLmapper]]

Ihr: /* When the statement will be executed */

2009-10-21T15:04:46Z

When the statement will be executed

← Older revision		Revision as of 15:04, 21 October 2009
Line 68:		Line 68:
	Optionally, there may exist one '''where''' element that contains the text of a where clause that will be added to the end of the select statement.		Optionally, there may exist one '''where''' element that contains the text of a where clause that will be added to the end of the select statement.

	===When the statement ~~will be~~ executed===		===When the statement is executed===

	In the [[Mapper to driver data exchange dialog]], during the 2<sup>nd</sup> question, the mapper asks the driver about how may fact items for a specific identifier are in the data source. At this time, if the query has not been executed before, it is executed now (and the result is cached during the live of the execution of the XBRL report).		In the [[Mapper to driver data exchange dialog]], during the 2<sup>nd</sup> question, the mapper asks the driver about how may fact items for a specific identifier are in the data source. At this time, if the query has not been executed before, it is executed now (and the result is cached during the live of the execution of the XBRL report).

Ihr: /* Configuration file */

2009-10-21T15:04:27Z

Configuration file

← Older revision		Revision as of 15:04, 21 October 2009
Line 67:		Line 67:

	Optionally, there may exist one '''where''' element that contains the text of a where clause that will be added to the end of the select statement.		Optionally, there may exist one '''where''' element that contains the text of a where clause that will be added to the end of the select statement.

			===When the statement will be executed===

			In the [[Mapper to driver data exchange dialog]], during the 2<sup>nd</sup> question, the mapper asks the driver about how may fact items for a specific identifier are in the data source. At this time, if the query has not been executed before, it is executed now (and the result is cached during the live of the execution of the XBRL report).

	==Navigation==		==Navigation==
	[[Main Page]] \| [[XBRLmapper]]		[[Main Page]] \| [[XBRLmapper]]

Ihr: Created page with '==Description== The Relational Database Source Driver is a configurable generic driver to obtain data from relational databases (tables) and create XBRL reports inside the autom…'

2009-10-21T12:51:52Z

Created page with '==Description== The Relational Database Source Driver is a configurable generic driver to obtain data from relational databases (tables) and create XBRL reports inside the autom…'

New page

==Description==

The Relational Database Source Driver is a configurable generic driver to obtain data from relational databases (tables) and create XBRL reports inside the automatization framework provided by the XBRL Mapper engine designed by Reporting Standard.

==Editors==

There are currently no specific editors designed for the Relational Database Source Driver configuration files. They are XML files than can be created using standard XML editors.

==Configuration file==

The configuration file is provided during the driver declaration inside the instance document template file. See [[XBRL Template File#Definition_of_data_sources]] for more information. The driver class is '''com.ihr.xbrl.mapper.source.SQLDataSource'''

Sample SQL Driver data source declaration:
<syntaxhighlight lang="xml">
<datasources>
<source
id="source0"
class="com.ihr.xbrl.mapper.source.SQLDataSource"
config="SQL-driver-config.xml"/>
</datasources>
</syntaxhighlight>

The configuration file must be valid according to the XML Schema that has the following namespace <nowiki>http://www.reportingstandard.com/source/driver/SQLDriver-2009</nowiki> and that is published in the following official location <nowiki>http://www.reportingstandard.com/schemas/source/XBRLDataSourceSQL-2009.xsd</nowiki>

Sample configuration file:
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>

<XBRLDataSourceSQL xmlns="http://www.reportingstandard.com/source/driver/SQLDriver-2009" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.reportingstandard.com/source/driver/SQLDriver-2009 http://www.reportingstandard.com/schemas/source/XBRLDataSourceSQL-2009.xsd">
<connection id="con0">
<url>jdbc:mysql://localhost:3306/testdb</url>
<user>root</user>
<password>xbrl</password>
</connection>
<data connRef="con0">
<precision>INF</precision>
<table>GovernmentGrantsDisclosuresMasterTuple</table>
<field identifier="ifrs-gp_GovernmentGrantsDisclosures" name="GovernmentGrantsDisclosures" />
<field identifier="ifrs-gp_DetailOfGovernmentGrants" name="DetailOfGovernmentGrants" />
<field identifier="ifrs-gp_AmountOfGovernmentGrantsNettedAgainstReportedExpenses" name="AmountOfGovernmentGrantsNettedAgainstReportedExpenses" />
<where>fiscalCode = '12345'</where>
</data>
<data connRef="con0">
<decimals>0</decimals>
<table>GovernmentGrantsDisclosuresDetailsTuple</table>
<field identifier="ifrs-gp_DescriptionOfGovernmentGrant" name="DescriptionOfGovernmentGrant"/>
<field identifier="ifrs-gp_AmountOfGovernmentGrantRecognised" name="AmountOfGovernmentGrantRecognised"/>
<field identifier="ifrs-gp_ExplanationOfUnfulfilledConditionsAndOtherContingenciesAttachingToGovernmentAssistance" name="ExplanationOfUnfulfilledConditions"/>
<where>fiscalCode = '12345'</where>
</data>
<data connRef="con0">
<decimals>INF</decimals>
<table>GovernmentGrantsDisclosuresAmounts</table>
<field identifier="GovermentGrantTuple" name="rut"/>
<where>fiscalCode = '12345'</where>
</data>
</XBRLDataSourceSQL>
</syntaxhighlight>

Each '''data''' element above defined a select statement to the database in order to retrieve information that may be relevant to create an XBRL report. Each '''data''' element has a '''connRef''' attribute that identify the database connection parameters.

The content of a '''data''' element is first either a '''decimals''' or a '''precision''' element that will be relevant for all numeric fields obtained by this select statement.

The next element is a '''table''' element that contains the SQL table o view name used to build the select statement.

Following the '''table''' element is a sequence of one or unlimited number of '''field''' elements. A field element maps a table field with a generation identifier name. The field name is indicated in the '''name''' attribute and the event generation identifier name is indicated in the '''identifier''' attribute.

Optionally, there may exist one '''where''' element that contains the text of a where clause that will be added to the end of the select statement.

==Navigation==
[[Main Page]] | [[XBRLmapper]]