Difference between revisions of "PDS4 Product Labels, Step by Step"

From The SBN Wiki
Jump to navigation Jump to search
(Creation)
 
(Creation - Safety Save)
Line 1: Line 1:
 
This page provides step-by-step information for filling out a PDS4 label.  There are several distinct types of labels that you will encounter, with different structural details, though there is some overlap. In each case, the label is divided into several major section, listed below.
 
This page provides step-by-step information for filling out a PDS4 label.  There are several distinct types of labels that you will encounter, with different structural details, though there is some overlap. In each case, the label is divided into several major section, listed below.
 +
 +
You will find this and the associated pages most useful if you have a label in front of you to work on or reference.  You can start with a template, or create a label of one of the following types from scratch via the PDS4 master schema,
 +
 +
The collection of SBN PDS4 templates is on the [[Templates]] page of this Wiki.
 +
 +
The PDS4 master schema can be downloaded from http://pds.jpl.nasa.gov/pds4/schema/released/ - select the most recent ''PDS4_PDS_*'' schema from the ''bottom'' of the page, and if you have a schema-aware editor like ''Eclipse'', you can get a general idea of how to create a new XML label from scratch from our [[Eclipse: Creating a New XML File from an XSD Schema File]] page.
  
 
== Observational Product Label Structure ==
 
== Observational Product Label Structure ==
 +
 +
The '''Product_Observational''' is overwhelmingly the most common instance of this you will encounter, and also the most complex in terms of descriptive options.  '''Product_SPICE_Kernel''' is closely related.
  
 
In a typical observational product, there are four major sections, and occasionally there's a fifth:
 
In a typical observational product, there are four major sections, and occasionally there's a fifth:
Line 13: Line 21:
 
== Document Product Label Structure ==
 
== Document Product Label Structure ==
  
Documents, which consist of at least a single file and may comprise an entire directory tree, replace the '''File_Area''' of the observational product label with a Document_Format_Set that describes the set of files constituting one complete version of a document. The major sections of a document label are:
+
Documents, which consist of at least a single file and may comprise an entire directory tree, replace the '''File_Area''' of the observational product label with a Document_Format_Set that describes the set of files constituting one complete version of a document. '''Product_Document''' is the label format for traditional (i.e., mainly textual) documentation.
 +
 
 +
The major sections of a document label are:
  
 
# '''Identification Area''' - as in the observational product label. <br/>[[Filling Out the Identification_Area Class]]
 
# '''Identification Area''' - as in the observational product label. <br/>[[Filling Out the Identification_Area Class]]
Line 20: Line 30:
 
# '''Reference List''' - as in the observational product label.  This section is also optional in document prodducts. <br>[[Filling Out the Reference_List Classes]]
 
# '''Reference List''' - as in the observational product label.  This section is also optional in document prodducts. <br>[[Filling Out the Reference_List Classes]]
 
# '''Document Format Set''' - This class structure identifies and describes all the files that constitue one copy of the document in one electronic format.  Often this will be a single UTF-8 text file or a PDF/A file, but it may also describe a text file with a series of graphics or image files.  There must be at least one of these in the document label, and all formats of the document should be described in the same label. <br/> [[Filling Out the Document_Format_Set Classes]]
 
# '''Document Format Set''' - This class structure identifies and describes all the files that constitue one copy of the document in one electronic format.  Often this will be a single UTF-8 text file or a PDF/A file, but it may also describe a text file with a series of graphics or image files.  There must be at least one of these in the document label, and all formats of the document should be described in the same label. <br/> [[Filling Out the Document_Format_Set Classes]]
 +
 +
There are also specific product types for documentation that is image-based, and a special-case label for XML Schema files.  These labels are simpler than the standard
 +
'''Product_Document''' label, and use a ''File_Area''-type class rather than the ''Document_Format_Set'' class to point to their constituent files.
 +
 +
* '''Product_Browse''' and '''Product_Thumbnail''' are used to label images used for supporting user access and file selection.
 +
* '''Product_XML_Schema''' is used to label XSD schema documents (e.g., local dictionary schemas) when they go into the archive,
 +
 +
== Context Product Label Structure ==
 +
 +
Context products provide high level descriptive information about the hardware, facilities, targets and phenomena involved in producing the observational data products. Existing context products can and should be referenced by data preparers creating new products whenever possible.  When you have to write your own, here's what's in it:
 +
 +
# '''Identification Area''' - as in the observational product label. <br/>[[Filling Out the Identification_Area Class]]
 +
# '''Discipline Area''' - An optional are where classes from discipline dictionaries can be inserted, as needed, to provide additional parameters for info, or for searching. <br/>[[Filling Out the Discipline_Area]]
 +
# '''Reference List''' - as in the observational product label. This is optional in context product labels. <br>[[Filling Out the Reference_List Classes]]
 +
# '''Context Data Object''' - This will be a descriptive class depending on the type of context concept you're describing.  Each context product will have exactly one of there. <br/>[[Filling Out Context Object Classes]]
 +
 +
== Collection Product Label Structure ==
 +
 +
A collection is itself a product - it's a product that defines and describes a significant relationship among a list of other, selected products (specifically, products that are not themselves collections or bundles).  Products listed in a collection will be all of the same type (observational, document, context, etc.), and thus comprise a collection of that type (i.e., an observational collection, a document collection, and so on.)  A collection product has a structure that is similar to an observational product:
 +
 +
# '''Identification Area''' - as in the observational product label. <br/>[[Filling Out the Identification_Area Class]]
 +
# '''Context Area''' - as in document product labels.  This class is optional in context products. <br/>[[Filling Out the Observation_Area Classes]]
 +
# '''Reference List''' - as in the observational product label. This is optional in context product labels. <br>[[Filling Out the Reference_List Classes]]
 +
# '''Collection Area''' - This class defines the collection type.  It is required, as you might expect. <br/>[[Filling Out the Collection Class]]
 +
# '''Inventory File Area''' - Similar in structure to the '''File_Area_Observational''', this area has many more constraints on it, reflecting the requirements for Collection inventory table formatting and content.  It is required to be present. <br/> [[Filling Out the File_Area_Invetory Classes]]

Revision as of 16:39, 9 November 2012

This page provides step-by-step information for filling out a PDS4 label. There are several distinct types of labels that you will encounter, with different structural details, though there is some overlap. In each case, the label is divided into several major section, listed below.

You will find this and the associated pages most useful if you have a label in front of you to work on or reference. You can start with a template, or create a label of one of the following types from scratch via the PDS4 master schema,

The collection of SBN PDS4 templates is on the Templates page of this Wiki.

The PDS4 master schema can be downloaded from http://pds.jpl.nasa.gov/pds4/schema/released/ - select the most recent PDS4_PDS_* schema from the bottom of the page, and if you have a schema-aware editor like Eclipse, you can get a general idea of how to create a new XML label from scratch from our Eclipse: Creating a New XML File from an XSD Schema File page.

Observational Product Label Structure

The Product_Observational is overwhelmingly the most common instance of this you will encounter, and also the most complex in terms of descriptive options. Product_SPICE_Kernel is closely related.

In a typical observational product, there are four major sections, and occasionally there's a fifth:

  1. Identification Area - contains identifiers that distinguish this product from all others, This area is required in all labels regardless of type.
    Filling Out the Identification_Area Class
  2. Observation Area - contains information used to describe the observation and subsequent processing at a high level. This area is required in observational products.
    Filling Out the Observation_Area Classes
  3. Reference List - contains cross-references to internal products (e.g., calibration observations or documents) and/or external publications. This area is always optional.
    Filling Out the Reference_List Classes
  4. File Area - identifies the data file(s) and defines the data structures within observational products. Observational product labels must have at least one File Area.
    Filling Out the File_Area_Observational Classes
  5. File Area Supplemental, the structure of which is identical to the File Area. This section is optional.
    Filling Out the File_Area_Observational_Supplemental Classes

Document Product Label Structure

Documents, which consist of at least a single file and may comprise an entire directory tree, replace the File_Area of the observational product label with a Document_Format_Set that describes the set of files constituting one complete version of a document. Product_Document is the label format for traditional (i.e., mainly textual) documentation.

The major sections of a document label are:

  1. Identification Area - as in the observational product label.
    Filling Out the Identification_Area Class
  2. Document Area - This area contains what could be thought of as the "card catalog" information for the document being labels - that is, the description of the logical context of the document, like title and author.
    Filling Out the Document Class
  3. Context Area - This is the more general form of the Observation_Area of the observational product label. Fields required for observational products are optional here. In fact, this class is optional in document products.
    Filling Out the Observation_Area Classes
  4. Reference List - as in the observational product label. This section is also optional in document prodducts.
    Filling Out the Reference_List Classes
  5. Document Format Set - This class structure identifies and describes all the files that constitue one copy of the document in one electronic format. Often this will be a single UTF-8 text file or a PDF/A file, but it may also describe a text file with a series of graphics or image files. There must be at least one of these in the document label, and all formats of the document should be described in the same label.
    Filling Out the Document_Format_Set Classes

There are also specific product types for documentation that is image-based, and a special-case label for XML Schema files. These labels are simpler than the standard Product_Document label, and use a File_Area-type class rather than the Document_Format_Set class to point to their constituent files.

  • Product_Browse and Product_Thumbnail are used to label images used for supporting user access and file selection.
  • Product_XML_Schema is used to label XSD schema documents (e.g., local dictionary schemas) when they go into the archive,

Context Product Label Structure

Context products provide high level descriptive information about the hardware, facilities, targets and phenomena involved in producing the observational data products. Existing context products can and should be referenced by data preparers creating new products whenever possible. When you have to write your own, here's what's in it:

  1. Identification Area - as in the observational product label.
    Filling Out the Identification_Area Class
  2. Discipline Area - An optional are where classes from discipline dictionaries can be inserted, as needed, to provide additional parameters for info, or for searching.
    Filling Out the Discipline_Area
  3. Reference List - as in the observational product label. This is optional in context product labels.
    Filling Out the Reference_List Classes
  4. Context Data Object - This will be a descriptive class depending on the type of context concept you're describing. Each context product will have exactly one of there.
    Filling Out Context Object Classes

Collection Product Label Structure

A collection is itself a product - it's a product that defines and describes a significant relationship among a list of other, selected products (specifically, products that are not themselves collections or bundles). Products listed in a collection will be all of the same type (observational, document, context, etc.), and thus comprise a collection of that type (i.e., an observational collection, a document collection, and so on.) A collection product has a structure that is similar to an observational product:

  1. Identification Area - as in the observational product label.
    Filling Out the Identification_Area Class
  2. Context Area - as in document product labels. This class is optional in context products.
    Filling Out the Observation_Area Classes
  3. Reference List - as in the observational product label. This is optional in context product labels.
    Filling Out the Reference_List Classes
  4. Collection Area - This class defines the collection type. It is required, as you might expect.
    Filling Out the Collection Class
  5. Inventory File Area - Similar in structure to the File_Area_Observational, this area has many more constraints on it, reflecting the requirements for Collection inventory table formatting and content. It is required to be present.
    Filling Out the File_Area_Invetory Classes