Filling Out the Ingest LDD Attributes

From The SBN Wiki
Jump to navigation Jump to 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.

Last update: 29 July 2020, for IM version (1E00 schemas).



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.



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.



This attribute indicates the level of your dictionary (with respect to the constraints and requirements you have to meet). If you are a PDS Node steward creating a discipline dictionary (tighter constraints) for use by multiple missions/projects, use the value Discipline. Otherwise, use the value Mission (even if you're not technically a "mission").



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.



This field identifies the PDS node (or reserved namespace steward) 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 Node
geo - Geosciences Node
img - Cartographic and Imaging Services Node
naif - Navigation and Ancillary Information Facility
pds - PDS (might be used for legacy data conversion - your PDS node consultant will tell you if you should be using this steward_id)
ppi - Planetary Plasma Interactions Node
rings - Ring-Moon Systems Node
rs - Radioscience (your PDS node consultant will tell you if you need to use this steward_id)
sbn - Small Bodies Node



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.



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



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.



This date/time should be updated whenever the file is modified. 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 may truncate the time portion to whatever makes sense for you; omit the T separator if there is no time part at all.