環境変数 (GUI)
環境変数は、ユーザー ツールバー ボタンで構成された外部プログラムによってアクセスされます。これらの変数を使用する場合は、変数名を大文字で指定する必要があります。大文字で指定しないと、PTC RV&S Client が変数を認識できません。
次のリストは、開いているウィンドウのそれぞれに関連付けられた環境変数を示します。
すべて
ウィンドウにサーバー接続がある場合は、次の変数が設定されます。
MKSSI_WINDOW
MKSSI_HOST
MKSSI_PORT
MKSSI_USER
アクティブなウィンドウやビューがない場合は、次のように設定されます。
MKSSI_WINDOW=none
アクティブなウィンドウがある場合は、次のように設定されます。
MKSSI_WINDOW=[archive|document|item|items|project|projecthistory|sandbox]
その他の場合は、ウィンドウ固有の値に設定されます。
MKSSI_WINDOW=archive
アクティブなウィンドウが別のウィンドウの場合は、次のように設定されます。
MKSSI_WINDOW=unknown
たとえば、固有の環境変数を生成しない「プロジェクトの変更」ウィンドウの場合は、次のように設定されます。
MKSSI_WINDOW=unknown
 |
値が none および unknown の場合は、その他の変数は設定されません。
|
PTC RV&S ではサーバーに対する複数の接続がサポートされているため、ツールバーからコマンド ライン操作を実行する際には次の環境変数を指定する必要があります。
si <command> --host=$MKSSI_HOST --port=$MKSSI_PORT --user=$MKSSI_USER
ドキュメント
「アイテム」 ウィンドウ タイプと同じです。次のリビジョン変数も指定します。
MKSSI_REVISION_NAME=<revision name>
次に例を示します。1.2
MKSSI_REVISION_DATE=<revision date>
(たとえば、Mon Mar 26 14:53:35 )。
対応するアイテムの「アイテムリビジョン以降の重要な変更」フィールドが true に設定されている場合は、次のように指定します。
MKSSI_REVISION_DELTA=true
|
|
変数 MKSSI_REVISION_NAME、MKSSI_REVISION_DATE、および MKSSI_REVISION_DELTA は、ルート アイテムの情報をエクスポートします。アイテムにリビジョンが適用されていないか、アイテムにリビジョン履歴がない場合、変数はエクスポートされません。 > メニュー オプションで表示されるウィンドウは、「アイテムの編集」ウィンドウと同じ変数をエクスポートします。
|
アイテム
開いている「アイテムの詳細」ウィンドウに対して、次の環境変数が設定されます。
MKSSI_NISSUE=<1>
MKSSI_ISSUE=<ID of selected item>
MKSSI_ISSUE0=<same ID as MKSSI_ISSUE>
MKSSI_REVISION_NAME=<revision name>
(たとえば、1.2 )。
MKSSI_REVISION_DATE=<revision date>
(たとえば、Mon Mar 26 14:53:35 )。
対応するアイテムの「アイテムリビジョン以降の重要な変更」フィールドが true に設定されている場合は、次のように指定します。
MKSSI_REVISION_DELTA=true
|
|
アイテムにリビジョンが適用されていないか、アイテムにリビジョン履歴がない場合、変数はエクスポートされません。
|
アイテムの編集
開いている 「アイテムの編集」 ウィンドウに対して、次の環境変数が設定されます。
MKSSI_ISSUE=<ID of item open for edit>
MKSSI_ISSUE0=<same ID as MKSSI_ISSUE>
MKSSI_REVISION_NAME=<revision name>
(たとえば、1.2 )。
MKSSI_REVISION_DATE=<revision date>
(たとえば、Mon Mar 26 14:53:35 )。
対応するアイテムの「アイテムリビジョン以降の重要な変更」フィールドが true に設定されている場合は、次のように指定します。
MKSSI_REVISION_DELTA=true
|
|
アイテムにリビジョンが適用されていないか、アイテムにリビジョン履歴がない場合、変数はエクスポートされません。
|
アイテム
開いている 「アイテム」 ウィンドウに対して、次の環境変数が設定されます。
MKSSI_NISSUE=<number of MKSSI_ISSUE objects>MKSSI_ISSUE[x]=<ID of selected item>
[x] の値は 0 から始まり、アイテムが選択されるたびに増加します。
MKSSI_QUERY=<current query for Items window>or
MKSSI_QUERY=<queryCreatorName>:<queryName>or
MKSSI_QUERYDEFINITION=<queryDefinition>
MKSSI_NFIELD=<number of columns in view>
MKSSI_FIELD[x]=<display name of each field displayed as columns
in the view>
開いている 「アイテム」 ウィンドウの列構成に対して、次の環境変数が設定されます。
MKSSI_NFIELD=<number of visible fields>
MKSSI_FIELD[x]=<name of each visible field>
[x] の値の範囲は、1 から MKSSI_NFIELD までです。
MKSSI_FIELD[x]_WIDTH=<width of each visible field>
[x] の値の範囲は、1 から MKSSI_NFIELD までです。
MKSSI_SORTFIELD=<name of the field that the view is sorted by>
MKSSI_SORTASCENDING=[true|false]
ビューが昇順で並べ替えられる場合は true、降順で並べ替えられる場合は false。
関連
開いている「関連」ウィンドウに対して、次の環境変数が設定されます。
MKSSI_NISSUE=<number of MKSSI_ISSUE objects>
MKSSI_ISSUE[x]=<ID of selected item>
[x] の値は 0 から始まり、アイテムが選択されるたびに増加します。
MKSSI_REVISION_NAME[x]=<revision name>
(たとえば、1.2 )。
MKSSI_REVISION_DATE[x]=<revision date>
(たとえば、Mon Mar 26 14:53:35 )。
対応するアイテムの「アイテムリビジョン以降の重要な変更」フィールドが true に設定されている場合は、次のように指定します。
MKSSI_REVISION_DELTA[x]=true
|
|
変数 MKSSI_REVISION_NAME[x]、MKSSI_REVISION_DATE[x]、および MKSSI_REVISION_DELTA[x] は、選択されているアイテムのリビジョン情報のみをエクスポートします。[x] の値は 0 から始まり、対応する MKSSI_ISSUE[x] にリビジョンが適用されていない場合にギャップをサポートします。アイテムにリビジョンが適用されていないか、アイテムにリビジョン履歴がない場合、リビジョンに固有の変数はそのアイテムに関してエクスポートされません。
|
メンバー履歴
開いている「メンバー履歴」ウィンドウに対して次の環境変数が設定されます。
MKSSI_FILE=<pathname-relative to project/sandbox of archive>
ウィンドウがサンドボックスから開かれた場合は、次の環境変数が設定されます。
MKSSI_WORKINGFILE=<full-path-to-working-file>
MKSSI_SANDBOX=<full-path-to-sandbox>
MKSSI_PROJECT_CONFIG_PATH=<project-configuration-path-in-the-form
#/Project Name#Subproject Name>
|
|
MKSSI_WORKINGFILE は、ワーク ファイルが存在しない場合は設定されません。
|
ウィンドウがプロジェクトから開かれた場合は、次の環境変数が設定されます。
MKSSI_PROJECT=<server-path-to-project>
MKSSI_PROJECT_CONFIG_PATH=<project-configuration-path-in-the-form
#/Project Name#Subproject Name>
プロジェクトまたはサンドボックスがバリアント プロジェクトまたはバリアント サンドボックスだった場合は、次の環境変数が設定されます。
MKSSI_VARIANT=<variantName>
プロジェクトまたはサンドボックスがビルド プロジェクトまたはビルド サンドボックスだった場合は、次の環境変数が設定されます。
MKSSI_BUILD=<buildNumber>
リビジョンが選択された場合は、次の環境変数が設定されます。
MKSSI_REVISION=<highest revision in selection>
MKSSI_REVISION[x]=<1.2>
つまり、選択された各リビジョンの番号を含む、MKSSI_REVISION1 から MKSSI_REVISION[x] までの n 個の変数があります。
プロジェクト
開いている 「プロジェクト」 ウィンドウに対して、次の環境変数が設定されます。
MKSSI_FILE=<server-side-project-path>
MKSSI_NMEMBER=<number of MKSSI_MEMBER[x] entries>
MKSSI_NSUBPROJECT=<number of MKSSI_SUBPROJECT[x] entries>
MKSSI_PROJECT_CONFIG_PATH=<project-configuration-path-
in-the form #/Project Name>
メンバーが選択されると、次の変数が適用されます。
MKSSI_MEMBER[x]=<path-relative-to-project>
MKSSI_MEMBER_PROJECT[x]=<server-side-project/subproject-path>
MKSSI_MEMBER[x]_PROJECT_CONFIG_PATH=<project-configuration-path-
in-the form #/Project Name#Subproject Name>
サブプロジェクトが選択されると、次の変数が適用されます。
MKSSI_SUBPROJECT[x]=<path-relative-to-project>
MKSSI_SUBPROJECT_PROJECT[x]=<server-side-project/subproject-path>
MKSSI_SUBPROJECT[x]_CONFIG_PATH=<subproject-configuration-path-
in-the-form #/Project Name#Subproject Name>
つまり、n 個のメンバーと m 個のサブプロジェクトが選択された場合は、1 から n までの番号が付いた n 個の MKSSI_MEMBER、番号 n が渡された MKSSI_NMEMBER、1 から m までの番号が付いた MKSSI_SUBPROJECT、および番号 m が渡された MKSSI_NSUBPROJECT があることになります。
サブディレクトリが選択された場合は、そのサブディレクトリが再帰的に展開されたかのように (ディレクトリだけで、サブプロジェクトは含まない)、すべてのメンバーが選択されます。
特定のメンバーが、ビューで開いている最上位のプロジェクトにあるとは限らないため、 MKSSI_MEMBER と MKSS_SUBPROJECT の各変数には、それぞれ対応する MKSSI_MEMBER_PROJECT[x] と MKSSI_SUBPROJECT_PROJECT[x] のエントリがあります。このため、各 MEMBER/SUBPROJECT 変数の相対パスの基準は、PROJECT で示される最上位ではなく、対応する MKSSI_FILE のエントリになります。
次に例を示します。
i=1
while [ $i -le $MKSSI_NMEMBER ]
do
eval si command -P\${MKSSI_MEMBER_PROJECT$i}\${MKSSI_MEMBER$i}
let i=i+1
done
|
|
si command を呼び出すときに --devpath と --projectrevision のオプションを使用すると、環境変数 MKSSI_VARIANT と MKSSI_BUILD もエクスポートされます (設定されている場合)。
|
プロジェクト履歴
開いている 「プロジェクト履歴」 ウィンドウに対して、次の環境変数が設定されます。
MKSSI_FILE=<server-side-project-path>
MKSSI_PROJECT_CONFIG_PATH=<project-configuration-path-in-the-form
#/Project Name>
|
|
MKSSI_REVISION[x] は、メンバー履歴と同じように設定されます。
|
サンドボックス
開いている 「サンドボックス」 ウィンドウに対して次の環境変数が設定されます。
MKSSI_FILE=<full-path-to-sandbox>
MKSSI_NMEMBER=<number of MKSSI_MEMBER objects>
MKSSI_NSUBPROJECT=<number of MKSSI_SUBPROJECT objects>
MKSSI_PROJECT_CONFIG_PATH=<project-configuration-path-in-the-form
#/Project Name>
メンバーが「サンドボックス」ウィンドウで選択されている場合。
MKSSI_MEMBER[x]_PROJECT_CONFIG_PATH=<project-configuration-path-
in-the-form #/Project Name#Subproject Name>
サブプロジェクトが「サンドボックス」ウィンドウで選択されている場合。
MKSSI_SUBPROJECT[x]_CONFIG_PATH=<subproject-configuration-path-
in-the-form #/Project Name#Subproject Name>
MKSSI_SUBSANDBOX[x]=<local-Sandbox-path-of-the-currently-selected-
subsandbox-in-the-form C:\Sandbox Location\Project1\project.pj>
MKSSI_SUBSANDBOX[x]_PARENT=<local-Sandbox-path-of-the-parent-for-the-
currently-selected-subsandbox>
|
|
変数 MKSSI_MEMBER[x]= は、プロジェクト ウィンドウと同じ設定になります。対応する変数 MKSSI_MEMBER[x]_SANDBOX もプロジェクトと同じです。該当する場合は、MKSSI_VARIANT と MKSSI_BUILD も設定されます。
MKSSI_SUBPROJECT[x] の環境変数は、MKSSI_SUBPROJECT[x]_CONFIG_PATH に置き換えられます。MKSSI_SUBPROJECT[x]_SANDBOX の環境変数は、MKSSI_SUBSANDBOX[x] および MKSSI_SUBSANDBOX[x]_PARENT に置き換えられます。
|
登録されているプロジェクト
開いている「登録されているプロジェクト」ビューの場合。
MKSSI_PROJECT[x]_CONFIG_PATH=<project-configuration-path-in-the-form
#/Project Name>
MKSSI_SUBPROJECT[x]_CONFIG_PATH=<subproject-configuration-path-
in-the-form #/Project Name#Subproject Name>
登録されているサンドボックス
開いている「登録されているサンドボックス」ビューの場合。
MKSSI_PROJECT[x]_CONFIG_PATH=<project-configuration-path-in-the-form
#/Project Name>
MKSSI_SUBPROJECT[x]_CONFIG_PATH=<subproject-configuration-path-
in-the-form #/Project Name#Subproject Name>
MKSSI_SUBSANDBOX[x]=<local-Sandbox-path-of-the-currently-selected-
subsandbox-in-the-form C:\Sandbox Location\Project1\project.pj>