注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

アクションタイプをブランチ化する

オントロジーのアクションは Global Branching と統合されており、本番環境に影響を与えずにブランチ上でアクションタイプをテストできます。変更を main にマージする前に、分離されたブランチのコンテキストでアクションを実行し、設定を検証して、編集結果を確認できます。ブランチ上の編集はマージされません。

Global Branching の概念とワークフローに関する一般的な情報については、Global Branching のドキュメントを参照してください。

ブランチ上でアクションを実行する

ブランチ上の Workshop モジュールでアクションをテストして、正しく設定されていることを検証できます。関連するすべてのオブジェクトタイプがブランチ上でインデックス化済みになると、アクションタイプを実行し、その結果生じた編集をブランチ上で確認できます。

前提条件

ブランチ上でアクションを実行するには、アクションタイプによって編集されるすべてのオブジェクトタイプとリンクタイプが、そのブランチ上でインデックス化されている必要があります。個々のオブジェクトタイプまたはリンクタイプのページから、あるいは Ontology Manager のアクションタイプのページからインデックス化できます。

ブランチ上で Ontology Manager のアクションタイプを開くと、そのアクションタイプが変更するオブジェクトタイプまたはリンクタイプのうち、ブランチ上でインデックス化されていないものがある場合にバナーが表示されます。

Ontology Manager で、アクションタイプが変更するすべてのリソースを現在のブランチ上でインデックス化するよう求められます。

詳細については、アクションタイプによって変更されるリソースをインデックス化するを参照してください。

これらのリソースがインデックス化される前にアクションを実行しても、アクションによる編集は適用されません。トースト通知には、アクションは有効であるものの、編集対象のリソースのうち1つ以上がブランチ上で読み取り専用であることが表示されます。この通知には Ontology Manager へのリンクがあり、アクションを再実行する前に、残りのリソースをインデックス化できます。

アクションがメディアをアップロードする場合は、元のメディアセットもブランチ上で利用可能である必要があります。詳細については、ブランチ上でメディアをアップロードするを参照してください。

ブランチ上でのアクションの実行は、テストを目的としています。ブランチ上のアクションによる編集は main にマージされません。

ブランチ上で関数ベースのアクションを使用する

ブランチ上の関数ベースのアクションは、ブランチ対応かどうかによって動作が異なります。ブランチ対応の関数はブランチ上で変更でき、そのブランチからスキーマを読み取ります。一方、ブランチ非対応の関数は main からのみスキーマを読み取ります。ブランチ対応かどうかにかかわらず、すべての関数ベースのアクションはブランチ上でのみ実行され、変更を main に書き戻すことはありません。サポートされている関数の種類については、Global Branching のドキュメントを参照してください。

ブランチ上でメディアをアップロードする

元のメディアセットをグローバルブランチに追加すると、そのブランチ上でメディアをアップロードするアクションを実行できます。アクションは同じグローバルブランチ上のメディアセットにメディアをアップロードし、そのメディアは main やほかのグローバルブランチから分離された状態に保たれます。ブランチ上でのメディアセットの追加と既存の Media Reference の読み取りについては、オブジェクトタイプによって参照されるメディアセットを参照してください。

ブランチ上の副次的効果を管理する

以下の情報は、ブランチ上でアクションを介して適用される Webhook、外部呼び出しを伴う関数、および通知にのみ適用されます。ほかの手段で適用される副次的効果は、それらを利用する側で定義されたとおりに動作します。

Webhook

デフォルトでは、ブランチ上でアクションを適用しても Webhook は実行されません。これは、テスト環境で誤って外部システムに書き込むことを防ぐための動作です。

この場合、この動作を示すトースト通知が表示されます。

アクションは適用されたものの、Webhook は実行されなかったことを示すトースト通知。

ただし、READ エンドポイントを呼び出す場合など、ブランチ上で Webhook をテストしたい場合もあります。

デフォルトの動作を変更するには、Ontology Manager のアクションタイプのセキュリティと実行条件タブで、ブランチ上での Webhook の実行を有効にします。

ブランチ上で Webhook を有効にする設定。

ブランチ上での Webhook を有効にすると、Webhook は main 上とまったく同じように実行されます。そのため、外部の本番環境を呼び出すように Webhook が設定されている場合は、ブランチ上でアクションを実行しても、その本番環境が呼び出されます。

外部呼び出しを伴う関数

デフォルトでは、ブランチ上でアクションを適用しても、外部呼び出しを伴う関数ベースのアクションロジックは実行されず、アクション全体が失敗します。これは、テスト環境で誤って外部システムに書き込むことを防ぐための動作です。

この場合、失敗したことと、その動作の説明を示すトースト通知が表示されます。

外部関数呼び出しによってアクションがブロックされました。

ただし、READ エンドポイントを呼び出す場合など、ブランチ上でのテストが必要なこともあります。Ontology Manager のアクションタイプのセキュリティと実行条件タブで、ブランチ上での外部呼び出しを伴う関数を有効にすると、この制限を解除できます。

ブランチ上で外部呼び出しを伴う関数を有効にする設定。

ブランチ上での外部呼び出しを伴う関数を有効にすると、関数は main 上と同じ外部呼び出しを行います。そのため、外部の本番環境を呼び出すように関数が設定されている場合は、ブランチ上でアクションを実行しても、その本番環境が呼び出されます。

通知

デフォルトでは、ブランチ上でアクションを適用しても通知は実行されません。これは、テスト環境で誤って受信者に通知することを防ぐための動作です。

この場合、この動作を示すトースト通知が表示されます。

アクションは適用されたものの、通知は実行されなかったことを示すトースト通知。

ただし、ブランチ上で通知をテストしたい場合もあります。

デフォルトの動作を変更するには、Ontology Manager のアクションタイプのセキュリティと実行条件タブで、ブランチ上での通知を有効にできます。

また、ブランチ上でアクションが実行される際の通知の受信者を指定できます。

  • ブランチ所有者: すべての通知をブランチ所有者に送信します。
  • デフォルトの受信者: 元の通知で設定された受信者に通知します。

ブランチ上で通知を有効にする設定。

既知の制限事項

  • ブランチ上のアクションによる編集はテスト専用であり、main にマージされません。
  • ブランチ上でアクションを実行した場合、デフォルトでは Webhook とメール通知は実行されません。
  • ブランチ上でアクションを実行した場合、外部システムへの呼び出しを行う関数はデフォルトで失敗します。