Définition dʼautres fonctions SQL adding-additional-sql-functions

Adobe Campaign permet à l'utilisateur de définir ses propres fonctions, qui peuvent accéder aux fonctions SQL offertes par la base de données, et qui ne seraient pas déjà disponibles dans la console. Ce mécanisme est utile par exemple dans le cas de fonctions d'agrégats (moyenne, maximum, somme) qui ne peuvent être calculées que sur le serveur ou bien quand la base de données offre un moyen plus facile d'implémenter certaines fonctions, plutôt que d'écrire l'expression "à la main" dans la console (par ex. gestion de dates).

Ce mécanisme peut aussi servir dans le cas où l'on souhaiterait utiliser une fonction SQL récente, ou rare, d'un moteur de base de données, et qui ne serait pas encore offerte par la console Adobe Campaign.

Une fois ces fonctions ajoutées, elles apparaissent dans l'éditeur d'expressions, au même titre que les fonctions prédéfinies.

Installation installation

La ou les fonctions à ajouter se présentent sous la forme d’un fichier « package » au format XML, dont la structure est décrite au paragraphe suivant.

Pour l’installer depuis la console, sélectionnez les options de menu Outils/Avancé/Import de package, puis le bouton Installer depuis un fichier, et suivez les instructions de l’assistant d’import.

Structure générale du package à importer general-structure-of-package-to-import

La ou les fonctions à ajouter se présentent sous la forme d'un fichier "package" au format XML dont voici un exemple :

<?xml version="1.0" encoding='ISO-8859-1' ?>
<!-- ===========================================================================
  Additional SQL functions for Adobe Campaign
  ========================================================================== -->
<package
  namespace   = "nms"
  name        = "package-additional-funclist"
  label       = "Additional functions"
  buildVersion= "7.1"
  buildNumber = "10000">

  <entities schema="xtk:funcList">
    <funcList name="myList" namespace="cus">
      <group name="date" label="Personalized date">
        <function name="relativeMaturity" type="long" args="(<Âge>)" help="Returns the difference between a date and 18 years"
                  minArgs="1" maxArgs="1" display="Relative maturity of the person born on the date $1">
          <providerPart provider="MSSQL,Sybase,PostgreSQL" body="extract(year from age($1))-18"/>
        </function>
      </group>
    </funcList>
  </entities>
</package>

Si vous souhaitez ajouter des fonctions dans plusieurs groupes différents, il est possible de faire se suivre plusieurs éléments <group> dans la même liste.

Enfin, un élément <group> peut contenir la définition d’une ou de plusieurs fonctions, c’est-à-dire l’objectif du fichier de package. L’élément <function> est présenté dans le paragraphe ci-après.

Descripteur de fonction <function></function> function-descriptor--function-

Le cas présenté ici est le cas général, où l'on souhaite fournir l'implémentation de la fonction.

Ci-dessous l'exemple d'une fonction de "pseudo-maturité", qui, à partir d'un âge, indique depuis combien d'années la personne est majeure.

 <function name="relativeMaturity" type="long" args="(<Âge>)" help="Returns the difference between a date and 18 years"
              minArgs="1" maxArgs="1" display="Relative maturity of the person born on the date $1">
       <providerPart provider="PostgreSQL" body="extract(year from age($1))-18"/>
       <providerPart provider="MSSQL,Sybase,Teradata" body="[Other implementation]"/>
    </function>

Le champ @name fait référence au nom de la fonction et « args » correspond à la liste des paramètres qui s’affichera dans la description. Dans ce cas, la fonction apparaît sous la forme « relativeMaturity ( <age> ) » dans la fenêtre de sélection de fonction.

Le descripteur de fonction 'pass-through' pass-through--function-descriptor

Un descripteur de fonction spéciale est le bloc « pass-through » avec un système de base de données « provider » non spécifié. Dans ce cas, l’implémentation « body » ne peut contenir qu’un seul appel de fonction avec une syntaxe qui ne dépend pas de la base de données utilisée. Pendant ce temps, le bloc « ProviderPart » est unique.

    <function name="CountAll" args="()" help="Counts the values returned (all fields together)"
              type="long" minArgs="0" maxArgs="0">
      <providerPart body="Count(*)"/>
    </function>

Dans ce cas, l'ajout d'une fonction sert uniquement à rendre visible pour le client une fonction de la base de données qui n'aurait pas été rendue disponible par défaut.

Exemples examples

D’autres exemples de fonctions sont disponibles dans le package prédéfini « xtkdatakitfuncList.xml ».