| OracleÆ AutoVue for Agile PLM Installation and Configuration Guide Release 21.0.1 E71169-02 |
|
 Previous |
 Next |
| OracleÆ AutoVue for Agile PLM Installation and Configuration Guide Release 21.0.1 E71169-02 |
|
Previous |
Next |
You can configure the AutoVue server by modifying jvueserver.properties located in the <AutoVue for Agile PLM Install Root>\bin directory. For example, the following sections describe options that can be configured if you wish to modify the ports that the AutoVue server is running on, or if you wish to set up a server farm or perform any other server configuration.
|
Note: You must restart the AutoVue server for the changes in jvueserver.properties to take effect. |
The option allows you to indicate that the AutoVue server has authentication enable and that users must enter login credentials in order to gain access to the server.
If you rename your server machine name after you install AutoVue, you must update this parameter:
jvueserver.hostname = [host name]
|
Note: This new server hostname must be properly reflected in the JVUESERVER parameter specified in the VueServlet descriptors that point to this server. You must set the correct static or resolvable IP address or hostname or fully-qualified hostname (FQDN) in the file jvueserver.properties. |
This section provides RMI and socket port parameters that may be configured. For example, the RMI port may need to be configured when setting up an AutoVue server farm, and the socket port may need to be modified to meet company policy requirements on the usage of ports within a certain range.
Table B-2 RMI and Socket Port Options
| Parameter | Description | Default |
|---|---|---|
|
jvueserver.rmi.objectPorts = [2020-2029] |
Specify a range of ports to use, or leave commented for automatic allocation. |
|
|
jvueserver.socket.timeout=<integer> |
Specify the inactive time in seconds after which socket times out. When 0, there is no timeout. |
0 |
|
jvueserver.rmi.port = <port value> |
The RMI port can be used to communicate with other servers when AutoVue is set up in a server farm. In certain situations you may need to modify the RMI port. For example, you must modify the port when the default port is used by other applications or when a company policy requires the usage of ports within a certain range. Note: These port numbers are not related to the HTTP port used by the Web server. AutoVue uses n+1 consecutive ports starting from the base RMI port, where n is the processPoolSize value specified in jvueserver.properties. You should verify that the required port is open and not in use by any other process. The |
1099 |
|
jvueserver.socket.port = <port value> |
In certain situations you may need to modify the socket port. For example, you must modify the port when the default port is used by other applications or when a company policy requires the usage of ports within a certain range. This new socket port needs to be properly reflected in the JVUESERVER parameter specified in the VueServlet descriptors that point to this server. Note: This port number is not related to the HTTP port used by the Web server. AutoVue uses n+1 consecutive ports starting from the base socket ports, where n is the processPoolSize value specified in jvueserver.properties. You should verify that the required port is open and not in use by any other process. The netstat -a program displays which ports are in use. |
5099 |
|
jvueserver.ssl.enable= [TRUE|FALSE] |
Specify whether to enable/disable secure socket (SSL) connections for the server. This property is required when SSL connection is enabled for the VueServlet. Set to FALSE to disable SSL connections for the server. Set to TRUE to enable SSL connections for the server. |
TRUE |
The AutoVue server can run in a process pool on a single machine. The default process pool (DocServer) size is 4, and is set in the jvueserver.properties file.
Table B-3 Process Pool Size Option
| Parameter | Description | Default |
|---|---|---|
|
jvueserver.processPoolSize = [integer] |
Set the process pool size to specify the number of DocServers to run when the AutoVue server starts up. |
4 |
Creating a process pool helps improve the responsiveness when handling simultaneous connections and also helps balance the load across processors in a multi-CPU machine. As a rule of thumb, you should allow for a minimum of 200MB for each process in a pool, of which approximately 50MB is for the JVM and 128MB for the Java heap. As a result, a process pool size of 4 requires at least 1GB of RAM on the machine to run comfortably. The load is balanced across the pool on the single machine.
File viewing requires memory on top of the amount for each process in the pool. Depending on the number of users and files loaded at any given time, the recommended minimum is 2GB per DocServer. Provisioning for 2GB of memory per process in the pool should be expected.
|
Note: Do not modify the DocServer memory settings in jvueserver.properties. |
If the machine hosting the AutoVue server uses a proxy server to connect to the Internet, you must set the proxy setting to allow the request to go through. For example, AutoVue must connect to the Internet to retrieve required resources if missing from a file. To do so, the proxy server name must be specified in jvueserver.properties.
|
Note: If AutoVue is integrated with a DMS, you must also set the proxy setting to allow requests to go through as all machines on the internal network must pass through the proxy server. |
jvueserver.http.proxyhost=my.proxyserver.com:80
jvueserver.ftp.proxyhost=my.proxyserver.com:80
Replace my.proxyserver.com with the name of the proxy server running on the server and the port with the appropriate port number.
This section provides streaming files parameters that may be configured. By setting these parameters, you can specify whether to allow streaming file generation, the maximum lifetime of streaming files, and much more.
Table B-4 Streaming File Options
| Parameter | Description | Default |
|---|---|---|
|
jvueserver.metacache.enable = [TRUE | FALSE] |
Specifies whether to generate streaming files. When set to TRUE, streaming files are stored in the location specified by the jvueserver.cache.directory parameter. When set to FALSE, streaming files are not generated. Note: Streaming file generation is not supported for PDF Portfolio files. |
TRUE |
|
Note: The following options can be set if jvueserver.metacache.enable=TRUE. |
||
|
jvueserver.metacache.pdf.enable = [TRUE | FALSE] |
Set to FALSE: Streaming file is not generated for PDF. Set to TRUE: Streaming file is generated for PDF files. This configuration parameter should be set manually. It is recommended to set this option to FALSE as there is no benefit to enabling streaming files for PDF. |
FALSE |
|
jvueserver.dms.save.metafile = [TRUE | FALSE] |
Specifies whether or not streaming files are saved in the DMS. Set to TRUE to save streaming files in DMS. Set to FALSE so that streaming files will not be saved in DMS. |
TRUE |
|
jvueserver.metacache.process = [TRUE | FALSE] |
Flag for using a separate process for streaming file generation. If set to FALSE, the DocServers handle streaming file generation and the dedicated streaming file process does not start. |
TRUE |
|
jvueserver.metacache. threshold = [non-negative integer] |
Specifies the DocServer threshold at which the streaming file DocServer handles the generation of streaming files. jvueserver.metacache.process must be TRUE for this option to take effect. Increasing this value allows the DocServer that loads a file to generate the streaming file. By default, the threshold is set to 0. That is, the streaming file DocServer generates the streaming files for all documents. |
0 |
|
jvueserver.cache. directory=[directory path] |
Specifies in which directory the cached files should be saved. A central cache information file named cache.map is stored in the same directory. By default, the directory is the Cache subdirectory of the AutoVue server program directory. |
<AutoVue Install Root>\bin\Cache |
|
jvueserver.cache. forceascii=[0|1] |
Set to 1 to force the use of ASCII characters in cached files names. Set to 0 to leave characters as is. For example, you may want to use force ASCII characters if the server does not support file names with Unicode characters. |
0 |
|
jvueserver.cache.size=[value in MB] |
Specifies, in Megabytes, the maximum size of the file cache. The default value is 20GB. If not specified, or if value specified is less than 50 MB, a value of 4GB will be used. |
20480 |
|
jvueserver.cache. maxlifetime = [number of days] |
Specifies the maximum number of days a file is kept in the AutoVue cache directory. When the maximum life time is reached, the file is deleted from the cache directory. Note: The minimum value is 1. |
30 |
|
jvueserver.metacache.zipfile.enable = [TRUE|FALSE] |
Specifies whether to generate streaming files from ZIP files. If set to TRUE, then streaming files are generated. If set to FALSE, no streaming files are generated. Note: This option will only take effect when the jvueserver.metacache.enable option is set to TRUE. Only one streaming file is allowed for a ZIP file. It is recommended that this setting is left unmodified when the deployment is integrated with a DMS. |
FALSE |
|
jvueserver.cache. maxnumfiles= [value ] |
Specifies the maximum number of files allowed in the AutoVue cache directory. When the threshold is reached, the least recently used files are deleted. Note: The minimum value is 1000. |
64000 |
This section provides DMS parameters than may be configured. However, we recommend that you do not modify these parameters.
Table B-5 DMS Options
| Parameter | Description | Default |
|---|---|---|
|
dms.save.compress=[TRUE|FALSE] |
Set to TRUE to compress save data transmitted to the DMS. Note: We recommend that you do not modify this parameter. |
TRUE |
|
dms.save.length= [TRUE|FALSE] |
Set to TRUE so that the multipart save requests contain content length. Note: We recommend that you do not modify this parameter. |
FALSE |
|
Note: These options will be deprecated in the next release of AutoVue. |
When using the collaboration feature in AutoVue for Agile PLM, you can configure the following parameters.
For example: You may choose to enable the collaboration feature on the server, and/or you can specify the protocol to use for collaboration.
Table B-6 Collaboration Options
| Parameter | Description | Default |
|---|---|---|
|
jvueserver.collaboration.dmsargsfilter=<regex> |
This option filters out sensitive DMS arguments from the DocID that is passed to collaboration session guests. <regex>: The Java-style regular expression matching the entire DMS argument name. It is not case sensitive. |
.*(SESSION|USERNAME|PASSWORD).* |
|
jvueserver.collaboration.enable = [TRUE | FALSE] |
Set to TRUE to enable collaboration mode on the server. Set to FALSE to disable collaboration mode. Note: If not using Real-Time Collaboration, set this parameter to FALSE. |
FALSE |
|
jvueserver.collaboration.tcp.port=[integer] |
BaseTCP port to be used. Note: The configuration parameters below need to be changed when using more than one server cluster in a server farm. |
9700 |
|
jvueserver.collaboration.id.min=[integer] |
Minimum ID given to users and collaboration sessions by this server. Change this ID when you are running many AutoVue servers that must communicate together for collaboration. The second server must have a minimum ID of at least jvueserver.collaboration.id.min + jvueserver.collaboration.id.range of the first server. Otherwise, an ID overlap may occur. |
0 |
|
jvueserver.collaboration.id.range=[integer] |
Range of IDs given to users and collaboration sessions by this server. This will limit the number of simultaneous connections. |
100000 |
This section provides log4j and diagnostics parameters that may be configured. These parameters can be set to configure the logging level and time interval for detecting log4j configuration changes, and the output diagnostics information.
Table B-8 Log4j and Diagnostics Options
| Parameter | Description | Default |
|---|---|---|
|
jvueserver.log4j.configureandwatch = [TRUE | FALSE] |
Set this to TRUE to be able to dynamically change the log4j logging level. |
FALSE |
|
jvueserver.log4j.configureandwatch.delay =[integer] seconds |
Time interval for waking up and detecting log4j configuration change. |
60 |
|
jvueserver.diagnostics.format=[xml|text] |
Specify the output format for the AutoVue server diagnostics. |
xml |
|
jvueserver.diagnostics.period=[interval in minutes] |
Specify the interval in minutes at which the AutoVue server diagnostics are generated. |
No default; diagnostics are generated on demand. |
This option allows administrators to define which INI options cannot be modified using JavaScript.
Table B-9 Modified with JavaScript Option
| Parameter | Description | Default |
|---|---|---|
|
jvueserver.profile.options. filter= <INI option> |
This option allows administrators to define which INI options under the [OPTIONS] section cannot be modified using JavaScript. The option takes a regular expression string. Example: The default value for the option is "(XREFPATHS|XFONTPATHS|BKIMAGES)", which means that both XREFPATHS, XFONTPATHS and BKIMAGES cannot be modified using JavaScript. |
(XREFPATHS|XFONTPATHS|BKIMAGES) |
|
jvueserver.profile.markups.filter= <INI option> |
This option allows administrators to define which INI options under the [MARKUPS] sections cannot be modified using JavaScript. The option takes a regular expression string. Example: The default value for the option is "SIGNOFFFILE", which means that SIGNOFFFILE cannot be modified using JavaScript. |
SIGNOFFFILE |
The following table describes the reboot parameter for DocServers in jvueserver.properties. By setting this parameter, you can control the reboot time interval for DocServers.
The following table describes the DocServer timeout parameter for DocServers in jvueserver.properties. By setting this parameter, you can control the hang logs generation time interval for DocServers.
Table B-11 DocServer Timeout Option
| Parameter | Description | Default |
|---|---|---|
|
docserver.timeout=N (minutes), ClassName |
Specify the timeout in minutes after which the AutoVue server hang logs are generated. It is possible to implement a custom action to invoke a hang situation. When implemented, replace ClassName with the name of the class implementing the custom action. |
10 |
The following table describes the recovery attempt parameter in jvueserver.properties. By setting this parameter, you can control the number of recovery attempts for the DocServer.
The following table describes the extra libraries parameter that allows you to specify user-defined DLLs:
On start up, AutoVue registers all of its components into a VueServer.ini file. You can specify an alternate path for VueServer.ini using this option.
Table B-14 File Format Information Option
| Parameter | Description | Default |
|---|---|---|
|
jvueserver.inifile =[file name] |
Specify the INI file where AutoVue stores information on the file formats supported by AutoVue. By default, it is VueServer.ini located in the <AutoVue Install Root>\bin directory. Note: AutoVue saves certain memory management settings in this file. We recommend that you do not modify these options or the file. |
VueServer.ini |
The following global user settings may be configured. These parameters specify the directory in which user information is stored, and the names for global configuration files.
Table B-15 Global User Options
| Option | Description | Default |
|---|---|---|
|
jvueserver.users.directory |
Contains the directory in which user information is stored (initialization files and GUI files). |
<AutoVue installation directory>\bin\Profiles |
|
jvueserver.users.defaultini |
AutoVue provides a way to push certain INI settings to the user INI the first time the user accesses AutoVue. This is done by setting the required options in the default.ini file or in the file specified by jvueserver.users.defaultini parameter. This file should be located at <AutoVue installation directory>\bin directory. |
default.ini |
|
jvueserver.users.allusersini |
AutoVue provides a way to push INI settings to the user profile every time a user accesses AutoVue. This is done by setting required options in allusers.ini (or the files specified by jvueserver.users.allusersini). This file should be at <AutoVue Installation Directory>\bin directory. |
allusers.ini |
|
jvueserver.users.timeout=[interval in seconds] |
Specify the user session timeout in seconds. If the user session is idle for the specified time period, the session is closed. |
1800 |
You can configure the Markup Files dialog, Markup Files directory, permissions, and markup symbols library by setting the following options.
Table B-16 Markup Options
| Option | Description | Default |
|---|---|---|
|
jvueserver.markup.nativegui.type |
Add Author, Date, and Markup Info columns to the Markup Files dialog. 0: Name column displays 1: Enable Author 2: Enable Date 4: Enable Markup Info Note: These are ORed flags. For example: Enter 7 to enable all three columns. |
0 |
|
jvueserver.markups.directory |
Specifies in which directory the Markup files should be saved. Markups are saved with random names in this directory, and the mapping between Markup files and their base file is held in a central map file named markups.map, stored in the same directory. Note that multiple servers should not share the same location for storing markups. Note: This option is for server-managed markups. |
<AutoVue Install Root>\bin\Markups |
|
jvueserver.markups.permissions |
By default, all users can see the Markups of a file but only the owner of a Markup can modify it. The Permissions key can be used to change that behavior. Setting it to 0 allows all users to see and change Markup files. Setting it to 1 prevents all users from modifying the Markups. |
1 |
|
jvueserver.markups.symbols.directory |
Specifies in which directory the Markups symbol libraries are stored. By default, the directory is the symbols subdirectory of the AutoVue server program directory. |
<AutoVue Install Root>\bin\Symbols |
You can specify the entry points for language-specific Online help by setting the following options.
Table B-17 Online Help Options
| Option | Description |
|---|---|
|
jvueserver.help.file_en |
Entry specifies the URL to the English Help file. If Online Help does not exist for a language, AutoVue loads the English help file by default. |
|
jvueserver.help.file_xx |
Entry specifies the URL to the Help file for the language "xx." |
AutoVue performs memory management when loading large files. If AutoVue memory hits a pre-defined threshold, AutoVue dumps the least recently used data from memory to the disk. This memory management scheme helps load larger models in AutoVue. Memory management is enabled by default. To disable it, you must set jvueserver.memory.managed=FALSE in jvueserver.properties. Refer to the following table for all memory management-related configurations.
In jvueserver.properties, you can set the following parameters to optimize memory or performance speed.
Table B-18 Memory Optimization
| Parameter | Description | Default |
|---|---|---|
|
jvueserver.memory.managed = [TRUE | FALSE] |
This option orients the optimization in the product towards speed or memory. If set to FALSE, speed is optimized. If set to TRUE, memory is optimized. Setting this option to TRUE does not impact the loading of Office and Raster formats. Note: When this option is set to TRUE, AutoVue's memory manager dumps the least recently used components from memory onto disk when the process memory hits the threshold specified in jvueserver.memory.threshold. Effect on Performance: Performance speed is improved if value is set to FALSE. If loading large files, or files that require a lot of memory, we recommend that you set the option to TRUE to optimize memory usage. |
TRUE |
|
jvueserver.memory.threshold=value |
Specifies the process memory threshold for AutoVue after which the memory manager dumps data. Specify value in MB. When set to 0, AutoVue calculates the memory threshold based on the following formula: [(Total memory on the machine)/(n+1 where n is processpoolsize)]*1.2 The computed value does not exceed 1GB or the maximum memory size addressable for the process on the system multiplied by 0.8, whichever is less. Note: Minimum value is 256MB Effect on Performance: Performance speed is improved when the threshold is a larger value. To optimize memory usage, set a lower threshold. |
0 |
AutoVue programmatically writes certain memory management options in VueServer.ini. These options should not be modified:
Table B-19 Memory Management Options (Not to be Modified)
| Parameter | Description | Default |
|---|---|---|
|
MNGMEMPAGESIZE=[num] |
When memory management is enabled, specify the size of pages (memory) to allocate when storing the managed data. Each memory page is predefined. num = number of bytes used to allocate pages in memory. Minimum value: 8192 (8KB) Maximum value: 1048576 (1MB) Note: The memory pages are dumped to temporary dumping files located in the path defined in MNGTEMPFNAME. |
131072 (128KB) |
|
MNGTEMPFNAME=[folder location] |
When memory management is enabled, specifies the location and name of the temporary dumping folder. If the temporary dumping folder does not exist, the folder is created and marked for deletion. |
<AutoVue Install Root>\bin\avdump |
The following section lists Linux-specific parameters that can be configured in jvueserver.properties.
|
Note: It is not recommended that you change these options. The AutoVue installer will configure these options to values that is appropriate for your system. These options should not be modified unless there are particular constraints for your deployment. |
The following table describes java class preload parameter in jvueserver.properties.
AutoVue provides the following options to initialize Xvfb parameters. It is not recommended that you change these options.
Table B-21 Xvfb Options
| Option | Description | Default |
|---|---|---|
|
xvfb.display=<port number> |
Specifies the initial port to use for Xvfb. In the event of a port conflict, modifying xvfb.display may resolve the issue. |
909 |
|
xvfb.process |
Specifies the name of process to start or kill Xvfb process. |
Xvfb |
|
xvfb.policy |
If set, this contains path name to security policy file, used with Xvfb -sp option when the Xvfb process is started. Note: This is applicable for Linux 5.x. |
|
|
xvfb.colormap |
If set, this contains path name to color map file, used with Xvfb -co option when the Xvfb process is started. Note: This is applicable for Linux 5.x. |
|
|
xvfb.args |
These are arguments to be passed to Xvfb when it is started. Note that the default setting runs Xvfb on a non-listening port. |
-nolisten tcp -cc 4 -screen 0 1280x1024x24 -pixdepths 1 8 15 16 24 32 |
|
xvfb.new=[0|1] |
Startup parameter. Set to 1 on Oracle Enterprise Linux (OEL) 6 and Red Hat Enterprise Linux (RHEL) 6 and above. Set to 0 on Oracle Enterprise Linux (OEL) 5 and Red Hat Enterprise Linux (RHEL) 5. |
0 for OEL 5 and RHEL 5 1 for OEL 6 and RHEL 6 |
The following table describes VueServlet initialization parameters that can be set in webdefault.xml when deploying on Jetty. If a context has a webdefault.xml descriptor, it is applied before the context’s own web.xml file. For more information, refer to section .
Table B-24 VueServlet Initialization Parameters
| Parameter | Description | Default |
|---|---|---|
|
DebugLevel=[0-100] |
Set the debug output category. Values: 0: no logging10: basic logging20: HTTP connection information100: debug |
0 |
|
EnableSSL=[TRUE|FALSE] |
Set to TRUE to enable secure socket connection to the AutoVue servers. |
TRUE |
|
EnableEM=[TRUE|FALSE] |
Specify whether or not to retrieve Oracle Enterprise Management information. Set to TRUE to retrieve information. Set to FALSE to disable information retrieving. |
FALSE |
|
JVueServer=[server hostnames] |
A semicolon separated list of the AutoVue server host names. This parameter is used by the VueServlet to connect to the AutoVue servers through a socket connection. The JVueServer parameter needs to be set to the hostname:port value used when starting the AutoVue server. This port value must match the port set in jvueserver.properties. You can specify more than one hostname:port separated by semi-colons (;) for fail-over. In other words, if one machine is down the servlet will try the next machine. If JVueServer is not specified, it defaults to localhost:5099. The servlet assumes that the AutoVue server is running on the same machine as the Web server and communicates through port 5099. Note: The port listed in this option should match the port listed in the jvueserver.socket.port option in the jvueserver.properties file. |
local hostname:5099 |
|
InvokerCount=[value] |
Set the number of simultaneous connections from the VueServlet to the AutoVue server. If the number of pending requests at any given time exceeds this set value, then the remaining requests wait in a queue until a connection is free. Note: If this parameter is set too high, then it will cause an overload of requests and result in no connections being made. |
100 |
|
ServerInfo=[TRUE|FALSE] |
Set to TRUE to include the AutoVue server information on VueServlet status page. Set to FALSE to hide the AutoVue server information. |
FALSE |
