Veri Eylemi Eklentileri ve Veri Eylemleri Altyapısı Hakkında

AbstractDataAction

Bu sınıfın sorumlulukları:

• Knockout Modelini depolamak (alt sınıflar bunu kendi nitelikleri ile genişletebilir).
• Alt sınıfların uygulaması gereken soyut yöntemleri tanımlamak:
  • + invoke(oActionContext: ActionContext, oDataActionContext:DataActionContext) <<abstract>>

    Veri eylemini iletilen bağlamla çağırır. Sadece DataActionManager tarafından çağrılmalıdır.

  • + getGadgetInfos(oReport): AbstractGadgetInfo[] <<abstract>>

    Bu veri eylemi tipini düzenlemek için kullanıcı arayüzü alanlarını göstermekten sorumlu GadgetInfos öğesini yapılandırır ve döndürür.

  • + validate() : DataActionError

    Veri eylemini değerlendirir ve geçerliyse boş veya geçersizse DataActionError döndürür.

• Veri eylemi kullanıcı arayüzü alanlarının genel bölümlerini göstermek üzere kullanılan aşağıdaki yöntemler için uygulama öndeğerini sağlamak:
  • + getSettings():JSON

    Veri eyleminin Knockout Modelini, rapora dahil edilmeye hazır JSON'a serileştirir (komapping.toJS(_koModel) kullanır).

  • + createNameGadgetInfo(oReport) : AbstractGadgetInfo

    Veri eyleminin Ad alanını gösterebilen GadgetInfo öğesini yapılandırır ve döndürür.

  • + createAnchorToGadgetInfo(oReport) : AbstractGadgetInfo

    Veri eyleminin Tutturma Hedefi alanını gösterebilen GadgetInfo öğesini yapılandırır ve döndürür.

  • + createPassValuesGadgetInfo(oReport) : AbstractGadgetInfo

    Veri eyleminin Değerleri İlet alanını gösterebilen GadgetInfo öğesini yapılandırır ve döndürür.

Alt sınıflar için temel sınıfın sağladığı tüm GadgetInfo'lar gerekli olmayabilir, dolasıyla alt sınıfların bu yöntemlerin tümünü çağırması gerekmeyebilir. Her alanın görüntülenmesini bu yöntemle ayırarak, alt sınıflar ihtiyaçları olan gadget'ları toplamakta ve seçmekte özgürdür. Bazı alt sınıflar, bu yaygın veri eylemi gadget'larının farklı bir uygulamasını sağlamayı da seçebilir.

CanvasDataAction, URLNavigationDataAction, HTTPAPIDataAction, EventDataAction

Bunlar, temel veri eylemi tipleri için somut sınıflardır. Bu sınıflar, bu veri eylemi tiplerine yönelik genel kullanıcı arayüzünü sağlamak için kendi kendilerine çalışır. Özel veri eylemi eklentilerinin genişlemesi için uygun temel sınıflar olarak da işlev görebilirler.

• CanvasDataAction: Bir fona gitmek için kullanılır.
• URLNavigationDataAction: Bir web sayfasını yeni tarayıcı penceresinde açmak için kullanılır.
• HTTPAPIDataAction: Bir HTTP Uygulama Programı Arabirimine GET/POST/PUT/DELETE/TRACE isteğinde bulunmak ve HTTP Yanıtı'nı programlı olarak işlemek için kullanılır.
• EventDataAction: JavaScript olaylarını Olay Yönlendiricisi aracılığıyla yayımlamak için kullanılır.

Her bir sınıf şunlardan sorumludur:

• Temel sınıftan soyut yöntemleri uygulamak.
  • invoke(oActionContext: ActionContext, oDataActionContext:DataActionContext)

    Bu yöntem KOModel'de tanımlı nitelikleri, belirtilen DataActionContext nesnesi ile birleştirerek veri eylemini çağırmalıdır.

  • getGadgetInfos(oReport): AbstractGadgetInfo[]

    Bu yöntemin yapması gerekenler:

    • AbstractGadgetInfos içeren bir dizi oluşturmak.
    • Her AbstractGadgetInfo'yu diziye iterek bireysel createXXXGadgetInfo() yöntemleri çağırmak.
    • Diziyi döndürmek.
• Belirli veri eylemi alt sınıfına özel bireysel gadget'lar oluşturmak için ek yöntemler sağlamak.

Bu somut sınıfların alt sınıflarının, özel kullanıcı arayüzlerinde üst sınıfları tarafından sağlanan tüm gadget'ları kullanmaları gerekmeyebilir. Her gadget'ın yapılandırmasını bu yöntemle ayırarak, alt sınıflar ihtiyaçları olan gadget'ları toplamakta ve seçmekte özgürdür.

DataActionKOModel, ValuePassingMode

DataActionKOModel sınıfı, farklı AbstractDataAction alt sınıfları tarafından paylaşılan temel KOModel'i sağlar. Bkz. DataActionKOModel Sınıfı.

DataActionManager

.png'' çiziminin açıklaması

DataActionManager ile kurulan tüm iletişimler, şunlar için olay işleyicilerini uygulayan ClientEvents.DataActionManager'ı kullanır:

• Geçerli çalışma kitabında tanımlı veri eylemi grubunu yönetmek.
• Veri eylemi çağırmak.
• Geçerli çalışma kitabında tanımlı tüm veri eylemlerini almak.
• Geçerli işaretlenmiş veri noktalarına uygulanabilen tüm veri eylemlerini almak.

DataActionContext, EnvironmentContext

Bir veri eylemi çağrıldığında, DataActionContext sınıfı hedefe iletilen bağlamı içerir.

• getColumnValueMap()

  Özellik sütunu adlarına göre bağlanan özellik sütunu değerlerinin eşlemesini döndürür. Bunlar, veri eyleminin çağrıldığı veri noktalarına yönelik nitelenen veri referansını tanımlar.

• getLogicalFilterTrees()

  Veri eyleminin çağrıldığı belirli veri noktalarına yönelik nitelenen veri referanslarını açıklayan LogicalFilterTrees nesnesini döndürür (detaylar için bkz. InteractionService).

• getEnvironmentContext()

  Kaynak ortamı açıklayan EnvironmentContext sınıfının bir anı, örneğin:

  • getProjectPath()
  • getCanvasName()
  • getUserID()
  • getUserName()
• getReport()

  Veri eyleminin çağrıldığı raporu döndürür.

DataActionHandler

DataActionHandler sınıfı çeşitli veri eylemi eklentilerini kaydeder. Bunun uygulama programı arabirimi, diğer eklenti işleyicileriyle tutarlıdır (örneğin, VisualizationHandler).

DataActionHandler sınıfı şu genel yöntemleri sağlar:

• getClassName(sPluginType:String) : String

  Belirtilen veri eylemi tipi için tam nitelenmiş sınıf adını döndürür.

• getDisplayName(sPluginType:String) : String

  Belirtilen veri eylemi tipi için çevrilen görünen adı döndürür.

• getOrder(sPluginType:String) : Number

  Veri eylemi tiplerinin listelerini tercih edilen düzende sıralamak için kullanılan bir sayı döndürür.

DataActionHandler sınıfı şu statik yöntemleri sağlar:

• getDependencies(oPluginRegistry:Object) : Object.<String, Array>

  Tüm kayıtlı veri eylemi tiplerini kapsayan bir bağımlılık eşlemesi döndürür.

• getHandler(oPluginRegistry:Object, sExtensionPointName:String, oConfig:Object) : DataActionPluginHandler

  DataActionHandler sınıfının yeni bir anını yapılandırır ve döndürür.

DataActionUpgradeHandler

DataActionUpgradeHandler sınıfı bir rapor açıldığında UpgradeService tarafından çağrılır.

DataActionHandler sınıfı iki ana yöntem sağlar:

• deferredNeedsUpgrade(sCurrentVersion, sUpgradeTopic, oDataActionJS, oActionContext) : Promise

  Belirtilen veri eyleminin yükseltilmesinin gerekli olup (true) olmadığını (false) belirten bir Mantıksal değere çözümlenen bir Promise döndürür. Yöntem, veri eylemi anını veri eyleminin yapılandırıcısı ile karşılaştırarak, veri eyleminin yükseltilmesinin gerekli olup olmadığına karar verir.

• performUpgrade(sCurrentVersion, sUpgradeTopic, oDataActionJS, oActionContext, oUpgradeContext) : Promise

  Belirtilen veri eyleminde yükseltmeyi gerçekleştirir ve Promise'i çözümler. Yükseltme, veri eyleminde upgrade() yöntemi çağrılarak gerçekleştirilir (sadece yükseltilen belirli veri eylemi alt sınıfı kendisini yükseltmeye uygundur).

• getOrder(sPluginType:String) : Number

  Veri eylemi tiplerinin listelerini tercih edilen düzende sıralamak için kullanılan bir sayı döndürür.

Yeni Veri Eylemi Anı Alanını Oluşturma

Bu etkileşim, Oracle Analitik bir veri eylemi kullanıcı arayüzü alanını göstermek istediğinde başlar. Bunu yapmak için:

1. Veri eyleminin döndürdüğü GadgetInfos için üst GadgetInfo işlevi gören bir PanelGadgetInfo oluşturur.
2. Veri eyleminde getGadgetInfos()'u çağırır.
3. Veri eyleminin GadgetInfos'larını ilk adımda oluşturulan PanelGadgetInfo'nun alt öğeleri olarak ekler.
4. PanelGadgetInfo'yu gösteren PanelGadgetView'ı oluşturur.
5. PanelGadgetView'ın kapsayıcısı olan HTMLElement'i ayarlar.
6. PanelGadgetView'ı, HostedComponent ağacına ekli olan bir HostedComponent'ın alt HostedComponent'ı olarak kaydeder.

   Bu, veri eyleminin gadget'larını Panel gadget'ında getGadgetInfos() tarafından döndürülen dizide göründükleri sırada gösterir.

Veri Eylemi Çağırma

Bu etkileşim, kullanıcı Oracle Analitik kullanıcı arayüzü üzerinden bir veri eylemi çağırdığında başlar (örneğin, görselleştirmedeki bir veri noktasındaki bağlam menüsünden).

Kullanıcı etkileşimine yanıt olarak kod:

1. Veri eylemi no'yu, veri eyleminin çağrıldığı DataVisualization'ı ve bir TransientVizContext nesnesi içeren bir INVOKE_DATA_ACTION olayı yayımlar.
2. DataActionManager bu olayı şu şekilde işler:
   1. Veri eylemi anını no'sundan edinerek.
   2. Belirtilen DataVisualization'da işaretli veri noktaları için LogicalFilterTrees'i edinerek.
   3. Veri eyleminin hedefine iletilen tüm bilgileri içeren bir DataActionContext yapılandırarak.
   4. Veri eyleminde invoke(oDataActionContext) çağırarak.

Örnek plugin.xml

<?xml version="1.0" encoding="UTF-8"?>
<tns:obiplugin xmlns:tns="http://plugin.frameworks.tech.bi.oracle"
               xmlns:viz="http://plugin.frameworks.tech.bi.oracle/extension-points/visualization"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               id="obitech-currencyconversion"
               name="Oracle BI Currency Conversion"
               version="0.1.0.@qualifier@"
               optimizable="true"
               optimized="false">
 
 
   <tns:resources>
      <tns:resource id="currencyconversion" path="scripts/currencyconversion.js" type="script" optimizedGroup="base"/>
      <tns:resource-folder id="nls" path="resources/nls" optimizable="true">
         <tns:extensions>
            <tns:extension name="js" resource-type="script"/>
         </tns:extensions>
      </tns:resource-folder>
   </tns:resources>
 
 
   <tns:extensions>
      <tns:extension id="oracle.bi.tech.currencyconversiondataaction" point-id="oracle.bi.tech.plugin.dataaction" version="1.0.0">
         <tns:configuration>
         {
            "resourceBundle": "obitech-currencyconversion/nls/messages",
            "properties":
            {
               "className": "obitech-currencyconversion/currencyconversion.CurrencyConversionDataAction",
               "displayName": { "key" : "CURRENCY_CONVERSION", "default" : "Currency Conversion" },
               "order": 100
            }
         }
         </tns:configuration>
      </tns:extension>
   </tns:extensions>
 
 
</tns:obiplugin>