Academy
Prozess starten

Prozess starten

Erklärung

Im bisherigen Kurs haben wir gelernt, wie Prozesse modelliert und mit der 5Minds-Engine ausgeführt werden. Dabei haben wir die Prozesse mithilfe des 5Minds-Studios deployed, gestartet und ausgeführt. Im aktuellen Szenario möchten wir jedoch den Prozess über eine eigene Anwendung starten. Dafür verwenden wir das 5Minds-App.SDK (opens in a new tab), das uns Funktionen zur Kommunikation mit der Engine bietet.

Das 5Minds-App.SDK (opens in a new tab) stellt eine Sammlung von Funktionen und Komponenten bereit, mit denen prozessbasierte Anwendungen schnell und effizient realisiert werden können.

Ausgangssituation

Derzeit verfügt unser Projekt über eine einfache Oberfläche ohne umfangreiche Funktionalität. Im ersten Schritt möchten wir eine Verbindung zur Engine herstellen, um einen Prozess zu starten.

In der Datei /my-processcube-app/apps/next-app/.env finden wir den Eintrag PROCESSCUBE_ENGINE_URL. Diese Environment-Variable verweist auf die Engine. Die Funktionen des App.SDK greifen automatisch auf diese Variable zu.

💡

Sollte die Engine unter einer anderen Adresse laufen, ist hier der Ort, um das zu konfigurieren.

Zudem arbeiten wir hier mit einer Next.js-Anwendung. Next.js ist ein auf React basierendes Framework für die Entwicklung von Full-Stack-Anwendungen. Das bedeutet, wir können sowohl das Frontend als auch das Backend entwickeln. Dadurch haben wir vielfältige Möglichkeiten, sowohl serverseitige als auch clientseitige Funktionalitäten zu implementieren.

Falls das Framework nicht bekannt ist, lohnt sich ein Blick in die Dokumentation (opens in a new tab). Hier finden sich viele Informationen, Beispiele und Kurse. Eine minimale Grundkenntnis zu Next.js wird im weiteren Verlauf des Kurses vorausgesetzt.

NextUI

Dieser Part ist nur notwendig, wenn anfangs beim Erstellen des Projekts die Frage "Would you like to use Next UI? (Next UI implies and installs Tailwind CSS.)" mit No beantwortet wurde. Andernfalls kann mit dem nächsten Abschnitt Prozesse starten fortgefahren werden.

Im folgenden Teil des Kurses werden NextUI-Komponenten verwendet. Um diese nutzen zu können, kann dieser Dokumentation (opens in a new tab) gefolgt werden.

Am Ende sollte die angelegte tailwind.config.js ergänzt werden und danach so aussehen:

tailwind.config.js
import { nextui } from '@nextui-org/react';
 
/** @type {import('tailwindcss').Config} */
module.exports = {
  content: [
    './pages/**/*.{js,ts,jsx,tsx,mdx}',
    './components/**/*.{js,ts,jsx,tsx,mdx}',
    './app/**/*.{js,ts,jsx,tsx,mdx}',
    './node_modules/@nextui-org/theme/dist/**/*.{js,ts,jsx,tsx}',
  ],
  theme: {
    extend: {
      colors: {
        '5minds-orange': '#f7a823',
      },
      backgroundImage: {
        'gradient-radial': 'radial-gradient(var(--tw-gradient-stops))',
        'gradient-conic': 'conic-gradient(from 180deg at 50% 50%, var(--tw-gradient-stops))',
      },
    },
  },
  darkMode: 'class',
  plugins: [nextui()],
};

Prozesse starten

Sämtliche hier neu angelegten Komponenten müssen im App-Ordner /src/app hinterlegt werden.

Um zu beginnen, erstellen wir zunächst eine Navbar-Komponente. Dazu legen wir in unserer App einen Ordner components an und erstellen darin die Datei Navbar.tsx.

app/components/Navbar.tsx
import React from 'react';
 
import { getIdentity, startProcess } from '@5minds/processcube_app_sdk/server';
import { Navbar, NavbarContent, NavbarItem, Link, Button } from '@nextui-org/react';
 
export async function startMaterialBestellungProcess() {
  'use server';
  const identity = await getIdentity();
  const response = await startProcess(
    {
      processModelId: 'Material-Bestellung_Process',
    },
    identity,
  );
}
 
export default function Navigationbar() {
  return (
    <Navbar position="static">
      <NavbarContent className="hidden sm:flex gap-4" justify="center">
        <NavbarItem>
          <Link color="foreground" href="/">
            Home
          </Link>
        </NavbarItem>
        <NavbarItem>
          <form action={startMaterialBestellungProcess}>
            <Button type="submit">Bestellung erfassen</Button>
          </form>
        </NavbarItem>
      </NavbarContent>
    </Navbar>
  );
}

startMaterialBestellungProcess

Diese Funktion ist eine sogenannte Server Action (opens in a new tab). Das bedeutet, dass sie auf dem Server ausgeführt wird. In diesem Fall wird die Identität des Benutzers abgerufen und ein Prozess gestartet.

Auch wenn die Benutzeridentität aktuell noch nicht relevant ist, wird sie im späteren Verlauf des Kurses benötigt. Daher entwickeln wir die Funktionalität jetzt bereits so, dass sie auch für komplexere Szenarien genutzt werden kann.

getIdentity

Diese Methode ist eine von den vom App.SDK bereitgestellten Funktionen. Sie gibt uns die Identität des Benutzers zurück, der aktuell eingeloggt ist.

Eine genauere Beschreibung befindet sich in der Dokumentation (opens in a new tab).

startProcess

Diese Methode ist ebenfalls eine vom App.SDK bereitgestellte Funktion. Sie startet einen Prozess in der Engine. Dazu wird die Prozessmodell-ID und die Identität des Benutzers benötigt, mit dem der Prozess gestartet werden soll.

💡

Der hier verwendete Benutzer gilt als der "Besitzer" der gestarteten Prozessinstanz. Entsprechend hat nur dieser Benutzer die volle Kontrolle über diese Prozessinstanz.

Eine genauere Beschreibung befindet sich in der Dokumentation (opens in a new tab).

Form

Die Form wird genutzt, um die Funktion startMaterialBestellungProcess aufzurufen, wenn der Button gedrückt wird.

Verwendung

Die Navbar-Komponente kann nun über die layout.tsx Datei in unsere App eingebunden werden. Diese Datei sollte danach so aussehen:

app/layout.tsx
import './globals.css';
import type { Metadata } from 'next';
import Navigationbar from './components/Navbar';
import { Providers } from './providers';
 
export const metadata: Metadata = {
  title: 'Create ProcessCube App',
  description: 'Generated by create processcube app',
};
 
export default function RootLayout({ children }: { children: React.ReactNode }) {
  return (
    <html lang="en" className="dark">
      <body className="w-full">
        <Providers>
          <Navigationbar />
          <main className="flex min-h-screen flex-col p-8 items-center">{children}</main>
        </Providers>
      </body>
    </html>
  );
}

Nach der Implementierung enthält die Anwendung eine Navbar mit einem entsprechenden Button. Wenn dieser Button geklickt wird, startet ein Prozess in der Engine. Um dies zu überprüfen, können wir im Studio die laufenden Prozessinstanzen einsehen.


Im nächsten Schritt geht es darum, User Tasks zu implementieren.