Passer au contenu principal
Adaptive Planning
Dernière mise à jour : 2024-03-08
Créer des chargeurs infonuagiques personnalisés

Créer des chargeurs infonuagiques personnalisés

Des connaissances et une expérience approfondies en matière de programmation JavaScript sont requises pour créer un chargeur infonuagique personnalisé. Vous ne devez pas commencer à créer un chargeur infonuagique personnalisé si vous ne disposez pas d’un programmeur JavaScript expérimenté. L’autorisation Développeur d’intégration doit également vous avoir été assignée sous Administration > Ensemble d’autorisations, avant d’essayer de créer un chargeur infonuagique personnalisé.
Les chargeurs infonuagiques personnalisés vous permettent d'exporter
Adaptive Planning
Les données du plan directement dans des systèmes infonuagiques tiers.
Regardez la vidéo :
3 min 16 s

Étapes de base

  1. Saisissez les paramètres de la source de données.
  2. Définissez les paramètres.
  3. Écrivez du code Java à l’aide des API CCDS dans la section Espace de noms ai.
  4. Définissez les règles de gestion.
  5. Exécutez ou planifiez le chargeur.

Conditions préalables

  • Vérifiez que vous disposez de l’autorisation Développeur d’intégration.
  • Vérifiez que
    Adaptive Planning
    Les données de plan que vous souhaitez exporter existent déjà dans une table intermédiaire
  • Créez un identifiant OAuth pour votre système externe ou obtenez des identifiants que vous pouvez explicitement inclure dans votre JavaScript.
  • Vous devez savoir quels paramètres transmettre à votre système externe et les valeurs par défaut qu’attend le système externe.
  • Vous devez savoir comment écrire au point de terminaison du système externe.

Navigation

Compas.png À partir du menu de navigation, accédez à
Intégrations de conception
d’intégration

Saisir les paramètres de source de données

Les paramètres de source de données vous permettent de choisir la table source que vous souhaitez utiliser dans les données intermédiaires de votre instance, déterminent les identifiants à utiliser et le niveau de détail du journal à enregistrer lors d’une exécution du chargeur.

Créer un nouveau chargeur infonuagique personnalisé

  1. Accédez au concepteur de données en sélectionnant
    Intégration > Concevoir des intégrations
    .
  2. Dans le dossier Chargeurs de la Bibliothèque de composants, cliquez sur
    Créer un nouveau chargeur
    .
  3. Sélectionnez
    Chargeur infonuagique personnalisé
    comme type de chargeur et donnez-lui un nom.
    Si vous ne voyez pas l’option Chargeur infonuagique personnalisé, soit elle n’est pas activée pour cette instance, soit vous ne disposez pas de l’autorisation Développeur d’intégration nécessaire pour y accéder.
  4. Sélectionnez
    Créer
    .

Sélectionner la table source, l’identifiant et le niveau de journalisation

  1. Saisissez les informations du chargeur infonuagique personnalisé :
    • Table source :
      sélectionnez une table intermédiaire contenant
      Adaptive Planning
      les données Planning que vous souhaitez exporter.
    • Identifiant obligatoire :
      indiquez si le système externe nécessite OAuth et si vous exigez qu’un utilisateur disposant de l’autorisation Opérateur d’intégration sélectionne l’identifiant OAuth approprié.
    • Identifiant :
      sélectionnez un identifiant OAuth préexistant.
    • Niveau de journalisation :
      indiquez le niveau de détail à consigner lors de l’exécution du chargeur :
      • Erreur
         :
        consigne uniquement les erreurs.
      • Informations
         :
        consigne toutes les informations de base. Par exemple, lorsque la source de données a été mise à jour.
      • Mode détaillé
         :
        fournit des informations très détaillées sur toutes les phases et actions. Principalement utilisé pour le débogage ou l’audit, car il peut générer plus d’informations de journal que nécessaire pour une utilisation normale.
  2. Cliquez sur
    Enregistrer
    dans le menu Actions.

Définir des paramètres

Définissez les paramètres dont votre javaScript doit faire l'exportation
Adaptive Planning
les données vers votre système externe. Les paramètres peuvent inclure des adresses URL de connexion, des noms d’utilisateur, des mots de passe et des dimensions de
Adaptive Planning
, et d’autres renseignements. Les paramètres configurés vous permettent de modifier leurs valeurs au moment de l’exécution. Les paramètres statiques persistent à chaque exécution du chargeur.
  1. Cliquez sur
    Paramètres du concepteur.
  2. Faites glisser les éléments de paramètres paramétrables ou statiques du panneau
    Composant de paramètres
    dans le tableau
    Paramètres du concepteur.
    • Les valeurs des paramètres paramétrables saisies ici deviennent les valeurs par défaut du chargeur si vous n’en fournissez aucune autre lors de l’exécution du chargeur.
    • Les paramètres statiques que vous saisissez ici sont utilisés à chaque exécution du chargeur et n’exigent aucune entrée au moment de l’exécution.
      • Booléen : valeur représentée par la valeur 1 ou 0.
      • Dimension : une dimension de l'administrateur des dimensions dans
        Adaptive Planning
        .
      • Entier : un nombre entier non négatif.
      • Mot de passe : un mot de passe. Cette valeur n’est plus visible une fois enregistrée.
      • Plage de périodes : une plage de périodes
        Adaptive Planning
        .
      • Texte : une valeur alphanumérique.
  3. Cliquez deux fois sur un élément de paramètre pour saisir un nom et modifier sa valeur.
  4. Faites glisser tous les éléments que vous devez référencer dans votre JavaScript.
  5. Enregistrez le chargeur.
  6. Utilisez le nom d’un paramètre dans votre JavaScript pour le référencer.

Écrire un JavaScript

  1. Sélectionnez
    Script
    .
  2. Sélectionnez le modèle préexistant et modifiez-le ou sélectionnez
    Nouveau script
    pour créer votre propre script.
  3. Écrivez le javaScript que vous souhaitez que le chargeur exécute à l’aide des API CCDS dans le Espace de noms ai.
  4. Vérifiez que le script contient les éléments requis suivants :
  5. Référencez par nom tous les paramètres que vous avez créés dans les paramètres du concepteur.
  6. Enregistrez le script.
Vous pouvez formater et améliorer un script dans l’éditeur à l’aide du raccourci clavier
CTRL+Maj+B
. Recherchez et remplacez les lancements avec
CTRL+H
.
Vous pouvez séparer un long script en plusieurs fichiers pour faciliter sa maintenance.
Exemple : vous pouvez inclure toutes vos valeurs
testConnection
logique en un seul script appelée
testconnectionscript
. Un deuxième script, appelé
exportdatascript
, peut contenir la totalité des
exportData
logique.
Lorsque la même fonction est déclarée dans plusieurs scripts, celle provenant du script le plus récemment ajouté est utilisée.

Utiliser OAuth dans les scripts du chargeur infonuagique personnalisé

Lorsque vous sélectionnez Identifiant obligatoire pour un chargeur infonuagique personnalisé, votre script doit contenir
ai.https.authorizedRequest.
Voir Authentification avec OAuth pour savoir comment créer un identifiant OAuth.
Les personnes qui exécutent un chargeur infonuagique personnalisé faisant référence à un identifiant doivent :
  1. Sélectionner
    Demander une autorisation
    avant d’exécuter le chargeur.
  2. Fournir des détails supplémentaires pour l’autorisation, tels que le champ d’application, requis pour le point de terminaison du système externe.
  3. Sélectionner
    Tester la connexion
    pour vérifier que les identifiants OAuth ont été correctement transmis au point de terminaison.
  4. Noter la date d’autorisation et le code utilisateur dans le statut d’autorisation. Les dates d’expiration des autorisations varient d’un système externe à un autre. Cliquez sur Réinitialiser l’autorisation dans le panneau Actions pour réattribuer une autorisation, le cas échéant.

Définir des règles de gestion

Vous pouvez utiliser des règles de gestion pour créer des expressions SQL qui limitent les données intermédiaires exportées vers le système externe. Seuls les enregistrements répondant à vos critères de filtrage seront chargés.
L’onglet Règles de gestion contient une zone de texte pour saisir du langage SQL.
  1. Cliquez sur l’onglet
    Règles de gestion
    .
  2. Cliquez sur
    Modifier
    .
  3. Saisissez une expression SQL. Vous pouvez cliquer sur un élément dans Colonnes disponibles pour inclure cette colonne dans l’expression SQL, plutôt que de la saisir.
  4. Cliquez sur
    Appliquer
    pour vérifier votre syntaxe. En cas d’erreurs, un cadre rouge entoure l’expression. Passez la souris sur l’expression pour afficher des informations concernant des erreurs de syntaxe.
  5. Corrigez toute erreur dans votre syntaxe et cliquez sur
    Appliquer
    . Seules les lignes intermédiaires correspondant à l’expression SQL seront chargées.

Inclure le chargeur infonuagique personnalisé dans une tâche d’intégration

Les chargeurs infonuagiques personnalisés doivent être exécutés comme des tâches d’intégration. Une tâche peut contenir un ou plusieurs chargeurs. Une tâche peut également contenir d’autres tâches d’intégration et chargeurs. Voir : Créer des tâches d’intégration.
Une bonne pratique consiste à utiliser une tâche d’intégration distincte par chargeur.
Si une tâche contient plusieurs chargeurs, les paramètres de chaque chargeur sont présentés à chaque exécution de la tâche. Si un paramètre commun/partagé est utilisé dans les chargeurs d’une tâche, la tâche ne lance le paramètre qu’une seule fois. Vous pouvez choisir de remplacer les invites des paramètres.
Pour les exécutions planifiées de la tâche, les valeurs par défaut des paramètres, stockées lors de la création des chargeurs, sont utilisées.

Exemple de script de chargeur infonuagique personnalisé

Utilisez l’exemple ci-dessous pour vous connecter à votre instance AWS S3 pour exporter et afficher les données de vos feuilles de calcul. Vous aurez besoin du nom de compartiment, de la clé, de la clé d’accès, de la clé secrète et des valeurs régionales. Pour plus d’informations et des exemples de codes, voir ai.AWss3.
  1. Configurez une source de données de type feuille de calcul.
  2. Créez un nouveau chargeur infonuagique personnalisé dans le panneau
    Chargeurs
    .
  3. Naviguez jusqu’à l’onglet
    Paramètres de source de données
    et sélectionnez votre source de données de type feuille de calcul dans le champ
    Table source
    .
  4. Copiez l'exemple de script ci-dessous dans l'onglet
    Scripts
    .
    // Manually invoke this method via 'Test connection' function testConnection(context) { return true; } // Manually invoke this method via 'Run manually' function exportData(context) { //"xxx" is the name of your Amazon S3 bucket. var bucketName = 'xxx'; //Name of the sample CSV file to which data from your spreadsheet data source is exported var key = 'exampleTest.csv'; //"xxxx" is the access key for your AWS S3 bucket. var awsAccessKey = 'xxxx'; //"xxxx" is the secret key of your AWS S3 bucket. var awsSecretKey = 'xxxx'; var region = 'us-west-1'; // Step 1: Get the data var reader = context.createTableReader(); // Step 2: Process and export the data var result = "Column,Heading,Names\n"; var row = null; while ((row = reader.readRow()) !== null) { // remove meta columns we don't need row.length = row.length - 2; result += row.join() + '\n'; } ai.awss3.putFile(bucketName, key, result, region, awsAccessKey, awsSecretKey); }
  5. Sélectionnez
    Enregistrer
    dans le panneau
    Actions
    .
  6. Pour exécuter le script, cliquez sur
    Exécuter manuellement
    dans le panneau
    Actions
    .