#הפניה ל-API

#צד השרת

ממשקי ה-API הזמינים במבנה חבילת צד השרת מוצגים בקוד הבא:

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

#PluginWorkflowServer

מחלקה של תוסף תהליך עבודה.

בדרך כלל, בזמן ריצת היישום, תוכלו לקרוא ל-app.pm.get<PluginWorkflowServer>(PluginWorkflowServer) בכל מקום שבו ניתן לגשת למופע היישום app, כדי לקבל את מופע תוסף תהליך העבודה (להלן יכונה plugin).

#registerTrigger()

מרחיב ורושם סוג טריגר חדש.

חתימה

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

פרמטרים

דוגמה

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

function handler(this: MyTrigger, workflow: WorkflowModel, message: string) {
  // מפעיל את תהליך העבודה
  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);
    // מאזין לאירוע כלשהו כדי להפעיל את תהליך העבודה
    process.on(
      'message',
      this.messageHandlers.set(workflow.id, messageHandler),
    );
  }

  off(workflow: WorkflowModel) {
    const messageHandler = this.messageHandlers.get(workflow.id);
    // מסיר את המאזין
    process.off('message', messageHandler);
  }
}

export default class MyPlugin extends Plugin {
  load() {
    // מקבל את מופע תוסף תהליך העבודה
    const workflowPlugin =
      this.app.pm.get<PluginWorkflowServer>(PluginWorkflowServer);

    // רושם את הטריגר
    workflowPlugin.registerTrigger('myTrigger', MyTrigger);
  }
}

#registerInstruction()

מרחיב ורושם סוג צומת חדש.

חתימה

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

פרמטרים

דוגמה

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() {
    // מקבל את מופע תוסף תהליך העבודה
    const workflowPlugin = this.app.pm.get<PluginWorkflowServer>(PluginWorkflowServer);

    // רושם את ההוראה
    workflowPlugin.registerInstruction('log', LogInstruction);
  }
}

#trigger()

מפעיל תהליך עבודה ספציפי. משמש בעיקר בטריגרים מותאמים אישית, כדי להפעיל את תהליך העבודה המתאים כאשר מאזינים לאירוע מותאם אישית ספציפי.

חתימה

trigger(workflow: Workflow, context: any)

פרמטרים

דוגמה

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

class MyTrigger extends Trigger {
  timer: NodeJS.Timeout;

  on(workflow) {
    // רושם אירוע
    this.timer = setInterval(() => {
      // מפעיל את תהליך העבודה
      this.plugin.trigger(workflow, { date: new Date() });
    }, workflow.config.interval ?? 60000);
  }
}

#resume()

מחדש את ביצוע תהליך עבודה שהושהה באמצעות משימת צומת ספציפית.

• רק תהליכי עבודה הנמצאים במצב המתנה (EXECUTION_STATUS.STARTED) יכולים להתחדש.
• רק משימות צומת הנמצאות במצב ממתין (JOB_STATUS.PENDING) יכולות להתחדש.

חתימה

resume(job: JobModel)

פרמטרים

דוגמה

לפרטים נוספים, ראו קוד המקור.

#Trigger

מחלקה בסיסית לטריגרים, המשמשת להרחבת סוגי טריגרים מותאמים אישית.

on/off משמשים לרישום/ביטול רישום של מאזיני אירועים כאשר תהליך עבודה מופעל/מושבת. הפרמטר המועבר הוא מופע תהליך העבודה המתאים לטריגר, וניתן לטפל בו בהתאם להגדרות. סוגי טריגרים מסוימים שכבר מאזינים לאירועים באופן גלובלי, אינם חייבים לממש את שתי השיטות הללו. לדוגמה, בטריגר מתוזמן, ניתן לרשום טיימר ב-on ולבטל את רישומו ב-off.

#Instruction

מחלקה בסיסית לסוגי הוראות, המשמשת להרחבת סוגי הוראות מותאמים אישית.

סוגים קשורים

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, תוכלו לעיין במימוש צומת הלולאה, המשמש לספק תוכן משתנים מקומיים עבור ענפים.

#EXECUTION_STATUS

טבלת קבועים עבור סטטוסי תוכנית ביצוע של תהליך עבודה, המשמשת לזיהוי הסטטוס הנוכחי של תוכנית הביצוע המתאימה.

למעט שלושת הראשונים, כל השאר מייצגים מצב כשל, אך יכולים לשמש לתיאור סיבות שונות לכשל.

#JOB_STATUS

טבלת קבועים עבור סטטוסי משימות צומת בתהליך עבודה, המשמשת לזיהוי הסטטוס הנוכחי של משימת הצומת המתאימה. הסטטוס שנוצר על ידי הצומת משפיע גם על סטטוס תוכנית הביצוע כולה.

#צד הלקוח

ממשקי ה-API הזמינים במבנה חבילת צד הלקוח מוצגים בקוד הבא:

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

#PluginWorkflowClient

#registerTrigger()

רושם את לוח התצורה המתאים לסוג הטריגר.

חתימה

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

פרמטרים

#registerInstruction()

רושם את לוח התצורה המתאים לסוג הצומת.

חתימה

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

פרמטרים

#registerInstructionGroup()

רושם קבוצת סוגי צמתים. NocoBase מספקת כברירת מחדל 4 קבוצות סוגי צמתים:

• 'control': בקרת זרימה
• 'collection': פעולות על אוספים
• 'manual': טיפול ידני
• 'extended': הרחבות אחרות

אם אתם צריכים להרחיב קבוצות נוספות, תוכלו להשתמש בשיטה זו לרישום.

חתימה

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

פרמטרים

דוגמה

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

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

#Trigger

מחלקה בסיסית לטריגרים, המשמשת להרחבת סוגי טריגרים מותאמים אישית.

• אם useVariables אינו מוגדר, פירוש הדבר שסוג טריגר זה אינו מספק פונקציית אחזור ערכים, ולא ניתן לבחור את נתוני ההקשר של הטריגר בצמתי תהליך העבודה.

#Instruction

מחלקה בסיסית להוראות, המשמשת להרחבת סוגי צמתים מותאמים אישית.

סוגים קשורים

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

• אם useVariables אינו מוגדר, פירוש הדבר שסוג צומת זה אינו מספק פונקציית אחזור ערכים, ולא ניתן לבחור את נתוני התוצאה של צומת מסוג זה בצמתי תהליך העבודה. אם ערך התוצאה הוא יחיד (לא ניתן לבחירה), ניתן להחזיר תוכן סטטי המבטא את המידע המתאים (ראו: קוד המקור של צומת חישוב). אם נדרשת בחירה (לדוגמה, מאפיין מסוים באובייקט), ניתן להתאים אישית את פלט רכיב הבחירה המתאים (ראו: קוד המקור של צומת יצירת נתונים).
• Component הוא רכיב רינדור מותאם אישית עבור הצומת. כאשר רינדור הצומת המוגדר כברירת מחדל אינו מספק, ניתן להחליף אותו לחלוטין ולבצע רינדור תצוגת צומת מותאמת אישית. לדוגמה, אם ברצונכם לספק כפתורי פעולה נוספים או אינטראקציות אחרות עבור צומת ההתחלה של סוג ענף, עליכם להשתמש בשיטה זו (ראו: קוד המקור של ענף מקבילי).
• useInitializers משמש לספק שיטה לאתחול בלוקים. לדוגמה, בצומת ידני, ניתן לאתחל בלוקי משתמש קשורים בהתבסס על צמתי upstream. אם שיטה זו מסופקת, היא תהיה זמינה בעת אתחול בלוקים בתצורת ממשק הצומת הידני (ראו: קוד המקור של צומת יצירת נתונים).
• isAvailable משמש בעיקר לקבוע אם ניתן להשתמש (להוסיף) בצומת בסביבה הנוכחית. הסביבה הנוכחית כוללת את תהליך העבודה הנוכחי, צמתי upstream ואינדקס הענף הנוכחי, ועוד.