注: 以下の翻訳の正確性は検証されていません。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 とメール通知は実行されません。
  • 外部システムを呼び出す関数は、ブランチ上でアクションを実行した場合、デフォルトでは失敗します。