#Tham chiếu API

#Phía máy chủ

Các API có sẵn trong cấu trúc gói phía máy chủ được hiển thị trong đoạn mã sau:

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

#PluginWorkflowServer

Lớp plugin luồng công việc.

Thông thường, trong quá trình chạy ứng dụng, bạn có thể gọi app.pm.get<PluginWorkflowServer>(PluginWorkflowServer) ở bất kỳ đâu có thể truy cập thể hiện ứng dụng app để lấy thể hiện của plugin luồng công việc (sau đây được gọi là plugin).

#registerTrigger()

Mở rộng và đăng ký một loại trình kích hoạt mới.

Chữ ký

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

Tham số

Ví dụ

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

function handler(this: MyTrigger, workflow: WorkflowModel, message: string) {
  // kích hoạt luồng công việc
  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);
    // lắng nghe một số sự kiện để kích hoạt luồng công việc
    process.on(
      'message',
      this.messageHandlers.set(workflow.id, messageHandler),
    );
  }

  off(workflow: WorkflowModel) {
    const messageHandler = this.messageHandlers.get(workflow.id);
    // gỡ bỏ bộ lắng nghe
    process.off('message', messageHandler);
  }
}

export default class MyPlugin extends Plugin {
  load() {
    // lấy thể hiện của plugin luồng công việc
    const workflowPlugin =
      this.app.pm.get<PluginWorkflowServer>(PluginWorkflowServer);

    // đăng ký trình kích hoạt
    workflowPlugin.registerTrigger('myTrigger', MyTrigger);
  }
}

#registerInstruction()

Mở rộng và đăng ký một loại nút mới.

Chữ ký

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

Tham số

Ví dụ

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() {
    // lấy thể hiện của plugin luồng công việc
    const workflowPlugin = this.app.pm.get<PluginWorkflowServer>(PluginWorkflowServer);

    // đăng ký lệnh
    workflowPlugin.registerInstruction('log', LogInstruction);
  }
}

#trigger()

Kích hoạt một luồng công việc cụ thể. Chủ yếu được sử dụng trong các trình kích hoạt tùy chỉnh để kích hoạt luồng công việc tương ứng khi một sự kiện tùy chỉnh cụ thể được lắng nghe.

Chữ ký

trigger(workflow: Workflow, context: any)

Tham số

Ví dụ

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

class MyTrigger extends Trigger {
  timer: NodeJS.Timeout;

  on(workflow) {
    // đăng ký sự kiện
    this.timer = setInterval(() => {
      // kích hoạt luồng công việc
      this.plugin.trigger(workflow, { date: new Date() });
    }, workflow.config.interval ?? 60000);
  }
}

#resume()

Tiếp tục thực thi một luồng công việc đang chờ với một tác vụ nút cụ thể.

• Chỉ những luồng công việc ở trạng thái chờ (EXECUTION_STATUS.STARTED) mới có thể được tiếp tục thực thi.
• Chỉ những tác vụ nút ở trạng thái chờ (JOB_STATUS.PENDING) mới có thể được tiếp tục thực thi.

Chữ ký

resume(job: JobModel)

Tham số

Ví dụ

Xem chi tiết tại mã nguồn.

#Trigger

Lớp cơ sở cho các trình kích hoạt, được sử dụng để mở rộng các loại trình kích hoạt tùy chỉnh.

on/off được sử dụng để đăng ký/hủy đăng ký bộ lắng nghe sự kiện khi một luồng công việc được bật/tắt. Tham số được truyền vào là thể hiện luồng công việc tương ứng với trình kích hoạt, có thể được xử lý theo cấu hình tương ứng. Một số loại trình kích hoạt đã lắng nghe sự kiện toàn cục có thể không cần triển khai hai phương thức này. Ví dụ, trong một trình kích hoạt theo lịch, bạn có thể đăng ký bộ hẹn giờ trong on và hủy đăng ký nó trong off.

#Instruction

Lớp cơ sở cho các loại lệnh, được sử dụng để mở rộng các loại lệnh tùy chỉnh.

Các kiểu liên quan

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 có thể tham khảo triển khai của nút lặp, được sử dụng để cung cấp nội dung biến cục bộ cho các nhánh.

#EXECUTION_STATUS

Bảng hằng số trạng thái kế hoạch thực thi luồng công việc, được sử dụng để xác định trạng thái hiện tại của kế hoạch thực thi tương ứng.

Ngoại trừ ba trạng thái đầu tiên, tất cả các trạng thái khác đều đại diện cho trạng thái thất bại, nhưng có thể được sử dụng để mô tả các nguyên nhân thất bại khác nhau.

#JOB_STATUS

Bảng hằng số trạng thái tác vụ nút luồng công việc, được sử dụng để xác định trạng thái hiện tại của tác vụ nút tương ứng. Trạng thái do nút tạo ra cũng sẽ ảnh hưởng đến trạng thái của toàn bộ kế hoạch thực thi.

#Phía máy khách

Các API có sẵn trong cấu trúc gói phía máy khách được hiển thị trong đoạn mã sau:

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

#PluginWorkflowClient

#registerTrigger()

Đăng ký bảng cấu hình tương ứng cho loại trình kích hoạt.

Chữ ký

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

Tham số

#registerInstruction()

Đăng ký bảng cấu hình tương ứng cho loại nút.

Chữ ký

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

Tham số

#registerInstructionGroup()

Đăng ký nhóm loại nút. NocoBase cung cấp 4 nhóm loại nút mặc định:

• 'control': Điều khiển
• 'collection': Thao tác bộ sưu tập
• 'manual': Xử lý thủ công
• 'extended': Các tiện ích mở rộng khác

Nếu bạn cần mở rộng các nhóm khác, bạn có thể sử dụng phương thức này để đăng ký.

Chữ ký

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

Tham số

Ví dụ

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

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

#Trigger

Lớp cơ sở cho các trình kích hoạt, được sử dụng để mở rộng các loại trình kích hoạt tùy chỉnh.

• Nếu useVariables không được thiết lập, điều đó có nghĩa là loại trình kích hoạt này không cung cấp chức năng truy xuất giá trị, và dữ liệu ngữ cảnh của trình kích hoạt không thể được chọn trong các nút của luồng công việc.

#Instruction

Lớp cơ sở cho các lệnh, được sử dụng để mở rộng các loại nút tùy chỉnh.

Các kiểu liên quan

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

• Nếu useVariables không được thiết lập, điều đó có nghĩa là loại nút này không cung cấp chức năng truy xuất giá trị, và dữ liệu kết quả của loại nút này không thể được chọn trong các nút của luồng công việc. Nếu giá trị kết quả là đơn lẻ (không thể chọn), bạn có thể trả về nội dung tĩnh thể hiện thông tin tương ứng (tham khảo: mã nguồn nút tính toán). Nếu cần có thể chọn (ví dụ: một thuộc tính trong một đối tượng), bạn có thể tùy chỉnh đầu ra của thành phần chọn tương ứng (tham khảo: mã nguồn nút tạo dữ liệu).
• Component là thành phần hiển thị tùy chỉnh cho nút. Khi hiển thị nút mặc định không đủ, nó có thể được ghi đè hoàn toàn để sử dụng, thực hiện hiển thị chế độ xem nút tùy chỉnh. Ví dụ, nếu bạn cần cung cấp thêm các nút thao tác hoặc tương tác khác cho nút bắt đầu của loại nhánh, bạn sẽ cần sử dụng phương thức này (tham khảo: mã nguồn nhánh song song).
• useInitializers được sử dụng để cung cấp phương thức khởi tạo các khối. Ví dụ, trong một nút thủ công, bạn có thể khởi tạo các khối người dùng liên quan dựa trên các nút phía trên. Nếu phương thức này được cung cấp, nó sẽ khả dụng khi khởi tạo các khối trong cấu hình giao diện nút thủ công (tham khảo: mã nguồn nút tạo dữ liệu).
• isAvailable chủ yếu được sử dụng để xác định xem một nút có thể được sử dụng (thêm) trong môi trường hiện tại hay không. Môi trường hiện tại bao gồm luồng công việc hiện tại, các nút phía trên và chỉ mục nhánh hiện tại, v.v.