Atualizar e gerenciar etapas com versões

Quando você publica uma nova versão da etapa, os fluxos de usuários atuais que a incluem não são atualizados automaticamente. Depois de publicar uma etapa, use versões para manter o suporte ao comportamento anterior.

As mudanças que você deve usar versões incluem:

  • Adicionar novos campos obrigatórios
  • Descontinuação de campos de entrada ou saída
  • Alterar tipos de dados, como string, float ou int
  • Modificar o comportamento fundamental de uma etapa

Para implementar o controle de versões, especifique current_version e min_version no arquivo de manifesto da etapa.

  • current_version: o número da versão da implantação ativa atual.
  • min_version: a versão mais antiga compatível da etapa.

O exemplo de manifesto a seguir mostra como definir versões para uma etapa:

JSON

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

Durante a execução, é possível recuperar o número da versão do objeto de evento e definir um comportamento personalizado para cada versão.

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
  }
}