Sandbox Automation: デプロイ前後トリガー

Sandbox Automation: デプロイ前後トリガー

お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

サンドボックスでは、自動アクションを、主要な展開イベント(プロジェクトの関連付けプロジェクトの同期プロジェクトの展開)の前後に設定できます。これらの自動化は、サーバースクリプトを使用して実装され、検証の実行、ポリシーの適用、追加アクションの自動トリガーを行えます。

自動化の種類   

サンドボックスアクションでは、2種類のスクリプトトリガーに対応しています。
  • 展開前自動化
    • アクション実行前実行されます。
    • 検証や不適切なアクションのブロックに適しています。
  • 展開後自動化
    • アクションが正常に完了した後実行されます。
    • データの同期、外部システムへの通知、クリーンアップ作業の実行に役立ちます。

例:本番環境からサンドボックスインスタンスにプロジェクトを展開する場合を想定します。
  • 展開前:適切な移行元環境と移行先環境が選択されているかを検証し、選択されていない場合は展開を停止します。
  • 展開後:展開が完了すると、メタデータテーブルを同期し、外部システムに通知します。
 

実行フロー   

サンドボックストリガーが開始されると、次の処理が行われます。
  1. アクション前スクリプト(設定されている場合)が最初に実行されます。
  2. その後、システムが主なアクション(プロジェクトの関連付け、同期、展開)を実行します。
  3. 正常に完了し、インスタンスへのインポートが完了すると、アクション後スクリプト(設定されている場合)がトリガーされます。
この順序により、展開前に重要なチェックを実行し、展開後に必要なフォローアップアクションを実施できます。

 

展開前自動化の設定 

  1. 左ペインの設定の歯車アイコンをクリックします。
  2. 次の順に[詳細設定]→[サンドボックス]へ移動し、[展開前自動化]をクリックします。
  3. デフォルトでは、自動化は無効で、すぐにオンに切り替えることはできません
  4. 自動化を有効にするには、[スクリプト]タブで、1つ以上のトリガーイベントを選択します。
    • プロジェクトの関連付け前プロジェクトを関連付ける前、または変更する前にトリガーされます。
    • プロジェクトの同期前:変更をある階層から別の階層に同期する前にトリガーされます(例:本番環境→ステージング)。
    • 展開前:変更が展開キューに追加された後、実際の展開が開始される前にトリガーされます。
  1. 自動化をスクリプトエディターで、CodeX SDKを使用して記述します。
  2. スクリプトを保存するには、[スクリプトを公開]をクリックします。
  3. 最初のスクリプトが公開されると、自動化の切り替えが利用可能になります。必要に応じて有効または無効にできます。



展開後自動化の設定   

  1. 左ペインの設定の歯車アイコンをクリックします。
  2. 次の順に[詳細設定]→[サンドボックス]→[展開後自動化]へ移動します。
  3. 展開前と同様に、自動化の切り替えは最初は無効です。
  4. 展開後自動化を有効にするには、[スクリプト]タブで、トリガーイベントを選択します。
    • プロジェクトの関連付け後:プロジェクトを関連付けた後、または変更した後にトリガーされます。
    • プロジェクトの同期後:変更をある階層から別の階層に同期した後にトリガーされます(例:本番環境→ステージング)。
    • 展開後:展開後にトリガーされます
  1. 自動化ロジックをスクリプトエディターで記述します。
  2. 設定を保存するには、[スクリプトを公開]をクリックします。
  3. 最初のスクリプトが公開されると、以降は自動化の有効化/無効化の切り替えが利用可能になります。


スクリプトの管理   

自動化の編集

  1. トリガーの場所のみを変更した場合、[スクリプトの場所を更新]が表示されるため、そのボタンをクリックします。
  2. スクリプトコード、またはコードと場所の両方を更新した場合、公開するには[スクリプトを公開]を、下書きとして保存して後で公開するには[スクリプトを下書きとして保存]をクリックします。

スクリプトのバージョン

  1. エディターの下にある切り替えボタンを使用して、[下書き]ビューと[公開済み]ビューを切り替えます。

実行ログ   

次の情報を確認するには、[実行ログ]タブに移動します。
  • トリガーされたイベント名
  • 実行ステータス(成功/失敗)
  • スクリプトの実行にかかった時間
  • Codex SDKの呼び出し回数
これにより、自動化のパフォーマンスを追跡し、問題のトラブルシューティングを行えます。







    • Related Articles

    • Sandbox のその他の設定オプション

      お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 リポジトリー内の保存済みの変更の表示 設定の変更内容はリポジトリーに保存されます(実際のユーザーデータではなく、設定データのみ)。保存できるのは、現在のバージョンと前のバージョンとの差分のみです。リポジトリーに保存された設定の変更内容を表示するには、次の手順を実行します。 ...