سير العمل
المنصة الأساسيةworkflow_definitions_readسير العمليقرأ عمليات أتمتة سير العمل في منشأة: مسارات العمل، والرسم البياني الكامل لمسار عمل واحد، وأنواع العُقد التي يمكن أن يستخدمها الرسم البياني، والقوالب المنتقاة. اقرأ node_types قبل إنشاء رسم بياني أو تعديله حتى يكون كل نوع ومعلمة صالحين في المنشأة.
الإجراءات:
- list: عرض مسارات العمل. كل مسار عمل مع حالة تشغيله الحي، وإصداره المنشور، وعدد مرات تشغيله، وآخر تشغيل، وعُقده (id، وname، وtype). لا تُدرج مسارات عمل العلامة التجارية والمنظمة.
- get: الحصول على مسار عمل. الرسم البياني الكامل للمسودة (العُقد، والاتصالات، والملاحظات، والإعدادات) وmeta: active، وpublishedVersionId، وبعد النشر publishedWorkflow، وهو الرسم البياني الحي الآن. مسارات عمل هذه المنشأة فقط. يتطلب workflowId.
- node_types: أنواع العُقد. إدخالات اللوحة مع type، وlabel، وcategory، وoutputs (الفروع)، وinputSchema، وهي المعلمات المطلوب ملؤها. تكون available بالقيمة false، مع السبب، عندما تفتقر المنشأة إلى وحدة نمطية تحتاج إليها العقدة. تظهر أدوات MCP بوصفها عُقد mcp.
. . - templates: القوالب. نقاط بداية لعمليات الأتمتة الشائعة، مع risk وriskNote (ما قد يحدث من خطأ إذا نُشر دون عناية)، وأنواع العُقد، والوحدات النمطية المطلوبة، والتوفر في هذه المنشأة، ورسم بياني للمعاينة. حوّل قالبًا إلى رسم بياني باستخدام workflow_definitions_write instantiate_template.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
action* | "list" | "get" | "node_types" | "templates" | الإجراء المطلوب؛ كل إجراء موصوف في وصف الأداة. |
limit | integer | عدد العناصر في الصفحة (الافتراضي 25، والحد الأقصى 100) (list, node_types, templates) |
cursor | string | nextCursor من الصفحة السابقة (list, node_types, templates) |
facilityId | string | معرّف المنشأة. اختياري إذا كانت المنشأة المتصلة هي المقصودة. |
workflowId | string | معرّف مسار العمل من workflow_definitions_read list (get) |
query | string | كلمات للبحث عنها في النوع أو التسمية أو الوصف أو مصطلحات البحث (node_types) |
category | string | هذه الفئة فقط: trigger أو action أو logic أو ai (node_types) |
types | array | الأنواع المحددة المراد وصفها، مثل الأنواع الموجودة في مسار عمل تعدّله. يشمل الأنواع المتقاعدة التي لم تعد اللوحة تعرضها؛ ويتجاهل query وcategory. (node_types) |
workflow_definitions_writeسير العملينشئ عمليات أتمتة سير العمل في منشأة ويعدّلها وينشرها ويوقفها ويحذفها. دورة الإنشاء: اقرأ node_types باستخدام workflow_definitions_read، وأنشئ الرسم البياني (أو ابدأ من instantiate_template)، وأنشئه بوصفه مسودة، وجرّبه باستخدام workflow_runs_write test (محاكاة)، ثم انشره. لا تغيّر تعديلات المسودة أبدًا ما هو حي حتى تُنشر.
الإجراءات:
- create: إنشاء مسار عمل. يحفظ مسودة جديدة غير نشطة من رسم بياني كامل يحتوي على عقدة واحدة على الأقل؛ وname افتراضيًا "Untitled workflow". تعود مشكلات التحقق في errors مع تفاصيل العقدة. يتطلب nodes.
- update: حفظ المسودة. يستبدل المسودة بالكامل: أرسل كل عقدة واتصال، وليس التغييرات فقط. يستمر الإصدار الحي في العمل حتى تنشر. تعود مشكلات التحقق في errors مع تفاصيل العقدة. يتطلب workflowId وnodes.
- patch_meta: إعادة التسمية. يغيّر الاسم أو الوصف فقط؛ ويبقى الرسم البياني والإصدار الحي كما هما. تكون changed بالقيمة false إذا كان كلاهما مطابقًا بالفعل. يتطلب workflowId.
- duplicate: التكرار. ينسخ مسار عمل إلى مسودة جديدة باسم "
(copy)" بمعرّفات عُقد جديدة، غير منشورة ولا نشطة أبدًا. لا يُمس الأصل. يتطلب workflowId. - delete: الحذف. يحذف مسار العمل نهائيًا: المسودة، والإصدارات المنشورة، وسجل التشغيل، وتوجيه المشغّلات. أما set_active false فيوقفه مع الاحتفاظ به؛ ويعيد discard_draft تعيين تعديلات المسودة فقط. يتطلب workflowId. يطلب التأكيد.
- discard_draft: تجاهل تعديلات المسودة. يعيد المسودة إلى آخر إصدار منشور، متجاهلًا التعديلات التي أُجريت منذ ذلك الحين. لا يتأثر الإصدار الحي أبدًا؛ ويتطلب وجود إصدار منشور. يتطلب workflowId. يطلب التأكيد.
- publish: النشر. يتحقق من صحة المسودة، ويحفظها بوصفها الإصدار الحي ويشغّل مسار العمل، فتُطلق مشغّلاته وتُنفَّذ إجراءاته فعليًا. تكتمل عمليات التشغيل الجارية على الإصدار القديم. إذا كانت خطوات Delay المنتظرة ستُعاد جدولتها، فستحتوي النتيجة على الرمز WAIT_RETARGET_CONFIRMATION_REQUIRED وimpacts: استدعِ مجددًا مع confirmWaitRetargets وتلك impacts. يتطلب workflowId. يطلب التأكيد.
- set_active: التشغيل أو الإيقاف. active true يعيد تشغيل مسار عمل منشور. active false يوقفه: تتوقف المشغّلات عن الإطلاق وتُلغى خطوات Delay المعلّقة فلا تكتمل أبدًا. لا يُحذف أي شيء. يطلب التأكيد أولًا ما لم يكن في تلك الحالة بالفعل. يتطلب workflowId وactive. قد يطلب التأكيد.
- instantiate_template: رسم بياني من قالب. يحوّل قالبًا إلى رسم بياني جاهز لـ create: { name, description, nodes, connections } بمعرّفات عُقد جديدة. تترك القوالب المستلمين والأبواب والأوقات فارغة عمدًا؛ املأها أولًا. لا يحفظ شيئًا. يتطلب templateId.
- generate: إنشاء رسم بياني. ينشئ رسمًا بيانيًا من طلب بلغة بسيطة باستخدام الذكاء الاصطناعي للمنشأة ويعيد { name, description, nodes, connections } باستخدام أنواع عُقد صالحة فقط. مرّر workflow لمراجعة مسار عمل؛ ويعود الرسم البياني المُراجع كاملًا. لا يحفظ شيئًا، لكنه يستهلك أرصدة الذكاء الاصطناعي للمنشأة. يتطلب prompt. يطلب التأكيد.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
action* | "create" | "update" | "patch_meta" | "duplicate" | "delete" | "discard_draft" | "publish" | "set_active" | "instantiate_template" | "generate" | الإجراء المطلوب؛ كل إجراء موصوف في وصف الأداة. |
name | string | اسم مسار العمل (create, update, patch_meta) |
description | string | ما يفعله مسار العمل (create, update, patch_meta) |
nodes | array | كل عقدة: { id, name, type, position, parameters }. تأتي الأنواع والمعلمات من workflow_definitions_read node_types. (create, update) |
connections | object | الاتصالات مفهرسة باسم العقدة المصدر؛ ويمكن أن تكون فارغة لعقدة واحدة (create, update) |
notes | array | ملاحظات اللوحة (create, update) |
settings | object | إعدادات مسار العمل (create, update) |
facilityId | string | معرّف المنشأة. اختياري إذا كانت المنشأة المتصلة هي المقصودة. |
workflowId | string | معرّف مسار العمل من workflow_definitions_read list (update, patch_meta, duplicate, delete, discard_draft, publish, set_active) |
confirmWaitRetargets | boolean | إعادة جدولة خطوات Delay المنتظرة المدرجة في impacts للنتيجة السابقة (publish) |
confirmedWaitRetargets | array | قيمة impacts من نتيجة WAIT_RETARGET_CONFIRMATION_REQUIRED، تُعاد دون تغيير (publish) |
active | boolean | true لتشغيله، وfalse لإيقافه (set_active) |
templateId | string | معرّف القالب من workflow_definitions_read templates (instantiate_template) |
prompt | string | ما يجب أن يفعله مسار العمل (generate) |
workflow | object | مسار عمل كامل من workflow_definitions_read get، لمراجعته بدلًا من البدء من جديد (generate) |
confirm | boolean | اضبطه فقط بعد أن يؤكد المستخدم المعاينة التي أعادها الاستدعاء الأول |
workflow_runs_readسير العملسجل تشغيل مسار عمل، من الأحدث إلى الأقدم، وتشغيل واحد خطوة بخطوة. استخدمه للتحقق مما إذا كانت عملية أتمتة قد عملت، أو لمتابعة تشغيل بدأ باستخدام workflow_runs_write، أو لمعرفة العقدة التي فشلت وسبب فشلها.
الإجراءات:
- list: عرض عمليات التشغيل. كل تشغيل مع status، وmode (live أو test)، والتأثيرات الجانبية، والمشغّل، ومن بدأه، والأوقات، وعدد الخطوات، والعقدة التي ينتظرها، وأي خطأ. يتطلب workflowId.
- get: الحصول على تشغيل. حالة التشغيل مع كل خطوة بالترتيب، ومدخلات كل عقدة ومخرجاتها وملاحظتها وخطئها. عمليات التشغيل غير متزامنة: التشغيل الذي يحتوي على Delays ينتظر حتى يحين موعد استكماله. يتطلب workflowId وexecutionId.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
action* | "list" | "get" | الإجراء المطلوب؛ كل إجراء موصوف في وصف الأداة. |
workflowId | string | معرّف مسار العمل من workflow_definitions_read list |
limit | integer | عدد العناصر في كل صفحة (الافتراضي 25، والحد الأقصى 100) (list) |
cursor | string | قيمة nextCursor من الصفحة السابقة (list) |
facilityId | string | معرّف المنشأة. اختياري إذا كانت المنشأة المتصلة هي المقصودة. |
executionId | string | معرّف التشغيل من workflow_runs_read list (get) |
workflow_runs_writeسير العمليبدأ عمليات تشغيل مسارات العمل، ويشغّلها تجريبيًا، ويلغيها، ويعيد تشغيلها. فضّل test، الذي يشغّل المسودة مع محاكاة التأثيرات الجانبية؛ أما run فينفّذ مسار العمل المنشور فعليًا. عمليات التشغيل غير متزامنة: تابعها باستخدام workflow_runs_read get.
الإجراءات:
- run: التشغيل الآن. يشغّل مسار العمل المنشور من مشغّله اليدوي (custom.manualTrigger)، مع تأثيرات جانبية حقيقية. تُطلق المشغّلات المجدولة ومشغّلات webhook والأحداث من تلقاء نفسها. يعيد executionId للتشغيل وحالته الأولى. يتطلب workflowId. يطلب التأكيد.
- test: اختبار المسودة. يشغّل المسودة المحفوظة دون نشرها، ويُسجَّل بوصفه تشغيلًا تجريبيًا. تُحاكى التأثيرات الجانبية افتراضيًا: لا يُرسل أو يُبدَّل أي شيء، وتُبلغ كل عقدة عما كانت ستفعله. sideEffects live يطلب التأكيد أولًا. يتطلب workflowId. قد يطلب التأكيد.
- cancel: إلغاء تشغيل منتظر. يلغي تشغيلًا ينتظر Delay: تُغلق عمليات الانتظار المعلّقة ولا تُنفَّذ الخطوات التالية لها أبدًا. لا يمكن إلغاء عمليات التشغيل المكتملة ولا تلك التي في منتصف خطوة. يتطلب workflowId وexecutionId. يطلب التأكيد.
- retry: إعادة تشغيل. يعيد تشغيل تشغيل مكتمل من مدخلات المشغّل المسجلة، ويُربط به عبر retryOf. الخيار published (الافتراضي) يعيد تشغيل الإصدار الذي استخدمه، فعليًا، ويطلب التأكيد أولًا؛ والخيار draft-test يشغّل المسودة الحالية بالمحاكاة، وهو الخيار الصحيح أثناء إصلاح فشل. يتطلب workflowId وexecutionId. قد يطلب التأكيد.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
action* | "run" | "test" | "cancel" | "retry" | الإجراء المطلوب؛ كل إجراء موصوف في وصف الأداة. |
workflowId | string | معرّف مسار العمل من workflow_definitions_read list |
nodeId | string | معرّف عقدة المشغّل للبدء منها؛ اتركه للمشغّل اليدوي (run, test) |
payload | object | مدخلات العُقد التالية للمشغّل، مثل { "visitorName": "Ada" } (run, test) |
facilityId | string | معرّف المنشأة. اختياري إذا كانت المنشأة المتصلة هي المقصودة. |
sideEffects | "simulate" | "live" | هل تُنفَّذ إجراءات العُقد فعليًا (test) |
executionId | string | معرّف التشغيل من workflow_runs_read list (cancel, retry) |
mode | "published" | "draft-test" | ما يُعاد التشغيل مقابله (retry) |
confirm | boolean | اضبطه فقط بعد أن يؤكد المستخدم المعاينة التي أعادها الاستدعاء الأول |