Laufzeit-Substitutionsvariablen in Berechnungsskripten, die in Smart View ausgeführt werden

Laufzeit-Substitutionsvariablen in Berechnungsskripten werden in Smart View ausgeführt

Sie können Laufzeitsubstitutionsvariablen (RTSVs) in Essbase-Berechnungsskripten verwenden, die Sie für die Ausführung in Smart View entwerfen. Mit den RTSVs kann der Fokusbereich der Berechnung je nach aktivem Rasterkontext (POV) dynamisch sein.

Um ein Berechnungsskript zu verwenden, das Laufzeitsubstitutionsvariablen in Smart View enthält, muss die Laufzeitsubstitutionsvariablendeklaration im Berechnungsbefehl SET RUNTIMESUBVARS das Tag <RTSV_HINT> enthalten. Darüber hinaus muss das Tag <RTSV_HINT> das Tag <svLaunch> enthalten. In der Regel enthält das Tag <svLaunch> zusätzliche XML-Tags, die Metadaten zur Ausführung des Berechnungsskripts in Smart View bereitstellen.

Verwenden Sie die folgende Syntax, um eine Laufzeitsubstitutionsvariablendefinition für die Verwendung in Smart View zu definieren:

SET RUNTIMESUBVARS
{
   rtsvName = POV
   <RTSV_HINT>
      <svLaunch>
         <description>rtsv_description</description>
         <type>member | string | number</type>
         <dimension>dimName</dimension>
         <choice>single | multiple</choice>
         <allowMissing>true | false</allowMissing>
      </svLaunch>
   </RTSV_HINT>
};

In der obigen Definition lautet der Name der Laufzeitsubstitutionsvariablen rtsvName. Sie können jedoch einen beliebigen Namen verwenden. Der Wert der Variablen muss auf POV gesetzt werden, um anzugeben, dass nur das aktuelle Datensegment im Tabellenraster berechnet werden soll.

Das Element <RTSV_HINT> muss auch Teil der Variablendeklaration sein. Der Inhalt umfasst:

<description>: Ein Deskriptor, mit dem Smart View-Benutzer die Elementauswahl verstehen können
<type>: Eine Angabe, ob die Variable für ein Element, eine Zeichenfolge oder eine Zahl gilt
<allowMissing>: true, wenn fehlende Daten eingeschlossen werden sollen; andernfalls false
<dimension>: Der Name der Dimension, aus der diese Variable Informationen abruft
<choice>: single, wenn nur eine Auswahl an die Laufzeitsubstitutionsvariable übergeben werden kann. Andernfalls multiple.

Eine vollständige Beschreibung der oben aufgeführten XML-Tags finden Sie unter XML-Tagreferenz – Berechnungsskripte mit Laufzeitsubstitutionsvariablen für Smart View.

Wenn Sie in Smart View ein Berechnungsskript auswählen, das Laufzeitsubstitutionsvariablen im Dialogfeld Berechnungsskripte enthält, wird der Bereich Laufzeit-Prompts mit Feldern aufgefüllt, die darauf basieren, wie die Laufzeitsubstitutionsvariablen im Berechnungsbefehl SET RUNTIMESUBVARS definiert werden. Sie können das Berechnungsskript wie definiert ausführen oder mithilfe der Runtime Prompts verschiedene Variablendaten basierend auf dem Datentyp eingeben.

Hinweis:

In Smart View können Sie kein Berechnungsskript ausführen, das Laufzeitsubstitutionsvariablen enthält, wenn der Befehl SET RUNTIMESUBVARS die <RTSV_HINT><svLaunch>...</svLaunch></RTSV_HINT>-Tags nicht enthält.

Beispiel: Laufzeitsubstitutionsvariable auf POV gesetzt

Um die Laufzeitsubstitutionsvariable eines Essbase-Berechnungsskripts auf den aktiven Smart View-Rasterkontext (POV) zu setzen, muss der Wert der Laufzeitsubstitutionsvariable auf POV und der Datentyp auf member gesetzt sein, wie in diesem Beispiel gezeigt.

Standardmäßig verwendet das Berechnungsskript das aktive Element im POV zur Laufzeit, es sei denn, der Smart View-Benutzer gibt ein anderes Element in der Runtime Prompt an.

In diesem Beispiel wird davon ausgegangen, dass die Datenbank über die folgenden Dimensionen verfügt: Account, Entity, Period und Scenario. Drei Laufzeit-Substitutionsvariablen werden definiert (benannt rtsvEntity, rtsvScenario und rtsvPeriod), und der Wert für jede Variable wird auf POV gesetzt. Die Laufzeitsubstitutionsvariablen werden in der FIX-Anweisung als &rtsvEntity, &rtsvScenario und &rtsvPeriod referenziert.

SET RUNTIMESUBVARS {
   rtsvEntity = POV
      <RTSV_HINT>
         <svLaunch>
            <description>Entities to Copy</description>
            <type>member</type>
            <dimension>Entity</dimension>
            <allowMissing>false</allowMissing>
            <choice>multiple</choice>
         </svLaunch>
      </RTSV_HINT>;
   rtsvScenario = POV
      <RTSV_HINT>
         <svLaunch>
            <description>Scenarios to Copy</description>
            <type>member</type> 
            <allowMissing>false</allowMissing>
            <dimension>Scenario</dimension>
            <choice>multiple</choice>
         </svLaunch>
      </RTSV_HINT>;
   rtsvPeriod   = POV
      <RTSV_HINT>
         <svLaunch>
            <description>Period to Copy</description>
            <type>member</type>
            <allowMissing>false</allowMissing>
            <dimension>Period</dimension>
            <choice>single</choice>
         </svLaunch>
      </RTSV_HINT>;
}
FIX(&rtsvEntity, &rtsvScenario, &rtsvPeriod)
"Opening Balance" (
@PREV("Closing Balance");
)

Unter den Variablendeklarationen befindet sich ein FIX-Block, der den Fokusbereich der Berechnung auswählt und einen Befehl ausführt, um den Anfangssaldo der Periode festzulegen. Die Laufzeitsubstitutionsvariablen werden mit der folgenden Syntax an den FIX-Block übergeben: &varname. Der Schwerpunktbereich der Berechnung ist daher dynamisch, je nach POV in Smart View.

Hinweis:

Wenn Sie die Essbase-Jobs-Schnittstelle, die MaxL-Anweisung execute Calculation oder APIs (wie der REST-API-Endpunkt Execute Jobs) verwenden, können Sie kein Berechnungsskript ausführen, das eine Laufzeitsubstitutionsvariable enthält, die auf POV gesetzt ist. Da diese vom aktuellen Smart View-Rasterkontext abhängig sind, müssen sie in Smart View ausgeführt werden.

XML-Tagreferenz – Berechnungsskripte mit Laufzeitsubstitutionsvariablen für Smart View

Wenn Sie Essbase-Berechnungsskripte mit Laufzeitsubstitutionsvariablen entwerfen, die auf Basis des POV-/Rasterkontextes von Smart View ausgeführt werden sollen, müssen Sie einige XML-Tags verwenden, die hier erläutert werden.

<RTSV_HINT>

Erforderliches Tag zum Definieren von Laufzeitsubstitutionsvariablen für die Verwendung in Smart View.
<svLaunch>

Erforderliches Tag, das angibt, dass die Laufzeitsubstitutionsvariable für die Verwendung in Smart View definiert ist.

Dieses Tag ist das übergeordnete Tag für die folgenden Tags: <description>, <type>, <dimension>, <choice> und <allowMissing>.
<description>rtsv_description</description>

rtsv_description ist eine Zeichenfolge, die die Laufzeitsubstitutionsvariable beschreibt. Die Zeichenfolge wird in der Berechnung nicht verwendet.
<type>value</type>

Gültige Datentypwerte sind:
- Element – Der Wert der Laufzeitersetzungsvariablen muss als Element (ein einzelner Elementname oder eine kommagetrennte Liste von Elementnamen) oder POV definiert sein.
  
  Hinweis:
  
  Elementnamen müssen in Anführungszeichen gesetzt werden. Beispiel: "New York" (einzelnes Element) oder "New York","Florida" (eine durch Komma getrennte Liste mit Elementnamen).
  
  Wenn der Wert der Laufzeitsubstitutionsvariable auf POV gesetzt ist, muss der Wert <type> ein Element sein. Siehe auch das Tag <choice>.
  
  Wenn Sie Essbase-Jobs oder MaxL verwenden, können Sie kein Berechnungsskript ausführen, das eine Laufzeitersetzungsvariable enthält, die auf den POV gesetzt ist. Diese Berechnungsskripte sollen aus Smart View ausgeführt werden, da der POV vom aktuellen Rasterkontext abhängig ist, um das Segment zu bestimmen.
- string (Zeichenfolge) – Der Wert der Laufzeitsubstitutionsvariablen kann als ein einzelner Elementname, eine durch Komma getrennte Liste mit Elementnamen (z.B. "New York", "Florida") oder ein Datum definiert werden.
  
  Wenn Sie den Datentyp "Zeichenfolge" verwenden, ist das Dialogfeld Elementauswahl nicht verfügbar. Daher muss der Smart View-Benutzer die korrekte Syntax verwenden (ein Elementname wird in Anführungszeichen eingeschlossen). Mehrere Elementnamen durch ein Komma trennen oder bei einem Datum das Format der Datumszeichenfolge mit dem Format abgleichen, das im Berechnungsskript definiert ist – mm-dd-yyyy oder dd-mm-yyyy).
- number (Zahl) – Der Laufzeitsubstitutionsvariablenwert muss als Zahl definiert sein
<dimension>dimName</dimension>

Name der Dimension.

Hinweis:

Dieses XML-Tag wird nur unterstützt, wenn der Wert <type> ein Element ist.
<choice>value</choice>

Gültige Werte sind:
- single:
  - Wenn ein einzelnes Element im Raster oder POV vorhanden ist, wird dieses Element verwendet.
  - Wenn sich eine Dimension im POV befindet, wird das aktive Element verwendet.
  - Wenn sich eine Dimension im POV befindet und mehrere Elemente vorhanden sind, tritt ein Fehler auf.
- multiple (mehrere) – Alle Dimensionselemente im Raster oder POV werden verwendet.
Hinweis:

Dieses XML-Tag wird nur unterstützt, wenn der Wert <type> ein Element ist.
<allowMissing>boolean</allowMissing>

Gibt an, ob Datenzellen zugelassen oder unterdrückt werden sollen, für die keine Daten in der Datenbank vorhanden sind.

Gültige Wert: "true" und "false".