Une extension est une archive zippée comprenant les fichiers de l'extension, ainsi qu'un fichier de métadonnées. Pour installer le contenu d'une extension dans ThingWorx, vous devez importer son fichier ZIP. Vous pouvez importer plusieurs extensions en même temps en rassemblant dans un même un dossier zip tous les fichiers zip d'extension.

L'importation d'extensions est désactivée par défaut pour tous les utilisateurs. Elle peut cependant être activée en configurant le fichier platform-settings.json :

Optez pour une approche itérative lors de la configuration des paramètres de l'élément ExtensionPackageImportPolicy afin d'activer un nombre minimal de paramètres et garder ainsi le contrôle sur les importations d'extensions. Par défaut, tous les paramètres sont définis sur "false".

Pour importer une extension, procédez comme suit :

En utilisant l'attribut dependsOn de l'élément ExtensionPackage, vous pouvez spécifier des paires nom-version séparées par une virgule pour vos extensions. Le format à utiliser est le suivant : nom:numéro de version majeure.numéro de version mineure.numéro de correctif (par exemple, extensionA:1.0.0) ; ce format est important pour la vérification des dépendances.

Lorsque vous tentez de mettre à niveau une extension adossée à Java en important une nouvelle version, un message d'information s'affiche indiquant que vous devez redémarrer la plateforme. Lorsque cela se produit, le fichier zip d'extension est placé dans une file d'attente : /ThingworxStorage/extensions/upgradequeue. Une fois le serveur Apache Tomcat redémarré, ThingWorx tente d'importer les fichiers zip d'extension dans la file d'attente. Si une importation d'extension en file d'attente échoue, vous devez redémarrer le serveur pour rétablir la version précédente de l'extension. A l'issue de la tentative d'import par ThingWorx des extensions en file d'attente, la file est purgée, même en cas d'échec de l'importation.

Vous n'avez pas à redémarrer après chaque importation d'une extension adossées à Java. Plusieurs extensions peuvent être mises en file d'attente pour importation, qui seront ensuite importées dans l'ordre approprié en fonction de leurs dépendances après un unique redémarrage. Consultez le manuel anglais Extension Development Guide (Guide de développement d'extensions) pour en savoir plus sur la configuration des dépendances.

Les messages d'information et les avertissements suivants sont courants lors des importations d'extension :

Chaque fois que vous importez une extension contenant un fichier JAR, vous obtenez ce message indiquant que vous devez redémarrer le serveur pour terminer l'importation.

Après le redémarrage, consultez les journaux de l'application pour vous assurer de la bonne importation des extensions en file d'attente. Vous devez voir ce qui suit dans le journal de l'application pour chaque extension en file d'attente importée :

Le message suivant sera affiché si les importations en file d'attente ont abouti :

Les erreurs suivantes seront affichées s'il y a eu des problèmes :

Si l'importation de votre extension échoue, des messages indiquant que l'opération a échoué seront consignés dans le journal de l'application et vous inviteront à consulter le journal des erreurs pour en savoir plus. Le motif de l'échec d'importation du package d'extension est indiqué dans le fichier ErrorLog.log, à la fin du message d'erreur généré au moment de l'échec d'importation. Le fait que l'importation soit désactivée ou que l'importation de fichiers JAR ne soit pas autorisée constituent des motifs d'échec. Utilisez ces informations pour vous aider à ajuster les paramètres de configuration appropriés et installer ainsi votre extension.