Passer au contenu principal
Documentation
Documentation
Adaptive Planning
Dernière mise à jour : 2023-06-23
Exporter des données Planning avec Scripted Planning Exporter

Exporter des données Planning avec 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
 Pour utiliser Pentaho, voir Configurer des sources de données par script.

Comprendre le fonctionnement d'un SPE

Le SPE fonctionne en appelant le
Adaptive Planning
 export REST-API, puis stocke les résultats de cet appel d'API dans le fichier de votre choix. Le SPE prend en charge la sortie dans des formats de fichier CSV et XML. Toutes les données d'export 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 de. Pour plus d'informations sur l'installation de l'agent de données, voir Installer Data Agent Service Manager. 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, l'export de données s'effectue à partir de Planning et l'import de données s'effectue vers la destination externe. Cependant, dans Spoon, le SPE constitue une étape de saisie, car il permet de saisir des informations dans le script. C'est la raison pour laquelle il est intitulé "Adaptive Planning Input" dans Spoon.
Vous pouvez lancer le SPE directement dans l'environnement Spoon ou à distance en l'incluant dans un chargeur de scripts. Le processus général d'utilisation du SPE consiste à rédiger un script créant une demande XML au format accepté par le serveur Planning, transférant ces éléments au SPE, puis traitant les résultats. Vous trouverez ci-dessous un exemple de script indiquant 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 bonnes pratiques pour ce script sont les suivantes :
  • Tous les noms de champ d'entrée sont sensibles à la casse. Vérifiez qu'ils sont définis en conséquence dans le script Kettle.
  • requestXMLString :
     chaque API d'export dispose de son propre format de demande XML. Voir les
    Adaptive Planning
     API REST pour plus d'informations.
  • targetResponseFormat :
     à partir de la version 11 de l'API, seule la charge utile de l'API "exportData" peut être transformée au format CSV. Tous les autres exports doivent être au format XML.
  • TargetFolder :
     en général, il est conseillé de ne pas cocher la case Restrict Runner Access to Files dans Agent Service Manager. Le dossier cible peut se trouver à n'importe quel endroit dans le système de fichiers.
  • Nombre de fichiers de réponse :
    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'export passe du côté du serveur Planning, la valeur requestSuccess affichera true ("Y"). Si la demande d'export é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 workflow général pour l'extraction d'informations de Planning et leur envoi vers un fichier sortie est le suivant :
  1. Fichier XML d'entrée d'une demande
  2. Convertir le contenu du fichier en chaîne
  3. Définir le format cible (CSV | XML) et le dossier
  4. Adaptive Scripted Planning Exporter
  5. Étape de blocage
  6. Consigner la sortie d'Adapter

Utiliser les API d'export Planning depuis le script Kettle

Le SPE utilise
Adaptive Planning
API v11 ou supé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érer un ensemble de valeurs à partir d'une version spécifiée
Voir Comprendre :
Adaptive Planning
 API pour plus d'informations.

Configurer le plug-in 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. Saisissez les informations suivantes 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.
    • Connexion :
       valeur du paramètre contextuel de connexion.
    • Mot de passe 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.

Configurer le SPE dans
Adaptive Planning
 IU Integration Cloud

Le processus général pour la création d'un chargeur de scripts avec l'IU Cloud Integration est le suivant :
  • Créer un chargeur de scripts
  • Sélectionner un point d'entrée
  • Configurer les paramètres obligatoires
Commencez par créer un nouveau chargeur de scripts. Pour plus d'informations, voir Créer des chargeurs de scripts . Vous devez également sélectionner un point d'entrée dans la liste déroulante Point d'entrée. Le nom du script à exécuter définit le point d'entrée lors de l'exécution du chargeur de scripts.
Vous devez mapper et exposer les paramètres contextuels locaux et partagés définis dans le chargeur de scripts 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 (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 de scripts 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 cliquant sur
Refresh Configuration
 pour les actualiser.