Windchill Configuration Assistant を実行する際の ant コマンド構文
Windchill Configuration Assistant を実行するには、次のいずれかの一般形式で ant コマンドを入力します。
ant -f WindchillConfigAssistant.xml -projecthelp
この形式を使用すると、指定可能なメインターゲットの説明が表示されます。
ant -f WindchillConfigAssistant.xml target [-Dinteractive=false] [-Dpropagate=true] [-D<Property>=<Value>]
この形式では、指定したターゲットを実行します。必要に応じて、対話モードを無効にする引数、設定変更を反映する引数、特定のプロパティ値を上書きする引数も指定できます。
1 つ以上の -D<Property>=<Value> 引数を指定して、1 つ以上のプロパティ値を設定できます。設定したプロパティ値は、Windchill Configuration Assistant でデフォルト値の代わりに使用されます。プロパティ値のデフォルトセットは <Windchill>/utilities/wca/Configurator.properties ファイルに保存されます。
WindchillConfigAssistant.xml のターゲット
WindchillConfigAssistant.xml のターゲットは以下のように分類できます。
• 推奨設定値を計算し、それらを中間プロパティファイルに書き込むターゲット。
• 中間プロパティファイルにすでに保存されている変更を反映するターゲット。
• システムを以前の設定に戻すときに使用するターゲット。
• site.xconf ファイルに ConfigurationRef エレメントを追加したり、このファイルから ConfigurationRef エレメントを削除するターゲット。
この後のセクションでは、設定オプションでサポートされているターゲットについて説明します。
推奨値を計算するターゲット
次のリストに、推奨設定値を計算し、それらを中間プロパティファイルへ書き込むときに使用できるターゲットを示します。
|
|
-Dpropagate=true コマンドライン引数を設定した場合、xconfmanager ユーティリティを使用して新しい値が反映されます。
|
-Dinteractive=false コマンドライン引数を設定した場合、推奨値を確認するプロンプトが表示されません。
configureWindchill
次のプロパティの新しい値を計算し、それらを <Windchill>/utilities/wca/conf/windchill/windchillconfigurator.xconf ファイルに書き込みます。
com.ptc.windchill.wca.buildDate
wt.admin.cache.maxDomains
wt.cache.size.AclCache
wt.cache.size.EnumerationDefinitionCache
wt.cache.size.IBADefViewManager$IBADefViewCache
wt.cache.size.IndexListCache
wt.cache.size.PagingSessionCache
wt.cache.size.PreferenceCache
wt.cache.size.RoleAccessCache
wt.cache.size.SessionCache
wt.cache.size.StandardFvService$ActiveFolderCache
wt.cache.size.StandardUfidSrvService$RemoteObjectIdCache
wt.cache.size.StructEnumAttTemplateCache
wt.cache.size.TypeDefinitionCache2
wt.cache.size.WTPrincipalCache
wt.manager.cmd.common.jmx.args
wt.manager.cmd.MethodServer
wt.manager.cmd.MethodServer.java.extra.args
wt.manager.cmd.ServerManager
wt.manager.cmd.ServerManager.java.extra.args
wt.manager.cmd.ServerManager.jmx.args
wt.manager.log.tee
wt.manager.maxHeap
wt.manager.minHeap
wt.manager.monitor.start.MethodServer
wt.method.log.tee
wt.method.maxHeap
wt.method.minHeap
wt.pom.dbConnectionsHardLimit
wt.pom.inClauseBindOptimizationCardinality
wt.pom.inClauseUseBindOptimization
wt.pom.maxDbConnections
wt.pom.minDbConnections
wt.pom.paging.snapshotQueryLimit
wt.pom.queryLimit
wt.pom.refreshCache.size
wt.pom.rowPrefetchCount
wt.pom.statementCacheSize
wt.queue.executeQueues
wt.services/rsc/default/ObjectReferenceCacheTable/ContainerCache.Size/null/0
wt.services/rsc/default/ObjectReferenceCacheTable/ContainerTeamCache.Size/null/0
サーバーマネージャ MBean 設定ファイル (serverManagerMBeanConfig.xm) に保存されている JMX-Administrators リストの現在の内容を読み取ります。さらに、対話モードのときは、最新の設定値をこのリストに書き込むことができます。
configureTomcat
<Windchill>/tomcat/config.properties ファイルに保存されている、次のプロパティに設定する値を指定します。また、最新の推奨設定を含む中間ファイルを生成し、<Windchill>/utilities/wca/conf/tomcat/config.properties に格納します。
mode
mode プロパティの現在の値は、<Windchill>/utilities/wca/conf/tomcat/configproperties.backup に保存されます。
|
|
現在、Tomcat は Embedded Servlet Engine と呼ばれています (Apache Tomcat に基づいています)。
|
設定
以下のターゲットを呼び出します。
configureWindchill
configureTomcat
configure ターゲットを実行すると、それぞれ上記のターゲットを使用して Windchill Configuration Assistant を 2 回実行した場合と同じ結果が得られます。
中間ファイルの値を反映するターゲット
次のリストに、中間ファイルのプロパティ値を反映するときに使用するターゲットを示します。Windchill Configuration Assistant は、xconfmanager ユーティリティを使用して Windchill プロパティを反映します。
|
|
これらのターゲットを実行するには、site.xconf ファイルに ConfigurationRef エレメントが存在する必要があります。
|
これらの反映ターゲットを実行する前に、関連する中間ファイルの有無がチェックされます。必要な中間ファイルが存在しない場合、関連するプロパティ値を反映する前に、それを知らせるエラーが返されます。中間ファイルを生成するターゲットを再実行すれば、この問題を解決できます。
Embedded Servlet Engine (以前の Tomcat) のプロパティは、xconfmanager ユーティリティでは管理されません。初期インストール後の Embedded Servlet Engine インストールディレクトリには、プロパティファイルの config.properties と、ant ビルドスクリプトの config.xml が格納されています。関連する config.properties の値を使用して、テンプレートファイルから Embedded Servlet Engine の設定ファイルが再生成されます。次の (mode プロパティの値を格納している) ファイルは、config.xml スクリプトの実行時に再生成され、それまでに手動で編集した内容が失われます。
<Windchill>/tomcat/conf/web.xml
|
|
ant コマンドで指定されている propagate 引数の値にかかわらず、これらのターゲットは変更を反映します。
|
propagateWindchill
xconfmanager -p -F を呼び出して、<Windchill>/utilities/wca/conf/windchill/windchillconfigurator.xconf の値を Windchill プロパティへ反映します。
メソッドサーバー MBean 設定ファイルの Windchill Configuration Assistant 中間コピーに保存されているメソッドサーバー MBean 設定プロパティを、メソッドサーバー MBean 設定ファイル (<Windchill>/codebase/WEB-INF/methodServerMBeanConfig.xml) にコピーします。
|
|
configureWindchill ターゲットを実行して中間設定ファイルを作成した後、メソッドサーバーの Loader MBean 保存操作を実行してメソッドサーバーを変更した場合、propagateWindchill ターゲットの実行時にそれらの変更が失われます。MBean の変更の永続化については、 Loader MBean を使用した設定変更の永続化を参照してください。 |
メソッドサーバー MBean 設定ファイルの中間コピーに保存されている JMX-Administrators リストの内容を、setEmailList ant ターゲットを使用するすべての JMX-Administrators リストに適用します。電子メールリストおよび
Windchill Configuration Assistant で使用する ant スクリプトについては、
JMX-Administrators リストへの追加を参照してください。
|
|
この操作の結果として、すべての JMX-Administrators リストに同じ電子メールアドレスのリストが格納されます。反映が完了した後でリストを個別に修正するには、JMX クライアントから特定の JMX-Administrators MBean へ移動します。リストを修正したら、Loader MBean を使用して変更内容を永続化します。
|
configureWindchill および configure ターゲットを指定する際、ant コマンドに -Dpropagate=true 引数を追加した場合は、xconfmanager を呼び出して変更を反映できます。propagateWindchill ターゲットを使用する代わりに、-Dpropagate=true 引数を使用できます。
propagateTomcat
中間プロパティファイルの <Windchill>/utilities/wca/conf/tomcat/config.properties に保存されているプロパティ値を、ターゲット Embedded Servlet Engine の config.properties ファイルに反映し、<Windchill>/tomcat/config.xml の configureJspEngine ant ターゲットを実行します。
propagate
以下のターゲットを呼び出します。
propagateWindchill
propagateTomcat
propagate ターゲットを実行すると、それぞれ上記のターゲットを使用して Windchill Configuration Assistant を 2 回実行した場合と同じ結果が得られます。
Windchill Configuration Assistant による設定変更をロールバックするターゲット
以下の表は、Windchill Configuration Assistant によって反映された設定変更をロールバックするときに使用できるターゲットの一覧です。
|
|
推奨値を計算するターゲットを実行するたびに、別々のバックアップファイルが生成されます。Windchill Configuration Assistant は、復元用に作成された最新のバックアップファイルを使用します。ターゲットを実行して設定変更をロールバックする前に、最新のバックアップファイルの値が適切であることを確認してください。
|
|
Target
|
説明
|
|
restoreWindchill
|
configureWindchill ターゲットを最後に実行したときに加えられた変更をロールバックします。<Windchill>/utilities/wca/conf/windchill/windchillconfigurator.xconf の値が、バックアップ値で置換されます。
|
|
restoreTomcat
|
configureTomcat ターゲットの実行時に加えられた変更をロールバックし、バックアップファイルに保存されているプロパティ値に戻します。
|
|
restore
|
以下のターゲットを呼び出します。
restoreWindchill
restoreTomcat
|
|
|
変更をロールバックするとき、ConfigurationRef エレメントは site.xconf ファイルから除去されません。このエレメントを除去する場合は、uninstallConfigRef ターゲットを実行します。
|
site.xconf ConfigurationRef エレメントのターゲット
Windchill Configuration Assistant は site.xconf ファイル内の ConfigurationRef エレメントを使用して、サイトで管理されているプロパティ値 (site.xconf ファイル内のプロパティ値) と、configure ターゲットおよび configureWindchill ターゲットの実行時に設定されるプロパティ値とを関連付けます。
ConfigurationRef エレメントに設定する xlink:href 値は、windchillconfigurator.xconf ファイルの部分パスです。以下に例を示します。
<ConfigurationRef xlink:href="utilities/wca/conf/windchill/windchillconfigurator.xconf"/>
configure ターゲットまたは configureWindchill ターゲットを実行する ant コマンドで -Dpropagate=true を指定した場合、ConfigurationRef エレメントがまだ存在しないときは、site.xconf ファイルにこのエレメントが自動的に追加されます。
propagate または propagateWindchill ターゲットを使用して、windchillconfigurator.xconf ファイルに保存されている値を反映する場合、これらのターゲットを実行する前に、ConfigurationRef エレメントを site.xconf ファイルに追加しておく必要があります。
以下の表は、ConfigurationRef エレメントを追加および削除するときに使用できるターゲットの一覧です。
|
Target
|
説明
|
|
installConfigRef
|
ConfigurationRef エレメントを site.xconf ファイルに追加し、<Windchill>/utilities/wca/conf/windchill ディレクトリに空の windchillconfigurator.xconf ファイルを作成します。
ConfigurationRef エレメントがすでに site.xconf に追加されており、windchillconfigurator.xconf ファイルが存在する場合、このターゲットは正常に実行されますが、何も変更されません。
ConfigurationRef エレメントはすでに site.xconf に追加されているが、windchillconfigurator.xconf ファイルが存在しない場合は、空の windchillconfigurator.xconf ファイルが作成されます。
|
|
uninstallConfigRef
|
ConfigurationRef エレメントを site.xconf ファイルから削除します。
このエレメントが site.xconf ファイルに存在しない場合でも、エラーは返されません。
|
無人モードでの Windchill Configuration Assistant の実行
Windchill Configuration Assistant は、ユーザーと対話的に実行するか、ユーザーの操作を必要とせずに実行できます。デフォルトでは対話モードで実行されます。対話モードの場合、内部ターゲットを実行するたびに、Windchill Configuration Assistant によって計算されたプロパティ値を受け入れるか、上書きするかを確認するプロンプトが表示されます。
Windchill Configuration Assistant を無人モードで実行するには、ant コマンドに -Dinteractive=false を追加します。
ant -f WindchillConfigAssistant.xml target
-Dinteractive=false
無人モードでは、計算されたプロパティ値をユーザーが受け入れたと見なして、それらの値が使用されます。
-Dinteractive=false 引数を使用できるターゲットは以下のとおりです。
configure
configureWindchill
configureTomcat
ant コマンドでその他のターゲットを指定した場合は、実行時に interactive プロパティの値がチェックされません。したがって、-Dinteractive=false 引数は使用できません。
反映モードでの Windchill Configuration Assistant の実行
推奨設定値を計算するターゲットが Windchill Configuration Assistant によって実行されると、新しく計算されたプロパティ名と値のペアが次のファイルに保存されます。
<Windchill>/utilities/wca/conf/windchill/windchillconfigurator.xconf
セクション「site.xconf ConfigurationRef エレメントのターゲット」で説明したように、ConfigurationRef エレメントが site.xconf ファイルに追加されている場合、この XCONF ファイルのプロパティは xconfmanager ユーティリティによってさまざまなプロパティファイルに反映されます。
Windchill Configuration Assistant では、xconfmanager ユーティリティを呼び出して、計算されたすべてのプロパティ値を該当するプロパティファイルへ反映できます。デフォルトでは、Windchill Configuration Assistant は値を反映しません。つまり、有効なターゲットを実行する際、ant コマンドラインで propagate 引数の値を明示的に true に設定しないかぎり、計算されたプロパティ値は反映されません。
Windchill Configuration Assistant を反映モードで実行するには、ant コマンドに -Dpropagate=true を追加します。
ant -f WindchillConfigAssistant.xml target
-Dpropagate=true
-Dpropagate=true 引数を使用できるターゲットは以下のとおりです。
configure
configureWindchill
configureTomcat
ant コマンドでその他のターゲットを指定した場合は、実行時に propagate プロパティの値がチェックされません。したがって、-Dpropagate=true 引数は使用できません。
|
|
無人モードで実行し、同時に反映モードで実行する場合は、-Dinteractive=false 引数と -Dpropagate=true 引数を両方追加できます。
|
|
|
Windchill Configuration Assistant を反映モードで実行した場合、ConfigurationRef エレメントが site.xconf ファイルへ自動的に追加されます (存在しない場合)。installConfigRef ターゲットを実行したかどうかにかかわらず、このエレメントが追加されます。セクション「site.xconf ConfigurationRef エレメントのターゲット」を参照してください。
|
対話モードでの Windchill Configuration Assistant の実行
対話モードで作業している場合、コマンドラインの [input] 行に各推奨値が表示されます。以下に例を示します。
[input] Number of MethodServers to configure (current=1): [2]
現在値が定義されている場合、該当する行に、現在値が括弧で囲まれて表示されます (current=x)。x は現在値です。この例では、現在値は 1 です。
推奨値は、行の最後に大括弧 [ ] で囲まれて表示される値です。この例では、推奨値は 2 です。
一部の入力では、特定の値を指定する必要があります。その場合、入力行の最後に、指定可能な値が括弧で囲まれて表示されます。さらに、このうち推奨値は大括弧 [ ] で囲まれます。たとえば、以下の入力行では、free と total が指定可能な値であり、推奨値は free です。
[input] Allocate Windchill Memory region from total (16378 MB)
or free (10986 MB) physical memory ([free], total)
推奨値を上書きするには、プロンプトに新しい値を入力して Enter を押します。推奨値を使用する場合は、そのまま Enter を押します。
コマンドラインでのプロパティ値の設定
プロパティ値の選択グループを上書きするには、コマンド行に -D<Property>=<Value> 引数を追加します。
Windchill Configuration Assistant によって以下のプロパティが定義されます。したがって、configureWindchill ターゲットの実行時に計算される CPU 数、物理メモリ (メガバイト数)、空きメモリ (メガバイト数)、およびベンダーの値を上書きできます。
CPUCount
physMem
freeMem
vmVendor
指定したプロパティ値が使用されるようにするには、指定したターゲットで計算されたプロパティを指定する必要があります。たとえば、4 つの CPU、8 GB の RAM を搭載したシステムで以下のコマンドを実行すると、CPU、物理メモリ、空きメモリ、およびベンダーの計算値が上書きされます。このコマンドは、16 の CPU、36 GB の RAM、32 GB の空きメモリ、およびベンダーとして IBM Corporation を指定しています。
ant -f WindchillConfigAssistant.xml configureWindchill
-DCPUCount=16 -DphysMem=36000
-DfreeMem=32000 -DvmVendor="IBM Corporation"
デスクトップクラスシステムで実行するコマンドラインで CPUCount、physMem、および freeMem のプロパティ値を設定し、その他の値を計算すれば、それらの値をサーバークラスターゲットシステムで使用できます。
各ターゲットの影響を受けるその他のプロパティのリストについては、セクション「WindchillConfigAssistant.xml のターゲット」を参照してください。
