Academy
Task-Liste anzeigen

Task-Liste programmieren

Erklärung

Ein weiteres häufiges Szenario in prozessorientierten Anwendungen sind sogenannte Task-Listen. Task-Listen enthalten Aufgaben, die von einem Benutzer bearbeitet werden müssen. Ein Beispiel dafür ist der User Task "Bestellung prüfen". Während beim Task "Bestellung erfassen" die Bearbeitung in der Regel direkt erfolgt, ist die Bearbeitung beim "Bestellung prüfen" eher asynchron, da diese Prüfung von einem anderen Benutzer durchgeführt wird, der möglicherweise nicht sofort verfügbar ist.

Das bedeutet, dass sich hier Aufgaben ansammeln können.

Solche Aufgaben lassen sich gut durch Task-Listen abbilden. In der Task-Liste werden alle anstehenden "Prüfungen" aufgelistet. Der Benutzer kann dann eine einzelne Aufgabe auswählen, um diese im Detail zu bearbeiten.

"Bestellungen prüfen"-Task-Liste erstellen

Komponenten

Zunächst erstellen wir die benötigten Komponenten.

Als Erstes benötigen wir ein Icon, das später in einem Button verwendet wird. Dazu erstellen wir im Ordner components/Icons die Datei EditIcon.tsx:

/app/components/Icons/EditIcon.tsx
import React from 'react';
export const EditIcon = () => (
  <svg
    xmlns="http://www.w3.org/2000/svg"
    fill="none"
    viewBox="0 0 24 24"
    strokeWidth={1.5}
    stroke="currentColor"
    className="size-5"
  >
    <path
      strokeLinecap="round"
      strokeLinejoin="round"
      d="m16.862 4.487 1.687-1.688a1.875 1.875 0 1 1 2.652 2.652L10.582 16.07a4.5 4.5 0 0 1-1.897 1.13L6 18l.8-2.685a4.5 4.5 0 0 1 1.13-1.897l8.932-8.931Zm0 0L19.5 7.125M18 14v4.75A2.25 2.25 0 0 1 15.75 21H5.25A2.25 2.25 0 0 1 3 18.75V8.25A2.25 2.25 0 0 1 5.25 6H10"
    />
  </svg>
);

Anschließend erstellen wir die eigentliche Taskliste. Da wir diese speziell für diesen Fachbereich verwenden, legen wir sie im Ordner Material-Bestellung/Bestellungen_pruefen ab:

Wichtig ist hier zu beachten, dass diese Datei sowie die folgende Page nicht unter /[processInstanceId]/Bestellung_pruefen/ abgelegt werden, sondern unter /Bestellungen_pruefen/. Der Grund dafür ist, dass wir hier eine Sammlung von Aufgaben darstellen und nicht nur eine einzelne Aufgabe. Das bedeutet, erstens haben wir mehrere Aufgaben und zweitens keine spezifische Instanz!

/app/Material-Bestellung/Bestellungen_pruefen/tasklist.tsx
'use client';
 
import React from 'react';
 
import {
  Table,
  TableHeader,
  TableColumn,
  TableBody,
  TableRow,
  TableCell,
  Link,
  Tooltip,
  Pagination,
  Button,
} from '@nextui-org/react';
import { UserTaskList } from '@5minds/processcube_engine_sdk';
import { EditIcon } from '@/app/components/Icons/EditIcon';
 
export default function Tasklist({ userTaskList }: { userTaskList: UserTaskList }) {
  const [page, setPage] = React.useState(1);
  const rowsPerPage = 5;
 
  const pages = Math.ceil(userTaskList.totalCount / rowsPerPage);
 
  const items = React.useMemo(() => {
    const start = (page - 1) * rowsPerPage;
    const end = start + rowsPerPage;
 
    return userTaskList.userTasks.slice(start, end);
  }, [page, userTaskList]);
 
  return (
    <Table
      aria-label="Example static collection table"
      className="w-[600px] mx-bottom-10"
      bottomContent={
        <div className="flex w-full justify-center">
          <Pagination
            isCompact
            showControls
            color="primary"
            page={page}
            total={pages}
            onChange={(page) => setPage(page)}
          />
        </div>
      }
    >
      <TableHeader>
        <TableColumn>Produkt</TableColumn>
        <TableColumn>Menge</TableColumn>
        <TableColumn>Aktionen</TableColumn>
      </TableHeader>
      <TableBody emptyContent={'Keine offenen Aufgaben.'}>
        {items.map((userTask) => (
          <TableRow key={userTask.flowNodeInstanceId}>
            <TableCell>{userTask.startToken['produkt']}</TableCell>
            <TableCell>{userTask.startToken['menge']}</TableCell>
            <TableCell className="flex flex-row">
              <Tooltip content={'Edit'}>
                <Button
                  as={Link}
                  size="sm"
                  isIconOnly
                  variant="light"
                  className="text-default-400 hover:text-default-800"
                  href={`/Material-Bestellung/${userTask.processInstanceId}/Bestellung_pruefen`}
                >
                  <EditIcon />
                </Button>
              </Tooltip>
            </TableCell>
          </TableRow>
        ))}
      </TableBody>
    </Table>
  );
}

Page

Nun erstellen wir die Page, die die Taskliste darstellt. Diese legen wir im Ordner Material-Bestellung/Bestellungen_pruefen/ ab:

/app/Material-Bestellung/Bestellungen_pruefen/page.tsx
import { getIdentity, getWaitingUserTasksByFlowNodeId } from '@5minds/processcube_app_sdk/server';
import TaskList from './tasklist';
 
export const dynamic = 'force-dynamic';
 
export default async function Page() {
  const identity = await getIdentity();
  const taskList = await getWaitingUserTasksByFlowNodeId('Bestellung_pruefen', { identity });
 
  return (
    <div style={{ padding: '0 30%' }}>
      <h1 className="flex justify-center text-xl font-semibold">Bestellungen prüfen</h1>
      <TaskList userTaskList={taskList}></TaskList>
    </div>
  );
}

getWaitingUserTasksByFlowNodeId

Auch hierbei handelt es sich um eine Funktion aus dem App.SDK. Diese Funktion liefert uns eine Liste von User Tasks zurück, die anhand der Flownode-ID spezifiziert wird.

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

⚠️

Hier ist erneut darauf zu achten, dass die Flownode-ID im Prozessmodell den Namen "Bestellung_pruefen" trägt. Falls dies noch nicht der Fall ist, muss die ID entsprechend angepasst und die neue Version des Prozessmodells auf der Engine deployed werden.

"Bestellungen prüfen" in der Navbar anzeigen

Um die Task-Liste in der Navbar anzuzeigen, fügen wir der Navbar-Komponente einen Eintrag hinzu:

/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';
import { revalidatePath } from 'next/cache';
import { redirect } from 'next/navigation';
 
export async function startMaterialBestellungProcess() {
  'use server';
  const identity = await getIdentity();
  const response = await startProcess(
    {
      processModelId: 'Material-Bestellung_Process',
    },
    identity,
  );
 
  revalidatePath(`/Material-Bestellung/${response.processInstanceId}/Bestellung_erfassen`);
  redirect(`/Material-Bestellung/${response.processInstanceId}/Bestellung_erfassen`);
}
 
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>
        <NavbarItem>
          <Link color="foreground" href="/Material-Bestellung/Bestellungen_pruefen">
            Bestellungen prüfen
          </Link>
        </NavbarItem>
      </NavbarContent>
    </Navbar>
  );
}

"Bestellung prüfen"-Page programmieren

Wenn wir uns die Tasklist-Komponente ansehen, fällt auf, dass für jede Aufgabe ein Link zu einer spezifischen Seite führt. Den entsprechenden Endpunkt müssen wir nun programmieren.

Das Vorgehen ist im Wesentlichen identisch zum vorherigen Kapitel: Wir erstellen unter Material-Bestellung/[processInstanceId]/Bestellung_pruefen eine neue Page.

/app/Material-Bestellung/[processInstanceId]/Bestellung_pruefen/page.tsx
import { DynamicUi, UserTaskResult } from '@5minds/processcube_app_sdk/client';
import { finishUserTask, getIdentity, waitForUserTask } from '@5minds/processcube_app_sdk/server';
 
import '@5minds/processcube_app_sdk/client/components/DynamicUi/DynamicUi.css';
import { Identity, UserTaskInstance } from '@5minds/processcube_engine_sdk';
import { revalidatePath } from 'next/cache';
import { redirect } from 'next/navigation';
 
async function submit(result: UserTaskResult, formData: FormData, userTask: UserTaskInstance) {
  'use server';
  const identity: Identity = await getIdentity();
  await finishUserTask(userTask.flowNodeInstanceId, result, identity);
  revalidatePath(`/Material-Bestellung/Bestellungen_pruefen`);
  redirect(`/Material-Bestellung/Bestellungen_pruefen`);
}
 
export default async function Page(params: {
  params: {
    processInstanceId: string;
  };
}) {
  const identity: Identity = await getIdentity();
 
  const userTask = await waitForUserTask(
    {
      processInstanceId: params.params.processInstanceId,
      flowNodeId: 'Bestellung_pruefen',
    },
    identity,
  );
 
  return (
    <div className="w-[600px] h-full sm:p-12 flex gap-4 flex-wrap">
      <DynamicUi task={userTask} classNames={{ base: 'rounded-none sm:rounded-lg' }} onSubmit={submit} darkMode />
    </div>
  );
}

Ein erster Test

Wenn wir jetzt eine Bestellung erfassen und dann auf "Bestellungen prüfen" klicken, sehen wir die Task-Liste. Klicken wir hier auf Edit, navigieren wir zur spezifischen Page und können die Aufgabe bearbeiten.