Using oslcquery on command line is generating errors

[denisbelanger101]

Hi,
Can someone tell me why I am getting these errors when running a query from the command line please?
Here is the command/arguments and the output. Your help would be really appreciated!

Thank you!

C:\Program Files\Python313>oslcquery -J "My IBM DNG server!" -U "user" -P "My user password!" -p "My project name!" -q rm:module=~465913 -r rm_view:"testview" -O "C:\TEMP\results.csv
Version 0.28.0
Traceback (most recent call last):
File "", line 198, in _run_module_as_main
File "", line 88, in run_code
File "C:\Users\user\AppData\Roaming\Python\Python313\Scripts\oslcquery.exe_main.py", line 7, in
sys.exit(main())
~~~~^^
File "C:\Users\user\AppData\Roaming\Python\Python313\site-packages\elmclient\examples\oslcquery.py", line 841, in main
do_oslc_query(sys.argv[1:])
~~~~~~~~~~~~~^^^^^^^^^^^^^^
File "C:\Users\user\AppData\Roaming\Python\Python313\site-packages\elmclient\examples\oslcquery.py", line 242, in do_oslc_query
theserver = server.JazzTeamServer(args.jazzurl, args.username, args.password, verifysslcerts=args.certs, jtsappstring=f"jts:{approots['jts']}", cachingcontrol=args.cachecontrol, cachefolder=cachefolder )
File "C:\Users\user\AppData\Roaming\Python\Python313\site-packages\elmclient\server.py", line 149, in init
self._session = JazzTeamServer.__get_client(user, password,cachingcontrol=cachingcontrol, cachefolder=self.cachefolder)
~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "C:\Users\user\AppData\Roaming\Python\Python313\site-packages\elmclient\server.py", line 290, in __get_client
os.makedirs(webcachefolder,exist_ok=True)
~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "", line 217, in makedirs
File "", line 227, in makedirs
PermissionError: [WinError 5] Access is denied: '.web_cache'

C:\Program Files\Python313>oslcquery -J "https://nouvlr.clm.ibmcloud.com" -U "user" -P "PlutonPluton105!"
Version 0.28.0
Traceback (most recent call last):
File "", line 198, in _run_module_as_main
File "", line 88, in run_code
File "C:\Users\user\AppData\Roaming\Python\Python313\Scripts\oslcquery.exe_main.py", line 7, in
sys.exit(main())
~~~~^^
File "C:\Users\user\AppData\Roaming\Python\Python313\site-packages\elmclient\examples\oslcquery.py", line 841, in main
do_oslc_query(sys.argv[1:])
~~~~~~~~~~~~~^^^^^^^^^^^^^^
File "C:\Users\user\AppData\Roaming\Python\Python313\site-packages\elmclient\examples\oslcquery.py", line 242, in do_oslc_query
theserver = server.JazzTeamServer(args.jazzurl, args.username, args.password, verifysslcerts=args.certs, jtsappstring=f"jts:{approots['jts']}", cachingcontrol=args.cachecontrol, cachefolder=cachefolder )
File "C:\Users\user\AppData\Roaming\Python\Python313\site-packages\elmclient\server.py", line 149, in init
self._session = JazzTeamServer.__get_client(user, password,cachingcontrol=cachingcontrol, cachefolder=self.cachefolder)
~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "C:\Users\user\AppData\Roaming\Python\Python313\site-packages\elmclient\server.py", line 290, in __get_client
os.makedirs(webcachefolder,exist_ok=True)
~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "", line 217, in makedirs
File "", line 227, in makedirs
PermissionError: [WinError 5] Access is denied: '.web_cache'

[barny]

As the last line tells you, oslcquery can't create folder .web_cache. This is used to cache responses to speed the overall query and it is left after a run so the next run can use the cached data. The cache content is ignored seven days after it was retrieved. You can clear the cache with the -W option, or clear it and disabled caching using -WW option.

Two solutions:

1. Ensure you have permission to create a folder called .web_cache wherever you're running oslcquery
2. Use option -WW option which disables caching so there shouldn't be any attempt to create the .web_cache folder. But the shape loading will have to be done every time as it is no longer cached.

[denisbelanger101]

Great, thank you so much , I will try that!

[barny]

I guess you're trying to query views. RM has query capability for views, you can use this by specifying -r View or -r http://jazz.net/ns/rm/dng/view#View or -r rm_view:View - these all mean exactly the same thing.

You can see Query Capabilities at the top of a type system report using e.g. --typesystemreport a.html - use the short name, or the URI with -r.

[denisbelanger101]

Great, thank you so much , I will try that!

[denisbelanger101]

Hi,

I managed to get it to work. The only this is that it outputs to the csv file, only the row artifact URI of the module and the DOORS ID.

What I need is to export a complete view in a excel file. Just as when I chose "Export View" in a DNG Module, and then it exports the exact structure of the Module view in a xls file.

Does the ELMclient does that?

Thank you!
Denis

[barny]

The query is for views, not the content of views. I believe it's primarily for use when using the ReqIF API to create a Reqif definition to export content of a view. But that's to ReqIF XML, not CSV/XLS/XLSX.

AFAIK the only way to export content of a view is to XML using the DNG Reportable REST API https://jazz.net/wiki/bin/view/Main/DNGReportableRestAPI - export a module using a view URI

There is an attempt at exporting Reportable REST in elmclient, but I don't think it's finished. See examples/represt.py

[denisbelanger101]

I tried this and I can get the xml file, but I had the issue that I need something to convert this xml file with the original structure, and especially the child nodes. The code I have only parses the parent nodes.

[barny]

The bookOrder tag tells you where the artifact is in the module read linearly from top to bottom, and section tag gives you it's location in the hierarchy. Of course these give most useful output when no artifacts are not present because of filtering by the view, and when the view is not sorted.

represt will export reportable rest results from rm to CSV, including bookOrder and section, when using the resources format with a project and view specified, for example:

For project rm_optin_p1, component of the same name, with -m the module name and -v the view name, from the default configuration (specify a different config using -l):

represt rm resources -p rm_optin_p1 -c rm_optin_p1 -m "AMR Stakeholder Requirements Specification" -v "Trace to System Requirements" -C a.csv -V

But be warned represt isn't finished and I'm honestly much less likely to have time to fix problems in it - but you've got the source code :-)

[denisbelanger101]

Great! Thanks a million Ian! I will look at this represt code!

[denisbelanger101]

Hi Ian,
Here is a status. I did a lot of tests. Represt works fine but the --view or -v parameter does not work. There are no errors, the view name spelled right but the csv file shows all attributes, not just the one contained in the "View". Here is my command:
represt rm resources -J "https:server" -U myusername-P mypassword! -p "myprojectname" -m "mymodulename" --view "Test1" -C "myCSVfilename"

[denisbelanger101]

Hi Ian,
Here is what I found using the debug tool in elmclient. The View URI is found using the text name of the view. My command line is as the above: represt rm resources -J "https:server" -U myusername-P mypassword! -p "myprojectname" -m "mymodulename" --view "Test1" -C "myCSVfilename"

So, the View name is "Test1". In DNG, in the Module, you can see View "Test1". On the right side of the below screenshot, you can see the attributes selected for this View.

But in the output file you can find all attributes of thi Module, even the one that are not selected for this View, like foe example the below one...

And indeed, if I add this attribute to the view, it looks like this in DNG:

How can I get some help on this last issue I have.

Thank you!

[barny]

As I answered your other discussion about this, the DNG Reportable REST API does accept a view and filters the returned artifacts by that view but doesn't limit the returned attributes to what's in the view, i.e. the same attributes are always returned, as you've seen: this is the expected behaviour.