#API Referentie

#Serverkant

De API's die u kunt gebruiken in de serverkant pakketstructuur, ziet u in de onderstaande code:

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

#PluginWorkflowServer

De klasse voor de workflow plugin.

Gewoonlijk, tijdens de runtime van de applicatie, kunt u overal waar u de applicatie-instantie app kunt verkrijgen, app.pm.get<PluginWorkflowServer>(PluginWorkflowServer) aanroepen om de workflow plugin-instantie te verkrijgen (hierna aangeduid als plugin).

#registerTrigger()

Hiermee breidt u de functionaliteit uit en registreert u een nieuw triggertype.

Handtekening

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

Parameters

Voorbeeld

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

function handler(this: MyTrigger, workflow: WorkflowModel, message: string) {
  // activeer 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);
    // luister naar een gebeurtenis om de workflow te activeren
    process.on(
      'message',
      this.messageHandlers.set(workflow.id, messageHandler),
    );
  }

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

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

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

#registerInstruction()

Hiermee breidt u de functionaliteit uit en registreert u een nieuw knooppunttype.

Handtekening

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

Parameters

Voorbeeld

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() {
    // verkrijg de workflow plugin-instantie
    const workflowPlugin = this.app.pm.get<PluginWorkflowServer>(PluginWorkflowServer);

    // registreer de instructie
    workflowPlugin.registerInstruction('log', LogInstruction);
  }
}

#trigger()

Activeert een specifieke workflow. Dit wordt voornamelijk gebruikt in aangepaste triggers om de corresponderende workflow te activeren wanneer een specifieke aangepaste gebeurtenis wordt gedetecteerd.

Handtekening

trigger(workflow: Workflow, context: any)

Parameters

Voorbeeld

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

class MyTrigger extends Trigger {
  timer: NodeJS.Timeout;

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

#resume()

Hervat de uitvoering van een wachtende workflow met een specifieke knooppunt-taak.

• Alleen workflows die zich in de wachtende status (EXECUTION_STATUS.STARTED) bevinden, kunnen worden hervat.
• Alleen knooppunt-taken die zich in de JOB_STATUS.PENDING status bevinden, kunnen worden hervat.

Handtekening

resume(job: JobModel)

Parameters

Voorbeeld

Zie de broncode voor details.

#Trigger

De basisklasse voor triggers, gebruikt om aangepaste triggertypen uit te breiden.

on/off worden gebruikt om gebeurtenislisteners te registreren/deregistreren wanneer een workflow wordt ingeschakeld/uitgeschakeld. De meegegeven parameter is de workflow-instantie die overeenkomt met de trigger, die u kunt verwerken volgens de bijbehorende configuratie. Sommige triggertypen die al globaal naar gebeurtenissen luisteren, hoeven deze twee methoden mogelijk niet te implementeren. In een geplande trigger kunt u bijvoorbeeld een timer registreren in on en deze deregistreren in off.

#Instruction

De basisklasse voor instructietypen, gebruikt om aangepaste instructietypen uit te breiden.

Gerelateerde 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;
}

Voor getScope kunt u verwijzen naar de implementatie van het lus-knooppunt, dat wordt gebruikt om lokale variabele-inhoud voor takken te bieden.

#EXECUTION_STATUS

Een constantentabel voor de statussen van workflow-uitvoeringsplannen, gebruikt om de huidige status van het corresponderende uitvoeringsplan te identificeren.

Behalve de eerste drie, vertegenwoordigen alle andere een mislukte status, maar kunnen ze worden gebruikt om verschillende redenen voor mislukking te beschrijven.

#JOB_STATUS

Een constantentabel voor de statussen van workflow-knooppunt-taken, gebruikt om de huidige status van de corresponderende knooppunt-taak te identificeren. De status die door het knooppunt wordt gegenereerd, beïnvloedt ook de status van het gehele uitvoeringsplan.

#Clientkant

De API's die u kunt gebruiken in de clientkant pakketstructuur, ziet u in de onderstaande code:

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

#PluginWorkflowClient

#registerTrigger()

Registreert het configuratiepaneel voor het triggertype.

Handtekening

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

Parameters

#registerInstruction()

Registreert het configuratiepaneel voor het knooppunttype.

Handtekening

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

Parameters

#registerInstructionGroup()

Registreert een knooppunttypegroep. NocoBase biedt standaard 4 knooppunttypegroepen:

• 'control' (besturing)
• 'collection' (collectie-bewerkingen)
• 'manual' (handmatige verwerking)
• 'extended' (overige uitbreidingen)

Als u andere groepen wilt uitbreiden, kunt u deze methode gebruiken om ze te registreren.

Handtekening

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

Parameters

Voorbeeld

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

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

#Trigger

De basisklasse voor triggers, gebruikt om aangepaste triggertypen uit te breiden.

• Als useVariables niet is ingesteld, betekent dit dat dit type trigger geen functie voor waarde-opvraging biedt, en dat de contextdata van de trigger niet kan worden geselecteerd in de workflow-knooppunten.

#Instruction

De basisklasse voor instructies, gebruikt om aangepaste knooppunttypen uit te breiden.

Gerelateerde typen

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

• Als useVariables niet is ingesteld, betekent dit dat dit knooppunttype geen functie voor waarde-opvraging biedt, en dat de resultaatdata van dit type knooppunt niet kan worden geselecteerd in de workflow-knooppunten. Als de resultaatwaarde enkelvoudig is (niet selecteerbaar), kunt u statische inhoud retourneren die de corresponderende informatie uitdrukt (zie: broncode van het rekenknooppunt). Als het selecteerbaar moet zijn (bijvoorbeeld een eigenschap van een Object), kunt u de corresponderende selectiecomponent-uitvoer aanpassen (zie: broncode van het knooppunt voor het aanmaken van data).
• Component is een aangepaste rendercomponent voor het knooppunt. Wanneer de standaard weergave van het knooppunt niet volstaat, kunt u deze volledig overschrijven en gebruiken voor aangepaste knooppuntweergave. Als u bijvoorbeeld meer actieknoppen of andere interacties wilt bieden voor het startknooppunt van een taktype, dan moet u deze methode gebruiken (zie: broncode van de parallelle tak).
• useInitializers wordt gebruikt om een methode te bieden voor het initialiseren van blokken. In een handmatig knooppunt kunt u bijvoorbeeld gerelateerde gebruikersblokken initialiseren op basis van upstream-knooppunten. Als deze methode wordt geboden, is deze beschikbaar bij het initialiseren van blokken in de interfaceconfiguratie van het handmatige knooppunt (zie: broncode van het knooppunt voor het aanmaken van data).
• isAvailable wordt voornamelijk gebruikt om te bepalen of een knooppunt in de huidige omgeving kan worden gebruikt (toegevoegd). De huidige omgeving omvat de huidige workflow, upstream-knooppunten en de huidige takindex, enz.