Skip to content

Commit

Permalink
Updated Science Catalog page
Browse files Browse the repository at this point in the history
Made some minor tweaks to the Science Catalog page
  • Loading branch information
blakemassey-usfws committed Jul 3, 2024
1 parent 31a71f8 commit f8c9dd0
Show file tree
Hide file tree
Showing 9 changed files with 267 additions and 40 deletions.
Binary file modified _site/assets/metadata_system_architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
256 changes: 235 additions & 21 deletions _site/content/science_catalog.html

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion _site/content/settings.html
Original file line number Diff line number Diff line change
Expand Up @@ -689,7 +689,8 @@ <h2 class="anchored" data-anchor-id="general-settings">General Settings</h2>
<h2 class="anchored" data-anchor-id="sa-specific-settings">SA-Specific Settings</h2>
<p><em>These must be implemented before you begin creating metadata records.</em></p>
<p><strong>1. Importing from ScienceBase</strong> In the Defaults section, set the default Import URL to import items from ScienceBase with the following: <a href="https://api.sciencebase.gov/sbmd-service/mdjson/" class="uri">https://api.sciencebase.gov/sbmd-service/mdjson/</a>.</p>
<p><strong>2. Metadata Repositories</strong>: In the Defaults section, add two Metadata Repositories.</p>
<p><strong>2. MdTranslator</strong> In the Defaults section, set the default mdTranslator API URL to use the latest version of the translator with the following: <a href="https://api.sciencebase.gov/mdTranslator/api/v3/translator" class="uri">https://api.sciencebase.gov/mdTranslator/api/v3/translator</a>.</p>
<p><strong>3. Metadata Repositories</strong>: In the Defaults section, add two Metadata Repositories.</p>
<ol type="1">
<li>Select <strong>ScienceCatalog</strong> from the Repository drop-down menu. Enter “SA Science Catalog” as the collection title. It is important that the text is entered exactly as written to be included in the Science Catalog.</li>
<li>Select <strong>data.gov</strong> from the Repository drop-down menu. For the collection title, enter “Data.gov USFWS Science Applications”.</li>
Expand Down
2 changes: 1 addition & 1 deletion _site/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -654,7 +654,7 @@ <h1 class="title">USFWS Science Applications Metadata Guidance</h1>
<section id="introduction" class="level2">
<h2 class="anchored" data-anchor-id="introduction">Introduction</h2>
<p>This manual describes the requirements and best practices for the creation of high-quality and consistent metadata records for projects and products for USFWS Science Applications (SA) Program. These metadata requirements conform to the standardized metadata format agreed upon by the SA Data Management Working Group and meet USFWS policy requirements for data management. This metadata is aggregated and organized in the SA Science Catalog, where SA projects and products are discoverable, accessible, and usable.</p>
<p>This is a working draft that will continue to be edited. Please refresh this manual every time you open it to ensure you are viewing the most recent version. <strong>Last updated:</strong> <strong>21 June, 2024</strong>. If you have questions or concerns regarding this guidance, please contact the FWS SA National Data Steward ([email protected]) or Blake Massey ([email protected]).</p>
<p>This is a working draft that will continue to be edited. Please refresh this manual every time you open it to ensure you are viewing the most recent version. <strong>Last updated:</strong> <strong>03 July, 2024</strong>. If you have questions or concerns regarding this guidance, please contact the FWS SA National Data Steward ([email protected]) or Blake Massey ([email protected]).</p>
</section>
<section id="usfws-data-management-integration" class="level2">
<h2 class="anchored" data-anchor-id="usfws-data-management-integration">USFWS Data Management Integration</h2>
Expand Down
21 changes: 15 additions & 6 deletions _site/search.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"href": "index.html",
"title": "USFWS Science Applications Metadata Guidance",
"section": "",
"text": "This manual describes the requirements and best practices for the creation of high-quality and consistent metadata records for projects and products for USFWS Science Applications (SA) Program. These metadata requirements conform to the standardized metadata format agreed upon by the SA Data Management Working Group and meet USFWS policy requirements for data management. This metadata is aggregated and organized in the SA Science Catalog, where SA projects and products are discoverable, accessible, and usable.\nThis is a working draft that will continue to be edited. Please refresh this manual every time you open it to ensure you are viewing the most recent version. Last updated: 21 June, 2024. If you have questions or concerns regarding this guidance, please contact the FWS SA National Data Steward ([email protected]) or Blake Massey ([email protected]).",
"text": "This manual describes the requirements and best practices for the creation of high-quality and consistent metadata records for projects and products for USFWS Science Applications (SA) Program. These metadata requirements conform to the standardized metadata format agreed upon by the SA Data Management Working Group and meet USFWS policy requirements for data management. This metadata is aggregated and organized in the SA Science Catalog, where SA projects and products are discoverable, accessible, and usable.\nThis is a working draft that will continue to be edited. Please refresh this manual every time you open it to ensure you are viewing the most recent version. Last updated: 03 July, 2024. If you have questions or concerns regarding this guidance, please contact the FWS SA National Data Steward ([email protected]) or Blake Massey ([email protected]).",
"crumbs": [
"Introduction"
]
Expand All @@ -14,7 +14,7 @@
"href": "index.html#introduction",
"title": "USFWS Science Applications Metadata Guidance",
"section": "",
"text": "This manual describes the requirements and best practices for the creation of high-quality and consistent metadata records for projects and products for USFWS Science Applications (SA) Program. These metadata requirements conform to the standardized metadata format agreed upon by the SA Data Management Working Group and meet USFWS policy requirements for data management. This metadata is aggregated and organized in the SA Science Catalog, where SA projects and products are discoverable, accessible, and usable.\nThis is a working draft that will continue to be edited. Please refresh this manual every time you open it to ensure you are viewing the most recent version. Last updated: 21 June, 2024. If you have questions or concerns regarding this guidance, please contact the FWS SA National Data Steward ([email protected]) or Blake Massey ([email protected]).",
"text": "This manual describes the requirements and best practices for the creation of high-quality and consistent metadata records for projects and products for USFWS Science Applications (SA) Program. These metadata requirements conform to the standardized metadata format agreed upon by the SA Data Management Working Group and meet USFWS policy requirements for data management. This metadata is aggregated and organized in the SA Science Catalog, where SA projects and products are discoverable, accessible, and usable.\nThis is a working draft that will continue to be edited. Please refresh this manual every time you open it to ensure you are viewing the most recent version. Last updated: 03 July, 2024. If you have questions or concerns regarding this guidance, please contact the FWS SA National Data Steward ([email protected]) or Blake Massey ([email protected]).",
"crumbs": [
"Introduction"
]
Expand Down Expand Up @@ -88,7 +88,7 @@
"href": "content/settings.html#sa-specific-settings",
"title": "Settings",
"section": "SA-Specific Settings",
"text": "SA-Specific Settings\nThese must be implemented before you begin creating metadata records.\n1. Importing from ScienceBase In the Defaults section, set the default Import URL to import items from ScienceBase with the following: https://api.sciencebase.gov/sbmd-service/mdjson/.\n2. Metadata Repositories: In the Defaults section, add two Metadata Repositories.\n\nSelect ScienceCatalog from the Repository drop-down menu. Enter “SA Science Catalog” as the collection title. It is important that the text is entered exactly as written to be included in the Science Catalog.\nSelect data.gov from the Repository drop-down menu. For the collection title, enter “Data.gov USFWS Science Applications”.\n\n\n\n\nScience Applications settings\n\n\n\n\n\n\n\n\nThe metadata repository information must be exactly the same for each record with no variations in spelling, spaces, capitalization, etc. Specifying this information in Settings is the best way to ensure the repository information will be consistent across records. It is strongly recommended that you do not type these in by hand on individual metadata records.\n\n\n\n3. Parent Identifier: Under publishing, enter the ScienceBase identifier for your SA Region’s ScienceBase project folder (see table below) in the “Default Parent Identifier” field.\n\n\n\n\nUSFWS Region\nParent Identifier\n\n\n\n\nRegion 1\n5b4e1c5ae4b06a6dd17df2d5\n\n\nRegion 2\n5b6469d3e4b006a11f733900\n\n\nRegion 3\n5b6469e5e4b006a11f733902\n\n\nRegion 4\n5b6469efe4b006a11f733904\n\n\nRegion 5\n5b6469f8e4b006a11f733906\n\n\nRegion 6\n5b646a02e4b006a11f733908\n\n\nRegion 7\n5b646a2fe4b006a11f73390c\n\n\nRegion 8\n5b646a38e4b006a11f73390e\n\n\nHeadquarters\n5b646a14e4b006a11f73390a",
"text": "SA-Specific Settings\nThese must be implemented before you begin creating metadata records.\n1. Importing from ScienceBase In the Defaults section, set the default Import URL to import items from ScienceBase with the following: https://api.sciencebase.gov/sbmd-service/mdjson/.\n2. MdTranslator In the Defaults section, set the default mdTranslator API URL to use the latest version of the translator with the following: https://api.sciencebase.gov/mdTranslator/api/v3/translator.\n3. Metadata Repositories: In the Defaults section, add two Metadata Repositories.\n\nSelect ScienceCatalog from the Repository drop-down menu. Enter “SA Science Catalog” as the collection title. It is important that the text is entered exactly as written to be included in the Science Catalog.\nSelect data.gov from the Repository drop-down menu. For the collection title, enter “Data.gov USFWS Science Applications”.\n\n\n\n\nScience Applications settings\n\n\n\n\n\n\n\n\nThe metadata repository information must be exactly the same for each record with no variations in spelling, spaces, capitalization, etc. Specifying this information in Settings is the best way to ensure the repository information will be consistent across records. It is strongly recommended that you do not type these in by hand on individual metadata records.\n\n\n\n3. Parent Identifier: Under publishing, enter the ScienceBase identifier for your SA Region’s ScienceBase project folder (see table below) in the “Default Parent Identifier” field.\n\n\n\n\nUSFWS Region\nParent Identifier\n\n\n\n\nRegion 1\n5b4e1c5ae4b06a6dd17df2d5\n\n\nRegion 2\n5b6469d3e4b006a11f733900\n\n\nRegion 3\n5b6469e5e4b006a11f733902\n\n\nRegion 4\n5b6469efe4b006a11f733904\n\n\nRegion 5\n5b6469f8e4b006a11f733906\n\n\nRegion 6\n5b646a02e4b006a11f733908\n\n\nRegion 7\n5b646a2fe4b006a11f73390c\n\n\nRegion 8\n5b646a38e4b006a11f73390e\n\n\nHeadquarters\n5b646a14e4b006a11f73390a",
"crumbs": [
"Settings"
]
Expand Down Expand Up @@ -1599,21 +1599,30 @@
"href": "content/science_catalog.html",
"title": "Science Catalog",
"section": "",
"text": "A more detailed look at the metadata requirements and architecture behind the Science Applications Science Catalog."
"text": "A more detailed look at the metadata requirements and architecture behind the Science Applications Science Catalog.",
"crumbs": [
"Science Catalog"
]
},
{
"objectID": "content/science_catalog.html#overview",
"href": "content/science_catalog.html#overview",
"title": "Science Catalog",
"section": "Overview",
"text": "Overview\nThe SA Science Catalog collates the metadata from all FWS regions and Headquarters. It allows for user-defined searching and filtering of projects and products as well as access to products for download. Users can see what has been funded, which can help prevent duplication of work. The SA Science Catalog also enables reporting, such as funding summaries or project examples based on particular geographies, species, organization, year, or other categories of interest."
"text": "Overview\nThe Science Application Science Catalog collates the metadata from all FWS regions and Headquarters. It allows users to search for and filter projects and products and download products. Users can see what has been funded, which can help prevent duplication of work. The SA Science Catalog also enables reporting, such as funding summaries or project examples based on particular geographies, species, organization, year, or other categories of interest.",
"crumbs": [
"Science Catalog"
]
},
{
"objectID": "content/science_catalog.html#architecture",
"href": "content/science_catalog.html#architecture",
"title": "Science Catalog",
"section": "Architecture",
"text": "Architecture\nAt present, SA creates and edits metadata in mdEditor and then publish the metadata to ScienceBase, where it can be channeled to the SA Science Catalog and Data.gov. The mdTranslator tool is integrated with mdEditor so you can create metadata once, and then convert and publish the metadata in your desired format, such as mdJSON for the SA Science Catalog, sbJSON for ScienceBase, XML for data.gov, and FGDC for geospatial data.\n\n\n\nA basic diagram detailing the Science Applications metadata system architecture\n\n\n\nItems are imported from a database (like ScienceBase), or created directly in mdEditor.\nmdJSON files can also be stored in a local repository and then transmitted via a web service to ScienceBase. Alternately, the local files can be exported to a web accessible folder and then harvested by ScienceBase.\nThe mdTranslator converts the mdJSON files into sbJSON (the ScienceBase JSON format), and XML.\nItems are exported from ScienceBase to: Data.gov as XML; the SA Science Catalog website as Projects and Products; or into mdEditor as mdJSON."
"text": "Architecture\nAt present, SA creates and edits metadata in mdEditor and then publish the metadata to ScienceBase, where it can be channeled to the SA Science Catalog and Data.gov. The mdTranslator tool is integrated with mdEditor so you can create metadata once, and then convert and publish the metadata in your desired format, such as mdJSON for the SA Science Catalog, sbJSON for ScienceBase, XML for data.gov, and FGDC for geospatial data.\n\n\n\nA basic diagram detailing the Science Applications metadata system architecture\n\n\n\nItems are imported from a database (like ScienceBase), or created directly in mdEditor.\nmdJSON files can also be stored in a local repository and then transmitted via a web service to ScienceBase. Alternately, the local files can be exported to a web accessible folder and then harvested by ScienceBase.\nThe mdTranslator converts the mdJSON files into sbJSON (the ScienceBase JSON format), and XML.\nItems are exported from ScienceBase to: Data.gov as XML; the SA Science Catalog website as Projects and Products; or into mdEditor as mdJSON.",
"crumbs": [
"Science Catalog"
]
},
{
"objectID": "content/trouble_shooting/qa_qc_fixes.html",
Expand Down
4 changes: 2 additions & 2 deletions _site/sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</url>
<url>
<loc>https://studious-adventure-wo15nv1.pages.github.io/content/settings.html</loc>
<lastmod>2024-03-31T15:33:04.163Z</lastmod>
<lastmod>2024-06-21T17:43:25.353Z</lastmod>
</url>
<url>
<loc>https://studious-adventure-wo15nv1.pages.github.io/content/roles_and_responsibilities.html</loc>
Expand Down Expand Up @@ -266,7 +266,7 @@
</url>
<url>
<loc>https://studious-adventure-wo15nv1.pages.github.io/content/science_catalog.html</loc>
<lastmod>2024-03-31T15:27:04.700Z</lastmod>
<lastmod>2024-07-03T12:26:59.147Z</lastmod>
</url>
<url>
<loc>https://studious-adventure-wo15nv1.pages.github.io/content/trouble_shooting/qa_qc_fixes.html</loc>
Expand Down
Binary file not shown.
Binary file modified assets/metadata_system_architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 12 additions & 9 deletions content/science_catalog.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ Science Applications Science Catalog.

## Overview

The SA Science Catalog collates the metadata from all FWS regions and
Headquarters. It allows for user-defined searching and filtering of projects and
products as well as access to products for download. Users can see what has been
funded, which can help prevent duplication of work. The SA Science Catalog also
enables reporting, such as funding summaries or project examples based on
particular geographies, species, organization, year, or other categories of
interest.
The [Science Application Science Catalog](https://www.fws.gov/science/catalog)
collates the metadata from all FWS regions and Headquarters. It allows users to
search for and filter projects and products and download products. Users can
see what has been funded, which can help prevent duplication of work. The SA
Science Catalog also enables reporting, such as funding summaries or project
examples based on particular geographies, species, organization, year, or other
categories of interest.

## Architecture

Expand All @@ -28,7 +28,8 @@ metadata once, and then convert and publish the metadata in your desired format,
such as mdJSON for the SA Science Catalog, sbJSON for ScienceBase, XML for
data.gov, and FGDC for geospatial data.

![A basic diagram detailing the Science Applications metadata system architecture](/assets/metadata_system_architecture.png){width="800"}
![A basic diagram detailing the Science Applications metadata system
architecture](/assets/metadata_system_architecture.png){width="800"}

1. Items are imported from a database (like ScienceBase), or created directly
in mdEditor.
Expand All @@ -40,6 +41,8 @@ data.gov, and FGDC for geospatial data.
4. Items are exported from ScienceBase to: Data.gov as XML; the SA Science
Catalog website as Projects and Products; or into mdEditor as mdJSON.

```{=html}
<!---
![A diagram of the Science Applications metadata system architecture that focuces on the relationship between MdEditor, ScienceBase, Data.gov, and the Science Applications Science Catalog. Blue arrow action are performed by the user. After a user publishes to ScienceBase from mdEditor, the dark brown arrow actions are triggered automatically by mdEditor and ScienceBase webservices. Green arrow actions are performed automatically by the external catalogs.](/assets/metadata_system_architecture2.png){width="800"}
--->
--->
```

0 comments on commit f8c9dd0

Please sign in to comment.