Esecuzione di servizi in WorkflowSubsystem in ThingWorx Composer
Prerequisiti
Prima di eseguire i servizi in ThingWorx Composer, assicurarsi di soddisfare i prerequisiti seguenti.
• Il server ThingWorx Flow deve essere in esecuzione.
• L'utente ha eseguito l'accesso a ThingWorx come amministratore.
Passi
1. Nel dashboard di ThingWorx Flow fare clic su Composer per passare a ThingWorx Composer.
2. In ThingWorx Composer, in Sistema, selezionare Sottosistemi.
3. Selezionare WorkflowSubsystem e fare clic sulla scheda Servizi. Di seguito sono riportati i servizi disponibili per ThingWorx Flow:
4. Cercare il servizio ed eseguire uno dei task seguenti.
◦ Selezionare il servizio per visualizzarne le informazioni di input e output.
◦ Fare clic su 
. Specificare i valori di input appropriati e fare clic su Esegui.
. Specificare i valori di input appropriati e fare clic su Esegui.Servizi
LoadOAuthConfiguration
Utilizzare questo servizio per caricare il file JSON di configurazione OAuth sul server ThingWorx Flow. Questo servizio aggiorna o aggiunge i provider OAuth per i connettori specificati nel file JSON. Non elimina gli eventuali provider OAuth esistenti.
Input | Output | ||
|---|---|---|---|
Nome parametro | Tipo di base | Descrizione | |
oauthConfigurations | JSON | Fornire un file JSON valido con le impostazioni di configurazione OAuth corrette per un connettore. | Restituisce un messaggio che indica il completamento corretto o gli errori che si verificano durante l'esecuzione del servizio. |
Ad esempio, per caricare la configurazione OAuth per JIRA, immettere il valore di oauthConfigurations come
"jira": {
"JIRA": {
"CLIENT_ID": "<Client ID>"
"CLIENT_SECRET": "<Secret>"
}
},
"JIRA": {
"CLIENT_ID": "<Client ID>"
"CLIENT_SECRET": "<Secret>"
}
},
Vedere Configurazione e caricamento di OAuths per i modelli di file JSON di configurazione di OAuth disponibili in ThingWorx Composer
DeleteOAuthConfiguration
Utilizzare questo servizio per eliminare una configurazione OAuth dal server ThingWorx Flow, se il provider OAuth non è in uso da un connettore.
Input | Output | ||
|---|---|---|---|
Nome parametro | Tipo di base | Descrizione | |
Connector config name | String | Immettere un valore di configurazione valido per il connettore di cui si desidera eliminare le impostazioni di configurazione OAuth. | Restituisce un messaggio che indica il completamento corretto o gli errori che si verificano durante l'esecuzione del servizio. |
OAuth provider | String | Fornire un provider OAuth valido per il connettore specificato. | |
Per eliminare la stessa configurazione OAuth per JIRA, immettere il valore del campo Connector config name come jira e del campo OAuth provider come JIRA.
GetOAuthConfiguration
Utilizzare questo servizio per recuperare l'elenco dei connettori per cui le configurazioni OAuth vengono caricate sul server ThingWorx Flow. Le informazioni sensibili, ad esempio ID client, segreti client e URL, non vengono visualizzate.
Input | Output | ||
|---|---|---|---|
Nome parametro | Tipo di base | Descrizione | |
- | - | - | Restituisce un JSON che fornisce il nome del connettore e il nome del provider OAuth di tutte le configurazioni OAuth caricate sul server ThingWorx Flow. |
DeleteOAuthAccessToken
Utilizzare questo servizio per eliminare i token di accesso OAuth del provider OAuth specificato.
Input | Output | ||
|---|---|---|---|
Nome parametro | Tipo di base | Descrizione | |
OAuth provider | String | Fornire un provider OAuth valido per il servizio o l'utilità di terze parti. | Restituisce un messaggio che indica il completamento corretto o gli errori che si verificano durante l'esecuzione del servizio. |
User Name | String | Specificare il nome utente di ThingWorx per cui si desidera eliminare i token di accesso generati per il provider OAuth specificato. Questo campo è facoltativo. Se non si specifica un nome utente, il servizio elimina tutti i token di accesso OAuth per qualsiasi utente per il provider OAuth specificato. | |
 | Dopo che il servizio ha eliminato il token di accesso OAuth per un provider OAuth, il connettore OAuth (utente non anonimo) viene visualizzato con un'icona  nel dashboard di ThingWorx Flow. |
Dopo che i token di accesso OAuth vengono eliminati per un utente, gli utenti devono fornire le relative informazioni di autorizzazione per il connettore OAuth per l'esecuzione del workflow.
◦ OAuth (utente non anonimo) - Modificare il connettore OAuth (utente non anonimo) per fornire le credenziali per riconfigurare il connettore.
◦ OAuth (utente sessione) - Tutti gli utenti che utilizzano questo connettore OAuth (utente sessione) nel workflow devono eseguire l'accesso e fornire di nuovo le approvazioni e le concessioni necessarie per il servizio o l'utilità di terze parti.
RefreshMetadata
ThingWorx Flow memorizza nella cache le informazioni su Windchill OData per migliorare le prestazioni. Se sono state modificate le specifiche dei metadati Windchill o sono stati aggiornati gli attributi soft sul server Windchill, utilizzare questo servizio per aggiornarli sul server ThingWorx Flow.
Input | Output | ||
|---|---|---|---|
Nome parametro | Tipo di base | Descrizione | |
connectorName | String | Specificare il nome del connettore per un servizio di terze parti. | Restituisce un messaggio che indica il completamento corretto o gli errori che si verificano durante l'esecuzione del servizio. |
ValidateFlowSetup
Eseguire questo servizio per verificare che ThingWorx possa comunicare con i servizi ThingWorx Flow.
Input | Output | ||
|---|---|---|---|
Nome parametro | Tipo di base | Descrizione | |
- | - | - | Restituisce un messaggio che indica il completamento corretto o gli errori che si verificano durante l'esecuzione del servizio. |
In caso di problemi di connettività tra ThingWorx e i servizi ThingWorx Flow, vengono visualizzati i codici e i messaggi di errore seguenti:
Codice di errore | Messaggio di errore |
|---|---|
[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. Make sure that you are accessing ThingWorx over the ThingWorx Flow hostname and port once ThingWorx Flow has been installed. Otherwise, ThingWorx Flow and ThingWorx will not be able to communicate with each other. |
[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. |