xBRL-Forge is an open-source software solution designed to streamline the process of creating final XBRL (eXtensible Business Reporting Language) and iXBRL (Inline XBRL) reports by integrating data from multiple software applications. With xBRL-Forge, users can effortlessly generate XBRL taxonomies and compile comprehensive reports using a simple JSON structure for integration.
Combine strengths of different source systems creating reports (but hey, it's also easy to use for very simple use cases):
flowchart TD
s1[[Reporting System A]]
s2[[Reporting System B]]
s1 --> d1
s1 --> d2
s2 --> d3
s2 --> d4
d1[("Part of iXBRL
Report 1 as JSON")]
d2[("Untagged XHTML
Report 2 as JSON")]
d3[("Part of iXBRL
Report 1 as JSON")]
d4[("xBRL Report 3
as JSON")]
d1 --> combined
d2 --> combined
d3 --> combined
d4 --> combined
combined[["`**xBRL-Forge**
create different reports, even from parts;
merge extension taxonomy structures`"]]
combined --> package
package{{Combined xBRL Report Package}}
package --> rp4
package --> rp1
package --> rp2
package --> rp3
rp4(["merged extension
Taxonomy"])
rp1([iXBRL Report 1])
rp2([XHTML Report 2])
rp3([xBRL Report 3])
Tag data imported from other files
flowchart TD
docx[Word File]
docx --> forge
forge[["`**xBRL-Forge**
convert to JSON Structure`"]]
forge --> json1
json1[("**Document Contents in
Target JSON strucutre**
edit (tag) with any Tool and feed back into xBRL-Forge to create xBRL Package")]
-
Multi-Source Integration: Seamlessly gather data from various software solutions and compile them into a unified XBRL or iXBRL report.
-
XBRL Taxonomy Generation: Create customizable XBRL taxonomies to meet your reporting needs.
-
Easy JSON Structure: Integrate data using an intuitive and straightforward JSON format.
-
Open Source: Contribute to the community and enhance the functionality of xBRL-Forge.
-
Data conversion: Prepare your data in a Word file (docx) and then convert it to the xBRL-Forge data structure to enhance it with tags!
-
Supported Data Types:
- Numeric Data (monetary, emissions, etc.)
- formatted string data (boolean, date, etc.)
- untransformable data (enumeration, enumerationSet)
- escaped string data (textBlock, etc.)
There are two ways of using this project.
- Standalone use of this tool: Lern how to run the tool for simple usage (with ui):
- Integration into other tools/workflows: Learn how to convert files and use the engine of this project in differnt ways:
When integrating the tool you will exit the JSON object from other systems. To learn how to Apply Tags to the JSON object please see this:
For detailed documentation on how to use xBRL-Forge, including API references and examples, please refer to the docs folder.
We welcome contributions from the community! To contribute:
- Fork the repository.
- Create a new branch:
git checkout -b <ISSUE_NUMBER>-feature/YourFeature - Make your changes and commit them:
git commit -m 'Add your feature #<ISSUE_NUMBER>' - Push to the branch:
git push origin <ISSUE_NUMBER>-feature/YourFeature - Create a pull request.
PLEASE NOTE: this project uses the REBASE STRATEGY
Please ensure your contributions align with the project guidelines.
This project is licensed under the APACHE 2.0 License - see the LICENSE file for details.
If you encounter any issues or have questions, feel free to open an issue in the GitHub repository or reach out via email.
Also you can join the discussion on Discord.
Thank you for using xBRL-Forge! We look forward to your feedback and contributions!