Provenance WD: vo-dml review

[CresitelloDittmar, Mark]

All,
   Laurent and Mireille have been working hard on the vo-dml representation
of the Provenance model, working through
   several technical glitches resulting from migration to Modelio 3.8.
This past week or so, they've gotten pretty close to working
   out the issues, and are generating viable vo-dml/XML and HTML output.
Below is a review of the latest drop.

Review of Provenance model vo-dml representation: commit 5557

https://volute.g-vo.org/svn/trunk/projects/dm/provenance/ProvDM/vo-dml/Provenance.html

Validation:
  + XSLT script:  Modelio-3.8 xmi does not quite process with the
Modelio-3.7 script
     a) need to revert the base_* tags to the previous tags ( base_Element
-> base_Package), (base_Element -> base_NamedElement)
         o MCD commited xmi2vo-dml_Modelio3.8_UML2.4.1.xsl to volute
20190719 [commit 5559]
            NOTE: this was obviously already done 'on-the-side' by Laurent
to produce the current volute content..
  + Processing of xmi -> vo-dml/xml using Modelio3.8 xslt script works.
  + Validation of vo-dml/xml shows 2 instances of 1 Error.
     o datatype ivoa:quantity.Unit of ValueDescription.unit is not a value
type but a ''
     o Due to incorrect proxy ivoa model in Provenance xmi.  Hand editing
the vodml-id of the elements in the quantity package, which does not exist
in the REC, produces vo-dml/xml which validates.
     *ACTION:* The ivoa proxy in the provenance model should be updated to
match the vo-dml REC
  + Confirmed vo-dml/xml -> html works on above vo-dml/xml product

Convention:
  + according to our organizational conventions  <volute>.../dm/00README.txt
     o *ACTION:* the xmi file should reside in the 'model' directory rather
than the 'vo-dml'

Comments:
  Model
    + name/prefix: expecting a short-name/prefix for the model.. while
'Provenance' does match the vo-dml pattern spec, I think something like
'prov' is more in keeping with the convention.  This would produce
"prov:Entity" rather than "Provenance:Entity"
       o *ACTION?:* change Model name/prefix to 'prov"?
    + the model stereotype is missing content; title, authors, version,
previousVersion elements
       o *ACTION:* Fill in Model stereotype content.

  ModelImport
    + import of 'ivoa' types model looks good, links to ivoa types resolve
properly in html file
    + NOTE: proxy 'ivoa' model content incorrect.. see validation note
above.

  Content
    - NOTE: in the following, 'the PDF' refers to Provenance WD - 20190716
(not sure which commit)
    + All elements appear to be present, no 'extra' elements appear to
exist.
       o Element details (attributes, multiplicity, etc) have had good
review through the diagrams in the PDF
       o I note 1 ERROR; Enumeration TypeOfConfigArtifact - the name does
not match the PDF; "Artifact" in UML, "Artefact" in PDF
          *ACTION:* Correct the spelling; the name of the Enumeration type
is the only place this spelling is used, all others in PDF and UML use
'artefact'
    + All elements have at least some description.
       o BUT, the descriptions vary significantly between the vo-dml and
PDF.  While it is OK for the descriptive content to differ, they MUST be
consistent so that readers of both do not get confusing or conflicting
information.  In my opinion, they should be identical where practical,
allowing the PDF to expand on detail from the vo-dml content.
       o *ACTION:* The vo-dml descriptions need a good review for
consistency with the PDF.
    + Relational elements are not listed under the Element tables in the
PDF, this is presumably intentional.   e.g. Activity.informant,
Activity.activityDescription, Activity.used ...

Mark
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.ivoa.net/pipermail/dm/attachments/20190719/9fa40a39/attachment.html>