| 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 |
This chapter describes how to install AutoVue for Agile PLM on Windows and Linux OSes. The AutoVue for Agile PLM installer updates the Agile PLM Application Server and File Manager components for Agile PLM version 9.3.6, 9.3.5, 9.3.4, and 9.3.3 on all platforms. It also installs the AutoVue server component on Windows or Linux.
|
Note: When upgrading your installation of AutoVue for Agile PLM, do not cancel the installation process once it has begun. Canceling the installation may leave your current installation of AutoVue for Agile PLM unusable. |
You must run the AutoVue for Agile PLM installer on the application server and all File Managers as well as the machine where you wish to install the AutoVue server. Select the AutoVue Server option in the installer if you wish to install the AutoVue server, and select the AutoVue Client Libraries option if you are running the installer on an application server or File Manager. If it is required to install the AutoVue server on the same machine with the application server and File Manager, then both the AutoVue Server and the AutoVue Client Libraries options must be selected in the installer.
|
Note: Before updating the AutoVue client libraries, ensure that you stop the file server and any additional Agile processes. |
The following sections discusses upgrading AutoVue from earlier versions.
If you are upgrading from AutoVue for Agile PLM 20.2.x/21.0.0, you do not need to run the uninstaller before you install AutoVue for Agile PLM 21.0.1. You can just run the installer for AutoVue for Agile PLM 21.0.1. The installer detects if AutoVue for Agile PLM 20.2.x/21.0.0 is installed on your machine. If it is installed, the installer backs up required data, uninstalls version 20.2.x/21.0.0 and then installs 21.0.1 to the same location. If you already have 20.1.x/20.2.x, with codebase (client JAR files) set in Jetty, the installer will upgrade to AutoVue for Agile PLM 21.0.1.
If installing on a Linux OS, make sure you have the correct version of WINE installed. The version of WINE compatible with AutoVue for Agile PLM 21.0.1 is wine-av-20040914-24.i386.rpm. You can download this version of WINE from http://oss.oracle.com/AutoVue.
|
Note: It is recommended to delete all cached and streaming files when updating AutoVue for Agile PLM. |
Below is the list of data that is migrated if you are upgrading:
Settings in jvueserver.properties are migrated to the new version.
The installer upgrades the previous configuration settings from allusers.ini and jvueserver.properties when you install the new version.
Any changes made to default.ini and allusers.ini are migrated to the new version.
AutoVue for Agile PLM user profiles are left as is.
The following are left as is since they are read by the new version of AutoVue:
Server-managed markups
Any stamps and stamp libraries
Intellistamps and definitions
On Linux, changes made to <AutoVue for Agile PLM Install Root>/config/jvuew_config are left as is since this will be read by the newer version of AutoVue.
Custom log settings: If you had custom log settings, these are migrated to the newer version of AutoVue for Agile PLM.
Changes made to markup policy file – markuppolicy.xml are migrated to the newer version of AutoVue for Agile PLM.
Any changes made to format-specific files such as color maps, font maps, fonts are migrated to the newer version.
The following are not migrated and must be migrated manually:
GUI files: If you created custom GUI files, you must make sure to migrate the GUI settings. In order to migrate GUI, it is recommended that you run a diff utility between your current version's default.gui and your custom GUI. Identify what GUI components have been updated. Manually apply these settings to 21.0.1 GUI file.
If you are upgrading AutoVue for Agile PLM from version 20.1.x or earlier, you must manually move your configuration settings from your version to AutoVue for Agile PLM 21.0.1. You must first uninstall any service packs that are installed for that version of AutoVue for Agile PLM and then uninstall your previous version before installing the new version of AutoVue for Agile PLM. Before you uninstall, you must backup all required data. After you install 21.0.1, you must migrate your past data to 21.0.1. Below is what you need to backup and migrate manually:
Custom settings in jvueserver.properties
Custom settings in VueServer.ini. As of version 20.1, settings in VueServer.ini have been migrated to jvueserver.properties. Refer to the Oracle AutoVue 20.1 Release Notes for a mapping of VueServer.ini options to jvueserver.properties parameters.
Custom settings in default.ini and allusers.ini should be backed up and migrated to the new version.
User-specific INI files should be backed up and copied over to the Profiles folder of the new installation.
GUI files: If you created custom GUI files, you must make sure to migrate the GUI settings. In order to migrate GUI, it is recommended that you run a diff utility between your current version's default.gui and your custom GUI. Identify what GUI components have been updated. Manually apply these settings to 21.0.1 GUI file.
Custom log settings: If you had custom log settings, apply them manually on the new version of AutoVue.
Stamp attributes and settings from the dmstamps.ini file (located in the <AutoVue for Agile PLM Install Root>\bin directory) should be copied over manually to the new version
Markup files, if markups are being managed by the AutoVue server (located in the <AutoVue for Agile PLM Install Root>\bin\Markups directory), should be backed up and copied over to the new version of AutoVue.
Custom markup symbol libraries (located in the <AutoVue for Agile PLM Install Root>\bin\Symbols directory) should be backed up and copied over to the new version of AutoVue.
If MarkupPolicy.xml located in <AutoVue for Agile PLM Install Root>\bin was modified, it should be backed up and changes to the policy should be manually applied to the new version.
On Linux installations of AutoVue for Agile PLM, backup the jvuew_config file (located in the <AutoVue for Agile PLM Install Root>/config directory) if it was modified and apply the changes manually to the new version.
Any changes made to format-specific files such as color maps, font maps, fonts must be backed up and these changes should manually be applied to the new version.
To install AutoVue for Agile PLM on Windows Platform:
Download Oracle AutoVue 21.0.1 for Agile PLM Media Pack listed under the product Oracle Agile Applications product pack from Oracle Software Delivery Cloud or edelivery (http://edelivery.oracle.com) to a temporary directory and extract its contents.
For Windows run the setup_av_win.exe from the temporary directory.
Proceed to Running the Installation Program.
The installation program prompts you to enter specific information about the system and configuration. See the Table 6-1, "Installation Instructions" for what you have to do during the installation.
Table 6-1 Installation Instructions
| In this window... | Perform the following action... |
|---|---|
|
Welcome to AutoVue for Agile PLM Installation |
Click Next to proceed with the installation. |
|
Customer Information |
Enter the User Name and Company Name. Click Next. |
|
Choose Install Component (s) |
If running the AutoVue for Agile PLM installer on a machine with the Agile PLM application server and/or File Manager installed then the "AutoVue client libraries" component will be displayed and is selected by default. The "AutoVue Server" component is always displayed and selected by default. Click Install. Note: Refer to Deployment Scenarios to determine what components are required for your installation. |
|
Installation Location |
Enter the location or folder where you want to install the selected AutoVue components in the Specify where to install the selected AutoVue component(s) box. Click Next. If a supported AGILE_HOME exists then the default Installation Location is the directory AGILE_HOME/AVS and this would be the AutoVue Server home directory. |
|
AutoVue Server |
Enter the host name and the port number of the AutoVue server that Agile File Manager will connect to. Click Next. Note: Ensure that you enter fully qualified machine/domain name for the Host Name. Example: host.domain.com (machinename.domainname). |
|
AutoVue Product |
Choose the AutoVue product that you have licensed. The options are:
Click Next. |
|
Choose Shortcut Folder |
Here you can choose where you want to create the product icons. Following are the options:
Note: In case you select the Create Icons for All Users, then the product icon appears as a short cut for all users. Click Next. |
|
Pre-Installation Summary |
Review the Product Name, Install Folder, Shortcut Folder, Product Features, Disk Space Information (for Installation) and additional information before continuing with the installation. After the review, click Install. |
|
Install Complete |
Click Finish to complete the installation. |
|
Note: Before installing the AutoVue client libraries, remember to stop the file server and any additional Agile processes. |
After installing on the Application Server: After installing the AutoVue client libraries, redeploy the application.ear file and restart the application server.
For instructions on restarting the application server, refer to either the Installing Agile PLM on Oracle Application Server or the Installing Agile PLM on Oracle WebLogic Server manuals.
After installing on the File Manager: After installing the AutoVue client libraries, redeploy the webfs.war file (Filemgr web application) on the File Manager.
|
Note: The webfs.war file and application.ear files are available at "AGILE_HOME\agiledomain\applications". |
To install AutoVue for Agile PLM on Linux platforms:
Uninstall any previous versions of AutoVue.
Run the Red Hat Update Agent, yum up2date, to download the latest Xvfb and Mesa files.
|
Note: Both the AutoVue installer and the AutoVue for Agile PLM installer do not detect the installation of Mesa or Xvfb. |
It is recommended that AutoVue is installed on the same user account used to install Agile PLM to avoid any library conflicts between AutoVue and Agile or Oracle database.
Install the pre-requisites as described in Linux Prerequisites.
Download Oracle AutoVue for Agile PLM Media Pack listed under the product Oracle Agile Applications product pack from Oracle Software Delivery Cloud or edelivery (http://edelivery.oracle.com) and extract its contents.
Launch the AutoVue for Agile PLM installer (Linux: setup_av_lin.bin).
|
Note: It is recommended to run the AutoVue for Agile PLM installer UI on the server itself either through the primary display or, if installing remotely, by using vncserver. |
Follow the instructions to proceed with the installation. Select the components you would like to install.
For information about any screen in the installer, click Help.
Click Next to proceed through the installer.
|
Note: If you are installing on an Application Server or File Manager, select the AutoVue Client Libraries check box on the Choose Install Components panel. |
Click Done to finish the installation.
The AutoVue server can be installed on only Windows and Linux. However, Agile PLM application server and File Manager components can be installed on several other platforms including Solaris (SPARC), Solaris (x64), AIX (POWER) and HP-UX (Itanium). You can install AutoVue Client Libraries on any of these platforms.
Oracle AutoVue Client Libraries and integration components can be installed on the following platforms:
|
Note: VueLink/VueServlet are delivered as part of the File Manager web application, and do not has to be installed separately. See Note in Testing the VueServlet for details. |
Table 6-2 Platforms and the corresponding executable file
| Platform | Executable File |
|---|---|
|
Solaris (SPARC) |
|
|
Solaris (x64) |
|
|
AIX (POWER) |
|
|
HP-UX (Itanium) |
|
Download Oracle AutoVue 21.0.1 for Agile PLM Media Pack listed under the product Oracle Agile Applications product pack from Oracle Software Delivery Cloud or edelivery (http://edelivery.oracle.com).
Extract the media pack and run the executable file.
Follow the instructions to proceed with the installation.
For information about any screen in the installer, click Help.
Click Next to proceed through the installer.
|
Note: If you are installing on an Application Server or File Manager, select the AutoVue Client Libraries check box on the Choose Install Components panel. |
Click Done to finish the installation.
To install AutoVue for Agile PLM in console mode:
Download Oracle AutoVue 21 for Agile PLM Media Pack listed under the product Oracle Agile Applications product pack from Oracle Software Delivery Cloud or edelivery (http://edelivery.oracle.com) to a temporary directory and extract its contents.
Run the ./setup_av_<platform>.bin -i console.
Proceed to Running the Installation Program in Console Mode.
Table 6-3 Installation Instructions
| In this window... | Perform the following action... |
|---|---|
|
Welcome to AutoVue for Agile PLM Installation |
Press <Enter> to proceed with the installation. |
|
Customer Information |
Enter the User Name and Company Name. Press <Enter>. |
|
Choose Install Component (s) |
Enter a comma_separated list of numbers representing the features you would like to select, or deselect. To view a feature's Description, enter <NUMBER>. 1- AutoVue Server2- AutoVue Client LibrariesPress <Enter> after you have entered the number. Note: Refer to Deployment Scenarios to determine what components are required for your installation. |
|
Installation Location |
Enter the location or folder where you want to install the selected AutoVue components in the Specify where to install the selected AutoVue for Agile PLM component(s). Enter an absolute path, or press <Enter> to accept the default. |
|
AutoVue Server |
Enter the Host Name and Port Number of the AutoVue Server that Agile File Manager will connect to. Press <Enter>. Note: Ensure that you enter fully qualified machine/domain name for the Host Name. Example: host.domain.com (machinename.domainname). |
|
AutoVue Product |
Choose the AutoVue product that you have licensed.1- AutoVue 2D Professional for Agile2- AutoVue Electro-Mechanical Professional for AgileEnter the number of the desired choice. After entering your choice, press <Enter>. |
|
Install Complete |
After the installation is complete, you get the following message: All the selected components for AutoVue for Agile PLM have been successfully installed to the selected folder. |
For information on how to configure and re-deploy the File Manager, refer to the "Configuring the File Manager" chapter of the Agile Product Lifecycle Management Application Installation Guide located on the Agile OTN site http://www.oracle.com/technetwork/documentation/agile-085940.html.
|
Note: If you are upgrading from an earlier version it is required to run the MetaFilesRemover utility on all File Manager machines. |
If you are upgrading from an earlier version:
Remove the CMF files of the previous version on the file vault.
To remove the CMF files, unzip the MetaFilesRemover.zip file and run the MetaFilesRemover utility located at agile_home\agileDomain\tools.
Usage: java -jar MetaFilesRemover.jar [-delete] [-age <value>] [-size <value>] -basedir <value> -prefix <value> -serverURL <value> -username <value> -password <value> -dburl <value> -dbuserid <value> -dbpassword <value>
where
delete deletes the metafiles.
age specifies the access time (day).
size specifies file size (KB).
basedir is the file vault location where the metafiles are removed.
prefix is the file name prefix.
serverURL is the location of the DMS service.
For example, Server URL should be - http://<ApplicationServerHostName>:7001/Agile/DmsService/DmsViewerAPIService.
username is the DMS service username.
password is the DMS service password.
dburl is the database location (ex: hostname.us.oracle.com:1521:agile9).
dbuserid is the database user id.
dbpassword is the database password for this user.
After you have installed the AutoVue client libraries and File Manager, you must verify that your integration works correctly with this version of AutoVue for Agile PLM. The following details the verification steps:
Start the AutoVue server, application server, and File Manager.
For each File Manager, verify the status of the VueServlet by accessing the File Manager configuration page:
http://fmhost:port/Filemgr/Configuration
<init-param>…</init-param> for each AutoVue client parameter that you want to pass to AutoVue at the start-up. Refer to for a complete list of the client parameters supported by AutoVue.Deploying VueKeyPairServletVueKeyPairServlet is provided as a reference implementation for validation and testing purposes. It is a demonstration sample and integrators are strongly advised to review their deployment from a security point of view and chose the best way to generate these encryption keys. To use it, you need to do the following:VueKeyPairServlet on a J2EE-enabled application server within a JAR or a WAR file, following the approach described for VueServlet in .the code provided in to the configuration file web.xml of the J2EE-enabled application server used to deploy VueKeyPairServlet in order to specify the deployment descriptor needed for it.<servlet id="VueKeyPairServlet"> <servlet-name>VueKeyPairServlet</servlet-name> <servlet-class>com.cimmetry.servlet.VueKeyPairServlet</servlet-class> <load-on-startup>0</load-on-startup> </servlet> <servlet-mapping> <servlet-name>VueKeyPairServlet</servlet-name> <url-pattern>/servlet/VueKeyPairServlet</url-pattern> <url-pattern>/servlet/VueKeyPairServlet/*</url-pattern> </servlet-mapping>The AutoVue client is the main entry point to AutoVue's capabilities. The AutoVue client components need to be made accessible to end-users at an application server or Web server location. The instructions for deploying the client components vary depending on whether you have AutoVue integrated with a DMS or if you are using a non-integrated environment.jsonrpc4j.jar.client supports a scripting API and starts a socket listening to XML HTTP requests invoking this API. These requests are wrapped into a JavaScript Object named AutoVue and implemented in the file autovue.js. This object is designed to simplify the integration of AutoVue and provides a JavaScript method for each scripting API supported by AutoVue. If you want to send XML HTTP requests using your own approach, then look at the methods initScriptService and processScriptMethod of the file autovue.js to see how to build such requests. However, an integration solution could use this AutoVue JavaScript object to communicate with AutoVue client in a simpler way. To do so, you must include the JavaScript source in your HTML code integrating AutoVue: <script type="text/javascript" src="autovue.js"></script>Then, you must instantiate an AutoVue Object into a JavaScript block within your HTML code as shown in the following code:to instantiate an AutoVue Object<script language="JavaScript"> var myAvApp = new AutoVue( JNLP_HOST, CODEBASE_HOST, CLIENT_PORTS, INIT_PARAMS, ...)</script>To use the sample HTML pages provided with AutoVue (typically, only used for testing purposes, or a baseline example to create your own custom AutoVue client) copy them with the file autovue.js from <AutoVue Install Root>\html to the directory you created to your Web server root.launch the AutoVue clientav_jnlp.htmlupdate AutoVue Object Constructor parameters with appropriate valuesSome of these parameters are defined into JavaScript variables (CODEBASE, JNLP_HOST, CL_PRTS, etc) within av_jnlp.html and passed to AutoVue Object constructor. If you use av_jnlp.html, update these variables and the line instantiating AutoVue Object with the appropriate values. Add more optional parameters if needed.Launch AutoVue client by invoking the following start API: myAvApp.start(onInit, onFail, user_data);The parameter <onInit> is a JavaScript Callback method invoked when the browser connects to AutoVue and the scripting API is ready for use. This callback does not carry any argument.The parameter <onFail> is a JavaScript Callback method invoked when the browser fails to connect to AutoVue. An example that prompts the user for "Retry" three times and suggests notifying AutoVue administrator through e-mail is provided in av_jnlp.html. This callback must follow the following prototype: function onFail(xmlhttp_request, error_msg, user_data),where: xmlhttp_request: The last XMLHTTPRequest object used by the browser to communicate with AutoVue. error_msg: A text string describing the error preventing the connection to AutoVue. user_data: Custom object sent among the argument of this start API.The parameter <user_data> is a custom object that will be sent within the arguments of the onFail callback.av_jnlp.htmlConfiguring AutoVue Client for Secure Socket Layer (SSL)When used in an https-based environment, web browsers enforce a "mixed active content" restriction which requires the communication with AutoVue Client be performed through a secure socket. In order to open this socket, the client needs to possess a server certificate. The AutoVue Client detects when this configuration occurs, and retrieves the server certificate. The certificate can be either self-signed, or signed with an existing local certificate authority.A new tool (makeAvCert) is distributed with AutoVue to provision this certificate for an installation. It can be implemented in an installer, or handled as a manual configuration. To run AutoVue under HTTPS Protocol, you have to do the following additional steps:a security certificate for "localhost". This certificate will only be used to enable SSL communication between the users' browsers and the AutoVue Client, so it should be as restricted as possible. The administrative tool provided with AutoVue (makeAvCert) produces suitable certificates. Running the utility will generate two files: av_cert.pem which contains the complete certificate with key-pair, and localhost.cer which contains the public information. The utility need the package tools.jar to run.the complete certificate file (av_cert.pem) to the directory you created to your Web server root.the URL of the SSL certificate file (av_cert.pem) as an AutoVue client parameter, to the JNLP file required to start AutoVue. For example, if you use the servlet VueJNLPServlet provided with AutoVue, then you should add this URL in the application-desc portion of the autovue.jnlp template used by this servlet:<application-desc main-class="com.cimmetry.jvue.JVueApp"> <argument> -paramsslcert_url= https://AutoVueServer:ServletPort/AutoVue/av_cert.pem </argument> ...</application-desc>that using self-signed localhost certificates requires them to be loaded as a certificate exception in each user's browser (The localhost.cer file generated by makeAvCert is intended for this purpose). For the best experience, this should be done before users attempt to use AutoVue. In Microsoft Windows environments, administrators can automate this operation by using the Group Policy Management facility. Mozilla Firefox maintains its own independent certificate store, normally stored in a file named cert8.db. A variety of third party tools have been developed for administrators to manage the certificates pushed to users. Any of these tools may be used to import the localhost certificate for AutoVue.In Apple and Linux environments, there are fewer standard distributed administration tools. Importing the certificate may be handled manually if necessary by exporting the certificate from the keystore to DER or PEM format and importing to certificate stores by opening the files in the browser, or by using the command line tools provided in each system (keychain application (MacOS), certutil (Linux)).In Enterprise environments where a local certificate authority (CA) has been set up, a localhost certificate can be generated that is signed by the local CA. Since users will already have the local CA configured in their browsers, the importing of a self-signed certificate can be omitted. This option is only suitable for environments where the infrastructure work has already been configured.AutoVue server hostnameav_jnlp.htmlwebstart is installedCODEBASE_HOSTsecond parameter in the AutoVue object constructor called in av_jnlp.html or batchprint_jnlp.html filesWeb server/application serveror the port parameter in jetty-ssl.xml when SSL is configured. This parameter is