Variables et fonctions utilitaires

Les variables vous permettent d’accéder aux données contenues dans les Formulaires et les Flux pour créer une logique commerciale et des automatismes personnalisés.

Voici quelques considérations de base sur l’utilisation des variables :

• Les variables sont entourées d’accolades {{ variable }}.

• Si une variable n’existe pas ou ne peut pas être résolue, elle a le même effet qu’une variable dont la valeur est undefined (indéfini).

• Vous pouvez utiliser des opérateurs nuls pour gérer les variables dont la valeur est null ou undefined, par exemple :{{fields.foo ?? fields.bar}}.

Vous pouvez utiliser différents types de variables pour référencer et transformer les données que vous recueillez auprès des clients avec les Formulaires et les Flux.

Les Formulaires et les Flux héritent automatiquement des variables de contexte de la transaction en cours. Vous pouvez accéder aux variables de contexte suivantes :

• L’objet user, avec accès aux propriétés suivantes :

  • user.user_id

  • user.username

  • user.name

  • user.given_name

  • user.family_name

  • user.nickname

  • user.email

  • user.email_verified

  • user.phone_number

  • user.phone_verified

  • user.picture

  • user.user_metadata

  • user.app_metadata

  • user.created_at

  • user.updated_at

  • user.last_password_reset

  • user.identities

• L’objet organization, avec accès aux propriétés suivantes :

  • organization.id

  • organization.name

  • organization.display_name

  • organization.metadata

• L’objet client, avec accès aux propriétés suivantes :

  • client.client_id

  • client.name

• L’objet tenant (locataire), avec accès à la propriété suivante :

  • tenant.name

• L’objet transaction, avec accès à la propriété suivante :

  • transaction.state

{
  "user": {
    "user_id": "auth0|658409...",
    "name": "ana@travel0.com",
    "nickname": "ana",
    "email": "ana@travel0.com",
    "email_verified": true,
    "picture": "https://s.gravatar.com/avatar/8eb1b522f6...",
    "user_metadata": {},
    "app_metadata": {},
    "created_at": "2023-12-21T09:46:40.487Z",
    "updated_at": "2024-05-07T10:44:26.271Z",
    "last_password_reset": "2023-12-21T09:49:08.932Z",
    "identities": [
      {
        "user_id": "6584...",
        "isSocial": false,
        "provider": "auth0",
        "connection": "Username-Password-Authentication"
      }
    ]
  },
  "client": {
    "client_id": "xpeg5...",
    "name": "My App"
  },
  "tenant": {
    "name": "tenant-testing"
  },
  "transaction": {
    "state": "hKFo2SBId2M0..."
  }
}

Par exemple :  {{context.user.user_id}} référence user_id de l’objet user.

Les variables de champ contiennent les données recueillies auprès de l’utilisateur dans les champs de saisie du formulaire et les données des champs cachés. Les données de chaque champ varient en fonction du type de champ. Par exemple : {{fields.first_name}} référence la valeur saisie dans le champ ayant l’ID first_name.

Lorsqu’une action de flux est exécutée, elle génère un objet qui peut être référencé dans les actions suivantes. Par exemple : {{actions.generate_otp.code}} référence le code résultant de l’action avec l’IDgenerate_otp.

Vous pouvez stocker des variables à partager avec des flux ultérieurs ou même avec des composants de formulaire dans la même transaction. Les variables partagées sont éphémères et sont associées à un parcours de formulaire spécifique. Leurs valeurs ne sont pas accessibles en dehors de ce parcours. Par exemple : {{vars.external_id}} référence la valeur d’une variable partagée avec l’ID external_id.

Les fonctions utilitaires permettent de transformer les données et d’effectuer des opérations simples. Par exemple : {{functions.toString(fields.privacy_policies)}} transforme la valeur du champ ayant l’ID privacy_policies utilisant la fonction toString().

Les fonctions utilitaires disponibles sont les suivantes :

Lorsque vous ajoutez un champ de Formulaire ou une action de Flux, l’ID est automatiquement généré.

Mettez à jour l’ID avec une valeur plus descriptive afin de pouvoir identifier les informations qu’il contient. Par exemple, si vous créez un champ de Formulaire qui stocke le prénom de l’utilisateur, modifiez l’ID en first_name.

Si une variable est déjà utilisée et que vous devez modifier son ID, identifiez l’endroit où vous l’avez référencée et mettez l’ID à jour en conséquence pour éviter les valeurs indéfinies ou vides.

Si vous constatez une valeur de variable inattendue, utilisez l’aperçu Executions (Exécutions) pour dépanner la variable.

Le menu de remplissage automatique vous aide à localiser et à référencer correctement les variables existantes.