Schritte mit Versionen aktualisieren und verwalten

Wenn Sie eine neue Version Ihres Schritts veröffentlichen, werden vorhandene Nutzerabläufe, die den Schritt enthalten, nicht automatisch aktualisiert. Nachdem Sie einen Schritt veröffentlicht haben, sollten Sie Versionen für Änderungen verwenden, um die Unterstützung für das bisherige Verhalten beizubehalten.

Änderungen, für die Sie Versionen verwenden sollten:

  • Neue Pflichtfelder hinzufügen
  • Eingabe- oder Ausgabefelder einstellen
  • Datentypen ändern, z. B. „string“, „float“ oder „int“
  • Grundlegendes Verhalten eines Schritts ändern

Um die Versionsverwaltung zu implementieren, geben Sie current_version und min_version in der Manifestdatei Ihres Schritts an.

  • current_version: Die Versionsnummer des aktuell aktiven Deployments.
  • min_version: Die älteste unterstützte Version des Schritts.

Das folgende Beispielmanifest zeigt, wie Versionen für einen Schritt definiert werden:

JSON

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

Während der Ausführung können Sie die Versionsnummer aus dem Ereignisobjekt abrufen und benutzerdefiniertes Verhalten für jede Version definieren.

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