User Guide on oPBWeb Manual

Getting Started

Mon, 01 Jan 0001 00:00:00 +0000

Overview

This chapter shows you how to sign in, how the oPBWeb interface is laid out and how to use the search to jump quickly to packages, files and commands. At the end you find a short overview of the roles and the package lifecycle.

Signing in

Open oPBWeb in your browser. Without a valid session, you land on the sign-in page.
Enter your User name and Password.
Click Sign in.

After signing in, the package list opens, or the page you originally wanted to open. On the sign-in page you can already switch the language (DE/EN) and light/dark mode in the top corner.

Packages

Mon, 01 Jan 0001 00:00:00 +0000

Overview

The Packages area is the start page of oPBWeb. Here you see all packages with their latest version, check in the package details on which depots they are installed, and create new packages. As a viewer you can see the list and the details; creating, importing and all changing actions require at least the Packager role.

The package list

Package Editor

Mon, 01 Jan 0001 00:00:00 +0000

Overview

In the package editor you edit a package version: the control data (product information, scripts, dependencies, properties), the changelog and the files of the package. This chapter describes the control tab. Working with files and scripts is described in Package Files and Script Editor .

You can only edit drafts, and only with at least the Packager role. As a viewer and for released versions, all fields are locked; you can still view everything.

Package Files

Mon, 01 Jan 0001 00:00:00 +0000

Overview

Every package version consists of the three areas OPSI/, CLIENT_DATA/ and SERVER_DATA/. In the package editor you see them on the left under the Files tab. There you create files and folders, upload installers, rename, move and delete. The Structure tab next to it shows which scripts include which other scripts.

You can only change files in a version with the status Draft and with at least the Packager role. In released versions and with the Viewer role, the file tree is read-only: opening and downloading still work, all changing entries in the context menu are grayed out.

Script Editor

Mon, 01 Jan 0001 00:00:00 +0000

Overview

To open a text file of the package, click it in the file tree (see Package files ). It opens as a separate tab next to the control tab in the script editor. For opsi scripts, the editor offers completion, error checking, command help and snippets. All other text formats get syntax highlighting. You set the highlighting colors per file type under My account .

You can only edit files in a version with the status Draft and with at least the Packager role. Otherwise the editor is read-only; reading, searching, help and copying text still work.

Build and Deploy

Mon, 01 Jan 0001 00:00:00 +0000

Overview

This chapter describes the path of a package version from draft to the depots: Build creates the .opsi file, Install … transfers it to one or more depots and releases the version in the process, Promote … takes a tested version unchanged to the depots of the next stage. You find all actions in the toolbar of the control tab in the package editor and in the ⋯ menu (More actions).

Snippets

Mon, 01 Jan 0001 00:00:00 +0000

Overview

Snippets are text blocks for opsi-script that you insert in the script editor by double-click, autocompletion or the context menu. The Snippets view in the activity bar is where you manage them: create categories, write and test snippets, import and export files.

Viewers see all snippets but cannot change anything. From the Packager role on, you create your own snippets and maintain the shared categories.

Depots

Mon, 01 Jan 0001 00:00:00 +0000

Overview

The Depots view shows all opsi config servers set up in oPBWeb and their depots as oPBWeb last read them. You see which products are installed in which version, clean up the repository, edit files directly on the server and compare the depots with each other.

Viewers see everything but cannot change anything. What Packagers and Releasers may change on a depot depends on its stage (see Stages and roles ). Only administrators can add, edit and remove config servers, see opsi server .

Jobs

Mon, 01 Jan 0001 00:00:00 +0000

Overview

Everything that takes longer or talks to an opsi server runs in oPBWeb as a background job. You start the action, keep working and follow the progress in the status bar, in the package editor or in the Jobs view.

All users see all jobs, including those of their colleagues, together with their logs. This lets you trace who built or deployed what and when.

Account and Language

Mon, 01 Jan 0001 00:00:00 +0000

Overview

You reach the settings of your own account via the avatar icon with your initials at the far right of the top bar. Next to it in the top bar you find the switches for language and light/dark appearance, as well as access to this manual.

These functions are available to all users, regardless of their role.

Click the avatar icon to open the user menu.

User Guide on oPBWeb Manual

Getting Started

Overview

Signing in

Packages

Overview

The package list

Package Editor

Overview

Package Files

Overview

Script Editor

Overview

Build and Deploy

Overview

Snippets

Overview

Depots

Overview

Jobs

Overview

Account and Language

Overview

The user menu