maintenance app

การบำรุงรักษา-แอป

การกำหนดค่าแอพ

แอพการบำรุงรักษาส่วนใหญ่ขับเคลื่อนโดยแอพ config และ schemas จาก API schemas อ่านโดยตรงจาก 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 นำเข้ารายการชื่อฟิลด์จากไฟล์ที่มีชื่อหลังจากแต่ละรุ่นที่เกี่ยวข้อง

สำหรับบันทึก "schemas" และ "ประเภทแบบจำลอง" เป็นหลักในสิ่งเดียวกันและคำศัพท์เหล่านี้ใช้แทนกันได้ทั้งในแอพบำรุงรักษาและที่อื่น ๆ Schemas ถูกเปิดเผยโดย API แต่ไม่ใช่ทุกรุ่นที่แสดงอยู่ใน schemas เพื่อเพิ่มความสับสน "โมเดล" นั้นบางครั้งก็เรียกว่า "วัตถุ"

ส่วนประเภทของรุ่นและฟิลด์

เพื่อให้ประเภทรุ่นที่จะแสดงในแอพบำรุงรักษาต้องปฏิบัติตามเงื่อนไขต่อไปนี้:

• ประเภทรุ่นแสดงอยู่ภายใต้ส่วนใน src/config/maintenance-models.js
• ประเภทรุ่นมีอยู่ในจุดสิ้นสุดของ Schemas ใน API

เมื่อมีการปฏิบัติตามเงื่อนไขเหล่านี้แล้วประเภทของรุ่นจะปรากฏในแอพบำรุงรักษาภายใต้ส่วนที่ระบุไว้ใน maintenance-models.js เมื่อสร้างหรือแก้ไขโมเดลประเภทใหม่แบบฟอร์มจะเป็นค่าเริ่มต้นจะมีฟิลด์ที่กำหนดไว้ล่วงหน้าเพียงไม่กี่แห่งเท่านั้น เพื่อให้ฟิลด์เพิ่มเติมที่จะแสดงในรูปแบบจะต้องปฏิบัติตามเงื่อนไขต่อไปนี้:

• ฟิลด์แสดงอยู่ภายใต้ประเภทรุ่นใน src/config/field-config/field-order.js
• ฟิลด์มีอยู่ในจุดสิ้นสุดของ Schemas สำหรับประเภทโมเดลเฉพาะใน 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. ภายในไฟล์ Override ฟิลด์ใหม่ ( src/config/field-overrides/newType.js ) เริ่มเพิ่มการปรับแต่งสำหรับฟิลด์ที่ต้องการ โดยทั่วไปจะเกี่ยวข้องกับการสร้างส่วนประกอบใหม่และ/หรือเอาชนะคุณสมบัติของฟิลด์บางอย่าง ดูที่ฟิลด์ที่มีอยู่แทนที่จะเป็นตัวอย่าง
6. สตริงที่ปรากฏเป็น ** string ** ใน UI ขาดการแปล สิ่งเหล่านี้จะต้องเพิ่มลงในไฟล์การแปลที่อยู่ใน src/i18n/ สตริงบางอย่างถูกสร้างขึ้นแบบไดนามิกและอาจปรากฏขึ้นในบางสถานการณ์ตัวอย่างเช่นเมื่อพยายามลบโมเดล หมายเหตุ: เวิร์กโฟลว์การแปลควรเปลี่ยนเป็นบางจุดเป็นการใช้ I18NEXT เพื่อสนับสนุน d2.i18n

กรณีพิเศษพิเศษ

บางรุ่นต้องการการปรับแต่งเกินกว่าสิ่งที่เป็นไปได้โดยใช้การกำหนดค่าและการแทนที่ฟิลด์ ในกรณีเหล่านั้นอาจจำเป็นต้องสร้างองค์ประกอบระดับบนสุดใหม่และเชื่อมโยงส่วนประกอบนั้นกับเส้นทางพิเศษใน src/router.js

ตัวอย่างของวิธีการนี้รวมถึง:

• โปรแกรมแก้ไขโปรแกรมกิจกรรม: src/EditModel/event-program/EditEventProgram.component.js
• ตัวแก้ไขแบบฟอร์มที่กำหนดเอง: src/EditModel/EditDataEntryForm.component.js