مرجع ضبط حِزمة التدفق المشتركة

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلىمستندات Apigee X.
info

إنّ سير العمل المشترَك هو وظيفة قابلة لإعادة الاستخدام تشبه وكيل واجهة برمجة التطبيقات. سيكون معظم محتوى هذا المرجع مألوفًا إذا كنت على دراية بوكلاء واجهة برمجة التطبيقات.

إذا كنت بصدد تعلُّم كيفية إنشاء سير عمل مشترَك، ابدأ بالموضوع سير العمل المشترَكة القابلة لإعادة الاستخدام.

بنية حزمة سير العمل المشترَك

تتألف حزمة سير العمل المشترَك من الإعدادات التالية:

الإعدادات الأساسية إعدادات الضبط الأساسية الاطّلاع على الإعدادات الأساسية
السياسات ملفات الإعداد بتنسيق XML التي تتوافق مع مخططات سياسات Apigee Edge الاطّلاع على السياسات.
المراجع البرامج النصية وملفات JAR وملفات XSLT التي تشير إليها السياسات لتنفيذ منطق مخصّص الاطّلاع على المراجع.
SharedFlows عمليات سير العمل المشترَكة المضمّنة في هذه الحزمة الاطّلاع على عمليات سير العمل المشترَكة.

يتم تحديد المكوّنات في الجدول أعلاه من خلال ملفات الإعداد في بنية الدليل التالية:

ملفات الإعداد وبنية دليل حزمة سير عمل مشترَك

يوضّح هذا القسم ملفات الإعداد وبنية دليل حزمة سير عمل مشترَك.

الإعدادات الأساسية

يقع ملف الإعداد الأساسي في الدليل الجذري للحزمة. واسمه هو اسم الحزمة.

/sharedflowbundle/traffic-management-shared.xml

تحدّد الإعدادات الأساسية محتويات حزمة سير العمل المشترَك، بالإضافة إلى معلومات لتتبُّع سِجل النُسخ السابقة للحزمة.

<SharedFlowBundle revision="2" name="traffic-management-shared">
    <ConfigurationVersion majorVersion="4" minorVersion="0"/>
    <CreatedAt>1478637529218</CreatedAt>
    <CreatedBy>gladys@example.com</CreatedBy>
    <Description>Shared flow to moderate API traffic</Description>
    <DisplayName>traffic-management-shared</DisplayName>
    <LastModifiedAt>1481573374023</LastModifiedAt>
    <LastModifiedBy>gladys@example.com</LastModifiedBy>
    <Policies>
        <Policy>Auth-Flow-Callout</Policy>
        <Policy>Extract-Token</Policy>
        <Policy>Spike-Arrest</Policy>
    </Policies>
    <Resources>
        <Resource>jsc://extract-token.js</Resource>
    </Resources>
    <SharedFlows>
        <SharedFlow>default</SharedFlow>
    </SharedFlows>
</SharedFlowBundle>

سمات الإعدادات الأساسية

الاسم الوصف تلقائي مطلوب؟
SharedFlowBundle
name اسم حزمة سير العمل المشترَك، ويجب أن يكون فريدًا داخل المؤسسة تقتصر الأحرف المسموح بها في الاسم على ما يلي: A-Za-z0-9_- لا ينطبق نعم
revision رقم مراجعة إعدادات حزمة سير العمل المشترَك لست بحاجة إلى ضبط رقم المراجعة بشكلٍ صريح، لأنّ Apigee Edge يتتبّع تلقائيًا المراجعة الحالية لسير العمل المشترَك. لا ينطبق لا

عناصر الإعدادات الأساسية

الاسم الوصف تلقائي مطلوب؟
SharedFlowBundle
ConfigurationVersion إصدار مخطط إعدادات حزمة سير العمل المشترَك الذي يتوافق معه سير العمل المشترَك هذا القيمة المسموح بها حاليًا هي majorVersion 4 وminorVersion 0. قد يتم استخدام هذا الإعداد في المستقبل لتفعيل تطوير تنسيق حزمة سير العمل المشترَك 4.0 لا
CreatedAt وCreatedBy تاريخ/وقت إنشاء حزمة سير العمل المشترَك (بالوقت الفاصل) وعنوان البريد الإلكتروني للمستخدم الذي أنشأها
Description وصف نصي لسير العمل المشترَك إذا تم تقديم الوصف، سيظهر في واجهة إدارة Edge. لا ينطبق لا
DisplayName اسم سهل الاستخدام قد يختلف عن سمة name لإعدادات سير العمل المشترَك لا ينطبق لا
LastModifiedAt وLastModifiedBy تاريخ/وقت آخر تعديل لحزمة سير العمل المشترَك (بالوقت الفاصل) مع عنوان البريد الإلكتروني للمستخدم الذي عدّلها
Policies قائمة بالسياسات في دليل /policies لسير العمل المشترَك هذا لن يظهر هذا العنصر عادةً إلا عند إنشاء سير العمل المشترَك باستخدام واجهة إدارة Edge. هذا مجرد إعداد "بيان"، تم تصميمه لتوفير إمكانية الاطّلاع على محتويات سير العمل المشترَك. لا ينطبق لا
Resources قائمة بالمراجع (JavaScript وPython وJava وXSLT) في دليل /resources لسير العمل المشترَك هذا لن يظهر هذا العنصر عادةً إلا عند إنشاء سير العمل المشترَك باستخدام واجهة إدارة Edge. هذا مجرد إعداد "بيان"، تم تصميمه لتوفير إمكانية الاطّلاع على محتويات سير العمل المشترَك. لا ينطبق لا
SharedFlows تحدّد سير العمل المشترَك الذي تحتوي عليه هذه الحزمة

يُرجى العِلم أنّه لا يمكن لهذا العنصر حاليًا سوى استخدام عنصر ثانوي واحد هو <SharedFlow>، ولا يمكن إضافة سوى سير عمل مشترَك واحد إلى حزمة سير عمل مشترَك.

لا ينطبق نعم

عمليات سير العمل المشترَكة

/sharedflowbundle/sharedflows/default.xml

تحدّد إعدادات SharedFlow التسلسل الذي يجب تنفيذ عناصر سير العمل به. تحدّد كل من العناصر الثانوية <Step> للعنصر <SharedFlow> جزءًا من التسلسل، مثل طلب سياسة.

تحدّد إعدادات SharedFlow التالية ثلاث سياسات سيتم تنفيذها بتسلسل من أعلى إلى أسفل (من اليسار إلى اليمين في وحدة التحكّم بالإدارة)، مع سياسة Spike Arrest أولاً وسياسة Flow Callout أخيرًا.

<SharedFlow name="default">
    <Step>
        <Name>Spike-Arrest</Name>
    </Step>
    <Step>
        <Name>Extract-Token</Name>
    </Step>
    <Step>
        <Name>Auth-Flow-Callout</Name>
    </Step>
</SharedFlow>

سمات إعدادات سير العمل المشترَك

الاسم الوصف تلقائي مطلوب؟
SharedFlow
name اسم سير العمل المشترَك، ويجب أن يكون فريدًا داخل المؤسسة تقتصر الأحرف المسموح بها في الاسم على ما يلي: A-Za-z0-9_- لا ينطبق نعم
revision رقم مراجعة إعدادات سير العمل المشترَك لست بحاجة إلى ضبط رقم المراجعة بشكلٍ صريح، لأنّ Apigee Edge يتتبّع تلقائيًا المراجعة الحالية لسير العمل المشترَك. لا ينطبق لا

عناصر إعدادات سير العمل المشترَك

الاسم الوصف تلقائي مطلوب؟
SharedFlow تحدّد تسلسل السياسات في سير العمل المشترَك لا ينطبق نعم
Step تحدّد خطوة، وهي مرحلة في تسلسل سير العمل لا ينطبق نعم
Name تحدّد اسم العنصر الذي تشير إليه الخطوة يجب أن تكون قيمة هذا العنصر هي نفسها المعرّف الفريد للعنصر، مثل قيمة سمة الاسم للسياسة. لا ينطبق نعم

السياسات

/sharedflowbundle/policies

كما هو الحال في وكيل واجهة برمجة التطبيقات، يحتوي دليل /policies في حزمة سير العمل المشترَك على ملف XML للإعدادات لجميع السياسات التي يمكن إرفاقها بسير العمل المشترَك في الحزمة. تتشارك السياسات مجموعة فرعية من العناصر، على الرغم من أنّ هذه المجموعة الفرعية يتم توسيعها بعناصر خاصة بالسياسة. لمزيد من المعلومات حول كيفية إعداد سياسة، اطّلِع على الموضوع حول السياسة التي تريدها. يمكنك أيضًا الوصول إلى هذه السياسات من نظرة عامة على مرجع السياسات.

المراجع

/sharedflowbundle/resources

المراجع هي البرامج النصية والتعليمات البرمجية وعمليات تحويل XSL التي يمكن إرفاقها بعمليات سير العمل المشترَكة باستخدام السياسات. تظهر هذه المراجع في قسم "البرامج النصية" في محرِّر سير العمل المشترَك في واجهة الإدارة.

اطّلِع على ملفات المراجع لمعرفة أنواع المراجع المتوافقة.

يمكنك نشر الأسئلة في منتدى مطوّري Apigee.