Reference pro soubory modulů plugin akcí s daty

Příklad souboru plugin.xml

Tento příklad ukazuje typický soubor plugin.xml pro jednu akci s daty.

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>

Zdroje

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>

Zde je nutné registrovat všechny soubory JavaScript , CSS, obrázků a zdrojového textu pro překlad. Tato část je obsažena v prvku <tns:resources> a obsahuje libovolný počet následujících prvků:

• <tns:resource>

  Tyto prvky se používají k registraci jednoho souboru (například souboru JavaScript nebo CSS).

• <tns:resource-folder>

  Tyto prvky se používají k současné registraci všech souborů v zadané složce. Může se například jednat o složku s obrázky nebo složku obsahující zdrojové soubory pro podporu mateřského jazyka.

Další informace o postupu registrace jednotlivých typů souborů jsou uvedeny v následujících částech.

Soubory JavaScript

Každý soubor JavaScript v modulu plugin musí být registrován prostřednictvím řádky, která je podobná níže uvedené řádce.

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

Kde:

• id je identifikátor přiřazený souboru.

  Nastavte identifikátor tak, aby odpovídal názvu souboru JavaScript bez přípony .js.

• path je relativní cesta k souboru JavaScript ze souboru plugin.xml. Soubory JavaScript by měly být uloženy v adresáři scripts modulu plugin.

  Pro soubory JavaScript můžete používat všechna malá písmena bez speciálních znaků (například podtržítko, spojovník).

• type je typ registrovaného souboru. Pro soubory JavaScript musí být nastaven typ script.
• optimizedGroup seskupuje více souborů JavaScript do jednoho komprimovaného souboru. Pro moduly plugin třetích stran je nutné ponechat nastavenou hodnotu base.

Soubory CSS

Každý soubor CSS v modulu plugin musí být registrován prostřednictvím řádky, která je podobná níže uvedené řádce.

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

Kde:

• id je identifikátor přiřazený souboru.

  Nastavte identifikátor tak, aby odpovídal názvu souboru CSS bez přípony .css.

• path je relativní cesta k souboru CSS ze souboru plugin.xml. Soubory CSS by měly být uloženy v adresáři resources modulu plugin.

  Pro soubory CSS můžete používat všechna malá písmena bez speciálních znaků (například podtržítko, spojovník).

• type je typ registrovaného souboru. Pro soubory CSS by měl být vždy nastaven typ css.

Složky obrázků

Pokud modul plugin obsahuje obrázky, na které je nutné odkazovat z kódu JavaScript, pak je vložte do adresáře resources/images v adresářové struktuře modulu plugin a následně přidejte prvek <tns:resource-folder> do souboru plugin.xml:

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

Pokud na obrázky odkazují pouze vaše soubory CSS, není nutné přidávat tento prvek <tns:resource-folder> do souboru plugin.xml. V tomto případě je však stále musíte přidat do adresáře resources/images, abyste na ně mohli odkazovat pomocí relativní cesty ze souboru CSS.

Složky zdrojů pro podporu mateřského jazyka

Služba Oracle Analytics implementuje podporu mateřského jazyka. To vyžaduje, aby vývojáři externalizovali řetězce, které se zobrazují v jejich uživatelském rozhraní, do samostatných zdrojových souborů JSON. Poté můžete poskytnout různé lokalizované verze těchto souborů v předepsané struktuře adresářů a služba Oracle Analytics automaticky použije správný soubor pro zvolený jazyk uživatele. Můžete poskytnout tolik přeložených verzí zdrojových souborů, kolik jich potřebujete. Zdrojová složka podpory mateřského jazyka nasměruje službu Oracle Analytics do kořenové složky předepsané struktury adresářů podpory mateřského jazyka používané modulem plugin. Všechny moduly plugin, které používají zdrojové soubory podpory mateřského jazyka, musí mít položku <tns:resource-folder>, která vypadá přesně jako níže uvedený příklad.

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>

Podrobnosti o obsahu souborů a předepsané struktuře adresářů, kterou byste měli dodržovat, najdete v tématu Generované složky a soubory.

<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>

Kde:

• id je jedinečný identifikátor, který přiřadíte akci s daty.
• point-id je typ rozšíření, které chcete registrovat. U rozšíření akcí s daty je tento údaj nutné nastavit na hodnotu oracle.bi.tech.plugin.dataaction.
• version je verze rozhraní API rozšíření, kterou definice rozšíření používá (ponechejte nastavenou verzi 1.0.0).

Prvek <tns:configuration> obsahuje řetězec JSON, který definuje:

• host.module - Jedná se o plně kvalifikovaný název modulu obsahujícího akci s daty. Tento plně kvalifikovaný název modulu má tvar %ID_pluginu%/%Název_modulu%, kde:
  • Část %ID_pluginu% musí být nahrazena identifikátorem modulu plugin, který je zadán v atributu id elementu <tns:obiplugin>.
  • %Název_modulu% musí být nahrazen identifikátorem zdroje, zadaným v atributu id elementu <tns:resource> pro soubor JavaScriptu obsahující akci s daty.
• resourceBundle - Jedná se o cestu podpory mateřského jazyka ke zdrojovému souboru, který obsahuje lokalizované zdroje této akce s daty. Pokud mají vaše zdrojové soubory přiřazen název messages.js a jsou správně uloženy v předepsané struktuře adresářů nls, pak nastavte tuto vlastnost na %PluginID%/nls/messages (kde %PluginID% je nutné nahradit za identifikátor modulu plugin, který jste zadali prostřednictvím atributu id prvku <tns:obiplugin> na začátku souboru plugin.xml).
• properties.className - Jedná se o plně kvalifikovaný název třídy přiřazený akci s daty, kterou právě registrujete. Tento plně kvalifikovaný název má tvar %ID_pluginu%/%Název_modulu%.%Název_třídy%, kde:
  • Část %ID_pluginu% musí být nahrazena identifikátorem modulu plugin, který je zadán v atributu id elementu <tns:obiplugin>.
  • %Název_modulu% musí být nahrazen identifikátorem zdroje, zadaným v atributu id elementu <tns:resource> pro soubor JavaScriptu obsahující akci s daty.
  • %Název_třídy% musí být nahrazen názvem třídy akce s daty, zadaným v souboru JavaScriptu.
• properties.displayName - Tato vlastnost obsahuje objekt a dvě další vlastnosti:
  • key je klíč zprávy podpory mateřského jazyka, který lze použít k vyhledání lokalizovaného zobrazovaného názvu akce s daty v cestě zadané prostřednictvím vlastnosti resourceBundle.
  • default je výchozí zobrazovaný název, který se použije, pokud nelze z nějakého důvodu najít lokalizovanou verzi zobrazovaného názvu.
• properties.order - Tato vlastnost vám umožňuje zadat nápovědu použitou k určení pozice, na které se akce s daty objeví v seznamu všech akcí. Akce s daty s nižšími číselnými hodnotami vlastnosti order se objeví před akcemi s daty, které mají přiřazeny vyšší hodnoty. Při rovnosti hodnot se akce s daty zobrazí v pořadí, v němž jsou načteny systémem.