Installing and Deploying the ENOVIA VPM V5 Connector

Access to an ENOVIA VPM V5 server from a 3DEXPERIENCE client via an ENOVIA VPM V5 connector requires the Apache TomEE middleware. The ENOVIA VPM V5 client code is loaded and run in response to requests from a 3DEXPERIENCE client.

This page discusses:

Overview



Important:
  • ENOVIA VPM V5 cannot be installed on the Linux operating system.
  • Automatic deployment of TomEE on AIX is not supported. You can however deploy a TomEE / LPM server on Windows (computer 2 shown above) using an ENOVIA VPM V5 application server on AIX (computer 1 shown above)
  • You must have an installed ENOVIA VPM V5 server with its vault. You will need to provide the server's computer name, port, and the vault client configuration file.
  • TomEE, ENOVIA VPM V5 DEW and ENOVIAAppSrvforENOVIAvpmandENOVIAVPMV5Connectors must all be installed in the same bit mode: 32-bit or 64-bit.
  • For the supported levels of TomEE and Java Development Kit (JDK), see the appropriate Program Directory (Deployment: Strategic Platforms: HW & SW Requirements).
  • The ENOVIA VPM V5 connector can be deployed on the same computer as the ENOVIA VPM V5 server or on a different computer.
  • The LPM server level must be the same as the 3DEXPERIENCE level.

For installation on Windows, you should proceed as follows:

  1. Install the ENOVIA VPM V5 DEW Product from the ENOVIA_VPM_V5 Installation Media.
  2. Generate the WAR File from the 3DEXPERIENCE Media.
  3. then EITHER:OR:
    • first Install an External TomEE then use the ENOVIA VPM V5 installer that generates the WAR and automatically deploys the WAR file in TomEE
    OR:
    • first Install the Embedded TomEE then use the ENOVIA VPM V5 installer that generates the WAR and automatically deploys the WAR file in TomEE. The TomEE is then installed on Windows as a "service".

Important: AIX is not supported. However, it is possible to manually deploy the WAR file generated on Windows then transfer it to an AIX computer. See Deploy Manually on AIX.

Install the ENOVIA VPM V5 DEW Product from the ENOVIA_VPM_V5 Installation Media

This task shows you how to launch the installation of the DEW - ENOVIA - VPM PRODUCT DESIGN WEB SERVICES product from the ENOVIA_VPM_V5 installation media.

  1. Provide the directory path where the DEW product will be installed.
  2. Provide the directory path of the corresponding ENV file.
  3. Select the Custom installation.
  4. Select the languages.
  5. Select Products (default: Configurations) and select the DEW product.
  6. Provide the Orbix configuration information about the existing V5 server.
  7. Provide a timeout value.
  8. Click Next to accept the existing ENOVIA vault client information.
  9. Provide the communication ports.
  10. Provide the Java Development Kit (JDK) path.
  11. Click Install.
  12. Provide information for the vault server alias, the VPM V5 server name and port after a pop-up appears.
  13. Close the window when the installation is completed.

Generate the WAR File from the 3DEXPERIENCE Media

This task shows how to generate, from the 3DEXPERIENCE media, a WAR file that you later deploy on the TomEE application server.

  1. Launch the installation of the product ENOVIAAppSrvforENOVIAvpmandENOVIAVPMV5Connectors from the 3DEXPERIENCE installation media. Click Next >.
  2. Specify the target directory for installation. Click Next >.
  3. Enter the name of the WAR file to be generated. The file name will be the root URI for web services, the default value is LPMServerMgt. Click Next >.
  4. Select the option Generate war file only. Click Next >.
  5. Select ENOVIA VPM V5 as the target server. Click Next >.
  6. Provide the following information required for V5 installation purposes:
    • the installation directory of the V5 DEW product (with "/win_b64" concatenated at the end)
    • the directory containing the V5 vault configuration file (default: /docs/java concatenated at the end in the V5 server installation)
    • the name of the V5 server
    • the port number of the V5 server.
    Click Next >.
  7. In the dialog box that now appears, check to make sure that the displayed information matches the selections you have just made.
    Note: The Java path is detected automatically if the required level is installed.
  8. To correct any of the information, click Back >.
  9. If the displayed information is correct, click Install >.
  10. Close the window when the installation is completed.
  11. Check to make sure that the file has been generated at:<install_path>\<WAR name>\distrib\ .

Download TomEE

This section tells you how to download TomEE from the Internet.

  1. Browse http://tomee.apache.org.
  2. Click Downloads and download the appropriate version of TomEE.
  3. Install TomEE following the recommendations.

Deploy the WAR File in TomEE

This section tells you how to deploy in TomEE the WAR file you have already generated.

  1. Start the TomEE server.
  2. In a web browser, connect to the application management page of the TomEE server, for example http://localhost:8080/manager/html.
  3. In the War File to Deploy section, browse to the WAR file created in step 3 above: $installpath/$WarName/distrib.
  4. Click Deploy.
  5. On any computer on the same network as your LPM server, enter the following url: http://tomEEServer:Port/<WAR name>/config and check the installation directory, the vault file directory and also the server name and port.

Install the Embedded TomEE

This section tells you how to install the TomEE from the 3DEXPERIENCE media ENOVIAAppSrvforENOVIAvpmandENOVIAVPMV5Connectors.

You can install the TomEE:

Install the TomEE Embedded in the 3DEXPERIENCE Media with an Embedded JRE

  1. Launch the installation of the product ENOVIAAppSrvforENOVIAvpmandENOVIAVPMV5Connectors from the 3DEXPERIENCE installation media. Click Next >.
  2. Specify the target directory for installation. Click Next >.
  3. Enter the name of the generated WAR file. Click Next >.
  4. Select the option Installation with TomEE. Click Next >.
  5. Check the box Install the embedded server JRE. Click Next >.
  6. In the next dialog box, you can, if you wish, change the TomEE port connection number. Click Next >.
  7. A window now appears showing the Apache JServ Protocol (AJP) port and shutdown port numbers. Click OK.
  8. Choose to start the TomEE at the end of the installation or not. Click Next >.
  9. In the dialog box that now appears, read the provided information and choose whether or not to deploy the webapp in TomEE at the end of the installation. Click Next >.
  10. Select ENOVIA VPM V5. Click Next >.
  11. Provide the following information required for V5 installation purposes:
    • the ENOVIA VPM V5 install directory
    • the ENOVIA VPM V5 vault file directory
    • the ENOVIA VPM V5 server name
    • the ENOVIA VPM V5 server port.
    Click Next >.
  12. In the dialog box that now appears, check to make sure that the displayed information matches the selections you have just made. Click Next >.
    Note: The Java path is detected automatically if the required level is installed.
  13. To correct any of the information, click Back >.
  14. If the displayed information is correct, click Install >.
  15. Check to make sure that:
    • the WAR file has been generated at: <install_path>\<WAR name>\distrib\
    • the TomEE is installed with the relevant files at: <install_path>\<WAR name>\<OS>\code\tomee
    • a folder with the WAR name is present at: <install_path>\<WAR name>\<OS>\code\tomee\webapps (depending on whether or not you chose to deploy the WAR file in TomEE at the end of the installation)
    • the TomEE server is running then, on any computer on the same network as your LPM server, enter the following url: http://tomEEServer:Port/<WAR name>/config and check the installation directory, the vault file directory and also the server name and port.
    • the TomEE service is running or not (depending on whether or not you chose to start the TomEE at the end of the installation).

Install the TomEE Embedded in the 3DEXPERIENCE Media with an External JRE

  1. Launch the installation of the product ENOVIAAppSrvforENOVIAvpmandENOVIAVPMV5Connectors from the 3DEXPERIENCE installation media. Click Next >.
  2. Specify the target directory for installation. Click Next >.
  3. Enter the name of the generated WAR file. Click Next >.
  4. Select the option Installation with TomEE. Click Next >.
  5. Uncheck the box Install the embedded server JRE. Click Next >.
  6. Provide a valid Java path. Click Next >.
  7. Check the box Install the embedded Apache TomEE +.. Click Next >.
  8. In the next dialog box, you can, if you wish, change the TomEE port connection number. Click Next >.
  9. A window now appears showing the Apache JServ Protocol (AJP) port and shutdown port numbers. Click OK.
  10. Choose to start the TomEE at the end of the installation or not. Click Next >.
  11. In the dialog box that now appears, read the provided information and choose whether or not to deploy the webapp in TomEE at the end of the installation. Click Next >.
  12. Click ENOVIA VPM V5. Click Next >.
  13. Provide the required information in the dialog box that appears:
    • the ENOVIA VPM V5 install directory
    • the ENOVIA VPM V5 vault file directory
    • the ENOVIA VPM V5 server name
    • the ENOVIA VPM V5 server port.
    Click Next >.
  14. In the dialog box that now appears, check to make sure that the displayed information matches the selections you have just made. Click Next >.
  15. To correct any of the information, click Back >.
  16. If the displayed information is correct, click Install >.
  17. Check to make sure that:
    • the WAR file has been generated at: <install_path>\<WAR name>\distrib\
    • the TomEE is installed with the relevant files at: <install_path>\<WAR name>\<OS>\code\tomee
    • a folder with the WAR name is present at: <install_path>\<WAR name>\<OS>\code\tomee\webapps (depending on whether or not you chose to deploy the WAR file in TomEE at the end of the installation)
    • the TomEE server is running then, on any computer on the same network as your LPM server, enter the following url: http://tomEEServer:Port/<WAR name>/config and check the installation directory, the vault file directory and also the server name and port
    • the TomEE service is running or not (depending on whether you chose to start the TomEE at the end of the installation or not).

Install an External TomEE

This section tells you how to install the TomEE located in the 3DEXPERIENCE media.

  1. Launch the installation of the product ENOVIAAppSrvforENOVIAvpmandENOVIAVPMV5Connectors from the 3DEXPERIENCE installation media. Click Next >.
  2. Specify the target directory for installation. Click Next >.
  3. Enter the name of the generated WAR file. Click Next >.
  4. Select the option Installation with TomEE. Click Next >.
  5. Uncheck the box Install the embedded server JRE. Click Next >.
  6. Provide a valid Java path. Click Next >.
  7. Uncheck the box Install the embedded Apache TomEE +.. Click Next >.
  8. Provide a valid TomEE path. Click Next >.
  9. Click ENOVIA VPM V5. Click Next >.
  10. Provide the required information in the dialog box that appears:
    • the ENOVIA VPM V5 install directory
    • the ENOVIA VPM V5 vault file directory
    • the ENOVIA VPM V5 server name
    • the ENOVIA VPM V5 server port.
    Click Next >.
  11. In the dialog box that now appears, check to make sure that the displayed information matches the selections you have just made. Click Next >.
  12. To correct any of the information, click Back >.
  13. If the displayed information is correct, click Install >.
  14. Manually start the TomEE then check to make sure that:
    • the WAR file has been generated at: <install_path>\<WAR name>\distrib\
    • a folder with the WAR name is present at: <install_path>\tomee\webapps
    • the TomEE server is running then, on any computer on the same network as your LPM server, enter the following url: http://tomEEServer:Port/<WAR name>/config and check the installation directory, the vault file directory and also the server name and port.

Reroute ENOVIA Web Services

You can optionally reroute your ENOVIA web services to another ENOVIA VPM V5 server or vault by modifying the application config page in your web browser.

  1. Open the website http://<tomee_computer:tomee_port>/<ENOVIA VPM V5>/config in a browser, where <tomee_computer:tomee_port> is the address and port of the Apache TomEE application server and ENOVIA VPM V5 is the name of the deployed connector.
  2. Modify the following information on the Configuration page:
    Field Description
    Installation Directory Installation directory of the ENOVIA VPM V5 DEW product
    Vault File DirectoryDirectory of the ENOVIA VPM V5 vault client configuration file
    Server Name Name of the ENOVIA VPM V5 server
    Server PortPort number of the ENOVIA VPM V5 server
  3. To save the modifications, click Save Configuration

Deploy Manually on AIX

This section tells you how to manually deploy the WAR file generated on Windows then transfer it to an AIX computer. No other method is possible using AIX.

  1. On an AIX computer, Install the ENOVIA VPM V5 DEW Product from the ENOVIA_VPM_V5 Installation Media.
  2. On an intermediate Windows computer, Generate the WAR File from the 3DEXPERIENCE Media. However, when you specify the installation directory of the V5 DEW product and the directory containing the V5 vault configuration file, you must enter dummy Windows paths. (You can enter the name and port number of the AIX server.)
  3. Transfer the WAR file from the Windows computer to the target AIX computer using the binary mode (and not the ASCII one).
  4. Complete the manual deployment i.e. Download TomEE from the Internet yourself then Deploy the WAR File in TomEE.
  5. Make sure the TomEE server is running, then, on any computer on the same network as your LPM server, enter the following url: http://<AIX computer:port>/<WAR name>/config .
  6. In the Installation Directory and Vault File Directory fields, replace the dummy paths you entered earlier with the correct UNIX ones.