Skip to main content

Managing your app

This page explains how you manage the apps you maintain: where to find them in the interface and what can be configured.

Library​

Apps can be found in the Library page of the environment. All users (except for external users/developers) have access to this page, allowing easy discovery and seeing what's available.

On the Details page of the app the user can find images, a description and more information about the app.

overview of apps

Managing your apps from the Develop page​

The Library is meant for discovery: it shows users which apps are available and what they do. You manage the apps you maintain from the "Develop" page instead. The sections below describe the actions available there.

ADMINISTRATORS

Administrators manage all apps in the organization, including apps they do not maintain, from the "All apps" page in the Administrator panel. See All apps.

Creating a new app​

Apps can be created by administrators and developers, and only from the "Develop" page. Developers are automatically assigned as the first maintainer on the app they create. In the "Develop" menu, click on the "Create app" button to create a new app. You can choose between:

  • App Builder — build directly in your browser with AI assistance. See the App Builder guide.
  • Create a blank app — a temporary placeholder that shows the CLI instructions for setting up an app locally. This option will be removed in the future; local development will happen entirely through the VIKTOR CLI.

Editing an existing app​

The details of an existing app can be updated by navigating to the "Develop" menu, followed by clicking on the "Details" button on the app card. On the details page, click on the three dots in the top-right corner, and select "Edit app" to go through the same steps as when you first created the app.

Version history​

All versions of your app are listed on the versions tab of the app details page. The tab shows what each version is and which version is currently deployed on testing or production.

The versions tab of an app, listing each version with its version tag and where it is deployed

Every row shows the version tag of the version, where it is deployed, and the maintainer and date it was published. A version can be deployed on testing, on production, on both, or on neither.

Expand a row to see the app type, the SDK version, and the Python version.

The tab lists every version ever published, not only the ones currently deployed, so you can find older code. It does not mark which previous version was deployed on production.

Change which version is deployed​

MAINTAINERS ONLY
  1. Open the Details page of your app and go to the versions tab.
  2. Select the version you would like to deploy to production, expand the row in the table.
  3. Confirm the change.

You can select any version in the list for production, including an older one. This is how you take production back to a known-good version after a bad release, without having to fix forward. Testing always reflects the latest published version and cannot be moved to an older one.

VIKTOR validates the change when you confirm it rather than in advance. When the two versions are not interchangeable the change is refused and you are told the reason. See Move a line to another version for the causes.

When the change would delete stored data, you first see which entity types are affected and how many entities that involves. Nothing changes until you accept it. If you reject, both lines stay as they were.

Environment variables​

ADMIN & MAINTAINERS ONLY

Administrators and app maintainers can access the variables tab on the app. On this tab, environment variables can be created, adjusted, or deleted. For more information please refer to using environment variables.

app variables page

Apps archive​

ADMIN & MAINTAINERS ONLY

Apps that are no longer being used can be archived from the "Develop" page, in either of these two ways:

  • Click the Details button on the app to open its Details page, then click the three dots in the top-right corner of the screen and select the Archive option.
  • Click the Select button on the Develop page, select the app you want to archive, and archive it from there.

Archived apps can be inspected by clicking the "Archive" button in the top-right corner of the page. Apps can be unarchived by clicking the Unarchive button.

Note that an app cannot be archived when:

  • the app has active app instances associated to it

    Solution: archive the active app instances first

Note that an app cannot be unarchived when:

Labels​

An admin can add labels to apps and their instances. This enables users to filter and quickly find the tools relevant for them. For example, the labels can be used to distinguish between industry disciplines, such that a newly registered GIS user can quickly find the relevant app instances for the user. Besides filtering on labels, a user can also filter on visibility and app name. The labels on your app are also pre-selected when a new app instance is created from it.

Adding labels is part of editing the app details, described in Add a label to an app. The labels you can choose from are managed by an administrator, see Labels.