Purpose

This repo provides XULE support for ferc validation rulesets.

The repo contains ferc form ruleset files that support validation with the latest version of XULE.

Versions

There are different versions of the rulesets that accompany each taxonomy version. The repo has seperate branches for each taxonomy version. The main branch reflects the validation rules for the latest taxonomy release.

Validating a Filing

FERC forms are validated during the submission process with a series of checks. These validations can also be downloaded from the root of this repository and invoked as .zip files using Arelle version 2.23.11 or later and the XULE processor version 3.0.30003 or later.

The command to validate a filing is as follows (update the {location} text for the corresponding ruleset to use and instance to check):

.\arellecmdline.exe --plugins xule --xule-rule-set {location of form ruleset}/Form1.zip -f {location of instance}/sampleF1.xbrl -v --xule-time .005 --xule-debug --noCertificateCheck --logFile {location of output}/log.xml

The validation ruleset.zip files can be invoked from this repository by using the /raw/ attribute in the URL. The following example will check a sample posted to the FERC Xendr templates repository:

.\arellecmdline.exe --plugins xule | transforms --xule-rule-set https://github.com/xbrlus/ferc-validation-rulesets/raw/2024-04-01/ValidationRuleset_Form2.zip -f https://raw.githubusercontent.com/xbrlus/ferc-xendr-rulesets/2024-04-01/Form2/sampleInstances/Sample_Form_2.xbrl -v --xule-time .005 --xule-debug --noCertificateCheck --logFile log.xml

Check it out with or : after running the first cell to create a Python environment with Arelle and XULE, paste the command below into the "2. Run XULE against an XBRL report" step (replacing what's in the cell), then run the cell. This will take about 75 seconds to load the taxonomy, process the filing and run FERC validations:

!arelleCmdLine --plugins xule --xule-rule-set https://github.com/xbrlus/ferc-validation-rulesets/raw/2024-04-01/ValidationRuleset_Form2.zip -f https://raw.githubusercontent.com/xbrlus/ferc-xendr-rulesets/2024-04-01/Form2/sampleInstances/Sample_Form_2.xbrl -v --xule-time .005 --xule-debug --noCertificateCheck --logFormat="[%(messageCode)s] %(message)s"