Rules

Rules は、アクションタイプのロジックを定義し、パラメーターをオントロジー編集や他の効果に変換します。主に2つのタイプのルールがあります。オントロジーを編集するものと、Foundryで別の効果をトリガーするものです。

オントロジールール

オントロジーのルールは、オントロジーの特定の要素を変更します。既存のタイプのオブジェクトやリンクを作成、変更、削除することができます。1 対多または1 対1 のリンクを作成または削除するには、オブジェクトルールを使用し、オブジェクトの外部キーのプロパティを変更する必要があります。

1. オブジェクトの作成: 事前に定義されたタイプのオブジェクトを作成するために使用できます。オブジェクトタイプの主キーは、必ず記入する必要がある必須プロパティです。追加のプロパティをオプションで追加することができます。
2. オブジェクトの変更: オブジェクト参照パラメーターから主キーが導出された既存のオブジェクトを変更するために使用できます。これは、現在のアクションの一部として作成されたオブジェクトを参照することはできません。
3. オブジェクトの削除: オブジェクト参照パラメーターから主キーが導出された既存のオブジェクトを削除するために使用できます。これは、現在のアクションの一部として作成されたオブジェクトを参照することはできません。
4. リンクの作成: オブジェクト参照パラメーターで渡されるオブジェクト間に多対多のリンクを作成するために使用できます。外部キーリンクについては、オブジェクトの変更ルールを使用して外部キープロパティを明示的に変更する必要があります。
5. リンクの削除: オブジェクト参照パラメーターで渡されるオブジェクト間に多対多のリンクを削除するために使用できます。外部キーリンクについては、オブジェクトの変更ルールを使用して外部キープロパティを明示的に変更する必要があります。
6. Function Rule: アクションのパラメーターから入力が導出されるオントロジー編集関数を参照するために使用できます。このルールが存在する場合、Function コードだけで他のルールができることすべてを処理できるため、他のルールは設定できません。Function action typesについてもっと詳しく読む。

値とパラメーター

リンクやオブジェクトを作成または変更する場合、ルールには追加の値が必要です。オブジェクトを変更する場合、ルールはどのプロパティが変更されるかを定義します。各プロパティは、複数のオプションから提供される値にマッピングされます（リンク上のルールはオブジェクト参照パラメーターのみを取得できます）。

• From parameter: プロパティと同じタイプの既存のパラメーター。デフォルトでは、ルールに新しいプロパティが追加されるたびに、同じ名前のパラメーターが自動的に作成され、このパラメーターの値を取得するようにマッピングされます。
• オブジェクトパラメータープロパティ: 既存のオブジェクト参照パラメーターのプロパティ。オブジェクトパラメーターのプロパティタイプは、マッピングされるプロパティタイプと一致する必要があります。
• 静的値: アクションタイプの Rules 部分でのみ存在する静的な値。Workshop、Slate、Object viewsでアクションを操作する際には、この値を変更することはできません。
• 現在のユーザー/時間: 文字列やタイムスタンプのプロパティは、アクションの現在のユーザーや提出時の時間といったコンテキスト値を取得することもできます。静的値と同様に、これらの値はアクションの提出時に操作できず、アクションタイプの他の部分で使用することはできません。

オブジェクトと多対多リンクの作成

オブジェクトと多対多のリンクを同時に作成することもできます。ただし、多対多リンクを作成するだけでは、リンクの両側にあるオブジェクトが事前に存在する必要があります。多対多リンクを持つオブジェクトタイプでオブジェクトの作成ルールを設定してから、プロパティの追加の下にあるリンクの追加ボタンをクリックして、リンクタイプを選択し、リンクを設定します。

1 対多または1 対1 のリンクタイプを作成するには、オブジェクトの外部キーを編集するだけです。

無効な組み合わせ

アクションタイプには、オントロジールールの組み合わせが含まれます。複数のルールが定義されている場合、アクションのバックエンドはルールをコンパイルして、オブジェクトごとに 1 つの編集を生成します（例：オブジェクトの追加、オブジェクトの変更、またはオブジェクトの削除）。たとえば、1つのルールの結果がプロパティを「A」に更新する場合でも、同じアクションタイプ内の別のルールが同じオブジェクトのプロパティを「B」に更新する場合、結果としての編集はプロパティを「B」に更新するだけです。ルールの順序が最終的なオブジェクト編集に影響します。その結果、次のオブジェクト編集の組み合わせはサポートされていません。

• オブジェクトは、追加または変更される前に削除することはできません。
• オブジェクトは、追加される前に変更することはできません。
• オブジェクトは、1回のフォーム送信で2回作成することはできません。

その他のルール

副作用をトリガーする2つのタイプのルールがあります。

• 通知ルールは、アクションに関する通知を送信するために使用できます。パラメーターは、通知の内容と受信者をカスタマイズするために使用できます。エンドユーザーは、プッシュ通知、メール、または両方で通知を受信するための設定を調整することができます。通知は、すべてのアクション編集が適用された後に送信されますが、通知の内容は、編集が適用される前のオントロジーの状態に基づいて生成されます。
• Webhookは、アクションが適用されるときに、外部システムへのリクエストを行うためにアクションを有効にします。アクションのパラメーターはWebhookに渡され、外部リクエストにパラメーターを渡すことができます。Webhookは、編集が適用される前または後に実行するように設定することができます。