הפניה לקובץ של תוסף פעולות על נתונים

plugin.xml לדוגמה

דוגמה זו מראה קובץ plugin.xml אופייני לפעולה אחת על נתונים.

1 <?xml version="1.0" encoding="UTF-8"?>
2 <tns:obiplugin xmlns:tns="http://plugin.frameworks.tech.bi.oracle"
3                id="obitech-currencyconversion"
4                name="Oracle BI Currency Conversion"
5                version="0.1.0.@qualifier@"
6                optimizable="true"
7                optimized="false">
8 
9 
10   <tns:resources>
11      <tns:resource id="currencyconversion" path="scripts/currencyconversion.js" type="script" optimizedGroup="base"/>
12      <tns:resource-folder id="nls" path="resources/nls" optimizable="true">
13         <tns:extensions>
14            <tns:extension name="js" resource-type="script"/>
15         </tns:extensions>
16      </tns:resource-folder>
17   </tns:resources>
18  
19 
20   <tns:extensions>
21      <tns:extension id="oracle.bi.tech.currencyconversiondataaction" point-id="oracle.bi.tech.plugin.dataaction" version="1.0.0">
22         <tns:configuration>
23         {
24            "host": { "module": "obitech-currencyconversion/currencyconversion" },
25            "resourceBundle": "obitech-currencyconversion/nls/messages",
26            "properties":
27            {
28               "className": "obitech-currencyconversion/currencyconversion.CurrencyConversionDataAction",
29               "displayName": { "key" : "CURRENCY_CONVERSION", "default" : "Currency Conversion" },
30               "order": 100
31            }
32         }
33         </tns:configuration>
34      </tns:extension>
35   </tns:extensions>
36 
37 </tns:obiplugin>

משאבים

1 <tns:resources>
2    <tns:resource id="currencyconversion" path="scripts/currencyconversion.js" type="script" optimizedGroup="base"/>
3    <tns:resource-folder id="nls" path="resources/nls" optimizable="true">
4       <tns:extensions>
5          <tns:extension name="js" resource-type="script"/>
6       </tns:extensions>
7    </tns:resource-folder>
8 </tns:resources>

עליך לרשום כאן כל קובץ JavaScript, CSS, תמונה ומשאב תרגום. הפרק כלול בתוך הרכיב <tns:resources> ומכיל מספר כלשהו של הרכיבים הבאים:

• <tns:resource>

  רכיבים אלה משמשים לרשום קובץ יחיד (למשל קובץ JavaScript או CSS).

• <tns:resource-folder>

  רכיבים אלה משמשים לרשום בו-זמנית את כל הקבצים תחת תיקייה מוגדרת. לדוגמה, תיקיית תמונות או התיקייה המכילה את קובצי המשאבים בשביל התמיכה בשפה המקומית.

מידע נוסף על איך לרשום כל סוג של קובץ מופיע בפרקים הבאים.

קובצי JavaScript

יש לרשום כל קובץ JavaScript בתוסף שלך עם שורה הדומה לזו המוצגת להלן.

<tns:resource id="currencyconversion" path="scripts/currencyconversion.js" type="script" optimizedGroup="base"/>

כאשר:

• id הוא המזהה שניתן לקובץ..

  הגדר את המזהה כך שיתאים לשם הקובץ של JavaScript בלי הסיומת .js.

• path הוא הנתיב היחסי לקובץ JavaScript מקובץ plugin.xml. קובצי JavaScript יש לאחסן בספרייה תסריטים של התוסף שלך.

  השתמש באותיות קטנות לקובצי JavaScript שלך בלי תווים מיוחדים כמו קו תחתון ומקף.

• type הוא סוג הקובץ שרושמים. הוא צריך להיות מוגדר כתסריט לקובצי JavaScript.
• optimizedGroup מקבץ מספר קובצי JavaScript לקובץ דחוס אחד. תוספי צד שלישי צריכים להשאיר את זה מוגדר כבסיס.

קובצי CSS

יש לרשום כל קובץ CSS בתוסף שלך עם שורה הדומה לזו המוצגת להלן.

<tns:resource id="currencyconversionstyles" path="resources/currencyconversion.css" type="css"/>

כאשר:

• id הוא המזהה שניתן לקובץ..

  הגדר את המזהה כך שיתאים לשם הקובץ של CSS בלי הסיומת .css.

• path הוא הנתיב היחסי לקובץ CSS מקובץ plugin.xml. קובצי CSS יש לאחסן בספרייה משאבים של התוסף שלך.

  השתמש באותיות קטנות לקובצי CSS שלך בלי תווים מיוחדים כמו קו תחתון ומקף.

• type הוא סוג הקובץ שרושמים. הוא צריך להיות מוגדר תמיד כcss לקובצי CSS.

תיקיות תמונות

אם התוסף שלך מכיל תמונות שאליהן אתה צריך לפנות מתוך קוד JavaScript שלך, הצב אותן בספרייה משאבים/תמונות במבנה הספריות של התוסף שלך והוסף רכיב <tns:resource-folder> ל-plugin.xml באופן הבא:

<tns:resource-folder id="images" path="resources/images" optimizable="false"/>

אם רק קובצי ה-CSS שלך מפנים לתמונות שלך, אינך צריך להוסיף רכיב <tns:resource-folder> זה לקובץ plugin.xml שלך. במקרה זה, אתה עדיין צריך להוסיף אותן לספרייה משאבים/תמונות כדי שתוכל לפנות אליהן באמצעות נתיב יחסי מקובץ CSS שלך.

תיקיות משאבים לתמיכה בשפה המקומית

Oracle Analytics מממש תמיכה בשפה המקומית. הדבר דורש ממפתחים להחצין את המחרוזות שהם מציגים בממשק המשתמש שלהם בקובצי משאבי JSON נפרדים. תוכל אז לספק גרסאות מקומיות שונות של קבצים אלה במבנה ספריות מומלץ ו-Oracle Analytics משתמש באופן אוטומטי בקובץ הנכון בשביל השפה שנבחרה על-ידי המשתמש. אתה יכול לספק גרסאות מתורגמות של קובצי המשאבים בכל מספר דרוש. תיקייה של משאבי תמיכה בשפה המקומית מפנה את Oracle Analytics לשורש של מבנה הספריות של התמיכה בשפה המקומית המוגדרת בשימוש התוסף שלך. לכל התוספים המשתמשים בקובצי משאבים של תמיכה בשפה המקומית צריכה להיות רשומה של <tns:resource-folder> הנראית בדיוק כמו הדוגמה הבאה.

1 <tns:resource-folder id="nls" path="resources/nls" optimizable="true">
2    <tns:extensions>
3       <tns:extension name="js" resource-type="script"/>
4    </tns:extensions>
5 </tns:resource-folder>

ראה תיקיות וקבצים שהופקו לפרטים על התוכן של הקבצים ומבנה הספריות המומלץ שעל-פיהם עליך לפעול.

<tns:extension id="oracle.bi.tech.currencyconversiondataaction" point-id="oracle.bi.tech.plugin.dataaction" version="1.0.0">
   <tns:configuration>
   {
      "host": { "module": "obitech-currencyconversion/currencyconversion" },
      "resourceBundle": "obitech-currencyconversion/nls/messages",
      "properties":
      {
         "className": "obitech-currencyconversion/currencyconversion.CurrencyConversionDataAction",
         "displayName": { "key" : "CURRENCY_CONVERSION", "default" : "Currency Conversion" },
         "order": 100
      }
   }
   </tns:configuration>
</tns:extension>

כאשר:

• id הוא המזהה הייחודי שאתה נותן לפעולה על נתונים שלך.
• point-id הוא סוג ההרחבה שאתה רוצה לרשום. להרחבות של פעולות על נתונים, צריך להגדיר אותו כ-oracle.bi.tech.plugin.dataaction.
• version היא גרסת ה-API של ההרחבה בו משתמשת הגדרת ההרחבה שלך (השאר אותה מוגדרת כ-1.0.0).

הרכיב <tns:configuration> מכיל מחרוזת JSON שמגדירה:

• host.module - זהו השם המלא של המודול שמכיל את הפעולה על נתונים שלך. שם מודול מלא זה מנוסח כ-%PluginID%/%ModuleName%, כאשר:
  • את %PluginID% יש להחליף במזהה התוסף שהגדרת בתכונה id של הרכיב <tns:obiplugin>.
  • את %ModuleName% יש להחליף במזהה המשאב שהגדרת בתכונה id של הרכיב <tns:resource> לקובץ JavaScript שמכיל את הפעולה על נתונים שלך.
• resourceBundle - זהו נתיב התמיכה בשפה המקומית אל קובץ המשאבים המכיל את המשאבים המקומיים של פעולה על נתונים זו. אם קובצי המשאבים שלך נקראים messages.js ומאוחסנים נכון במבנה הספרייה המומלץ nls, הגדר מאפיין זה כ- %PluginID%/nls/הודעות (כאשר את %PluginID% יש להחליף במזהה התוסף שהגדרת בתכונה id של רכיב <tns:obiplugin> בראש הקובץ plugin.xml).
• properties.className - זהו שם המחלקה המלא שניתן לפעולה על נתונים שאתה רושם. שם מחלקה מלא זה מנוסח כ-%PluginID%/%ModuleName%.%ClassName%, כאשר:
  • את %PluginID% יש להחליף במזהה התוסף שהגדרת בתכונה id של הרכיב <tns:obiplugin>.
  • את %ModuleName% יש להחליף במזהה המשאב שהגדרת בתכונה id של הרכיב <tns:resource> לקובץ JavaScript שמכיל את הפעולה על נתונים שלך.
  • את %ClassName% יש להחליף בשם שנתת למחלקת הפעולות על נתונים בקובץ JavaScript שלך.
• properties.displayName - מאפיין זה מכיל אובייקט ושני מאפיינים נוספים:
  • key הוא מפתח ההודעה של התמיכה בשפה המקומית בו אפשר להשתמש כדי לחפש את שם התצוגה המקומי של הפעולה על נתונים מתוך ה-resourceBundle המצוין.
  • default הוא ברירת המחדל של שם תצוגה לשימוש במקרה שלא ניתן למצוא את הגרסה המקומית של שם התצוגה.
• properties.order - מאפיין זה מאפשר לתת רמז שמשמש לקבוע את המיקום שבו פעולה על נתונים זו צריכה להופיע כאשר היא מוצגת ברשימה של פעולות על נתונים. פעולות על נתונים עם מספרים נמוכים יותר במאפיין הסדר שלהם מופיעות לפני פעולות על נתונים עם מספרים גבוהים יותר. במקרה של תיקו, הפעולות על נתונים מוצגות בסדר שבו הן הוטענו על-ידי המערכת.