config.xml

คำอธิบาย config.xml

ไฟล์ config.xml

ไฟล์ config.xml ใน Backstage ใช้กำหนดค่าโมดูล ไฟล์นี้ประกอบด้วยองค์ประกอบหลัก 4 ประการ:

1. app:

• กำหนดข้อมูลทั่วไปเกี่ยวกับโมดูล

• องค์ประกอบนี้ประกอบด้วยแท็กย่อยต่อไปนี้:

  • UUID: รหัสเฉพาะสำหรับโมดูล

  • sys: ระบุว่าโมดูลเป็นโมดูลระบบหรือไม่

  • version: เวอร์ชันโมดูล

  • versionSys: เวอร์ชันระบบ Backstage ที่โมดูลรองรับ

  • author: ผู้เขียนโมดูล

  • website: เว็บไซต์ของผู้เขียนโมดูล

  • email: อีเมลติดต่อของผู้เขียนโมดูล

ตัวอย่าง:

XML

<app>
  <UUID>sY4o7pEVn/t0wkyCPJuaR3Y6.cuOxk0YOI8XGkmy1zU=</UUID>
  <sys>false</sys>
  <version>1.0</version>
  <versionSys>315</versionSys>
  <author>PNA Digital Co.,Ltd</author>
  <website>https://www.pna.co.th</website>
  <email>[email protected]</email>
</app>

2. menu:

• กำหนดค่ารายการเมนูสำหรับโมดูล

• องค์ประกอบนี้ประกอบด้วยแท็กย่อยต่อไปนี้:

  • display: รูปแบบการแสดงผล (content,full,menu)

  • auth: ระบุว่าจำเป็นต้องมีการรับรองความถูกต้องหรือไม่

  • show: ระบุว่าจะแสดงรายการเมนูหรือไม่

  • row: ลำดับการแสดงรายการเมนู

  • url: URL ของโมดูล

  • language: ข้อความที่แสดงในเมนูสำหรับภาษาต่างๆ

  • permission: สิทธิ์การเข้าถึงสำหรับรายการเมนู

  • color: สีของไอคอนเมนู

  • icon: ไอคอนเมนู

ตัวอย่าง:

XML

<menu>
  <display>content</display>
  <auth>true</auth>
  <show>true</show>
  <row>97</row>
  <url/>
  <language>
   <th-th>
    <name>ฝ่ายการขาย</name>
    <shortdesc>ฝ่ายการขาย</shortdesc>
   </th-th>
   <en-us>
    <name>Sales</name>
    <shortdesc>Sales</shortdesc>
   </en-us>
  </language>
  <permission>
   <team>1</team>
   <team>4</team>
   <team>6</team>
   <team>8</team>
  </permission>
  <color>#3498DB</color>
  <icon>fab fa-amazon</icon>
</menu>

3. addon:

• กำหนดค่าส่วนเพิ่มเติมสำหรับโมดูล

• องค์ประกอบนี้ประกอบด้วยแท็กย่อยต่อไปนี้:

  • database: กำหนดค่าการเชื่อมต่อฐานข้อมูล ชื่อฐานข้อมูลที่ใช้ในโมดูลนี้

  • css: กำหนดค่าไฟล์ CSS

  • script: กำหนดค่าไฟล์ JavaScript

ตัวอย่าง:

XML

<addon>
  <database/>
  <css>
   <url/>
  </css>
  <script>
   <url/>
  </script>
</addon>

4. css:

• กำหนดค่าไฟล์ CSS สำหรับโมดูล

• องค์ประกอบนี้ประกอบด้วยแท็กย่อยต่อไปนี้:

  • url: URL ของไฟล์ CSS

ตัวอย่าง:

XML

<css>
  <url/>
</css>

5. script:

• กำหนดค่าไฟล์ JavaScript สำหรับโมดูล

• องค์ประกอบนี้ประกอบด้วยแท็กย่อยต่อไปนี้:

  • url: URL ของไฟล์ JavaScript

ตัวอย่าง:

XML

<script>
  <url/>
</script>

ตัวอย่างไฟล์ XML แบบเต็ม

<?xml version="1.0" encoding="UTF-8"?>
<config>
  <app>
    <UUID>sY4o7pEVn/t0wkyCPJuaR3Y6.cuOxk0YOI8XGkmy1zU=</UUID>
    <sys>false</sys>
    <version>1.0</version>
    <versionSys>315</versionSys>
    <author>PNA Digital Co.,Ltd</author>
    <website>https://www.pna.co.th</website>
    <email>[email protected]</email>
  </app>
  <menu>
    <display>content</display>
    <auth>true</auth>
    <show>true</show>
    <row>97</row>
    <url/>
    <language>
      <th-th>
        <name>ฝ่ายการขาย</name>
        <shortdesc>ฝ่ายการขาย</shortdesc>
      </th-th>
      <en-us>
        <name>ฝ่ายการขาย</name>
        <shortdesc>ฝ่ายการขาย</shortdesc>
      </en-us>
    </language>
    <permission>
      <team>1</team>
      <team>4</team>
      <team>6</team>
      <team>8</team>
    </permission>
    <color>#3498DB</color>
    <icon>fab fa-amazon</icon>
  </menu>
  <addon>
    <database/>
  </addon>
  <css>
    <url>https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css</url>
  </css>
  <script>
    <url>https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js</url>
  </script>
</config>