複数行ルール実行プログラム

単一行の構文規則については、 「属性関数」 を参照してください。

複数行ルールの要素

複数行ルールは YAML 形式で記述されます。 これは、YAML 文書のフォーマット設定の要件によって制約されます。 使用される YAML パーサーは、YAML 1.1 および 1.2 の大部分をサポートします。

サポートされるステートメント・タイプ

context ステートメント

return ステートメント

return ステートメントは、実行を終了し、計算された値を即時に返すように、ルール・エンジンに指示するために使用されます。

形式は return: {{expression}} です。

if ステートメント

if ステートメントは、条件付きブロックを作成するために使用されます。 このステートメントは、前の 2 つのステートメントとは異なり、いくつかのプロパティーから成り立っています。

トレース・ロギング

複数行ルールにトレースログ機能を追加することで、デバッグログを送信することができます。 トレースログのプロパティは、トレースモードが有効な状態でルールが実行された場合に適用されます。 トレースの記録は debug 、 および debugx プロパティを通じてサポートされています。

debug 記述

この debug ステートメントは、指定された式を実行し、返された値をログに記録するために使用されます。 この式は常に文字列として評価される必要があります。

形式 - debug: {{expression}}

debugx ブロック

fieldsこの debugx ブロックは、 log とという2つのプロパティで構成されています。

名前	説明	フォーマット
ログ	指定された式が評価され、返された値がログに記録されます。 この式は常に文字列として評価される必要があります。	log: {{expression}}
フィールド	ログと共に送信されるカスタムメタデータフィールド。 キーと値のペアとして提供されます。 各ペアの値は式であり、その評価結果は文字列でなければなりません。	{{field_key}}: {{expression}}

トレースログの記録を説明するサンプル関数については、該当のセクションを参照してください。

スニペット

以下のスニペットのリストは、包括的ではなく、ルールのすべての可能な使用法を示しているわけではありません。 しかし、このリストで提供されるいくつかのサンプルは、そのまま使用するか、拡張して使用することができます。

マネージャーの表示名の取得

statements:
  - context: manager := user.getManager()
  - context: userExists := has(context.manager.name)
  - context: >
      givenNameExists := context.userExists
      && has(context.manager.name.givenName) 
      && context.manager.name.givenName != ""
  - context: familyNameExists := context.userExists && has(context.manager.name.familyName) && context.manager.name.familyName != ""
  - context: formattedExists := context.userExists && has(context.manager.name.formatted) && context.manager.name.formatted != ""
  - if:
      match: context.formattedExists
      block:
        - return: context.manager.name.formatted
      elseifs:
        - match: context.givenNameExists
          block:
            - if:
                match: context.familyNameExists
                block:
                  - context: managerName := context.manager.name.familyName + ", " + context.manager.name.givenName
                  - return: context.managerName
                else:
                  - return: context.manager.name.givenName
        - match: context.familyNameExists
          block:
            - return: context.manager.name.familyName
- return: string("Not Available")

E メール・ドメインの変換

statements:
  - context: "workEmails := has(user.emails) ? user.emails.filter(e, e.type == 'work') : []"
  - context: "workEmail := size(context.workEmails) > 0 ? context.workEmails[0].value : ''"
  - if:
      match: context.workEmail != ""
      block:
        - context: cn := context.workEmail.substring(0, context.workEmail.lastIndexOf('@'))
        - if:
            match: context.cn != ""
            block:
              - return: context.cn + "@github.com"
  - return: ""

変数のスコープ設定

statements:
    - context: ret := 3 + 4
    - if:
        match: 2 > 1block:
          - context: ret := 5
          - if:
              match: 3 > 2block:
                - context: ret = 0
    - return: context.ret

結果は 7 です。 if.blockこの結果は、6行目で が ret 内で再初期化されるためです。 後続のネストされたステートメントは、この変数を認識します。 しかし、ルール・エンジンは、if.block を終了した後に 2 行目で初期化された変数にアクセスできます。

トレースログの例

この例では、トレースログ出力文の使用方法を説明します。

statements:
  - context: uid := user.id
  - context: userEmail := "user@test.com"
  - debug: '"This is an example of a trace log at time " + string(now)'
  - debugx: 
      log: '"The user id obtained: " + context.uid'
      fields:
          flow: '"login"'
          time: 'string(now)'
          userEmail: context.userEmail
  - return: context.uid  + ", " + context.userEmail

"This is an example of a trace log at time <timestamp>"この debug ステートメントでは、指定された式が評価され、としてログに記録されます。

重要な制限事項

• context フレームで初期化された変数は、そのフレームおよびそのサブフレーム内でのみ存続します。 前出のルール例の場合、変数 managerName は、その変数を初期化した if フレームの外部からはアクセスできません。
• elseifs フレームおよび else フレームは、if フレームが同じレベルにある場合にのみ使用できます。
• if フレームおよび elseifs フレームはすべて、常にブール値を返す match 式が必要です。
• ルール評価フローに return ステートメントがない場合は、ヌル値が返されます。 エラーはスローされず、想定し得るすべてのフローに return があることを確認するための構文検査も実行されません。 ルールの作成者は、ルールのすべてのフローが許容可能値を返すことを確認する必要があります。