Plugins

Overview

The Map Plugin Management interface allows administrators to upload, view, and manage map plugins for the VCSuite Publisher application. This section explains how to use the plugin list and upload functionality.

Viewing Map Plugins

The Map Plugin List displays all installed plugins in an overview. For each plugin, the following information is shown:

Column Description

Name

The plugin identifier.

Version

The latest version number of the plugin.

Map Version

The compatible map version of the plugin.

Created At

The timestamp of the upload.

Actions

Available operations for the plugin, such as viewing documentation or deleting.

Searching and Sorting Plugins

Via the search field at the top of the plugin list, you can search by name and map version. Multiple search terms can be entered simultaneously to further narrow down the results. Clicking on the column headers allows you to sort the plugins by the respective criterion.

Viewing Plugin Versions

Plugins can have multiple versions installed simultaneously. To view all available versions of a plugin, click the Show Versions button in the versions column. The table expands to show older versions with their details. Click Hide Versions to collapse the list again.

Viewing Documentation

For plugins that provide documentation, the corresponding icons are available in the actions column. Clicking the text box icon opens the plugin’s README file in a new browser tab. Clicking the numbered list icon opens the associated CHANGELOG in a new browser tab as well.

Deleting Plugins

To remove a plugin or a specific version, click the delete icon in the actions column. If multiple versions exist, you will be asked which version to delete. You can either remove all versions of the plugin at once or select a specific version. Click Delete to confirm the removal, or Cancel to abort the process.

If the plugin is currently in use by an app, you will be prompted to explicitly confirm the deletion.

Uploading Map Plugins

Supported File Types

Only .tar.gz archive files are accepted for upload. Two types of archives are supported:

Type Description

Plugin Archive

A single plugin package (e.g. plugin.tar.gz).

Bundle Archive

Refers to the VCMapUI and must follow the naming pattern vcmap-bundle*.tar.gz.

Upload Process

To upload new plugins, click the plus icon in the Map Plugin List header. An upload area opens where you can drag and drop .tar.gz files or click the area to select files. Multiple files can be uploaded simultaneously. After selection, the files are validated first. Then click Upload to begin the upload process. A progress indicator is shown for each file being uploaded. Clicking Cancel returns you to the overview without uploading.