Setting environment variables - Revision history

Ihr at 15:04, 28 November 2015

2015-11-28T15:04:24Z

← Older revision		Revision as of 15:04, 28 November 2015
Line 7:		Line 7:

	In sort, if you have no changed anything.		In sort, if you have no changed anything.
	* On '''windows''' that directory is the content of the APPDATA environment variable, and the "ReportingStandardXBRLTools". Normally this is C:\Users\{Your user name}\AppData\Roaming\ReportingStandardXBRLTools". Note that AppData is a hidden folder.		* On '''windows''' that directory is the content of the APPDATA environment variable, and the '''ReportingStandardXBRLTools'''. Normally this is C:\Users\{Your user name}\AppData\Roaming\ReportingStandardXBRLTools". Note that AppData is a hidden folder.
	* On '''UNIX''' (Linux, Mac and other *Ix derived OS) it is the user's home directory followed by "ReportingStandardXBRLTools".		* On '''UNIX''' (Linux, Mac and other *Ix derived OS) it is the user's home directory followed by '''ReportingStandardXBRLTools'''.

	You can modify the installation configuration by setting the following 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:		You can modify the installation configuration by setting the following 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:

Ihr at 12:31, 28 November 2015

2015-11-28T12:31:49Z

← Older revision		Revision as of 12:31, 28 November 2015
Line 12:		Line 12:
	You can modify the installation configuration by setting the following 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:		You can modify the installation configuration by setting the following 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 that can be HOME of [[Taxonomy Catalogs]]. 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.

Ihr at 12:28, 28 November 2015

2015-11-28T12:28:53Z

← Older revision		Revision as of 12:28, 28 November 2015
Line 1:		Line 1:
	~~==Environment Variables~~ and ~~Java Variables ==~~		In a normal installation, the XBRL API requires a directory with read/write permissions to the user who launches the tools. That directory is used later for the following purposes:
			# A place to search for the license file
			# A place to read taxonomies in the different supported taxonomy catalogs
			# A place to store application properties and user configuration files

	~~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:		The specific mechanism to obtain the value of that directory is documented here: [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/util/RSStaticAndUser.html RSStaticAndUser java class documentation]

			In sort, if you have no changed anything.
			* On '''windows''' that directory is the content of the APPDATA environment variable, and the "ReportingStandardXBRLTools". Normally this is C:\Users\{Your user name}\AppData\Roaming\ReportingStandardXBRLTools". Note that AppData is a hidden folder.
			* On '''UNIX''' (Linux, Mac and other *Ix derived OS) it is the user's home directory followed by "ReportingStandardXBRLTools".

			You can modify the installation configuration by setting the following 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.

Ihr at 12:18, 28 November 2015

2015-11-28T12:18:19Z

← Older revision		Revision as of 12:18, 28 November 2015
Line 1:		Line 1:
	=Environment Variables and Java Variables =		==Environment Variables and Java Variables ==

	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:		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:

Ihr: Created page with '=Environment Variables and Java Variables = Reporting Standard XBRL API can be configured using environment variables and Java Variables in order to set the location of common c…'

2015-11-28T12:18:00Z

Created page with '=Environment Variables and Java Variables = Reporting Standard XBRL API can be configured using environment variables and Java Variables in order to set the location of common c…'

New page

=Environment Variables and Java Variables =

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.

* '''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.

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]