A demonstration of CoreFiling's True North Data Platform.
This application demonstrates the platform's support for working with XBRL filings and provides links to other applications that demonstrate other platform features.
To try out these examples, please sign-up for the True North Data Platform at https://www.corefiling.com/platform/.
Each example requires the user to select a filing. This can be done by uploading a filing, selecting a filing from the dataset of all US Securities and Exchange Commission filings, or reusing a recent filing.
When uploading a filing, choose the relevant "Validation Profile". This ensures the document is validated against the correct set of business rules.
This step uses the True North Data Platform Document Service and Search Service APIs. Documents are uploaded to the Document Service.
The code can be found in src/app/workspace.
This example displays the validation status of the filing from the Validation Service API.
The code can be found in src/app/validator.
This example displays table renderings provided by the Table Rendering API. This uses Table Linkbase if the taxonomy includes it, otherwise synthesizes table layouts automatically.
The code can be found in src/app/viewer.
This example displays statistics derived from CoreFiling platform APIs.
The Filing Statistics Service API is a CoreFiling Labs API that aggregates the statistics.
The code can be found in src/app/statistics.
This example shows how the CoreFiling Platform can be used to perform analysis of XBRL documents.
An Open Source CoreFiling Labs service is used to calculate statistics related to Benford's law. Benford's law is an observation about the frequency distribution of leading digits in many real-life sets of numerical data that has applications in accounting fraud detection.
The code can be found in src/app/benfords.
- Quick Taxonomy Info demonstates searching for concepts in a taxonomy.
- Taxonomy Packager demonstates creating an XBRL Taxonomy Package from a taxonomy ZIP file.
- XBRL Document Change Report demonstates comparing two versions of a filing to review the changes.
Sign-up for the True North Data Platform at https://www.corefiling.com/platform/.
As part of the sign-up process you can access a CoreFiling-hosted copy of this application. The following instructions allow you to run a local copy based on a checkout of this Git repository.
Install node@>=6.0.0, npm@>=4.0.0 and yarn@>=1.0.0.
$ yarn install
$ yarn startThe application will be available on http://localhost:8080/filings-workspace/.
When prompted, log in using the email address and password for your CoreFiling account.
To configure non-default OAuth 2 client credentials (supplied by CoreFiling)
export the following variables before starting the application with yarn start.
$ export CLIENT_ID="your-client-id"
$ export CLIENT_SECRET="your-client-secret"See Getting Started for the dependencies.
yarn storybookand visit http://localhost:6006/.
Single run:
yarn testWatch files:
yarn test-debugyarn compileyarn pack # Produces cfl-filings-workspace-$VERSION.tgzThe webpack development server is currently optimised for running in CoreFiling's development environment and cannot easily be used externally.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.