Activation of plugin in Arelle API

[Sriram S]

Hi Team,

I'm able to activate the plugin in commandline with the below command,

arelleCmdLine --plugin validate/DQC --dqc-version

and the validation works fine on the local host with the below command

http://localhost:8080/rest/xbrl/validation?file={fileName}&media=xml&utr&plugins=validate/DQC|transforms/SEC|EdgarRenderer&efm-pragmatic

Similarly, how to activate the plugin while using the API since it returns the response with the below error:

<entry code="arelle:pluginParameterError" level="error">
 <message name="validate/DQC" file="validate/DQC">[arelle:pluginParameterError] Unable to load "validate/DQC" as a plug-in or "validate/DQC" is not recognized as a plugin command.  -</message> <ref href=""/></entry>

It would be helpful to get your insights on the above!

Thanks,

Sriram

[Austin Matherne]

Hi Sriram,

Are you running Arelle from python source or one of the distributed builds?

Kind regards,

Austin Matherne

[Sriram S]

Hi Austin,

Using the distributed builds not a python source.

Thanks 

--

---
You received this message because you are subscribed to a topic in the Google Groups "Arelle-users" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/arelle-users/wW-ex6ovntc/unsubscribe.
To unsubscribe from this group and all its topics, send an email to arelle-users...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/arelle-users/b909440c-688c-426c-9a67-14c0abd11c49n%40googlegroups.com.

[Austin Matherne]

What command are you using to launch the webserver?

[Sriram S]

Hi Austin,

To give more clarity of our usage. We create an Arelle image from the github commits (for both the Arelle & EdgarRenderer) which runs on the docker. 

If I place the 'xule' folder inside the 'plugin' folder of the container with the dqc.py files under 'validate' folder, I get the expected response as mentioned below,

<entry code="info" level="info">
 <message>2024-04-25 07:52:44,331 [info] Activation of plug-in DQC Rules Validator successful, version Check version using Tools->DQC->Version on the GUI or --dqc-version on the command line. - validate/DQC
</message>
 <ref href="validate/DQC"/></entry>

<entry code="debug" level="debug">
 <message>2024-04-25 07:52:45,235 [debug] resourcesFolder=/arelle_cgi/plugin/EdgarRenderer/resources - EdgarRenderer
</message>
 <ref href="EdgarRenderer"/></entry>

My query is how to automate this process of adding the xule & dqc python files to be placed in the respective folder OR in other words how to activate a new plugin (dqc validator or any other plugin) for our usage.

Hope it's clear for you to give a solution to resolve my issue.

Thanks for your support!

[Austin Matherne]

The XULE and DQC plugins are maintained in a separate project by XBRL US. You may find it helpful to look at the build steps we use to package them in our builds.

Kind regards,

Austin Matherne

[Sriram S]

It works as expected. Thanks Austin for your support!