Breaks DataQualityCommittee/dqc_us_rules

[michaelchadfleming]

EDGAR/validate/XuleInterface.py

Line 53 in 4196818

_xule_resources_dir = os.path.join(os.path.dirname(__file__), "resources", "xule")

We've encountered an issue with EDGAR 25.1 recently. The issue is that the new EDGAR Xule/DQC isn't playing nicely with the DataQualityCommittee/dqc_us_rules. I spoke with both Herm and David over the phone yesterday and they both mentioned a few good ideas. The crux of our current issue is that XuleInterface.py is changing the _xule_resources_dir and that is breaking DataQualityCommittee/dqc_us_rules. The consequence that we're experiencing is we are not getting any DQC error messages or only getting some of the errors/warnings. Our various development teams are mitigating these issues by modifying the EDGAR code in various ways unfortunately.

I have a question at this point in the discussion; is there a flag we can use in the command argument parameters to disable EDGAR Xule/DQC and stop it from changing the _xule_resources_dir? If not, it might be beneficial to allow there to be two different _xule_resources_dir: (1.) one when processing EDGAR Xule/DQC and (2.) one for DataQualityCommittee/dqc_us_rules.

CURRENT ISSUE

No DQC warning logs are showing

PLUGIN VERSIONS

ARELLE_VERSION=2.36.29

EDGAR_VERSION=25.1

DQC_PLUGIN_VERSION=26.0.4

XULE_PLUGIN_VERSION=30045.2

IXBRL_VIEWER_VERSION=1.4.62

APPLICATION PROJECT PROCESS TO RUN ARELLE

Using Dockerfile we are setting the following configuration:

1.  Pulling Arelle from git repo 
   

2.  Pulling EDGAR from git repo and copying it into “/opt/Arelle/arelle/plugin” 
   

3.  Pulling xule from git repo and copying it into “/opt/Arelle/arelle/plugin” 
   

4.  Pulling DQC python file from xule git repository and replacing it into “/opt/Arelle/arelle/plugin/EDGAR/validate” 
   

5.  Pulling rulesetMap from DQC repository [https://raw.githubusercontent.com/DataQualityCommittee/dqc_us_rules/v${DQC_PLUGIN_VERSION}/rulesetMap.json](https://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fraw.githubusercontent.com%2FDataQualityCommittee%2Fdqc_us_rules%2Fv%24%257BDQC_PLUGIN_VERSION%257D%2FrulesetMap.json&data=05%7C02%7Cchad.c.fleming%40dfinsolutions.com%7Ce067115363c4434b2bba08dd6ca14e12%7C64ebfaf9be4543c29e9cfcb060bf234d%7C1%7C0%7C638786162236552911%7CUnknown%7CTWFpbGZsb3d8eyJFbXB0eU1hcGkiOnRydWUsIlYiOiIwLjAuMDAwMCIsIlAiOiJXaW4zMiIsIkFOIjoiTWFpbCIsIldUIjoyfQ%3D%3D%7C0%7C%7C%7C&sdata=v8OK%2FBH%2FBldzLPj8%2FK1CrujjzRaGMuXqX7gQZvp98%2Fo%3D&reserved=0) and replacing it into “/opt/Arelle/arelle/plugin/xule/rulesetMap.json” 
   

With this previous configuration we are running a docker container for Arelle and calling it from our project with curl:

/rest/xbrl/validation?disclosure-system=efm-pragmatic&media=zip&copyInlineFilesToOutput=true&copyXbrlFilesToOutput=true&saveViewer=false&logFile=logFile.json&zipXbrlFilesToOutput=true&saveTargetInstance=true&calc=c11r

[ActionScripted]

Hey Michael / all, is there a way to get this working? We're looking to upgrade EDGAR but we're having the same issues with dqc_us_rules.

[michaelchadfleming]

@ActionScripted The SEC dev added a new parameter value "XULE_RUN_ALL". The parameter below can be added to the command line arguments:

--parameters "dqcRuleFilter=XULE:2024|XULE_RUN_ALL"

The original question was to disable the EDGAR Xule/DQC implementation. We see some flags/parameters intended for this purpose but we unable to find documentation one how to implement. We were able to disable EDGAR Xule/DQC by changing the file "XuleInterfact.py" .../validate/XuleInterface.py? by returning nothing form every def function.

[NostalgicBeing]

Hi Arelle,

I'm following up on this thread, as we are encountering a similar issue.

Command line:
/opt/arelle/arelleCmdLine --abortOnMajorError --calc c10d --collectProfileStats --disclosureSystem efm-pragmatic --file /home/site/cache_samples/SampleTestCase.zip --internetRecheck never --internetTimeout 120 --logFile /tmp/arelle/storage/2025-06-19T14-40-37_d7199151d7e14ca48eaf6b93883895b9/arelle_log.json --plugins Edgar|Validate/DQC|Validate/EFM -r /tmp/arelle/storage/2025-06-19T14-40-37_d7199151d7e14ca48eaf6b93883895b9 --validate --xdgConfigHome /home/site/cache_base_temp

We receive the following error message:
"[arelle.incompatibleRulePlugin] EDGAR is not compatible with the DQC.py plugin, please remove the DQC.py plugin. The EDGAR plugin directly manages running of to run DQC rules. - "

The versions we have tested this with are:
ARELLE_REF=2.36.27
EDGAR_REF=25.1
XULE_REF=30045.2
and
ARELLE_REF=2.37.12
EDGAR_REF=25.2
XULE_REF=30048

[austinmatherne-wk]

Hi @NostalgicBeing,

As the error message indicates, you should remove the validate/DQC plugin. This happens because the EDGAR plugin is already configured to run its own set of DQC rules, and enabling the validate/DQC plugin in your command causes a conflict.

If you’d like to run the full set of DQC rules instead of the subset configured by the SEC, you can use the dqcRuleFilter parameter mentioned by Chad above.

[NostalgicBeing]

Hi Austin,

We tried that, with calling validate as follows :
/opt/arelle/arelleCmdLine --abortOnMajorError --calc c10d --collectProfileStats --disclosureSystem efm-pragmatic --file /home/site/cache_samples/SampleTestCase.zip --internetRecheck never --internetTimeout 120 --logFile /tmp/arelle/storage/2025-06-19T14-40-37_d7199151d7e14ca48eaf6b93883895b9/arelle_log.json --plugins Edgar|Validate/DQC|Validate/EFM -r /tmp/arelle/storage/2025-06-19T14-40-37_d7199151d7e14ca48eaf6b93883895b9 --parameters dqcRuleFilter=XULE_RUN_ALL --validate --xdgConfigHome /home/site/cache_base_temp

Here we added the dqcRuleFilter=XULE_RUN_ALL parameter; however, the data quality committee DQC rules still do not run.

We also tried it with both, including the Validate/DQC plugin, as well as removing it. When the Validate/DQC plugin is included, alongside the dqcRuleFilter param we get the same warning message ([arelle.incompatibleRulePlugin]), and without it, we do not, but the rules do not run either way.

Tested on versions
ARELLE_REF=2.37.12
EDGAR_REF=25.2
XULE_REF=30048

[austinmatherne-wk]

It looks like your dqcRuleFilter value is missing the XULE:2024| prefix from Chad's example. That part defines the minimum US GAAP taxonomy version to run XULE against. Some more info in the plugin source file.

[NostalgicBeing]

Thanks, Austin, for the quick response. We added the missing prefix of XULE:2024|, and it did not make any difference. We ran the Arelle GUI, including the dqc.py, and received the expected results.

This leaves us to believe that Chad's original issue persists. We are planning to implement what Chad recommend above which is to disable EDGAR Xule/DQC by changing the file "XuleInterfact.py" .../validate/XuleInterface.py? by returning nothing form every def function.

We tested the above locally, it returned the DQC rules as expected.

PS: we are testing the latest approach recommended by Chad: #41 (comment)