Filling Out the Ingest LDD Attributes

From The SBN PDS4 Wiki
Jump to: navigation, search

These attributes, located at the top of the <Ingest_LDD> class, provide parameters relevant to the dictionary as a whole. As such, most of them are required.


<name>

REQUIRED

This is the name of the dictionary to be produced. This is the title string that users will see in, for example, search results if they are looking through the dictionary database. Avoid abbreviations, no matter how obvious they may seem, as this title could still be popping up in search results 50 years from now.

<ldd_version_id>

REQUIRED

This is the version number for the dictionary as a whole. There is no specific format enforced on the value, but you should do something reasonable here. You will also need to remember to update it according to whatever rules you might have decided on for the various version levels you display. This version number, munged based on assumptions that it will look like a PDS4 Information Model version number, is used to formulate output file names. Note that this means that not changing this could result in older versions of the output files being overwritten.

<full_name>

REQUIRED

This field should contain the full name of the person, team, or institution that is officially responsible for the content of the dictionary being produced. For most dictionaries in active development, this will be the name of a person. For very large development projects this might be the name of a team tasked with collecting and maintaining the dictionary input from a variety of sources.

<steward_id>

REQUIRED

This field identifies the PDS node that will be permanently responsible for the dictionary contents, once the dictionary is reviewed and accepted for archiving. It must be single-valued, so use the lead PDS node if multiple nodes are involved. The valid values you might plausibly use are all lower-case node abbreviations:

atm - Atmospheres
geo - Geosciences
img - Imaging
naif - Navigation and Ancillary Information Facility
pds - PDS (might be used for legacy data conversion)
ppi - Planetary Plasma Interations
rings - Planetary Rings
rs - Radioscience
sbn - Small Bodies Node

<namespace_id>

REQUIRED

This is not, in fact, the namespace, but rather the permanent abbreviation reserved for and assigned to this dictionary by the PDS. You will get this value from your PDS node consultant. It will generally be a lowercase abbreviation for your mission or project that is not likely to collide with any other abbreviations any time soon. Sometimes not so easy.

This abbreviation is used to formulate the actual namespace ID, and is also used by LDDTool in generating the output file names.

<external_property_maps_id>

OPTIONAL

This attribute is in support of a feature still in development, but is currently undocumented. Avoid it.

<comment>

OPTIONAL

This is an optional, free-format text field you can use to provide internal documentation, notes to yourself, or similar remarks relevant to the Ingest_LDD content. These comments are not transferred to the LDDTool output.

<last_modification_date_time>

REQUIRED

This is required to contain both a date and a time, but must be updated by hand. The format is the ISO standard YYYY-MM-DDThh:mm:ss.sss format, where T is literal and the numbers must be zero-padded on the left as needed. You can use 24-hour time format, if you like. The only optional part is the fractional seconds (or fractional minutes in 24-hour format).