Si vous voulez héberger le package de composants personnalisé à partir d'Oracle Digital Assistant en tant que service de composants imbriqué, vous devez d'abord packager les composants personnalisés dans un fichier TGZ. Ensuite, lorsque vous créez le service de composant imbriqué, vous téléchargez ce fichier.

Ce fichier TGZ, que vous packagez à l'aide de bots-node-sdk pack, doit contenir les ressources et la structure décrites dans Implémentation des composants personnalisés. Il doit également contenir tous les modules de noeud dont il dépend (bots-node-sdk pack s'en occupe pour vous).

Pour préparer un package en vue du téléchargement vers le service de conteneur imbriqué, procédez comme suit :

1. Assurez-vous que vous disposez de la dernière version des outils de ligne de commande Node.js Bots.

   Le conteneur imbriqué exige que le fichier TGZ comprenne tous les éléments dependencies. Les versions antérieures n'ont pas regroupé les éléments dependencies dans le fichier. La commande que vous allez utiliser pour créer le fichier TGZ fait en sorte que votre fichier package.json contienne un noeud bundledDependencies qui répertorie tous les modules dépendants à inclure dans le fichier TGZ.

2. Dans le répertoire contenant le fichier main.js, exécutez la commande suivante pour chacun des modules dont dépend le package. Vous n'avez pas besoin d'effectuer cette opération pour devDependencies, comme le kit SDK Bots Node .

   Cette commande ajoute le module au dossier node_modules et l'ajoute en tant que dépendance dans package.json.

   npm install <module>

   Si package.json nomme déjà toutes les dépendances, vous pouvez exécuter npm install à la place.

3. Assurez-vous que le dossier de niveau supérieur contient un fichier .npmignore contenant lui-même une entrée *.tgz. Par exemple :

   *.tgz
   spec
   service-*

   Sinon, lorsque vous packagerez les fichiers dans un fichier TGZ, vous inclurez le fichier TGZ qui existe déjà dans le dossier de niveau supérieur et la taille de votre fichier TGZ doublera. Une fois que vous avez packagé les fichiers plusieurs fois, le fichier TGZ est trop volumineux pour être téléchargé dans le conteneur.

4. Exécutez cette commande :

   bots-node-sdk pack

   Cette commande valide le package de composants, le met à jour pour inclure devDependencies si nécessaire, puis crée un fichier TGZ que vous téléchargerez lors de la création d'un service de composant imbriqué à partir de l'onglet Composants de la brique. Les fichiers que vous avez répertoriés en tant qu'éléments dependencies sont inclus en tant que bundledDependencies, à l'exception du kit SDK Bots Node et d'Express, qui sont des éléments devDependencies.

Votre package doit être compatible avec le noeud 14.17.0.

Pour plus d'informations sur la commande pack, reportez-vous à https://github.com/oracle/bots-node-sdk/blob/master/bin/CLI.md.

Après avoir créé un package de composants personnalisé dans un fichier TGZ, vous pouvez le télécharger pour créer un service de composant imbriqué à partir de l'onglet Composants de la brique.

Pour savoir comment créer le fichier TGZ, reportez-vous à Préparation du package pour un service de conteneur imbriqué.

Pour créer le service de composant imbriqué, procédez comme suit :

1. Dans la brique, cliquez sur Composants .

2. Cliquez .

3. Sélectionnez Conteneur imbriqué.

4. Cliquez sur Télécharger un fichier de package de composants et pointez vers le fichier TGZ à télécharger, ou faites glisser le fichier vers la zone Fichier de package.

5. (Facultatif) Si vous voulez envoyer les instructions context.logger() de composant personnalisé au journal du service, activez l'option Activer la journalisation de composant. Cette option est disponible uniquement dans les instances Oracle Digital Assistant qui ont été provisionnées sur Oracle Cloud Infrastructure (parfois appelée infrastructure cloud Generation 2).

   Pour visualiser le journal à partir de l'onglet Composants, cliquez sur Diagnostics > Visualiser les journaux.

   Remarque
   
   La brique conserve une entrée de journal pendant deux jours. Lorsque vous supprimez un service de composant personnalisé incorporé, les entrées de journal de la brique pour ce service sont supprimées.

6. Cliquez sur Créer.

   Digital Assistant télécharge le fichier TGZ et crée le service de composant imbriqué. Lors du téléchargement, Digital Assistant vérifie que le package est valide et peut le rejeter pour les raisons décrites plus loin dans cette section.

   Une fois le fichier TGZ téléchargé vers le serveur, le service de composant personnalisé est créé et ses composants sont déployés. Si la page Composants affiche un message indiquant que le déploiement est en attente après le téléchargement du fichier TGZ vers le serveur, cela signifie que le service a été créé mais n'est pas encore disponible. Lorsque le service est disponible, les métadonnées de déploiement sont affichées à la place du message indiquant que le déploiement est en attente.

7. Assurez-vous que l'option Service activé est activée.

Lors du téléchargement, Digital Assistant peut rejeter le package. Voici les motifs de rejet et les méthodes de résolution des problèmes.

• JavaScript contient des erreurs de syntaxe : si le fichier JavaScript d'un composant comprend des erreurs de syntaxe, ce composant n'est pas ajouté au conteneur, ce qui génère le message d'erreur suivant.

  Error Message: failed to start service built: Invalid component
        path:

  Affichez les fichiers de composant dans un éditeur qui détecte les erreurs de syntaxe. Essayez également d'héberger le package sur un serveur local qui envoie des messages d'erreur vers un journal de console.

  Ce message peut également apparaître si le package ne contient pas toutes les dépendances de module de noeud. Consultez l'élément suivant de cette liste.

• Modules de noeud manquants : si le package ne contient pas toutes les dépendances du module de noeud, vous obtiendrez le même message d'erreur que ci-dessus.

  Error Message: failed to start service built: Invalid component
        path:

  Pour savoir comment inclure des dépendances de module de noeud, reportez-vous à Préparation du package pour un service de conteneur imbriqué.

• Nom de composant trop long : si un nom de composant comporte plus de 100 caractères, commence par System. ou contient des caractères autres que des caractères alphanumériques et des traits de soulignement, cela entraîne l'échec de la création du service.

  Modifiez le nom dans le fichier JavaScript du composant, repackagez-le et téléchargez-le à nouveau.

• Dépassement de la limite de service de composant : si votre instance a déjà le nombre maximal de services de composant personnalisés imbriqués, la création du service échoue. Demandez à l'administrateur de service la limite embedded-custom-component-service-count décrite dans Affichage des limites de service dans la console Infrastructure.

  Si vous avez besoin d'augmenter la limite, vous pouvez demander une augmentation. Reportez-vous à Demande d'augmentation de limite de service.

• Fichier TGZ trop volumineux : cela se produit généralement lorsque le fichier .npmignore ne contient pas d'entrée *.tgz. Par conséquent, chaque fois que vous packagez les fichiers, une copie imbriquée du fichier TGZ existant est ajoutée.

  Lorsque le dossier de niveau supérieur contient un fichier .npmignore avec une extension *.tgz, la version précédente du fichier TGZ n'est pas incluse lors de la mise à jour du package.

Si vous voulez envoyer les instructions context.logger() de composant personnalisé au journal du service, activez l'option Activer la journalisation de composant. Cette option est disponible uniquement dans les instances Oracle Digital Assistant qui ont été provisionnées sur Oracle Cloud Infrastructure (parfois appelée infrastructure cloud Generation 2).

Lorsque l'option Activer la journalisation de composant est activée, vous pouvez cliquer sur le bouton Diagnostics du service pour accéder à l'option de visualisation des journaux et aux rapports d'incident afin de diagnostiquer le problème.

• Sélectionnez Visualiser les journaux pour visualiser les messages que le composant personnalisé envoie à context.logger(). Cette fonctionnalité est disponible uniquement dans les instances Oracle Digital Assistant qui ont été provisionnées sur Oracle Cloud Infrastructure (parfois appelée infrastructure cloud Generation 2). L'option Activer la journalisation de composant doit être activée pour que le journal contienne ces messages.
• Sélectionnez Afficher le rapport d'incident pour afficher les détails sur les causes de la panne du conteneur.

Une fois le service créé, vous pouvez appeler les composants personnalisés à partir de votre flux de dialogue, comme décrit dans Composants personnalisés.