Determine ideal structural metadata for each GIS data type

[thatbudakguy]

prereq to #673 and to other tickets related to directly accessing files in stacks.

we need a table that defines each of the files that is generated by the gisAssemblyWF and their attributes (publish, shelve, preserve, etc.) for each of the existing (and coming soon?) GIS data types in the SSDI (Shapefile, geoTIFF, etc).

[thatbudakguy]

Vector

Shapefile

Data

Resource (1): object Label: Data	file name	type	role	publish	shelve	preserve	notes
layer.shp	application/vnd.shp	Master	✓	✓	✓	geometry for shapefile, required
layer.shx	application/vnd.shx	Master	✓	✓	✓	offsets for shapefile, required
layer.dbf	application/vnd.dbf	Master	✓	✓	✓	feature table for shapefile, required
layer.sbn	binary	Master	✓	✓	✓	spatial index, optional
layer.sbx	binary	Master	✓	✓	✓	spatial index, optional
layer.prj	text/plain	Master	✓	✓	✓	defines projection, optional
layer.cpg	text/plain	Master	✓	✓	✓	defines encoding, optional
index_map.geojson	application/json	Master	✓	✓	✓	index map, optional

Metadata

Resource (2): object Label: Metadata	file name	type	role	publish	shelve	preserve	notes
layer.shp.xml	application/xml	Master	✓	✓	✓	metadata in ESRI ArcCatalog format
layer-iso19139.xml	application/xml	Derivative	✓	✓	metadata in ISO 19139 format
layer-iso19110.xml	application/xml	Derivative	✓	✓	feature table in ISO 19110 format
layer-fgdc.xml	application/xml	Derivative	✓	✓	metadata in FGDC format

Preview

Resource (3): preview Label: Preview	file name	type	role	publish	shelve	preserve	notes
prevew.jpg	image/jpeg	Master	✓	✓	✓	can generate automatically

GeoJSON

Data

Resource (1): object Label: Data	file name	type	role	publish	shelve	preserve	notes
layer.geojson	application/json	Master	✓	✓	✓	required

Metadata

Resource (2): object Label: Metadata	file name	type	role	publish	shelve	preserve	notes
layer.geojson.xml	application/xml	Master	✓	✓	✓	metadata in ESRI ArcCatalog format
layer-iso19139.xml	application/xml	Derivative	✓	✓	metadata in ISO 19139 format
layer-iso19110.xml	application/xml	Derivative	✓	✓	feature table in ISO 19110 format
layer-fgdc.xml	application/xml	Derivative	✓	✓	metadata in FGDC format

Preview

Resource (3): preview Label: Preview	file name	type	role	publish	shelve	preserve	notes
prevew.jpg	image/jpeg	Master	✓	✓	✓	can generate automatically

Raster

GeoTIFF

Data

Resource (1): object Label: Data	file name	type	role	publish	shelve	preserve	notes
layer.tif	image/tiff	Master	✓	✓	✓	raster data, required
layer.tfw	text/plain	Master	✓	✓	✓	world file, optional
layer.ovr	binary	Master	✓	✓	✓	pyramid layers, optional
layer.rrd	binary	Master	✓	✓	✓	pyramid layers, optional
layer.aux	binary	Master	✓	✓	✓	auxiliary statistics, optional
layer.aux.xml	application/xml	Master	✓	✓	✓	auxiliary statistics, optional

Metadata

Resource (2): object Label: Metadata	file name	type	role	publish	shelve	preserve	notes
layer.tif.xml	application/xml	Master	✓	✓	✓	metadata in ESRI ArcCatalog format
layer-iso19139.xml	application/xml	Derivative	✓	✓	metadata in ISO 19139 format
layer-fgdc.xml	application/xml	Derivative	✓	✓	metadata in FGDC format

Preview

Resource (3): preview Label: Preview	file name	type	role	publish	shelve	preserve	notes
prevew.jpg	image/jpeg	Master	✓	✓	✓	can generate automatically

COG

Data

Resource (1): object Label: Data	file name	type	role	publish	shelve	preserve	notes
layer.tif	image/tiff	Master	✓	✓	✓	required

Metadata

Resource (2): object Label: Metadata	file name	type	role	publish	shelve	preserve	notes
layer.tif.xml	application/xml	Master	✓	✓	✓	metadata in ESRI ArcCatalog format
layer-iso19139.xml	application/xml	Derivative	✓	✓	metadata in ISO 19139 format
layer-fgdc.xml	application/xml	Derivative	✓	✓	metadata in FGDC format

Preview

Resource (3): preview Label: Preview	file name	type	role	publish	shelve	preserve	notes
prevew.jpg	image/jpeg	Master	✓	✓	✓	can generate automatically

[aaron-collier]

@thatbudakguy I added you as assigned on #712 as I think this will be part of the output of "documentation". Thanks for this!

[thatbudakguy]

Completed the table and added this info to the wiki page (https://github.com/sul-dlss/gis-robot-suite/wiki/GIS-SSDI-Data-input-formats-and-derivatives), so closing.

[lwrubel]

Thanks, this table is super helpful!