EM HAVE SC

 View Only
  • 1.  Chet and Darrell: [emergency-have] HAVE 2.0 - Data Dictionary

    Posted 10-23-2014 11:55
    Darrell, I originally had a question whether the gen’d version provides all the information that our typical data dictionary would.  After comparing it looks like it definitely does.  The gen appears to produce the “Data Dictionary table rows” that only apply to each element.  For example, I didn’t see a row for “enumerations/default values” until I found an element where it applied so we are good.   Chet, I’d like to reiterate a couple of points regarding this request.  This proposed method: 1.        covers all the information we normally include in a manually-written data dictionary (DD) 2.        is far less resource intensive than manually matching schema with DD 3.        eliminates errors between the two.  If the schema is fixed, a new data dictionary is gen’d to automatically pick up the changes 4.        helps with an urgent driver to get the HAVE specification completed ASAP, and through the OASIS process to address the need for Ebola support   Thanks ,     Tim __________________________________________________________   From: emergency-have@lists.oasis-open.org [mailto:emergency-have@lists.oasis-open.org] On Behalf Of Darrell O'Donnell Sent: Thursday, October 23, 2014 7:36 AM To: Elysa Jones Cc: Chet Ensign; HAVE SC Subject: Re: [emergency-have] HAVE 2.0 - Data Dictionary   Chet - as a consideration we can also generate a detailed and interactive HTML version of the schema. Here is an example that I generated from our working draft:  http://oasis-edxl-have-v2.0-wd.s3.amazonaws.com/edxl-have-v2.0-wd.html   cheers,   Darrell     --   Darrell O'Donnell, P.Eng. OASIS Member (volunteer) - www.oasis-open.org   OASIS EM-TC - Member OASIS EM-TC HAVE SC - Co-Chair   darrell.odonnell@continuumloop.com       On Thu, Oct 23, 2014 at 7:34 AM, Elysa Jones < elysajones@yahoo.com > wrote: Chet,   Please review this process for an auto-generated data dictionary.  We are working diligently to get a PR draft out for HAVE given the interest due to the Ebola situation.  This method would save us time as well as minimize/eliminate the common mistakes made when it is done manually.    Thanks,   Elysa Jones, Chair OASIS Emergency Management Technical Committee Emergency Interoperability Member Section   Elysa     From: emergency-have@lists.oasis-open.org [mailto: emergency-have@lists.oasis-open.org ] On Behalf Of Darrell O'Donnell Sent: Wednesday, October 22, 2014 6:00 AM To: HAVE SC Cc: Chet Ensign Subject: [emergency-have] HAVE 2.0 - Data Dictionary   Folks - as we discussed in the EDXL-HAVE SC meeting this afternoon we would like to use a different format for the Data Dictionary section of the standards document.   I have CC'ed Chet Ensign from the TC Admin as per Elysa's recommendation.    The approach that I recommend and that we agreed upon was to use an auto-generated document that is driven from the data in our XML Schema. This would mean that there should be no errors (barring a software glitch in OxygenXML) but there are a couple of issues to consider:   1. I can't generate a Word-compatible version so we can't cut and paste the content into the .docx standard file. I proposed that we would include the full PDF (sample attached) as an appendix and reference it in the Data Dictionary. This would need approval from the TC Admin for the format.    2. There may be come formatting issues. If you look at the attached PDF, there are a few images that go beyond the page (e.g. see page 8). We can make a fully browse-able website version available too though - it doesn't have that problem.    Here is a screenshot comparing a draft (ignore the highlights on the left side please) with the normal table and the generated XML Schema documentation on the right. I believe all of the fields and information that we need is there and it includes a pretty good diagram.     We'll have the ERM diagram as well (thanks to Patti!) and the rest is coming along well.   Thanks a ton for the great meeting. I'll send out the draft minutes in a moment.   cheers,   Darrell     --   Darrell O'Donnell, P.Eng. OASIS Member (volunteer) - www.oasis-open.org   OASIS EM-TC - Member OASIS EM-TC HAVE SC - Co-Chair   darrell.odonnell@continuumloop.com      


  • 2.  Re: Chet and Darrell: [emergency-have] HAVE 2.0 - Data Dictionary

    Posted 10-23-2014 20:52
    Yes indeed, I see the benefits of this approach. Much better than manually slogging through a huge pile of data...  On Thu, Oct 23, 2014 at 7:55 AM, Timothy Grapes < grapesco@outlook.com > wrote: Darrell, I originally had a question whether the gen’d version provides all the information that our typical data dictionary would.  After comparing it looks like it definitely does.  The gen appears to produce the “Data Dictionary table rows” that only apply to each element.  For example, I didn’t see a row for “enumerations/default values” until I found an element where it applied so we are good.   Chet, I’d like to reiterate a couple of points regarding this request.  This proposed method: 1.        covers all the information we normally include in a manually-written data dictionary (DD) 2.        is far less resource intensive than manually matching schema with DD 3.        eliminates errors between the two.  If the schema is fixed, a new data dictionary is gen’d to automatically pick up the changes 4.        helps with an urgent driver to get the HAVE specification completed ASAP, and through the OASIS process to address the need for Ebola support   Thanks ,     Tim __________________________________________________________   From: emergency-have@lists.oasis-open.org [mailto: emergency-have@lists.oasis-open.org ] On Behalf Of Darrell O'Donnell Sent: Thursday, October 23, 2014 7:36 AM To: Elysa Jones Cc: Chet Ensign; HAVE SC Subject: Re: [emergency-have] HAVE 2.0 - Data Dictionary   Chet - as a consideration we can also generate a detailed and interactive HTML version of the schema. Here is an example that I generated from our working draft:  http://oasis-edxl-have-v2.0-wd.s3.amazonaws.com/edxl-have-v2.0-wd.html   cheers,   Darrell     --   Darrell O'Donnell, P.Eng. OASIS Member (volunteer) - www.oasis-open.org   OASIS EM-TC - Member OASIS EM-TC HAVE SC - Co-Chair   darrell.odonnell@continuumloop.com       On Thu, Oct 23, 2014 at 7:34 AM, Elysa Jones < elysajones@yahoo.com > wrote: Chet,   Please review this process for an auto-generated data dictionary.  We are working diligently to get a PR draft out for HAVE given the interest due to the Ebola situation.  This method would save us time as well as minimize/eliminate the common mistakes made when it is done manually.    Thanks,   Elysa Jones, Chair OASIS Emergency Management Technical Committee Emergency Interoperability Member Section   Elysa     From: emergency-have@lists.oasis-open.org [mailto: emergency-have@lists.oasis-open.org ] On Behalf Of Darrell O'Donnell Sent: Wednesday, October 22, 2014 6:00 AM To: HAVE SC Cc: Chet Ensign Subject: [emergency-have] HAVE 2.0 - Data Dictionary   Folks - as we discussed in the EDXL-HAVE SC meeting this afternoon we would like to use a different format for the Data Dictionary section of the standards document.   I have CC'ed Chet Ensign from the TC Admin as per Elysa's recommendation.    The approach that I recommend and that we agreed upon was to use an auto-generated document that is driven from the data in our XML Schema. This would mean that there should be no errors (barring a software glitch in OxygenXML) but there are a couple of issues to consider:   1. I can't generate a Word-compatible version so we can't cut and paste the content into the .docx standard file. I proposed that we would include the full PDF (sample attached) as an appendix and reference it in the Data Dictionary. This would need approval from the TC Admin for the format.    2. There may be come formatting issues. If you look at the attached PDF, there are a few images that go beyond the page (e.g. see page 8). We can make a fully browse-able website version available too though - it doesn't have that problem.    Here is a screenshot comparing a draft (ignore the highlights on the left side please) with the normal table and the generated XML Schema documentation on the right. I believe all of the fields and information that we need is there and it includes a pretty good diagram.     We'll have the ERM diagram as well (thanks to Patti!) and the rest is coming along well.   Thanks a ton for the great meeting. I'll send out the draft minutes in a moment.   cheers,   Darrell     --   Darrell O'Donnell, P.Eng. OASIS Member (volunteer) - www.oasis-open.org   OASIS EM-TC - Member OASIS EM-TC HAVE SC - Co-Chair   darrell.odonnell@continuumloop.com       -- /chet    [§]  ---------------- Chet Ensign Director of Standards Development and TC Administration  OASIS: Advancing open standards for the information society http://www.oasis-open.org Primary: +1 973-996-2298 Mobile: +1 201-341-1393  Check your work using the Support Request Submission Checklist at  http://www.oasis-open.org/committees/download.php/47248/tc-admin-submission-checklist.html   TC Administration information and support is available at http://www.oasis-open.org/resources/tcadmin Follow OASIS on: LinkedIn:     http://linkd.in/OASISopen Twitter:         http://twitter.com/OASISopen Facebook:   http://facebook.com/oasis.open