أنشئ مستند تصميم تقني لـ SAP CPI من الـ iFlow

كل مشروع SAP Cloud Integration (SAP CPI) يطلب مستند تصميم تقني، ومعظم هذه المستندات يُكتب مرتين: مرة قبل البناء، من المواصفات، ومرة أخرى عند التسليم، من الـ iFlow، لأن الـ iFlow تغيّر. والمرة الثانية في معظمها نسخ لما يقوله الـ iFlow أصلًا.

يسرد هذا المقال ما يجب أن يتضمنه مستند التصميم التقني لـ iFlow، ويبيّن كيف تنشئه من الـ iFlow نفسه، بصيغة Word أو PDF أو HTML، أو في قالب Word الخاص بشركتك.

الغرض من المستند

يخبر مستند التصميم التقني شخصًا لم يبنِ الـ iFlow كيف يعمل: أي أنظمة يربط، وماذا يفعل بالرسالة في طريقها، وكيف يفشل، وما يحتاجه المشغّل لتشغيله. ويُقرأ في المراجعات، وعند التسليم، وبعد أشهر عندما تتعطل الواجهة.

ما الذي تضعه فيه

• نظرة عامة على الواجهة: الاسم، والمعرّف، والحزمة، والغرض، والمرسِلون والمستقبِلون مع محوّلاتهم وعناوينهم.
• التدفق: رسم، ولكل عملية سرد قصير لما يحدث للرسالة.
• التوجيه: كل Router، ومساراته وشروطها، والمسار الافتراضي.
• التحويلات (mappings) والسكربتات: ما يفعله كل منها، في جملة أو جملتين.
• الترويسات والخصائص: ما يضبطه الـ iFlow وما يقرؤه.
• معالجة الأخطاء: عمليات Exception Subprocess وما تفعله.
• الأمان: أسماء بيانات الاعتماد والمفاتيح التي يستخدمها (وليس الأسرار أبدًا).
• المعاملات الخارجية (externalized parameters)، وData Stores وقوائم انتظار JMS وروابط ProcessDirect التي يستخدمها.
• التشغيل: أين تراقبه، وماذا تفعل عندما يفشل، وبمن تتصل.

لماذا تتقادم المستندات المكتوبة يدويًا

كل بند في تلك القائمة موجود أصلًا في الـ iFlow. وكتابته يدويًا تعني نسخ العناوين والشروط وأسماء المعاملات، وكل تغيير في الـ iFlow يجعل النسخة أقل دقة قليلًا. أما المستند المُنشأ من الـ iFlow فيكون صحيحًا يوم إنشائه، وإعادة إنشائه بعد تغيير تستغرق دقيقة.

أنشئه من الـ iFlow

1. افتح الـ iFlow في المصمم، وانقر زر "Kitegra" واختر "توثيق هذا الـ iFlow". يُفتح "مستند iFlow" في تبويب جديد.
2. راجع الحقائق التي قرأها: المشاركون والمحوّلات، والعمليات وخطواتها، والمسارات، والتحويلات والسكربتات، والترويسات والخصائص، والمعاملات، وأسماء Security Material، والمخازن والروابط، ومعالجة الأخطاء.
3. اختر "القالب": "التصميم التقني" أو "ملخص قصير" أو "تسليم العمليات".
4. املأ "المشروع" و"المؤلف"؛ ويُحتفظ بهما للمستند التالي.
5. نزّله بصيغة Word أو PDF أو HTML.

يُرسم الرسم من الـ iFlow، وتحصل كل عملية على سرد مثل "يتلقى رسائل من … عبر …" و"عند حدوث خطأ: …". ودون المصمم، اختر "رفع iFlow (ZIP أو .iflw)" بدلًا من ذلك؛ والملف المرفوع لا يُحتسب ضمن iFlows خطتك. وتسميات ملف PDF باللغة الإنجليزية.

استخدم قالب Word الخاص بشركتك

إذا كان لمشروعك قالب، فاختر "قالب Word الخاص بك". اكتب العناصر النائبة (placeholders) في ملف .docx حيث يجب أن توضع الحقائق، ثم اختر "املأ ونزّل":

Interface:   {{iflowName}} ({{iflowId}})
Package:     {{package}}
Project:     {{project}}        Author: {{author}}        Date: {{date}}

Purpose
{{description}}

Senders: {{senders}}        Receivers: {{receivers}}
Adapters: {{adapters}}

How it works
{{narrative}}

Routing: {{routes}}
Scripts: {{scripts}}
Error handling: {{errorHandling}}

تسرد الصفحة كل عنصر نائب تملؤه، ومنها {{iflowName}} و{{package}} و{{narrative}} و{{routes}} و{{parameters}} و{{securityMaterial}} و{{errorHandling}}. وتحصل Message Mappings على جدولها الخاص: اطّلع على توثيق Message Mapping في Excel.

كيف يساعدك Kitegra

المستندات هي مجال iFlow Docs في Kitegra. يُبنى المستند في متصفحك؛ ولا تُرسل السكربتات والتحويلات (mappings) إلى Kitegra أبدًا. وقبل أن توثّق iFlow، تلتقط قائمة المراجعة ما لا تريد أن تكتبه في المستند.

تحتسب كلٌّ من Helper وMessage Monitor وiFlow Inspector وiFlow Docs عدد iFlows التي تستخدمها عليها: 5 لكل وحدة بلا حساب، و50 في خطة Free، و100 في خطة Starter، و300 في خطة Pro، أما خطة Business فبلا حد. ويأتي Toolbox وميزات مساحة العمل الإضافية مجانًا. قارن بين الخطط.

جرّبها في الـ iFlow التالي

تعرّف على ما يضيفه Kitegra حول مصمم SAP Integration Suite، أو اطّلع عليه مع بقية وحدات Kitegra.

الأسئلة الشائعة