UBmatrix Processing Engine
Date: v2.500 Jan 2007
Author: UBmatrix Inc
This document covers the following sections:
About This Document
UBmatrix Processing Engine
Building the software
In this Open Source release
Configuration and Recommendations
About This Document
The release notes below detail the products system requirements, recommended
practices, and known issues.
UBmatrix Processing Engine
Hosted on Sourceforge.net with the project name: UBmatrix XBRL Processing Engine
Processing Engine is a software development kit (SDK) for building applications that
consume, generate and validate XBRL documents. It is designed for high volume, large
scale business processes that require XBRL data validation and data conversion for
use in new and existing applications. A processing engine is the essential component
of any application that plans to read, write, and validate XBRL. Much like a database
engine that uses SQL to read and write data to a set of relational tables (or schema),
the processing engine reads and writes XBRL based upon the schema, dimensions, and
business rules defined in an XBRL taxonomy. What is more, with its standards-based
XSLT support, the UBmatrix Processing Engine can render XBRL data into a variety
of formats readable by both computers and people.
For more information regarding UBmatrix visit http://www.ubmatrix.com.
For other XBRL documentation and samples go to xBReeze Open Source Edition:
For online documentation: http://demo.ubmatrix.com/webhelp/XPE/2_5/OS/index.htm
The following operating systems are supported in this open source release:
Microsoft Windows Server System 2003
Microsoft Windows XP Home or Professional Edition with Service Pack 2
Microsoft Windows 2000 Professional, Server Edition with Service Pack 3 or later.
Ubuntu Linux 5.10
RedHat Linux Enterprise Linux 4.
Suse 10 Linux.
Recommended RAM: Minimum of 512 MB RAM
Runtime requirements: Sun Java 1.4.2 Java Runtime Environment (JRE)
Sun Java 1.4.2 Software Development Kit (SDK)
Third Party Software
The following third-party software has been distributed with this product and each
is subject to its own software license.
Sun Java 1.4.2: http://java.com/en/download/help/5000010500.xml
Saxonica Xpath: http://www.saxonica.com/documentation/documentation.html
XML Apache: http://xml.apache.org/xalan-j
Xerces API: http://xerces.apache.org
There are source (SRC) and compiled source (BIN) distriubtions available for download.
Select download files from sourceforge.net > extract the compressed files from (.zip).
The compiled source is contained within: ubmatrix\lib
The source code is lcoated in: ubmatrix\src\ubmatrix\xbrl
Building the software
We recommend downloading and installing the Eclipse IDE: http://www.eclipse.org/downloads
Launch Eclipse > Go to File > Import/Export.
Select Existing Projects into Workspace > Next.
Select the Eclipse .project file at the root folder > Next
Select the XPE SDK project Finish
In Eclipse select Project > Build All
In this open source release
XPE_SDK_2.5.xxxx.xxxx_documentation.zip - Product Documentation
XPE_SDK_2.5.xxxx.xxxx_linux_BIN.zip - Compiled source for Linux distribution
XPE_SDK_2.5.xxxx.xxxx_inux_SRC.zip - Source code for Linux distribution
XPE_SDK_2.5.xxxx.xxxx_Win32_BIN.zip - Compiled source code for Windows distribution
XPE_SDK_2.5.xxxx.xxxx_Win32_SRC.zip - Uncomplied source code for Windows distribution
Load XBRL 2.1 documents
Generate XBRL 2.1 documents
Validate XBRL 2.1 documents
FRTA 1.0 validation XBRL documents
XBRL Dimensions 1.0 validation of XBRL documents
XBRL Editing - can create and edit XBRL documents using the API.
Users of Processing Engine can download XBRL documents from the Internet to a local
cache of documents to increase loading speeds.
Some versions of common XBRL documents are already downloaded and configured
(in "resources\System\XbrlConfiguration.xml") and therefore load faster than other
documents that are directly loaded via the internet.
Generate an XBRL "summation-item" Calculation Trace
Processing Engine can trace the XBRL "summation-item" calculations that occur when
validating an XBRL instance document that references a calculation linkbase that
specifies calculations. This is a way for Processing Engine to inform the user of
the results of calculation roll-ups when applying calculation rules against data
expressed in an instance document.
Generate a Dimension Aggregation "aggregator-contributor" Calculation Trace
Processing Engine can process and render a trace the dimensional "aggregator-contributer"
calculations that occur when validating an XBRL instance document that references
a calculation linkbase that specifies dimensional aggregational calculations.
Extensible Stylesheet Language Transformations (XSLT)
Processing Engine leverages XSLT to transform XBRL instance and taxonomy documents
into a desired format such as .pdfs, xml, .doc, or text files.
Sample XBRL application:
The following is a sample XBRL applciation that is supplied with this release that allows you to load, validate, transform, and create calcualtion traces.
lib\xpe-ui.sh (for Linux)
lib\xpe-ui.cmd (for Windows)
Command Line Tools:
Refer to the available documentation "doc\web\index.htm" on how to use the following utilities:
This command line tool allows the user to load and validates XBRL documents.
XbrlProcessor.cmd (for Windows)
xbrlprocessor.sh (for Linux / Unix)
This command line tool allows the user to load and transform XBRL documents.
XbrlTransform.cmd (for Windows)
xbrlTransform.sh (for Linux / Unix)
UBmatrix Processing Engine documentation
To view the product documentation, download and extract "XPE_SDK_2.5.xxxx.xxxx_documentation.zip"
from sourceforge.net go to "doc\api\index.html" or "doc\web\index.htm".
XBRL specification documentation
For up to date specifications we recommend that you go to http://www.xbrl.org.
XBRL 2.1 Sample Documents
The following XBRL sample documents are included in this release, for up-to-date
files go to http://www.xbrl.org.
XbrlFiles\acme - XBRL sample documents
XbrlFiles\Dimensions - various XBRL dimensional documents
For other XBRL documentation and samples go to xBReeze Open Source Edition:
The following code samples are included in this release:
Load (samples\load): This example demonstrates how the API can be used to load documents.
Validation (samples\validation): This example demonstrates how the API can be used to validate documents.
Editing (samples\editing): This example demonstrates how the API can be used to edit documents.
Transformation (sample\XbrlTransform): This sample demonstrates loading and transforming XBRL documents using the API.
XBRL Dimensions (samples\dimension): This example loads and validates a XBRL Dimensional documents.
Processing Engine is fully compliant with the XBRL 2.1, Dimensions 1.0, and Financial Reporting Taxonomies Architecture (FRTA) 1.0 specifications.
Published specifications can be found at http://www.xbrl.org/SpecRecommendations.
"Errors" are items in a document that violate rules with MUSTs and MUST NOT. These rules must be adhered to in order to comply with the XBRL 2.1 specification and FRTA 1.0 specification.
Warnings are items in a document that violate rules with SHOULD and SHOULD NOT. Compliance with these rules is dependent on the author and the XBRL.org compliance process and should be treated as a best practice.
Using the sample GUI application or command line tools supplied with this release you can validate your XBRL documents and determine if they are considered valid or invalid (and if invalid determine which section that your document does not adhere to the standards.)
We recommend setting the Java virtual memory (JVM) heap size to 512 MB to prevent the JVM from reporting an out of memory error.
512 MB does not represent the residual memory required to keep the document in memory.
Rather it represents spikes in memory growth during loading of large documents require the JVM to allocate larger heap size above the default.
This version of Processing Engine is compliant with the published XBRL 2.1, Dimensions 1.0, FRTA 1.0 specifications as of June 2006; since then there have
been erratums to these specifications, these changes will be accounted for in a future release.
Do not advise extracting UBmatrix XBRL Processing Engine to a directory with extended characters such as "É".
Loading large, remote files over HTTP can be slow depending on the speed of your Internet connection and the size of the files.
Caching these files can improve your loading speed, find out more in "doc\web\index.htm" on how to configure caching (redirection) using the xbrlconfiguration.xml file.
Loading documents with circular references fails on some DTS's. The scenarios that fail are rarely encountered in real XBRL documents. For example, XBRL linkbase conformance test case 206.06, where the two schemas reference two linkbases, both of which refer back to both of the original schemas.
The XBRL Processing Engine is not able to open linkbases directly at this time and attempting to do so will generate a warning. Note: The Processing Engine does support this method of discovery via the API interface.
Processing Engine might not properly resolve file paths when the values in a SchemaLocationResolution element in the XbrlConfiguration.xml conflict with a file that the user is trying to load. For example, the default XbrlConfiguration.xml points to a local cache of the US GAAP taxonomy. Typically, opening an instance that references the HTTP address for US GAAP works, and the local copy is found. If the instance references a different local copy of US GAAP, the load will likely fail, and Processing Engine will generate many false errors. There are three Workarounds:
1. Change the instance to point directly to the HTTP addresses for US GAAP.
2. Remove all of the SchemaLocationResolution elements related to the referenced file (such as US GAAP). Users are advised to not edit elements and relationships with the base XBRL schemas.
3. Remove the copy of US GAAP that the instance documents references.
Calculations that involve c-equal, u-equal, or duplicate fact values may not generate inconsistency signals when the calculation is inconsistent, or inversely, may generate inconsistency signals when in fact the calculation is consistent. This error occurs mostly in non-FRIS compliant XBRL instances. An example with duplicate fact values:
<xbrl xmlns="http://www.xbrl.org/2003/instance" xmlns:link="http://www.xbrl.org/2003/linkbase"
<link:schemaRef xlink:href="dupeFactValues.xsd" xlink:type="simple"/>
<my:sharesOnIssue unitRef="share" contextRef="c1" precision="4">1000</my:sharesOnIssue>
<my:sharesOnIssue unitRef="share" contextRef="c1" precision="4">2000</my:sharesOnIssue>
Configuration and Recommendations
Launch the Processing Engine application (xpe-ui.cmdfor windows / xpe-ui.sh for Linux)
Select Help > UBmatrix Online Help, and go to the Troubleshooting FAQ section for a
list of known issues for the current release.
Processing Engine can render (into html, xml, pdf, and other formats) the networks of the
sample XBRL pattern files using the default input parameters defined in Network-ToHTML.xsl,
In the above example, the default extended link is http://www.xbrl.org/2003/role/link.
This role is used by the XBRL sample patterns to group the defined network of relationships.
Other XBRL taxonomies, such as US GAAP, use custom extended link roles to define networks,
such as http://www.xbrl.org/us/fr/lr/role/StatementCashFlows.
To render the US GAAP, and the following extended link, http://www.xbrl.org/us/fr/lr/role/StatementCashFlows and
its presentation relationships, the elRoleUri input parameter should be defined to have the value http://www.xbrl.org/us/fr/lr/role/StatementCashFlows.
This value can be directly modified in the Network-ToHtml.xsl file or in the Transformation dialog.
Send your open source support requests through the sourceforge project web site.
Copyright (C) 2006-2007 UBmatrix, Inc
Address: UBmatrix, Inc., 803 Kirkland Avenue, Kirkland, Washington 98033-6318, USA
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
GNU GENERAL PUBLIC LICENSE
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS