Extracting Module and Artifact data from DOORS N

[PersonalGHubAccount]

Hi!

So I am trying to extract data from DN. I want to retrieve Module artifacts as well as all data about the artifacts inside of that module.

In version 0.31.1 I manage to retrieve the module structure, but I need more detail about the specific artifacts. I've tried using 0.32 and 0.33 but I am unfortunately locked to using python 3.11.9 and I seem to hit some syntax issues (like f string matching that is easily fixed), but other than that, the scripts just give me a lot of errors (like me needing to insert projectname, login etc in multiple places for authentication to work). It just feels like something is stopping the code from working properly at certain places.

Is there a python 3.12+ requirement somewhere I am not seeing or something similar? Which example files would be best for my use case of retrieving a Module, and full details about the Artifacts (attributes, tables etc)?

Thank you :)

[barny]

AFAIK apart from the f-string issue there's no reason you should be able to use back to Python 3.9. However I'm using 3.13 (which is why I hadn't seen the f-string issue myself).

Which example are you starting from?

If you're getting the module details then you must have selected a project/component/configuration: continue using the badly named c variable which continues to refer to that project/component/configuration.

If what you need is a list of the artifacts in the module (i.e. not the heading hierarchy) the simplest way to get these is to use OSLC Query to give you all the artifacts used by the module, for example (based on dn_simple_module_structure.py line 173, insert this after line 189):

# untested!
# assumes you have the themodule_u url, and qcbase is the query capability for Requirements
    moduleuses = c.execute_oslc_query(
            qcbase,
            whereterms=[['rm:module','=',f'<{themodule_u}>']],
            select=['*'],
            prefixes={rdfxml.RDF_DEFAULT_PREFIX["rm"]:'rm'} # note this is reversed - url to prefix
            )
    for i,art_u in enumerate( moduleuses ):
        print( f"Artifact {i} url {art_u}" )
        art_x = c.execute_get_rdf_xml( art_u )
        print( f"XML={ET.tostring( art_x )}\n\n" )

You can put additional query terms in the whereterms for example to only return artifacts of a particular type for example you can get the URL of the artifact type in variable typeURL then:

            whereterms=[['rm:module','=',f'<{themodule_u}>'],['oslc:instanceShape','=',f'<{typeURL}>']],
            prefixes={rdfxml.RDF_DEFAULT_PREFIX["dcterms"]:'dcterms',rdfxml.RDF_DEFAULT_PREFIX["oslc"]:'oslc'} # note this is reversed - url to prefix

returns only artifacts of that type in the module.

In a future release I'm going to make it easier to do OSLC Queries by providing a function using the same query expression syntax as used by the oslcquery commandline example (the query parsing code is already there, of course) - so you just use the human-friendly names for things like the artifact type/oslc:instanceShape - also so you don't have to explicitly specify the prefixes. Using this the above the query would be rm:module=^"My Module Name" and oslc:instanceShape='Stakeholder Requirement' and you wouldn't have to specify anything else :-)

[PersonalGHubAccount]

Hi, I just managed to post my other question before your reply. I am currently using the dn_simple_modulestructure.py. I've incorporated it into my own code, but in general its untouched and I am just fetching artifact ids. but I am guessing here I could somehow retrieve specific types of URLS by typeURL? is there any type of way to still get the heading hierarchy printed out, but to then just get a tuple returned with artifact ID and its "embedds to" "satisfies by" etc resource links with that? I am guessing there's some kind of documentation for this typeURL? I apologize if I am in over my head with this and for the now kind of double postings.

[barny]

any type of way to still get the heading hierarchy printed out

It's your code, of course you can also print the hierarchy if you need to.

could somehow retrieve specific types of URLS by typeURL

The example above does just that. The type URLs are stored in the type system.

The config-specific type system is stored in the component c by load_types() in _rm.py - look in _typesystem.py there's a function textreport() which generates HTML report of the typesystem, that shows how you might look up a type by name. This function is used by the oslcquery --typesystemreport option, you might use that to see what the report looks like

See my answer to your other question for the tags for links like Embedded and Link - when present these are in the RDF at the source end of the link.