XBRL API related discussions - Revision history

Agil at 11:58, 28 January 2019

2019-01-28T11:58:59Z

← Older revision		Revision as of 11:58, 28 January 2019
Line 111:		Line 111:
	=== Related documentation===		=== Related documentation===

	[[http://www.xbrl.org/Specification/Infoset/PWD-2009-02-04/infoset-PWD-2009-02-04.html The XBRL Infoset Specification document]] Created by Reporting Standard S.L.		[[http://www.xbrl.org/Specification/Infoset/PWD-2009-02-04/infoset-PWD-2009-02-04.html The XBRL Infoset Specification document]] - Created by Reporting Standard S.L.

Agil at 14:20, 8 January 2019

2019-01-08T14:20:12Z

← Older revision		Revision as of 14:20, 8 January 2019
Line 3:		Line 3:
	===Product page===		===Product page===

	[~~[http~~://www.reportingstandard.com/~~XBRL_API.xhtml~~ XBRL API product page]]		[https://www.reportingstandard.com/xbrl-2-1-integration-api/?lang=en XBRL API product page]

	===Descripcion===		===Descripcion===
Line 23:		Line 23:
	The Java version requires Java 1.6 installed and 4Gb of RAM are recommended 2Gb of RAM minimun. A single CPU processor of 1.4 Ghz is minimun but, in order to be able to handle large taxonomies a dual CPU at GHz or more is recommended.		The Java version requires Java 1.6 installed and 4Gb of RAM are recommended 2Gb of RAM minimun. A single CPU processor of 1.4 Ghz is minimun but, in order to be able to handle large taxonomies a dual CPU at GHz or more is recommended.

	# Download the latest version of Reporting Standard tools from the [~~http~~://www.reportingstandard.com/downloads~~.xhtml~~ downloads page]		# Download the latest version of Reporting Standard tools from the [https://www.reportingstandard.com/downloads/?lang=en downloads page]
	# Install the tools on your computer		# Install the tools on your computer
	# Install the license files in the lib folder as indicated in the documentation		# Install the license files in the lib folder as indicated in the documentation
Line 35:		Line 35:
	====.NET====		====.NET====

	# Download the latest version of Reporting Standard tools from the [~~http~~://www.reportingstandard.com/downloads~~.xhtml~~ downloads page]		# Download the latest version of Reporting Standard tools from the [https://www.reportingstandard.com/downloads/?lang=en downloads page]
	# Install the tools on your computer		# Install the tools on your computer
	# Install the license files in the lib folder as indicated in the documentation		# Install the license files in the lib folder as indicated in the documentation
Line 63:		Line 63:
	Note: the next directory after the directory pointed to by this variables must have a fixed name '''ReportingStandardXBRLTools'''.		Note: the next directory after the directory pointed to by this variables must have a fixed name '''ReportingStandardXBRLTools'''.

	There is more information about how the API obtains the path for a user file on the [~~http~~://www.reportingstandard.com/apidoc/com/ihr/xbrl/util/RSStaticAndUser.html RSStaticAndUser java class documentation]		There is more information about how the API obtains the path for a user file on the [https://www.reportingstandard.com/apidoc/com/ihr/xbrl/util/RSStaticAndUser.html RSStaticAndUser java class documentation]

	===Objects overview===		===Objects overview===

	The starting point for almost anything you want to do with Reporting Standard API requires the creation of a DTSContainer object. See the [~~[http~~://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html DTSContainer javadoc page]] this object will be used for loading a DTS or for creating a new DTS from scratch, performing XBRL validation, etc.		The starting point for almost anything you want to do with Reporting Standard API requires the creation of a DTSContainer object. See the [https://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html DTSContainer javadoc page] this object will be used for loading a DTS or for creating a new DTS from scratch, performing XBRL validation, etc.

	* [[DTSContainer]] wiki page		* [[DTSContainer]] wiki page
Line 112:		Line 112:

	[[http://www.xbrl.org/Specification/Infoset/PWD-2009-02-04/infoset-PWD-2009-02-04.html The XBRL Infoset Specification document]] Created by Reporting Standard S.L.		[[http://www.xbrl.org/Specification/Infoset/PWD-2009-02-04/infoset-PWD-2009-02-04.html The XBRL Infoset Specification document]] Created by Reporting Standard S.L.

	~~==Navigation==~~
	~~[[Main Page]]~~

Ihr: /* Objects overview */

2016-08-12T08:32:55Z

Objects overview

← Older revision		Revision as of 08:32, 12 August 2016
Line 98:		Line 98:

	* Getting available languages [[LangsProvider]]		* Getting available languages [[LangsProvider]]

			Extending the validation engine

			* [[The basis of all validation engines]]

			* [[XBRLPlugInProcessor]] wiki page

			* [[XBRLProcessorFactory]] interface wiki page

			* [[XBRLProcessorFactoryBase]] abstract class that implements the [[XBRLProcessorFactory]] interface

	=== Related documentation===		=== Related documentation===

Ihr: /* Environment Variables and Java Variables */

2012-07-05T10:43:34Z

Environment Variables and Java Variables

← Older revision		Revision as of 10:43, 5 July 2012
Line 63:		Line 63:
	Note: the next directory after the directory pointed to by this variables must have a fixed name '''ReportingStandardXBRLTools'''.		Note: the next directory after the directory pointed to by this variables must have a fixed name '''ReportingStandardXBRLTools'''.

	There is more information about how the API obtains the path for a user file on the		There is more information about how the API obtains the path for a user file on the [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/util/RSStaticAndUser.html RSStaticAndUser java class documentation]

	===Objects overview===		===Objects overview===

Ihr: /* Environment Variables */

2012-07-05T10:42:17Z

Environment Variables

← Older revision		Revision as of 10:42, 5 July 2012
Line 49:		Line 49:
	The API is organized in logical layers. The lowest layer is considered the syntactical layer of the XML files that are the source of the information. One intermediate layer is the object model that represents the DTS content after resolving relationship prohibitions. A higher layer on top of the previous layer is the output of the XBRL validation rules that operated with the input of the previous later. Each one of the layers are able to detect XBRL errors or errors related to the specific layer, for example, the XML parser will detect and raise errors found on the syntax of the XML files. The XML Schema validation layer will raise XML Schema errors and so on. Information can flow between the layers, for example when you load a DTS from files, the information flows from bottom to top, but when you create an XBRL report programatically and later you call de <tt>save</tt> method, the information flows from top bottom layers.		The API is organized in logical layers. The lowest layer is considered the syntactical layer of the XML files that are the source of the information. One intermediate layer is the object model that represents the DTS content after resolving relationship prohibitions. A higher layer on top of the previous layer is the output of the XBRL validation rules that operated with the input of the previous later. Each one of the layers are able to detect XBRL errors or errors related to the specific layer, for example, the XML parser will detect and raise errors found on the syntax of the XML files. The XML Schema validation layer will raise XML Schema errors and so on. Information can flow between the layers, for example when you load a DTS from files, the information flows from bottom to top, but when you create an XBRL report programatically and later you call de <tt>save</tt> method, the information flows from top bottom layers.

	===Environment Variables===		===Environment Variables and Java Variables ===

	Reporting Standard XBRL API can be configured using environment variables in order to set the location of common components. The following environment variables are recognized by the XBRL API:		Reporting Standard XBRL API can be configured using environment variables and Java Variables in order to set the location of common components such as the license file and taxonomy catalog files. The following environment variables and java variables are recognized by the XBRL API:

	* '''XBRLCATALOGPATH''' This environment variable points to a ; separated list of directories where files with the name '''XBRLCatalog.xml''' exist. Those files must be according to the OASIS XML Catalog syntax convention. For this reason, it is recommended (but not required) that they reference the Catalog.xsd schema. The variable has effect in Windows and Unix, Java and .NET environments. The Windows installer already sets the environment variable and the right value pointing to the directory where the installer has installed the Taxonomy Catalog.		* '''XBRLCATALOGPATH''' This environment variable points to a ; separated list of directories where files with the name '''XBRLCatalog.xml''' exist. Those files must be according to the OASIS XML Catalog syntax convention. For this reason, it is recommended (but not required) that they reference the Catalog.xsd schema. The variable has effect in Windows and Unix, Java and .NET environments. The Windows installer already sets the environment variable and the right value pointing to the directory where the installer has installed the Taxonomy Catalog.

	* '''XBRLRSHOME''' This environment variable points to a directory that will be used as the home directory where Reporting Standard applications store user properties that are used to share information across multiple applications (like the information to connect to the XBRL Repository). The Windows installer does not set this environment variable and the API defaults to the user's home directory. The value is used in Windows and Unix, Java and .NET environments.		* '''XBRLRSHOME''' This environment variable points to a directory that will be used as the home directory where Reporting Standard applications store user properties that are used to share information across multiple applications (like the information to connect to the XBRL Repository). The Windows installer does not set this environment variable and the API defaults to the user's home directory. The value is used in Windows and Unix, Java and .NET environments.

			* '''xbrl.rs.home''' If this java system property exist, it shall point to a directory that will be used instead of the '''XBRLRSHOME''' enviroment variable.

	* '''XBRLLIBRARYPATH''' This environment variable points to the directory where Reporting Standard libraries are installed on the system.		* '''XBRLLIBRARYPATH''' This environment variable points to the directory where Reporting Standard libraries are installed on the system.

			Note: the next directory after the directory pointed to by this variables must have a fixed name '''ReportingStandardXBRLTools'''.

			There is more information about how the API obtains the path for a user file on the

	===Objects overview===		===Objects overview===

Ihr: /* Objects overview */

2012-07-05T10:16:07Z

Objects overview

← Older revision		Revision as of 10:16, 5 July 2012
Line 80:		Line 80:

	* XBRL Formulas processor [[XBRLFormulaProcessor]]		* XBRL Formulas processor [[XBRLFormulaProcessor]]

			* XBRL UTR (Universal Type Registry) processor [[XBRLUTR]]

			* XBRL Edgar (US SEC Validator) [[EDGAR Validator]]

	* Traversing networks of relationships [[DTSExplorer]]		* Traversing networks of relationships [[DTSExplorer]]

Ihr: /* Descripcion */

2011-05-11T17:35:00Z

Descripcion

← Older revision		Revision as of 17:35, 11 May 2011
Line 13:		Line 13:
	All Tools from Reporting Standard have been build using Reporting Standard XBRL API.		All Tools from Reporting Standard have been build using Reporting Standard XBRL API.

	The API provides access to several components from other libraries like XML Schema aware XPath processing from Saxonica XML processor or Storage capabilities in relational databases.		The API provides access to several components from other libraries like XML Schema aware XPath processing from Saxonica XML processor (License included in Reporting Standard license) or Storage capabilities in relational databases.

	===Quick start guide===		===Quick start guide===

Ihr: /* Environment Variables */

2011-05-11T17:34:06Z

Environment Variables

← Older revision		Revision as of 17:34, 11 May 2011
Line 57:		Line 57:
	* '''XBRLRSHOME''' This environment variable points to a directory that will be used as the home directory where Reporting Standard applications store user properties that are used to share information across multiple applications (like the information to connect to the XBRL Repository). The Windows installer does not set this environment variable and the API defaults to the user's home directory. The value is used in Windows and Unix, Java and .NET environments.		* '''XBRLRSHOME''' This environment variable points to a directory that will be used as the home directory where Reporting Standard applications store user properties that are used to share information across multiple applications (like the information to connect to the XBRL Repository). The Windows installer does not set this environment variable and the API defaults to the user's home directory. The value is used in Windows and Unix, Java and .NET environments.

	* '''XBRLLIBRARYPATH''' This environment variable points to the directory where Reporting Standard libraries are installed on the system~~. This environment variable is used by the .NET platform only in order to let the library find the saxonica license file~~.		* '''XBRLLIBRARYPATH''' This environment variable points to the directory where Reporting Standard libraries are installed on the system.

	===Objects overview===		===Objects overview===

Ihr: /* .NET */

2011-04-06T13:13:45Z

.NET

← Older revision		Revision as of 13:13, 6 April 2011
Line 41:		Line 41:
	# Read the section about the environment variables and set them according to your settings. Note there is no Classpath in .NET so the XBRLLIBRARYPATH environment variable is of high importance in .NET environments.		# Read the section about the environment variables and set them according to your settings. Note there is no Classpath in .NET so the XBRLLIBRARYPATH environment variable is of high importance in .NET environments.
	# Create a new project in, for example, Visual Basic .NET		# Create a new project in, for example, Visual Basic .NET
	# add references to the following DLL files: '''xbrljlib-2.0.dll''', '''IKVM.OpenJDK.~~ClassLibrary~~.dll''', '''IKVM.AWT.WinForms.dll''' and '''IKVM.Runtime.dll'''		# add references to the following DLL files: '''xbrljlib-2.0.dll''', '''IKVM.OpenJDK.Core.dll''', '''IKVM.OpenJDK.Util.dll''', '''IKVM.OpenJDK.XML.API.dll''', '''IKVM.OpenJDK.XML:Parse.dll''', '''IKVM.AWT.WinForms.dll''' and '''IKVM.Runtime.dll'''
			# Please note, other DLLs may be required depending on the application you are using. All of them are in the same directory.
	# Start coding		# Start coding

Ihr: /* Objects overview */

2011-03-04T13:05:00Z

Objects overview

← Older revision		Revision as of 13:05, 4 March 2011
Line 75:		Line 75:

	* XBRL 2.1 validation [[XBRLCoreProcessor]]		* XBRL 2.1 validation [[XBRLCoreProcessor]]

			* XBRL Dimensions processor [[XDTProcessor]]

			* XBRL Formulas processor [[XBRLFormulaProcessor]]

	* Traversing networks of relationships [[DTSExplorer]]		* Traversing networks of relationships [[DTSExplorer]]