Distribuzione dei connettori
Dopo avere creato e testato localmente il connettore, è possibile distribuirlo in un'istanza di test locale di ThingWorx Flow. Per distribuire il connettore sul server ThingWorx Flow, attenersi alla procedura descritta di seguito.
1. Nel progetto del connettore eseguire il comando npm install.
Vengono installati tutti i package richiesti dal connettore.
2. Avviare il prompt dei comandi ed eseguire il comando riportato di seguito:
flow-deploy connector -s <Progetto_directory_radice_di_connettore> -t <Directory_installazione_flusso_ThingWorx>
Questo comando esegue le operazioni descritte di seguito.
a. Copia dei metadati degli elementi nel file di caricamento del database.
b. Distribuzione delle icone nella posizione di runtime.
c. Copia del codice del connettore nella posizione di runtime per i connettori.
3. Per caricare i metadati degli elementi distribuiti in ThingWorx Flow, eseguire il comando seguente:
flow-deploy migrate
4. Selezionare > > per riavviare il servizio ThingWorx Flow.
È necessario poter creare i flussi utilizzando connessioni, azioni e trigger dal connettore.
flow-deploy
Il comando flow-deploy dispone dei sottocomandi seguenti:
• flow-deploy about - Fornisce informazioni sull'utilità di distribuzione di ThingWorx Flow.
• flow-deploy connector - Distribuisce gli elementi del connettore in un'installazione locale di ThingWorx Flow.
• flow-deploy migrate - Carica i metadati degli elementi distribuiti nel server ThingWorx Flow.
• flow-deploy settings <command> - Carica o scarica le impostazioni del connettore.
Tutti i sottocomandi del comando flow-deploy accettano i parametri descritti di seguito.
Parametro | Descrizione | Tipo di dati |
|---|---|---|
--log,-l | Imposta il livello di registrazione. | [stringa] [default: "info"] |
--version | Visualizza il numero di versione di ThingWorx Flow Deploy Utility. | [booleano] |
--help | Visualizza la guida per i vari comandi, sottocomandi e parametri che possono essere forniti al comando. | [booleano] |
flow-deploy about
Stampa le informazioni sulla versione dell'utilità di distribuzione di ThingWorx Flow. La sintassi del comando e l'output per il comando flow-deploy about si presentano come segue:
flow-deploy about
ThingWorx Flow Deploy Utility, Version :1.0.2
flow-deploy connector
Distribuisce il package del connettore personalizzato nella directory di installazione di ThingWorx Flow e aggiorna gli script di caricamento in modo che includano i metadati degli elementi del connettore personalizzato, ad esempio le connessioni, le azioni e così via.
Il comando flow-deploy connector accetta i parametri seguenti:
Parametro | Descrizione | Tipo di dati |
|---|---|---|
--sourceDir,-s Obbligatorio | Directory radice del progetto di connettore personalizzato. | [stringa] |
--targetDir,-t Obbligatorio | La directory di installazione di ThingWorx Flow di default è C:\ThingWorxOrchestration. | [stringa] |
--allow_schema_overwrite | Lo strumento flow-deploy non consente la sovrascrittura delle proprietà dello schema di input e output presenti nei file JSON di metadati di un'azione, una connessione e un trigger esistenti. Se fosse consentita la sovrascrittura, qualsiasi flusso creato utilizzando il vecchio schema verrebbe interrotto. Durante la fase di sviluppo è tuttavia possibile sovrascrivere le proprietà dello schema di input e output. Impostare questo flag per sovrascrivere lo schema esistente con il nuovo schema nel progetto del connettore. | - |
La sintassi del comando flow-deploy connector è la seguente:
flow-deploy connector --sourceDir <Progetto_directory_radice_di_connettore> --targetDir <Directory_installazione_flusso_ThingWorx>
flow-deploy migrate
Questo comando carica i metadati del connettore sul server ThingWorx Flow.
Il comando flow-deploy migrate accetta i parametri descritti di seguito.
Parametro | Descrizione | Tipo di dati |
|---|---|---|
--sourceDir,-s Obbligatorio | La directory di installazione di ThingWorx Flow di default è C:\ThingWorxOrchestration. | [stringa] |
--Database username, -u Obbligatorio | Nome utente per il database ThingWorx Flow. | [stringa] |
--Database password, -p Obbligatorio | Password per il database ThingWorx Flow. | - |
La sintassi del comando flow-deploy migrate è la seguente:
flow-deploy migrate --sourceDir <Directory_installazione_ThingWorx_Flow> -u <Nomeutente_per__Database_ThingWorx_Flow> -p <Password_per_database_ThingWorx_Flow>
flow-deploy settings
È possibile configurare più tenant per un connettore. Questo comando consente di aggiornare il comportamento di un connettore attraverso la personalizzazione di alcune sue impostazioni per un determinato server ThingWorx Flow. Questo comando dispone dei sottocomandi seguenti:
• flow-deploy settings download - Scarica le impostazioni del connettore da un'istanza in esecuzione di ThingWorx Flow.
• flow-deploy settings file-download - Scarica un file da un'istanza in esecuzione di ThingWorx Flow.
• flow-deploy settings upload - Carica le impostazioni del connettore in un'istanza in esecuzione di ThingWorx Flow.
I parametri riportati di seguito sono comuni a tutti i sottocomandi del comando flow-deploy settings.
Parametro | Descrizione | Tipi di dati |
|---|---|---|
--username,-u | Nome utente dell'amministratore di ThingWorx | [stringa] |
--password,-p | Password dell'amministratore di ThingWorx | [stringa] |
--app-key,-a | Chiave di accesso di ThingWorx | [stringa] |
--twx-url,-t | URL di base ThingWorx nel formato https://<Nomehost:porta>/Thingworx. | [stringa] |
--connector,-c | Nome del connettore. | [stringa] |
--file,-f | Percorso del file di impostazioni del connettore | [stringa] |
--systemid,-s | ID sistema personalizzato | [stringa] |
--default, -d | ID sistema di default | [stringa] |
flow-deploy settings download
Scarica le impostazioni del connettore da un'istanza in esecuzione di ThingWorx Flow.
Ad esempio, per scaricare le impostazioni di configurazione per un connettore specificato sul server ThingWorx Flow, eseguire il comando riportato di seguito:
flow-deploy settings download -f <Percorso_file_impostazioni_connettore> -t <URL_base_ThingWorx> -u <Nomeutente_amministratore_ThingWorx> -p '<Password_amministratore_ThingWorx>' -c <Nome_connettore> -s <ID_sistema_personalizzato>
flow-deploy settings file-download
Scarica un file da un'istanza in esecuzione di ThingWorx Flow.
Oltre ai parametri comuni a tutti i sottocomandi, il comando flow-deploy settings accetta il parametro seguente:
Parametro | Descrizione | Tipo di dati |
|---|---|---|
--fileId | ID file del file che si desidera caricare. Questo nome è disponibile nel file di definizione delle impostazioni del connettore. | [stringa] |
La sintassi del comando flow-deploy settings file-download è la seguente:
flow-deploy settings file-download -f <Percorso_file_personalizzazione> -t <URL_base_ThingWorx> -u <Nomeutente_amministratore_ThingWorx> -p '<Password_amministratore_ThingWorx>' -c <Nome_connettore> -s <ID_sistema_personalizzato> –fileID <ID_file_da_caricare>
flow-deploy settings upload
Carica le impostazioni del connettore in un'istanza in esecuzione di ThingWorx Flow.
 | Prima di eseguire questo comando, creare un file JSON delle impostazioni di configurazione e utilizzare il parametro -f per specificare il percorso del file. Se le impostazioni in questo file corrispondono allo schema, le impostazioni vengono caricate correttamente. In caso contrario viene visualizzato un messaggio di errore indicante lo schema necessario. |
Oltre ai parametri comuni a tutti i sottocomandi, il comando flow-deploy settings accetta il parametro seguente:
Parametro | Descrizione | Tipo di dati |
|---|---|---|
--propertyKey,-k | Nome della proprietà che si desidera aggiornare. Per una singola proprietà immettere solo il <NomeProprietà>. Per un oggetto JSON o un array immettere il <PercorsoProprietà>. Ad esempio, per l'oggetto JSON immettere prop1.prop2.prop3 e per l'array immettere prop1[0].prop2[1].prop3. | [stringa] |
Si considerino gli esempi riportati di seguito.
◦ Per caricare le impostazioni sul server ThingWorx Flow per un determinato connettore con un ID di sistema personalizzato, eseguire il comando riportato di seguito:
flow-deploy settings upload -f <Percorso_file_impostazioni_connettore> -t <URL_base_ThingWorx> -u <Nomeutente_amministratore_ThingWorx> -p '<Password_amministratore_ThingWorx>' -c <Nome_connettore> -s <ID_sistema_personalizzato>
◦ Per caricare le impostazioni sul server ThingWorx Flow per un determinato connettore con l'ID di sistema di default, eseguire il comando seguente:
flow-deploy settings upload -f <Percorso_file_impostazioni_connettore> -t <URL_base_ThingWorx> -u <Nomeutente_amministratore_ThingWorx> -p '<Password_amministratore_ThingWorx>' -c <Nome_connettore> -d
◦ Per aggiornare una singola proprietà nel file delle impostazioni per un determinato connettore, eseguire il comando seguente:
flow-deploy settings upload -f <Percorso_file_impostazioni_connettore> -k <NomeProprietà> o <PercorsoProprietà> -t <URL_base_ThingWorx> -u <Nomeutente_amministratore_ThingWorx> -p '<Password_amministratore_ThingWorx>' -c <Nome_connettore> -d
Il comando prende il valore della proprietà specificata dal file delle impostazioni e lo carica sul server ThingWorx Flow.
flow-deploy settings file-upload
Carica un file in un'istanza in esecuzione di ThingWorx Flow.
Oltre ai parametri comuni a tutti i sottocomandi, il comando flow-deploy settings accetta i parametri seguenti:
Parametro | Descrizione | Tipo di dati |
|---|---|---|
--fileId | ID file del file che si desidera caricare. Questo nome è disponibile nel file di definizione delle impostazioni del connettore. | [stringa] |
--contentType | Tipo di contenuto del file. | [stringa] |
Esempio: flow-deploy settings file-upload -f <Percorso_file_personalizzazione> -t <URL_base_ThingWorx> -u <Nomeutente_amministratore_ThingWorx> -p '<Password_amministratore_ThingWorx>' -c <Nome_connettore> -s <ID_sistema_personalizzato> –fileID <ID_file_da_caricare> --contentType <Tipo_contenuto>