View a markdown version of this page

Parametri di automazione - AWS App Studio
Vantaggi dei parametri di automazioneScenari e casi d'usoDefinizione dei tipi di parametri di automazioneConfigurazione dei valori dinamici da passare ai parametri di automazioneDigitare sicurezzaConvalidaLe migliori pratiche per i parametri di automazione

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Parametri di automazione

I parametri di automazione sono una potente funzionalità di App Studio che può essere utilizzata per creare automazioni flessibili e riutilizzabili passando valori dinamici da varie fonti, come l'interfaccia utente, altre automazioni o azioni relative ai dati. Agiscono come segnaposto che vengono sostituiti con valori effettivi quando l'automazione viene eseguita, consentendo di utilizzare la stessa automazione con input diversi ogni volta.

All'interno di un'automazione, i parametri hanno nomi univoci ed è possibile fare riferimento al valore di un parametro utilizzando la variabile params seguita dal nome del parametro, ad esempio. {{params.customerId}}

Questo articolo fornisce una comprensione approfondita dei parametri di automazione, inclusi i concetti fondamentali, l'utilizzo e le best practice.

Vantaggi dei parametri di automazione

I parametri di automazione offrono diversi vantaggi, tra cui il seguente elenco:

  1. Riusabilità: utilizzando i parametri, è possibile creare automazioni riutilizzabili che possono essere personalizzate con valori di input diversi, consentendo di riutilizzare la stessa logica di automazione con input diversi.

  2. Flessibilità: anziché codificare i valori in un'automazione, puoi definire parametri e fornire valori diversi quando necessario, rendendo le tue automazioni più dinamiche e adattabili.

  3. Separazione dei problemi: i parametri aiutano a separare la logica di automazione dai valori specifici utilizzati, promuovendo l'organizzazione e la manutenibilità del codice.

  4. Convalida: ogni parametro ha un tipo di dati, ad esempio stringa, numero o booleano, che viene convalidato in fase di esecuzione. Ciò garantisce che le richieste con tipi di dati errati vengano rifiutate senza la necessità di un codice di convalida personalizzato.

  5. Parametri opzionali e obbligatori: è possibile designare i parametri di automazione come facoltativi o obbligatori. I parametri obbligatori devono essere forniti durante l'esecuzione dell'automazione, mentre i parametri opzionali possono avere valori predefiniti o essere omessi. Questa flessibilità consente di creare automazioni più versatili in grado di gestire diversi scenari in base ai parametri forniti.

Scenari e casi d'uso

Scenario: recupero dei dettagli del prodotto

Immagina di avere un'automazione che recupera i dettagli del prodotto da un database in base a un ID del prodotto. Questa automazione potrebbe avere un parametro chiamatoproductId.

Il productId parametro funge da segnaposto che puoi inserire con il valore effettivo dell'ID del prodotto durante l'esecuzione dell'automazione. Invece di codificare un ID di prodotto specifico nell'automazione, puoi definire il productId parametro e passare valori ID prodotto diversi ogni volta che esegui l'automazione.

È possibile chiamare questa automazione dall'origine dati di un componente, passando l'ID del prodotto selezionato come productId parametro utilizzando la sintassi tra doppie parentesi graffe:. {{ui.productsTable.selectedRow.id}} In questo modo, quando un utente seleziona un prodotto da una tabella (ui.productsTable), l'automazione recupererà i dettagli del prodotto selezionato passando l'id della riga selezionata come parametro. productId

In alternativa, è possibile richiamare questa automazione da un'altra automazione che esegue un ciclo su un elenco di prodotti e recupera i dettagli di ciascun prodotto passando l'id del prodotto come parametro. productId In questo scenario, il valore del productId parametro verrebbe fornito dinamicamente dall'{{product.id}}espressione in ogni iterazione del ciclo.

Utilizzando il productId parametro e la sintassi delle doppie parentesi graffe, è possibile rendere questa automazione più flessibile e riutilizzabile. Invece di creare automazioni separate per ogni prodotto, puoi avere un'unica automazione in grado di recuperare i dettagli di qualsiasi prodotto semplicemente fornendo l'ID del prodotto appropriato come valore del parametro da diverse fonti, come componenti dell'interfaccia utente o altre automazioni.

Scenario: gestione dei parametri opzionali con valori di riserva

Consideriamo uno scenario in cui si dispone di un'entità «Attività» con una colonna «Proprietario» obbligatoria, ma si desidera che questo campo sia facoltativo nell'automazione e fornisca un valore di riserva se il proprietario non è selezionato.

  1. Crea un'automazione con un parametro denominato Owner che corrisponda al Owner campo dell'Taskentità.

  2. Poiché il Owner campo è obbligatorio nell'entità, il Owner parametro verrà sincronizzato con l'impostazione richiesta.

  3. Per rendere il Owner parametro opzionale nell'automazione, disattiva l'requiredimpostazione per questo parametro.

  4. Nella logica di automazione, puoi usare un'espressione come. {{params.Owner || currentUser.userId}} Questa espressione controlla se il Owner parametro è fornito. Se non viene fornito, tornerà all'ID dell'utente corrente come proprietario.

  5. In questo modo, se l'utente non seleziona un proprietario in un modulo o in un componente, l'automazione assegnerà automaticamente l'utente corrente come proprietario dell'attività.

Modificando l'requiredimpostazione del Owner parametro e utilizzando un'espressione di riserva, è possibile disaccoppiarlo dal requisito del campo dell'entità, renderlo opzionale nell'automazione e fornire un valore predefinito quando il parametro non viene fornito.

Definizione dei tipi di parametri di automazione

Utilizzando i tipi di parametri per specificare i tipi di dati e impostare i requisiti, puoi controllare gli input per le tue automazioni. Questo aiuta a garantire che le automazioni funzionino in modo affidabile con gli input previsti.

Sincronizzazione dei tipi da un'entità

La sincronizzazione dinamica dei tipi di parametri e dei requisiti delle definizioni dei campi delle entità semplifica le automazioni degli edifici che interagiscono con i dati delle entità, assicurando che il parametro rifletta sempre il tipo e i requisiti più recenti del campo dell'entità.

La procedura seguente descrive in dettaglio i passaggi generali per la sincronizzazione dei tipi di parametri di un'entità:

  1. Crea un'entità con campi digitati (ad esempio Boolean, Number, ecc.) e contrassegna i campi come necessario.

  2. Crea una nuova automazione.

  3. Aggiungi parametri all'automazione e, quando scegli il Tipo, scegli il campo dell'entità con cui desideri sincronizzare. Il tipo di dati e l'impostazione richiesta verranno sincronizzati automaticamente dal campo dell'entità mappata

  4. Se necessario, è possibile sovrascrivere l'impostazione «obbligatorio» attivandola per ciascun parametro. on/off Ciò significa che lo stato richiesto non verrà mantenuto sincronizzato con il campo dell'entità, ma in caso contrario rimarrà sincronizzato.

Definizione manuale dei tipi

È inoltre possibile definire i tipi di parametro manualmente senza eseguire la sincronizzazione da un'entità

Definendo tipi di parametri personalizzati, è possibile creare automazioni che accettano tipi di input specifici e gestiscono parametri opzionali o obbligatori secondo necessità, senza fare affidamento sulle mappature dei campi delle entità.

  1. Crea un'entità con campi digitati (ad esempio Boolean, Number, ecc.) e contrassegna i campi come necessario.

  2. Crea una nuova automazione.

  3. Aggiungi parametri all'automazione e, quando scegli il tipo, scegli il tipo desiderato.

Configurazione dei valori dinamici da passare ai parametri di automazione

Dopo aver definito i parametri per un'automazione, puoi passare loro dei valori quando richiami l'automazione. Puoi passare i valori dei parametri in due modi:

  1. Trigger dei componenti: se richiami l'automazione da un trigger del componente, ad esempio facendo clic su un pulsante, puoi utilizzare JavaScript le espressioni per passare valori dal contesto del componente. Ad esempio, se hai un campo di immissione di testo denominatoemailInput, puoi passarne il valore al parametro email con la seguente espressione:. ui.emailInput.value

  2. Altre automazioni: se stai richiamando l'automazione da un'altra automazione, puoi utilizzare JavaScript le espressioni per passare valori dal contesto di automazione. Ad esempio, puoi passare il valore di un altro parametro o il risultato di un passaggio di azione precedente.

Digitare sicurezza

Definendo parametri con tipi di dati specifici, come String, Number o Boolean, puoi assicurarti che i valori passati all'automazione siano del tipo previsto.

Nota

In App Studio, le date sono date in formato ISO e anch'esse verranno convalidate.

Questa protezione dei tipi aiuta a prevenire le discrepanze tra i tipi, che possono causare errori o comportamenti imprevisti nella logica di automazione. Ad esempio, se definisci un parametro come aNumber, puoi essere certo che qualsiasi valore passato a quel parametro sarà un numero e non dovrai eseguire ulteriori controlli di tipo o conversioni all'interno dell'automazione.

Convalida

Puoi aggiungere regole di convalida ai tuoi parametri, assicurandoti che i valori passati all'automazione soddisfino determinati criteri.

Sebbene App Studio non fornisca impostazioni di convalida integrate per i parametri, puoi implementare convalide personalizzate aggiungendo un' JavaScript azione all'automazione che genera un errore in caso di violazione di vincoli specifici.

Per i campi delle entità, è supportato un sottoinsieme di regole di convalida, come i valori. minimum/maximum Tuttavia, questi non vengono convalidati a livello di automazione, ma solo a livello di dati, quando si eseguono Create/Update/Delete azioni Record.

Le migliori pratiche per i parametri di automazione

Per garantire che i parametri di automazione siano ben progettati, gestibili e facili da usare, segui queste best practice:

  1. Usa nomi di parametro descrittivi: scegli nomi di parametro che descrivano chiaramente lo scopo o il contesto del parametro.

  2. Fornisci descrizioni dei parametri: sfrutta il campo Descrizione quando definisci i parametri per spiegarne lo scopo, i vincoli e le aspettative. Queste descrizioni verranno visualizzate nei commenti JSDoc quando si fa riferimento al parametro, nonché in tutte le interfacce utente in cui gli utenti devono fornire valori per i parametri quando invocano l'automazione.

  3. Utilizza tipi di dati appropriati: valuta attentamente il tipo di dati di ciascun parametro in base ai valori di input previsti, ad esempio: String, Number, Boolean, Object.

  4. Convalida i valori dei parametri: implementa controlli di convalida appropriati all'interno dell'automazione per garantire che i valori dei parametri soddisfino requisiti specifici prima di procedere con ulteriori azioni.

  5. Usa valori di riserva o predefiniti: sebbene App Studio attualmente non supporti l'impostazione di valori predefiniti per i parametri, puoi implementare valori di fallback o predefiniti quando utilizzi i parametri nella logica di automazione. Ad esempio, puoi utilizzare un'espressione come {{ params.param1 || "default value" }} per fornire un valore predefinito se il param1 parametro non viene fornito o ha un valore falso.

  6. Mantieni la coerenza dei parametri: se hai più automazioni che richiedono parametri simili, prova a mantenere la coerenza nei nomi dei parametri e nei tipi di dati in tutte le automazioni.

  7. Utilizzo dei parametri del documento: mantieni una documentazione chiara per le tue automazioni, comprese le descrizioni di ogni parametro, il suo scopo, i valori previsti ed eventuali esempi o casi limite pertinenti.

  8. Esamina e rifattorizza frequentemente: rivedi periodicamente le tue automazioni e i relativi parametri, rifattorizzando o consolidando i parametri secondo necessità per migliorare la chiarezza, la manutenibilità e la riusabilità.

  9. Limita il numero di parametri: sebbene i parametri offrano flessibilità, troppi parametri possono rendere un'automazione complessa e difficile da usare. Cerca di trovare un equilibrio tra flessibilità e semplicità limitando il numero di parametri solo a ciò che è necessario.

  10. Prendi in considerazione il raggruppamento dei parametri: se ti ritrovi a definire più parametri correlati, valuta la possibilità di raggrupparli in un unico parametro. Object

  11. Preoccupazioni separate: evita di utilizzare un singolo parametro per più scopi o di combinare valori non correlati in un unico parametro. Ogni parametro dovrebbe rappresentare una preoccupazione o un dato distinto.

  12. Usa alias di parametro: se hai parametri con nomi lunghi o complessi, valuta l'utilizzo di alias o versioni abbreviate all'interno della logica di automazione per una migliore leggibilità e manutenibilità.

Seguendo queste best practice, potete assicurarvi che i parametri di automazione siano ben progettati, gestibili e facili da usare, migliorando in ultima analisi la qualità e l'efficienza complessive delle vostre automazioni.