# Getting Started

Configuring a SeaSketch project by an Administrator or owner of a project.

The new version of SeaSketch (code named "Next") sits at <https://www.seasketch.org>. The old version of SeaSketch is located at <https://legacy.seasketch.org>.&#x20;

To get started creating a new SeaSketch project, visit <https://www.seasketch.org/new-project>[. ](https://www.seasketch.org/new-project)Choose a project name, such as "Marine Spatial Planning in My Country". You may change this name later whenever you like. Then, enter a unique URL for your project, such as "msp-my-country". Note that you should choose wisely because these URLs cannot be changed.&#x20;

You have now created a new project and will be taken directly to the Settings Page located at, for example, [www.seasketch.org/msp-my-country/admin.\&#x20](http://www.seasketch.org/msp-my-country/admin.\&#x20);

The following sections will walk you through all that you will need to do in order to configure your SeaSketch project. Note that most of this can be done with only a minimal knowledge of geospatial data and applications. However, when it comes to configuring Sketch Classes to *analyze sketches*, the process becomes quite complex. For that step, you will need to have some knowledge of AWS and Javascript and will need to follow the steps we have outlined in GitHub. We'll cover more of that under the section on [Sketch Classes](/seasketch-documentation/administrators-guide/sketch-classes).&#x20;


# Basic Settings

Configuring the basic settings as an Administrator for your SeaSketch Project.

## <mark style="color:blue;">Basic Settings</mark>

This section is fairly self explanatory. The <mark style="color:red;">Project Name</mark> is what you entered when you created the project. This can be changed at any time. The Description can be anything you like and will appear under your project name on the [Project Listings](https://next.seasket.ch/projects) page, should you choose to list project there. (More on this under the section on Access Control Settings.)

You may upload a PNG logo with a transparent background of at least 128x128 pixels. This will appear in the top left hand corner of your project when in Project View (as opposed to Admin View) and may be linked to another website, such as your organization's website by providing a Logo Link URL. For example the University Logo shown below links to <https://nceas.ucsb.edu.&#x20>;

![](https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FvNvKEcs5FcnpWODVBlI5%2FScreenshot%202023-02-27%20at%2010.03.42%20AM.png?alt=media\&token=c6eb8633-1f88-4e79-a502-a38e987c6e21)

## <mark style="color:blue;">Access Control Settings</mark>

You may choose to make your project Public, visible to Admins Only, or visible only to those who have been explicitly invited (by email or request). You may change these settings at any time. At first, for example, you may wish to make the project visible to Admins Only (the default setting) until you have configured your project suitable enough for an internal team to review it, then set it to "Invite Only" and invite a group of reviewers. Likewise, once it's ready for public viewing, you can switch access to "Public".&#x20;

By default, your project is set to be publicly listed so that users can find it on our projects page without having to know the unique URL for your specific project. Note that a public listing does not necessarily mean that the public can access your project. For that, you need to switch the Access Control Settings to "Public".&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2F3sBFEg5LDUeVgBh1vJko%2FScreenshot%202023-02-27%20at%2010.14.10%20AM.png?alt=media&amp;token=cc8049d9-868b-413c-ba01-426950f010b6" alt=""><figcaption><p>Access Control Settings allow you to determine who can see and access your project as a whole. In other settings, you can limit who can see certain layers, sketch or participate in Forums by creating groups and group-specific permissions for each of these features. </p></figcaption></figure>

## <mark style="color:blue;">Mapbox Access Tokens</mark>

SeaSketch uses maps created in Mapbox for what you might traditionally think of as "base maps", or those that appear beneath all of the other map overlays. To get started, create an account in Mapbox, generate and publish a publicly viewable Mapbox style.&#x20;

There are many ways to create Mapbox styles and integrate them with SeaSketch. We will provide more details on this in the future. Stay tuned.&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2F0yGkJPL9ZR765xZSxWeV%2FScreenshot%202023-02-27%20at%2010.21.38%20AM.png?alt=media&amp;token=fcae5397-cdd4-46ae-a221-09ddf3cd01fe" alt=""><figcaption><p>Linking your SeaSketch account to your Mapbox account is a convenient way to ensure you can add maps to your planning tool and surveys. </p></figcaption></figure>

## <mark style="color:blue;">Map Extent Settings</mark>

The default map extent is set here. This is the view of your project's map to a first-time user. For example, if you wish a first-time user to view your entire Exclusive Economic Zone (EEZ), draw a box around the approximate area of your EEZ.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FbTBUKNtro8fZvxCXlJaj%2FScreenshot%202023-02-27%20at%2010.27.10%20AM.png?alt=media&amp;token=a61a0b4b-6a0d-4e11-b4a3-ac2859be0e70" alt=""><figcaption><p>The default extent you set here is for first-time users. Once a user changes the map extent in their own account, they will no longer view this extent each time they revisit your project. </p></figcaption></figure>

## <mark style="color:blue;">Language Support</mark>

SeaSketch can be configured to support one or more languages. Currently, the SeaSketch interface has been translated into 14 languages so, ostensibly, any given project could utilize 1 or as many as 14 languages. The translation work falls into 3 categories:

1. Language common to all SeaSketch project planning and survey tools. &#x20;
2. Language common to all SeaSketch reports.&#x20;
3. Custom content for any project (e.g., data layers, sketch classes, forums and reports).&#x20;

The first two sets of terms and phrases are translated in a tool called POEditor. Anyone who wishes to help translate the Planning and Survey tool interfaces may visit <https://poeditor.com/join/project/juloLqMZDP> and select one or more languages to assist with. Anyone who wishes to help translate the report interface may visit <https://poeditor.com/join/project/mHa2KSriVC>. If you don't see a language that you'd like to use with SeaSketch, simply click "Suggest a new language" at the bottom of either page.&#x20;

Even if a language has already been translated, you may find that some terms don't quite make sense as you start to use the term. This may be due to the fact that some terms were auto-translated with Google Translate or Microsoft Translate and, for a variety of reasons, they just don't sound quite right. You can use POEditor to recommend changes as you see fit.&#x20;

The third set of terms and phrases (custom content for any project) are translated by project owners because they are unique to any given project. See the section on [Language Support](/seasketch-documentation/administrators-guide/language-support) for more information on configuring your project with these unique terms.&#x20;

If you plan on adding additional languages to your project, simply toggle on/off the languages of your choice in the Basic Settings page:

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FhDIA71mna1xNb8Ey7yQQ%2FScreenshot%202023-04-28%20at%2012.14.40%20PM.png?alt=media&amp;token=b7fb6535-e083-4a2b-b2b3-74ee23cb956b" alt=""><figcaption><p>For this project, I'm using both English and Portuguese. This is an ever growing list of supported languages. If you don't see one that you'd like to use, suggest one using <a href="https://poeditor.com/join/project/juloLqMZDP">POEditor</a>. </p></figcaption></figure>


# Activity

Coming soon...

In the Activity dashboard you can view the number of participants, sketches, forum posts, survey responses, data uploads and layer storage for your project. You can also track the number of visitors, hosted layer requests, and visitor metrics over the last 24 hours, 7 days or 30 days.&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FX8sACwrJsEMHbSZ5Z84w%2FScreenshot%202024-07-01%20at%201.15.48%E2%80%AFPM.png?alt=media&amp;token=50d76fba-8a7b-4ab1-b75b-978c80103868" alt=""><figcaption></figcaption></figure>


# Users and Groups

Invite users and create user groups

If your project is open to the public, any user can join it. This is made particularly easy if you have chosen to list your project on our [Project Listings Page](https://next.seasket.ch/projects). However, you may have a project that is limited only to those you have explicitly invited. Or, you may wish to invite users to your project and assign them to a group if, for example, you are holding a meeting where you want a group of users to collaboratively develop a plan.&#x20;

By default, you'll be the only user and you will be designated as an Administrator. You may add as many users as you like and each of them *could* be designated as an Administrator as well. The best practice is to keep the number of Administrators to a minimum. As they say, too many cooks in the kitchen spoil the broth (and can lead to a bunch of headaches).&#x20;

## <mark style="color:blue;">User Groups</mark>

You can create an unlimited number of groups which can then be given special privileges such as viewing private data layers and participating in private forums. We find it particularly helpful to start out with a Staff group when starting a project so that we can share internal thoughts in a Forum and develop a game plan for how the project is configured.&#x20;

Under User Groups, click "Create Group" and give it a name:

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2Fk2eefRAMTV6LIH8UlLnR%2FScreenshot%202023-02-27%20at%2011.01.48%20AM.png?alt=media&amp;token=6f958d5d-feca-4763-b841-4a5f458461a1" alt=""><figcaption><p>A Staff Group can facilitate internal conversations as you configure your project. </p></figcaption></figure>

## <mark style="color:blue;">Invite Users</mark>

You may invite users individually or in bulk. To invite them individually, click 'Invite Users' and enter the user's email address, full name, assign administrative privileges (if they are intended to be a part of this select group), assign them to a group (e.g., the Staff group) if needed, and then click "Send Email Now" before clicking submit. If you don't send an email immediately, they will appear under the <mark style="color:red;">Draft Invitations</mark> section and you can send the email later.&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2F7YmCfyMjNnAC64mGUABq%2FScreenshot%202023-02-27%20at%2011.05.34%20AM.png?alt=media&amp;token=004be649-aa52-4477-8678-3132fe0e6dea" alt=""><figcaption><p>Inviting a single user. </p></figcaption></figure>

To invite users in bulk, enter comma-separated values for user emails and names. You may assign administrator access and group membership and send emails as you would above.&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FTStjoPVaxuoUPhcJ6lSK%2FScreenshot%202023-02-27%20at%2011.07.09%20AM.png?alt=media&amp;token=25197328-3264-414b-a106-a953662775a8" alt=""><figcaption><p>Inviting multiple users at once. </p></figcaption></figure>

Check to see that your invitations have been sent under the Sent Invitations section. If your email(s) bounced, it will be listed under the section <mark style="color:red;">Bounces, Complaints and Errors</mark>.&#x20;

## <mark style="color:blue;">Banning Users</mark>

It is highly unusual that users misbehave. If deemed necessary, however, you may ban users from posting from any forums. To do so, click on the individual's account under the Participants list and toggle on "Ban from Forums".&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FB3JkI4lKnKHNmsziT2E8%2FScreenshot%202023-02-28%20at%203.07.28%20PM.png?alt=media&amp;token=cbfd585c-1029-4d74-a68b-ad265380d514" alt=""><figcaption><p>Banning users from posting to a forum is highly unusual but perhaps necessary. </p></figcaption></figure>

{% hint style="info" %}
You cannot altogether remove individuals from a project to which they have been invited or a project that is completely public. Remember, however, that you can restrict user access to data layers, forums and sketching tools by limiting those items to defined groups.&#x20;
{% endhint %}


# Overlay Layers

Overlay Layers refers to any data layer not include in a [Basemap](/seasketch-documentation/administrators-guide/basemaps-maps). SeaSketch supports [directly uploading spatial data](/seasketch-documentation/administrators-guide/overlay-layers/uploading-spatial-data) in SeaSketch, as well as data from remote web services. It also supports managing [layer metadata](/seasketch-documentation/administrators-guide/overlay-layers/metadata-and-attribution), updating and [tracking data versions](/seasketch-documentation/administrators-guide/overlay-layers/uploading-spatial-data#managing-new-versions-of-a-dataset), includes [advanced cartography tools](/seasketch-documentation/administrators-guide/overlay-layers/cartographic-styling), and numerous [interactivity options](/seasketch-documentation/administrators-guide/overlay-layers/interactivity-and-popups).

We aim for SeaSketch to provide a complete data portal solution in a single tool, using the latest technology to make data viewing and management fast and intuitive. Anyone can using SeaSketch to support marine conservation planning can create a project, and each include 10 GB of free data hosting.


# Uploading Spatial Data

SeaSketch supports uploading data in both vector and raster formats. From these files it creates high-performance vector or raster tiles which are served to end-users via a content delivery network (CDN). Layers hosted on SeaSketch are *fast*, and support our [advanced cartography tools](/seasketch-documentation/administrators-guide/overlay-layers/cartographic-styling) and [layer versioning features](#uploading-new-versions-of-a-dataset). We recommend hosting data directly from SeaSketch for the best user experience and offer 10 gigabytes of layer hosting for free with each project.

### Uploading a layer

To create a new layer in SeaSketch, navigate to Admin > Data Layers > Overlay Layers and simply drag & drop a [supported file](#supported-data-types) to the window. Drag & drop as many files as you like, even all at once! Data files are processed individually on our cloud infrastructure, and can scale to handle as many as needed. You can also choose to browse for files on your computer using the Edit menu.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FaIkibrXWsjfaJIpXPyIR%2FScreenshot%202024-12-09%20at%2011.43.46%E2%80%AFAM.png?alt=media&amp;token=67e2e326-921e-4126-8329-3e24df999616" alt="From the Overlay Layers toolbar, choose Edit > Add Data > Upload spatial data files" width="375"><figcaption><p>From the Overlay Layers toolbar, choose Edit > Add Data > Upload spatial data files</p></figcaption></figure>

After choosing one or more files to upload, you will see a Background Task list appear at the bottom of the overlays list. This enables you to track the stages of processing for each upload.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2F5HRqqdd20iDyEzblyse5%2FScreenshot%202024-12-09%20at%2011.48.25%E2%80%AFAM.png?alt=media&amp;token=fcb5be83-9354-4205-8b8e-816e5a6de498" alt="Screenshot of background job progress indicator" width="375"><figcaption><p>The Background Jobs list will appear when there are uploads being actively processed.</p></figcaption></figure>

If there are any errors while processing your upload, they will be indicated in the Background Jobs list where you can click the info button for more detail.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FmWXS0aF9ot0FQjJOP2bF%2Finfo-button.png?alt=media&amp;token=dad3d210-ff88-4da8-afbd-9219f6eabc7a" alt="" width="375"><figcaption></figcaption></figure>

### Supported data types

SeaSketch supports a growing list of vector and raster data formats. Some of these files have special requirements that are important to understand for successful uploads. If a data format you use is not currently supported, please [contact support](mailto:support@seasketch.org).

#### Vector Formats

* [Esri Shapefile](https://desktop.arcgis.com/en/arcmap/latest/manage-data/shapefiles/what-is-a-shapefile.htm)
* [GeoJSON](https://geojson.org/)
* [Flatgeobuf](https://flatgeobuf.org/)

#### Shapefile special considerations

Shapefiles are very common among GIS users and one of our top recommendations for uploads. They are smaller that GeoJSON due to their binary nature, so are faster to upload. You can also include FGDC or ISO 19139 xml metadata in your upload to automatically populate metadata.

Each layer you upload needs to be represented by a single file, but "Shapefiles" are [actually many different files](https://desktop.arcgis.com/en/arcmap/latest/manage-data/shapefiles/shapefile-file-extensions.htm), each representing different concerns like projection information (.prj), geometry (.shp) and column values (.dbf). For this reason, you will need to create a Zipfile archive which contains all these associated files into one archive.

*Before uploading a shapefile, make sure:*

* [ ] You are uploading a .zip file archive
* [ ] The .zip file contains all related sidecar files (.shp, .dbf, .prj, .shx, etc)
* [ ] All files share the same name, excepting the file extension
* [ ] The .zip file only contains files related to a single layer, and they are not contained in any subfolder

For an example of a .zip file which meets these criteria, download this [example of the Federated States of Micronesia EEZ](https://seasketchhelp.s3.amazonaws.com/FSM_12nm_Territorial_Sea.zip).

#### Raster Formats

SeaSketch supports raster uploads in the following formats:

* [GeoTiff](https://www.ogc.org/publications/standard/geotiff) - Including both RGB imagery or single-band data values
* [NetCDF](https://en.wikipedia.org/wiki/NetCDF) - First layer found will be used

Currently SeaSketch only supports uploading files with a single data layer. While SeaSketch can recognize 3-band RGB imagery, when encountering other multi-band GeoTiff or multi-layer NetCDF files the system will pick the first band or layer it encounters. We hope to add support for multi-layer raster uploads and vector formats like *File geodatabase* in the future, but this is a current limitation.

### Managing new versions of a dataset

SeaSketch is designed to serve as a long-term steward of your data. This includes handling situations where a dataset is replaced by a new version. SeaSketch can track versions of a dataset, recording who uploaded it, when, and why through user-contributed change-log messages. Once in the system, you can even rollback layers to a previous version.

To view data source versioning information, navigate to the *Data Source* tab in the layer editor. Here you will see a list of each version, which you can click to see further details.

To create a new version of a layer, drag & drop a new layer to the *Data Source* tab. You will be prompted to provide a change-log message so that future viewers can understand why the revision was made.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2Fs9PRXiVxA02QwgYI3Wse%2FScreenshot%202024-12-09%20at%2012.18.58%E2%80%AFPM.png?alt=media&amp;token=987d27c2-f550-4871-86c0-7f50ca637677" alt="Screenshot of a layer revision being processed" width="563"><figcaption><p>After dropping a new layer revision into the <em>Data Source</em> tab, processing progress can be visualized</p></figcaption></figure>

#### Rolling back changes

SeaSketch tracks older visions of layers in the database. This means you can rollback to an older version if a mistake is made. Rolling back to an older version deletes all later versions of a data source, so confirmation is required.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FkBZmQ5XPrd2raltCCiv1%2FScreenshot%202024-12-09%20at%2012.25.51%E2%80%AFPM.png?alt=media&amp;token=af2dc1d4-a67b-49f6-9104-56add18c0d7b" alt=""><figcaption></figcaption></figure>

By default, SeaSketch retains all older versions of a data source, which count against your [data hosting quota](#managing-the-data-hosting-quota). You can set your project to only retain older versions for a specified length of time (e.g. 6 months). To adjust these settings, navigate to the Overlay Layers toolbar and select **Settings > Archived Layer Retention**.

### Enabling data download

SeaSketch retains the original uploaded file in its database. If desired, you can enable your end users to download this file, as well as transform it into their spatial data format of choice. End users can right-click on these layers and choose *Download Data* when enabled.

#### Enabling data download for a single layer

From the layer editor, toggle the Enable Data Download switch.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FFkxhaZ0B3iI9PHPJhLey%2FScreenshot%202024-12-09%20at%2012.35.33%E2%80%AFPM.png?alt=media&amp;token=11f7ec66-cfe0-4d68-bf46-78fa94dc7711" alt="" width="375"><figcaption></figcaption></figure>

#### Toggling data download for all layers

From the Overlay Layers toolbar, choose **Settings > Data Download** to set whether uploaded files are downloadable or private by default. You can also use the **Edit > Data Download** actions to change settings for all existing layers.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FTDLacabtowigxwKiznHF%2FScreenshot%202024-12-09%20at%2012.37.39%E2%80%AFPM.png?alt=media&amp;token=8d7d3edc-9d56-497c-8683-bc09ab31556f" alt=""><figcaption><p>SeaSketch has controls for the default <em>downloadability</em> of your uploaded data, as well as bulk actions to change the download setting for current layers.</p></figcaption></figure>

### Managing the data hosting quota

SeaSketch provides 10 GB of free storage for each project, which should be more than enough for most. This limit is in place to prevent abuse or misuse of SeaSketch. Some datasets (particularly raster imagery) may consume a disproportionate amount of this capacity. If a project reaches the data hosting limit, spatial data layer uploads will be disabled until storage is freed up. To facilitate this process, the Overlay Layers toolbar can be used to show a summary of how layers are counting against the storage limit. Choose **View > Data Hosting Quota** to see this visualization.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FeoWV1RcwPzxZSZAo9dWC%2FScreenshot%202024-12-09%20at%2012.43.17%E2%80%AFPM.png?alt=media&amp;token=7c47440a-d970-4016-b74b-89ab018e5d37" alt=""><figcaption></figcaption></figure>

Use this treemap visualization to identify which layers are consuming the most storage space. Deleting these layers will immediately free up space and enable you to upload layers again. If you project is unable to remain under the data hosting quota, please [contact support](mailto:support@seasketch.org) for assistance.

### AI Processing

When uploading a layer, you may be prompted to enable or disable AI processing of your upload's metadata in order to automatically create useful layer titles and cartographic styles. See the [AI Cartographer section](/seasketch-documentation/administrators-guide/overlay-layers/ai-cartographer) for more details on these settings and features.


# ArcGIS Services

SeaSketch supports the addition of layers backed by ArcGIS Services hosted on their server product or ArcGIS Online. For raster layers, SeaSketch requests image tiles from the service. For vector layers, SeaSketch fetches vector data from the service and translates Esri cartographic style to mapbox-gl-style dynamically, and attempts to match this style with maximum fidelity.

To add an Esri service, choose **Edit > Add Data > Esri ArcGIS Service**. This will open the service search prompt.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2Fmg2SD88oLozbWpQjYWcp%2FScreenshot%202024-12-09%20at%201.18.36%E2%80%AFPM.png?alt=media&amp;token=17e574d4-ebbd-4a1f-a9c8-1b1199baf084" alt=""><figcaption><p>When choosing to add an ArcGIS service, the first step is to specify the service location</p></figcaption></figure>

SeaSketch remembers recently used servers so that you may quickly add new layers from known locations. The service location you enter must be an [ArcGIS REST API service url](https://enterprise.arcgis.com/en/server/latest/deploy/windows/components-of-arcgis-urls.htm#ESRI_SECTION2_30B15502135F49BFB5EA708C78FE6BD9). This may be a link to the root of a service directory, or a deep link directly to a MapServer or FeatureServer. These urls can typically be identified when they contain `/arcgis/rest/services`.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2F35ooCM5rYAfsf7hEA6EM%2FScreenshot%202024-12-09%20at%201.24.50%E2%80%AFPM.png?alt=media&amp;token=63fa56e3-7b27-4658-b1d1-42f1d0274ed2" alt=""><figcaption><p>The ArcGIS catalog viewer has options to add layers to your project</p></figcaption></figure>

After providing a valid location, you will be presented with a catalog viewer where you can see all layers contained in the service. Clicking on a layer will bring up a map preview and an option to add the service to your project. Adding a service will not close the window. Instead, you can browse to find all the layers that you would like to include in your SeaSketch project and add them quickly, one-by-one.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FsEqb0Fe8zi3rmpMtx5aK%2FScreenshot%202024-12-09%20at%201.27.53%E2%80%AFPM.png?alt=media&amp;token=77b04642-7890-420b-850d-aa32d932e869" alt=""><figcaption><p>Services must be evaluated before adding to your project</p></figcaption></figure>

When adding a service to your project, you will need to wait for SeaSketch to evaluate the service. SeaSketch examines layer metadata, cartography, and data size and complexity in order to make a determination about how to best present the layer in SeaSketch. This process may require some time to complete for very complex data sources, but don't worry. When the layer is loaded in SeaSketch and presented to end users it will use information gathered as part of this process to load much more quickly.

{% hint style="info" %}
SeaSketch is committed to supporting ArcGIS services with high reliability and fidelity, but we need your help! If a service isn't loading for you, or the style doesn't match what is displayed on ArcGIS Online, [contact support](mailto:support@seasketch.org). Please include a description of the problem and a direct URL for the service in question. The more feedback we have from Esri users, the better we can make this integration.
{% endhint %}

### Tiled Map Services as Basemaps

When importing a [tiled map service](https://developers.arcgis.com/documentation/portal-and-data-services/data-services/map-tile-services/introduction/) you will be given the option to import it either as a Basemap or an Overlay Layer. Basemaps are accessible from the Maps sidebar, and can only be viewed one at a time. Overlays can be displayed along with many other layers and their opacity can be changed. Only *tiled* map services can be imported this way.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FpRaZlVOBiGlh24z56yUq%2Fimage.png?alt=media&amp;token=5fa6d655-f4f1-4539-9d9e-0b0580530418" alt=""><figcaption></figcaption></figure>

### Styling ArcGIS Services

SeaSketch gathers cartographic styling information from the underlying service and attempts to faithfully render the data similarly to how it would be displayed on ArcGIS Online. SeaSketch cartography tools are not available for ArcGIS Services. If you would like to style data within SeaSketch, convert the ArcGIS service to a SeaSketch-hosted layer.

### Layer Settings

Within the layer editor you have short list of available settings for ArcGIS services.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FwOOfS5YQRaTBTfrdfmOh%2FScreenshot%202024-12-09%20at%201.33.32%E2%80%AFPM.png?alt=media&amp;token=e43061ad-33ac-4a66-926b-3c6405247fb3" alt="" width="375"><figcaption><p>Navigate to the <em>Data Source</em> tab within the layer editor for these options</p></figcaption></figure>

#### Data Download

[Like uploaded layers](/seasketch-documentation/administrators-guide/overlay-layers/uploading-spatial-data#enabling-data-download), you may enable data download for ArcGIS vector layers supported by a FeatureService or vector FeatureLayer. SeaSketch will extract vector data from the service and provide it to the users as GeoJSON when requested. *Data download* is not supported for raster services.

#### Fetch Strategy

When first analyzing a service for inclusion in SeaSketch the *fetch strategy* will be determined. SeaSketch can either instruct clients to download the entire vector data source in order to display it on the map, or make *tiled requests* of vector data generalized as appropriate for the given viewport and zoom level. Usually this setting should be left for SeaSketch to determine automatically.

### Converting to a SeaSketch-hosted Layer

The *Data Source* tab within the layer editor has a **Convert to Hosted Layer** button which will harvest vector data from an ArcGIS Service and convert it to a SeaSketch-hosted layer with all the same functionality supported for [Uploaded Layers](/seasketch-documentation/administrators-guide/overlay-layers/uploading-spatial-data). This is a great option if the original source service is slow, unreliable, or you want to utilize [SeaSketch's advanced cartography tools](/seasketch-documentation/administrators-guide/overlay-layers/cartographic-styling).&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FXNKyiOdNZK5mADQZXAHM%2FScreenshot%202024-12-09%20at%201.59.26%E2%80%AFPM.png?alt=media&amp;token=6732e9f2-47a5-40f9-a22a-e03d979b070c" alt="" width="375"><figcaption></figcaption></figure>

Note that converted layers are managed by the data source versioning system. The relation to the old service will be recorded, as well as the requester and date when the conversion took place. Any admin can ***rollback*** the layer to the original service. The opens up two interesting capabilities.

1. It is very easy to evaluate converting a layer to SeaSketch-hosted vs using the originating service.&#x20;
2. If data in an ArcGIS service changes, a SeaSketch-hosted service can be rolled back temporarily and then converted again to a hosted service in order to incorporate changes in the service.

{% hint style="info" %}
Services which contain very large datasets or are generally slow or unreliable may fail the export process when attempting to convert to a hosted service. In these cases it may be easier to contact the data provider for a hard copy of the data.
{% endhint %}


# Other Service Types

Besides direct uploads and ArcGIS Services, SeaSketch supports a growing list of other service types. If you don't see support you need in this list, please [reach out to support](mailto:support@seasketch.org).

#### Supported Service Types

* Mapbox Vector Tiles hosted on a public url
* Remote GeoJSON

From the Overlay Layers toolbar, choose **Edit > Add Data > Connect to data services** for these options.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FyHwTWc8lrKPbq3MhBEXS%2FScreenshot%202024-12-09%20at%202.06.37%E2%80%AFPM.png?alt=media&amp;token=26a774c0-4311-4651-81d9-3b28b41e926b" alt="" width="563"><figcaption></figcaption></figure>


# Layer Access Control

All Overlay Layers support *Access Control* settings to limit visibility of data to the appropriate group. Open the layer editor to change these settings. Layers may be entirely Public, limited to particular User Groups, or restricted to only Admins. See the [Users and Groups](/seasketch-documentation/administrators-guide/users-and-groups) page for details on how to assign users to these different groups and roles.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FwTqhHdWnbG1BpkGN2LJx%2FScreenshot%202024-12-09%20at%2011.01.30%E2%80%AFAM.png?alt=media&amp;token=80787ad6-fdc1-442c-8fea-ee64af804cea" alt="" width="375"><figcaption><p>The layer editor can be opened by right-clicking on a layer in the Overlay Layers list</p></figcaption></figure>

In addition to assigning *Access Control* rules on individual layers, you can set these permissions on Folders. Visibility of a folder will control access to all contained sub-folders and layers.

{% hint style="info" %}
Remember, changes to these settings will only be updated after [Publishing Changes](/seasketch-documentation/administrators-guide/overlay-layers/publishing-changes)
{% endhint %}


# Metadata and Attribution

### Attribution

When editing layers in the admin interface, the first field below the layer name is the attribution.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FObMyHUqR17LBbMWuczsd%2FScreenshot%202024-12-10%20at%2010.01.42%E2%80%AFAM.png?alt=media&amp;token=53a43276-7f6e-40ce-aa34-b70b68347861" alt="" width="375"><figcaption></figcaption></figure>

The attribution field is used to display a short message at the bottom of the map giving credit to the data source. In many cases data providers require such attribution. This information will also be shown on the map when printing.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FgGzQwU8Jwt6NZUQVfVeP%2FScreenshot%202024-12-10%20at%2010.03.07%E2%80%AFAM.png?alt=media&amp;token=6a59edcf-86ad-4bfb-bc9f-678026473d77" alt="" width="375"><figcaption></figcaption></figure>

Beyond a simple text label, it is possible to display a link. To do so, enter an [html anchor tag](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a). An example of such a tag looks like the following:

```
<a href="https://marineregions.org">MarineRegions</a>
```

### Metadata

SeaSketch has tools to author and provide metadata to users explaining the source,  collection methods, and provenance of data layers. Users can access metadata for individual layers by right-clicking on the layer in the layer list or using the context button in the legend. These metadata summaries may provide a complete record for the layer, or use hyperlinks to redirect users to authoritative sources.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FKELcRsrn9sGRGNxChAFu%2FScreenshot%202024-12-10%20at%2010.10.35%E2%80%AFAM.png?alt=media&amp;token=b8569233-826d-495f-8d15-6d24c84c0e84" alt="" width="375"><figcaption><p>Metadata may be accessed via the data layer context menu</p></figcaption></figure>

#### Authoring Metadata in SeaSketch

Metadata can be authored using the *Metadata* tab of the layer editor.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FBWSmGMrrnYZiQeg5Hug7%2FScreenshot%202024-12-10%20at%2010.14.53%E2%80%AFAM.png?alt=media&amp;token=134be806-d823-4c7f-bde1-18ed5c2f8bcc" alt="Screenshot of the layer editor tabs, highlighting the Metadata tab" width="375"><figcaption><p>The metadata editor is available via the layer editor</p></figcaption></figure>

This WYSIWYG editor features tools to format text and create hyperlinks and lists. Copying and pasting text from sources such as web pages or Word documents will maintain basic formatting when possible. Many of our projects maintain metadata exclusively using the editor.

#### Metadata Titles

The WYSIWYG editor contains an H1 tag which can be used to provide a title for the metadata summary. If used, this will be the title displayed. If no H1 tag is used, SeaSketch will automatically title the metadata display with the layer name used in the layer list. For this reason, we recommend *not using the H1 tag* unless you intend for the metadata to have a different title than the layer name. Omitting the H1 tag will leave less redundant information for admins to maintain.

{% hint style="info" %}
Remember, changes to these settings will only be updated after [Publishing Changes](/seasketch-documentation/administrators-guide/overlay-layers/publishing-changes)
{% endhint %}

#### Using XML Metadata

Many organizations already maintain metadata using XML. SeaSketch is designed to work with these files, generating summaries of provided XML metadata for presentation to users and making the original source XML available for download.&#x20;

The easiest way to get XML metadata into SeaSketch is when originally uploading a shapefile. If the .zip archive contains a .xml file that conforms to [FGDC](https://www.fgdc.gov/metadata) or [ISO 19139](https://pro.arcgis.com/en/pro-app/latest/help/metadata/create-iso-19115-and-iso-19139-metadata.htm) standards, the system will automatically associate that XML file with the layer, create a human-readable summary of the metadata for viewing in SeaSketch, and make it available for download when viewing that summary.

To upload XML metadata for a layer which didn't include an XML file during upload, or to update existing XML metadata, use the upload button in the metadata editor toolbar.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2F4XF3tibo42i4Qw3gjfRB%2FScreenshot%202024-12-10%20at%2010.40.47%E2%80%AFAM.png?alt=media&amp;token=3d764ca2-99f8-4ab5-9dfe-7b976fd00604" alt=""><figcaption><p>Click the upload button in the toolbar to update XML metadata or upload it for existing layers without XML metadata</p></figcaption></figure>

You can also update XML metadata from the footer of the metadata document.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FJMvENwJGRk5XsWQzCKA3%2FScreenshot%202024-12-10%20at%2010.41.04%E2%80%AFAM.png?alt=media&amp;token=4ede0374-678b-4e71-b34c-de053b7aeaae" alt=""><figcaption></figcaption></figure>

Note that at this time, metadata summaries are not updated when new XML is uploaded. To create summaries of XML metadata, it must be included in the .zip archive during initial upload.

{% hint style="info" %}
XML metadata handling is a new feature of SeaSketch and we look forward to your feedback. [Contact support](mailto:support@seasketch.org) to help us understand how we can improve your metadata handling workflow in SeaSketch.
{% endhint %}

### Metadata for ArcGIS Services

ArcGIS services have support for publishing certain metadata directly as part of the service. By default, SeaSketch will show a summary of information from the service when viewing metadata for these layers. You can choose to override this metadata with your own custom metadata authored in SeaSketch if you choose. It is also possible to revert back to the service-provided metadata if desired.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2Fcrh9t4HmmOXK37AbyjmJ%2FScreenshot%202024-12-10%20at%2010.50.18%E2%80%AFAM.png?alt=media&amp;token=f02dc246-0dc3-4ed5-be4f-613e1f6f0195" alt="" width="375"><figcaption><p>In this case, the ArcGIS service does not contain sufficiently detailed metadata, so the admin may choose to author metadata for it directly in SeaSketch.</p></figcaption></figure>

Click *Convert to editable metadata* to start authoring metadata directly in SeaSketch. Once converted, updates to the service metadata will no longer be reflected in SeaSketch, though you can always choose to revert back to dynamic metadata from the service.


# Cartographic Styling

Advanced layer styling tools are available for all datasets [uploaded to SeaSketch](/seasketch-documentation/administrators-guide/overlay-layers/uploading-spatial-data). All cartography displayed in the application is defined using the [mapbox-gl-style specification](https://github.com/mapbox/mapbox-gl-styles). Until recently, all styles were authored in a code editor using this language. Now, SeaSketch offers both a code editor and a new graphical cartography interface which creates these style layers for you.

### Graphical Style Editor

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2Fy91UiqreneNfhU5yWTob%2FScreenshot%202024-12-10%20at%2012.26.53%E2%80%AFPM.png?alt=media&amp;token=547971ad-5784-4a21-865f-61ccbb4aa575" alt=""><figcaption><p>Here a layer is represented by a categorical fill visualization. An administrator can use the selected dropdown to change visualization types to different display options.</p></figcaption></figure>

When viewing the *Style* section of the layer editor, you will be first presented with the graphical cartography editor. After uploading a layer, SeaSketch will attempt to determine the best visualization type for that layer based on inspection of its attributes. If you would like to change the overall visualization type used to present the layer, click on the first dropdown and you will be presented with options that are suitable for the vector geometry type or raster format of that data source. Such options may include:

* Simple displays, such as a single colored polygon, line, or circle
* Categorical styles, which color polygons or pixels based on an attribute
* Color Range options which display a color scale based on a numeric attribute
* Heatmaps to display the density of points
* RGB Image display for rasters

Each visualization type includes its own unique configuration. In most cases settings that may be unclear will contain additional help tooltips which can be revealed by hovering over the info button.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FNDeNAu8bGnHdVJjIFWKh%2FScreenshot%202024-12-10%20at%2012.38.42%E2%80%AFPM.png?alt=media&amp;token=0dcba0b3-d42d-4c4a-9802-dca537622678" alt="" width="563"><figcaption></figcaption></figure>

#### Changing the visualized attribute

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2F1RHHx48k58IdLAeP6gqI%2FScreenshot%202024-12-10%20at%2012.41.22%E2%80%AFPM.png?alt=media&amp;token=5a99d06f-0ef2-4779-9581-99b63e427694" alt="" width="563"><figcaption><p>Here, the field used to categorize polygons can be changed</p></figcaption></figure>

In all but the simplest visualization options, you can usually change the attribute used to categorize or otherwise visualize the data layer. SeaSketch summarizes attribute values and shows example values in the dropdown menu for reference. You can also use the toolbar to select **View > Open layer property details** to see information on all attributes found in the data layer.

#### Customizing the legend

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FzPyPi09c97cKI7nF7yc2%2FScreenshot%202024-12-10%20at%2012.44.45%E2%80%AFPM.png?alt=media&amp;token=5c6a2e35-abe8-49c6-964d-5d0ac72d9677" alt="" width="375"><figcaption></figcaption></figure>

By default, SeaSketch uses column names and values from the visualized column to render the legend. Often these values have odd capitalization or are short codes which may be hard for users to interpret. You can use the text fields in the visualization configuration to customize the legend with more appropriate labels.

#### Undo and Redo

Using the toolbar *Edit* menu, or by using `Control+Z` and `Control+Shift+Z`, you can undo and redo all changes to a style. This includes both the graphical and code editors. Please experiment with styles freely knowing you can always undo your changes. Just be mindful that you will lose this command history upon closing the layer editor.&#x20;

{% hint style="info" %}
Remember, changes to these settings will only be updated after [Publishing Changes](/seasketch-documentation/administrators-guide/overlay-layers/publishing-changes)
{% endhint %}

### Using the Code Editor

Some tools use code to define cartography, which offers great flexibility but is hard to use and learn. Others provide graphical editors which are easy to use but cannot possibly cover all use cases.  SeaSketch attempts to marry these two approaches in order to have an easy to use tool that covers 90% of needs, but also provides a code editor for advanced users who want to have complete control of how layers are displayed. All styles authored in the graphical editor are translated to code, and the graphical editor attempts to interpret styles edited in the code editor.

Our team often starts in the graphical editor and switches to the code editor to make some final tweaks to get the exact results we'd like in complex cases. For example, the graphical editor does not currently support zoom-dependent styles. For now, the code editor can be used to address this need when it arrises.

Use the switch at the top of the style editor to switch to the code editor.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FDPxLIeDTPn8wbKTe8eer%2FScreenshot%202024-12-10%20at%2012.51.59%E2%80%AFPM.png?alt=media&amp;token=63df1d1c-fd9e-480e-9ac2-73063f5bc34a" alt="" width="563"><figcaption></figcaption></figure>

The language used for cartography is the [mapbox-gl-styles specification](https://github.com/mapbox/mapbox-gl-styles). MapBox has a great deal of [high quality documentation](https://docs.mapbox.com/mapbox-gl-js/guides/styles/) which you can use to learn this json-based language.

SeaSketch's code editor understands this specification and will validate all input. You will see red underlining of invalid values and code, which can be hovered over to see specific error messages. Styles containing invalid code will not be saved until corrected.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2F1iILK6kBzHNNxbEe10Og%2FScreenshot%202024-12-10%20at%201.01.15%E2%80%AFPM.png?alt=media&amp;token=f40daaa2-70da-4219-8a9d-054a74085c36" alt="" width="348"><figcaption></figcaption></figure>

The style editor has an advanced understanding of both the mapbox style specification and your layer's metadata, and so can provide helpful autocompletion suggestions and inline documentation. Often these suggestions will automatically appear as you type, but they can also be triggered by pressing `Control+Space`. Hovering over a style property will also bring up a documentation tooltip.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FPMk08UpUEHpiJZwmSGGJ%2FScreenshot%202024-12-10%20at%201.03.24%E2%80%AFPM.png?alt=media&amp;token=9f24b6af-968b-454b-93ca-28eef1bf151b" alt=""><figcaption><p>Here a tooltip is suggesting style props. These are filtered to those which are appropriate for the "paint" settings of a fill layer</p></figcaption></figure>

When creating a [data-driven style](https://docs.mapbox.com/mapbox-gl-js/example/data-driven-circle-colors/) using a `["get", "column-name"]` expression, the code editor will give suggestions based on the columns found in the current data layer, along with their data type. Autocompleting these column names is a much faster and less error-prone way of defining these styles.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2F1h06jSlfeLgg2cpPttRp%2FScreenshot%202024-12-10%20at%201.08.22%E2%80%AFPM.png?alt=media&amp;token=0f98c70a-a8c8-4686-8775-76bc1188fdc0" alt="" width="563"><figcaption></figcaption></figure>


# Interactivity and Popups

The settings under the Interactivity tab of the layer editor give you some control over values that may appear when you click on a layer or hover over a layer feature. A Banner is short text that can be displayed toward the bottom of the map when the user hovers over features. Tootips are short text displayed next to the mouse cursor when you hover over a feature. Popups appear when you click feature.&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FWzUzUgb3JJaJZNtu30Dd%2FScreenshot%202023-02-27%20at%2012.03.59%20PM.png?alt=media&amp;token=b7e82e26-1d0c-4881-9956-3d550ce76656" alt=""><figcaption><p>Here I have entered "12nm Boundary" as a tooltip. Howevering my cursor over a feature in this layer reveals that text. </p></figcaption></figure>

Note that Tooltips and Popups can be enhanced with simple HTML tags. We will provide more information on this feature in future updates to our documentation.&#x20;

{% hint style="info" %}
Remember, changes to these settings will only be updated after [Publishing Changes](/seasketch-documentation/administrators-guide/overlay-layers/publishing-changes)
{% endhint %}


# Organizing Overlays

## Folders

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FfqR30ehL4UHw0ZeexPIc%2FScreenshot%202024-12-10%20at%201.14.00%E2%80%AFPM.png?alt=media&amp;token=45003536-063a-460e-a61b-b1a91e99d6d9" alt="" width="375"><figcaption></figcaption></figure>

The edit menu can be used to create *Folders* to organize your data layers. These can be nested as deeply as needed, and Folders have advanced options such as *Radio Children* and *Check-Off Only* to control how members behave. [Access Control settings](/seasketch-documentation/administrators-guide/overlay-layers/layer-access-control) can also be set at the folder level by right-clicking on a Folder and choosing Edit.

## Layer Organization

Layers (and Folders) can be organized in the list by simply dragging and dropping them into their prefered position or folder. As the list grows beyond the extent of you browser screen, pausing at the top or bottom edge of the list will scroll up or down as needed.

{% hint style="info" %}
Currently drag & drop operations are only supported for single layers or folders. In the future we hope to include options to select and reorganize multiple table of contents items in a single action.
{% endhint %}


# Publishing Changes

Updating the Overlay Layers may involve many small changes, and often requires review by multiple contributors. For this reason, changes to these layers are not immediately published to the project homepage. You can think of the administrative view of data layers as a staging area to work on changes before finally deciding to publish. This is helpful to prevent partially configured layers from going out, but you must also remember to *publish*!

The publish action is represented by a button at the top of the overlays list. It changes color depending on whether or not there are unpublished changes.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FPFge8o171UTnCz8yHf6E%2FScreenshot%202024-12-09%20at%2010.47.50%E2%80%AFAM.png?alt=media&amp;token=b526de61-824b-4139-b7be-1c0b0750c4a2" alt="" width="563"><figcaption><p>The blue button indicates there are changes that have yet to be published</p></figcaption></figure>

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2Fe1l4Zc4mWsfinoG4Mt05%2FScreenshot%202024-12-09%20at%2010.48.07%E2%80%AFAM.png?alt=media&amp;token=e63fbf18-19d5-49ee-9bf0-ffe3f65683de" alt="" width="563"><figcaption><p>A muted presentation indicates there are no unpublished changes</p></figcaption></figure>

When ready, click *Publish* and return to the project view by clicking the *Back to Project* button to ensure everything looks good from the end-user perspective.&#x20;

### Change Logs

Starting in April of 2026, SeaSketch tracks updates to each project's data layers using a change logging system. Each layer has a history of when it was created, and every edit to titles, access control settings, cartography, metadata, and other details. You can inspect these details from the layer editing sidebar, and you will also see a summary of changes since the last publication of the layer list when you use the **Publish** action.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2Fo7URordubVwBuHFZTvCW%2FScreenshot%202026-05-12%20at%205.07.11%E2%80%AFPM.png?alt=media&amp;token=7f26ad0b-a751-4641-9c22-6cacfe5e7b58" alt=""><figcaption></figcaption></figure>

Each layer listed in the changes summary should include one or more *activity badges* that indicate the exact changes made to a layer. For significant changes such as those to cartography or metadata, you can open up a detailed history viewer that will also enable you to rollback undesireable changes.

{% hint style="info" %}
Note, you will need to refresh your browser after returning to the project view in order to see your changes!
{% endhint %}


# The Data Library

The SeaSketch team is developing a growing set of curated data layers from authoritative sources. The goal of the data library is to provide commonly-used datasets with excellent cartography and interactivity settings ready to use "out of the box" and to support custom integrations with bespoke web services and catalogs that would be impossible to automate otherwise.

To access the Data Library, choose **Edit > Add Data > View the Data Library** from the Overlays administration page.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2F51SH00JbhHTXDC68SoAR%2FScreenshot%202025-12-14%20at%208.48.19%E2%80%AFPM.png?alt=media&amp;token=5b70fb68-0118-41bb-af62-00f8dac3f97c" alt="" width="375"><figcaption></figcaption></figure>

The Data Library currently includes data from NOAA Coral Reef Watch and iNaturalist. Our intention is to grow this resource over time. Please contact <support@seasketch.org> if you would like your data to be included, or there is a data source that you would like added that is otherwise difficult to integrate with SeaSketch.

#### NOAA Coral Reef Watch

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FX1J3D2nVodc4gYbnTjah%2FScreenshot%202025-12-14%20at%208.50.40%E2%80%AFPM.png?alt=media&amp;token=8a0b2667-1c02-4beb-a524-8782d970d6f0" alt=""><figcaption></figcaption></figure>

The[ National Oceanic and Atmospheric Administration's Coral Reef Watch](https://coralreefwatch.noaa.gov/) provides NetCDF products derived from remote sensing data to monitor coral reef bleaching. SeaSketch pulls data from NOAA's servers daily and updates a set of 6 data layers automatically. Should you choose to add these datasets to your project, they will also be updated as new data becomes available (typically every 24 hours). With the layers added to your project, you may still customize cartography and interactivity settings while receiving source updates.

#### iNaturalist

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FxVZNBNPy3U6GIVKsLIXP%2FScreenshot%202025-12-14%20at%208.59.14%E2%80%AFPM.png?alt=media&amp;token=7b4c0891-5728-4ecb-91c0-682dd8e1a3b0" alt=""><figcaption></figcaption></figure>

Using this integration, administrators can create layers representing observations in [iNaturalist](https://www.inaturalist.org/). The tool can be used to create layers showing all observations from a given iNaturalist project in order to highlight *citizen science* efforts, or for particular taxonomic groups to show where observations have been made of particular species. Administrators can enable an optional *call to action banner* to encourage viewers of the layer to contribute their own observations to an iNaturalist project.


# AI Cartographer

Use our new AI tools to process layers and give them a cleaned up layer title, attribution, and cartographic settings that match your data.

When uploading new layers to SeaSketch, you have the option to process layers using our *AI Cartographer* system. This system can assign layers a well-formatted title, an attribution if metadata is available, an appropriate cartographic style, and interactivity settings (e.g. popups). This can save you a great deal of time, and is also a great way to learn how our cartography tools can be used to fit your visualization needs. As always, you can use the cartography tools to adjust these automated settings afterwards as needed.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FYGmicwd7K8tpTvDaV0Rh%2FScreenshot%202026-04-07%20at%209.18.34%E2%80%AFAM.png?alt=media&amp;token=0c634f91-8812-4b75-9dd0-5a327045be00" alt=""><figcaption><p>In this example, the system identified a categorical color scheme driven by the <em>Morphotype</em> column as the most appropriate way to present a Seamounts layer.</p></figcaption></figure>

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FXOy3B3cUQAIfhcwTBNVo%2FScreenshot%202026-04-07%20at%209.46.19%E2%80%AFAM.png?alt=media&amp;token=bb31e6da-a18e-492a-b0c4-0ed1976eaf5e" alt=""><figcaption><p>Here, the system identified a raster as containing bathymetry data and chose a blue color scheme where deeper areas are a darker color. It reversed the default color palette order in order to show shallower areas in a lighter shade. Also note that the system cleaned up a complex filename to produce a clear layer title.</p></figcaption></figure>

## Enabling AI Processing

AI processing is a feature enabled or disabled for each individual SeaSketch account. Individuals have control over whether their uploaded data is processed.

With the launch of this new feature, you will be prompted to enable or decline the use of this system with your next upload automatically. If you want to change your settings later, you do so from the Overlay Layers section of your project's the admin interface.

Choose **Settings** -> **AI layer processing...** from the Overlay Layers admin to enable or disable these features.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FM5TyjbGLOBbmxyq7eVrQ%2FScreenshot%202026-04-07%20at%209.57.32%E2%80%AFAM.png?alt=media&amp;token=dfeda5fe-d329-417a-8128-947001f87893" alt="" width="375"><figcaption></figcaption></figure>

## Using with Sensitive Data

In order to provide AI services related to an uploaded layer, SeaSketch sends metadata about it to a 3rd-party data processor, OpenAI, to analyze it. The information sent to this service may include:

* The filename
* XML or textual metadata included with the layer
* The number of bands, min, max, and histograms of value distributions for raster data
* The geometry type, and number of features in vector data layers
* Column stats (min, max, avg, histograms) and sample values (e.g. Morphotype and SeamountId values from the example above).

SeaSketch **does not** send complete data layers to processors for inference, and for sample string values it will shuffle records to make reconstruction infeasible. SeaSketch also scans incoming data for *personally identifiable information* (PII) on local servers. Columns identified as likely to contain PII such as person names, emails, phone numbers, or government identifiers are redacted before sending to AI services. You can read more about how we redact PII [here](https://github.com/seasketch/next/tree/master/packages/geostats-pii-risk-classifier).

Details on how our data processor treats this data can be found on their website: [OpenAI: Your data in the API](https://developers.openai.com/api/docs/guides/your-data). In summary, this information **is not** used for training OpenAI models and is retained only for logging and abuse prevention. Typically for less than 30 days. This is very similar to the policies related to other paid cloud computing services SeaSketch utilizes.

Even though we make every effort to prevent sharing of PII, SeaSketch cannot detect all sensitive information. Person names can be difficult to detect in global languages, and there are many other data values (like sensitive coordinates) which we cannot automatically redact. For that reason, for truly sensitive data we recommend disabling AI processing for your account when uploading those particular layers. This avoids metadata and sample values being sent to 3rd party data processors like OpenAI. You can always re-enable these features when uploading public data later.


# Specialized Editor Views

The Overlays administrative area contains many specialized views that can be used to visualize the state of your project's layer list and very efficiently make changes to many layers at once. For example, you can use the **Download Settings** view to very quickly see and update which layers are available for users to download. You can access these views by accessing **View** from the menubar.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FGwFC0fXv9f0Mos4naXEl%2FScreenshot%202026-05-13%20at%203.38.36%E2%80%AFPM.png?alt=media&amp;token=4e3b5f9f-ba6f-42c9-9afb-d49acdcaa75a" alt="" width="563"><figcaption></figcaption></figure>

### Layer Z-Ordering

The Z-Order refers to how layers appear on top or beneath one another. Users of your project can reorder layers in the legend, but it can be helpful to specify a default ordering so that users don't have to adjust this setting while viewing layers on the map. Use the view menu to view the default order of your project's layers.&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FHo4WiFCuJRlBv4o66Wvp%2Fhttps___files.gitbook.com_v0_b_gitbook-x-prod.appspot.com_o_spaces%252FmrOjheW9v23epAZJDsmJ%252Fuploads%252Fg9ANjgCXtgyhSgstADFJ%252FScreenshot%25202024-12-09%2520at%252010.43.18%25E2%2580%25AFAM.avif?alt=media&amp;token=641a97de-96cb-4730-b622-e09e98df167f" alt="" width="563"><figcaption></figcaption></figure>

To move a layer so that it appears on top of another one, simply drag and drop the desired layer toward the top of the list.

### Data Hosting Quota

Each SeaSketch project is allotted a limited amount of space for storing uploaded data layers. Using the treemap visualization in the view it is easy to determine which layers use the majority of a project's quota.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FU6raPi3m5Slvt72Ihvho%2FScreenshot%202026-05-13%20at%203.48.03%E2%80%AFPM.png?alt=media&amp;token=1a9d1100-996c-4a5d-809f-0a30902a8251" alt=""><figcaption></figcaption></figure>

### Download Settings

Using the **Download Settings** view, you can quickly see what layers are accessible to users for download and control this option.

### Sharing Settings

This view enables administrators to very rapidly assess and update access control settings. Rather than accessing the editing sidebar for individual layers, can update settings from a popover menu.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FIQ85pvPeN80Klq07Klis%2FScreenshot%202026-05-13%20at%203.38.15%E2%80%AFPM.png?alt=media&amp;token=deb15fe6-580c-4158-b76e-03710ce0f8f0" alt=""><figcaption></figcaption></figure>


# Basemaps (Maps)

In SeaSketch, *Maps* refer to base maps that are authored in MapBox and then imported into SeaSketch. You will need to create a MapBox account, create Mapbox style, publish it and then add the URL to your SeaSketch project. &#x20;

In Data Layers, choose Maps > Add New Map > By URL > and past the link below into the field that says Style Location.&#x20;

mapbox://styles/seasketch/clhao1xum01w901qm2wkd06tc

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FNooB7xctMIkUa1sBFPvf%2FScreenshot%202023-07-28%20at%2012.23.01%20PM.png?alt=media&amp;token=7c1a6e87-9acf-415f-9afb-b14cc3fccb70" alt=""><figcaption><p>Entering a custom MapBox style to use as a "Map". Maps are basemaps that appear underneat any data layers turned on. </p></figcaption></figure>

Select an area of the map to create a thumbnail.&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FCKeNupxJojl48bFrcmCw%2FScreenshot%202023-07-28%20at%2012.24.44%20PM.png?alt=media&amp;token=5653aee1-98d2-41ed-90ad-254576f70db9" alt=""><figcaption><p>Selecting an area of the map to use as a thumbnail. </p></figcaption></figure>

After capturing and saving the thumbnail, the new map will be viewable by all users. They do not require "publishing" as do data layers shown above.&#x20;


# Sketch Classes

In SeaSketch, sketch classes are the things you draw, such as zones, and potentially analyze as prospective plans.

<mark style="color:blue;">Adding Sketch Classes</mark>

To add a sketch class click the "Add +" button. Sketch classes include Simple Polygons, Simple Lines, Marine Protected Areas and Collections. Collections are just as they sound like: collections of multiple sketches that can be *analyzed as a whole*. This is not to be confused with a simple folder which is just a bucket to hold muliple sketches or collections but cannot be analyzed. We cover creating folders in the End User Documentation.&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FcgiGyXRS1H4LtgBj5pv5%2FScreenshot%202023-02-27%20at%2012.15.34%20PM.png?alt=media&amp;token=ebd5de58-ec40-4e71-8687-c669082d6b72" alt=""><figcaption><p>Dialog box for adding a new sketch class to your project. </p></figcaption></figure>

### Simple Polygon

Simple polygons could be any zone type, for example an "mariculture zone". The settings tab allows you to give it a name and limit who sees it (using Access Control).&#x20;

After creating and using your sketch class, you may wish to hide it. Perhaps you no longer have a use for it and you don't want to confuse your users by having it persist in the Project. If this is the case, toggle the Archive to "on". You can always restore it in the future.&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2Fi72SkLDCtQ4VEP8azLtz%2FScreenshot%202023-02-27%20at%2012.19.51%20PM.png?alt=media&amp;token=b81acb4f-c6fb-4ce1-8817-d0a2a573cc19" alt=""><figcaption><p>Archive is turned "off" in this case, so the sketch class will still appear in the Project View. </p></figcaption></figure>

You may also choose to delete a sketch class but this is only possible if your users have created fewer than 10 sketches. This is to prevent "orphaned" shapes they may have drawn.&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FTgU0AXll4HHZxTx3Q4L9%2FScreenshot%202023-02-27%20at%2012.22.36%20PM.png?alt=media&amp;token=90e51bca-3128-48af-b61b-7caeb7ed9730" alt=""><figcaption><p>If you simply archive your old sketch classes, this option is probably not needed. </p></figcaption></figure>

#### Attribute Form

Create as many attributes for a sketch that are useful. Possible attribute fields include:&#x20;

* Email
* Multiple Choice (multiple or single selection)&#x20;
* Short Text
* Text Area
* Number
* Rating (1-5 stars)
* Statements (which can provide information to users)&#x20;
* Combo Box (similar to Multiple Choice but presented in a dropdown list).&#x20;
* Matrix

Notice that for any given attribute, you can edit the options associated with it by clicking the pencil icon next to the attribute in the form. In the example below, the Multipe Choice options include Required (on/off), Export ID (the column name used when exporting data), Change to Comobo Box and Options (for labels and values).&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FRv58UCatYLx6VDEztZFL%2FScreenshot%202023-02-27%20at%201.17.59%20PM.png?alt=media&amp;token=c78a24a3-fbda-4cb5-8076-e807b0154e2f" alt=""><figcaption><p>Editing the attributes of a simple polygon. </p></figcaption></figure>

#### Geoprocessing

A sketch can be configured with a preprocessing service and geoprocessing service. A preprocessing service is used to transform or validate a sketch, for example erasing land from a polygon intended to overlap water or ensuring a zone falls within a nations exclusive economic zone (EEZ). A geoprocessing service defines the reporting tools that will appear when analyzing a sketch, such as calculating the amount of overlap with seafloor habitats or human activities.&#x20;

Services are used by entering the URL of that service. For example, the following URL is a preprocessing service that removes land from a sketch using the Open Street Map land polygons:&#x20;

{% embed url="<https://h13gfvr460.execute-api.us-west-2.amazonaws.com/prod>" %}
Copy this URL to use as a preprocessing service
{% endembed %}

Simply enter the above URL into the preprocessing service of your simple polygon

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FP448M3W2C3A4rok8Qk4c%2FScreenshot%202023-02-27%20at%201.26.36%20PM.png?alt=media&amp;token=5337f1b2-3c2a-4f6a-95f7-e4d3d6a5d37b" alt=""><figcaption><p>Entering the URL of the preprocessing service</p></figcaption></figure>

Click "Search"

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2Fu7wulQIoFUcA22rdc1bH%2FScreenshot%202023-02-27%20at%201.27.29%20PM.png?alt=media&amp;token=eda9d11e-c2b6-466e-a7d0-5671cb4921b6" alt=""><figcaption><p>Identifying the preprocessing service you would like to use</p></figcaption></figure>

And then choose the preprocessing service you would like to use. In this case, the name of the preprocessing service si called "eraseLand", a service thag was written by Chad Burt on May 5, 2020.&#x20;

Geoprocessing services that are used to analyze sketches and generate reports are significantly more complicated to add. This is because, at the time of this writing, we do not have generic geoprocessing services you can use. These services must be written using our [Geprocessing Framework which is documented here on GitHub](https://github.com/seasketch/geoprocessing/wiki).&#x20;

We have an Application Programming Interface (API) that will allow 3rd party developers to create their own geoprocessing services and reports, then link them up to sketch classes in their own project.  Our hope is that, over time, 3rd party developers will create custom reports and publish them as open source, creating a library of templates that could be used by others.&#x20;

#### Style

The style editor for Sketch classes is currently code based and uses the [Mapbox GL Style ](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/)language. In the near future, we will also have a graphical user interface (GUI) for modifying styles.&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FKpgtDjEiUtHMDUy1w53C%2Fsketch%20style.png?alt=media&amp;token=a2caf15a-daca-40eb-83cc-8da14ab46e5e" alt=""><figcaption></figcaption></figure>


# Forums

Interactive forums are used to share messages that may include map bookmarks, attached sketches and documents.

Forums are the primary means by which SeaSketch users collaborate. Messages may include rich text (including styling, bullet points, hyperlinks), in-line bookmarks to the map state (the map extent and any active data layers), attached sketches and documents. Each message also contains a unique URL which may be copied and shared via email or other media. Messages are only accessible to those that have permission to access the forum to which they are posted.&#x20;

To create a new forum, click the "Add + button under the Forums tab. If this is your first forum, you can also click "Create your first Forum" and give it a name.&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2Fx2WODktoiIe3UZNDn8K5%2FScreenshot%202023-02-27%20at%201.54.48%20PM.png?alt=media&amp;token=48169e45-1d6e-4853-80b0-a78a15e4e66c" alt=""><figcaption><p>Create your first forum. </p></figcaption></figure>

After creating a forum, you will be presented with the forum editor.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FMMx1VZElKEA577RSTZg7%2FScreenshot%202024-12-09%20at%209.55.00%E2%80%AFAM.png?alt=media&amp;token=3d2677fa-30d9-4d3c-a966-63128cbecbad" alt=""><figcaption><p>The forum editor includes tools to update translated text, set access permission, and archive or delete a forum.</p></figcaption></figure>

### Editing a Forum

#### Name and Description

Both the name and description support setting translated text for your project's supported languages. See the [Language Support](/seasketch-documentation/administrators-guide/language-support) documentation for instructions on how to provide these translations.&#x20;

The description will appear below the name of a Forum in forum listings, if provided.

### Access control

Users will only be able to post if they are logged in, even for public forums. Forums support both read and write (post) permissions being set independently. This covers several useful scenarios.

* Public forums in which all users can both read and post
* Forums which anyone can read (public read), but require membership in a particular group or admin privileges to post. These can be used for announcements.
* Closed forums which require particular group membership to read and post.

Project administrators will be able to read and post to all forums. See the [Users and Groups](/seasketch-documentation/administrators-guide/users-and-groups#user-groups) documentation for details on how to assign users to groups.

### Archiving a Forum

Enable this setting if you would like to disable and hide a forum, but not delete the content. Only administrators will be able to view these archived forums. Disabling the archive setting will restore the visibility of the forum to authorized users.

### Deleting a Forum

Deleting a forum is a permanent operation. To prevent loss of important information, it is only possible to delete a forum which has fewer than 10 posts. In almost all cases, it is best to simply archive a forum that is no longer used unless it was only used for evaluating or testing SeaSketch functionality.


# Surveys

A flexible tool for data collection.

Surveys are a useful tool for collecting information. We use them most commonly for gathering information on the distribution of valued places in and around the ocean. Surveys can be crowdsourced (if the survey is simple) or facilitated (our most common use case). Questions may be conditional, optional and may require drawing on a map to collect spatial information.&#x20;

Survey results may be exported by an administrator as CSV (for non-spatial information) or geojson (for spatial information and associated attributes). At this time, survey results cannot be analyzed in SeaSketch and must be exported for use with desktop tools. We have developed an R-Shiny application for monitoring survey results and several open-source tools for analyzing the spatial results. For information on these tools, contact <support@seasketch.org>.&#x20;

## Creating a Survey

Click Create a New Survey and give your survey a name. Note that this name is simply an internal name (Ie., not what your users will see) and I intended to simply distinguish the survey from others you've created as you create more.&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2F2nbmkIgy0TLyCOb1jZ6g%2FScreenshot%202023-02-27%20at%202.04.01%20PM.png?alt=media&amp;token=0ef40c56-a0c4-4782-a0e0-c026bc3b63f1" alt=""><figcaption><p>I have created "Will's Test Survey" which is still in Draft mode so that nobody but administrators may see it. </p></figcaption></figure>

Click "Edit Form" to reveal the form editor. As you can tell, the form editor is extremely rich. We recommend taking the time to click through all of these options to get a sense of what the survey can do. By default, your survey will have five survey elements:

* **Welcome to the Survey** (may be edited, not deleted)
* **Informed Consent** (may be edited or deleted)
* **What is your name** (may be edited or deleted)
* **Save Screen** (may be edited, not deleted)
* **Thank You For Your Response** (may be edited, not deleted)

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2F5wQZQHumGKtyEIdBBvRv%2FScreenshot%202023-02-27%20at%202.10.09%20PM.png?alt=media&amp;token=ce105857-c1f9-4464-a6a8-8e812691e660" alt=""><figcaption><p>The Survey Form Editor</p></figcaption></figure>

Click "Base Settings" and notice that you can select among a growing list of supported languages. If you want to issue your survey using one of the listed langauges, you must first ensure that the survey interface has been translated (we use a tool called [POEditor](https://poeditor.com/)). If the interface has been translated, then you will only need to translate the survey content (ie., the questions).

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FqPRkJjnRDyiLdUhTGryB%2FScreenshot%202023-02-27%20at%202.14.09%20PM.png?alt=media&amp;token=f78340bd-a511-4901-b93f-dd4fdbef8290" alt=""><figcaption><p>Here I have chosen to conduct a survey in both English and Portuguese. </p></figcaption></figure>

To return to the main page of the survey editor, click the "Welcome to the Surv..." button under Forum Elements on the left.&#x20;

If you have selected multiple languages for your survey, as I did above, you will see yellow dropdown flags that allow you to switch between language content.&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FdVy77bp4f0r76rH2YCKO%2FScreenshot%202023-02-27%20at%202.18.11%20PM.png?alt=media&amp;token=bee7e6f9-ceec-4dc8-a2c6-dee291dd4ade" alt=""><figcaption><p>I will begin with the English translation first. </p></figcaption></figure>

The appearance of your survey is highly customizable. You can change background images, colors, layout, etc. Click "Choose image..." to select an open source image from Unsplash.&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FPgkYw5NH5UboRf67K8JI%2FScreenshot%202023-02-27%20at%202.20.38%20PM.png?alt=media&amp;token=83a4afcf-a896-4d55-96fb-5dc5e5c05e57" alt=""><figcaption><p>Searching for kelp images from Unspash.com</p></figcaption></figure>

{% hint style="info" %}
Note that adding more images to your survey will increase the size of your survey. This will slow down loading your survey depending on the quality of your respondents Internet connection and bandwidth. To ensure fast loading, minimize the number of unique images you use in your survey.&#x20;
{% endhint %}

### Informed Consent

Many surveys will require an informed consent that, for example, lays out how user responses will be stored, shared or archived. If you do not require an informed consent in your survey, you may delete this form element by choosing "Delete Element" on the informed consent page.&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FHvg3Vm8Elomo8TqzOaFf%2FScreenshot%202023-02-27%20at%202.24.56%20PM.png?alt=media&amp;token=bc03a834-b587-4579-8b51-16bdb5001731" alt=""><figcaption><p>Informed consent element</p></figcaption></figure>

Replace the placeholder text with information to help users understand why you've asked for their informed consent. Drag and drop a document (e.g., PDF) with your consent form. Every time you drag and drop a new document, your consent form is versioned and SeaSketch keeps track of which version a user has agreed to.&#x20;

### What is your name?

Surveys usually take two forms: facilitated and unfacilitated. In facilitated surveys, a respondent sits with a facilitator who asks questions and uses the SeaSketch survey tool to enter the responses. In an unfacilitated - or crowdsourced - survey, the respondent enters the data directly Ito SeaSketch.&#x20;

By default, all surveys include the question, "What is your name?" While this element may be deleted, we almost always find it useful to collect user names and (if used) facilitator names.&#x20;

If your survey is facilitated, keep "Show Facilitation Option" toggled on.&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FvnqLh5dN8wv2OPaHKqGb%2FScreenshot%202023-02-28%20at%203.19.49%20PM.png?alt=media&amp;token=5545c170-ddb9-4e10-9b4b-1b16a768f69c" alt=""><figcaption><p>This survey will include the facilitattion option. </p></figcaption></figure>

{% hint style="info" %}
If you toggle on the facilitation option, facilitators will need to click on "Settings" and toggle on "Facilitated Response" before beginning a survey.&#x20;
{% endhint %}

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FELpoRTHxZGU0Op8Q2CGr%2FScreenshot%202023-02-28%20at%203.26.58%20PM.png?alt=media&amp;token=a93e5006-340d-43b4-966f-dbcf1f9b7a95" alt=""><figcaption><p>Note the "Settings" in the bottom left corner of the survey homepage. </p></figcaption></figure>

{% hint style="info" %}
To see how your survey looks at any point I development, click "Preview Survey" button in the top right of the page.&#x20;
{% endhint %}

### Additional Form Elements

Clicking on the "Add" button at the top of your form elements will reveal a wide variety of elements you may wish to add to your survey. They include:

* **Email**: Validated email input
* **Consent**: Data sharing agreement
* **Multiple Choice:** Choose one or more values
* **Short Text:** Single line of text for short answers
* **Text Area:** Longer text input
* **Number**: Single integer input
* **Rating**: Numeric rating (1-5 stars)
* **Statement**: Rich text block
* **Yes/No**: Boolean input
* **Combo Box**: For large lists of options
* **Matrix**: Choose values for multiple items
* **Multiple Locations**: Collect spatial features with attributes.&#x20;
* **Spatial Access Priority**: Prioritize by location.&#x20;

{% hint style="info" %}
We think that most of these form elements are pretty straight forward. [Contact us](mailto:support@seasketch.org) if you need help sorting these out. For now, we'll provide a little more detail on what is undoubtedly going to be two of the most useful form elements in spatial planning: Multiple Locations and Spatial Access Priority.&#x20;
{% endhint %}

#### Multiple Locations

The Multiple Locations form element allows users to draw points lines or polygons and, if so configured, enter attributes for these geographic features.

Click "Add" and choose "Multiple Locations" from the Form Elements side bar. Replace the default text (Where have you seen this species?) with the question you want to ask. For example, "Where do you fish?" Then, select whether this question will require the user to draw a point, line or polygon. By default, the user will draw polygons.&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FvdOtgW8mKNvHoPWBqqqo%2FScreenshot%202023-02-28%20at%203.51.01%20PM.png?alt=media&amp;token=fab86150-45e2-41e3-8ccb-a9ec9d6ca7ca" alt=""><figcaption><p>Configuring a Multiple Locations form element. </p></figcaption></figure>

Select a basemap to use for this question. These are MapBox-based maps that have been added to your project under [Data Layers.](/seasketch-documentation/administrators-guide/overlay-layers)[ ](/seasketch-documentation/administrators-guide/overlay-layers#maps)You may also point to a new basemap that you have published in MapBox.&#x20;

{% hint style="info" %}
Notice the dropdown list just above your question? Look through each of these and you'll see some sub-questions that should be customized. You'll also notice two unique questions that pertain to how the question is presented on mobile devices.&#x20;

![](https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2F2szFZDpFS21wx3LmXih6%2FScreenshot%202023-02-28%20at%203.52.46%20PM.png?alt=media\&token=84a6beca-1d01-4c99-a849-f93e73cb5cc7)
{% endhint %}

Under your Multiple Locations question in the Form Elements side bar, you'll see a list of Spatial Attributes starting with Location Name which is always required. Click "Add element" and you'll the same list of form elements you saw above, with only two missing (Multiple Locations and Spatial Access Priority).&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FxrCvGt1lGkoR44KXWIiD%2FScreenshot%202023-02-28%20at%204.00.35%20PM.png?alt=media&amp;token=b566f535-7ced-4453-adf3-6437ee6cbfb8" alt=""><figcaption><p>Adding elements as spatial attributes. </p></figcaption></figure>


# Offline Support

Surveys may be configured for use offline.

Working with SeaSketch in remote or disconnected environments is only possible if the tool has been configured for offline use. For now, this feature is limited to the Survey Tool but we intend to extend this to the Planning tool as well.&#x20;

Configuring a survey for offline use is only possible for SeaSketch Developers within the McClintock Lab at UCSB. Please [contact us](mailto:support@seasketch.org) if this is a necessary feature for your project and we can discuss the possibility of enabling this feature for you.&#x20;


# Language Support

Translating your content to support multiple languages.

If you have enabled support for multiple languages under [Basic Settings](/seasketch-documentation/administrators-guide/basic-settings), you'll start to see some options available to you in [Data Layers](/seasketch-documentation/administrators-guide/overlay-layers), [Sketch Classes](/seasketch-documentation/administrators-guide/sketch-classes), [Forums](/seasketch-documentation/administrators-guide/forums) and [Surveys](/seasketch-documentation/administrators-guide/surveys). When navigating the administrative (and user) interface, look for the <img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FinrGIIUKdkPIv6AjZa2V%2FScreenshot%202023-04-28%20at%2012.21.01%20PM.png?alt=media&amp;token=d7c18927-3a75-4aa2-bd4f-47367fc4cca0" alt="" data-size="line"> icon indicating that multi-language support is provided.&#x20;

## <mark style="color:blue;">Data Layers</mark>

Data layers have a single property that can be translated into multiple languages: Title. This is name of the layer as it appears to end users. To edit the name of a layer, navigate to Data Layers > Overlay Layers, right click on the name of a layer and choose Edit. (This was covered in the [Data Layers](/seasketch-documentation/administrators-guide/overlay-layers) section.) Under the Settings tab, click on <img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FinrGIIUKdkPIv6AjZa2V%2FScreenshot%202023-04-28%20at%2012.21.01%20PM.png?alt=media&amp;token=d7c18927-3a75-4aa2-bd4f-47367fc4cca0" alt="" data-size="line"> to view your options.&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FJbsfREEXcr1Ivpp18WEq%2FScreenshot%202023-04-28%20at%2012.32.50%20PM.png?alt=media&amp;token=29596572-48a1-49be-9bc9-37c2afaaa202" alt=""><figcaption><p>I've enabled multi-language support in this project so that I can view the names of data layers in either English or Portuguese. </p></figcaption></figure>

For each layer, enter the translations for all of the languages you have indicated you want supported in your project and click save.&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FtnBzy5ar3eEUPA0sIhys%2FScreenshot%202023-04-28%20at%2012.34.20%20PM.png?alt=media&amp;token=312c5d50-28b1-425f-a966-737b5509e443" alt=""><figcaption><p>The default name for this layer is "Caution". I've used Google Translate to translate this into Portuguese, "Cuidado". </p></figcaption></figure>

When you have published your data layers, users will be able to view layer names in either English or Portuguese.&#x20;

## <mark style="color:blue;">Sketch Classes</mark>

Sketch class names, attributes and attribute values can all be viewed in multiple languages. Once you have created your sketch class and added attributes using the [steps described ](/seasketch-documentation/administrators-guide/sketch-classes)[previously](/seasketch-documentation/administrators-guide/sketch-classes), in the Settings dialog, click the <img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FinrGIIUKdkPIv6AjZa2V%2FScreenshot%202023-04-28%20at%2012.21.01%20PM.png?alt=media&amp;token=d7c18927-3a75-4aa2-bd4f-47367fc4cca0" alt="" data-size="line"> icon to enter in one or more translations for the sketch class name.&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2Fiy2Yc1eskFkLre7WfGx0%2FScreenshot%202023-04-28%20at%2012.48.55%20PM.png?alt=media&amp;token=8fb6f6a8-c9cd-4e7d-9a93-0463aff9b86b" alt=""><figcaption><p>I've left the default English sketch class name (MPA) but added a Portuguese translation (Área Marinha Protegida). </p></figcaption></figure>

### Sketch class attributes

The "name" field will always be auto-translated based on the interface language you've selected. I'm viewing the administrative dashboard in English, so the name field is labeled "Name".&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FrtqgB8vVpJYJZTmkm7jx%2FScreenshot%202023-04-28%20at%2012.53.26%20PM.png?alt=media&amp;token=72edc0b9-e745-4203-b05d-a8ad4980275b" alt=""><figcaption></figcaption></figure>

The text for attributes (e.g., questions or subquestions) can be translated by clicking on the dropdown at the top of the attribute form and selecting a different language. Below, I've selected "French" and added translations from the original English ("What ecosystems and features are in your chosen area? Choose as many ecosystems and features as there are in the area.").&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FxZJAHzivPakDEOTYMXWV%2FScreenshot%202023-04-28%20at%2012.57.34%20PM.png?alt=media&amp;token=bef7985f-7d35-44f3-9d9b-d3f8623b9508" alt=""><figcaption><p>Viewing the attribute form with French translations (originally in English). This project also supports Portuguese and Spanish translations. </p></figcaption></figure>

In Multiple Choice, Combo Box or Matrix fields, you will need to translate the labels for each option, while keeping the values the same. In the example below, I'm viewing the labels and values for a Multiple Choice field in English:

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FYevC9fs6UlqiwgN08CZt%2FScreenshot%202023-04-28%20at%201.03.34%20PM.png?alt=media&amp;token=7dbf0e5d-5de2-4881-b58c-0894b4bd1dfa" alt=""><figcaption><p>Viewing multiple choice labels and values in English. </p></figcaption></figure>

Clicking the dropdown menu and choosing French, shows how I have translated the labels into French, but the kept the values for each option in the original English. As the instructions in the dialog indicate, values are not required. However, if you use them for, say, exporting user drawn shapes for use in a desktop GIS, you need to ensure that the values are consistent between languages.&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FMkpTNADmbD26LME39ZJ1%2FScreenshot%202023-04-28%20at%201.07.59%20PM.png?alt=media&amp;token=13d5acf8-1812-498c-93cc-826c26128a14" alt=""><figcaption><p>I've translated the labels for this multiple choice field into French, but kept the values the same (in the original English). </p></figcaption></figure>

## <mark style="color:blue;">Surveys</mark>

Surveys are a big topic and, for now, we'll just cover a few items. Take some time to play around with the survey tool builder described [here](/seasketch-documentation/administrators-guide/surveys), and look for the <img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FinrGIIUKdkPIv6AjZa2V%2FScreenshot%202023-04-28%20at%2012.21.01%20PM.png?alt=media&amp;token=d7c18927-3a75-4aa2-bd4f-47367fc4cca0" alt="" data-size="line"> icon for places where you can provide translation for your survey content.&#x20;

In short, you can provide translations for every element of your survey, including:

* Introductory paragraph
* "Begin" button
* All of the content for forms, including questions and options.&#x20;
* The save screen and the "Thank you" screen

The instructions for providing translations are basically the same as they are for the sections on sketch class attributes ([above](/seasketch-documentation/administrators-guide/language-support#sketch-class-attributes)). Try it out and if you have questions, email [Will McClintock](mailto:undefined) for help.&#x20;


# Reports

Full documentation for the report builder is coming soon.


# Debugging Timeout and Performance Issues

SeaSketch's overlay engine can perform calculations on large raster and vector datasets, but how your data is structured, and the options you choose when setting up your reports, can have a big impact on whether calculations can complete. Typically, you should expect calculations performed on sketches to complete in 1 - 5 seconds. Calculations for entire *geographies* can take longer, but will only be performed once during report authoring and then be cached. The overlay engine usually calculates results quickly or fails entirely.&#x20;

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2Fv221BhgvMOigXOeNnlAU%2FScreenshot%202026-06-25%20at%2011.00.32%E2%80%AFAM.png?alt=media&amp;token=380edc72-d5b5-43dc-8ca1-e4666f60e013" alt=""><figcaption></figcaption></figure>

When a failure occurs, you will be given the option to **View Details**, which opens the above modal window. The status of every metric related to that visualization widget is displayed, and by hovering over the status indicator you can see a popup with further details on the parameters used and nature of the error. This information can be used to fix some issues yourself, or [contact the SeaSketch team](mailto:support@seasketch.org) for further assistance.

If you regularly see timeouts or other errors while authoring a report, consider the following impacts on performance.

## Impact of Geography Configuration

Reports currently work best when your geographies are based on the built-in Exclusive Economic Zones, optionally clipping to land. A great deal of effort has gone into optimizing calculations even with the complex open-streetmap-based shoreline using subdivided sources.&#x20;

### Custom Geographies

If you opt to create a custom geography using an uploaded polygon, the complexity of that shape (number of vertices) will have a large impact on how fast overlap can be calculated. Particularly when calculating geography-wide stats. If using a custom layer for your geographies, consider the following best practices:

* Polygon layers should be as simple as possible. If your geography consists of many megabytes of vertices, all that data will complicate and slow overlay analysis.
* Rather than basing your geography on a custom polygon that includes complex shoreline contours, build a simpler boundary that overlaps the land. Then, when creating the geography, enable the **Remove Land** option. This will use our subdivided coastline dataset, which SeaSketch is heavily optimized for.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FywsACI4fhqZZx0lYzs8e%2FScreenshot%202026-06-25%20at%2011.23.10%E2%80%AFAM.png?alt=media&amp;token=3173966c-ad76-41cd-a114-872dbb75d023" alt="" width="375"><figcaption></figcaption></figure>

In the future we hope to provide tools to subdivide and better optimize calculations on complex custom geographies, but for now it is important to understand these tradeoffs.

### High Seas Planning

When using the built-in High Seas geography, many calculations must consider the entire global contours of the high seas polygon. Performance is similar to using a very complex custom geography as described above. For now, this limits the size and complexity of data that can be used in overlay analysis. We hope to further optimize performance for this use-case in the near future.

## Overlapping Polygon Settings

When performing overlapping area calculations on polygon layers, SeaSketch has essentially two different paths it can take — a fast batching algorithm, and a slow algorithm that performs calculations on individual features. The system looks at data during preprocessing and looks for overlap in a sampling of features. If it finds overlap, it will automatically select the slower algorithm when performing calculations. You can manually choose which algorithm to use by adjusting the source options of report widgets like the Overlapping Area Table as shown in the screenshot below. **Source options** are typically found within the **rows** submenu.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FNuExlraZkDUCgLnuZpPp%2FScreenshot%202026-06-25%20at%2012.17.35%E2%80%AFPM.png?alt=media&amp;token=1bb83e34-a9f1-4a3b-9e9e-3857134c4422" alt=""><figcaption></figcaption></figure>

If you have a dataset where polygons do not ever overlap, you should always use the faster option (*Assume no overlap*). For very large datasets, it's very common that the slower algorithm cannot even be completed without timing out. If there is overlap and you choose this faster option, it can introduce inaccuracies. The system will union overlapping polygons, eliminating overlap in the area calculation. It can still be acceptable to choose the faster algorithm with overlapping features in these circumstances:

1. If overlap is negligible. This can occur in vectorized raster sources, but also in other instances, where there is minor overlap in the edges of some polygons.
2. If overlap only occurs among features belonging to different class keys, and you are using the **Group by** option with that class key, then the faster batching algorithm will not batch those features and it is completely safe to use it.

### Examples of Overlapping Polygon Situations

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2F4Xz8xLNAcUa4yswifGgy%2FScreenshot%202026-06-25%20at%2012.33.04%E2%80%AFPM.png?alt=media&amp;token=e7028323-f61a-4a3a-aa00-6889745ecca7" alt=""><figcaption></figcaption></figure>

Here, we have a layer of *Ecologically and Biologically Significant Areas*. There are two areas here that significantly overlap. If we wanted to report on the percent of EBSAs included in the EEZ that our sketches overlapped, we ***would*** want to use the "Polygons are known to overlap" setting. If not, areas covered by both EBSAs could be unioned before overlay analysis, resulting in 50% less area measured. Since this is a simple dataset with few, relatively simple features, it's unlikely that we would have a problem calculating metrics with the slower algorithm anyways.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FPveYyjId3kAgU6oFEbx4%2FScreenshot%202026-06-25%20at%2012.39.23%E2%80%AFPM.png?alt=media&amp;token=ce8f4f93-e5ab-456a-872a-2245a1590e8f" alt=""><figcaption></figcaption></figure>

In the example above, we have a habitat classification layer that has numerous overlapping features. This is a large (58MB) layer covering the entire Brasilian EEZ, so calculating metrics for the entire geography using the slower algorithm was failing. Luckily we were able to safely enable the faster algorithm which ignores overlap, since in our reports we are grouping results by a class key. It appears that when this layer was made, there were possibly multiple datasets with different classification schemes merged, and so there is overlap between them. Importantly though, there is no overlap between features within a habitat class. SeaSketch cannot detect this reliably, but it is easy to identify by looking at the map. Had there been overlap between features within the same classification it would not be possible to use the optimized algorithm without first cleaning up the dataset in desktop GIS.

## Raster VRM Settings

This settings controls the amount of [virtual resampling](https://observablehq.com/@danieljdufour/geoblaze-virtual-resampling-demo) applied to raster pixels before calculating metrics on a sketch (or geography). To understand why resampling may be necessary, consider the example below.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2Fv4AipQm9kgSnF1trQRzL%2FScreenshot%202026-06-25%20at%201.28.18%E2%80%AFPM.png?alt=media&amp;token=3fea857e-412d-4b57-a95b-f70cf683c35d" alt="" width="375"><figcaption></figcaption></figure>

In this situation we have an area of interest (AOI) drawn over a raster layer, with pixel values that range from 0 - 1. The majority of the AOI covers very low or zero values, and a small proportion (<10%) covers a pixel valued at 1. Typical desktop GIS tools would calculate zonal statistics using one of two different methods.

1. All-touched, which in this case would count all 4 pixels the polygon overlaps. 3 very low value pixels and 1 very high value.
2. Cell-center methods would only count pixels where the AOI overlaps the pixel's centerpoint. In this case, only the single, low-value pixel in the center would count.

Neither of these methods are ideal. Cell-center doesn't represent the high-valued yellow pixel at all in zonal statistics, and all-touched weighs it equally to all the other pixels, skewing statistics.&#x20;

Ideally we'd count fractional pixel values in statistics, and virtual resampling is how that is done. Depending on the VRM setting, each pixel is divided into up into 4, 8, 16 or up to 100 parts. Only then is [intersection calculated against for the area of interest](https://medium.com/@DanielJDufour/calculating-intersection-of-polygon-with-a-raster-89c2624d78a2). SeaSketch relies on an open-source library, [geoblaze](https://github.com/GeoTIFF/geoblaze), to perform these virtual resampling and zonal statistics calculations.

SeaSketch automatically assigns VRM settings when you embed a raster reporting widget, and for the most part these settings work well. If you see errors relating to "Invalid array length", or results that don't line up with your expectations, you may need to manually choose your settings.

* auto - SeaSketch chooses an appropriate VRM setting based on the size of the sketch being analyzed and the pixel size of the raster. This is the default.
* disabled - [geoblaze intersection algorithm](https://medium.com/@DanielJDufour/calculating-intersection-of-polygon-with-a-raster-89c2624d78a2) is applied on unaltered, full-size pixels.
* 2 - divides each pixel, creating a 2 × 2 grid, or 4 virtual pixels per original pixel.
* 4 - creates a 4 × 4 grid, or 16 virtual pixels per original pixel.
* 12
* 32
* 64
* 100 - creates a 100 × 100 grid, or 10,000 virtual pixels per original pixel.

#### Performance considerations when using virtual resampling

Higher VRM values can produce more accurate statistics, but higher values can quickly exhaust limited memory. Consider a 16-bit raster. If a bounding box around an analyzed feature contains 100x100 pixels, and a setting of 100 VRM is applied, that's 1 trillion pixels which would require 2 TB of memory. This is how *"Invalid array length"* errors occur. If this happens, reduce or disable virtual resampling using the menu shown below. If the `auto` setting is resulting in these errors, please create a [ticket in github](https://github.com/seasketch/next/issues) or [contact support](mailto:support@seasketch.org) so we can improve the system.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2Fhs8c6V6FQArwTb3705Cw%2FScreenshot%202026-06-25%20at%202.00.52%E2%80%AFPM.png?alt=media&amp;token=a72721de-a2d5-41c9-acb1-284ab4109e9b" alt=""><figcaption></figcaption></figure>

It is important to note that you can set VRM parameters for analysis of sketches and geography-wide statistics seperately. Usually, geographies are so large compared to pixels that VRM can be disabled or set to a very low value and still calculate very accurate statistics.


# Getting Started

{% hint style="info" %}
This article covers:

* [SeaSketch project layout](#project-page-layout)
* [Signing in](#signing-in)
* [Creating your profile and joining a project](#creating-your-profile-and-joining-a-project)
  {% endhint %}

## Project Page Layout

On any SeaSketch project homepage you'll see a layout like the one below. The map will look different depending on the project.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FnVXubWIgVPgvwVriK7Os%2Fproject-page.png?alt=media&amp;token=a0dff38a-0ebb-4a5e-a861-e14237f931c2" alt=""><figcaption></figcaption></figure>

This interface is composed of the main menu on the left where you can navigate to the various tools and options the platform offers, and the map viewer on the right. These elements are described in detail in their respective guides.

The arrow at the top right of the menu will collapse the menu panel for a better view of the map. Clicking the SeaSketch icon in the bottom left will take you to the main SeaSketch homepage.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FETCfuGpZiQvIc1BrYqbZ%2Fproject-page-layout.png?alt=media&amp;token=8c95b0bc-6008-44ac-b115-7bf94928828b" alt=""><figcaption></figcaption></figure>

### Language Selection

You can select a language to view the app in by clicking the menu item shown below. The language options will be dependent on the project.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FEVXk9pekaIf1iF9ZXmt4%2Fchoose-language.png?alt=media&amp;token=c9dc2411-e611-49c3-9396-8692fa997a85" alt=""><figcaption></figcaption></figure>

## Signing In

In order to contribute to a project you have to be logged in. To do so, click 'Sign In' on the main menu. Here, you may enter your SeaSketch account credentials, sign in using Google, or create an account, as shown below.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FvNiKTPuwZqCX29r4QB6x%2Fseasketch-signin.png?alt=media&amp;token=7e8e1342-14ba-4d93-978b-439fea4c702d" alt=""><figcaption></figcaption></figure>

## Creating Your Profile and Joining a Project

Once you've logged into your account, you can create a profile and join the project. Joining a project is necessary to participate in discussion forums and allows administrators to grant you access to protected data layers.

To create your profile start by clicking 'My Profile' on the main menu — this should appear as an option if you have successfully signed in to your account. That link will take you here:

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FjZxdgwvrkr3b17TEzA4G%2FScreenshot%202023-02-28%20at%2010.39.19%20AM.png?alt=media&amp;token=e7ec6eb9-fd1e-414d-85c2-e97e1ea97a9d" alt=""><figcaption></figcaption></figure>

From this page you can edit your profile. The only field required to join the project is your full name, but we encourage you to add a profile picture, nickname (username), email, and affiliations to better identify yourself in discussion forums.\
\
Simply fill in your name, add any optional information, and click 'Join Project'. Once you've joined, you should be returned to the project homepage. You can edit your profile at any time by clicking the same 'My Profile' link.\
\
Once you've joined the project, you can start exploring and contributing! The full suite of SeaSketch tools you can use to do so are outlined in the following pages.


# The Map Viewer

{% hint style="info" %}
This article covers:

* [Navigating the map](#navigating-the-map)
* [Choosing basemaps](#choosing-basemaps)
  {% endhint %}

## Navigating the map

***To move around*** the map, click and drag.

***To zoom in and out*****,** you can use the <img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FtfJyBqDVhLXGeKnw45e3%2Fzoom-in-icon.png?alt=media&amp;token=08cbff64-dbaa-41d2-88cf-480addc8ab10" alt="" data-size="line"> and <img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2F7uJVhJ0w2chZPP8PAtff%2Fzoom-out-icon.png?alt=media&amp;token=9f597ecc-8d50-45e9-bf6f-77705f28a032" alt="" data-size="line"> buttons in the top right corner of the map, or the scroll wheel on your mouse (or equivalent hand gesture on a touchpad). Using the scroll wheel or touchpad offers more granular zooming.

***To rotate the map or adjust the viewing angle***, right click and drag. To return to a northward orientation, you can click the <img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2Fwe8TxBWdmohf9CN02uwM%2Fcompass-icon.png?alt=media&amp;token=3edd70a8-250b-4018-b92c-9a2542fbdeb6" alt="" data-size="line"> button in the top right

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2Ft4SjNiyAVtFtjaripbkQ%2Fmapviewer_layout_multi-arrow.png?alt=media&amp;token=ff645e06-8da9-497d-b1d0-7ed94ef56b22" alt=""><figcaption></figcaption></figure>

***To zoom in on a particular area***, hold `shift` and click and drag your cursor. A rectangle should appear — this rectangle will become the new bounds of the map viewer window.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2F9lC1ZyYnmuEr0zP8R21K%2Fzoom-select.gif?alt=media&amp;token=d514b8ce-69d8-445a-b2b1-d3b344442bff" alt=""><figcaption></figcaption></figure>

***To zoom to the extent of a data layer*****,** right click on the layer and and click 'Zoom to bounds'

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FJPoJrUf2oqvqCWo18fBp%2FZoom%20to%20bounds.png?alt=media&amp;token=36719f07-334d-4784-be62-bd9b6899ad64" alt=""><figcaption></figcaption></figure>

## Choosing basemaps

SeaSketch allows you to choose between different map viewer basemaps. The selection of basemaps depends on the project. To select a different basemap, click 'Maps' in the main menu or the map icon  if the menu is collapsed. You'll see the following panel and can click on your desired basemap:

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FS77adyhD7ppEjfEKNQEo%2Fchoose-basemap.png?alt=media&amp;token=52d9f090-72ef-4386-b442-8cafd725a1a3" alt=""><figcaption></figcaption></figure>


# Overlay Layers

{% hint style="info" %}
This article covers:

* [Viewing data in the map viewer](#viewing-data-layers-in-the-map-viewer)
* [Layer values](#layer-values)
* [Viewing metadata](#viewing-metadata)
  {% endhint %}

## Viewing Data Layers in the Map Viewer

To view the list of data layers contained in the project click 'Overlay Layers' or the layer stack <img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2F5atkUcSiPbuQ83tdO5hM%2Fimage%20(1)%20(1)%20(1).png?alt=media&amp;token=45a6dbfb-75e0-4ed3-9058-3685d0e8d347" alt="" data-size="line"> icon.\
\
In most projects, layers will be organized into folders. Click the arrow <img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FqffKbeFeaxCpwpVJGWbR%2Fimage%20(8).png?alt=media&amp;token=925e7d0d-55e6-4996-914b-df0ee839da3d" alt="" data-size="line"> next to a folder to expand the contents. Check the box next to a layer name to add it to the map. In some cases, you can add multiple layers at a time by checking the box next to the name of the folder containing multiple layers.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FbWflDDL0P59wbQo61FWs%2FScreenshot%202023-03-06%20at%209.06.04%20PM.png?alt=media&amp;token=b6f903ec-dbb4-4718-b2dd-ba48d45356f8" alt=""><figcaption></figcaption></figure>

## Layer Values

The layer legend appears in the upper right corner. Layers may be hidden by clicking the&#x20;

Icon and clicking the      icon will reveal a menu with various options including ‘Zoom to bounds’, ‘View metadata’, ‘Download…’ (if the download feature is enabled for the layer), ‘Move to front’, ‘Move to back’ and ‘Opacity’.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2Fy14V2HRHwoPCmjg1OnKr%2FLayer%20values%201.png?alt=media&amp;token=ccf97a69-ab5e-4e1a-bc64-0125e5482323" alt=""><figcaption></figcaption></figure>

Some layers will display their attributes when you hover your cursor over them. This may be a feature classification (like the example below), or a pixel value.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2Fs3VhhfvTqhSKV94ooiNd%2Ftooltip%20(2).png?alt=media&amp;token=056830aa-5d40-4cae-8e4f-1ef87c4d2dc3" alt=""><figcaption></figcaption></figure>

## Viewing Metadata

To view a layer's metadata (information about the layer), right click and select 'Metadata' from the drop down menu. The information contained in the metadata will depend on what the project administrators chose to include.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2F0tyKLVIeAZ8RLSRBpiUk%2FScreenshot%202024-07-02%20at%2011.38.15%E2%80%AFAM.png?alt=media&amp;token=d4f43c34-25dc-429c-a203-e680926b9dce" alt=""><figcaption><p>View metata using the context menu accessed by right clicking on a layer name. </p></figcaption></figure>

## Downloading Layers

Right clicking on a layer name may also show the option to download the layer. **This option is only available if an administrator has explicitly turned ‘on’ data downloads for this layer.** If you select ‘Download’ from the context menu, you may choose to download the layer in its original format or optional formats. The list of formats will grow over time as we develop this feature.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FZFsuye2RtjcUtwxuswDZ%2Fdata%20download.png?alt=media&amp;token=84fe7135-2da6-40e8-bfa1-c67db6f54af0" alt=""><figcaption></figcaption></figure>


# Sketching Tools

{% hint style="info" %}
This article covers:

* [Navigating to sketching tools](#navigating-to-sketching-tools)
* [Creating a new sketch](#create-a-new-sketch)
* [Sketching](#sketching)
  * [Sketching a shape](#sketching-a-shape)
  * [Automatic clipping](#automatic-clipping)
  * [Editing and deleting shapes](#editing-and-deleting-shapes)
  * [Adding a name and description](#adding-a-name-and-description)
* [Organizing Sketches](#organizing-sketches)
* [Downloading Sketches](#downloading-sketches)
  {% endhint %}

## Navigating to Sketching Tools

To get started sketching, click 'Sketching Tools' or the polygon symbol <img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FxpcZ7gM8pniAnY0kxCTl%2Fimage%20(11)%20(1).png?alt=media&amp;token=2c2310e8-553b-4c74-ba5d-2ae2a9808eea" alt="" data-size="line"> in the main menu. If you haven't made any sketches yet, the panel that appears will be blank as shown below.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FpFYgXgnu5btTHe5ocg9o%2FScreenshot%202023-03-09%20at%201.42.56%20PM.png?alt=media&amp;token=5eedc058-2ce0-401f-87a3-3a43c1fa3be5" alt=""><figcaption></figcaption></figure>

## Create a New Sketch

To create a sketch, click <img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2F2lBihWNNbbsBnfyaVLDx%2Fimage%20(6).png?alt=media&amp;token=b0890cea-ab2c-454a-b138-676ae9ae8a33" alt="" data-size="line"> at the top of the panel. A dropdown menu will appear containing the various "sketch classes" that pertain to your project. The exact list of classes and parameters associated with each class tend to be unique to each project. If you're not sure which sketch class to use, talk to a project administrator.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FMeQMsjZmAjpNWqqLsGyU%2Fsketching.png?alt=media&amp;token=e567403a-4633-401b-9d58-906768d63c00" alt=""><figcaption></figcaption></figure>

## Sketching

Once you've selected the type of sketch you want to create, you'll enter the sketching interface in which you can draw your desired area on the map and give it a name and description.

### Sketching a shape

To start sketching, move your cursor onto the map viewer and click to create the first vertex of your polygon. From here, continue clicking to create additional vertices along the perimeter of your envisioned shape. When your shape is complete you can either double-click the end point or click your starting point to finish editing.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FL4K89DyUYt1hr0OG5S8O%2Fdrawing-shapes-2.gif?alt=media&amp;token=73f16033-498a-4b64-bae3-a34ebff316d8" alt=""><figcaption></figcaption></figure>

### Automatic clipping

When you finish editing a shape, you'll see its boundary briefly light up and become animated. Once this is complete, some parts of your shape might be cropped or clipped out. Most sketch classes will automatically remove certain areas whether they be land, areas extending beyond EEZ boundaries, or other areas specific to the project.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FGqzGJcjTK8yG74VQFdfO%2FScreenshot%202023-03-09%20at%202.44.34%20PM.png?alt=media&amp;token=8ea5c06f-c5a8-4e41-8fe1-590748791780" alt=""><figcaption></figcaption></figure>

### Editing and deleting shapes

Once your shape has finished clipping and appears green and static, you can delete or edit it by clicking on it.

To delete your shape and start over, simply click the trashcan symbol <img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FbF3tHhWPzxzh839bPp8X%2Fimage%20(10).png?alt=media&amp;token=47ae4ec6-65ac-4981-87fa-36314d367c6b" alt="" data-size="line"> in the menu near the bottom of the screen.

To edit your shape, you can drag existing vertices to new locations, or click and drag the smaller orange points between vertices to create new ones.

Click <img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FC7ZxUTdQsjtBSGzI4qag%2Fimage%20(4)%20(1).png?alt=media&amp;token=61a58261-4714-4aab-9071-7cd290850c85" alt="" data-size="line"> at the bottom when finished.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FjOjw1N1yyVKk0z0WNNX8%2Fedit-shapes.png?alt=media&amp;token=9a35d176-0f76-4fba-b8ce-5226d9f14408" alt=""><figcaption></figcaption></figure>

If a sketch has already been created, you can still edit it by clicking it on the map viewer or right clicking its name in the left panel and hitting 'Edit'.

### Adding a name and description

Adding a distinctive name and informative description is crucial for collaborative planning efforts. You can add these details within the sketching interface.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FtQxJPAsxbNE6Xg6jNUWU%2FScreenshot%202023-03-09%20at%203.35.43%20PM.png?alt=media&amp;token=445a1b31-a73d-45cc-816e-f43435b7b338" alt=""><figcaption></figcaption></figure>

## Organizing Sketches

If you create multiple sketches, you can group them in a couple ways. You can create and add sketches to a folder — this is purely for organizational purposes. Or, if they are part of a proposed network of managed areas, you can compile them into a network. Networks can be assessed as a collective area when generating analytics reports. [More on reports in the next section](/seasketch-documentation/users-guide/sketching-tools/reports).

To create a folder or network, click <img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FQCDBfCnEY3w38APVHTGa%2Fimage%20(11).png?alt=media&amp;token=ba9482af-5aca-49bc-89f2-d9a2358d4527" alt="" data-size="line"> and select the respective option from the dropdown menu. After giving the grouping a name (and description in the case of a network), you can drag and drop individual areas to add them to the group.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FYNgk8AivJz6W3tZP20kL%2Fcreate-network-2.gif?alt=media&amp;token=ca14865f-e365-4bd4-b2b1-4703dc16d590" alt=""><figcaption></figcaption></figure>

## Downloading Sketches

You can download any shapes you create as GeoJSON files. Just right click on the area or network you want to download and hit <img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2F0blOBAixC8Rb5IXjSiCx%2Fimage%20(1).png?alt=media&amp;token=be1a38c5-8e28-4c4f-9f16-3a98ec92dd15" alt="" data-size="line">. GeoJSON files can easily be loaded into a desktop GIS program like ArcMap or QGIS.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FQ4gYEXIJe5S3jwM99nXR%2Fdownload-sketch.png?alt=media&amp;token=89c20bf5-bb76-4cbe-b895-e42a93d2589c" alt=""><figcaption></figcaption></figure>


# Reports

{% hint style="info" %}
This article covers:

Reports

* [Generating reports](#generating-reports)
* [Navigating reports](#navigating-reports)
* [Viewing report layers](#viewing-report-layers)
  {% endhint %}

## Reports

### Generating reports

To generate a report, simply right click the name of the area or network in the left panel and hit <img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2F7rVjbFJ3vfzBsE0Y9brb%2Fimage%20(3)%20(1).png?alt=media&amp;token=8a70c1a7-f79a-4ffd-b983-8baa508b7ddb" alt="" data-size="line"> in the dropdown menu

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2F9TXnXJRyRU2qAXy9WUET%2Fview-reports.png?alt=media&amp;token=e7a2d78a-8693-4f19-9d19-55a74766f724" alt=""><figcaption></figcaption></figure>

### Navigating reports

Reports contain at least two sections which you can navigate between using the tabs at the top of the report window. Two common sections are 'Viability' and 'Representation', as shown below. Scrolling down, you can view the various components of the current section.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FMhZFuTnUVmpAKrqsh3Vo%2FScreenshot%202023-03-14%20at%209.44.19%20AM.png?alt=media&amp;token=157c45b7-7b63-46b9-8b99-a79acf68cdc4" alt=""><figcaption></figcaption></figure>

### Viewing report layers

Each report metric is calculated using a specific data layer. You can view the associated layer in the map viewer with the 'Map' toggle <img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FTAsnZrtjbpzoQgeQUBxQ%2Fmap-toggle.png?alt=media&amp;token=e55f4382-d666-4e63-97d4-28e0af462c74" alt="" data-size="line"> located to the right of the report item.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2F1JhcJPm4K9m2Ir1In2NK%2FScreenshot%202023-03-14%20at%2010.48.40%20AM.png?alt=media&amp;token=cf3e474b-b02f-455e-aebf-aeaf360334e7" alt=""><figcaption></figcaption></figure>


# Discussion Forums

{% hint style="info" %}
This article covers:

* [Navigating discussion forums](#navigating-discussion-forums)
* [Viewing discussions and plans](#viewing-discussions-and-plans)
  * [Generating reports on plans](#generating-reports-on-plans)
* [Contributing to discussions and sharing plans](#contributing-to-discussions)
  {% endhint %}

## Navigating Discussion Forums

To access a project's discussion forums, click 'Discussion Forums' or the comment symbol <img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2F7wrqTjdLDrY5mkaSARq2%2Fimage%20(1)%20(4).png?alt=media&amp;token=33358301-0300-4646-a906-e663a376bce9" alt="" data-size="line"> in the main menu. The Discussion Forum layout is shown below.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FSNXrw65tsh0idwn1iuUc%2Fforum-interface%20(3).png?alt=media&amp;token=e2cf0793-fc86-44d9-a6fa-46c4b54f6d93" alt=""><figcaption></figcaption></figure>

## Viewing Discussions and Plans

You can click on a forum and then a thread, or jump right into a thread on the 'Latest Discussions' feed. Once in a thread you'll likely see comments and plans from other project participants. A checkbox appears next plans — click the checkbox to add that plan to the map viewer.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FDwXSSYZsFcVhEEedToK8%2FScreenshot%202023-03-14%20at%203.13.05%20PM.png?alt=media&amp;token=fa601877-daa7-436b-a27e-c6445e4d5f98" alt=""><figcaption></figcaption></figure>

### Generating reports on plans

You can view reports on plans same as in the Overlay Layers interface — simply right click on the plan and select 'View Reports'.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FZsqBXcS786I0p1jARNw8%2Fforum-report.png?alt=media&amp;token=c37c3015-55c0-44aa-b0d8-6d3c582c144b" alt=""><figcaption></figcaption></figure>

## Contributing to Discussions

To contribute, scroll to the bottom of a thread — there you can type a reply and share plans.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FntX8ZqcrBX5eXzK6EMNb%2Fshare-plans%20(1).png?alt=media&amp;token=bcf6a62d-f870-4935-b9d3-f0930c22ce7e" alt=""><figcaption></figcaption></figure>

### Map Bookmarks

You can "bookmark" a particular view of the map just as you see it on your screen and share it with collaborators in a discussion thread. Bookmarking captures the basemap, position, and zoom of the map viewer as well as any visible overlay layers and sketches. This allows other users to see exactly what you're looking at and vice versa.

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FhOHDn7q8IEw197NbAhja%2Fshare-bookmark.png?alt=media&amp;token=c8444483-6c6a-4a22-8b5e-04026c30c70e" alt=""><figcaption><p>Capturing a map bookmark</p></figcaption></figure>

### Map Bookmarks in Action

<figure><img src="https://3101925571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmrOjheW9v23epAZJDsmJ%2Fuploads%2FufUYOlXpPx34n5oyFcDt%2Fmap-bookmark.gif?alt=media&amp;token=82d6643f-f471-4a78-8b4c-6b16276c73a0" alt=""><figcaption><p>Displaying a map bookmark</p></figcaption></figure>


# FAQs

Frequently asked questions

<details>

<summary>What does it mean that SeaSketch is Open Source?</summary>

We use the Free BSD License. It goes like this:&#x20;

Copyright 2020 The Regents of the University of California.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. either the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

</details>

<details>

<summary>How much data can I store in SeaSketch? </summary>

Projects are limited to storing 10 GB of data for free. If more storage is needed, contact <support@seasketch.org>. We are currently working on a means by which interested parties may purchase additional storage but that recharge mechanism has not yet been established.&#x20;

It's worth noting that while SeaSketch offers storage space for data, the platform is primarily designed to facilitate collaborative planning and decision-making processes, rather than to serve as a data repository. That said, it *does* server as an excellent repository that can even be used to store versions of data along with cartographic styles and metadata.

</details>

<details>

<summary>Can I use SeaSketch for commercial purposes?</summary>

See our [Terms of Use](https://next.seasket.ch/terms-of-use) for more information.&#x20;

</details>

<details>

<summary>What are the Terms of Use for SeaSketch?</summary>

Our Terms of Use are published [here](https://next.seasket.ch/terms-of-use).&#x20;

</details>

<details>

<summary>Can I use SeaSketch for educational purposes? </summary>

Yes, SeaSketch can be used for educational purposes. The platform is designed to support collaborative planning and decision-making processes, which can be useful in a variety of educational contexts, from K-12 classrooms to higher education settings.

SeaSketch is essentially free, and it provides up to 10 GB of free storage space, which is sufficient for many educational projects. The platform's collaborative features can also be useful for group projects or class assignments.

In addition to using SeaSketch directly in the classroom, educators and students can also leverage the platform's public projects and datasets for research or other educational purposes. The platform includes a variety of projects and datasets related to marine and coastal conservation, ecosystem management, and other environmental topics, which can provide valuable learning opportunities for students at all levels.

</details>

<details>

<summary>Can I delete users from a project? </summary>

No. Once a user has joined a public or invite-only project, a user cannot be removed from a project. This is to protect any content (such as sketches) that a user has generated. You may, however, ban users from accessing forums, or limit their ability to view data or sketch plans by using access controls.&#x20;

</details>

<details>

<summary>Can users download data? </summary>

SeaSketch provides users with a range of options for downloading and exporting data, depending on the user's needs and permissions.

For example, users with appropriate permissions (e.g., administrators) can download shapefiles, CSV files, or GeoJSON files for specific layers or projects. These files can then be used in other GIS software or analyzed in Excel or other data analysis tools.

Additionally, users with permissions can download layers that have been designated downloadable by administrators. Vector data may be download as shapefiles, GeoJSON and flatgeobufs where raster data may be downloaded as GeoTIFFs.&#x20;

It is important to note, however, that SeaSketch is a collaborative platform that promotes data sharing and collaboration. As such, some data layers may be restricted by the data provider, and users may not be able to download or export them without permission. Additionally, some layers may be designed to be used exclusively within the SeaSketch platform, and may not be available for download.<br>

</details>

<details>

<summary>Are mobile devices supported?</summary>

SeaSketch is a web-based platform that is accessible from any device with a web browser and an internet connection, including mobile devices such as smartphones and tablets. The platform is designed to be responsive and adaptive, meaning that it can adjust to different screen sizes and resolutions, making it accessible and usable on a wide range of devices.

However, it is worth noting that some of the features and tools within SeaSketch may be better suited for use on a desktop or laptop computer, due to the size of the screen and the complexity of the tasks being performed. For example, creating and editing maps may be more challenging on a small screen.

Overall, SeaSketch is accessible and usable on mobile devices, but the suitability of the platform for specific tasks may depend on the user's device and the complexity of the task at hand.

</details>

<details>

<summary>What browsers are supported?</summary>

For now, we recommend using Chrome. We are expanding the list of browsers we support over time.&#x20;

</details>

<details>

<summary>Why use SeaSketch? </summary>

SeaSketch is specifically designed for marine spatial planning, which is a process of allocating human activities in the ocean in a way that minimizes conflict and maximizes sustainable use of resources. Therefore, if you are involved in ocean planning and management, SeaSketch can be an excellent tool for facilitating stakeholder engagement, data visualization, and decision-making.

Some of the unique features of SeaSketch that set it apart from other participatory mapping software include:

1. Marine-specific data and tools: SeaSketch provides marine-specific data and tools that can help users understand ocean ecosystems, biodiversity, and human activities in the ocean. These data and tools are provided by project owners and their collaborators to address the specific needs of marine planning.&#x20;
2. Collaborative decision-making tools: SeaSketch provides a suite of tools that enable stakeholders to participate in collaborative decision-making, such as debating, commenting, and sharing. This can help ensure that all stakeholders have a voice in the planning process and that decisions are made collaboratively.
3. Customizable platform: SeaSketch is an open-source software, which means that users can customize it to meet their specific needs. This can be particularly useful for organizations with unique planning and management requirements.
4. Integration with other systems: SeaSketch can integrate with other data and management systems, such as Geographic Information Systems (GIS), to provide a comprehensive view of ocean ecosystems and activities.
5. Free data hosting up to 10 GB. SeaSketch performs some critical functions for a  Spatial Data Infrastructure (SDI) including the ability to upload and store data and metadata, share those as downloadable (or not), and even store versions of datasets along with cartographic styles.&#x20;

SeaSketch has the potential to accelerate marine spatial planning (MSP) by facilitating stakeholder engagement, data sharing, and collaborative decision-making. By providing a platform for stakeholders to communicate and collaborate in a transparent and efficient way, SeaSketch can help streamline the MSP process and reduce conflict among stakeholders.

SeaSketch provides a suite of tools that enable stakeholders to share data, create and analyze maps, and engage in decision-making processes. These tools can help stakeholders understand the distribution of ocean ecosystems and human activities, identify areas of conflict and overlap, and explore potential solutions to these issues. By enabling stakeholders to work together more effectively, SeaSketch can help accelerate the MSP process and improve outcomes for ocean conservation and management.

However, it is important to note that MSP is a complex and multi-faceted process that involves many stakeholders and factors. While SeaSketch can provide a valuable platform for facilitating MSP, it is just one tool among many that may be needed to achieve successful marine spatial planning and management. Other factors, such as political will, regulatory frameworks, and funding, are also critical for the success of MSP.

</details>


# Is SeaSketch Free?

Yes!

SeaSketch is free for educational and non-profit use. Please read our [Terms of Use](https://next.seasket.ch/terms-of-use) and[ License Agreement](https://github.com/seasketch/next/blob/master/LICENSE). In short, you will find that by following our [user](https://docs.seasketch.org) and [developer](https://github.com/seasketch/geoprocessing/wiki) documentation, you can do a lot on your own to develop your own SeaSketch project.&#x20;

You might find that, eventually, you would like help configuring your SeaSketch application, developing and implementing surveys or facilitating meetings with SeaSketch. If you are interested in exploring how The McClintock Lab at UCSB can be contracted to assist with these tasks, contact [Will McClintock](mailto:will@ucsb.edu) at the National Center for Ecological Analysis and Synthesis, University of California Santa Barbara.&#x20;