トリガスクリプト変数
トリガスクリプト変数を使用して、データをトリガスクリプトに渡すことができます。 すべてのデータは文字列として渡されます。こうした文字列を適切に解釈または使用することが、トリガの役割です。
STDINおよびSTDOUTを使用してサーバおよびトリガ間で通信を行うこともできます。 詳細については、トリガとサーバ間の通信を参照してください。
maxError…
変数は、オペレーティングシステムのリソースに関する問題などが原因で、サーバでコマンドを実行できなかった状況を示します。 また、クライアント側のエラーがいつもサーバに表示されるとは限らず、maxError
カウントに計上されない場合があることについても注意してください。
terminated
変数は、コマンドが途中で終了したかどうかを示し、termReason
変数は、コマンドが途中で終了した理由を示します。
未知の変数の処理方法が変更されています。 以前のバージョンでは、未知の変数はトリガの起動時に除外されていました。 現在のバージョンでは、未知の変数は除外されません。 これによってトリガ引数の配列が維持されるとともに、使用できると想定されているデータが実際にはそうではない場合にトリガ作成者が問題を解決しやすくなっています。
引数 | 説明 | 適用できるトリガタイプ |
---|---|---|
|
null、またはチェンジリストかジョブに対して行われたアクションを反映する文字列です。 例えば、「 |
|
%archiveList%
|
プルするファイルが含まれているファイル名 | pull-archive
|
|
コマンド引数カウントです。 |
archiveトリガを除くすべてのタイプ |
|
コマンド引数文字列です。 |
archiveトリガを除くすべてのタイプ |
|
コマンド引数文字列です。この文字列の内容は、複数のコマンド引数をパーセントエンコーディングし、カンマ区切りのリストとして配列したものです。 |
archiveトリガを除くすべてのタイプ |
|
サブミットしようとしているチェンジリストの番号です。 短縮形
|
|
|
サブミットされたファイルのルートパスです。 |
|
|
トリガを起動させるユーザのクライアントワークスペース名です。 |
すべて |
|
クライアントの現在の作業ディレクトリです。 |
archiveトリガを除くすべてのタイプ |
|
ユーザのワークステーションのホスト名(プロキシ、ブローカ、レプリカ、エッジサーバを経由して接続する場合も含む。) |
すべて |
|
ユーザのワークステーションのIPアドレス(プロキシ、ブローカ、レプリカ、エッジサーバを経由して接続する場合も含む。) |
すべて |
|
ユーザのクライアントアプリケーション名です。 P4V、P4Winなど。 |
すべて |
|
ユーザのクライアントアプリケーションのバージョンです。 |
すべて |
|
コマンド名です。 |
archiveトリガを除くすべてのタイプ |
%depotName%
|
リポジトリが格納されているグラフディポです。 |
|
%email%
|
ユーザの電子メールアドレスです。 詳細については、「多要素認証(MFA)をトリガする」を参照してください。 |
|
|
ディポの |
|
|
最初の新しいチェンジリストの番号です。 詳細については、「プッシュコマンドおよびフェッチコマンド用のその他のトリガ」を参照してください。 |
|
|
一時フォーム仕様ファイルのパスです。 |
|
|
フォーム名です(例えば、ブランチ名やチェンジリスト番号)。 |
|
|
フォームタイプです(例えば、 |
|
%fullname%
|
ユーザのフルネームです。 詳細については、「多要素認証(MFA)をトリガする」を参照してください。 |
|
|
ユーザが所属しているグループのリスト(スペース区切り)です。 |
archiveトリガを除くすべてのタイプ |
%host%
|
ユーザのホストのIPアドレスです。 詳細については、「多要素認証(MFA)をトリガする」を参照してください。 |
|
|
ブローカやプロキシを示します。 |
archiveトリガを除くすべてのタイプ |
|
ジョブ番号の文字列です。この変数は、 |
|
|
最後の新しいチェンジリストの番号です。 詳細については、「プッシュコマンドおよびフェッチコマンド用のその他のトリガ」を参照してください。 |
|
|
|
archiveトリガを除くすべてのタイプ |
|
エラー番号とエラーメッセージです。 |
archiveトリガを除くすべてのタイプ |
|
ユーザ指定の値です。許容可能な最長のデータベースロック時間を、ミリ秒単位で指定します。 この変数が設定されている場合、ユーザがこの値に関するグループ設定を上書きしたということを意味します。 |
archiveトリガを除くすべてのタイプ |
|
ユーザ指定の値です。コマンド実行中にバッファするデータ量を指定します。 この変数が設定されている場合、ユーザがこの値に関するグループ設定を上書きしたということを意味します。 |
archiveトリガを除くすべてのタイプ |
|
ユーザ指定の値です。1度の操作中にスキャンされる最大行数を指定します。 この変数が設定されている場合、ユーザがこの値に関するグループ設定を上書きしたということを意味します。 |
archiveトリガを除くすべてのタイプ |
%method%
|
list-methodsの認証方法です(「unknown」に設定できます)。 詳細については、「多要素認証(MFA)をトリガする」を参照してください。 | |
%newValue%
|
詳細については、「タイプグラフのディポのトリガ」を参照してください。 | graph-push-reference
|
|
チェンジリストの番号がサブミット時に変更されると、この変数の値は古いチェンジリスト番号になります。 |
|
%oldValue%
|
詳細については、「タイプグラフのディポのトリガ」を参照してください。 | graph-push-reference
|
|
|
|
|
プロキシ、ブローカ、レプリカ、またはエッジサーバを通じてコマンドが送信された場合、プロキシ、ブローカ、レプリカ、エッジサーバのうちいずれかのホスト名を示します。 (コマンドが直接送信された場合、 |
すべて |
|
プロキシ、ブローカ、レプリカ、またはエッジサーバを通じてコマンドが送信された場合、プロキシ、ブローカ、レプリカ、エッジサーバのうちいずれかのIPアドレスを示します。 (コマンドが直接送信された場合、 |
すべて |
|
クライアントが接続するホストのポートです。 クライアントが仲介を通じてサーバに接続する場合、この変数は仲介のポート番号を保持します。 仲介なしで直接サーバに接続する場合、この変数は |
auth-check-sso(クライアント側スクリプトの場合のみ) |
%pusher%
|
プッシュでクレジットを付与されたユーザです。 詳細については、「タイプグラフのディポのトリガ」を参照してください。 |
|
|
二重引用符として使用する文字です。 |
すべて |
%reference%
|
詳細については、「タイプグラフのディポのトリガ」を参照してください。 |
|
%refFlags%
|
||
%refType%
|
||
%repo%
|
拡張子が |
|
%repoName%
|
リポジトリの名前です。 詳細については、「タイプグラフのディポのトリガ」を参照してください。 |
|
|
アーカイブファイルのリビジョンです。 |
|
%scheme%
|
init-authで設定した認証スキームです(「unknown」に設定できます)。 詳細については、「多要素認証(MFA)をトリガする」を参照してください。 | auth-init-2fa
|
|
Helix CoreサーバのIPアドレスおよびポート番号です。 |
auth-check-sso(クライアント側スクリプトの場合のみ) |
|
Helix Coreサーバのホスト名です。 |
すべて |
|
Helix Coreサーバの |
すべて |
|
サーバのIPアドレスです。 |
すべて |
|
Helix Coreサーバの |
すべて |
|
Helix Coreサーバのトランスポート、IPアドレス、ポート番号です。形式は prefix には |
すべて |
|
Helix Coreサーバの |
すべて |
|
サーバの役割を指定する文字列です。 以下のうちいずれか1つをとります。
|
archiveトリガを除くすべてのタイプ |
|
コマンドが早期に終了した場合、中断したサーバのバージョン文字列を示します。 中断の理由は |
archiveトリガを除くすべてのタイプ |
|
該当フォームのスペック行に展開されます。 |
|
%standbyserverid% | フェイルオーバーの前にスタンバイサーバのserverIDにまで拡張します。 | failed-over |
%standbyserverport% | フェイルオーバーの前にスタンバイサーバのP4PORTにまで拡張します。 | failed-over |
|
分散インストール環境ではない場合、 分散インストールでは、すべての変更トリガにおいて以下のことが挙げられます。
コミットサーバとエッジサーバの間で転送中のレプリカが存在する場合は、 『Helix Core P4コマンドリファレンス』の |
|
|
モニタリング対象のターゲットサーバのサーバポート。 P4TARGETまたはp4 heartbeatコマンドで使用される |
|
|
値が |
|
|
早期中断の理由を示します。 以下のうちいずれか1つをとる可能性があります。
|
archiveトリガを除くすべてのタイプ |
%token%
|
init-authフェーズで保存されたトークンです(空になっている場合があります)。 詳細については、「多要素認証(MFA)をトリガする」を参照してください。 | auth-init-2fa
|
%triggerdir%
|
外部ファイル転送のためのトリガでtmpファイルに使用されているPull.trigger.dir | edge-content
|
|
トリガ起動時に実行するコマンドです。 トリガ定義の最後のフィールドです。 ディポからスクリプトを実行する場合に限って設定してください。 |
archiveトリガを除くすべてのタイプ |
|
トリガ定義の第3のフィールドです。 このフィールドの意味はトリガタイプによって異なります。 change-submitトリガの場合、トリガと一致すべきパスです。 form-outトリガの場合、トリガに適用されるべきフォームタイプです。 このフィールドの詳細については、該当するトリガタイプの解説を参照してください。 |
archiveトリガを除くすべてのタイプ |
|
トリガ定義の第1のフィールド、すなわちトリガ名です。 ディポからスクリプトを実行する場合に限って設定してください。 |
archiveトリガを除くすべてのタイプ |
|
トリガ定義の第2のフィールド、すなわちトリガタイプです。 ディポからスクリプトを実行する場合に限って設定してください。 |
archiveトリガを除くすべてのタイプ |
|
トリガを起動させるユーザのHelixサーバユーザ名です。 |
すべて |