Attività di codifica

Informazioni sulle attività del codice

L’attività codice consente di utilizzare JavaScript personalizzato per eseguire operazioni di manipolazione dei dati, formattazione e calcolo prima o dopo altre attività in un flusso di lavoro. Ad esempio, si può usare l’attività codice per trasformare l’output di ritorno di una chiamata API in un risultato più facile da usare (ad esempio, per comunicare il risultato a un manager non tecnico). È quindi possibile convogliare il risultato trasformato in un’attività e-mail che invia un’e-mail al manager.

Impostazione delle attività del codice

1. Passare alla sezione pagina Flussi di lavoro stand-alone o il Scheda Flussi di lavoro di un sondaggio.
   
2. Fare clic su Crea un flusso di lavoro.
3. Selezionare Avviato alla ricezione di un evento.
4. Date un nome al vostro flusso di lavoro.
   
5. Fare clic su Scegli evento e selezionare l’evento che avvia il flusso di lavoro. In genere, si tratta di un evento di risposta al sondaggio.
6. Se lo si desidera, fare clic sul segno più ( + ) e selezionare Condizioni per aggiungere condizioni al flusso di lavoro. Le condizioni aiutano a determinare quando un flusso di lavoro viene attivato. Per ulteriori informazioni sulle condizioni dell’edificio, consultare la pagina collegata.
   
7. Fare clic sul segno più ( +) e selezionare Attività.
   
8. Scegliere l’attività Codice .
   
9. Inserite l’espressione JavaScript nella casella. Per informazioni utili alla stesura del codice, consultare la sezione sulle pratiche ottimali.
   
   Consiglio Q: l’editor di codice mantiene una cronologia delle modifiche, in modo da poterle annullare premendo CTRL + Z (PC) o CMD + Z (Mac). Usare MAIUSC + CTRL + Y (PC) o MAIUSC + CMD + Y (Mac) per ripetere una modifica.
   Consiglio Q: mentre si scrive il codice, è possibile che vengano visualizzati degli errori nella finestra. Questi errori controllano gli errori di sintassi, non quelli di esecuzione. Gli errori di sintassi vengono sempre visualizzati in inglese, indipendentemente dall’impostazione della lingua dell’account. L’esecuzione non avviene finché l’attività non viene salvata e il flusso di lavoro non viene triggerato.
   
10. Se si desidera, inserire un riepilogo dell’attività che spieghi cosa deve fare il codice JavaScript.
11. Fare clic su Test code per eseguire il codice nel browser locale.
    Consiglio Q: poiché si svolgono in ambienti diversi, il test del codice potrebbe non dare lo stesso risultato dell’esecuzione nel flusso di lavoro.
12. Utilizzare il menu {a} Aggiungi testo trasferito per aggiungere testo trasferito all’espressione JavaScript. Il testo trasferito è utile per inserire valori dall’evento, ad esempio per inserire le risposte al sondaggio dei partecipanti. Il testo trasferito viene valutato prima dell’esecuzione dell’espressione JavaScript.
13. Se è necessario cancellare il codice e ricominciare da capo, fare clic su Ripristina impostazioni predefinite.
14. Al termine, fare clic su Salva.
15. L’attività di codifica è spesso abbinata a un’altra attività per utilizzare l’output dell’attività di codifica. Fare clic sul segno più ( + ), selezionare Attività e scegliere l’attività avanti. Per una panoramica delle attività, consultare questa pagina.
    
    Consiglio Q: quando si impostano le attività successive, l’output dell’attività codice sarà disponibile nel menu Testo trasferito dell’attività.
    

Limiti di esecuzione di JavaScript

Quando scrivete il codice JavaScript da includere nell’attività, tenete conto dei seguenti limiti di esecuzione:

• Tempo massimo di esecuzione: 10 secondi
• Lunghezza massima di JavaScript: 6KB
• Nessuna richiesta API in uscita: Per motivi di sicurezza, lattività di codice non può effettuare richieste in uscita ad altre API o servizi, né può recuperare altre librerie JavaScript in fase di esecuzione tramite richieste HTTP.

Se il codice JavaScript supera questi limiti, lattività di codice fallirà. Se il flusso di lavoro non va a buon fine, visitate Flusso di lavoro Rapporti per ulteriori informazioni sul motivo per cui il flusso di lavoro non è andato a buon fine.

Prassi raccomandate

Quando scrivete il vostro JavaScript, seguite le seguenti best practice:

• • Il codice deve essere conforme alla sintassi ES6.
  • Il codice verrà eseguito tramite Node.js in un ambiente protetto. L’attività utilizza attualmente la versione 8.10 di Node.js.
  • Il codice deve restituire il risultato come oggetto JavaScript. Quando il risultato di ritorno è formattato in questo modo, il sistema può dedurre automaticamente quali campi personalizzati restituirà il codice e fornire il testo trasferito appropriato per le attività successive.

    Esempio: In questo esempio, vengono restituiti più risultati:

    function codeTask() {
     return {
       hello: "world",
       foo: "bar",
       status: 200
     };
    }

    Esempio: In questo esempio, restituiamo un singolo risultato:

    function codeTask() {
     return {
       result: "hello world",
     };
    }

  • A seconda del tipo di informazioni attese, potrebbe essere necessario incapsulare la sintassi del localizzatore tra virgolette. È necessario aggiungere le virgolette se si desidera che il localizzatore si risolva in una stringa. Non è necessario aggiungere le virgolette se si risolve in un oggetto

    Esempio: Ad esempio, un codice come quello riportato di seguito avrebbe bisogno di virgolette:

    function codeTask() {
       let ticketId = "~{ch://OCAC_31HNMUuEpm3Jg/exports.data.key}";
       ...
    }

  • Quando si usa il testo trasferito per campi che possono contenere virgolette, si devono usare i letterali di modello(`) invece delle virgolette intorno al testo trasferito.

Esempio: Utilizzo di un’attività di codice con un’attività di servizio web

Questo esempio illustra l’uso di un’attività di codice con un’attività di servizio Web. Si può usare un’attività di codice con un’attività di servizio web per trasformare la risposta al sondaggio di un rispondente in codice API-friendly e poi usare i valori restituiti per eseguire una chiamata API. È quindi possibile prendere i risultati della chiamata API e utilizzare un’altra attività di codice per trasformare i valori restituiti in una risposta di facile comprensione.

In questo esempio, stiamo costruendo un cercatore di ristoranti in Qualtrics. Ci addentreremo un po’ di più nei dettagli in seguito, ma di seguito è riportata una panoramica di come raggiungeremo questo obiettivo.

1. Nel nostro sondaggio, chiederemo agli intervistati dove vogliono mangiare e come vogliono restituire i risultati.
2. Per effettuare la ricerca di ristoranti, utilizzeremo un’applicazione di terze parti per la ricerca di ristoranti. Utilizziamo un’attività di codice per trasformare le risposte dei partecipanti al sondaggio in un modulo utilizzabile dall’API di terze parti per la ricerca di ristoranti.
3. Utilizziamo quindi un’attività di servizio web per eseguire una chiamata API al cercatore di ristoranti di terze parti, che ci restituisce i risultati come JSON.
4. Utilizziamo un’altra attività di codice per trasformare il JSON risultante in una forma leggibile dagli esseri umani.
5. Possiamo utilizzare un’ultima attività per inviare queste informazioni ai rispondenti o a noi stessi. Ad esempio, utilizzare un’attività e-mail per inviare un’e-mail al rispondente con i risultati restituiti.

Creazione di un cercatore di ristoranti con attività di codice

1. Nel sondaggio, creare le domande che confluiranno nell’attività di codifica. Nel nostro caso, si tratta di una domanda a immissione di testo che chiede dove cercare i ristoranti e di una domanda a scelta multipla che chiede come ordinare i risultati.
   
2. Passare a Flussi di lavoro.
3. Creare un nuovo flusso di lavoro.
4. Per l’evento del flusso di lavoro, selezionare l’opzione Risposte al sondaggio e configurare l’evento in modo che si attivi quando viene creata una nuova risposta. Per ulteriori informazioni, consultare la pagina collegata.
   
5. Fare clic sul segno più ( + ) e selezionare Attività.
6. Selezionare l’attività Codice .
   
7. Per quanto riguarda il codice, stiamo trasformando le risposte degli intervistati nei valori necessari per l’API di ricerca dei ristoranti.
   
8. Utilizziamo il testo trasferito per inserire la domanda da cui provengono le risposte dei rispondenti.
9. Fare clic su Salva per salvare l’attività.
10. Fare clic sul segno più ( + ) e selezionare Attività .
    
11. Selezionare l’attività Servizio Web e scegliere l’Autenticità. Per ulteriori informazioni, consultare questa pagina.
    
12. Inserire l’URL che si sta cercando di raggiungere.
    
13. Aggiungere i parametri usando le stringhe query. Utilizzare il menu Testo trasferito, {a}, per utilizzare i valori del sondaggio e dellattività di codice precedente.

    Esempio: Il nostro URL completamente costruito è

    https://api.example.com/v3/businesses/search?sort_by=~{ch://OCAC_Zt2TNQYggAb6u89/sort_by}&location=${q://QID1/ChoiceTextEntryValue}

    Contiene 2 parametri: sort_by e location. Per sort_by, il valore è il risultato della nostra prima attività di codice. Per l’ubicazione, il valore è la risposta dell’intervistato alla domanda di immissione di testo.

14. Terminare l’impostazione dell’attività, se necessario. Se avete bisogno di aiuto, consultate la sezione Attività del servizio Web.
    Consiglio Q: nell’attività del servizio web, è possibile testare i valori restituiti previsti per assicurarsi che la chiamata API funzioni.
    
15. Se necessario, creare percorsi JSON personalizzati che possono essere utilizzati in altre attività. Nel nostro esempio, creiamo un percorso “aziende” che restituisce un array di aziende dai risultati della ricerca.
    
    Consiglio Q: se avete testato la vostra attività di servizio web, Qualtrics identificherà automaticamente i percorsi JSON e li aggiungerà qui. Potete eliminare quelli non necessari facendo clic sull’icona del cestino.
16. Fai clic su Salva.
17. Fare clic sul segno più ( + ) e selezionare Attività.
    
18. Selezionare l’attività Codice .
    
19. Ora dobbiamo trasformare il JSON risultante dall’attività del servizio web in una forma leggibile. Nel nostro caso, lo stiamo trasformando in HTML per utilizzarlo in un’e-mail.
    
20. Per recuperare il JSON risultante dall’attività del servizio Web, utilizzare il menu Testo trasferito, {a}.
21. Fai clic su Salva.
    Consiglio Q: se si utilizza un testo trasferito, è possibile che venga visualizzato un avviso, poiché il designatore del testo trasferito non è un JavaScript valido. Tuttavia, questo problema verrà risolto prima dell’esecuzione, poiché il designatore del testo trasferito verrà sostituito con il valore del campo prima dell’esecuzione del codice.
22. Fate clic sul segno più ( + ) e scegliete Attività.
23. Selezionare l’e-mail.
    
24. Impostare l’attività e-mail. Per ulteriori informazioni, consultare la pagina collegata.
25. Inserite il risultato della seconda attività e-mail nel corpo dell’email. Questo è ciò che restituisce i risultati della ricerca di un ristorante.
    
    Esempio: Di seguito è riportato l’aspetto dell’editor di e-mail con le risposte del rispondente inserite, insieme al risultato della seconda attività di codifica.
    
26. L’e-mail che ne risulta riporta i risultati della ricerca selezionati dal rispondente!
    

FAQ