Render Inline XBRL (iXBRL) with CellStore, Part 1: Introduction
Estimated reading time: 1 minuteThis page is a placeholder, its contents are being worked on.
- 1: iXBRL Rendering Introduction
- 2: Prepare iXBRL Template
- 3: Query Facts For iXBRL Rendering
- 4: Tweaking the iXBRL Rendering
Prerequisites
Before going through this tutorial you should have CellStore up and running:
How does the Rendering of iXBRL Work with CellStore
For rendering iXBRL with CellStore three things are necessary:
- an iXBRL template file (to be sent to endpoint
/cellstore/v1/facts/render/ixbrlfor rendering) - a bag of facts (stored in and queried from CellStore)
- the endpoint
/cellstore/v1/facts/render/ixbrl(available from CellStore v0.9.8)
CellStore will combine these ingredients to create a valid iXBRL file (or files) according to the Inline XBRL 1.1 Specification.
In the following sections we will explain each ingredient.
Accessing the Endpoint
In order to access the endpoint common Rest API interface libraries can be used by software. Such libraries are commonly available in all major programming languages. Alternatively, CellStore provides a .NET client library for convenience (please, contact us for further information).
For testing purposes, we recommend either commandline tools like curl or Rest API development tools, for example:
Prefixes and Namespaces
The only prefix and namespace defined by the iXBRL templating mechanism is:
| Prefix | Namespace |
|---|---|
ixtp |
http://reportix.com/2021-07-21/ixbrl/template |
This namespace might change in future releases of the iXBRL templating mechanism.
The prefix ixtp is used in the examples of this documentation and is recommended to be used in template files.
However, the prefix can be renamed into any other prefix if necessary.