Mettre à jour et gérer les étapes avec les versions

Lorsque vous publiez une nouvelle version de votre étape, les parcours utilisateur existants qui incluent l'étape ne sont pas automatiquement mis à jour. Après avoir publié une étape, utilisez des versions pour les modifications afin de continuer à prendre en charge le comportement précédent.

Voici quelques exemples de modifications pour lesquelles vous devez utiliser des versions :

  • Ajouter de nouveaux champs obligatoires
  • Abandonner des champs d'entrée ou de sortie
  • Modifier les types de données (chaîne, float ou int, par exemple)
  • Modifier le comportement fondamental d'une étape

Pour implémenter le contrôle des versions, spécifiez current_version et min_version dans le fichier manifeste de votre étape.

  • current_version : numéro de version du déploiement actif actuel.
  • min_version : version la plus ancienne compatible de l'étape.

L'exemple de fichier manifeste suivant montre comment définir des versions pour une étape :

JSON

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

Lors de l'exécution, vous pouvez récupérer le numéro de version à partir de l'objet d'événement et définir un comportement personnalisé pour chaque version.

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