用于运行 Assistant 的 Ant 命令语法
要运行 Windchill Configuration Assistant,请以下列常规格式之一输入 ant 命令:
ant -f WindchillConfigAssistant.xml -projecthelp
使用此格式显示对可指定主要目标的说明。
ant -f WindchillConfigAssistant.xml target [-Dinteractive=false] [-Dpropagate=true] [-D<Property>=<Value>]
使用此格式执行指定目标,也可以选择性地提供可用于关闭交互模式、传播配置更改和覆盖特定特性值的自变量。
您可以指定一个或多个 -D<Property>=<Value> 自变量,用以设置一个或多个属性值,然后使用这些值替换 Assistant 使用的默认值。特性默认值集存储在 <Windchill>/utilities/wca/Configurator.properties 文件中。
用于 WindchillConfigAssistant.xml 的目标
用于 WindchillConfigAssistant.xml 的目标可分组如下:
• 用于计算推荐配置值并将其写入中间特性文件的目标。
• 用于传播中间特性文件中所存储的更改的目标。
• 用于将系统恢复为先前配置的目标。
• 用于向 site.xconf 文件中添加 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.xml) 中的 JMX-Administrators 列表的现有内容,并且在交互模式下运行时对此列表进行更新。
configureTomcat
确定要为存储在 <Windchill>/tomcat/config.properties 文件中的以下特性设置的值,并在 <Windchill>/utilities/wca/conf/tomcat/config.properties 中生成包含推荐更新的中间文件。
模式
模式特性的当前值保存在 <Windchill>/utilities/wca/conf/tomcat/configproperties.backup 中。
|
Tomcat 现在称为 Embedded Servlet Engine (基于 Apache Tomcat)。
|
configure
调用以下目标:
configureWindchill
configureTomcat
如果使用 configure 目标,则效果将与运行两次 Windchill Configuration Assistant 相同,且每次使用一个已列出的目标。
用于从中间文件传播值的目标
下表列出了可选择用来从中间文件传播特性值的目标。Windchill Configuration Assistant 使用 xconfmanager 实用程序来传播 Windchill 特性。
|
要执行这些目标,site.xconf 文件中必须存在 ConfigurationRef 元素。
|
运行 propagate 目标之前,Assistant 会进行检查以确保存在关联的中间文件。如果所需的中间文件不存在,则 Assistant 在尝试传播相关特性值之前返回一个错误以指示这一情况。要纠正此问题,可以重新运行生成中间文件的相应目标。
Embedded Servlet Engine (以前称为 Tomcat) 特性不由 xconfmanager 实用程序管理。初始安装后,Embedded Servlet Engine 安装目录包含一个名为 config.properties 的特性文件和一个名为 config.xml 的构建脚本。使用相关联的 config.properties 中的值从模板文件重新生成 Embedded Servlet Engine 配置文件。运行 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 目标并创建中间配置文件后,如果运行 propagateWindchill 目标,则由方法服务器 Loader MBean 保存操作执行的任何其他方法服务器更改都会丢失。有关保存 MBean 更改的详细信息,请参阅 使用 Loader MBean 保存配置更改。
|
使用 setEmailList ant 目标,将存储在方法服务器 MBean 配置文件的中间副本中的 JMX-Administrators 列表的内容应用到所有 JMX-Administrators 列表。有关电子邮件列表以及
Windchill Configuration Assistant 所使用的 ant 脚本的详细信息,请参阅
填充 JMX-Administrators 列表。
|
由于执行此操作,所有 JMX-Administrators 列表都将包含相同的电子邮件地址列表。要在完成传播后修改各个列表,可从 JMX 客户端导航至特定的 JMX-Administrators MBean,并在更改列表后使用 Loader MBean 保存这些更改。
|
指定 configureWindchill 和 configure 目标时,如果在 ant 命令中包括 -Dpropagate=true 自变量,则可调用 xconfmanager 传播更改。使用 -Dpropagate=true 自变量即可实现传播,而不是使用 propagateWindchill 目标。
propagateTomcat
将在名为 <Windchilll>/utilities/wca/conf/tomcat/config.properties 的中间特性文件中找到的特性值传播至目标 Embedded Servlet Engine config.properties 文件,并在 <Windchill>/tomcat/config.xml 中执行 configureJspEngine ant 目标。
传播
调用以下目标:
propagateWindchill
propagateTomcat
如果使用 propagate 目标,则效果将与运行两次 Windchill Configuration Assistant 相同,且每次使用一个已列出的目标。
用于回滚通过 Assistant 所做配置更改的目标
下表介绍了可用于回滚 Assistant 所传播的配置更改的目标。
|
每次运行计算推荐值的目标时,Assistant 都会生成单独的备份文件。Assistant 使用创建的最新备份文件进行恢复。在通过运行目标来回滚配置更改之前,请确保最新备份文件中包含您要使用的值。
|
目标
|
说明
|
restoreWindchill
|
取消上次运行 configureWindchill 目标时所做的任何更改。其会使用备份值替换 <Windchill>/utilities/wca/conf/windchill/windchillconfigurator.xconf 中的值。
|
restoreTomcat
|
使用存储在备份文件中的特性值回滚上次运行 configureTomcat 目标时所做的任何更改。
|
恢复
|
调用以下目标:
restoreWindchill
restoreTomcat
|
|
回滚更改不会从 site.xconf 文件中移除 ConfigurationRef 元素;如果要移除此元素,可执行 uninstallConfigRef 目标。
|
用于 site.xconf ConfigurationRef 元素的目标
Assistant 使用 site.xconf 文件中的 ConfigurationRef 元素,在 site.xconf 文件中保存的站点管理特性值和那些因运行 configure 和 configureWindchill 而设置的值之间建立链接。
ConfigurationRef 元素中的 xlink:href 值集是 windchillconfigurator.xconf 文件的部分文件路径。例如:
<ConfigurationRef xlink:href="utilities/wca/conf/windchill/windchillconfigurator.xconf"/>
如果尚不存在 ConfigurationRef 元素,则在执行 configure 或 configureWindchill 目标的 ant 命令中包括 -Dpropagate=true 时,该元素会自动添加到 site.xconf 文件。
如果要使用 propagate 或 propagateWindchill 目标来传播存储在 windchillconfigurator.xconf 文件中的值,则在执行目标前,site.xconf 文件中必须存在 ConfigurationRef 元素。
下表介绍了可用于添加和移除 ConfigurationRef 元素的目标:
目标
|
说明
|
installConfigRef
|
向 site.xconf 文件添加 ConfigurationRef 元素,并在 <Windchill>/utilities/wca/conf/windchill 目录中创建一个 windchillconfigurator.xconf 空文件。
如果 ConfigurationRef 元素已添加到 site.xconf 且 windchillconfigurator.xconf 文件已存在,则目标会成功完成,但不会做出任何更改。
如果 ConfigurationRef 元素已添加到 site.xconf 但 windchillconfigurator.xconf 文件尚不存在,则创建一个 windchillconfigurator.xconf 空文件。
|
uninstallConfigRef
|
从 site.xconf 文件中移除 ConfigurationRef 元素。
如果 site.xconf 文件中不存在该元素,不会返回任何错误。
|
在自动模式下运行 Windchill Configuration Assistant
无论是否存在用户交互,Windchill Configuration Assistant 都可进行运行。默认情况下,Assistant 以交互模式运行。在交互模式下,Assistant 每次运行内部目标时,都会提示用户接受或覆盖它所计算得到的特性值。
要在自动模式下运行 Assistant,ant 命令中应包含 -Dinteractive=false:
ant -f WindchillConfigAssistant.xml target
-Dinteractive=false
在自动模式下,Assistant 假定用户接受计算所得的特性值,因此会使用这些值。
-Dinteractive=false 自变量对以下目标有效:
configure
configureWindchill
configureTomcat
如果在 ant 命令中指定其他目标,则 Assistant 运行时不检查 interactive 特性的值。因此,不使用 -Dinteractive=false 自变量。
在传播模式下运行 Windchill Configuration Assistant
当 Windchill Configuration Assistant 运行用于计算推荐配置值的目标时,其会将更新后的特性名称/值对存储在具有如下名称的文件中:
<Windchill>/utilities/wca/conf/windchill/windchillconfigurator.xconf
如果 ConfigurationRef 元素已添加到 site.xconf 文件,如“用于 site.xconf ConfigurationRef 元素的目标”一节所述,则该 XCONF 文件中的特性可通过 xconfmanager 实用程序传播至受其管理的各种特性文件。
Windchill Configuration Assistant 中有一个选项可用于调用 xconfmanager 实用程序,以将计算所得的全部特性值传播到相应特性文件。默认情况下,Windchill Configuration Assistant 不会传播值;因此,除非在执行有效目标时将 ant 命令行中的 propagate 自变量明确设置为“真”,否则不会传播计算所得的特性值。
要在传播模式下运行 Assistant,ant 命令中应包含 -Dpropagate=true:
ant -f WindchillConfigAssistant.xml target
-Dpropagate=true
-Dpropagate=true 自变量对以下目标有效:
configure
configureWindchill
configureTomcat
如果在 ant 命令中指定其他目标,则 Assistant 运行时不检查 propagate 特性的值。因此,不使用 -Dpropagate=true 自变量。
|
如果要同时在自动和传播模式下运行,可包含 -Dinteractive=false 和 -Dpropagate=true 这两个自变量。
|
|
如果在传播模式下执行 Windchill Configuration Assistant,将自动向 site.xconf 文件添加 ConfigurationRef 元素 (如果尚未存在)。无论 installConfigRef 目标是否运行,都会执行这一添加操作。请参阅“用于 site.xconf ConfigurationRef 元素的目标”一节。
|
在交互模式下运行 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)
要覆盖推荐值,可在提示符处输入新值,然后按“返回”。要接受推荐值,只需按“返回”。
设置命令行中的特性值
在命令行中包含 -D<Property>=<Value> 自变量可以覆盖选定的属性值组。
Assistant 中定义了以下特性,用以覆盖运行 configureWindchill 目标时计算而得的 CPU 计数、物理内存 (MB)、空闲内存 (MB) 和厂商值:
CPUCount
physMem
freeMem
vmVendor
要使用指定特性值,指定特性必须是通过指定目标进行计算的特性。例如,在包含 4 个 CPU 和 8GB 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 特性值,Assistant 可以计算出其他值并随后用于服务器级目标系统中。
有关受每个目标影响的其他特性的列表,请参阅“用于 WindchillConfigAssistant.xml 的目标”一节。