Configuration

The configuration pages in Composer allow you to manage data, layers, and maps.

This page will describe the various configuration pages. The next page will discuss viewing and styling layers.

All Project Workspaces

This page, accessible from the navigation panel by clicking Project Workspaces, displays a list of all project workspaces.

../../_images/allprojectworkspaces.png

All Project Workspaces

The box at the top of the page provides options to sort the list of project workspaces by name or by last modification, and to filter which project workspaces are displayed based on a string.

For each workspace, links are available for the following functions:

  • Clicking the name of the project workspace will Open it, allowing the user to view the maps and layers in the project workspace.
  • Settings, for changing the project workspace name and settings.
  • Info, for showing the number of maps, layers, and stores associated with the project workspace.

Project Workspace Settings

On a project workspace settings page, the following options are available:

  • Name, for changing the project workspace name.
  • Namespace URI, for changing the namespace URI. This is a string that uniquely identifies the namespace to GeoServer. It must be in the form of a URL, but need not resolve to an actual web location.
  • Default, for specifying if this project workspace is the default. If a project is not specified in a GeoServer request, the default project workspace will be assumed.
  • Delete Workspace, which will remove the project workspace, and all of the contents of that project workspace, including layers and styles.

After making changes, click Save Changes.

../../_images/workspacesettings.png

Project workspace settings

Project Workspace contents

Clicking the name of a project workspace will bring up the contents of that project workspace.

../../_images/workspace.png

Project workspace contents

This page contains three tabs which show the following:

  • Maps (default) shows the list of all maps created in the project workspace
  • Layers shows the list of all layers published in the project workspace
  • Data shows the connections to the underlying stores (file or database sources)

Note

These tabs can also be accessed through the navigation panel:

../../_images/tabsinpanel1.png

Accessing project workspace tabs from the navigation panel

At the top, three buttons persist regardless of the active tab:

Maps tab

The Maps tab lists of all maps created in the project workspace, and is the default tab for a workspace.

The box at the top of the page provides options to sort the list of maps by name or by last modification, and to filter which maps are displayed based on a string.

For each map, there is a small preview of the map, which will open the map for styling and viewing when clicked. Details about the map are displayed beside the preview, including the number of layers, the spatial reference system used in the map, and how recently the map was modified.

Three other buttons are found below the map details:

  • The gear icon brings up the Map Settings page.
  • The link icon brings up a traditional GeoServer Layer Preview of the map.
  • The js icon brings up an OpenLayers Export dialog, for embedding the map in a web page.
../../_images/mapdetailsbuttons.png

Map details buttons

The Map Settings page allows details about the map to be entered:

  • Map Name, for the name of the map used in URLs

  • Title, for the human-readable name of the map

  • Projection, for the spatial reference system of the map

  • Extent, for the default region visible when rendering the map.

  • Generate Extent, to calculate the max extent based on the map contents. This can be useful when changing between projections with different units.

  • Description, for long-form information about the map

  • Render Timeout, for canceling long-running map requests when styling the map.

    Note

    If a map request exceeds its timeout, a partial image may be returned.

../../_images/mapsettings.png

Map settings

Layers tab

The Layers tab shows all of the layers contained in this project workspace.

../../_images/layerstab1.png

Layers tab

As with the Maps tab, the list of layers can be sorted by name or by last modification, and can also be filtered using a string.

Layers listed on this page can be added to a map by clicking them, selecting a map in the Select a map dialog, and then clicking the Add to Map button.

For each layer, details are shown, including:

  • Layer thumbnail
  • Geometry type, as indicated by an icon
  • Number of attributes, which when clicked will show details
  • Last modified date

There are also three links associated with each layer:

The layer details popup (from the Settings link) allows you to set the layer name, title, spatial reference system (SRS), and description. There is also a direct link to the GeoServer Admin Edit Layer section, and an option to unpublish the layer if desired.

../../_images/layersettings.png

Layer Settings

The Copy link brings up a very similar dialog to the Layer Settings, used to publish a copy of the layer as a new layer in GeoServer.

../../_images/copylayer.png

Copying to a new layer

Data tab

The Data tab shows information about the underlying data sources for the project workspace. Any layers published in this project workspace will have an associated data source shown here.

../../_images/datatab.png

Data tab

Similar to the Maps tab and Layers tab, the list of data sources can be sorted by name or by type, and can also be filtered using a string.

Each data source listed can be Enabled or Disabled by clicking the appropriate button. There is also the option to Delete the data source, in which case all associated layers will also be deleted (and all those layers removed from associated maps).

In certain data sources, one or more resources may be available, and these are shown on the right side. (For example, a PostGIS database may have multiple spatial tables, all of which can be published as layers). Each resource will be indicated as either Published or Unpublished. Clicking this indicator will show the layers associated with this resource (if any).

The list of resources can be sorted by name or published status, and can be filtered using a string.

Add Data

The Add Data wizard allows new data sources to be added (uploaded) to GeoServer, from which new layers can be published.

Selecting a source

There are two options for the type of data that can be added to GeoServer: Spatial files and Databases.

Spatial files such as shapefiles or GeoTIFFs can be added to GeoServer. Certain extensions may add support for additional file types; clicking the information icon (i) will display the list of file types currently supported.

You can click Browse to select one or more files, or drag and drop any number of files onto the dialog. For multi-file formats such as shapefiles, all files should be included in the import.

If you already have a store defined in the current workspace, you can choose to import the selected files into an existing store rather than creating a new store.

../../_images/importdatafile.png

Import data from files dialog

Once selected, clicking Upload will upload the data to the server.

Clicking Load will show the resources contained in the upload (and the resulting layers available for import). From here, you can select resources to add to GeoServer and publish as layers, add imported layers to an existing map, or create a new map.

../../_images/importaddmap.png

Options for a newly uploaded layer

Databases may also be connected to GeoServer. Specifically, the following databases are supported:

  • PostGIS
  • GeoPackage
  • H2

Support for additional databases can be enabled by installing the appropriate extension.

../../_images/importdb.png

Importing a database

Click the desired database to bring up a form. You will need to supply connection parameters for the specific database.

Once the form is filled out, click Connect to test the connection to the database. If successful, you will have the option of selecting resources to be added to GeoServer and published as layers. These layers can be added to a new or existing map, just like above.

Note

If you encounter difficulties during import, check that the projection/SRS is correct, as this is typically the cause of errors.

New Map

The goal of Composer is to make it easy to create maps, so there are a number of places where you can initiate the New Map dialog. In all cases, the process of creating a map is the same.

Creating a new map requires the following information:

  • Map Name, for the way that the map will be referenced in URLs. It should not contain spaces or more than 10 characters.
  • Title, the human-readable name of the map. It may contain spaces and be longer than 10 characters.
  • Projection, the spatial reference system. The default is Lat/Lon (WGS), though Web Mercator or any arbitrary spatial reference system code are allowed.
  • Description, a longer string of information about the layer.
../../_images/newmap.png

New map dialog

Clicking Add Layers will allow the layers to be selected for inclusion in the map. All layers in the project workspace will be shown in the list, and layers can be selectively included via check boxes.

../../_images/addlayerstonewmap.png

Adding layers to new map

Once layers have been selected, the map can be created via the Create Map with Selected button. The map will be created and listed in the Maps tab of the project workspace.

Note

Maps must be contained inside a project workspace, and there must exist layers published in that project workspace before a map can be created.