Exécution de services dans le sous-système de processus de ThingWorx Composer
Conditions requises
Avant d'exécuter les services dans ThingWorx Composer, assurez-vous que les conditions requises suivantes sont respectées :
• Le serveur ThingWorx Flow doit être en cours d'exécution.
• Vous êtes connecté à ThingWorx en tant qu'administrateur.
Etapes
1. Dans le tableau de bord ThingWorx Flow, cliquez sur Composer pour accéder à ThingWorx Composer.
2. Dans ThingWorx Composer, sous Système, sélectionnez Sous-systèmes.
3. Sélectionnez WorkflowSubsystem et cliquez sur l'onglet Services. Les services suivants sont disponibles pour ThingWorx Flow :
4. Recherchez le service, puis effectuez l'une des tâches suivantes :
◦ Sélectionnez le service pour afficher ses informations d'entrée et de sortie.
◦ Cliquez sur 
. Fournissez les valeurs d'entrée appropriées, puis cliquez sur Exécuter.
. Fournissez les valeurs d'entrée appropriées, puis cliquez sur Exécuter.Services
LoadOAuthConfiguration
Utilisez ce service pour charger le fichier JSON de configuration OAuth sur le serveur ThingWorx Flow. Ce service met à jour ou ajoute des fournisseurs OAuth pour les connecteurs spécifiés dans le fichier JSON. Il ne supprime aucune authentification OAuth.
Entrée | Sortie | ||
|---|---|---|---|
Nom de paramètre | Type de base | Description | |
oauthConfigurations | JSON | Fournissez un fichier JSON valide avec les paramètres de configuration OAuth voulus pour un connecteur. | Renvoie un message confirmant l'exécution du service ou signalant les erreurs survenues pendant l'exécution. |
Par exemple : pour charger la configuration OAuth pour JIRA, spécifiez la valeur de oauthConfigurations sur
"jira": {
"JIRA": {
"CLIENT_ID": "<Client ID>"
"CLIENT_SECRET": "<Secret>"
}
},
"JIRA": {
"CLIENT_ID": "<Client ID>"
"CLIENT_SECRET": "<Secret>"
}
},
Consultez la rubrique Configuration et chargement d'OAuths pour les modèles de fichier JSON de configuration OAuth disponibles dans ThingWorx Composer.
DeleteOAuthConfiguration
Utilisez ce service pour supprimer une configuration OAuth du serveur ThingWorx Flow, si le fournisseur OAuth n'est utilisé par aucun connecteur.
Entrée | Sortie | ||
|---|---|---|---|
Nom de paramètre | Type de base | Description | |
Connector config name | Chaîne | Spécifiez une valeur de configuration de connecteur valide dont vous souhaitez supprimer les paramètres de configuration OAuth. | Renvoie un message confirmant l'exécution du service ou signalant les erreurs survenues pendant l'exécution. |
OAuth provider | Chaîne | Spécifiez un fournisseur OAuth valide pour le connecteur spécifié. | |
Pour supprimer la même configuration OAuth pour JIRA, spécifiez la valeur du champ Connector config name sur jira et celle du champ OAuth provider sur JIRA.
GetOAuthConfiguration
Utilisez ce service pour récupérer la liste des connecteurs pour lesquels des OAuths sont chargées sur le serveur ThingWorx Flow. Les informations sensibles telles que les ID client, les clés secrètes client et les URL ne sont pas affichées.
Entrée | Sortie | ||
|---|---|---|---|
Nom de paramètre | Type de base | Description | |
– | – | - | Renvoie un fichier JSON qui fournit le nom du connecteur et le nom du fournisseur OAuth de toutes les OAuths chargées sur le serveur ThingWorx Flow. |
DeleteOAuthAccessToken
Utilisez ce service pour supprimer les jetons d'accès OAuth du fournisseur OAuth spécifié.
Entrée | Sortie | ||
|---|---|---|---|
Nom de paramètre | Type de base | Description | |
OAuth provider | Chaîne | Fournissez un fournisseur OAuth valide pour le service ou l'utilitaire tiers. | Renvoie un message confirmant l'exécution du service ou signalant les erreurs survenues pendant l'exécution. |
User Name | Chaîne | Spécifiez le nom d'utilisateur ThingWorx pour lequel vous souhaitez supprimer les jetons d'accès générés pour le fournisseur OAuth spécifié. Ce champ est facultatif. Si vous ne spécifiez aucun nom d'utilisateur, le service supprime tous les jetons d'accès OAuth pour tous les utilisateurs pour le fournisseur OAuth spécifié. | |
 | Une fois que le service a supprimé le jeton d'accès OAuth pour un fournisseur OAuth, le connecteur OAuth (utilisateur nommé) apparaît avec une icône  dans le tableau de bord ThingWorx Flow. |
Si les jetons d'accès OAuth sont supprimés pour un utilisateur, les utilisateurs doivent fournir leurs informations d'autorisation pour que le connecteur OAuth exécute le processus :
◦ OAuth (utilisateur nommé) : modifiez le connecteur OAuth (utilisateur nommé) pour fournir des informations d'identification afin de reconfigurer le connecteur.
◦ OAuth (utilisateur session) : chaque utilisateur se servant de ce connecteur OAuth (utilisateur session) dans son processus doit se connecter et fournir à nouveau des approbations et des droits au service ou à l'utilitaire tiers.
RefreshMetadata
ThingWorx Flow met en cache les informations Windchill OData pour améliorer les performances. Si vous avez modifié les spécifications de métadonnées Windchill ou mis à jour les attributs paramétrés sur le serveur Windchill, utilisez ce service pour les mettre à jour sur le serveur ThingWorx Flow.
Entrée | Sortie | ||
|---|---|---|---|
Nom de paramètre | Type de base | Description | |
connectorName | Chaîne | Spécifiez le nom du connecteur pour un service tiers. | Renvoie un message confirmant l'exécution du service ou signalant les erreurs survenues pendant l'exécution. |
ValidateFlowSetup
Exécutez ce service pour vérifier que ThingWorx est en mesure de communiquer avec les services ThingWorx Flow.
Entrée | Sortie | ||
|---|---|---|---|
Nom de paramètre | Type de base | Description | |
– | – | – | Renvoie un message confirmant l'exécution du service ou signalant les erreurs survenues pendant l'exécution. |
En cas de problème de connectivité entre ThingWorx et les services ThingWorx Flow, les codes et messages d'erreur suivants s'affichent.
Code d'erreur | Message d'erreur |
|---|---|
[FLOW-CONFIG-01] | ThingWorx Flow is not enabled. Add the OrchestrationSettings section to the platform-settings.json file to enable ThingWorx Flow. |
[FLOW-RABBIT-01] | Failed to connect to RabbitMQ. Check whether the RabbitMQ service is running and is accessible. |
[FLOW-API-01] | Failed to connect to ThingWorx Flow. Check ThingWorx logs for more detail. |
[FLOW-API-02] | Failed to connect to ThingWorx Flow. Assurez-vous que vous accédez à ThingWorx avec le nom d'hôte et le port ThingWorx Flow une fois que ThingWorx Flow a été installé. Sinon, ThingWorx Flow et ThingWorx ne pourront pas communiquer entre eux. |
[FLOW-KEY-01] | OAuth admin key not found in the ThingWorx KeyStore. |
[FLOW-KEY-02] | Exchange admin key not found in the ThingWorx KeyStore. |
[FLOW-KEY-03] | Failed to get ThingWorx Flow keys from the ThingWorx KeyStore. |
[FLOW-KEY-04] | Failed to get ThingWorx Flow keys from the ThingWorx KeyStore. |
[FLOW-EXCHANGE-01] | Failed to connect to ThingWorx Flow exchange service. Check ThingWorx logs for more details. |
[FLOW-EXCHANGE-02] | Failed to connect to ThingWorx Flow exchange service. Check whether ThingWorx Flow exchange service is up and running. |
[FLOW-OAUTH-01] | Failed to connect to ThingWorx Flow OAuth service. Check ThingWorx logs for more details. |
[FLOW-OAUTH-02] | Failed to connect to ThingWorx Flow OAuth service. Check whether ThingWorx Flow OAuth service is up and running. |