Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions apps/docs/docs/introduction/key-concepts/datastreams.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ For example, you could have a datastream of:
- a Sampled Medium of Surface Water
- measured using A YSI EXO2 Multiparameter Water Quality Sonde sensor

A datastream acts as the hub for understanding what's being measured at a given location. For example, if you want to know what's being measured, you'll ask the API for `datastream.observed_property` which will return 'Water temperature' along with metadata describing exactly what 'Water temperature' means to your organization. If you want to know how the observations are produced, you'd ask for `datastream.method`, which may include instrument details when applicable. If you want the actual data, you'll call `datastream.observations`.
A datastream acts as the hub for understanding what's being measured at a given location. For example, if you want to know what's being measured, you'll ask the API for `datastream.observedProperty` which will return 'Water temperature' along with metadata describing exactly what 'Water temperature' means to your organization. If you want to know how the observations are produced, you'd ask for `datastream.method`, which may include instrument details when applicable. If you want the actual data, you'll call `datastream.observations`.

## Naming Datastreams

The `datastream.name` must be unique and unambiguous within its monitoring site. Use a short, data-focused name and do not append the monitoring site name. HydroServer applications provide the monitoring-site context when it is needed.
The `datastream.name` must be unique and unambiguous within its monitoring site. Use a short, data-focused name and do not append the monitoring site name. HydroServer applications provide the monitoring site context when it is needed.

Use this recommended convention:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ HydroServer's data model and Data Management API use `MonitoringSite`. The Senso

## key:value tagging system

Most of the metadata you will need is already supported by HydroServer’s API. However, for organization-specific or custom information, tags offer a flexible way to store additional metadata that doesn’t fit into the standard fields. Tags are extra, customizable, key:value pairs that provide more context or categorization to the data. For example, you might use tags to link to your sites to 3rd party websites: `website:https://my-website.com`. You can use tags to specify values for additional attributes of a site, or you can point to external websites or URLs where more detailed information about that site might be maintained.
Most of the metadata you will need is already supported by HydroServer’s API. However, for organization-specific or custom information, tags offer a flexible way to store additional metadata that doesn’t fit into the standard fields. Tags are extra, customizable, key:value pairs that provide more context or categorization to the data. For example, you might use tags to store the USGS Hydrologic Unit your site is located within: `huc_12:160102030307`.
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ The following table is a comparison of permissions for the owners, editors, and

Remote systems or applications may need to authenticate with HydroServer in data-loading, retrieval, or analysis workflows. Giving these systems your username and password is risky because they receive all of your permissions. Instead, create a service account, assign it the minimum workspace role required for its job, and authenticate it with the generated API key. Service accounts can use roles such as Data Loader, Editor, or Viewer just like user collaborators.

## Data Visibility
## Data Privacy and Visibility

It's assumed in a HydroServer setup that you want your data to be publicly viewable. By default, when you load data to a datastream, any guest of your site will be able to view that data and all related metadata. These visibility setting can be changed at the workspace, site, and datastream levels.
It's assumed in a HydroServer setup that you want your data to be publicly viewable. By default, when you load data to a datastream, any guest of your site will be able to view that data and all related metadata. These privacy settings can be changed at the workspace, site, and datastream levels.

1. **Workspace Privacy**: This setting determines whether a workspace is private or public. If your workspace is private, all sites, datastreams, and associated metadata will only be accesible to the workspace owner and collaborators.
1. **Workspace Privacy**: This setting determines whether a workspace is private or public. If your workspace is private, all sites, datastreams, and associated metadata will only be accessible to the workspace owner and collaborators.

2. **Site Privacy**: This setting determines whether your site is private or public. If you set your site to private, it means that only the workspace owners and collaborators can view the site and all associated datastreams through the website or API. This is like having a closed folder that only selected people can open. This allows users to set some sites as public and others as private within a public workspace.

Expand All @@ -43,4 +43,4 @@ It's assumed in a HydroServer setup that you want your data to be publicly viewa

These privacy settings work in a hierarchical, conditional manner:

If you set the **Site Privacy** to private (`monitoring_site.is_private`), then both **Datastream Visibility** (`datastream.is_visible`) and **Datastream Data Visibility** (`datastream.is_data_visible`) will automatically be set to private as well. However, if the site is public, you can still control the visibility of each datastream and its data individually.
If you set the **Site Privacy** to private (`monitoringSite.isPrivate`), then both **Datastream Provacy** (`datastream.isPrivate`) and **Datastream Data Visibility** (`datastream.isVisible`) will automatically be set to private as well. However, if the site is public, you can still control the visibility of each datastream and its data individually.
Binary file not shown.
Binary file modified apps/docs/docs/public/hydroserver-101/access-control.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified apps/docs/docs/public/hydroserver-101/add-workspace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed apps/docs/docs/public/hydroserver-101/api-key.png
Binary file not shown.
Binary file modified apps/docs/docs/public/hydroserver-101/data-visualization.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file modified apps/docs/docs/public/hydroserver-101/datastream-table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file modified apps/docs/docs/public/hydroserver-101/new-datastream.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified apps/docs/docs/public/hydroserver-101/site-details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified apps/docs/docs/public/hydroserver-101/site-form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion apps/docs/docs/references/data-dictionary.md
Original file line number Diff line number Diff line change
Expand Up @@ -410,7 +410,7 @@ A Payload describes how the response body returned by the extractor should be pa

## DataConnectionNotification

A DataConnectionNotification records the configuration for the periodic data freshness notification associated with a DataConnection.
A DataConnectionNotification records the configuration for the periodic task run summary email associated with a DataConnection.

| Required | Attribute | Definition | Data Type |
| -------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
Expand Down
Loading
Loading