xconfmanager Command Syntax
The syntax of xconfmanager command that administrators should use is as follows:
xconfmanager {-fFhuwvV} {-r <product_root>} {-d <property_names>} {-s
<property_pair>} {-t <property_file>} {--add <property_pair>} {--remove
<property_pair>} {--reset <property_names>} {--setfromfile <property_file>}
{--undefine <property_names>} {-i <declarative_xconf>} {--validateassite
<site_xconf>} {--validateasdecl <declarative_xconf>} {--validatefilesassite
<site_list_file>} {--validatefilesasdecl <declar_list_file>} {-p}
The brackets ({}) in the syntax indicate optional parameters and indicate parameters that you specify together. The syntax includes only the short version of each parameter name. Parameter names are case-sensitive; enter the names using the case shown in the syntax and the following table.
The following variables are used in the syntax of multiple parameters:
<property_pair> is a command-line escaped name=value pair that is compatible with the specification for java.util.Properties. For an example, see Setting Property Values and Propagating Your Changes.
<property_names> is a comma-separated list of property names.
<property_file> is the relative or full path name of the property file.
<declarative_xconf> is either a full URL or relative file path to the declarative XCONF file.
In the following table, all parameter names are listed in alphabetical order with corresponding parameter descriptions:
Parameter Name
Description
--add
Add the specified value at the end of the set of ordered values already defined in the property. Use this parameter only when the property is declared as a multi-valued property.
To determine if property is multi-valued, you can display the current set of values using the -d parameter. The output from this parameter lists the multivalue separator when the property is multi-valued.
-d
or
--describe
Lists the values that are currently set and the corresponding XCONF file where each value is set for the specified properties.
This parameter executes after all parameter setting options and the -p option have executed.
-F
or
--force
Forces the propagator to ignore its cache of XCONF-to-properties file dependencies and ignore the timestamp comparison it usually does to determine which property files need to be updated. Using this option propagates all site-specific changes to property files.
Use this parameter in place of -p if you suspect that there are problems with file timestamps or you want to switch between the -w and -u options.
-f
or
--forcescan
Forces the propagator to ignore its cache of XCONF-to-properties file dependencies. This parameter is ignored if you specify -F.
Use this option in place of -p if you suspect that the cache is out of date.
-h
or
--help
Displays the help for the xconfmanager command.
-i
or
--install
Installs a declarative XCONF file that you have created. New declarative XCONF files are used when creating additional property files. When you are adding code in which new properties can be set, you can choose to create a separate property file where the properties are stored. For details on what to put in the declarative XCONF file, see Using XCONF Files.
-p
or
--propagate
Propagates all changes that have been made to XCONF files into the property files that are being used. This option always executes after any options that set properties. This execution order ensures that the newly set properties are included in the propagation.
Updated property files are accessed when the Windchill solution is restarted.
-r
or
--productroot
The root directory from which all relative paths are based for XCONF references specified in the declarations.xconf file and target file paths specified in the -t parameter.
The default root directory is the bin directory where the Windchill solution is installed.
--remove
Removes the specified value that is in the set of ordered values defined in the property. Use this option only when the property is declared as a multi-valued property.
To determine if a property is multi-valued, you can display the current set of values using the -d parameter. The output from this parameter lists the multivalue separator when the property is multi-valued.
--reset
Resets the site specific value of a property or set of properties to the declared default values.
-s
or
--set
Sets the named property to a specific value in the site.xconf file.
To set multiple properties in the same target property file, use multiple occurrences of this parameter or use the following parameter:
--setfromfile
To set multiple properties that are in different target property files, enter multiple xconfmanager commands, one for each target file.
Use this parameter in conjunction with the -t parameter.
--setfromfile
Adds the name=value pairs that are in the specified file to the end of the site.xconf file, thus setting each property named to the specified value. There is no checking done to determine if the value set is the default.
<property_file> is the file that contains a set of name=value pairs (one pair per line) that indicate the properties and values you want set in one target property file. Each pair sets a value for one property.
With this parameter, you can set multiple properties in the same target property file using one xconfmanager command. To set properties that are in different target property files, enter multiple xconfmanager commands, one for each target file.
Use this parameter in conjunction with the -t parameter.
-t
or
--targetfile
Identifies the property file in which the property value specified in the -s parameter is set or the property values specified in the following parameter are set:
--setfromfile
Use this parameter in conjunction with either the -s or the following parameter:
--setfromfile
This parameter is optional when setting common properties where the default property file to update has been declared and is available to the xconfmanager utility. For example, properties stored in wt.properties and db.properties do not require this parameter.
For other properties, you may need to specify the file path of the property file in this parameter. For example, updating properties in the federation.properties file requires that you enter this parameter using the codebase/federation.properties file path.
-u|w
or
--unix|win
Indicates the platform for which the property files are to be generated. Normally, the current platform settings determine the format of the property files.
Include this parameter when you want to generate property files for a specific platform that is not the current platform.
For UNIX platforms, specify -u or the following:
--unix
For Windows platforms, specify -w or the following:
--win
--undefine
Resets the specified properties such that their values will be null (instead of an empty string) when read through a java.util.Properties instance.
-v
Turns on verbose console output, which shows full exception stack traces.
-V
Turns on debug verbose console output. This option shows full exception stack traces and additional information.
--validateasdecl
Validates a specific file as a declarative XCONF file.
Returns a non-zero result if file cannot be validated.
--validatefilesasdecl
Validates a list of files as declarative XCONF files. The list is contained in the specified file, where each line in the file is either a full URL or relative file path to a declarative XCONF file.
Returns a non-zero result if any of the files cannot be validated.
<declar_list_file> is either a full URL or relative file path to the file containing the list of declarative XCONF files you want to validate.
--validatefilesassite
Validates a list of files as site-specific XCONF files. The list is contained in the specified file, where each line in the file is either a full URL or relative file path to a site-specific XCONF file.
Returns a non-zero result if any of the files cannot be validated.
<site_list_file> is either a full URL or relative file path to the file containing the list of site-specific XCONF files you want to validate.
--validateassite
Validates a specific file as a site-specific XCONF file.
Returns a non-zero result if file cannot be validated.
<site_xconf> is either a full URL or relative file path to the site-specific XCONF file you want to validate.
* 
The xconfmanager executes the following parameters in the order that they are specified in the command:
-s, --reset, --add, --remove, --undefine
This means that if the same property is set in multiple parameters, the last setting is used.
The xconfmanager always executes the -p parameter after executing the previously listed parameters for setting, resetting, adding, removing, and undefining values. This is done so that all parameter settings are included in the propagation.
Additionally, the xconfmanager always executes the -d parameter after executing the previously listed parameters. This is done so that the descriptions returned include all of the parameter settings made on the command.
È stato utile?