Passer au contenu principal
Documentation
Documentation
Adaptive Planning
Exporter des données Planning à l’aide de Scripted Planning Exporter

Exporter des données Planning à l’aide de Scripted Planning Exporter

Vous pouvez utiliser le Scripted Planning Exporter (SPE), un plug-in Pentaho personnalisé, pour exporter des données Planning vers des systèmes externes. Pour plus d’informations sur
Adaptive Planning
 l’utilisation de Pentaho, voir Définition d’une source de données à base de script.

Comprendre le fonctionnement d'un SPE

La fonction SPE effectue un appel au
Adaptive Planning
 Exporter l’API REST, puis stocker les résultats de cet appel d’API dans un fichier que vous précisez. Le SPE prend en charge la sortie dans des formats de fichier CSV et XML. Certaines données d'exportation ne peuvent pas être transformées au format CSV.
Le SPE est un plug-in regroupé avec l'agent de données à partir de la version v51.17.0734. Vous pouvez vérifier quelle version de Data Agent Service Manager dont vous disposez en ouvrant le programme. Le numéro de version s'affiche dans les informations figurant dans l'onglet À propos. Pour plus d’informations sur l’installation de l’agent de données, voir Installer le gestionnaire de service d’agent de données. Lorsque le SPE est installé, le plug-in Adaptive Planning s'affiche dans le dossier Entrée de l'onglet Conception de Spoon.
La terminologie relative à Scripted Planning Exporter Adapter peut être légèrement confuse. Étant donné que les données sont transférées de Planning vers le script, puis vers une destination externe, il s’agit d'une exportation de données à partir de Planning et une importation de données vers la destination externe. Cependant, en le considérant à partir de Spoon, le SPE constitue une étape d’entrée, car il permet d’entrer des informations dans le script. C'est la raison pour laquelle il est libellé "Adaptive Planning Input" dans Spoon.
Vous pouvez lancer le SPE directement dans l'environnement Spoon ou à distance en l'incluant dans un chargeur à base de scripts. Le processus général d'utilisation du SPE consiste à rédiger un script qui crée une demande XML au format accepté par le serveur Planning, la transfère au SPE, puis traite les résultats. Vous trouverez ci-dessous un exemple de script qui affiche les exigences minimales pour un script SPE :

      Scripted Planning Exporter
-------------------------------------------
Input:
      requestXMLString: request in XML format
      targetResponseFormat: CSV or XML
      targetFolder: target folder to store result file generated by
         this plugin

Output: The type of output fields is String, except
    requestSuccess, which is boolean
      requestSuccess: Boolean, Y' or N'
      planningMsgs: concatenate Planning messages in a string,
    delimited by ###'
      responseFileName: complete path of the response file name
      fieldNames: column name in CSV header, or NULL if
    targetResponseFormat is XML
      numberRecReturned: String, number of records returned by
    Planning, or NULL if targetResponseFormat is XML
Les meilleures pratiques pour ce script incluent :
  • Tous les noms de champ d'entrée sont sensibles à la casse. Définissez-les dans le script Kettle en conséquence.
  • requestXMLString :
    chaque API d’exportation a son propre format XML de demande. Voir
    Adaptive Planning
     L’API REST pour plus d’informations.
  • targetResponseFormat :
    à la version 11 de l’API, seule les données utiles de l’API ’exportData’ peuvent être converties au format CSV. Toutes les autres exportation doivent être en XML.
  • TargetFolder :
     en général, ne cochez pas la case Limiter l’accès des exécuters aux fichiers dans l’onglet Gestionnaire de services d’agent. Le dossier cible peut se trouver n’importe où dans le système de fichiers.
  • filterFileName :
    le nom du fichier de réponse est au format suivant :
    <targetFolder>_ApiResponse_<exportMethod>_<UUID>.<targetFormat>;
     Exemple :
    C:\pdiTemp\ApResponse_exportData_83980a17b3dc40c48282483cb9ea5e96.csv
  • requestSuccess :
     si la demande d’exportation est traitée sur le côté du serveur Planning, la valeur de requestSuccess est vraie (’Y’). Si la demande d'exportation échoue dans les résultats d'un appel adressé à Planning, le SPE lancera une exception avec les messages d'erreur renvoyés par le serveur Planning.
Le flux des travaux général pour l'extraction d'informations de Planning et leur envoi vers un fichier sortie est le suivant :
  1. Fichier XML d’une demande d'entrée.
  2. Convertissez le contenu du fichier en chaîne.
  3. Définissez le format cible (CSV | XML) et le dossier.
  4. Adaptive Scripted Planning Exporter.
  5. Étape de blocage.
  6. Consignez la sortie d'Adapter.

Utiliser les API d'exportation Planning à partir de script Kettle

L’entité SPE utilise
Adaptive Planning
API v11 ou version ultérieure. Vous pouvez utiliser les API suivants avec le SPE :
  • customReportValues :
    renvoie un ensemble de données pour les critères de rapport demandés dans l'instance demandée
  • exportData :
     récupère un ensemble de valeurs à partir d’une version précisée
Voir À propos de
Adaptive Planning
 L’API pour plus d’informations.

Configuration du module d’extension SPE Kettle

Pour configurer le plug-in SPE Kettle, procédez comme suit :
  1. Cliquez sur
    Adaptive Planning Input
     dans l'onglet Conception Spoon.
  2. Entrez les informations du SPE :
    • Agent actif :
       renseigné automatiquement par le SPE.
    • Hôte d'instance :
       renseigné automatiquement par le SPE.
    • Code d'instance :
       renseigné automatiquement par le SPE.
    • Identifiant de connexion : :
       valeur du paramètre contextuel de connexion.
    • Mot de passe d’indentifiant de connexion :
       valeur du paramètre contextuel du mot de passe.
    • Paramètres régionaux :
       définis par défaut sur
      en_US
      .
  3. Cliquez sur
    OK.
Vous devez créer un script qui définit les entrées et les sorties pour l'opération SPE. Consultez l'exemple de script dans cet article.

Configurant l'entité juridique unique dans
Adaptive Planning
 Interface utilisateur Integration Cloud

Le processus général pour la création d'un chargeur de scripts à l’aide de l'IU Cloud Integration est le suivant :
  • créer un chargeur à base de scripts
  • sélectionner un point d'entrée
  • configurer les paramètres obligatoires
Commencez par créer un nouveau chargeur à base de script. Voir Créer des chargeurs à base de script pour plus d’informations. Vous devez également sélectionner un point d'entrée dans la liste déroulante du Point d'entrée. Le nom du script à exécuter définit le point d'entrée lors de l'exécution du chargeur à base de script.
Vous devez mapper et exposer les paramètres contextuels locaux et partagés définis dans le chargeur à base de script sous forme de variables d'environnement dans l'environnement Kettle/Spoon. Exemple : si le paramètre contextuel "login" est défini dans l'écran de configuration du chargeur dans la section Paramètres, il sera alors exposé comme variable "${login}" dans l'environnement Kettle. La définition de deux paramètres contextuels dans un chargeur à base de script est ensuite utilisée dans le SPE pour les deux variables Kettle correspondantes.
Vous pouvez mettre à jour les variables Kettle au moment de la conception avec les valeurs actuelles des paramètres contextuels par défaut en lançant Adaptive Script Editor et en actualisant
Refresh Configuration
 par un clic.