#API-Referenz

#Server

Die im Server-Paket verfügbare API sieht wie folgt aus:

import PluginWorkflowServer, {
  Trigger,
  Instruction,
  EXECUTION_STATUS,
  JOB_STATUS,
} from '@nocobase/plugin-workflow';

#PluginWorkflowServer

Die Klasse des Workflow-Plugins.

In der Regel können Sie an einer beliebigen Stelle, an der Sie zur Laufzeit der Anwendung Zugriff auf die Anwendungsinstanz app haben, mit app.pm.get<PluginWorkflowServer>(PluginWorkflowServer) die Instanz des Workflow-Plugins abrufen (im Folgenden mit plugin bezeichnet).

#registerTrigger()

Registriert einen neuen Triggertyp.

Signatur

registerTrigger(type: string, trigger: typeof Trigger | Trigger })

Parameter

Beispiel

import PluginWorkflowServer, { Trigger } from '@nocobase/plugin-workflow';

function handler(this: MyTrigger, workflow: WorkflowModel, message: string) {
  // trigger workflow
  this.workflow.trigger(workflow, { data: message.data });
}

class MyTrigger extends Trigger {
  messageHandlers: Map<number, WorkflowModel> = new Map();
  on(workflow: WorkflowModel) {
    const messageHandler = handler.bind(this, workflow);
    // listen some event to trigger workflow
    process.on(
      'message',
      this.messageHandlers.set(workflow.id, messageHandler),
    );
  }

  off(workflow: WorkflowModel) {
    const messageHandler = this.messageHandlers.get(workflow.id);
    // remove listener
    process.off('message', messageHandler);
  }
}

export default class MyPlugin extends Plugin {
  load() {
    // get workflow plugin instance
    const workflowPlugin =
      this.app.pm.get<PluginWorkflowServer>(PluginWorkflowServer);

    // register trigger
    workflowPlugin.registerTrigger('myTrigger', MyTrigger);
  }
}

#registerInstruction()

Registriert einen neuen Node-Typ.

Signatur

registerInstruction(type: string, instruction: typeof Instruction | Instruction })

Parameter

Beispiel

import PluginWorkflowServer, { Instruction, JOB_STATUS } from '@nocobase/plugin-workflow';

class LogInstruction extends Instruction {
  run(node, input, processor) {
    console.log('my instruction runs!');
    return {
      status: JOB_STATUS.RESOVLED,
    };
  },
};

export default class MyPlugin extends Plugin {
  load() {
    // get workflow plugin instance
    const workflowPlugin = this.app.pm.get<PluginWorkflowServer>(PluginWorkflowServer);

    // register instruction
    workflowPlugin.registerInstruction('log', LogInstruction);
  }
}

#trigger()

Löst einen bestimmten Workflow aus. Wird hauptsächlich in benutzerdefinierten Triggern verwendet, um beim Eintreten eines bestimmten Events den entsprechenden Workflow zu starten.

Signatur

trigger(workflow: Workflow, context: any)

Parameter

Beispiel

import { Trigger } from '@nocobase/plugin-workflow';

class MyTrigger extends Trigger {
  timer: NodeJS.Timeout;

  on(workflow) {
    // register event
    this.timer = setInterval(() => {
      // trigger workflow
      this.plugin.trigger(workflow, { date: new Date() });
    }, workflow.config.interval ?? 60000);
  }
}

#resume()

Setzt einen pausierten Workflow mit einer bestimmten Node-Aufgabe fort.

• Nur Workflows im Wartezustand (EXECUTION_STATUS.STARTED) können fortgesetzt werden.
• Nur Node-Tasks im Wartezustand (JOB_STATUS.PENDING) können fortgesetzt werden.

Signatur

resume(job: JobModel)

Parameter

Beispiel

Siehe Quellcode.

#Trigger

Basis-Triggerklasse zum Erweitern um eigene Triggertypen.

on/off registrieren bzw. deregistrieren Event-Listener beim Aktivieren/Deaktivieren des Workflows; der übergebene Parameter ist die Workflow-Instanz, sodass Sie sie entsprechend der Konfiguration verarbeiten können. Triggertypen, die bereits global lauschen, müssen diese Methoden nicht implementieren. Beispielsweise können Sie in einem Cron-Trigger den Timer in on registrieren und in off wieder abmelden.

#Instruction

Basisklasse für Instructions zum Erweitern um eigene Node-Typen.

Zugehörige Typen

export type Job =
  | {
      status: JOB_STATUS[keyof JOB_STATUS];
      result?: unknown;
      [key: string]: unknown;
    }
  | JobModel
  | null;

export type InstructionResult = Job | Promise<Job>;

export type Runner = (
  node: FlowNodeModel,
  input: JobModel,
  processor: Processor,
) => InstructionResult;

export class Instruction {
  run: Runner;
  resume?: Runner;
}

getScope lässt sich anhand der Implementierung des Loop-Nodes nachvollziehen und wird genutzt, um den Branch lokale Variablen bereitzustellen.

#EXECUTION_STATUS

Konstanten für den Status eines Ausführungsplans eines Workflows.

Außer den ersten drei stehen alle anderen Werte für Fehlerzustände, sie unterscheiden sich aber im Grund des Fehlschlags.

#JOB_STATUS

Konstanten für den Status eines Node-Tasks im Workflow.

#Client

Die im Client-Paket verfügbare API sieht wie folgt aus:

import PluginWorkflowClient, {
  Trigger,
  Instruction,
} from '@nocobase/plugin-workflow/client';

#PluginWorkflowClient

#registerTrigger()

Registriert das Konfigurationspanel für einen Triggertyp.

Signatur

registerTrigger(type: string, trigger: typeof Trigger | Trigger): void

Parameter

#registerInstruction()

Registriert das Konfigurationspanel für einen Node-Typ.

Signatur

registerInstruction(type: string, instruction: typeof Instruction | Instruction): void

Parameter

#registerInstructionGroup()

Registriert eine Node-Gruppe. NocoBase liefert standardmäßig vier Node-Gruppen:

• 'control': Ablaufsteuerung
• 'collection': Datenoperationen
• 'manual': Manuelle Verarbeitung
• 'extended': Weitere Erweiterungen

Wenn Sie eine andere Gruppe hinzufügen möchten, verwenden Sie diese Methode.

Signatur

registerInstructionGroup(type: string, group: { label: string }): void

Parameter

Beispiel

export default class YourPluginClient extends Plugin {
  load() {
    const pluginWorkflow = this.app.pm.get(PluginWorkflowClient);

    pluginWorkflow.registerInstructionGroup('ai', { label: `{{t("AI", { ns: "${NAMESPACE}" })}}` });
  }
}

#Trigger

Basis-Triggerklasse zum Erweitern um eigene Triggertypen.

• Wenn useVariables nicht gesetzt ist, bietet dieser Triggertyp keine Wertentnahme an, und seine Kontextdaten können in den Workflow-Nodes nicht ausgewählt werden.

#Instruction

Basisklasse für Instructions zum Erweitern um eigene Node-Typen.

Zugehörige Typen

export type NodeAvailableContext = {
  workflow: object;
  upstream: object;
  branchIndex: number;
};

• Wenn useVariables nicht gesetzt ist, bietet dieser Node-Typ keine Wertentnahme an, und seine Ergebnisdaten können in Workflow-Nodes nicht ausgewählt werden. Wenn der Wert eindeutig ist (nicht auswählbar), reicht ein statischer Inhalt zur Beschreibung der Information (Beispiel: Quellcode des Calculation-Nodes). Falls auswählbar (z. B. eine Eigenschaft eines Objekts), kann eine eigene Auswahl-Komponente bereitgestellt werden (Beispiel: Quellcode des Create-Nodes).
• Component ist die eigene Render-Komponente des Nodes; verwenden Sie sie, wenn das Standard-Rendering nicht ausreicht und Sie es vollständig ersetzen möchten. Etwa wenn ein Branch-Start-Node zusätzliche Action-Buttons oder andere Interaktionen anbieten soll (Beispiel: Parallel-Branch Quellcode).
• useInitializers liefert Methoden zur Initialisierung von Blocks, beispielsweise um in einem Manual-Node abhängig vom Upstream-Node entsprechende Benutzer-Blocks zu initialisieren. Wenn definiert, sind diese in der Konfiguration des Manual-Nodes verfügbar (Beispiel: Quellcode des Create-Nodes).
• isAvailable entscheidet, ob der Node in der aktuellen Umgebung (aktueller Workflow, Upstream-Nodes, aktueller Branch-Index usw.) verfügbar ist (hinzugefügt werden kann).