Variables de substitution d'exécution dans des scripts de calcul exécutés dans Smart View

Vous pouvez utiliser des variables de substitution d'exécution (RTSV) dans les scripts de calcul Essbase que vous concevez pour exécution dans Smart View. Les RTSV permettent à la région d'attention du calcul d'être dynamique, en fonction du contexte de grille actif (PDV).

Pour utiliser un script de calcul qui inclut des variables de substitution d'exécution dans Smart View, la déclaration de variable de substitution d'exécution dans la commande de calcul SET RUNTIMESUBVARS doit inclure la balise <RTSV_HINT>. En outre, la balise <RTSV_HINT> doit inclure la balise <svLaunch>. En général, la balise <svLaunch> inclut des balises XML supplémentaires qui fournissent des métadonnées pour l'exécution du script de calcul dans Smart View.

Utilisez la syntaxe suivante pour définir une définition de variable de substitution d'exécution à utiliser dans Smart View :

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

Dans la définition ci-dessus, le nom de la variable de substitution d'exécution est rtsvName, mais vous pouvez utiliser n'importe quel nom. La valeur de la variable doit être définie sur POV, pour indiquer que seule la tranche de données actuelle présente dans la grille de feuille de calcul doit être calculée.

L'élément <RTSV_HINT> doit également faire partie de la déclaration de variable. Son contenu comprend :

<description> : descripteur permettant aux utilisateurs de Smart View de comprendre la sélection de membres.
<type> : spécification indiquant si la variable concerne un membre, une chaîne ou un nombre.
<allowMissing> : true si les données manquantes doivent être incluses ; false sinon
<dimension> : nom de la dimension à partir de laquelle cette variable extrait des informations
<choice> : single si une seule sélection peut être transmise à la variable de substitution d'exécution ; sinon, multiple.

Pour obtenir une description complète des balises XML répertoriées ci-dessus, reportez-vous à Référence de balise XML : scripts de calcul avec variables de substitution d'exécution pour Smart View.

Dans Smart View, lorsque vous sélectionnez un script de calcul qui inclut des variables de substitution d'exécution dans la boîte de dialogue Scripts de calcul, la zone Invites d'exécution est remplie de champs en fonction de la façon dont les variables de substitution d'exécution sont définies dans la commande de calcul SET RUNTIMESUBVARS. Vous pouvez exécuter le script de calcul tel que défini ou utiliser les invites d'exécution pour saisir différentes informations de variable en fonction du type de données.

Remarques :

Dans Smart View, vous ne pouvez pas exécuter de script de calcul incluant des variables de substitution d'exécution si la commande SET RUNTIMESUBVARS n'inclut pas les balises <RTSV_HINT><svLaunch>...</svLaunch></RTSV_HINT>.

Exemple : jeu de variables de substitution d'exécution sur PDV

Pour définir la variable de substitution d'exécution d'un script de calcul Essbase sur le contexte de grille actif Smart View, la valeur de la variable de substitution d'exécution doit être définie sur POV et le type de données doit être défini sur member, comme illustré dans cet exemple.

Par défaut, le script de calcul utilise le membre actif dans le PDV lors de l'exécution, sauf si l'utilisateur Smart View indique un autre membre dans l'invite d'exécution.

Dans cet exemple, supposons que la base de données comporte les dimensions suivantes : Compte, Entité, Période et Scénario. Trois variables de substitution d'exécution sont définies (nomées rtsvEntity, rtsvScenario et rtsvPeriod), et la valeur de chaque variable est définie sur PDV. Les variables de substitution d'exécution sont référencées dans l'instruction FIX en tant que &rtsvEntity, &rtsvScenario et &rtsvPeriod.

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");
)

Sous les déclarations de variable se trouve un bloc FIX, qui sélectionne la zone d'attention du calcul et exécute une commande pour définir le solde d'ouverture de la période. Les variables de substitution d'exécution sont transmises au bloc FIX en utilisant la syntaxe suivante : &varname. Par conséquent, la région d'attention du calcul est dynamique en fonction du PDV dans Smart View.

Remarques :

Lorsque vous utilisez l'interface Jobs Essbase, l'instruction MaxL de calcul d'exécution ou les API (telles que l'adresse Exécuter les travaux de l'API REST), vous ne pouvez pas exécuter de script de calcul incluant une variable de substitution d'exécution définie sur PDV. Comme elles dépendent du contexte de grille Smart View en cours, elles doivent être exécutées à partir de Smart View.

Référence de balise XML : scripts de calcul avec variables de substitution d'exécution pour Smart View

Lorsque vous concevez des scripts de calcul Essbase avec des variables de substitution d'exécution conçues pour s'exécuter en fonction du contexte PDV/grille Smart View, vous devez utiliser des balises XML qui sont expliquées ici.

<RTSV_HINT>

Balise requise pour définir les variables de substitution d'exécution à utiliser dans Smart View.
<svLaunch>

Balise requise indiquant que la variable de substitution d'exécution est définie pour être utilisée dans Smart View.

Cette balise est la balise parent de ces balises : <description>, <type>, <dimension>, <choice> et <allowMissing>.
<description>rtsv_description</description>

rtsv_description est une chaîne qui décrit la variable de substitution d'exécution. La chaîne n'est pas utilisée dans le calcul.
<type>value</type>

Les valeurs de type de données valides sont les suivantes :
- member : la valeur de la variable de substitution d'exécution doit être définie en tant que membre (nom de membre unique ou liste de noms de membre séparés par des virgules) ou PDV.
  
  Remarques :
  
  Les noms de membre doivent être placés entre guillemets ; par exemple, "New York" (membre unique) ou "New York","Florida" (liste de noms de membre séparés par des virgules).
  
  Si la valeur de la variable de substitution d'exécution est définie sur PDV, la valeur <type> doit être membre. Consultez également la balise <choice>.
  
  A l'aide de travaux Essbase ou de MaxL, vous ne pouvez pas exécuter de script de calcul incluant une variable de substitution d'exécution définie sur le PDV. Ces scripts de calcul sont destinés à être exécutés à partir de Smart View, car le PDV dépend du contexte de grille en cours pour déterminer la tranche.
- string : la valeur de la variable de substitution d'exécution peut être définie comme un nom de membre unique, une liste de noms de membre séparés par des virgules (par exemple, "New York", "Florida") ou une date.
  
  Lorsque vous utilisez le type de données de chaîne, la boîte de dialogue Sélection de membres n'est pas disponible. Par conséquent, l'utilisateur Smart View doit s'assurer d'utiliser la syntaxe correcte (en plaçant un nom de membre entre guillemets), la séparation de plusieurs noms de membre par une virgule ou, pour une date, la mise en correspondance du format de la chaîne de date avec le format défini dans le script de calcul (mm-dd-yyyy ou dd-mm-yyyy).
- number : la valeur de la variable de substitution d'exécution doit être définie en tant que nombre
<dimension>dimName</dimension>

Nom de la dimension.

Remarques :

Cette balise XML n'est prise en charge que si la valeur <type> est membre.
<choice>value</choice>

Les valeurs possibles sont les suivantes :
- single:
  - S'il y a un seul membre dans la grille ou le PDV, ce membre est utilisé.
  - Si une dimension se trouve sur le PDV, le membre actif est utilisé.
  - Si une dimension se trouve sur le PDV et qu'il y a plusieurs membres, une erreur se produit.
- multiple : tous les membres de dimension de la grille ou du PDV sont utilisés.
Remarques :

Cette balise XML n'est prise en charge que si la valeur <type> est membre.
<allowMissing>boolean</allowMissing>

Indique si les cellules de données pour lesquelles aucune donnée n'existe dans la base de données doivent être autorisées ou supprimées.

Les valeurs valides sont True et False.