Skip to main content
Version: Current

Saving, Versions and Deploying

This page covers what happens to a scenario around editing it: saving, versions, the Activities panel, scenario labels, the scenario menu (compare, import, export, migrate, archive) and deployment.

Scenario labels​

Labels are short tags that help you group and find scenarios; the scenario list can be filtered by Label. They are shown under the scenario name in the Scenario details panel.

  • Click + Add label, type a label and press Enter. Labels already used in other scenarios are suggested.
  • Remove a label with the cross on its chip.
  • A label can be used only once per scenario. Your installation may restrict what a label may look like; the rules are set with scenarioLabelSettings in the Designer configuration.

Label changes are a change of the scenario - save the scenario to keep them.

Saving​

The save button in the actions panel is active when there are unsaved changes. Its menu offers:

  • Save - saves the changes as a new version of the scenario. By default it opens a dialog where you can add a comment describing the change; the comment is shown with the version in the Activities panel.
  • Save with comment… - shown when Settings → Scenario → Allow quick save is on. Then Save saves at once without a dialog, and Save with comment… opens the dialog with the comment.
  • Save as… - saves the scenario as shown on the canvas, unsaved changes included, as a new scenario in the same category and opens it in a new browser tab. You give the copy a name; it is proposed as <name> copy_<suffix>. It requires permission to create and edit scenarios in the category.

If someone else saved a newer version since you opened the scenario, the Designer asks before overwriting it.

Drafts​

When Settings → Scenario → Enable draft is on, the Designer keeps your unsaved changes as a draft in the browser, so they survive closing the tab or navigating away. A draft belongs to a scenario version and is restored when you open that version again. The Activities panel then shows Local draft exists for this version; click Discard draft next to it to drop the unsaved changes and return to the saved version. Drafts are stored in your browser only; they are not visible to other users or on other machines.

Activities panel​

The Activities panel lists the history of the scenario: saved versions, deployments, cancellations, migrations, comments and attachments. Use its search box to find a past event. Repeated similar events are grouped; expand them with Show N more.

Versions​

Every save creates a new version. The version currently shown and the version currently deployed are highlighted.

  • Open an older version - click a version entry. If you have unsaved changes, you are asked first.
  • Revert to an older version - open it and save it; it becomes the newest version.
  • Compare - click the compare icon of an entry, or choose compare from the scenario menu (the ⋮ button in the Scenario details panel). In the dialog pick the Version to compare and see the differences. When a secondary environment is configured, you can switch Environment to compare with the scenario version on that environment.

Comments​

  • Add comment (at the bottom of the panel) adds a comment to the version you are viewing.
  • Some events, for example a deployment done without a comment, offer an icon to add a comment to them later.
  • You can edit (Edit comment) and delete only your own comments.

Attachments​

Add attachment (at the bottom of the panel) attaches one or more files to the version you are viewing. Each attachment entry has a download icon; you can delete only attachments you added.

Adding comments and attachments requires permission to edit the scenario.

Scenario menu​

The ⋮ button in the Scenario details panel opens the scenario menu:

  • properties - scenario properties.
  • compare - compare versions, see Versions. Disabled while the scenario has a single version.
  • migrate - copies the scenario to the secondary environment, after confirmation. Shown only when a secondary environment is configured.
  • import - click it or drop a JSON file on it to load a scenario exported earlier. The imported graph replaces the one on the canvas as an unsaved change; save to keep it.
  • export - downloads the scenario graph shown on the canvas as a JSON file named <scenario>-<version>.json.
  • archive / unarchive - archiving hides the scenario from the default scenario list; scenarios are never deleted. A running scenario cannot be archived - cancel it first. Archived scenarios can be found with the Archived status filter of the scenario list and unarchived from the same menu.

The PDF button, which exports the scenario graph to a PDF file, is not part of the default toolbars. An administrator can add it (button type process-pdf) with the toolbar configuration.

Deploying​

The actions panel holds the deployment buttons. deploy and redeploy require deployment permission, a scenario state that allows the action and no validation errors (see the Tips panel). By default, unsaved changes also disable these two buttons: use Save first. With the Auto save during deploy redeploy option in Settings → Toolbar on, you can deploy or redeploy unsaved changes; they are saved as part of the action.

  • deploy - opens the Deploy scenario dialog, where you can add a comment and confirm. With Settings → Scenario → Allow quick deploy on, the button reads start and deploys at once; its menu then has start and configure & start…, the latter opening the dialog.
  • redeploy - shown in place of deploy while the scenario is running; deploys it again, for example after you saved changes.
  • cancel - stops the scenario. It requires permission to stop and a scenario state that allows cancellation; validation errors and unsaved changes do not block it.

If you are viewing an older version and a newer one exists, the Designer warns you which version will be deployed.

Choosing a deployment target​

When the scenario type has more than one deployment target (for example two Flink clusters), the deploy button shows the selected target and has a menu listing the targets under Deployment target. Pick a target there, then click the button. The deploy dialog shows it as Deployment target: <name>.

Unless you pick one, the scenario goes to the target of its previous deployment, and a scenario never deployed goes to the first (default) target. In the scenario list, the row menu offers Deploy to <target> for each target.

Running a scheduled scenario now​

For scenarios deployed on a schedule (periodic scenarios), the run now button triggers a run outside the schedule. It opens the Perform single execution dialog, where you can add a comment. The run is recorded in the Activities panel.

Deployment targets page (administrators)​

Administrators manage deployment targets at /administration/targets (the page may have no side menu entry; open the address directly). For the chosen Scenario type it lists the targets with their Order, Name, Kind and Parameters. The first target is marked default; targets defined in the configuration file are marked from configuration and cannot be changed or removed here. Add target creates a target at runtime - it is available only when the scenario type allows it, see Deployment targets created at runtime.