Aggiornare e gestire i passaggi con le versioni

Quando pubblichi una nuova versione del passaggio, i flussi utente esistenti che includono il passaggio non vengono aggiornati automaticamente. Dopo aver pubblicato un passaggio, per mantenere il supporto del comportamento precedente, utilizza le versioni per le modifiche.

I casi in cui è consigliabile utilizzare le versioni includono:

  • Aggiunta di nuovi campi obbligatori
  • Campi di input o output ritirati
  • Modifica dei tipi di dati, ad esempio stringa, float o int
  • Modifica del comportamento fondamentale di un passaggio

Per implementare il controllo delle versioni, specifica current_version e min_version nel file manifest del passaggio.

  • current_version: il numero di versione del deployment attivo corrente.
  • min_version: La versione più vecchia supportata del passaggio.

Il seguente esempio di manifest mostra come definire le versioni per un passaggio:

JSON

...
"flows": {
     "workflowElements": [
       {
         "id": "...",
         "state": "...",
         "name": "...",
         "description": "...",
         "version" : {
           "current_version": 3,
           "min_version" : 1
         },
...

Durante l'esecuzione, puoi recuperare il numero di versione dall'oggetto evento e definire un comportamento personalizzato per ogni versione.

Apps Script

/**
 * Executes the step and handles different versions.
 * @param {Object} event The event object from the workflow.
 */
function onExecute(event) {
  // Get the version ID from the execution metadata.
  const versionId = event.workflow.executionMetadata.versionId;

  // Implement different behavior based on the version.
  if (versionId < 2) {
    // Handle earlier versions
  } else {
    // Handle current and newer versions
  }
}