Datenaktions-Plug-ins und Datenaktions-Framework

AbstractDataAction

Diese Klasse ist verantwortlich für:

• Speichern des Knockout-Modells (Unterklassen können dies mit ihren eigenen Eigenschaften erweitern)
• Definieren der abstrakten Methoden, die Unterklassen implementieren müssen:
  • + invoke(oActionContext: ActionContext, oDataActionContext:DataActionContext) <<abstract>>

    Ruft die Datenaktion mit dem übergebenen Kontext auf (darf nur vom DataActionManager aufgerufen werden).

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

    Erstellt die GadgetInfos, die für das Rendern der Benutzeroberflächenfelder zur Bearbeitung dieses Datenaktionstyps verantwortlich sind, und gibt diese zurück.

  • + validate() : DataActionError

    Validiert die Datenaktion und gibt Null zurück, wenn sie gültig ist, oder DataActionError, wenn sie ungültig ist.

• Bereitstellen der Standardimplementierung für die folgenden Methoden, mit denen generische Teile der Benutzeroberflächenfelder für die Datenaktion gerendert werden:
  • + getSettings():JSON

    Serialisiert das Knockout-Modell der Datenaktion als JSON für die Aufnahme in den Bericht (verwendet komapping.toJS(_koModel)).

  • + createNameGadgetInfo(oReport) : AbstractGadgetInfo

    Erstellt die GadgetInfo, die das Feld Name der Datenaktion rendern kann, und gibt diese zurück.

  • + createAnchorToGadgetInfo(oReport) : AbstractGadgetInfo

    Erstellt die GadgetInfo, die das Feld Verankern mit der Datenaktion rendern kann, und gibt diese zurück.

  • + createPassValuesGadgetInfo(oReport) : AbstractGadgetInfo

    Erstellt die GadgetInfo, die das Feld Werte übergeben der Datenaktion rendern kann, und gibt diese zurück.

Unterklassen benötigen möglicherweise nicht alle von der Basisklasse bereitgestellten GadgetInfos und müssen daher nicht unbedingt all diese Methoden aufrufen. Da das Rendering der einzelnen Felder auf diese Weise getrennt ist, können Unterklassen die erforderlichen Gadgets flexibel auswählen. Einige Unterklassen stellen unter Umständen sogar eine andere Implementierung dieser gängigen Datenaktionsgadgets bereit.

CanvasDataAction, URLNavigationDataAction, HTTPAPIDataAction, EventDataAction

Dies sind die konkreten Klassen für die grundlegenden Typen von Datenaktionen. Diese Klassen stellen die generische Benutzeroberfläche für diese Datenaktionstypen bereit. Sie können auch als praktische Basisklassen für die Erweiterung durch benutzerdefinierte Datenaktions-Plug-ins dienen.

• CanvasDataAction: Damit wird zu einer Leinwand navigiert.
• URLNavigationDataAction: Damit wird eine Webseite in einem neuen Browserfenster geöffnet.
• HTTPAPIDataAction: Damit wird eine GET/POST/PUT/DELETE/TRACE-Anforderung an eine HTTP-API gesendet und die HTTP-Antwort programmgesteuert verarbeitet.
• EventDataAction: Damit werden JavaScript-Ereignisse über den Ereignisrouter veröffentlicht.

Jede Klasse ist verantwortlich für:

• Implementieren der abstrakten Methoden aus der Basisklasse
  • invoke(oActionContext: ActionContext, oDataActionContext:DataActionContext)

    Diese Methode sollte die Datenaktion aufrufen, indem die im KOModel definierten Eigenschaften mit dem angegebenen DataActionContext-Objekt kombiniert werden.

  • getGadgetInfos(oReport): AbstractGadgetInfo[]

    Diese Methode sollte:

    • ein Array mit AbstractGadgetInfos erstellen;
    • einzelne createXXXGadgetInfo()-Methoden aufrufen, die die jeweilige AbstractGadgetInfo an das Array übertragen;
    • das Array zurückgeben.
• Bereitstellen der zusätzlichen Methoden zum Erstellen der speziellen Gadgets für die jeweilige Unterklasse der Datenaktion

Unterklassen dieser konkreten Klassen müssen möglicherweise nicht alle von den jeweiligen Superklassen bereitgestellten Gadgets in ihren benutzerdefinierten Benutzeroberflächen verwenden. Da die Erstellung der einzelnen Gadgets auf diese Weise getrennt ist, können Unterklassen die erforderlichen Gadgets flexibel auswählen.

DataActionKOModel, ValuePassingMode

Die DataActionKOModel-Klasse stellt das gemeinsame Basis-KOModel für die verschiedenen Unterklassen von AbstractDataAction bereit. Siehe DataActionKOModel-Klasse.

DataActionManager

.png

Die gesamte Kommunikation mit DataActionManager verwendet ClientEvents.DataActionManager. Dadurch werden Event-Handler für Folgendes implementiert:

• Verwaltung der in der aktuellen Arbeitsmappe definierten Datenaktionen
• Aufruf einer Datenaktion
• Abruf aller in der aktuellen Arbeitsmappe definierten Datenaktionen
• Abruf aller Datenaktionen für die derzeit markierten Datenpunkte

DataActionContext, EnvironmentContext

Beim Aufruf einer Datenaktion enthält die DataActionContext-Klasse den Kontext, der an das Ziel übergeben wird.

• getColumnValueMap()

  Gibt eine Map mit Attributspaltenwerten nach Attributspaltennamen zurück. Diese definieren die qualifizierte Datenreferenz für die Datenpunkte, aus denen die Datenaktion aufgerufen wird.

• getLogicalFilterTrees()

  Gibt ein LogicalFilterTrees-Objekt zurück, das die qualifizierten Datenreferenzen für die jeweiligen Datenpunkte zurückgibt, von denen die Datenaktion aufgerufen wird (Details finden Sie unter InteractionService).

• getEnvironmentContext()

  Eine Instanz der EnvironmentContext-Klasse für eine Beschreibung der Quellumgebung wie:

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

  Gibt den Bericht zurück, aus dem die Datenaktion aufgerufen wird.

DataActionHandler

Die DataActionHandler-Klasse registriert die verschiedenen Datenaktions-Plug-ins. Die zugehörige API ist mehr oder weniger mit anderen Plug-in-Handlern konsistent (z.B. VisualizationHandler).

Die DataActionHandler-Klasse stellt die folgenden öffentlichen Methoden bereit:

• getClassName(sPluginType:String) : String

  Gibt den vollqualifizierten Klassennamen für den angegebenen Datenaktionstyp zurück.

• getDisplayName(sPluginType:String) : String

  Gibt den übersetzten Anzeigenamen für den angegebenen Datenaktionstyp zurück.

• getOrder(sPluginType:String) : Number

  Gibt eine Zahl zurück, mit der die Listen der Datenaktionstypen in der bevorzugten Reihenfolge sortiert werden.

Die DataActionHandler-Klasse stellt die folgenden statischen Methoden bereit:

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

  Gibt eine Abhängigkeitsmap für alle registrierten Datenaktionstypen zurück.

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

  Erstellt eine neue Instanz der DataActionHandler-Klasse und gibt diese zurück.

DataActionUpgradeHandler

Die DataActionUpgradeHandler-Klasse wird beim Öffnen eines Berichts vom UpgradeService aufgerufen.

Die DataActionHandler-Klasse stellt zwei Hauptmethoden bereit:

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

  Gibt einen Promise zurück, der einen booleschen Wert ergibt und angibt, ob die angegebene Datenaktion upgegradet werden muss (true) oder nicht (false). Die Methode entscheidet, ob die Datenaktion upgegradet werden muss. Dazu wird die Datenaktionsinstanz mit dem Konstruktor der Datenaktion verglichen.

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

  Führt das Upgrade für die angegebene Datenaktion durch und löst den Promise auf. Das Upgrade selbst wird durch Aufruf der upgrade()-Methode für die Datenaktion ausgeführt (nur die jeweilige Unterklasse der upzugradenden Datenaktion kann sich selbst upgraden).

• getOrder(sPluginType:String) : Number

  Gibt eine Zahl zurück, mit der die Listen der Datenaktionstypen in der bevorzugten Reihenfolge sortiert werden.

Feld für eine neue Datenaktionsinstanz erstellen

Diese Interaktion beginnt, wenn Oracle Analytics das Benutzeroberflächenfeld für eine Datenaktion rendert. Dazu führt das Programm folgende Aktionen aus:

1. Es erstellt eine PanelGadgetInfo als übergeordnete GadgetInfo für die GadgetInfos, die von der Datenaktion zurückgegeben werden.
2. Es ruft getGadgetInfos() für die Datenaktion auf.
3. Es fügt die GadgetInfos der Datenaktion als untergeordnete Elemente der PanelGadgetInfo hinzu, die im ersten Schritt erstellt wurde.
4. Es erstellt die PanelGadgetView, die die PanelGadgetInfo rendert.
5. Es legt das HTMLElement fest, das als Container der PanelGadgetView dient.
6. Es registriert die PanelGadgetView als untergeordnete HostedComponent einer HostedComponent, die bereits an den HostedComponent-Baum angehängt wurde.

   Dadurch werden die Gadgets der Datenaktion in der Reihenfolge, in der sie in dem von getGadgetInfos() zurückgegebenen Array stehen, im Bereichsgadget angezeigt.

Datenaktion aufrufen

Diese Interaktion beginnt, wenn der Benutzer eine Datenaktion über die Benutzeroberfläche von Oracle Analytics aufruft (z.B. aus dem Kontextmenü für einen Datenpunkt in einer Visualisierung).

Der Code führt folgende Aktionen aufgrund der Benutzerinteraktion auf:

1. Veröffentlicht ein INVOKE_DATA_ACTION-Ereignis mit der ID der Datenaktion, der DataVisualization, aus der die Datenaktion aufgerufen wurde, und einem TransientVizContext-Objekt.
2. Der DataActionManager verarbeitet dieses Ereignis wie folgt:
   1. Abrufen der Datenaktionsinstanz anhand ihrer ID.
   2. Abrufen der LogicalFilterTrees für die markierten Datenpunkte in der angegebenen DataVisualization.
   3. Erstellen eines DataActionContext mit allen Informationen zum Übergeben an das Datenaktionsziel.
   4. Aufrufen von invoke(oDataActionContext) für die Datenaktion.

Beispiel für 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>