maintenance app

صيانة التطبيق

App Config

تطبيق الصيانة مدفوع إلى حد كبير بواسطة تكوين التطبيق والمخططات من واجهة برمجة التطبيقات. تتم قراءة المخططات مباشرة من API (بواسطة D2). المستندات التالية تكوين التطبيق:

• داخل src/config/ ...
  • تحدد maintenance-models.js أنواع النماذج المعروضة في التطبيق
  • field-config/ يحتوي على تكوين لكل نوع من الطراز
    • يحدد field-order.js ترتيب الحقول ضمن النموذج لكل نوع من الطراز
    • يحدد field-groups.js التجمع الميداني للنموذج لكل نموذج. يستخدم هذا حاليًا فقط للبرامج ، ولكن قد يكون من الجيد توسيعها إلى أنواع النماذج الأخرى أيضًا.
  • field-overrides/ يحتوي على تكوين إضافي للحقول التي تتطلب سلوكًا غير قياسي. الأكثر شيوعًا هذا يعني الحقول التي تتطلب مكونات خاصة.
    • index.js يسرد جميع النماذج التي لديها واحد أو أكثر من تجاوزات الحقل
    • يتم تحديد تجاوزات الحقل الفعلي في الملفات المسمى على بعد كل نوع من أنواع الطراز ، والتي بدورها يتم استيرادها إلى index.js . يتم فصل بعض أنواع النماذج أو الحقول التي تتطلب الكثير من المنطق إلى مجلدات فرعية.
  • inlinehelp-mapping.json يحدد التعيين من كل قسم/نوع النموذج إلى صفحات في الوثائق.
  • يحتوي field-rules.js على منطق مشروط يمكن استخدامه لإظهار أو إخفاء الحقول أو تعيين قيم الحقل بناءً على قيمة الحقول الأخرى.
  • يحتوي periodTypes.json على قائمة أنواع الفترة التي تدعمها الإصدار الحالي من API.
  • disabled-on-edit/ يحتوي على ملفات تسرد حقول سيتم عرضها دائمًا على أنها قراءة فقط عند تحرير كائن.
    • index.js استيراد قوائم أسماء الحقول من الملفات التي تحمل اسم كل نموذج ذي صلة

بالنسبة للسجل ، فإن "أنواع النماذج" و "أنواع النماذج" هي نفس الشيء بشكل أساسي ويتم استخدام هذه المصطلحات بالتبادل في تطبيق الصيانة وفي أي مكان آخر. يتم كشف المخططات بواسطة API ، ولكن لا يتم سرد كل نوع نموذج في المخططات. للإضافة إلى "نماذج" الارتباك ، يشار إليها في بعض الأحيان باسم "الكائنات".

الأقسام وأنواع النماذج والحقول

لكي يظهر نوع النموذج في تطبيق الصيانة ، يجب تلبية الشروط التالية:

• يتم سرد نوع النموذج ضمن قسم في src/config/maintenance-models.js
• يوجد نوع النموذج في نقطة نهاية المخططات في API

بمجرد استيفاء هذه الشروط ، سيظهر نوع النموذج في تطبيق الصيانة ضمن القسم المحدد في maintenance-models.js . عند إنشاء نماذج أو تحريرها من النوع الجديد ، لن يحتوي النموذج بشكل افتراضي على حفنة من الحقول المحددة مسبقًا. لكي يتم عرض الحقول الإضافية في النموذج ، يجب تلبية الشروط التالية:

• يتم سرد الحقل ضمن نوع النموذج في src/config/field-config/field-order.js
• يوجد الحقل في نقطة نهاية المخططات لنوع النموذج المحدد في API.

إضافة نوع طراز جديد

تتضمن إضافة نموذج جديد إلى الصيانة الخطوات التالية:

1. أضف نوع النموذج إلى src/config/maintenance-models.js
2. أضف نوع النموذج وقائمة الحقول التي يجب عرضها في النموذج إلى src/config/field-config/field-order.js
   1. (اختياري) إذا كان ينبغي فصل الحقول إلى مجموعات منفصلة في النموذج ، يمكن تحديد المجموعات في src/config/field-config/field-groups.js .
3. يجب الآن إدراج نوع النموذج الجديد في تطبيق الصيانة. انتقل إلى نوع النموذج الجديد وتحقق من النموذج على حد سواء عند إنشاء مثيل جديد لنوع النموذج وعند تحرير مثيل موجود. إذا كنت محظوظًا ، فسيعمل كل شيء في هذه المرحلة. على الأرجح سيكون هناك واحد أو أكثر من الحقول التي تتطلب المزيد من التخصيص.
4. قم بإنشاء ملف جديد يسمى بعد نوع النموذج الجديد في src/config/field-overrides/ . افتح src/config/field-overrides/index.js ، واستيراد الملف الذي تم إنشاؤه حديثًا وإضافته إلى كائن overridesByType .
5. داخل ملف تجاوز الحقل الجديد ( src/config/field-overrides/newType.js ) ، ابدأ في إضافة التخصيصات للحقول التي تتطلب ذلك. يتضمن هذا عادة إنشاء مكونات جديدة و/أو تجاوز خصائص حقل معينة. انظر إلى تجاوزات الحقل الحالي للأمثلة.
6. الأوتار التي تظهر كسلسلة ** string ** في واجهة المستخدم تفتقر إلى الترجمات. سوف تحتاج إلى إضافتها إلى ملفات الترجمات الموجودة في src/i18n/ . يتم إنشاء بعض السلاسل ديناميكيًا وقد تظهر فقط في مواقف معينة ، على سبيل المثال عند محاولة حذف نموذج. ملاحظة: يجب أن يتغير سير عمل الترجمة في مرحلة ما إلى استخدام I18NEXT لصالح d2.i18n .

حالات خاصة إضافية

تتطلب بعض النماذج التخصيص بما يتجاوز ما هو ممكن باستخدام تجاوزات التكوين والحقل. في هذه الحالات ، قد يكون من الضروري إنشاء مكون جديد للمستوى العلوي وربط هذا المكون بطريق خاص في src/router.js

تشمل أمثلة هذا النهج:

• محرر برنامج الأحداث: src/EditModel/event-program/EditEventProgram.component.js
• محرر النماذج المخصصة: src/EditModel/EditDataEntryForm.component.js