1 / 7

Document Versioning - Update

Document Versioning - Update. Milt Panas May 10, 2011. JPSS CGS Form J-110 10/22/2010. Issue Description. Issue – Data Product Document Versioning Description For Data products archived in CLASS, can the product format documentation be easily retrieved years after the product was created?

grace
Download Presentation

Document Versioning - Update

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Document Versioning - Update Milt Panas May 10, 2011 JPSS CGS Form J-110 10/22/2010

  2. Issue Description • Issue – Data Product Document Versioning • Description • For Data products archived in CLASS, can the product format documentation be easily retrieved years after the product was created? • Example • Let's say an SST product for a particular day (e.g. Jan 1, 2012) was generated using Mx5 and archived in CLASS. Ten years later, the SST algorithm and associated format documents (CDFCB-X) have been updated 3 times, but someone goes back and retrieves the SST from Jan 1, 2012. The current CDFCB-X doesn't describe the Mx5 version of the SST. Can the Mx5 version of the CDFCB-X be easily identified and retrieved.

  3. Response • Data Product Metadata • N_Software_Version - Version of IDPS software that created the Data Product. • <Identifier><Phase>.<Major>.<Minor>.<Patch> Example: I1.5.01.00 • N_Algorithm_Version - Indicates the version number of the algorithm • <Phase_ID>.<Category_ID>.<Science Baseline ID>.<Software ID> Example: 1.O.001.002 • N_NPOESS_Document_Ref - Provides an array of strings containing the filename of the documentation relevant to the algorithm that produced the particular data product – includes CDFCB-X, NPOESS Data Product Profile XML, and OAD filenames • D34862-04-02_NPOESS-CDFCB-X-Vol-IV-Part-2_E_20091209_I1.5.0.pdf,D34862-04-02_NPOESS-CDFCB-X-Vol-IV-Part-2_E_CrIMSS-EDR-PP.xml,D37021_OAD-CrIMSS-EDR_B_20090909_I1.5.0.pdf • Version Description Document (VDD) • Based on Software version • Example: VD7620529-1-10 I1.5.04.00A IDPS SW NPP OPS VDD.docx • N_Algorithm_Version is listed in the VDD • Release Packages • Created based on Software Version (same as N_Software_Version) • Contains Software and Documentation (except ITAR and FOUO) • Archived in CLASS • Use the Software Version number to find the Documentation in CLASS

  4. Related Issue Description • Issue – Updates to previously released Documents • Description • For Data products archived in CLASS, can the product format documentation be easily Updated years after the product/Documentation were created if an error is found? • Example • Previous example SST product for a particular day (e.g. Jan 1, 2012) was generated using Mx5 and archived in CLASS. Ten years later, an error is found in the associated format documents (CDFCB-X). Can the Mx5 version of the CDFCB-X be easily updated.

  5. Solution • No existing process for this • Possible solution • Revision update and re-release • Update the old revision (e.g. Rev A) of the CDFCB-X to make the update. Number the revision to indicate its an update (e.g. Rev A.1) • Release packages have a versioning mechanism for updates to the package (-n) • Example • Software Release package I1.5.01.00-1 has Rev A of the CDFCB-X Vol. VI Part 2. Ten years later, we find an error in the CDFCB-X volume that needs to be fixed. • Update CDFCB-X Vol. VI Part 2 to Revision A.1 • Update the Document VDD in the Release package • Update the SW Release package as I1.5.01.00-2 containing the CDFCB-X Vol. VI Part 2 Rev A.1 • Updated Release package is archived in CLASS (this needs to be worked) • Use the same Software Version number to find the updated Documentation in CLASS • N_NPOESS_Document_Ref • This includes the exact filename of the CDFCB-X Volume. If a change is made to a Revision, from A to A.1, the document references in this Metadata on all the delivered products will be obsolete. • It would not be possible to update all delivered copies of the products

  6. Updated Solution • Possible Updated solution • Change the definition of the N_NPOESS_Document_RefMetadata. • Instead of exact filenames, use document numbers and generic names. • When a Revision update is made form A to A.1, the document number and generic name stays constant • Users will need to use the Document number and Software version to find the correct revision of the document • CLASS Update • When CLASS ingests a Release package, a “key” may be needed that links the SW Version and the Document Number • Example • Release package I1.5.01.00-1 has CDFCB-X Vol. VI Part 2 Rev A • N_NPOESS_Document_Ref = DOC: D34862-04-02 NPOESS-CDFCB-X-Vol-IV-Part-2; XML: D34862-04-02 NPOESS-CDFCB-X-Vol-IV-Part-2 CrIMSS-EDR-PP; OAD: D37021 OAD-CrIMSS-EDR • Release package I1.5.01.00-2 changes CDFCB-X Vol. VI Part 2 Rev A.1 • N_NPOESS_Document_Ref is still valid (May need to adjust XML document numbers) • In CLASS – Document can be found as: I1.5.01.00-D34862-04-02

More Related