変数とヘルパー関数

変数を使用すると、フォームとフローに含まれるデータにアクセスして、カスタムビジネスロジックと自動化を作成できます。

変数を使用する際の基本的な考慮事項は次のとおりです。

• 変数は中括弧{{ variable }}で囲みます。

• 変数が存在しないか解決できない場合は、未定義の変数と同じ効果があります。

• nullまたは未定義の変数を処理するには、nullish演算子を使用できます。例:{{fields.foo ?? fields.bar}}。

フォームとフローを使用して顧客から収集したデータを参照および変換するには、さまざまな種類の変数を使用できます。

フォームとフローは、現在のトランザクションからコンテキスト変数を自動的に継承します。次のコンテキスト変数にアクセスできます。

• userオブジェクト。以下に挙げたプロパティにアクセスできます。

  • 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

• 次のプロパティにアクセスできる組織オブジェクト。

  • organization.id

  • organization.name

  • organization.display_name

  • organization.metadata

• 次のプロパティにアクセスできるクライアントオブジェクト。

  • client.client_id

  • client.name

• 次のプロパティにアクセスできるテナントオブジェクト。

  • tenant.name

• 次のプロパティにアクセスできるトランザクションオブジェクト。

  • 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..."
  }
}

例：  {{context.user.user_id}}は、ユーザーオブジェクトのuser_idを参照します。

フィールド変数には、フォームの入力フィールドからユーザーから収集されたデータと、非表示フィールドのデータが含まれます。各フィールドのデータは、フィールドタイプによって異なります。例：{{fields.first_name}}は、IDがfirst_nameのフィールドの入力値を参照します。

フローアクションが実行されると、後続のアクションで参照できる出力オブジェクト応答が生成されます。例：{{actions.generate_otp.code}}は、IDがgenerate_otpのアクションの出力コードを参照します。

後続のフローと共有する変数、または同じトランザクション内のフォームコンポーネントと共有する変数を保存できます。共有変数は一時的なものであり、特定のフォームジャーニーに関連付けられています。その値には、そのジャーニーの外部からはアクセスできません。例：{{vars.external_id}}は、IDがexternal_idの共有変数の値を参照します。

ヘルパー関数を使用すると、データを変換して簡単な操作を実行できます。例：{{functions.toString(fields.privacy_policies)}}は、toString()関数を使用して、IDprivacy_policiesのフィールドの値を変換します。

使用可能なヘルパー関数は次のとおりです。

フォームフィールドまたはフローアクションを追加すると、IDが自動的に生成されます。

IDをよりわかりやすい値に更新して、含まれる情報を識別できるようにします。たとえば、ユーザーの名を保存するフォームフィールドを作成する場合は、IDをfirst_nameに更新します。

変数がすでに使用されており、IDを変更する必要がある場合は、参照した場所を特定し、それに応じてIDを更新して、未定義または空の値にならないようにします。

予期しない変数値が表示された場合は、実行ビューを使用して変数のトラブルシューティングを行います。

オートコンプリートメニューを使用すると、既存の変数を見つけて適切に参照できます。